com.yworks.yfiles.layout.tree.BalloonLayouter

	Property	Defined By
		allowOverlaps : Boolean Getter: Returns whether or not to allow partially overlapping nodes.	BalloonLayouter
		chainStraighteningModeEnabled : Boolean Specifies whether chains within the graph shall be drawn straight or not.	BalloonLayouter
		childAlignmentPolicy : int Specifies the child alignment policy used by the layouter.	BalloonLayouter
		childOrderingPolicy : int Specifies the current policy for sorting the children around the local roots.	BalloonLayouter
		compactnessFactor : Number Specifies the compactness factor for this layouter.	BalloonLayouter
		comparator : Comparator Specifies the java.util.Comparator that will be used to sort the outgoing edges (com.yworks.yfiles.base.Node.sortOutEdges()) of each local root in the tree before they are being arranged.	BalloonLayouter
		componentLayouter : LayoutStage Specifies the LayoutStage responsible for laying out the connected components of the graph.	CanonicMultiStageLayouter
		componentLayouterEnabled : Boolean Getter: Returns whether or not ComponentLayouter is enabled.	CanonicMultiStageLayouter
		considerNodeLabelsEnabled : Boolean Getter: Returns whether or not the layouter considers node labels for the next layout run.	BalloonLayouter
		edgeLabelSpacing : Number Specifies the edge label spacing value (a non-negative double value).	BalloonLayouter
		fromSketchMode : Boolean Determines whether or not to take the coordinates of the input diagram into account when arranging the nodes of the elements of the tree.	BalloonLayouter
		groupNodeHider : LayoutStage Specifies the LayoutStage that is responsible for hiding away grouping information for the layout algorithm.	CanonicMultiStageLayouter
		hideGroupNodes : Boolean Specifies whether or not to hide away group nodes before the layout begins.	CanonicMultiStageLayouter
		integratedEdgeLabelingEnabled : Boolean Specifies whether or not the integrated edge labeling mechanism is enabled.	BalloonLayouter
		integratedNodeLabelingEnabled : Boolean Specifies whether or not the integrated node labeling mechanism is enabled.	BalloonLayouter
		interleavedMode : int Specifies the mode for interleaving child node arrangement.	BalloonLayouter
		labelLayouter : LayoutStage Getter: Returns the algorithm used for placing labels.	CanonicMultiStageLayouter
		labelLayouterEnabled : Boolean Getter: Returns whether or not LabelLayouter is enabled.	CanonicMultiStageLayouter
		layoutOrientation : int Specifies the main layout orientation.	CanonicMultiStageLayouter
		minimalEdgeLength : int Specifies the minimal edge length that this layouter assigns to laid out edges.	BalloonLayouter
		minimalNodeDistance : int Getter: Returns the distance to keep between the nodes in the tree.	BalloonLayouter
		nodeLabelingPolicy : int Specifies the policy for the integrated node labeling mechanism.	BalloonLayouter
		nodeLabelSpacing : Number Specifies the node label spacing value (a non-negative double value).	BalloonLayouter
		orientationLayouter : LayoutStage Specifies the LayoutStage that is responsible for changing the orientation of the computed layout.	CanonicMultiStageLayouter
		orientationLayouterEnabled : Boolean Getter: Returns whether or not the OrientationLayouter is enabled.	CanonicMultiStageLayouter
		parallelEdgeLayouter : LayoutStage Getter: Returns the LayoutStage responsible for routing parallel edges.	CanonicMultiStageLayouter
		parallelEdgeLayouterEnabled : Boolean Getter: Returns whether or not the ParallelEdgeLayouter is enabled.	CanonicMultiStageLayouter
		preferredChildWedge : int Getter: Returns the preferred child wedge angle.	BalloonLayouter
		preferredRootWedge : int Getter: Returns the preferred radial amount in degrees that stay unoccupied around the root node of the graph.	BalloonLayouter
		rootNodePolicy : int Specifies the root node policy that determines which node is chosen as (virtual) tree root for the layout process.	BalloonLayouter
		selfLoopLayouter : LayoutStage Getter: Returns the LayoutStage used for routing Self-loops.	CanonicMultiStageLayouter
		selfLoopLayouterEnabled : Boolean Getter: Returns whether or not the SelfLoopLayouter is enabled.	CanonicMultiStageLayouter
		subgraphLayouter : LayoutStage Specifies the LayoutStage that is responsible for constraining the layout process to a subgraph of the target graph.	CanonicMultiStageLayouter
		subgraphLayouterEnabled : Boolean Getter: Returns whether or not the SubgraphLayouter is enabled.	CanonicMultiStageLayouter

	Property	Defined By
		graph : LayoutGraph The layout graph being acted upon.	BalloonLayouter

	Method	Defined By
		BalloonLayouter(init:Boolean = true)	BalloonLayouter
		appendStage(stage:LayoutStage):void Appends a stage to the layout pipeline.	CanonicMultiStageLayouter
		calcLayout(layoutGraph:LayoutGraph):GraphLayout Returns a layout for the given layout graph.	CanonicMultiStageLayouter
		calcLayout2(graph:GraphInterface, layout:GraphLayout):GraphLayout Returns a layout for the given graph interface and layout.	CanonicMultiStageLayouter
		canLayout(graph:LayoutGraph):Boolean Tests whether or not the given graph can be laid out by this layouter.	CanonicMultiStageLayouter
		canLayoutCore(graph:LayoutGraph):Boolean [override] Returns true if the core layouter can layout the given graph structure.	BalloonLayouter
		doLayout(layoutGraph:LayoutGraph):void Calculates a layout for the given graph.	CanonicMultiStageLayouter
		doLayout2(graph:GraphInterface, layout:GraphLayout):void Calculates a layout for the given graph interface and layout.	CanonicMultiStageLayouter
		doLayoutCore(graph:LayoutGraph):void [override] Core layout routine.	BalloonLayouter
		enableOnlyCore():void Disables all layout stages and performs only the core layouter.	CanonicMultiStageLayouter
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	BalloonLayouter
		hashCode():int	YObject
		newBalloonLayouter():BalloonLayouter [static]	BalloonLayouter
		prependStage(stage:LayoutStage):void Prepends a stage to the layout pipeline.	CanonicMultiStageLayouter
		removeStage(stage:LayoutStage):void Removes a LayoutStage that has been previously added by the methods appendStage() or prependStage().	CanonicMultiStageLayouter

	Method	Defined By
		calcAngles(root:Node):Number Calculates the angle wedge that has to be reserved for the subtree rooted at the given node.	BalloonLayouter
		calcAngles2(root:Node, scaleFactor:Number):Number Calculates the angle wedge that has to be reserved for the subtree rooted at the given node.	BalloonLayouter
		calcChildArrangement(root:Node):void Calculates the child nodes arrangement for a given root node of the tree.	BalloonLayouter
		checkGroupNodeSize(layout:GraphLayout, node:Object):void This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given group node object is zero.	CanonicMultiStageLayouter
		checkNodeSize(layout:GraphLayout, node:Object):void This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given node object is zero.	CanonicMultiStageLayouter
		determineRoot():Node Determines the root node of this.graph according to the chosen root node policy.	BalloonLayouter
		getInfo(v:Node):BalloonLayouter_NodeInfo Returns the NodeInfo object that is associated with the given node while the layouter is active.	BalloonLayouter
		getPreferredChildWedge(root:Node):Number Returns the preferred child wedge angle in degrees that is used for the children of the given root node.	BalloonLayouter
		initBalloonLayouter():void Initializes this object.	BalloonLayouter
		initCanonicMultiStageLayouter():void	CanonicMultiStageLayouter
		sortChildNodes(root:Node):void Sorts the child nodes of the given node.	BalloonLayouter

	Constant	Defined By
		CENTER_ROOT : int = 1 [static] Root node policy specifier constant.	BalloonLayouter
		CHILD_ALIGNMENT_COMPACT : int = 2 [static] Child alignment policy specifier constant.	BalloonLayouter
		CHILD_ALIGNMENT_PLAIN : int = 0 [static] Child alignment policy specifier constant.	BalloonLayouter
		CHILD_ALIGNMENT_SAME_CENTER : int = 1 [static] Child alignment policy specifier constant.	BalloonLayouter
		CHILD_ALIGNMENT_SMART : int = 3 [static] Child alignment policy specifier constant.	BalloonLayouter
		CHILD_ORDERING_POLICY_COMPACT : int = 0 [static] Child ordering policy specifier constant.	BalloonLayouter
		CHILD_ORDERING_POLICY_SYMMETRIC : int = 1 [static] Child ordering policy specifier constant.	BalloonLayouter
		DIRECTED_ROOT : int = 0 [static] Root node policy specifier constant.	BalloonLayouter
		INTERLEAVED_MODE_ALL_NODES : int = 1 [static] Interleaved mode specifier constant.	BalloonLayouter
		INTERLEAVED_MODE_OFF : int = 0 [static] Interleaved mode specifier constant.	BalloonLayouter
		INTERLEAVED_MODE_SELECTED_NODES : int = 2 [static] Interleaved mode specifier constant.	BalloonLayouter
		INTERLEAVED_NODES_DPKEY : Object = y.layout.tree.BalloonLayouter.INTERLEAVED_NODES_DPKEY [static] com.yworks.yfiles.base.DataProvider key used to store if the children of a node should be arranged in an interleaved fashion or not (boolean values, true encodes interleaved).	BalloonLayouter
		NODE_LABELING_HORIZONTAL : int = 2 [static] Node labeling policy specifier constant.	BalloonLayouter
		NODE_LABELING_MIXED : int = 1 [static] Node labeling policy specifier constant.	BalloonLayouter
		NODE_LABELING_RAYLIKE : int = 0 [static] Node labeling policy specifier constant.	BalloonLayouter
		WEIGHTED_CENTER_ROOT : int = 2 [static] Root node policy specifier constant.	BalloonLayouter

