com.yworks.yfiles.layout.circular.CircularLayouter

	Property	Defined By
		balloonLayouter : BalloonLayouter [read-only] Returns the BalloonLayouter used for arranging the partitions Configuring that layouter has effect upon the partition arrangement within the overall layout.	CircularLayouter
		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
		considerNodeLabels : Boolean Specifies whether or not node labels are taken into account when calculating node positions (thereby preventing possible node/node label or node label/node label overlaps).	CircularLayouter
		fromSketchMode : Boolean Determines whether or not to take the coordinates of the input diagram into account when arranging the nodes of the partitions and the partitions themselves.	CircularLayouter
		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
		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
		layoutStyle : int Specifies the global layout style for this layouter.	CircularLayouter
		maximalDeviationAngle : int Specifies the maximal deviation angle allowed for an edge.	CircularLayouter
		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
		partitionLayoutStyle : int Specifies the layout style for the arrangement of each partition.	CircularLayouter
		placeChildrenOnCommonRadius : Boolean Getter: Returns whether or not, in the underlying tree, the children of a node are placed on a common radius.	CircularLayouter
		selfLoopLayouter : LayoutStage Getter: Returns the LayoutStage used for routing Self-loops.	CanonicMultiStageLayouter
		selfLoopLayouterEnabled : Boolean Getter: Returns whether or not the SelfLoopLayouter is enabled.	CanonicMultiStageLayouter
		singleCycleLayouter : SingleCycleLayouter [read-only] Returns the SingleCycleLayouter used for laying out single node cycles Configuring that layouter has effects upon single cycle layouts	CircularLayouter
		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

	Method	Defined By
		CircularLayouter(init:Boolean = true) Create a new instance of this layouter.	CircularLayouter
		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] Always returns true.	CircularLayouter
		doLayout(layoutGraph:LayoutGraph):void [override] Calculates a layout for the given graph.	CircularLayouter
		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.	CircularLayouter
		enableOnlyCore():void Disables all layout stages and performs only the core layouter.	CanonicMultiStageLayouter
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	CircularLayouter
		hashCode():int	YObject
		newCircularLayouter():CircularLayouter [static] Create a new instance of this layouter.	CircularLayouter
		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
		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
		initCanonicMultiStageLayouter():void	CanonicMultiStageLayouter
		initCircularLayouter():void Initializes this object.	CircularLayouter

	Constant	Defined By
		BCC_COMPACT : int = 0 [static] Layout style specifier.	CircularLayouter
		BCC_ISOLATED : int = 1 [static] Layout style specifier.	CircularLayouter
		CIRCLE_ID_HOLDER_DPKEY : Object = y.layout.circular.CircularLayouter.CIRCLE_ID_HOLDER_DPKEY [static] Used for publishing the final circle information.	CircularLayouter
		CIRCULAR_CUSTOM_GROUPS : int = 2 [static] Layout style specifier.	CircularLayouter
		CIRCULAR_CUSTOM_GROUPS_DPKEY : Object = y.layout.circular.CircularLayouter.CIRCULAR_CUSTOM_GROUPS_DPKEY [static] This key is used to identify custom groups.	CircularLayouter
		PARTITION_LAYOUTSTYLE_CYCLIC : int = 0 [static] Place each node of a partition on the boundary of a circle.	CircularLayouter
		PARTITION_LAYOUTSTYLE_DISK : int = 1 [static] Create semi-compact layout for each partition.	CircularLayouter
		PARTITION_LAYOUTSTYLE_ORGANIC : int = 2 [static] Create most compact layout for each partition.	CircularLayouter
		SINGLE_CYCLE : int = 3 [static] Layout style specifier.	CircularLayouter

Property Detail

balloonLayouter

property

balloonLayouter:BalloonLayouter [read-only]

Returns the BalloonLayouter used for arranging the partitions

Configuring that layouter has effect upon the partition arrangement within the overall layout.

