Specifies custom data for the MultiPageLayout and automatically takes care of handling item IDs, providing a translation back to original items, via methods like getOriginalItem .
Type Parameters
- TNode
- TEdge
- TNodeLabel
- TEdgeLabel
Type Details
- yFiles module
- algorithms
Constructors
Parameters
A map of options to pass to the method.
- nodeClusterIds - ItemMapping<TNode,any>
- The mapping from nodes to their cluster id. This option either sets the value directly or recursively sets properties to the instance of the nodeClusterIds property on the created object.
- multiEdgeConnectorIds - ItemMapping<TEdge,any>
- The mapping for specifying which multi-edges may share a connector node. This option either sets the value directly or recursively sets properties to the instance of the multiEdgeConnectorIds property on the created object.
Properties
Gets or sets the mapping for specifying which multi-edges may share a connector node.
Remarks
Multi-edges are edges with the same endpoints. If multi-edges are split because their endpoints are placed on different pages, all multi-edges with the same connector id use the same connector node.
If the predefined multi-edge connector policies for controlling which multi-edges should share connectors are not sufficient for your use case, you can manually select these multi-edges with this property.
See Also
Gets or sets the mapping from nodes to their cluster id.
Remarks
See Also
Methods
combineWith
(data: LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>…) : LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>Combines this instance with the given layout data.
Remarks
Parameters
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
Defined in
Returns a node of the original input graph that corresponds to the provided node of the LayoutGraph returned by the MultiPageLayout.
Remarks
null.Parameters
A map of options to pass to the method.
- layoutNode - LayoutNode
- a node of the page graph
- result - MultiPageLayoutResult
- the result of the MultiPageLayout
Returns
- ↪TNode?
- The corresponding node of the original graph or
nullif the node does not correspond to a node in the original graph, e.g. if it is an auxiliary node
Returns an edge of the original input graph that corresponds to the provided edge of the LayoutGraph returned by the MultiPageLayout.
Remarks
null.Parameters
A map of options to pass to the method.
- layoutEdge - LayoutEdge
- an edge of the page graph
- result - MultiPageLayoutResult
- the result of the MultiPageLayout
Returns
- ↪TEdge?
- The corresponding edge of the original graph or
nullif the edge does not correspond to an edge in the original graph
Returns the label of the original input graph that corresponds to the provided node label of the LayoutGraph returned by the MultiPageLayout.
Remarks
null.Parameters
A map of options to pass to the method.
- layoutLabel - LayoutNodeLabel
- a node label of the page graph
- result - MultiPageLayoutResult
- the result of the MultiPageLayout
Returns
- ↪TNodeLabel?
- The corresponding label of the original graph or
nullif the node label does not correspond to a label in the original graph
Returns the label of the original input graph that corresponds to the provided edge label of the LayoutGraph returned by the MultiPageLayout.
Remarks
null.Parameters
A map of options to pass to the method.
- layoutLabel - LayoutEdgeLabel
- an edge label of the page graph
- result - MultiPageLayoutResult
- the result of the MultiPageLayout
Returns
- ↪TEdgeLabel?
- The corresponding label of the original graph or
nullif the edge label does not correspond to a label in the original graph