Property Detail

allowOverlaps

property

allowOverlaps:Boolean

Getter: Returns whether or not to allow partially overlapping nodes.

Setter: Specifies whether or not this layouter should allow (partially) overlapping nodes. Activating this feature results in a more compact layout. The price for this feature is that some nodes may partially overlap. By default this feature is set to false.

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

chainStraighteningModeEnabled

property

chainStraighteningModeEnabled:Boolean

Specifies whether chains within the graph shall be drawn straight or not. Straightening all chains may lead to smoother, more symmetric results. A chain is defined as a tree node with exactly one child. The default value is false.

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

childAlignmentPolicy

property

childAlignmentPolicy:int

Specifies the child alignment policy used by the layouter. This policy influences the distance of a child node to its parent node. Possible values are CHILD_ALIGNMENT_COMPACT (default), CHILD_ALIGNMENT_PLAIN, CHILD_ALIGNMENT_SAME_CENTER and CHILD_ALIGNMENT_SMART.

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

childOrderingPolicy

property

childOrderingPolicy:int

Specifies the current policy for sorting the children around the local roots. Possible values are CHILD_ORDERING_POLICY_COMPACT and CHILD_ORDERING_POLICY_SYMMETRIC. Note: the policy is only considered if sketch mode is disabled (see method fromSketchMode) and no comparator is set (see method comparator). Furthermore, the policy is ignored for nodes whose children are placed in an interleaved (interleavedMode) fashion.

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

