C

GridComponentDescriptor

Show Usages
A GridComponentDescriptor defines settings for edges routed on a common bus in a grid-like subcomponent for HierarchicalLayout.
Inheritance Hierarchy

Remarks

Edges mapped to the same GridComponentDescriptor instance, adjacent to a common root node and having the same edge direction form a bus along which the nodes are placed in a grid-like style. The mapping is defined using property gridComponents.

A graph that contains a grid component consisting of 15 edges and using default descriptor settings (bus edges are highlighted)

Default Values of Properties

NameDefaultDescription
maximumNodesAfterBus0
If the maximum number of nodes before the bus is 0 too, then the number of nodes is unrestricted, otherwise all nodes are placed before the bus.
maximumNodesBeforeBus0
If the maximum number of nodes after the bus is 0 too, then the number of nodes is unrestricted, otherwise all nodes are placed after the bus.

See Also

Developer's Guide

API

gridComponents

Members

Show:

Constructors

GridComponentDescriptor

()

Parameters

Properties

maximumNodesAfterBus

: number
Gets or sets the maximum number of nodes in a layer that are placed after the common bus segment.
This setting allows to individually specify how the nodes should be distributed before/after the common bus segment with respect to the sequence of each layer. By default, both the maximumNodesBeforeBus and the maximumNodesAfterBus are 0 which means that the nodes are evenly distributed and the common bus segment is placed in the middle. The actual number of nodes before and after the bus is determined automatically in that case.
If nodes are specifically assigned to one side using the layout data property nodesBeforeBus, but the value of this property is set to 0, then the maximum will be exceeded as necessary. The maximum can also be exceeded if there are too many fixed nodes in the same layer (when running in incremental mode) or when grid layers are user-specified via gridComponentRootOffsets.
final

Property Value

the maximum number of nodes that are allowed to be placed after the bus segment

Throws

Exception ({ name: 'ArgumentError' })
if the given node count is negative

Default Value

The default value is: 0
If the maximum number of nodes before the bus is 0 too, then the number of nodes is unrestricted, otherwise all nodes are placed before the bus.

Sample Graphs

ShownSetting: Example result with evenly distributed nodes: both, before and after node count are 0

See Also

Developer's Guide

maximumNodesBeforeBus

: number
Gets or sets the maximum number of nodes in a layer that are placed before the common bus segment.
This setting allows to individually specify how the nodes should be distributed before/after the common bus segment with respect to sequence of each layer. By default, both the maximumNodesBeforeBus and the maximumNodesAfterBus are 0 which means that the nodes are evenly distributed and the common bus segment is placed in the middle. The actual number of nodes before and after the bus is determined automatically in that case.
If nodes are specifically assigned to one side using the layout data property nodesBeforeBus, but the value of this property is set to 0, then the maximum will be exceeded as necessary. The maximum can also be exceeded if there are too many fixed bus nodes in the same layer (when running in incremental mode) or when bus layers are user-specified via gridComponentRootOffsets.
final

Property Value

the maximum number of nodes that are allowed to be placed before the bus segment

Throws

Exception ({ name: 'ArgumentError' })
if the given node count is negative

Default Value

The default value is: 0
If the maximum number of nodes after the bus is 0 too, then the number of nodes is unrestricted, otherwise all nodes are placed after the bus.

Sample Graphs

ShownSetting: Example result with evenly distributed nodes: both, before and after node count are 0

See Also

Developer's Guide

Constants

All constants are filtered. Go to Filters.