Packagecom.yworks.yfiles.layout.orthogonal
Classpublic class EdgeLayoutDescriptor
InheritanceEdgeLayoutDescriptor Inheritance YObject Inheritance Object

This class is used by com.yworks.yfiles.layout.orthogonal.OrthogonalLayouter, com.yworks.yfiles.layout.orthogonal.DirectedOrthogonalLayouter and com.yworks.yfiles.layout.orthogonal.OrthogonalGroupLayouter to determine the routing details of the graph's edges.

See also

com.yworks.yfiles.layout.orthogonal.OrthogonalLayouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY
com.yworks.yfiles.layout.orthogonal.DirectedOrthogonalLayouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY
com.yworks.yfiles.layout.orthogonal.OrthogonalGroupLayouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY
com.yworks.yfiles.layout.orthogonal.OrthogonalLayouter
com.yworks.yfiles.layout.orthogonal.DirectedOrthogonalLayouter
com.yworks.yfiles.layout.orthogonal.OrthogonalGroupLayouter


Public Properties
 PropertyDefined By
  minimumFirstSegmentLength : Number
Getter: Returns the minimum length of the first segment (at the source).
EdgeLayoutDescriptor
  minimumLastSegmentLength : Number
Getter: Returns the minimum length of the last segment (at the target).
EdgeLayoutDescriptor
  minimumSegmentLength : Number
Getter: Returns the minimum segment length of the edge.
EdgeLayoutDescriptor
Public Methods
 MethodDefined By
  
EdgeLayoutDescriptor(init:Boolean = true)
Creates a new instance of an EdgeLayoutDescriptor using the default values.
EdgeLayoutDescriptor
  
Creates a copy of this instance.
EdgeLayoutDescriptor
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
EdgeLayoutDescriptor
 Inherited
hashCode():int
YObject
  
[static] Creates a new instance of an EdgeLayoutDescriptor using the default values.
EdgeLayoutDescriptor
Protected Methods
 MethodDefined By
  
Initializes this object.
EdgeLayoutDescriptor
Property Detail
minimumFirstSegmentLengthproperty
minimumFirstSegmentLength:Number

Getter: Returns the minimum length of the first segment (at the source). Default is 15.0d.

Setter: Sets the minimum length of the first segment (at the source). Note: the resulting segment length also depends on the given grid size (see com.yworks.yfiles.layout.orthogonal.OrthogonalLayouter.grid), i.e., segment length >= (int) Math.ceil(length / grid size).


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

See also

minimumLastSegmentLengthproperty 
minimumLastSegmentLength:Number

Getter: Returns the minimum length of the last segment (at the target). Default is 15.0d.

Setter: Sets the minimum length of the last segment (at the target). Note: the resulting segment length also depends on the given grid size (see com.yworks.yfiles.layout.orthogonal.OrthogonalLayouter.grid), i.e., segment length >= (int) Math.ceil(length / grid size).


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

See also

minimumSegmentLengthproperty 
minimumSegmentLength:Number

Getter: Returns the minimum segment length of the edge. Default is 15.0d.

Setter: Sets the minimum segment length of an edge. Note: the resulting segment length also depends on the given grid size (see com.yworks.yfiles.layout.orthogonal.OrthogonalLayouter.grid), i.e., segment length >= (int) Math.ceil(length / grid size).


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

See also

Constructor Detail
EdgeLayoutDescriptor()Constructor
public function EdgeLayoutDescriptor(init:Boolean = true)

Creates a new instance of an EdgeLayoutDescriptor using the default values.

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
createCopy()method
public function createCopy():EdgeLayoutDescriptor

Creates a copy of this instance.

Returns
EdgeLayoutDescriptor — the copy.
getClass()method 
override public function getClass():Class

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

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

See also

newEdgeLayoutDescriptor()method 
public static function newEdgeLayoutDescriptor():EdgeLayoutDescriptor

Creates a new instance of an EdgeLayoutDescriptor using the default values.

Returns
EdgeLayoutDescriptor