compactnessFactor

property

compactnessFactor:Number

Specifies the compactness factor for this layouter. This factor has to be a double value between 0 and 1. The smaller the factor the more compact will the layout potentially be. The price for a more compact layout is a potentially higher running time.

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

comparator

property

comparator:Comparator

Specifies the java.util.Comparator that will be used to sort the outgoing edges (com.yworks.yfiles.base.Node.sortOutEdges()) of each local root in the tree before they are being arranged. The default value is null which indicates that the algorithm should use its built-in logic.

Implementation
public function get comparator():Comparator
public function set comparator(value:Comparator):void

See also

java.util.Comparator
outgoing edges

considerNodeLabelsEnabled

property

considerNodeLabelsEnabled:Boolean

Getter: Returns whether or not the layouter considers node labels for the next layout run.

Note that this option only works correctly if the layout orientation (layoutOrientation) is set to com.yworks.yfiles.layout.LayoutOrientation.TOP_TO_BOTTOM (which is the default). Changing the layout orientation for an undirected layout algorithm like the com.yworks.yfiles.layout.tree.BalloonLayouter doesn't make sense.

Setter: Specifies whether or not the layouter considers node labels for the next layout run. Note: this setting does only have an effect if the integrated labeling mechanism is not enabled, that is if integratedNodeLabelingEnabled returns true.

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

edgeLabelSpacing

property

edgeLabelSpacing:Number

Specifies the edge label spacing value (a non-negative double value). It affects the distance between two edge labels belonging to the same edge as well as the distance of the edge labels to the target node. The default value is 4.0d. Note, that the edge label spacing has an effect only if the integrated edge labeling is enabled.

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

See also

integratedEdgeLabelingEnabled

fromSketchMode

property

fromSketchMode:Boolean

