Provides options for handling grouped graphs during the HierarchicalLayout's layering stage.
Members
No filters for this type
Constants
If this policy is set, all nodes are considered together during the layering stage, regardless of their position in the graph's grouping hierarchy.
static
Sample Graphs
ShownSetting: IGNORE_GROUPS
See Also
Developer's Guide
If this policy is set, groups are layered recursively, i.e.
- nodes in the same group always occupy adjacent layers
- layer intervals spanned by different group nodes are either disjoint or are nested
If the graph is flat, this policy has no effect.
The recursive processing of groups restricts the valid layering results which has to be considered when specifying layerConstraints. To ensure that such constraints are correctly considered, it is recommended to only specify them between elements of the same grouping hierarchy (i.e., elements with the same parent group).
static
Sample Graphs
ShownSetting: IGNORE_GROUPS
See Also
Developer's Guide
This policy behaves like RECURSIVE, with the exception, that additionally the number of node layers is decreased if possible without reversing edge directions. The resulting layering tries to keep the layer span of a group node low (i.e., the height of a group for layout orientation top-to-bottom). Note that a lower number of layers usually leads to an increased overall width (for layout orientation top-to-bottom).
This policy works best when an instance of TopologicalLayerAssigner is used for layer assignment. If this feature is enabled, an alignment policy that is set with groupAlignmentPolicy is ignored.
This property only influences the layer compactness (i.e., vertical compactness for layout orientation top-to-bottom). In order to obtain more compact group nodes with respect to the required width (i.e., horizontal compactness) use property groupCompaction.
static
Sample Graphs
ShownSetting: RECURSIVE
See Also
Developer's Guide
API
- groupCompaction
Static Methods
Converts the given argument to an enum constant of this enum type.
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static
Parameters
- value: GroupLayeringPolicy
- The value to convert to an enum constant.
Return Value
- GroupLayeringPolicy
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Returns the name of the given enum constant.
static
Parameters
- value: GroupLayeringPolicy
- The numeric value of an enum constant.
Return Value
- string
- The name of the enum constant.
Throws
- Exception ({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.