com.yworks.yfiles.layout.organic.GRIP

Public Properties

	Property		Defined By
		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
		deterministic : Boolean Specifies whether or not GRIP works in a deterministic manner.	GRIP
		finalRounds : int Getter: returns the number of the final rounds Setter: Sets the number of Fruchtermann Reingold rounds (final)	GRIP
		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
		initialTemperature : int Specifies the initial temperature for each round.	GRIP
		labelLayouter : LayoutStage Getter: Returns the algorithm used for placing labels.	CanonicMultiStageLayouter
		labelLayouterEnabled : Boolean Getter: Returns whether or not LabelLayouter is enabled.	CanonicMultiStageLayouter
		laxity : Number Specifies the current laxity value.	GRIP
		layoutOrientation : int Specifies the main layout orientation.	CanonicMultiStageLayouter
		nodeSizeAware : Boolean Specifies whether or not GRIP takes average node sizes into account.	GRIP
		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
		preferredEdgeLength : int Specifies the desired edge length	GRIP
		rounds : int Getter: returns the number of the initial rounds Setter: Sets the number of Kamada Kawai rounds (initial)	GRIP
		selfLoopLayouter : LayoutStage Getter: Returns the LayoutStage used for routing Self-loops.	CanonicMultiStageLayouter
		selfLoopLayouterEnabled : Boolean Getter: Returns whether or not the SelfLoopLayouter is enabled.	CanonicMultiStageLayouter
		smartInitialPlacement : Boolean Specifies whether or not initial placements are determined in a smart way.	GRIP
		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
		GRIP(init:Boolean = true) Creates a new instance of the GRIP layout algorithm	GRIP
		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(g:LayoutGraph):Boolean [override]	GRIP
		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(g:LayoutGraph):void [override]	GRIP
		enableOnlyCore():void Disables all layout stages and performs only the core layouter.	CanonicMultiStageLayouter
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	GRIP
		hashCode():int	YObject
		newGRIP():GRIP [static] Creates a new instance of the GRIP layout algorithm	GRIP
		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
		initGRIP():void Initializes this object.	GRIP

Property Detail

deterministic

property

deterministic:Boolean

Specifies whether or not GRIP works in a deterministic manner.

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

finalRounds

property

finalRounds:int

Getter: returns the number of the final rounds

Setter: Sets the number of Fruchtermann Reingold rounds (final)

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

initialTemperature

property

initialTemperature:int

Specifies the initial temperature for each round. This value should lie somewhere in [10..80].

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

laxity

property

laxity:Number

Specifies the current laxity value.

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

nodeSizeAware

property

nodeSizeAware:Boolean

Specifies whether or not GRIP takes average node sizes into account.

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

preferredEdgeLength

property

preferredEdgeLength:int

Specifies the desired edge length

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

rounds

property

rounds:int

Getter: returns the number of the initial rounds

Setter: Sets the number of Kamada Kawai rounds (initial)

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

smartInitialPlacement

property

smartInitialPlacement:Boolean

Specifies whether or not initial placements are determined in a smart way.

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

Constructor Detail

GRIP

()

Constructor

public function GRIP(init:Boolean = true)

Creates a new instance of the GRIP layout algorithm

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(g:LayoutGraph):Boolean

Parameters

g:LayoutGraph

Returns

Boolean

doLayoutCore

()

method

override public function doLayoutCore(g:LayoutGraph):void

Parameters

g:LayoutGraph

getClass

()

method

override public function getClass():Class

Returns

Class

initGRIP

()

method

protected final function initGRIP():void

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

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

Package	com.yworks.yfiles.layout.organic
Class	public class GRIP
Inheritance	GRIP CanonicMultiStageLayouter YObject Object