Specifies custom data for the MultiPageLayout.
Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.multipage.MultiPageLayoutData
See Also
Constructors
Creates a new instance of MultiPageLayoutData which helps configuring MultiPageLayout.
Parameters
A map of options to pass to the method.
- nodeIds - ItemMapping<INode,Object>
The mapping from nodes to their unique IDs. This option sets the nodeIds property on the created object.
- edgeIds - ItemMapping<IEdge,Object>
The mapping from edges to their unique IDs. This option sets the edgeIds property on the created object.
- nodeLabelIds - ItemMapping<ILabel,Object>
The mapping from node labels to their unique IDs. This option sets the nodeLabelIds property on the created object.
- edgeLabelIds - ItemMapping<ILabel,Object>
The mapping from edge labels to their unique IDs. This option sets the edgeLabelIds property on the created object.
- nodeClusterIds - ItemMapping<INode,Object>
The mapping from nodes to their cluster id. This option sets the nodeClusterIds property on the created object.
- edgeTypes - ItemMapping<IEdge,Object>
The mapping from edges to their type. This option sets the edgeTypes property on the created object.
- abortHandler - AbortHandler
The AbortHandler used during the layout. This option sets the abortHandler property on the created object.
Properties
Gets or sets the AbortHandler used during the layout.
Remarks
An AbortHandler can be used to gracefully stop or cancel a running layout and offers options for automatically doing so after a predetermined time.
An AbortHandler configured or set here overrides the one on LayoutExecutor.
Examples
The most common use case would be to just configure the AbortHandler here, e.g. to set timeouts for a graceful stop or canceling the running layout:
layoutData.abortHandler.stopDuration = TimeSpan.fromSeconds(10) layoutData.abortHandler.cancelDuration = TimeSpan.fromSeconds(30)
layoutData.abortHandler!.stopDuration = TimeSpan.fromSeconds(10) layoutData.abortHandler!.cancelDuration = TimeSpan.fromSeconds(30)
If there's already an AbortHandler instance that's pre-configured or will be used in a different place to, e.g., cancel the layout when the user presses a button, you can also set one explicitly:
layoutData.abortHandler = abortHandler
See Also
Gets or sets the mapping from edges to their unique IDs.
Gets or sets the mapping from edge labels to their unique IDs.
Gets or sets the mapping from edges to their type.
Remarks
See Also
Gets or sets the mapping from nodes to their cluster id.
Remarks
See Also
Gets or sets the mapping from nodes to their unique IDs.
Gets or sets the mapping from node labels to their unique IDs.
Methods
Combines this instance with the given layout data.
Remarks
Parameters
A map of options to pass to the method.
- data - LayoutData
- The LayoutData to combine this instance with.
Returns
- ↪LayoutData
- The combined layout data.