| Package | com.yworks.yfiles.layout.multipage |
| Class | public class MultiPageLayouter |
| Inheritance | MultiPageLayouter  AbstractLayoutStage YObject Object |
To guarantee that no information is lost, the layout algorithm replaces edges between nodes on different pages by so-called connector nodes (see com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_CONNECTOR). Furthermore, it may replicate (proxy) nodes and insert elements called proxy reference nodes to refers to such proxies (see com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_PROXY and com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_PROXY_REFERENCE).
Unlike other yFiles layout algorithms, MultiPageLayouter does not modify its input graph but returns its result as a com.yworks.yfiles.layout.multipage.MultiPageLayout . To be able to profit as much as possible from existing layout support, MultiPageLayouter implements the com.yworks.yfiles.layout.Layouter interface although method doLayout (com.yworks.yfiles.layout.Layouter.doLayout()) does not specify a return value. Therefore client code has to register (layoutCallback) a com.yworks.yfiles.layout.multipage.LayoutCallback that is notified of MultiPageLayouter results.
Note: Client code must register data providers for keys NODE_ID_DPKEY, EDGE_ID_DPKEY, NODE_LABEL_ID_DPKEY, and EDGE_LABEL_ID_DPKEY before calling doLayout() or calcLayout().
See also
| Property | Defined By | ||
|---|---|---|---|
 | coreLayouter : Layouter