Determines whether or not to take the coordinates of the input diagram into account when arranging the nodes of the elements of the tree. If this features is enabled, the original circular order of child nodes around each parent node will be maintained.

By default this feature is disabled.

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

graph

property

protected var graph:LayoutGraph

The layout graph being acted upon.

integratedEdgeLabelingEnabled

property

integratedEdgeLabelingEnabled:Boolean

Specifies whether or not the integrated edge labeling mechanism is enabled. With enabled integrated labeling the layouter does automatically place edge labels. The default value is false. Note: when enabling integrated edge labeling it is recommended to also activate the chain straightening mode, as edge labels (especially large ones) may lead to significantly non-straight chains.

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

See also

chainStraighteningModeEnabled

integratedNodeLabelingEnabled

property

integratedNodeLabelingEnabled:Boolean

Specifies whether or not the integrated node labeling mechanism is enabled. The integrated labeling does automatically place node labels. Different strategies may be selected using nodeLabelingPolicy. The default value is false. Note: if the integrated labeling mechanism is enabled, then the labels will always be placed by this algorithm, independent of the setting of considerNodeLabelsEnabled.

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

interleavedMode

property

interleavedMode:int

Specifies the mode for interleaving child node arrangement. Possible values are INTERLEAVED_MODE_ALL_NODES, INTERLEAVED_MODE_OFF (default) and INTERLEAVED_MODE_SELECTED_NODES. Note that if placing children of a node in an interleaved fashion, then the ordering policy (childOrderingPolicy) will not be considered for these children.

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

minimalEdgeLength

property

minimalEdgeLength:int

Specifies the minimal edge length that this layouter assigns to laid out edges.

By default a minimal edge length of 40 is set.

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

minimalNodeDistance

property

minimalNodeDistance:int

Getter: Returns the distance to keep between the nodes in the tree. The default distance is 0.0.

Setter: Sets the minimal distance to keep between the nodes in the tree. Note that this distance is not always considered if allowOverlaps is set to true. The default distance is 0.0.

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

See also

allowOverlaps

nodeLabelingPolicy

property

nodeLabelingPolicy:int

Specifies the policy for the integrated node labeling mechanism. Possible values are NODE_LABELING_HORIZONTAL, NODE_LABELING_RAYLIKE (default) and NODE_LABELING_MIXED. Note: the policy is only considered if integratedNodeLabelingEnabled is set to true.

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

nodeLabelSpacing

property

nodeLabelSpacing:Number

Specifies the node label spacing value (a non-negative double value). It affects the distance between two node labels of the same node as well as the distance of the labels and the node itself in case of a placement outside the node. The default value is 4.0d. Note, that the node label spacing has an effect only if the integrated node labeling is enabled.

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

See also

integratedNodeLabelingEnabled

preferredChildWedge

property

preferredChildWedge:int

Getter: Returns the preferred child wedge angle.

Setter: Set the preferred radial amount in degrees that all child nodes may occupy around a parent node. This value controls the degree to which the child nodes may radiate away from the center of layout. By default the wedge is 340 degrees which means that the child nodes may radiate in almost any direction from a parent node.

Allowed values lie within 0 and 360 degrees.

By default a child wedge of 340 degrees is used.

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

preferredRootWedge

property

preferredRootWedge:int

Getter: Returns the preferred radial amount in degrees that stay unoccupied around the root node of the graph.

Setter: Sets the preferred radial amount in degrees that stay unoccupied around the root node of the graph

Allowed values lie within 0 and 360 degrees. By default a root wedge of 360 degrees is used.

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

rootNodePolicy

property

rootNodePolicy:int

Specifies the root node policy that determines which node is chosen as (virtual) tree root for the layout process.

By default DIRECTED_ROOT is set.

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

Constructor Detail

BalloonLayouter

()

Constructor

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

calcAngles

()

method

protected function calcAngles(root:Node):Number

Calculates the angle wedge that has to be reserved for the subtree rooted at the given node.

Subclasses may overwrite this method to perform a custom angle wedge assignment scheme.

Parameters

root:Node

Returns

Number

calcAngles2

()

method

protected function calcAngles2(root:Node, scaleFactor:Number):Number

Calculates the angle wedge that has to be reserved for the subtree rooted at the given node. The distance of the successor nodes is additionally scaled by scaleFactor (use scaleFactor = 1.0 for no scaling).

Subclasses may overwrite this method to perform a custom angle wedge assignment scheme.

