Remarks
This class allows specifying per-item data to ILayoutAlgorithms.
Implementations of this class provide item-specific configuration options for a specific layout. Properties that are unrelated to specific items but affect the layout calculation are typically available on the specific layout class itself.
The LayoutExecutor applies these configurations when started. So does applyLayout, and applyLayoutAnimated.
When working only with LayoutGraph as input instance, then the layout data is passed via method applyLayout.
You cannot properly subclass this type, as it relies on internal implementations that are not accessible to subclasses outside the library. In order to pass custom data to a layout, consider using the GenericLayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> class, instead.
On a technical level, instances of this class collect information from the elements in the input graph (usually IGraph, but can also be LayoutGraph) that should be laid out and make sure it gets attached to the LayoutGraph that is used by the layout algorithm.
Type Parameters
TNode
TEdge
TNodeLabel
TEdgeLabel
See Also
Developer's Guide
API
- layoutData, applyLayout, applyLayoutAnimated, GenericLayoutData
Members
Methods
combineWith
(data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>): LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>Combines this instance with the given layout data.
combineWith
(data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>): LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>Parameters
- data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>
- The LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> to combine this instance with.
Return Value
- LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>
- The combined layout data.
See Also
Developer's Guide
API
- CompositeLayoutData, GenericLayoutData