C

MultiPageLayoutResult

This class represents the result of a layout run of MultiPageLayout.
Inheritance Hierarchy

Remarks

A layout run subdivides the input graph into several LayoutGraphs (called page graphs) such that the layout of each graph fits the specified MultiPageLayout.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 MultiPageLayout.applyLayoutImpl when directly working on the LayoutGraph API. The MultiPageLayout.layoutCallback has to be set before starting the layout run.

This class cannot be instantiated

See Also

Developer's Guide

Members

No filters for this type

Properties

Gets the layout context that holds more information about the MultiPageLayout run, for example, allowing access to information about nodes and edges.
Via the context, it is possible to query more information about nodes, edges, node labels, and edge labels. For example, see methods MultiPageLayoutContext.getNodeType, MultiPageLayoutContext.getEdgeType or MultiPageLayoutContext.getRepresentedEdge.
readonlyfinal

See Also

Developer's Guide
Returns the page graphs.
A page graph is a subgraph of the input graph whose layout fits the specified MultiPageLayout.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.
readonlyfinal