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

This class is used by com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl during the various phases to determine the routing details of the graph's edges. Note: not all of these values will be used for all kinds of edges and any kind of algorithm. This class is designed as a class to allow for future additions of new getter methods.

See also

com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl.EDGE_LAYOUT_DESCRIPTOR_DPKEY
com.yworks.yfiles.layout.hierarchic.incremental.NodeLayoutDescriptor
com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl

Public Properties
 PropertyDefined By
  minimumDistance : Number
Getter: Returns the preferred minimum distance of the edge to obstacles.
EdgeLayoutDescriptor
  minimumFirstSegmentLength : Number
Specifies the minimum length of the first segment (at the source).
EdgeLayoutDescriptor
  minimumLastSegmentLength : Number
Specifies the minimum length of the last segment (at the target).
EdgeLayoutDescriptor
  minimumLength : Number
Specifies the minimum length of the edge.
EdgeLayoutDescriptor
  minimumSlope : Number
Specifies the minimum slope this edge's mid-segments should have if the edge is routed polygonal in vertical layouts.
EdgeLayoutDescriptor
  minOctilinearSegmentLength : Number
Specifies the minimum length of octilinear segments for this edge.
EdgeLayoutDescriptor
  orthogonallyRouted : Boolean
Determines whether this edge should be routed orthogonally.
EdgeLayoutDescriptor
  routingStyle : RoutingStyle
Specifies the routing style for this edge.
EdgeLayoutDescriptor
  sourcePortOptimizationEnabled : Boolean
Specifies whether source port optimization is enabled, i.e.
EdgeLayoutDescriptor
  targetPortOptimizationEnabled : Boolean
Specifies whether target port optimization is enabled, i.e.
EdgeLayoutDescriptor
Public Methods
 MethodDefined By
  
EdgeLayoutDescriptor(init:Boolean = true)
Creates a new instance of an EdgeLayoutDescriptor using the default values.
EdgeLayoutDescriptor
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
EdgeLayoutDescriptor
 Inherited
hashCode():int
YObject
  
newEdgeLayoutDescriptor():EdgeLayoutDescriptor
[static] Creates a new instance of an EdgeLayoutDescriptor using the default values.
EdgeLayoutDescriptor
Protected Methods
 MethodDefined By
  
initEdgeLayoutDescriptor():void
Initializes this object.
EdgeLayoutDescriptor
Property Detail
minimumDistanceproperty
minimumDistance:Number

Getter: Returns the preferred minimum distance of the edge to obstacles. Default is 10.0d.

Setter: Sets the preferred minimum distance to obstacles.


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

Specifies the minimum length of the first segment (at the source). If the value is 0.0d the first segment does not need to be orthogonal. Default is 10.0d.


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

Specifies the minimum length of the last segment (at the target). If the value is 0.0d the last segment does not need to be orthogonal. Default is 15.0d.


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

Specifies the minimum length of the edge. If this is used for polyline routing, it describes the minimum vertical length of the mid segment (the one that may be routed non-orthogonally). If it is used for orthogonal routing it describes the minimum length for the whole edge. Default is 20.0d.


Implementation
    public function get minimumLength():Number
    public function set minimumLength(value:Number):void
minimumSlopeproperty 
minimumSlope:Number

Specifies the minimum slope this edge's mid-segments should have if the edge is routed polygonal in vertical layouts.

Default is 0.3d.


Implementation
    public function get minimumSlope():Number
    public function set minimumSlope(value:Number):void
minOctilinearSegmentLengthproperty 
minOctilinearSegmentLength:Number

Specifies the minimum length of octilinear segments for this edge. Note: the layout algorithm cannot always maintain the specified minimum length.

Default is 20.0d.


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

See also

routingStyle
orthogonallyRoutedproperty 
orthogonallyRouted:Boolean

Determines whether this edge should be routed orthogonally. Default is false. This does not affect the routing of bus-like structures.


Implementation
    public function get orthogonallyRouted():Boolean
    public function set orthogonallyRouted(value:Boolean):void
routingStyleproperty 
routingStyle:RoutingStyle

Specifies the routing style for this edge.


Implementation
    public function get routingStyle():RoutingStyle
    public function set routingStyle(value:RoutingStyle):void

See also

com.yworks.yfiles.layout.hierarchic.incremental.RoutingStyle
sourcePortOptimizationEnabledproperty 
sourcePortOptimizationEnabled:Boolean

Specifies whether source port optimization is enabled, i.e. whether the algorithm should try to find a better source com.yworks.yfiles.layout.PortConstraint if the current constraint is null or com.yworks.yfiles.layout.PortConstraint.ANY_SIDE. Default is false, which will result in ports being placed at the side of the node which lies closest to the target of the edge in terms of layering.


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

See also

com.yworks.yfiles.layout.PortConstraint
com.yworks.yfiles.layout.PortConstraint.ANY_SIDE
targetPortOptimizationEnabledproperty 
targetPortOptimizationEnabled:Boolean

Specifies whether target port optimization is enabled, i.e. whether the algorithm should try to find a better target com.yworks.yfiles.layout.PortConstraint if the current constraint is null or com.yworks.yfiles.layout.PortConstraint.ANY_SIDE. Default is false, which will result in ports being placed at the side of the node which lies closest to the source of the edge in terms of layering.


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

See also

com.yworks.yfiles.layout.PortConstraint
com.yworks.yfiles.layout.PortConstraint.ANY_SIDE
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
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()
newEdgeLayoutDescriptor()method 
public static function newEdgeLayoutDescriptor():EdgeLayoutDescriptor

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

Returns
EdgeLayoutDescriptor




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