Implementation
public function get balloonLayouter():BalloonLayouter

considerNodeLabels

property

considerNodeLabels:Boolean

Specifies whether or not node labels are taken into account when calculating node positions (thereby preventing possible node/node label or node label/node label overlaps).

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.circular.CircularLayouter doesn't make sense.

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

fromSketchMode

property

fromSketchMode:Boolean

Determines whether or not to take the coordinates of the input diagram into account when arranging the nodes of the partitions and the partitions themselves.

If enabled:

For complex partitions (those consisting of more than one node), the layouter tries to keep peripheral nodes and maintain their circular order around the center of the disk/circle. Other partitions that connect to this node are moved accordingly, if possible.
For multiple partitions that connect to the same node, the layouter tries to keep their circular order around this node. This only works as expected for BCC_COMPACT as partition policy, since otherwise the underlying tree structure is not well defined

Switching between different partition policies or group layout styles can lead to unexpected results.

By default this feature is disabled.

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

See also

BCC_COMPACT

layoutStyle

property

layoutStyle:int

Specifies the global layout style for this layouter. Allowed layout styles are SINGLE_CYCLE, BCC_ISOLATED, BCC_COMPACT and CIRCULAR_CUSTOM_GROUPS

By default BCC_COMPACT is used as layout style

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

maximalDeviationAngle

property

maximalDeviationAngle:int

Specifies the maximal deviation angle allowed for an edge. The deviation angle for an edge is the difference between its optimal radiation angle away from the parent cycle and its actual radiation angle.

By default a maximal deviation angle of 90 degrees is applied.

Note that using a small maximal deviation angle may significantly increase the length of edges. The same is true for small preferred child wedges set on the used BalloonLayouter instance, see method balloonLayouter.

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

See also

balloonLayouter

partitionLayoutStyle

property

partitionLayoutStyle:int

Specifies the layout style for the arrangement of each partition.

Default is PARTITION_LAYOUTSTYLE_CYCLIC

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

placeChildrenOnCommonRadius

property

placeChildrenOnCommonRadius:Boolean

Getter: Returns whether or not, in the underlying tree, the children of a node are placed on a common radius.

Setter: Specifies whether or not, in the underlying tree, the children of a tree node are placed on a common radius. Disabling this feature may produce more compact layout results.

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

singleCycleLayouter

property

singleCycleLayouter:SingleCycleLayouter [read-only]

Returns the SingleCycleLayouter used for laying out single node cycles

Configuring that layouter has effects upon single cycle layouts

Implementation
public function get singleCycleLayouter():SingleCycleLayouter

Constructor Detail

CircularLayouter

()

Constructor

public function CircularLayouter(init:Boolean = true)

Create a new instance of this layouter.

The default values are:

Partition policy: BCC_COMPACT
Partition layout style: PARTITION_LAYOUTSTYLE_CYCLIC

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

canLayoutCore

()

method

override public function canLayoutCore(graph:LayoutGraph):Boolean

Always returns true.

Parameters

graph:LayoutGraph

Returns

Boolean

doLayout

()

method

override public function doLayout(layoutGraph:LayoutGraph):void

Calculates a layout for the given graph. The given graph will not be copied during the layout process and the layout will be immediately applied to the given graph. This method is not side effect free in the sense that the order of edges or nodes in the input graph may change during the layout process.

Parameters

layoutGraph:LayoutGraph

doLayoutCore

()

method

override public function doLayoutCore(graph:LayoutGraph):void

Core layout routine.

Parameters

graph:LayoutGraph

getClass

()

method

override public function getClass():Class

Returns

Class

initCircularLayouter

()

method

protected final function initCircularLayouter():void

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

See also

newCircularLayouter()

newCircularLayouter

()

method

public static function newCircularLayouter():CircularLayouter

Create a new instance of this layouter.

The default values are:

