Widgets

Permission: Settings management

Widgets setting is a collection of widget configuration objects. With these configuration objects you can enable and configure widgets included in Visualization.

There are several internal widgets included in Graphlytic installation which you can use out of the box. See below for a full list of internal widgets and their configuration options.

Configuration

  1. Left menu - settings

  2. In panel "Settings list" use icon "Update" for setting "WIDGETS".

  3. Enter JSON configuration and confirm by pressing "Save" button.

Default configuration

Default configuration contains no enabled widgets.

  1. Left menu - settings

  2. In panel "Settings list" use icon "Update" for setting "WIDGETS".

  3. Press button "Default" and store by pressing button "Save".

Automatic configuration

Automatic configuration contains no enabled widgets. You have to configure widgets manually.

  1. Left menu - settings

  2. In panel "Settings list" use icon "Update" for setting "WIDGETS".

  3. Press button "Automatic", wait for generator to generate JSON and store by pressing button "Save".

Description of configuration

Configuration is entered as JSON. Example of JSON:

[
{
"widget":"outagePropagation",
"config":{
"outageProp":"outageDependency",
"outageValue":"yes",
"thresholdProp":"outageThreshold"
}
},
{
"widget":"sumReport"
}
]

Explanation of JSON properties:

Property

Values

Default

Description

Usage

widget

MANDATORY

String

 

ID of widget you want to enable (include) in Visualization.

Visualization

config

Object

 

Optional object which will be passed to widget with <widget>.configure(config) method immediately after widget is included. Structure of this object vary for each widget. Please see documentation of particular widget for more information about it's configuration options.

Visualization

Internal Widgets

Widget ID

Configuration

Description

sumReport

Property

Description

valueProp

Name of node DB property with values to sum. If not defined then random numbers are used (for demo purposes).

Demo of a widget which acts on set of selected nodes, calculates sum of one property across these nodes and result is presented to user in the form of a table in modal window.

Example of configuration:

{
"widget":"sumReport",
"config":{
"valueProp":"costs"
}
}

outagePropagation

Property

Description

outageProp

MANDATORY

Name of relationship DB property with outage values.

outageValue

MANDATORY

Value of outageProp which will be considered as true. In case of this value the relationship is considered to be a outage propagator.

thresholdProp

Name of relationship DB property with threshold value. Threshold is a numeric value representing minimum number of nodes outgoing relationships with active outage in order to consider the node to be down (to be affected by this outage). In case multiple outgoing relationships of a node have different thresholdProp values then the minimal value is used. If not defined then the outage is calculated as if threshold value is 1 (always propagate to node).

Widget ads the "outage propagation button" to Tools panel in Visualization for simulationg outage propagation in graph.

Usage: select one or more nodes which are outage starting points and click the outage propagation button. Widget calculates based on starting points and configuration option the nodes and relationships which propagates outage in this step and selects them. You can press the outage propagation button multiple times and in every step the same calculation is made so you can observe the outage propagation effect in graph.

Example of configuration:

{
"widget":"outagePropagation",
"config":{
"outageProp":"outageDependency",
"outageValue":"yes",
"thresholdProp":"outageThreshold"
}
}