Packagecom.yworks.yfiles.layout
Classpublic class SubgraphLayouter
InheritanceSubgraphLayouter Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

A layout stage that filters out all graph elements that are not part of a subgraph that is induced by the selected nodes of the input graph.



Public Properties
 PropertyDefined By
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
  subgraphNodesDpKey : Object
Specifies the DataProvider key which determines the nodes that induce the subgraph to be laid out.
SubgraphLayouter
Public Methods
 MethodDefined By
  
SubgraphLayouter(init:Boolean = true)
SubgraphLayouter
  
canLayout(graph:LayoutGraph):Boolean
[override]
SubgraphLayouter
  
doLayout(graph:LayoutGraph):void
[override]
SubgraphLayouter
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
SubgraphLayouter
 Inherited
hashCode():int
YObject
  
[static]
SubgraphLayouter
  
[static]
SubgraphLayouter
Protected Methods
 MethodDefined By
 Inherited
canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out.
AbstractLayoutStage
 Inherited
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
AbstractLayoutStage
 Inherited
AbstractLayoutStage
  
Initializes this object.
SubgraphLayouter
  
initSubgraphLayouter2(coreLayouter:Layouter):void
Initializes this object.
SubgraphLayouter
Property Detail
subgraphNodesDpKeyproperty
subgraphNodesDpKey:Object

Specifies the DataProvider key which determines the nodes that induce the subgraph to be laid out.

By default, com.yworks.yfiles.layout.LayouterKeys.SELECTED_NODES is used.


Implementation
    public function get subgraphNodesDpKey():Object
    public function set subgraphNodesDpKey(value:Object):void

Throws
IllegalArgumentException — if the specified key is null.

See also

Constructor Detail
SubgraphLayouter()Constructor
public function SubgraphLayouter(init:Boolean = true)

Parameters
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
canLayout()method
override public function canLayout(graph:LayoutGraph):Boolean

Parameters

graph:LayoutGraph

Returns
Boolean
doLayout()method 
override public function doLayout(graph:LayoutGraph):void

Parameters

graph:LayoutGraph

getClass()method 
override public function getClass():Class

Returns
Class
initSubgraphLayouter1()method 
protected final function initSubgraphLayouter1():void

Initializes this object. See the documentation of the corresponding factory method newSubgraphLayouter1() for details.

See also

initSubgraphLayouter2()method 
protected final function initSubgraphLayouter2(coreLayouter:Layouter):void

Initializes this object. See the documentation of the corresponding factory method newSubgraphLayouter2() for details.

Parameters

coreLayouter:Layouter

See also

newSubgraphLayouter1()method 
public static function newSubgraphLayouter1():SubgraphLayouter

Returns
SubgraphLayouter
newSubgraphLayouter2()method 
public static function newSubgraphLayouter2(coreLayouter:Layouter):SubgraphLayouter

Parameters

coreLayouter:Layouter

Returns
SubgraphLayouter