| Package | com.yworks.yfiles.layout.circular |
| Class | public class SingleCycleLayouter |
| Inheritance | SingleCycleLayouter  CanonicMultiStageLayouter YObject Object |
| Property | Defined By | ||
|---|---|---|---|
| automaticRadius : Boolean
Getter:
Returns whether or not to choose the cycle radius automatically. | SingleCycleLayouter | ||
 | 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 | |
| fixedRadius : Number
Getter:
Returns the fixed radius for the cycle on which the nodes of the graph will be placed. | SingleCycleLayouter | ||
| fromSketchModeEnabled : Boolean
Getter:
Returns whether or not to take the coordinates of the input diagram into account when arranging the nodes. | SingleCycleLayouter | ||
| 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 | |
| initialAngle : Number
Getter:
Get the angle for the first node. | SingleCycleLayouter | ||
| labelLayouter : LayoutStage
Getter:
Returns the algorithm used for placing labels. | CanonicMultiStageLayouter | |
| labelLayouterEnabled : Boolean
Getter:
Returns whether or not LabelLayouter is enabled. | CanonicMultiStageLayouter | |
| lastAppliedRadius : Number [read-only]
Returns the radius last applied by this layouter. | SingleCycleLayouter | ||
| layoutOrientation : int
Specifies the main layout orientation. | CanonicMultiStageLayouter | |
| minimalNodeDistance : int
Getter:
Returns the distance to keep between the nodes on the cycle Default value is 30.0. | SingleCycleLayouter | ||
| minimalRadius : Number
Getter:
Returns the minimal radius for the cycle on which the nodes are placed. | SingleCycleLayouter | ||
| nodeSequencer : NodeSequencer
Specifies the node sequencer used to determine the order of nodes around a cycle. | SingleCycleLayouter | ||
| 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 | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
SingleCycleLayouter(init:Boolean = true) | SingleCycleLayouter | ||
| appendStage(stage:LayoutStage):void
Appends a stage to the layout pipeline. | CanonicMultiStageLayouter | |
|
Returns a layout for the given layout graph. | CanonicMultiStageLayouter | |
|
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. | SingleCycleLayouter | ||
| doLayout(layoutGraph:LayoutGraph):void
Calculates a layout for the given graph. | CanonicMultiStageLayouter | |
|
Calculates a layout for the given graph interface and layout. | CanonicMultiStageLayouter | |
doLayoutCore(graph:LayoutGraph):void [override]
Core layout routine. | SingleCycleLayouter | ||
| enableOnlyCore():void
Disables all layout stages and performs only the core layouter. | CanonicMultiStageLayouter | |
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | SingleCycleLayouter | ||
| hashCode():int | YObject | |
[static] | SingleCycleLayouter | ||
| 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 | |
| CanonicMultiStageLayouter | ||
initSingleCycleLayouter():void
Initializes this object. | SingleCycleLayouter | ||
| automaticRadius | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesautomaticRadius:BooleanGetter: Returns whether or not to choose the cycle radius automatically. By default this feature is enabled.
Setter: Specifies whether or not the radius for the layout should be determined automatically. If enabled a radius will be chosen such that the adjacent nodes on the circle will be approximately minimalNodeDistance apart. If this feature is deactivated the radius specified via fixedRadius will be applied. By default this feature is enabled. public function get automaticRadius():Boolean public function set automaticRadius(value:Boolean):voidSee also
| fixedRadius | property |
fixedRadius:NumberGetter: Returns the fixed radius for the cycle on which the nodes of the graph will be placed. Default value is 200.0.
Setter: Sets a fixed radius for the cycle on which the nodes of the graph will be placed. The fixed radius is ignored if the automatic radius feature is activated. Default value is 200.0. public function get fixedRadius():Number public function set fixedRadius(value:Number):void| fromSketchModeEnabled | property |
fromSketchModeEnabled:BooleanGetter: Returns whether or not to take the coordinates of the input diagram into account when arranging the nodes.
Setter: Determines whether or not to take the coordinates of the input diagram into account when arranging the nodes of the partition. If this features is enabled, the original circular order of peripheral nodes around an estimated circle center is preserved. By default this feature is disabled. public function get fromSketchModeEnabled():Boolean public function set fromSketchModeEnabled(value:Boolean):void| initialAngle | property |
initialAngle:NumberGetter: Get the angle for the first node. Default value is 0.0
Setter: Set the angle for the first node of the sequence. The angle is measured in rad and world coordinates, i.e. 0 is east, Pi/4 south etc. Note: This setting is ignored when the SingleCycleLayouter is used in connection with com.yworks.yfiles.layout.circular.CircularLayouter. public function get initialAngle():Number public function set initialAngle(value:Number):voidSee also
| lastAppliedRadius | property |
lastAppliedRadius:Number [read-only] Returns the radius last applied by this layouter.
public function get lastAppliedRadius():Number| minimalNodeDistance | property |
minimalNodeDistance:intGetter: Returns the distance to keep between the nodes on the cycle Default value is 30.0.
Setter: Sets the minimal distance to keep between the nodes on the cycle This feature is ignored if the automatic radius feature is deactivated. Default value is 30.0. public function get minimalNodeDistance():int public function set minimalNodeDistance(value:int):void| minimalRadius | property |
minimalRadius:NumberGetter: Returns the minimal radius for the cycle on which the nodes are placed. Default value is 5.0.
Setter: Sets the minimal radius for the cycle on which the nodes are placed. This feature is considered if the radius is detected automatically. Default value is 5.0. public function get minimalRadius():Number public function set minimalRadius(value:Number):void| nodeSequencer | property |
nodeSequencer:NodeSequencerSpecifies the node sequencer used to determine the order of nodes around a cycle.
public function get nodeSequencer():NodeSequencer public function set nodeSequencer(value:NodeSequencer):void| SingleCycleLayouter | () | Constructor |
public function SingleCycleLayouter(init:Boolean = true)Parameters
init:Boolean (default = true) |
| canLayoutCore | () | method |
override public function canLayoutCore(graph:LayoutGraph):Boolean
Always returns true.
Yes we can handle anything!
Parameters
graph:LayoutGraph |
Boolean |
| doLayoutCore | () | method |
override public function doLayoutCore(graph:LayoutGraph):voidCore layout routine.
Parameters
graph:LayoutGraph |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initSingleCycleLayouter | () | method |
protected final function initSingleCycleLayouter():void
Initializes this object. See the documentation of the corresponding factory method newSingleCycleLayouter() for details.
See also
| newSingleCycleLayouter | () | method |