Packagecom.yworks.yfiles.layout
Classpublic class GraphLayoutLineWrapper
InheritanceGraphLayoutLineWrapper Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

A layout stage that can be used to "line-wrap" or "column-wrap" a graph layout. This stage both supports wrapping a layout at a given width (height) or wrapping the layout at a specific width (height) automatically so that the overall resulting aspect ratio will be close to a specifiable value.

See also

fixedWidthLineBreaks
fixedWidth
targetRatio
columnMode

Public Properties
 PropertyDefined By
  columnMode : Boolean
Determines whether this algorithm should not wrap lines or rows, but columns.
GraphLayoutLineWrapper
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
  edgeSpacing : Number
Specifies the space between edges that should be used for the additional routing.
GraphLayoutLineWrapper
  fixedWidth : Number
Specifies the desired width of the lines to use if fixedWidthLineBreaks is set to true.
GraphLayoutLineWrapper
  fixedWidthLineBreaks : Boolean
Specifies whether the algorithm should use the fixed width (fixedWidth) to determine line breaks.
GraphLayoutLineWrapper
  mirror : Boolean
Specifies whether lines should be going from left to right and right to left in an alternating fashion.
GraphLayoutLineWrapper
  spacing : Number
Specifies the space between adjacent lines of the wrapped graph layout.
GraphLayoutLineWrapper
  targetRatio : Number
Specifies the desired target aspect ratio the algorithm should try to generate.
GraphLayoutLineWrapper
Public Methods
 MethodDefined By
  
GraphLayoutLineWrapper(init:Boolean = true)
GraphLayoutLineWrapper
  
canLayout(graph:LayoutGraph):Boolean
[override]
GraphLayoutLineWrapper
  
doLayout(graph:LayoutGraph):void
[override]
GraphLayoutLineWrapper
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
GraphLayoutLineWrapper
 Inherited
hashCode():int
YObject
  
newGraphLayoutLineWrapper():GraphLayoutLineWrapper
[static]
GraphLayoutLineWrapper
Protected Methods
 MethodDefined By
 Inherited
canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out.
AbstractLayoutStage
 Inherited
doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
initAbstractLayoutStage1():void
AbstractLayoutStage
 Inherited
initAbstractLayoutStage2(core:Layouter):void
AbstractLayoutStage
  
initGraphLayoutLineWrapper():void
GraphLayoutLineWrapper
Property Detail
columnModeproperty
columnMode:Boolean

Determines whether this algorithm should not wrap lines or rows, but columns. If set to true, the layout will be wrapped vertically and new columns will be appended to the right of the first column. The fixedWidth property will be interpreted as a fixed height, in that case, of course. The default is false.


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

See also

fixedWidth
edgeSpacingproperty 
edgeSpacing:Number

Specifies the space between edges that should be used for the additional routing. The default is 5.


Implementation
    public function get edgeSpacing():Number
    public function set edgeSpacing(value:Number):void
fixedWidthproperty 
fixedWidth:Number

Specifies the desired width of the lines to use if fixedWidthLineBreaks is set to true. Note that the algorithm will not necessarily be able to satisfy very small values since the nodes need to fit into a line completely.

The default is 500


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

See also

fixedWidthLineBreaks
fixedWidthLineBreaksproperty 
fixedWidthLineBreaks:Boolean

Specifies whether the algorithm should use the fixed width (fixedWidth) to determine line breaks. The default is false.


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

See also

fixedWidth
targetRatio
fixed width
mirrorproperty 
mirror:Boolean

Specifies whether lines should be going from left to right and right to left in an alternating fashion. If set to true every second line will be rotated 180 degrees and ports will be adjusted correspondingly. The default is true


Implementation
    public function get mirror():Boolean
    public function set mirror(value:Boolean):void
spacingproperty 
spacing:Number

Specifies the space between adjacent lines of the wrapped graph layout. The default is 10.


Implementation
    public function get spacing():Number
    public function set spacing(value:Number):void
targetRatioproperty 
targetRatio:Number

Specifies the desired target aspect ratio the algorithm should try to generate. This setting only affects the outcome if fixedWidthLineBreaks is set to false. The default is 1.0d.


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

See also

fixedWidthLineBreaks
Constructor Detail
GraphLayoutLineWrapper()Constructor
public function GraphLayoutLineWrapper(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
canLayout()method
override public function canLayout(graph:LayoutGraph):Boolean

Parameters

graph:LayoutGraph

Returns
Boolean
doLayout()method 
override public function doLayout(graph:LayoutGraph):void

Parameters

graph:LayoutGraph

getClass()method 
override public function getClass():Class

Returns
Class
initGraphLayoutLineWrapper()method 
protected final function initGraphLayoutLineWrapper():void

newGraphLayoutLineWrapper()method 
public static function newGraphLayoutLineWrapper():GraphLayoutLineWrapper

Returns
GraphLayoutLineWrapper




Wed Oct 7 2015, 04:43 PM +02:00