JSON syntax: Diagram section

These settings determine general display settings for the diagram.

JSON syntax Description
"visitStrategy": "directed", "directedIncoming",
"directedOutgoing","completeGraph"
  • Indicates which nodes and edges have to be traversed and displayed.
  • This setting is optional.
  • You can select one of the following values:
    • "directed": For the start node, Collibra traverses the relations in all directions and adds all the nodes that it finds. For the encountered nodes, Collibra traverses relations only in the same direction as how they are encountered: if a node was encountered by traversing an outgoing relation, Collibra looks for outgoing relations, and vice versa. This behavior is similar to traversing a hierarchy.

      This is the default setting.

      For a refinement to this strategy, see also the setting for layoutRegion.

    • "completeGraph": All nodes and edges related to the current asset are displayed, irrespective of the direction in which they were encountered.
    • "directedIncoming":For the start node, Collibra only traverses the incoming relations and adds all the nodes that it encounters. For the encountered nodes, Collibra traverses relations only in the same direction as how they are encountered: incoming relations only.
    • "directedOutgoing": For the start node, Collibra only traverses the outgoing relations and adds all the nodes that it encounters. For the encountered nodes, Collibra traverses relations only in the same direction as how they are encountered: outgoing relations only.

Be careful with using completeGraph, this setting can lead to very large diagrams.
"resultNodeUnicityStrategy": "multipleNodesPerAssetId", "singleNodePerAssetId"
  • Indicates the number of times a node is displayed if it matches multiple nodes in the diagram view.
  • This setting is optional.
  • You can pick one of the following values:
    • "multipleNodesPerAssetId": If an asset is encountered more than once for different nodes in the diagram view, it is represented by multiple nodes in the diagram, one per matching view node.

      This is the default setting.

    • "singleNodePerAssetId": If an asset is encountered more than once for different nodes in the diagram view, it is represented by a single node in the diagram.

Note  If one asset is encountered multiple times for the same node in the diagram view, it is always displayed only once in the diagram. In that situation, there is a loop for that node.

"layout": "HierarchyLeftRight", "HierarchyTopBottom", "HierarchyBottomTop", "Circular", "SmartOrganic", "Radial", "Flow/Context"
  • Indicates the layout style of the diagram.
  • This setting is optional.
  • You can pick one of the following values:
    • "HierarchyLeftRight": Nodes and edges are displayed in a flow mostly from left to right. This is the default setting.
    • "HierarchyTopBottom": Nodes and edges are displayed in a flow mostly from top to bottom.
    • "HierarchyBottomTop": Nodes and edges are displayed in a flow mostly from bottom to top.
    • "Circular": Nodes and edges are arranged in a radial tree, where all nodes with the same number of edges to a given node are drawn in a circle.
    • "SmartOrganic": Nodes and edges are distributed in a well-balanced manner, there are minimal edge crossings.
    • "Radial": Nodes and edges are displayed with no overlaps, few edge crossings and few bends.
    • "Flow/Context": Layout style for diagrams with a flow and a context region. See also layoutRegion in the nodes section. Nodes and edges in the flow region are displayed mostly from left to right. The nodes and edges in the context region are displayed above the flow region. An edge that begins or ends with a context node, is shown with less emphasis (thinner and in light gray) than an edge between two flow nodes. If you specify this layout, keep in mind that for an edge between a flow node and a context node, the from node has to be in the flow region and the to node has to be in the context region.
"showOverview": false, true
  • Indicates if the overview is displayed.
  • This setting is optional.
  • You can pick one of the following values:
    • false: The overview is not displayed. This is the default setting.
    • true: The overview is displayed.
"showLabels": false, true
  • Indicates if the edge and node labels are displayed.
  • This setting is optional.
  • You can pick one of the following values:
    • false: The overlays are not displayed. This is the default setting.
    • true: The overlays are displayed.
"showLegend": false, true
  • Indicates if the diagram legend is displayed. The legend shows all asset types and complex relation types that occur in the diagram.
  • This setting is optional.
  • You can pick one of the following values:
    • false: The legend is not displayed.
    • true: The legend is displayed. This is the default setting.
"showPreview": false, true
  • Indicate if the preview pane is displayed by default. The preview pane shows information about the selected node or edge.
  • This setting is optional.
  • You can pick one of the following values:
    • false: The legend is not displayed.
    • true: The legend is displayed. This is the default setting.
"showFields": false, true
  • Indicates if the overlays are displayed.
  • This setting is optional.
  • You can pick one of the following values:
    • false: The labels are not displayed.
    • true: The labels are displayed. This is the default setting.
"maxNodeLabelLength": 0, <positive integer number>
  • Indicates the maximum length of the node labels (whether they should be truncated when they are too long).
  • This setting is optional.
  • You can provide 0 or a positive integer number as the value:
    • 0: Node labels are not truncated, they are displayed in full length.
    • The default setting is 50.
"maxEdgeLabelLength": 0, <positive integer number>
  • Indicates the maximum length of the edge labels. Edge labels are truncated when they are longer.
  • This setting is optional.
  • You can provide 0 or a positive integer number as the value:
    • 0: Edge labels are not truncated, they are displayed in full length.
    • The default value is 30.
"edgeBundling": false, true
  • Indicates whether edges of the same type are bundled to reduce clutter.
  • This setting is optional.
  • You can pick one of the following values:
    • false: Edges are not bundled.
    • true: Edges are bundled. This is the default setting.
"webworkersEnabled": false, true
  • Indicates whether the layout-related calculations can be moved to a separate Collibra service thread. This is useful for larger diagrams, so that your browser does not freeze while rendering the diagram.
  • This setting is optional.
  • You can pick one of the following values:
    • false: Layout-related calculations are not moved to a separate DGC thread of your processor.
    • true: For large diagrams, layout-related calculations are moved to a separate DGC thread of your processor. This is the default setting.