This class provides context during the HierarchicalLayout, like HierarchicalLayoutNodeContext and HierarchicalLayoutEdgeContext instances for elements in the current layout graph.
Remarks
Instances of this class are provided by HierarchicalLayoutCore and HierarchicalLayout for instances implementing sub-tasks during the layout.
This class cannot be instantiated
Type Details
- yFiles module
- algorithms
See Also
Properties
Gets or sets the active ItemFactory instance for the HierarchicalLayoutCore.
Remarks
See Also
Gets a list of the active HierarchicalLayoutLayers for the HierarchicalLayoutCore, basically describing the assignment of nodes to layers and their position in the layer.
Remarks
See Also
Methods
Returns the HierarchicalLayoutEdgeContext instance associated with the given LayoutEdge.
Parameters
A map of options to pass to the method.
- edge - LayoutEdge
- the given edge
Returns
- ↪HierarchicalLayoutEdgeContext?
- the HierarchicalLayoutEdgeContext instance associated with the edge
Returns the HierarchicalLayoutNodeContext instance associated with the given LayoutNode.
Parameters
A map of options to pass to the method.
- node - LayoutNode
- The given node
Returns
- ↪HierarchicalLayoutNodeContext?
- The HierarchicalLayoutNodeContext instance associated with the node
Creates and inserts a layer of a given type into the list of layers.
Parameters
A map of options to pass to the method.
- type - HierarchicalLayoutLayerType
- One of the predefined layer types as defined with property type in class HierarchicalLayoutLayer.
- position - number
- The index at which the specified layer is to be inserted.
Returns
- ↪HierarchicalLayoutLayer
- A new HierarchicalLayoutLayer instance.