Parameters

	`root:Node`

	`scaleFactor:Number`

Returns

Number

calcChildArrangement

()

method

protected function calcChildArrangement(root:Node):void

Calculates the child nodes arrangement for a given root node of the tree. Subclasses may overwrite this method to perform a custom child node arrangement.

Parameters

root:Node

canLayoutCore

()

method

override public function canLayoutCore(graph:LayoutGraph):Boolean

Returns true if the core layouter can layout the given graph structure. This is the case if the graph is a tree.

Parameters

graph:LayoutGraph

Returns

Boolean

determineRoot

()

method

protected function determineRoot():Node

Determines the root node of this.graph according to the chosen root node policy.

Returns

Node — the root node of this.graph.

doLayoutCore

()

method

override public function doLayoutCore(graph:LayoutGraph):void

Core layout routine.

Parameters

graph:LayoutGraph

getClass

()

method

override public function getClass():Class

Returns

Class

getInfo

()

method

protected function getInfo(v:Node):BalloonLayouter_NodeInfo

Returns the NodeInfo object that is associated with the given node while the layouter is active. Subclasses may want to use this information to refine the behavior of this algorithm.

Parameters

v:Node

Returns

BalloonLayouter_NodeInfo

getPreferredChildWedge

()

method

protected function getPreferredChildWedge(root:Node):Number

Returns the preferred child wedge angle in degrees that is used for the children of the given root node.

Subclasses may overwrite this method to provide a custom child wedge function.

Parameters

root:Node

Returns

Number

initBalloonLayouter

()

method

protected final function initBalloonLayouter():void

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

See also

newBalloonLayouter()

newBalloonLayouter

()

method

public static function newBalloonLayouter():BalloonLayouter

Returns

BalloonLayouter

sortChildNodes

()

method

protected function sortChildNodes(root:Node):void

Sorts the child nodes of the given node. This method uses the original node coordinates if fromSketchMode is enabled. Otherwise, it sorts the child nodes according to their wedge angle sizes, or, if present uses the specified comparator (comparator) to sort the outgoing edges of the local root node. The biggest one receives median position in the sorting order. The smaller the wedges the further away a node will be placed from the median position.

This method gets called within method calcChildArrangement() before coordinates are assigned and just after the wedges sizes for all subgraphs rooted at root were determined.

Note: This method will not be called for nodes whose children are placed in an interleaved (interleavedMode) fashion.

Parameters

root:Node

Constant Detail

CENTER_ROOT

Constant

public static const CENTER_ROOT:int = 1

Root node policy specifier constant. A center node will be chosen as root node of the tree.

CHILD_ALIGNMENT_COMPACT

Constant

public static const CHILD_ALIGNMENT_COMPACT:int = 2

Child alignment policy specifier constant. Child nodes rooted at the same node are aligned such that the resulting drawing will be as compact as possible, not considering any symmetric constraints or similar.

See also

childAlignmentPolicy

CHILD_ALIGNMENT_PLAIN

Constant

public static const CHILD_ALIGNMENT_PLAIN:int = 0

Child alignment policy specifier constant. Child nodes rooted at the same node are aligned such that the border of the nodes convex hull has the same distance from the root for all of the children. Note: two different distances will be realized, if the interleaved mode is active interleavedMode.

See also

childAlignmentPolicy
interleavedMode

CHILD_ALIGNMENT_SAME_CENTER

Constant

public static const CHILD_ALIGNMENT_SAME_CENTER:int = 1

Child alignment policy specifier constant. Child nodes rooted at the same node are aligned such that each node has the same center-to-center distance to the root. Therefore all nodes will be placed on one common radius around their root. Note: does realize two different radii if in interleaved mode interleavedMode.

See also

childAlignmentPolicy
interleavedMode

CHILD_ALIGNMENT_SMART

Constant

public static const CHILD_ALIGNMENT_SMART:int = 3

Child alignment policy specifier constant. Child nodes rooted at the same node are aligned using a smart strategy, which - if possible - tries to estimate an alignment such that the resulting drawing is well-balanced and symmetric. Note: if in interleaved mode interleavedMode, then currently a plain alignment will be chosen CHILD_ALIGNMENT_PLAIN.

CHILD_ORDERING_POLICY_COMPACT

Constant

public static const CHILD_ORDERING_POLICY_COMPACT:int = 0

Child ordering policy specifier constant. This policy sorts the child nodes according to the size of the subtree rooted by them in an interleaved fashion. Using this policy the produced results are often more compact.

