This class represents the result of a layout run of MultiPageLayout.
Remarks
A layout run subdivides the input graph into several LayoutGraphs (called page graphs) such that the layout of each graph fits the specified maximum page size. This class provides access to the different page graphs (see method getPage).
An instance of this class can be either obtained by calling calculateLayout or applyLayout. In the latter case, a ILayoutCallback has to be set before starting the layout run.
Type Details
- yfiles module
- layout-multipage
- yfiles-umd modules
- layout-multipage, layout
- Legacy UMD name
- yfiles.multipage.MultiPageLayoutResult
See Also
Methods
Returns the edge label information object of the given edge label layout.
Parameters
A map of options to pass to the method.
- edgeLabelLayout - IEdgeLabelLayout
- the edge label layout for which the information object should be returned
Returns
- ↪IEdgeLabelInfo
- the edge label information object of the given edge label layout
Implements
Returns the node label layout information object of the given node label layout.
Parameters
A map of options to pass to the method.
- nodeLabelLayout - INodeLabelLayout
- the node label layout for which the information object should be returned
Returns
- ↪INodeLabelInfo
- the node label information object of the given node label layout
Implements
Returns the page graph associated with the given page number.
Remarks
The page number is zero-based, i.e., the first page has number 0 and the last page pageCount - 1.
A page graph is a subgraph of the input graph whose layout fits the specified maximum page size.
Parameters
A map of options to pass to the method.
- pageNo - number
- the given page number (with
0being the first page)
Returns
- ↪LayoutGraph
- the page graph associated with the given page number
Throws
- Exception({ name: 'IndexOutOfRangeError' })
- if
pageNo >= pageCountorpageNo < 0
See Also
Returns the number of pages available in this MultiPageLayoutResult.
Remarks
Returns
- ↪number
- the number of available pages