This class represents the result of a layout run of MultiPageLayout.
Inheritance Hierarchy
MultiPageLayoutResult
Remarks
A layout run subdivides the input graph into several LayoutGraphs (called page graphs) such that the layout of each graph fits the specified maximumPageSize. This class provides access to the different page graphs (see pageGraphs).
An instance of this class can be obtained by executing the algorithm via the LayoutExecutor or by using applyLayoutImpl when directly working on the LayoutGraph API. The layoutCallback has to be set before starting the layout run.
This class cannot be instantiated
Type Details
- yFiles module
- algorithms
Properties
Gets the layout context that holds more information about the MultiPageLayout run, for example, allowing access to information about nodes and edges.
Remarks
Via the context, it is possible to query more information about nodes, edges, node labels, and edge labels. For example, see methods getNodeType, getEdgeType or getRepresentedEdge.
Returns the page graphs.
Remarks
A page graph is a subgraph of the input graph whose layout fits the specified maximumPageSize.
A page graph contains special nodes (that are not contained in the input graph) to guarantee that no information is lost when splitting edges that connect nodes placed on different pages.
All items of the page graphs are created by the layout algorithm. The input graph remains unchanged. When calling the layout algorithm with a MultiPageLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>, the original items of items in the page graphs can be obtained by calling getOriginalItem , getOriginalItem , getOriginalItem , or getOriginalItem .