Specifies the core layouter. | AbstractLayoutStage | |
| edgeBundleModeMask : int
Getter:
Returns the bit mask that is used to define edge bundles. | MultiPageLayouter | ||
| elementFactory : ElementFactory
Specifies the element factory that is used to create special nodes and edges in a multi-page layout. | MultiPageLayouter | ||
| groupMode : int
Specifies how to handle node grouping. | MultiPageLayouter | ||
| labelLayouter : LayoutStage
Getter:
Returns the algorithm that is used for placing labels. | MultiPageLayouter | ||
| labelLayouterEnabled : Boolean
Getter:
Returns whether or not the specified labeling stage is enabled. | MultiPageLayouter | ||
| layoutCallback : LayoutCallback
Specifies the callback that is notified upon completion of multi-page layout calculation runs. | MultiPageLayouter | ||
| maxPageSize : YDimension
Specifies the maximum size allowed for a single page. | MultiPageLayouter | ||
| preferredMaximalDuration : LongImpl
Getter:
Returns the preferred time limit (in milliseconds) set for the layout algorithm. | MultiPageLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
MultiPageLayouter(core:Layouter, init:Boolean = true)
Creates an instance of this layouter. | MultiPageLayouter | ||
Calculates a new multi-page layout for the specified graph. | MultiPageLayouter | ||
canLayout(graph:LayoutGraph):Boolean [override] | MultiPageLayouter | ||
doLayout(graph:LayoutGraph):void [override]
Calculates a new multi-page layout for the specified graph. | MultiPageLayouter | ||
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | MultiPageLayouter | ||
| hashCode():int | YObject | |
[static]
Creates an instance of this layouter. | MultiPageLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
| canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out. | AbstractLayoutStage | |
Creates an element factory for multi-page layouts. | MultiPageLayouter | ||
Called to improve layout results. | MultiPageLayouter | ||
| doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter. | AbstractLayoutStage | |
| initAbstractLayoutStage1():void | AbstractLayoutStage | |
| initAbstractLayoutStage2(core:Layouter):void | AbstractLayoutStage | |
initMultiPageLayouter(core:Layouter):void
Initializes this object. | MultiPageLayouter | ||
removeConnectorPair(connector1:Node, connector2:Node, originalEdgeIds:YList, context:LayoutContext):Boolean
Called during a postprocessing step that reduces the number of connectors. | MultiPageLayouter | ||
routeRestoredEdges(graph:LayoutGraph, selectedEdgesDP:DataProvider, boundingRectangle:YRectangle):void
Called by method removeConnectorPair() to route the restored edges. | MultiPageLayouter | ||
| Constant | Defined By | ||
|---|---|---|---|
| EDGE_BUNDLE_DISTINGUISH_DIRECTIONS : int = 2 [static]
Edge bundle mode specifier. | MultiPageLayouter | ||
| EDGE_BUNDLE_DISTINGUISH_MULTIEDGES : int = 1 [static]
Edge bundle mode specifier. | MultiPageLayouter | ||
| EDGE_BUNDLE_DISTINGUISH_TYPES : int = 4 [static]
Edge bundle mode specifier. | MultiPageLayouter | ||
| EDGE_ID_DPKEY : Object = y.layout.multipage.MultiPageLayouter.EDGE_ID_DPKEY [static]
Used to map each edge of the input graph to a unique id. | MultiPageLayouter | ||
| EDGE_LABEL_ID_DPKEY : Object = y.layout.multipage.MultiPageLayouter.EDGE_LABEL_ID_DPKEY [static]
Used to map each edge label of the input graph to a unique id. | MultiPageLayouter | ||
| EDGE_TYPE_DPKEY : Object = y.layout.multipage.MultiPageLayouter.EDGE_TYPE_DPKEY [static]
Allows to specify the edge kind (an object). | MultiPageLayouter | ||
| GROUP_MODE_ALL_NODES : int = 2 [static]
Node grouping specifier. | MultiPageLayouter | ||
| GROUP_MODE_IGNORE : int = 0 [static]
Node grouping specifier. | MultiPageLayouter | ||
| GROUP_MODE_ORIGINAL_NODES_ONLY : int = 1 [static]
Node grouping specifier. | MultiPageLayouter | ||
| NODE_CLUSTER_ID_DPKEY : Object = y.layout.multipage.MultiPageLayouter.NODE_CLUSTER_ID_DPKEY [static]
Allows to specify a cluster id (an object) for each node. | MultiPageLayouter | ||
| NODE_ID_DPKEY : Object = y.layout.multipage.MultiPageLayouter.NODE_ID_DPKEY [static]
Used to map each node of the input graph to a unique id. | MultiPageLayouter | ||
| NODE_LABEL_ID_DPKEY : Object = y.layout.multipage.MultiPageLayouter.NODE_LABEL_ID_DPKEY [static]
Used to map each node label of the input graph to a unique id. | MultiPageLayouter | ||
| edgeBundleModeMask | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesedgeBundleModeMask:intGetter: Returns the bit mask that is used to define edge bundles.
Setter: Specifies a bit mask that is used to define edge bundles. All multi-edges (edges with same endpoints) belonging to the same edge bundle are split by the same connector pair (see com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_CONNECTOR). Possible values are EDGE_BUNDLE_DISTINGUISH_TYPES, EDGE_BUNDLE_DISTINGUISH_DIRECTIONS and EDGE_BUNDLE_DISTINGUISH_MULTIEDGES. public function get edgeBundleModeMask():int public function set edgeBundleModeMask(value:int):voidSee also
| elementFactory | property |
elementFactory:ElementFactorySpecifies the element factory that is used to create special nodes and edges in a multi-page layout.
public function get elementFactory():ElementFactory public function set elementFactory(value:ElementFactory):voidSee also
| groupMode | property |
groupMode:intSpecifies how to handle node grouping. Possible values are GROUP_MODE_IGNORE, GROUP_MODE_ALL_NODES and GROUP_MODE_ORIGINAL_NODES_ONLY.
public function get groupMode():int public function set groupMode(value:int):voidSee also
| labelLayouter | property |
labelLayouter:LayoutStageGetter: Returns the algorithm that is used for placing labels. By default an instance of class com.yworks.yfiles.layout.labeling.GreedyMISLabeling will be returned that considers edge labels only.
Setter: Sets the algorithm that is used for placing labels. Note that assigning a new layout stage will not automatically activate it. To activate this stage use labelLayouterEnabled. public function get labelLayouter():LayoutStage public function set labelLayouter(value:LayoutStage):voidSee also
| labelLayouterEnabled | property |
labelLayouterEnabled:BooleanGetter: Returns whether or not the specified labeling stage is enabled.
Setter: Specifies whether or not to enable the labeling stage. By default it is disabled. public function get labelLayouterEnabled():Boolean public function set labelLayouterEnabled(value:Boolean):voidSee also
| layoutCallback | property |
layoutCallback:LayoutCallbackSpecifies the callback that is notified upon completion of multi-page layout calculation runs.
public function get layoutCallback():LayoutCallback public function set layoutCallback(value:LayoutCallback):void| maxPageSize | property |
maxPageSize:YDimensionSpecifies the maximum size allowed for a single page. The default value is width = height = 1000. Note that a large page size may increase runtime significantly. To limit runtime use method preferredMaximalDuration.
public function get maxPageSize():YDimension public function set maxPageSize(value:YDimension):voidSee also
| preferredMaximalDuration | property |
preferredMaximalDuration:LongImplGetter: Returns the preferred time limit (in milliseconds) set for the layout algorithm.
Setter: Sets a preferred time limit (in milliseconds) for the layout algorithm. Note that restricting the maximal duration may result in a worse layout quality. Furthermore, the actual runtime may exceed the maximal duration since the layout algorithm still has to find a valid solution. public function get preferredMaximalDuration():LongImpl public function set preferredMaximalDuration(value:LongImpl):void| MultiPageLayouter | () | Constructor |
public function MultiPageLayouter(core:Layouter, init:Boolean = true)Creates an instance of this layouter.
Parameterscore:Layouter — the layouter used to layout a page.
| |
init:Boolean (default = true) |
| calcLayout | () | method |
public function calcLayout(graph:LayoutGraph):MultiPageLayoutCalculates a new multi-page layout for the specified graph.
Parameters
graph:LayoutGraph — the input graph.
|
MultiPageLayout — an object that represents the results of the layout run.
|
See also
| canLayout | () | method |
override public function canLayout(graph:LayoutGraph):BooleanParameters
graph:LayoutGraph |
Boolean |
| createElementFactory | () | method |
protected function createElementFactory():ElementFactoryCreates an element factory for multi-page layouts. Called from elementFactory if no factory has been explicitly set using elementFactory.
ReturnsElementFactory — a com.yworks.yfiles.layout.multipage.DefaultElementFactory instance.
|
See also
| doIncrementalLayout | () | method |
protected function doIncrementalLayout(graph:LayoutGraph, incrementalNodesDP:DataProvider, context:LayoutContext):voidCalled to improve layout results. The marked nodes have to be placed without changing the coordinates of the fixed (non-marked) elements, without exceeding the specified maximum page size and without violating basic layout properties.
Parameters
graph:LayoutGraph — the graph to layout.
| |
incrementalNodesDP:DataProvider — a DataProvider that marks nodes that should be placed (nodes for which getBool() returns true). The position of the other nodes is not allowed to change.
| |
context:LayoutContext — the current layout context.
|
See also
| doLayout | () | method |
override public function doLayout(graph:LayoutGraph):voidCalculates a new multi-page layout for the specified graph. This method calls calcLayout() and notifies the registered layout callback (layoutCallback) of the calculated result.
Warning: Unlike other implementations of the com.yworks.yfiles.layout.Layouter.doLayout() method, the result of the layout calculation will not be applied to the input graph.
Parameters
graph:LayoutGraph — the input graph.
|
See also
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initMultiPageLayouter | () | method |
protected final function initMultiPageLayouter(core:Layouter):void
Initializes this object. See the documentation of the corresponding factory method newMultiPageLayouter() for details.
Parameters
core:Layouter |
See also
| newMultiPageLayouter | () | method |
public static function newMultiPageLayouter(core:Layouter):MultiPageLayouterCreates an instance of this layouter.
Parameters
core:Layouter — the layouter used to layout a page.
|
MultiPageLayouter |
| removeConnectorPair | () | method |
protected function removeConnectorPair(connector1:Node, connector2:Node, originalEdgeIds:YList, context:LayoutContext):BooleanCalled during a postprocessing step that reduces the number of connectors. A pair of connectors can be removed if both connector nodes are placed on the same page. This method removes both connector nodes and restores the original edges. It calls method routeRestoredEdges() to route these edges.
Parameters
connector1:Node — the first connector of the connector pair.
| |
connector2:Node — the second connector of the connector pair.
| |
originalEdgeIds:YList — the ids of the original edges that have to be restored.
| |
context:LayoutContext — the current layout context.
|
Boolean — whether or not the removal of the connector pair was successful. If the method returns false the graph was not changed, i.e., the connector pair was not removed.
|
See also
| routeRestoredEdges | () | method |
protected function routeRestoredEdges(graph:LayoutGraph, selectedEdgesDP:DataProvider, boundingRectangle:YRectangle):voidCalled by method removeConnectorPair() to route the restored edges.
Parameters
graph:LayoutGraph — the relevant graph.
| |
selectedEdgesDP:DataProvider — marks the edges that should be rerouted.
| |
boundingRectangle:YRectangle — the edge routes should be fully contained within this rectangle.
|
See also
| EDGE_BUNDLE_DISTINGUISH_DIRECTIONS | Constant |
public static const EDGE_BUNDLE_DISTINGUISH_DIRECTIONS:int = 2Edge bundle mode specifier. Used to define edge bundles. All multi-edges (edges with same endpoints) belonging to the same edge bundle are split by the same connector pair (see com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_CONNECTOR). This value specifies that multi-edges should be distinguished if the have different directions.
See also
| EDGE_BUNDLE_DISTINGUISH_MULTIEDGES | Constant |
public static const EDGE_BUNDLE_DISTINGUISH_MULTIEDGES:int = 1Edge bundle mode specifier. Used to define edge bundles. All multi-edges (edges with same endpoints) belonging to the same edge bundle are split by the same connector pair (see com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_CONNECTOR). This value specifies that all multi-edges should be distinguished, i.e., a separate connector pair is used for each multi-edge.
See also
| EDGE_BUNDLE_DISTINGUISH_TYPES | Constant |
public static const EDGE_BUNDLE_DISTINGUISH_TYPES:int = 4Edge bundle mode specifier. Used to define edge bundles. All multi-edges (edges with same endpoints) belonging to the same edge bundle are split by the same connector pair (see com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_CONNECTOR). This value specifies that multi-edges should be distinguished if they are of different (user specified) type, see EDGE_TYPE_DPKEY.
See also
| EDGE_ID_DPKEY | Constant |
public static const EDGE_ID_DPKEY:Object = y.layout.multipage.MultiPageLayouter.EDGE_ID_DPKEYUsed to map each edge of the input graph to a unique id. Note: this DataProvider has to be specified by the user!
| EDGE_LABEL_ID_DPKEY | Constant |
public static const EDGE_LABEL_ID_DPKEY:Object = y.layout.multipage.MultiPageLayouter.EDGE_LABEL_ID_DPKEYUsed to map each edge label of the input graph to a unique id. Note: this DataProvider has to be specified by the user!
| EDGE_TYPE_DPKEY | Constant |
public static const EDGE_TYPE_DPKEY:Object = y.layout.multipage.MultiPageLayouter.EDGE_TYPE_DPKEYAllows to specify the edge kind (an object). Multi-edges (edges with same endpoints) of different kind are distinguished if edgeBundleModeMask & EDGE_BUNDLE_DISTINGUISH_TYPES == 1.
See also
| GROUP_MODE_ALL_NODES | Constant |
public static const GROUP_MODE_ALL_NODES:int = 2Node grouping specifier. This value specifies that special nodes like, e.g., connector and proxy nodes are assigned to group nodes, too.
See also
| GROUP_MODE_IGNORE | Constant |
public static const GROUP_MODE_IGNORE:int = 0Node grouping specifier. This value specifies that group nodes are completely ignored.
See also
| GROUP_MODE_ORIGINAL_NODES_ONLY | Constant |
public static const GROUP_MODE_ORIGINAL_NODES_ONLY:int = 1Node grouping specifier. This value specifies that only original nodes are assigned in group nodes.
See also
| NODE_CLUSTER_ID_DPKEY | Constant |
public static const NODE_CLUSTER_ID_DPKEY:Object = y.layout.multipage.MultiPageLayouter.NODE_CLUSTER_ID_DPKEYAllows to specify a cluster id (an object) for each node. Nodes with the same cluster id should preferably be placed on the same page.
| NODE_ID_DPKEY | Constant |
public static const NODE_ID_DPKEY:Object = y.layout.multipage.MultiPageLayouter.NODE_ID_DPKEYUsed to map each node of the input graph to a unique id. Note: this DataProvider has to be specified by the user!
| NODE_LABEL_ID_DPKEY | Constant |
public static const NODE_LABEL_ID_DPKEY:Object = y.layout.multipage.MultiPageLayouter.NODE_LABEL_ID_DPKEYUsed to map each node label of the input graph to a unique id. Note: this DataProvider has to be specified by the user!