See also

childOrderingPolicy

CHILD_ORDERING_POLICY_SYMMETRIC

Constant

public static const CHILD_ORDERING_POLICY_SYMMETRIC:int = 1

Child ordering policy specifier constant. This policy sorts the child nodes according to their wedge angle sizes. The node with the biggest angle receives median position in the sorting order. The smaller the wedges the further away a node will be placed from the median position. Using this policy the produced results are often more symmetric.

See also

childOrderingPolicy

DIRECTED_ROOT

Constant

public static const DIRECTED_ROOT:int = 0

Root node policy specifier constant. A node with indegree 0 is chosen as root node of the tree. If no node with that property is present the an arbitrary node is chosen.

INTERLEAVED_MODE_ALL_NODES

Constant

public static const INTERLEAVED_MODE_ALL_NODES:int = 1

Interleaved mode specifier constant. Using this mode, the children (successors) of all nodes in the tree will possibly be placed in an interleaved fashion. Interleaved arrangement means, that the successors of node root are placed at different distances in an alternating way. Note: If there is enough space within the desired child wedge of some node to place all children without using different distances, then the children will simply be placed without interleaving.

See also

interleavedMode

INTERLEAVED_MODE_OFF

Constant

public static const INTERLEAVED_MODE_OFF:int = 0

Interleaved mode specifier constant. This mode does turn off the interleaved child arrangement for all nodes in the tree. This is the default mode.

See also

interleavedMode

INTERLEAVED_MODE_SELECTED_NODES

Constant

public static const INTERLEAVED_MODE_SELECTED_NODES:int = 2

Interleaved mode specifier constant. Using this mode, it is possible to specify individually for each node if the nodes children should be arranged in an interleaved way or not. For this purpose a com.yworks.yfiles.base.DataProvider with key INTERLEAVED_NODES_DPKEY can be attached to the graph to be laid out. The data provider may then provide a boolean value which determines, if the children of a specific node will be placed interleaved or not.

If there is no com.yworks.yfiles.base.DataProvider with key INTERLEAVED_NODES_DPKEY registered, then the selection of nodes where children shall arranged interleaved will be made based on a very simple heuristic.

Note: If there is enough space within the desired child wedge of a selected node to place all children without using different distances, then the children will simply be placed without interleaving.

INTERLEAVED_NODES_DPKEY

Constant

public static const INTERLEAVED_NODES_DPKEY:Object = y.layout.tree.BalloonLayouter.INTERLEAVED_NODES_DPKEY

com.yworks.yfiles.base.DataProvider key used to store if the children of a node should be arranged in an interleaved fashion or not (boolean values, true encodes interleaved). It allows to individually configure the interleaving feature for each node in the graph. Note that the data provider will only be considered if mode is set to INTERLEAVED_MODE_SELECTED_NODES.

NODE_LABELING_HORIZONTAL

Constant

public static const NODE_LABELING_HORIZONTAL:int = 2

Node labeling policy specifier constant. The labels of all nodes will be oriented horizontally and placed at the center of the corresponding node.

See also

nodeLabelingPolicy

NODE_LABELING_MIXED

Constant

public static const NODE_LABELING_MIXED:int = 1

Node labeling policy specifier constant. Only labels corresponding to leaf nodes won't be oriented horizontally. They get the same orientation as their nodes' incoming edge. These labels will be placed outside the node (without overlaps). The labels of all the other nodes will be oriented horizontally and placed at the center of the corresponding node.

See also

nodeLabelingPolicy

NODE_LABELING_RAYLIKE

Constant

public static const NODE_LABELING_RAYLIKE:int = 0

Node labeling policy specifier constant. Leaf nodes and nodes having exactly one successor (thus forming a sort of chain) will not be oriented horizontal but ray-like: that means they get the same orientation as their nodes' incoming edge. The labels of the nodes having more than 1 successor will be oriented horizontally and placed at the center of the corresponding node.

See also

nodeLabelingPolicy

WEIGHTED_CENTER_ROOT

Constant

public static const WEIGHTED_CENTER_ROOT:int = 2

Root node policy specifier constant. A weighted center node will be chosen as root node of the tree.

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
BalloonLayouter	Properties \| Methods \| Constants

Package	com.yworks.yfiles.layout.tree
Class	public class BalloonLayouter
Inheritance	BalloonLayouter CanonicMultiStageLayouter YObject Object