com.yworks.yfiles.layout.tree.LayeredNodePlacer

	Property	Defined By
		busAlignment : Number Specifies the vertical bus alignment for orthogonally routed edge buses.	LayeredNodePlacer
		dendrogramStyle : Boolean	LayeredNodePlacer
		id : Object [read-only] Returns the ID.	LayeredNodePlacer
		layerSpacing : Number Specifies the spacing between two layers.	LayeredNodePlacer
		modificationMatrix : AbstractRotatableNodePlacer_Matrix [read-only] The actual modification matrix	AbstractRotatableNodePlacer
		polylineLabelingEnabled : Boolean Specifies whether polyline labeling should be used.	LayeredNodePlacer
		rootAlignment : AbstractRotatableNodePlacer_RootAlignment Specifies the alignment strategy for the tree's root node.	LayeredNodePlacer
		routingStyle : int Specifies the routing style.	LayeredNodePlacer
		spacing : Number Specifies the spacing between subtrees this NodePlacer is arranging.	AbstractRotatableNodePlacer
		verticalAlignment : Number Specifies the relative vertical alignment of nodes within their respective layers.	LayeredNodePlacer

	Property	Defined By
		createdChildren : List List containing the created children	AbstractRotatableNodePlacer
		graph : LayoutGraph The graph instance this class is working on	AbstractRotatableNodePlacer
		nodeShapeProvider : DataProvider The actual node shape provider	AbstractRotatableNodePlacer
		_spacing : Number This is the "default" spacing for the different move operations.	AbstractRotatableNodePlacer
		subtreeShapeProvider : DataProvider The actual subtree shape provider	AbstractRotatableNodePlacer

	Method	Defined By
		LayeredNodePlacer(init:Boolean = true)	LayeredNodePlacer
		createComparator():Comparator	AbstractRotatableNodePlacer
		createFromSketchComparator():Comparator	AbstractRotatableNodePlacer
		createProcessor(layouter:GenericTreeLayouter, graph:LayoutGraph, currentRoot:Node):Processor [override] Creates an processor that distributes the LayerRoot	LayeredNodePlacer
		determineChildConnectors(localRoot:Node, connectorMap:DataMap):void This method initializes internal data structures, then uses the abstract method determineChildConnector() to determine the child node connector directions.	AbstractRotatableNodePlacer
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	LayeredNodePlacer
		hashCode():int	YObject
		newLayeredNodePlacer1():LayeredNodePlacer [static]	LayeredNodePlacer
		newLayeredNodePlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix, id:Object):LayeredNodePlacer [static] Default constructor.	LayeredNodePlacer
		placeSubtree(nodeShapeProvider:DataProvider, subtreeShapeProvider:DataProvider, graph:LayoutGraph, localRoot:Node, parentConnectorDirection:int):GenericTreeLayouter_SubtreeShape This method initializes the local data structures and then delegates the work to the abstract variant.	AbstractRotatableNodePlacer
		translatePoint(modificationMatrix:AbstractRotatableNodePlacer_Matrix, realWorldPoint:YPoint):YPoint [static] Translates a "real world point" to a "model point"	AbstractRotatableNodePlacer

	Method	Defined By
		createRootNodeShape(node:Node):SubtreeShapeRotated Convenience method that queries the DataProvider for the shape of a single node as a SubtreeShape instance.	AbstractRotatableNodePlacer
		createSubtreeShape(node:Node):SubtreeShapeRotated Convenience method that queries the DataProvider for a SubtreeShape.	AbstractRotatableNodePlacer
		determineChildConnector(child:Node):int [override]	LayeredNodePlacer
		getPortConstraint(localRoot:Node):PortConstraint Lookup method to get the PortConstraint for the local root translated.	AbstractRotatableNodePlacer
		getSourcePointAbs(edge:Edge):YPoint Translates the absolute source point of the given edge to the "view coordinates" (translated by the modification matrix)	AbstractRotatableNodePlacer
		initAbstractRotatableNodePlacer(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void	AbstractRotatableNodePlacer
		initLayeredNodePlacer1():void Initializes this object.	LayeredNodePlacer
		initLayeredNodePlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix, id:Object):void Initializes this object.	LayeredNodePlacer
		placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotated [override]	LayeredNodePlacer
		translateDirectionToModel(realDirection:int):int Translates a "real" direction into a directionModel direction	AbstractRotatableNodePlacer
		translateDirectionToReal(modelDirection:int):int Translates a modelDirectionModel into the "real" directionModel	AbstractRotatableNodePlacer

	Constant	Defined By
		ORTHOGONAL_STYLE : int = 1 [static] Layout style constant.	LayeredNodePlacer
		PLAIN_STYLE : int = 0 [static] Layout style constant.	LayeredNodePlacer

Property Detail

busAlignment

property

busAlignment:Number

Specifies the vertical bus alignment for orthogonally routed edge buses. The bus alignment determines the relative position of an edge bus in between two subsequent layers of nodes. A value of 0 places the bus at the top right below the parent node; a value of 0.5 places the bus in the middle between parent and child nodes; and a value of 1 places the bus at the bottom right above the child nodes.

