Visualization settings

Permission: Settings management

Visualization setting is used to configure visualization functionality.

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:

{
"nodeTitleProp" : "LOGICAL_NAME",
"relTitleProp" : "RELATIONSHIP_TYPE",
"mergedRelTitleProp" : "virtual_prop_technical_name",
"nodeTooltipProps" : [
{ "property":"TYPE" },
{ "property":"SUBTYPE" }
],
"relTooltipProps" : [
{ "property":"RELATIONSHIP_TYPE" },
{ "property":"RELATIONSHIP_SUBTYPE" }
],
"mergedRelTooltipProps" : [
{ "property":"virtual_prop_technical_name" }
],
"nodeSnippetProps" : [
{ "property":"TYPE" },
{ "property":"SUBTYPE" }
],
"nodeFilterProps" : [
]
}

Explanation of JSON properties:

JSON property names used prior to version 1.12 are listed in parentheeses after the current name

Property

Values

Default

Description

Usage

nodeTitleProp

(nodeLabelAttr)

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.

Visualization

relTitleProp

(edgeLabelAttr)

String

 

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

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 labels are shown in visualization.

Visualization

nodeTooltipProps

(nodeTooltipAttrs)

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":"TYPE" },
{ "property":"SUBTYPE" }
]

Visualization

relTooltipProps

(edgeTooltipAttrs)

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 DB properties are printed in relationship tooltip. Ordering in GUI is the same as in this setting.

Example:

"relTooltipProps" : [
"property":"RELATIONSHIP_TYPE" },
    { "property":"RELATIONSHIP_SUBTYPE" }
]

Visualization

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 DB properties are printed in relationship tooltip. Ordering in GUI is the same as in this setting.

Example:

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

Visualization

nodeSnippetProps

(nodeSnippetAttrs)

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":"TYPE" },
{ "property":"SUBTYPE" }
]

Visualization

nodeFilterProps

(tabAllNodeFilterAttrs)

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":"TYPE" },
{ "property":"SUBTYPE" }
]

Visualization