Specifies custom data for the TreeReductionStage.
Inheritance Hierarchy
LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
TreeReductionStageData
Type Parameters
- TNode
- TEdge
- TNodeLabel
- TEdgeLabel
Type Details
- yFiles module
- algorithms
Constructors
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- nonTreeEdges - ItemCollection<TEdge>
- The collection of edges explicitly marked as not belonging to a tree. This option either sets the value directly or recursively sets properties to the instance of the nonTreeEdges property on the created object.
- edgeBundleDescriptors - ItemMapping<TEdge,EdgeBundleDescriptor>
- The mapping of edges to their EdgeBundleDescriptor. This option either sets the value directly or recursively sets properties to the instance of the edgeBundleDescriptors property on the created object.
Properties
Gets or sets the mapping of edges to their EdgeBundleDescriptor.
Remarks
Bundling together multiple edges means that their common parts are to some degree merged into a bundled part. At the source and target point, the edges are again clearly split.
If an edge is mapped to null, the default descriptor is used.
See Also
Gets or sets the collection of edges explicitly marked as not belonging to a tree.
Gets the edge collection that after the layout run will contain all edges that were selected to become non-tree edges by the TreeReductionStage.
Remarks
The set of non-tree edges corresponds to the edges that were hidden during the coreLayout (e.g. a tree layout algorithm) of the TreeReductionStage.
See Also
This collection will be cleared before each layout run and filled with the resulting edges during the run.
Methods
combineWith
(data: LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>…) : LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>Combines this instance with the given layout data.
Remarks
This keeps the current instance unmodified and instead returns a new instance that dynamically combines the contents of all involved instances.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- data - LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> to combine this instance with.
Returns
- ↪LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The combined layout data.
See Also
CompositeLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>,
GenericLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>