Visualization settings

Permission: Settings management

Visualization setting is used to configure default visualization functionality and styling when user creates a new visualization.

Configuration

  1. Left menu - settings

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

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

Default configuration

Default configuration contains several default attributes to see how configuration should looks like. Probably this configuration doesn't match model of your data but can serve as example of short configuration.

  1. Left menu - settings

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

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

Automatic configuration

Automatic configuration is used to generate configuration which contains automatically detected "nodeLabelAttr".

This automatically generated configuration can be used as good starting point to create own configuration.

  1. Left menu - settings

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

  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:

{
"relationshipModel" : "dirMergedEdges",
"nodeTitleProp" : "db_or_virtual_property_key",
"relTitleProp" : "db_or_virtual_property_key",
"mergedRelTitleProp" : "virtual_property_key",
"dirMergedRelTitleProp" : "virtual_property_key",
"nodeTooltipProps" : [
{ "property":"db_or_virtual_property_key_1" },
{ "property":"db_or_virtual_property_key_2" }
],
"relTooltipProps" : [
{ "property":"db_or_virtual_property_key_3" },
{ "property":"db_or_virtual_property_key_4" }
],
"mergedRelTooltipProps" : [
{ "property":"virtual_property_key_1" }
],
"dirMergedRelTooltipProps" : [
{ "property":"virtual_property_key_2" }
],
"nodeSnippetProps" : [
{ "property":"db_or_virtual_property_key" },
{ "property":"db_or_virtual_property_key" }
],
"nodeFilterProps" : [
],
"mappers" : {
"nodes" : {
"background_color":{
"id":"1"
},
"background_image":{
"id":"2"
},
"border_width":{
"id":"21"
},
"border_color":{
"id":"22"
},
"size":{
"id":"3"
},
"shape":{
"id":"6"
}
},
"rels" : {
"line_color":{
"id":"5"
},
"line_style":{
"id":"9"
},
"width":{
"id":"4"
},
"curve_style":{
"id":"42"
}
}
}
}

Explanation of JSON properties:

Property

Values

Default

Description

relationshipModel

"edges", "mergedEdges", "dirMergedEdges"

"edges"

Default Relationship Model set at new visualization initialization (when user creates a new visualization).

nodeTitleProp

String

First node DB property defined in Data schema.nodeProperties.database

Name of DB property used in several places in visualization (node title, tooltip title, tab Detail title, node snippet title) to identify node. For best results it should be DB property with unique identification or name for nodes. If set to null or not defined then the first Database Property Definition from "nodeProperties"."database" in Data schema is used.

relTitleProp

String

 

Name of DB property used as relationship title in visualization. If set to null or not defined then no relationship titles are shown in visualization.

mergedRelTitleProp

String

 

Name of virtual property used as merged relationship title in visualization. If set to null or not defined then no merged relationship titles are shown in visualization.

dirMergedRelTitleProp

String

 

Name of virtual property used as direction merged relationship title in visualization. If set to null or not defined then no direction merged relationship titles are shown in visualization.

nodeTooltipProps

Array of objects

 

Array of node DB properties which are listed in node tooltip. Each property is defined as simple object with only one property property. If set to null or not defined then no DB properties are printed in node tooltip. Ordering in GUI is the same as in this setting.

Example:

"nodeTooltipProps" : [
{ "property":"db_or_virtual_property_key" },
{ "property":"db_or_virtual_property_key" }
]

relTooltipProps

Array of objects

 

Array of relationship DB properties which are listed in relationship tooltip. Each property is defined as simple object with only one property property. If set to null or not defined then no data is printed in relationship tooltip. Ordering in GUI is the same as in this setting.

Example:

"relTooltipProps" : [
"property":"db_or_virtual_property_key" },
    { "property":"db_or_virtual_property_key" }
]

mergedRelTooltipProps

Array of objects

 

Array of merged relationship virtual properties which are listed in merged relationship tooltip. Each property is defined as simple object with only one property property. If set to null or not defined then no data is printed in merged relationship tooltip. Ordering in GUI is the same as in this setting.

Example:

"mergedRelTooltipProps" : [
{ "property":"virtual_property_key" }
]

dirMergedRelTooltipProps

Array of objects

 

Array of direction merged relationship virtual properties which are listed in direction merged relationship tooltip. Each property is defined as simple object with only one property property. If set to null or not defined then no data is printed in direction merged relationship tooltip. Ordering in GUI is the same as in this setting.

Example:

"dirMergedRelTooltipProps" : [
{ "property":"virtual_property_key" }
]

nodeSnippetProps

Array of objects

 

Array of node DB properties which are used as additional node identification in visualization tabs, e.g. in search or in node details. If set to null or not defined then no additional information is used in GUI and the only identification of node is nodeTitleProp.

Example:

"nodeSnippetProps" : [
{ "property":"db_or_virtual_property_key" },
{ "property":"db_or_virtual_property_key" }
]

nodeFilterProps

Array of objects

All node DB properties defined in Data schema with dataRole="dimension"

Array of node DB properties which are used in advanced filter in the search tab in visualization. If set to null or not defined then all DB properties from "nodeProperties" in Data schema which have dataRole set to "dimension" are used. Ordering in GUI is the same as in this setting.

Example:

"nodeFilterProps" : [
{ "property":"db_or_virtual_property_key" },
{ "property":"db_or_virtual_property_key" }
]

mappers

Object

 

Containst only two properties : "nodes" and "rels" with default style mappers definitions which are used when user creates a new visualization.

mappers.nodes

Object

Empty object

The "nodes" object contains references to specific style mappers that should be used to style nodes when user creates a new visualization (these mappers has to be already defined in the Style mappers setting and then referenced with the mapper's id property). There can be one and only one mapper defined for every style property (e.g. for line color, width, curve style, ...). When no mapper is defined for some style properties then the internal default values are used automatically.

mappers.nodes.background_color

Object

Default styles

Definition of node background color mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.nodes.background_image

Object

Default styles

Definition of node background image mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.nodes.border_width

Object

Default styles

Definition of node border width mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.nodes.border_color

Object

Default styles

Definition of node border color mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.nodes.shape

Object

Default styles

Definition of node shape mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.nodes.size

Object

Default styles

Definition of node size mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.rels

Object

 

The "rels" object contains references to specific style mappers that should be used to style relationships when user creates a new visualization (these mappers has to be already defined in the Style mappers setting and then referenced with the mapper's id property). There can be one and only one mapper defined for every style property (e.g. for line color, width, curve style, ...). When no mapper is defined for some style properties then the internal default values are used automatically.

mappers.rels.line_color

Object

Default styles

Definition of relationship line color mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.rels.line_style

Object

Default styles

Definition of relationship line type mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.rels.width

Object

Default styles

Definition of relationship width mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.

mappers.rels.curve_style

Object

Default styles

Definition of relationship curve style mapper. This object contains only property id which is the ID of style mapper which should be used when user creates a new visualization. When not defined or set to null then the default styles are applied.