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 .
Inheritance Hierarchy
Members
Show:
Constructors
Properties
Gets or sets the mapping for specifying which multi-edges may share a connector node.
Gets or sets the mapping for specifying which multi-edges may share a connector node.
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.
If this option is used, the multiEdgeConnectorPolicy will be ignored.
conversionfinal
See Also
Gets or sets the mapping from nodes to their cluster id.
Gets or sets the mapping from nodes to their cluster id.
Nodes with the same cluster id should preferably be placed on the same page.
conversionfinal
See Also
Developer's Guide
API
- NODE_CLUSTER_ID_DATA_KEY
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>Combines this instance with the given layout data.
This keeps the current instance unmodified and instead returns a new instance that dynamically combines the contents of all involved instances.
final
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
Defined in
LayoutData.combineWithReturns a node of the original input graph that corresponds to the provided node of the LayoutGraph returned by the MultiPageLayout.
Returns a node of the original input graph that corresponds to the provided node of the LayoutGraph returned by the MultiPageLayout.
As the multi-page layout introduces auxiliary nodes, this method might return
null.This method is only guaranteed to work if the MultiPageLayout was called with this layout data.
final
Parameters
- layoutNode: LayoutNode
- a node of the page graph
- result: MultiPageLayoutResult
- the result of the MultiPageLayout
Return Value
- 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
See Also
Developer's Guide
Returns an edge of the original input graph that corresponds to the provided edge of the LayoutGraph returned by the MultiPageLayout.
Returns an edge of the original input graph that corresponds to the provided edge of the LayoutGraph returned by the MultiPageLayout.
As the multi-page layout introduces auxiliary nodes, this method might return
null.This method is only guaranteed to work if the MultiPageLayout was called with this layout data.
final
Parameters
- layoutEdge: LayoutEdge
- an edge of the page graph
- result: MultiPageLayoutResult
- the result of the MultiPageLayout
Return Value
- 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.
Returns the label of the original input graph that corresponds to the provided node label of the LayoutGraph returned by the MultiPageLayout.
As the multi-page layout introduces auxiliary nodes, this method might return
null.This method is only guaranteed to work if the MultiPageLayout was called with this layout data.
final
Parameters
- layoutLabel: LayoutNodeLabel
- a node label of the page graph
- result: MultiPageLayoutResult
- the result of the MultiPageLayout
Return Value
- 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.
Returns the label of the original input graph that corresponds to the provided edge label of the LayoutGraph returned by the MultiPageLayout.
As the multi-page layout introduces auxiliary nodes, this method might return
null.This method is only guaranteed to work if the MultiPageLayout was called with this layout data.
final
Parameters
- layoutLabel: LayoutEdgeLabel
- an edge label of the page graph
- result: MultiPageLayoutResult
- the result of the MultiPageLayout
Return Value
- TEdgeLabel
- The corresponding label of the original graph or
nullif the edge label does not correspond to a label in the original graph