This class is a ISequencer implementation that determines the sequence of nodes of the same layer based on a given comparator constraint.
Default Values of Properties
| sequenceComparer | null | No |
Type Details
- yfiles module
- layout-hierarchic
- yfiles-umd modules
- layout-familytree, layout-hierarchic, layout-radial, layout
- Legacy UMD name
- yfiles.hierarchic.GivenSequenceSequencer
Constructors
Creates a new instance of GivenSequenceSequencer using a given IComparer<T> for the sequencing.
Properties
Gets or sets the IComparer<T> used by this GivenSequenceSequencer to determine the sequence of the nodes.
Default Value
The default value is
null.No
Methods
sequenceNodeLayers
(graph: LayoutGraph, layers: ILayers, ldp: ILayoutDataProvider, itemFactory: IItemFactory)Calculates the sequence of the nodes within a ILayers instance based on the given IComparer<T> instance.
Remarks
This method is called by HierarchicLayoutCore during the sequencing phase and finally writes back the calculated sequence using the setNodeOrder method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
- layers - ILayers
- the given ILayers instance containing the elements of the layers
- ldp - ILayoutDataProvider
- the ILayoutDataProvider containing information about the nodes and edges of the graph
- itemFactory - IItemFactory
- the IItemFactory used for creating and destroying helper structures