Partition policy: BCC_COMPACT
Partition layout style: PARTITION_LAYOUTSTYLE_CYCLIC

Returns

CircularLayouter

Constant Detail

BCC_COMPACT

Constant

public static const BCC_COMPACT:int = 0

Layout style specifier. In this layout style the nodes within a biconnected component of the input graph are treated as separate partitions. If a node belongs to more biconnected components, it will be assigned to the one that seems to be more suitable.

This parameter can be set with layoutStyle

See also

layoutStyle

BCC_ISOLATED

Constant

public static const BCC_ISOLATED:int = 1

Layout style specifier. In this layout style the nodes within a biconnected component of the input graph are treated as separate partitions. If a node belongs to more biconnected components, it will form an isolated partition and will be laid out in between all of it's biconnected component cycles.

This parameter can be set with layoutStyle

See also

layoutStyle

CIRCLE_ID_HOLDER_DPKEY

Constant

public static const CIRCLE_ID_HOLDER_DPKEY:Object = y.layout.circular.CircularLayouter.CIRCLE_ID_HOLDER_DPKEY

Used for publishing the final circle information. If the com.yworks.yfiles.base.DataProvider associated to this key is also a com.yworks.yfiles.base.DataAcceptor, the integer circle id of each node is stored using the acceptor's setInt (com.yworks.yfiles.base.DataAcceptor.setInt()) method. Otherwise, the provider's values should be of type com.yworks.yfiles.util.IntValueSettable whose setValue (com.yworks.yfiles.util.IntValueSettable.value) method is used to store the integer circle id of each node.

CIRCULAR_CUSTOM_GROUPS

Constant

public static const CIRCULAR_CUSTOM_GROUPS:int = 2

Layout style specifier. In this layout style the user can specify groups that will each form a separate partition. To specify groups, a com.yworks.yfiles.base.DataProvider with key CIRCULAR_CUSTOM_GROUPS_DPKEY must be registered.

This parameter can be set with layoutStyle

CIRCULAR_CUSTOM_GROUPS_DPKEY

Constant

public static const CIRCULAR_CUSTOM_GROUPS_DPKEY:Object = y.layout.circular.CircularLayouter.CIRCULAR_CUSTOM_GROUPS_DPKEY

This key is used to identify custom groups.

PARTITION_LAYOUTSTYLE_CYCLIC

Constant

public static const PARTITION_LAYOUTSTYLE_CYCLIC:int = 0

Place each node of a partition on the boundary of a circle.

This style is very fast, but the results may need much space.

This parameter can be set with partitionLayoutStyle

See also

partitionLayoutStyle

PARTITION_LAYOUTSTYLE_DISK

Constant

public static const PARTITION_LAYOUTSTYLE_DISK:int = 1

Create semi-compact layout for each partition.

This style places nodes in the inside and the border of a circle and arranges them in an organic manner, leading to more compact layout. Only nodes with connections into other partitions are guaranteed to lie on the boundary of the resulting disk. This style may come with a performance penalty. This parameter can be set with partitionLayoutStyle

See also

partitionLayoutStyle

PARTITION_LAYOUTSTYLE_ORGANIC

Constant

public static const PARTITION_LAYOUTSTYLE_ORGANIC:int = 2

Create most compact layout for each partition.

This style creates an organic circular layout for each partition. Even nodes that connect into different partitions may be placed in the inside of the resulting disk. This style may come with a performance penalty.

This parameter can be set with partitionLayoutStyle

See also

partitionLayoutStyle

SINGLE_CYCLE

Constant

public static const SINGLE_CYCLE:int = 3

Layout style specifier. In this layout style all nodes of the input graph will be put on or inside a single cycle.

This parameter can be set with layoutStyle

See also

layoutStyle

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

Package	com.yworks.yfiles.layout.circular
Class	public class CircularLayouter
Inheritance	CircularLayouter CanonicMultiStageLayouter YObject Object