Layout algorithm that subdivides the input graph into several LayoutGraph s (called page graphs) such that the layout of each graph fits the specified maximum page size .

Namespace: yWorks.yFiles.Layout.Multipage
Assembly: yWorks.yFilesSilverlight.Algorithms (in yWorks.yFilesSilverlight.Algorithms.dll) Version: 2.4.0.0

Syntax

C#
public class MultiPageLayouter : AbstractLayoutStage
Visual Basic
Public Class MultiPageLayouter _ Inherits AbstractLayoutStage

Remarks

Layout algorithm that subdivides the input graph into several LayoutGraph s (called page graphs) such that the layout of each graph fits the specified maximum page size .

To guarantee that no information is lost, the layout algorithm replaces edges between nodes on different pages by so-called connector nodes (see Connector ). Furthermore, it may replicate (proxy) nodes and insert elements called proxy reference nodes to refers to such proxies (see Proxy and ProxyReference ).

Unlike other yFiles layout algorithms, MultiPageLayouter does not modify its input graph but returns its result as a MultiPageLayout . To be able to profit as much as possible from existing layout support, MultiPageLayouter implements the ILayouter interface although method doLayout does not specify a return value. Therefore client code has to register a ILayoutCallback that is notified of MultiPageLayouter results.

Note: Client code must register data providers for keys NodeIdDpKey , EdgeIdDpKey , NodeLabelIdDpKey , and EdgeLabelIdDpKey before calling DoLayout(LayoutGraph) or CalcLayout(LayoutGraph) .

Inheritance Hierarchy

System..::..Object
  yWorks.yFiles.Layout..::..AbstractLayoutStage
    yWorks.yFiles.Layout.Multipage..::..MultiPageLayouter

See Also