This interface provides layout information about the nodes of the graph during the layout.
Remarks
INodeData is a multi-purpose node descriptor for each node of the graph during the hierarchic layout used internally by the algorithm implementations.
Instances of this interface can be obtained during the layout from instances of the ILayoutDataProvider interface.
INodeData typically carries the type of the node and depending on the type an optional associated edge and associated node. Optionally, it may carry a geometric description of the borders of the node and descriptors for various aspects of the layout.
Type Details
- yfiles module
- layout-hierarchic
- yfiles-umd modules
- layout-familytree, layout-hierarchic, layout-radial, layout
- Legacy UMD name
- yfiles.hierarchic.INodeData
Properties
Gets the group node this node belongs to.
Gets the hint of the incremental mode of the YNode of this INodeData instance if this node is of type NORMAL.
Remarks
Gets the HierarchicLayoutNodeLayoutDescriptor instance initially bound to the YNode of this INodeData instance or null if no HierarchicLayoutNodeLayoutDescriptor has been registered.
Gets the SwimlaneDescriptor instance initially bound to the YNode of this INodeData instance or null if no SwimlaneDescriptor has been registered.
Methods
Creates, stores and returns a BorderLine for the given side or returns the current BorderLine instance if it already exists.
Remarks
Not every type of node supports this operation. NORMAL supports BorderLines.
Side value must be inside [0,3] interval, where 0 corresponds to the top side, 1 to the right side, 2 to the bottom side and 3 to the left side.
Parameters
A map of options to pass to the method.
- side - number
- an integer value from
[0,3]interval - nodeLayout - INodeLayout
- the INodeLayout of the current node
Returns
- ↪BorderLine
- a BorderLine instance
Throws
See Also
Returns a BorderLine for the given side which is treated as if the position of the node is at (0,0).
Remarks
Clients may modify this instance but should always reset it to the original position, since this is a shared instance.
It may return null to indicate that the BorderLine can be determined through the INodeLayout instance.
Side value must be inside [0,3] interval, where 0 corresponds to the top side, 1 to the right side, 2 to the bottom side and 3 to the left side.
Parameters
A map of options to pass to the method.
- side - number
- an integer value from
[0,3]interval
Returns
- ↪BorderLine
- a BorderLine instance or
null