Defaults to 0.3.

Implementation
public function get busAlignment():Number
public function set busAlignment(value:Number):void

dendrogramStyle

property

dendrogramStyle:Boolean

Implementation
public function get dendrogramStyle():Boolean
public function set dendrogramStyle(value:Boolean):void

property

id:Object [read-only]

Returns the ID. The ID is used to identify LayeredNodePlacers that share information about their height. Using different IDs offers aligned layouts within different subtrees.

Implementation
public function get id():Object

layerSpacing

property

layerSpacing:Number

Specifies the spacing between two layers.

Implementation
public function get layerSpacing():Number
public function set layerSpacing(value:Number):void

polylineLabelingEnabled

property

polylineLabelingEnabled:Boolean

Specifies whether polyline labeling should be used.

If set to true, the poly line connectors between the parent and its children are added to the shape. Labels (of nodes and edges) will not cut them.

Implementation
public function get polylineLabelingEnabled():Boolean
public function set polylineLabelingEnabled(value:Boolean):void

rootAlignment

property

rootAlignment:AbstractRotatableNodePlacer_RootAlignment

Specifies the alignment strategy for the tree's root node.

Implementation
public function get rootAlignment():AbstractRotatableNodePlacer_RootAlignment
public function set rootAlignment(value:AbstractRotatableNodePlacer_RootAlignment):void

routingStyle

property

routingStyle:int

Specifies the routing style. The possible values are:

ORTHOGONAL_STYLE
PLAIN_STYLE

Implementation
public function get routingStyle():int
public function set routingStyle(value:int):void

See also

ORTHOGONAL_STYLE
PLAIN_STYLE

verticalAlignment

property

verticalAlignment:Number

Specifies the relative vertical alignment of nodes within their respective layers. A value of 0 means nodes are top aligned; a value of 1 means nodes are bottom aligned.

Defaults to 0.5, i.e. nodes are center aligned.

Implementation
public function get verticalAlignment():Number
public function set verticalAlignment(value:Number):void

Constructor Detail

LayeredNodePlacer

()

Constructor

public function LayeredNodePlacer(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

createProcessor

()

method

override public function createProcessor(layouter:GenericTreeLayouter, graph:LayoutGraph, currentRoot:Node):Processor

Creates an processor that distributes the LayerRoot

Parameters

	`layouter:GenericTreeLayouter`

	`graph:LayoutGraph` — the actual graph

	`currentRoot:Node` — the actual root node for this node placer

Returns

Processor — a Processor or null

determineChildConnector

()

method

override protected function determineChildConnector(child:Node):int

Parameters

child:Node — the child node

Returns

int — a byte constant as defined in the com.yworks.yfiles.layout.tree.NodePlacer interface

getClass

()

method

override public function getClass():Class

Returns

Class

initLayeredNodePlacer1

()

method

protected final function initLayeredNodePlacer1():void

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

See also

newLayeredNodePlacer1()

initLayeredNodePlacer2

()

method

protected final function initLayeredNodePlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix, id:Object):void

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

Parameters

	`modificationMatrix:AbstractRotatableNodePlacer_Matrix`

	`id:Object`

See also

newLayeredNodePlacer2()

newLayeredNodePlacer1

()

method

public static function newLayeredNodePlacer1():LayeredNodePlacer

Returns

LayeredNodePlacer

newLayeredNodePlacer2

()

method

 public static function newLayeredNodePlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix, id:Object):LayeredNodePlacer

Default constructor. Instantiates a new instance with the given modification matrix.

Parameters

	`modificationMatrix:AbstractRotatableNodePlacer_Matrix` — the translation for the NodePlacer

	`id:Object`

Returns

LayeredNodePlacer

placeSubtreeCore

()

method

override protected function placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotated

Parameters

	`localRoot:Node` — the local root node

	`parentConnectorDirection:int` — the direction of the connector shape

Returns

SubtreeShapeRotated — a SubtreeShape instance that describes the shape of the whole subtree

Constant Detail

ORTHOGONAL_STYLE

Constant

public static const ORTHOGONAL_STYLE:int = 1

Layout style constant. Draw edges orthogonally in a bus-like fashion.

See also

routingStyle
routingStyle

PLAIN_STYLE

Constant

public static const PLAIN_STYLE:int = 0

Layout style constant. Draw edges as straight lines.

Note that it is possible that edges overlap with nodes depending on their size and vertical alignment. When node labels are considered (com.yworks.yfiles.layout.tree.GenericTreeLayouter.integratedNodeLabeling), there might also be edge overlaps with node labels that are placed above the according node.

Wed Oct 7 2015, 04:43 PM +02:00

yFiles FLEX Client Layout Extension 1.5 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
LayeredNodePlacer	Properties \| Methods \| Constants

Package	com.yworks.yfiles.layout.tree
Class	public class LayeredNodePlacer
Inheritance	LayeredNodePlacer AbstractRotatableNodePlacer YObject Object