| Package | com.yworks.yfiles.layout.organic |
| Class | public class ShuffleLayouter |
| Inheritance | ShuffleLayouter  YObject Object |
| Implements | LayoutStage |
| Property | Defined By | ||
|---|---|---|---|
| barycenterModeActive : Boolean
Getter:
Returns true if this layouter uses a barycenter based node shuffling strategy and false otherwise. | ShuffleLayouter | ||
| coreLayouter : Layouter
Specifies the core layouter. | ShuffleLayouter | ||
| horizontalOverlapCriterium : int
Specifies the horizontal overlap criterion. | ShuffleLayouter | ||
| minimalNodeDistance : Number
Specifies the minimal distance between nodes that has to be obeyed by this layouter. | ShuffleLayouter | ||
| simpleModeActive : Boolean
Getter:
Returns whether or not simple mode is active. | ShuffleLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
ShuffleLayouter(init:Boolean = true)
Creates a new instance of ShuffleLayouter. | ShuffleLayouter | ||
canLayout(graph:LayoutGraph):Boolean | ShuffleLayouter | ||
doLayout(graph:LayoutGraph):void
Performs the force transfer algorithm on the given graph after the core layouter has performed its job. | ShuffleLayouter | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | ShuffleLayouter | ||
| hashCode():int | YObject | |
[static]
Creates a new instance of ShuffleLayouter. | ShuffleLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
initShuffleLayouter():void
Initializes this object. | ShuffleLayouter | ||
| Constant | Defined By | ||
|---|---|---|---|
| FIXED_NODE_DPKEY : Object = y.layout.organic.ShuffleLayouter.FIXED_NODE_DPKEY [static]
This key can be used to specify whether or not a node's position should remain fixed. | ShuffleLayouter | ||
| HOC_INTERSECTION_BOX : int = 0 [static]
Horizontal overlap criteria enumeration constant. | ShuffleLayouter | ||
| HOC_LESS_MOVEMENT : int = 2 [static]
Horizontal overlap criteria enumeration constant. | ShuffleLayouter | ||
| HOC_NODE_CENTER : int = 1 [static]
Horizontal overlap criteria enumeration constant. | ShuffleLayouter | ||
| MINIMAL_DISTANCE_DPKEY : Object = y.layout.organic.ShuffleLayouter.MINIMAL_DISTANCE_DPKEY [static]
This key can be used to specify a minimal distance for each single node in the graph using a data provider. | ShuffleLayouter | ||
| barycenterModeActive | property |
Hide Inherited Public Methods
Show Inherited Public MethodsbarycenterModeActive:Boolean
Getter:
Returns true if this layouter uses a barycenter based node shuffling strategy and false otherwise.
public function get barycenterModeActive():Boolean public function set barycenterModeActive(value:Boolean):void| coreLayouter | property |
coreLayouter:LayouterSpecifies the core layouter.
public function get coreLayouter():Layouter public function set coreLayouter(value:Layouter):void| horizontalOverlapCriterium | property |
horizontalOverlapCriterium:intSpecifies the horizontal overlap criterion. One of HOC_INTERSECTION_BOX, HOC_LESS_MOVEMENT and HOC_NODE_CENTER
public function get horizontalOverlapCriterium():int public function set horizontalOverlapCriterium(value:int):voidSee also
| minimalNodeDistance | property |
minimalNodeDistance:NumberSpecifies the minimal distance between nodes that has to be obeyed by this layouter.
public function get minimalNodeDistance():Number public function set minimalNodeDistance(value:Number):void| simpleModeActive | property |
simpleModeActive:BooleanGetter: Returns whether or not simple mode is active.
Setter: Specifies whether or not to activate a simple layout mode. When in simple mode the algorithm is very fast but the quality of the resulting layout may be poor. When not active the resulting layout is better and the running time is higher. By default simple mode is not active. public function get simpleModeActive():Boolean public function set simpleModeActive(value:Boolean):void| ShuffleLayouter | () | Constructor |
public function ShuffleLayouter(init:Boolean = true)Creates a new instance of ShuffleLayouter.
Parametersinit:Boolean (default = true) |
| canLayout | () | method |
| doLayout | () | method |
public function doLayout(graph:LayoutGraph):voidPerforms the force transfer algorithm on the given graph after the core layouter has performed its job.
Parameters
graph:LayoutGraph |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initShuffleLayouter | () | method |
protected final function initShuffleLayouter():void
Initializes this object. See the documentation of the corresponding factory method newShuffleLayouter() for details.
See also
| newShuffleLayouter | () | method |
public static function newShuffleLayouter():ShuffleLayouterCreates a new instance of ShuffleLayouter.
ReturnsShuffleLayouter |
| FIXED_NODE_DPKEY | Constant |
public static const FIXED_NODE_DPKEY:Object = y.layout.organic.ShuffleLayouter.FIXED_NODE_DPKEYThis key can be used to specify whether or not a node's position should remain fixed. The corresponding data provider's com.yworks.yfiles.base.DataProvider.getBool() method is used to determine which nodes are fixed.
See also
| HOC_INTERSECTION_BOX | Constant |
public static const HOC_INTERSECTION_BOX:int = 0Horizontal overlap criteria enumeration constant.
| HOC_LESS_MOVEMENT | Constant |
public static const HOC_LESS_MOVEMENT:int = 2Horizontal overlap criteria enumeration constant.
| HOC_NODE_CENTER | Constant |
public static const HOC_NODE_CENTER:int = 1Horizontal overlap criteria enumeration constant.
| MINIMAL_DISTANCE_DPKEY | Constant |
public static const MINIMAL_DISTANCE_DPKEY:Object = y.layout.organic.ShuffleLayouter.MINIMAL_DISTANCE_DPKEYThis key can be used to specify a minimal distance for each single node in the graph using a data provider. Note that values must be strictly positive.