| Package | com.yworks.yfiles.layout.router.polyline |
| Class | public class EdgeLayoutDescriptor |
| Inheritance | EdgeLayoutDescriptor  YObject Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| minimalEdgeToEdgeDistance : Number
Getter:
Returns the minimal distance between a pair of edges. | EdgeLayoutDescriptor | ||
| minimalFirstSegmentLength : Number
Getter:
Returns the minimal length of the first segment (at the source). | EdgeLayoutDescriptor | ||
| minimalLastSegmentLength : Number
Getter:
Returns the minimal length of the last segment (at the target). | EdgeLayoutDescriptor | ||
| minimalNodeCornerDistance : Number
Getter:
Returns the minimal distance the edge shall keep from node corners when entering or leaving the node. | EdgeLayoutDescriptor | ||
| monotonicPathRestriction : int
Specifies the monotonic path restrictions for this edge. | EdgeLayoutDescriptor | ||
| penaltySettings : PenaltySettings
Specifies the penalty settings that should be used for this edge. | EdgeLayoutDescriptor | ||
| Method | Defined By | ||
|---|---|---|---|
EdgeLayoutDescriptor(init:Boolean = true)
Creates a new instance of an EdgeLayoutDescriptor using the default values. | EdgeLayoutDescriptor | ||
Creates a copy of this instance. | EdgeLayoutDescriptor | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | EdgeLayoutDescriptor | ||
| hashCode():int | YObject | |
[static]
Creates a new instance of an EdgeLayoutDescriptor using the default values. | EdgeLayoutDescriptor | ||
| Method | Defined By | ||
|---|---|---|---|
initEdgeLayoutDescriptor():void
Initializes this object. | EdgeLayoutDescriptor | ||
| Constant | Defined By | ||
|---|---|---|---|
| MONOTONIC_BOTH : int [static]
Constant that specifies monotonic path restrictions for edges. | EdgeLayoutDescriptor | ||
| MONOTONIC_HORIZONTAL : int [static]
Constant that specifies monotonic path restrictions for edges. | EdgeLayoutDescriptor | ||
| MONOTONIC_NONE : int [static]
Constant that specifies monotonic path restrictions for edges. | EdgeLayoutDescriptor | ||
| MONOTONIC_VERTICAL : int [static]
Constant that specifies monotonic path restrictions for edges. | EdgeLayoutDescriptor | ||
| minimalEdgeToEdgeDistance | property |
Hide Inherited Public Methods
Show Inherited Public MethodsminimalEdgeToEdgeDistance:Number
Getter:
Returns the minimal distance between a pair of edges.
Default is 3.0.
3.0.The value must be >= 0, otherwise the default value will be assigned.
public function get minimalEdgeToEdgeDistance():Number public function set minimalEdgeToEdgeDistance(value:Number):void| minimalFirstSegmentLength | property |
minimalFirstSegmentLength:Number
Getter:
Returns the minimal length of the first segment (at the source).
Default is 5.0.
Note: the first segment length starts, if present, at the halo of the source.
Setter: Sets the minimal length of the first segment (at the source). By default this value is set to5.0. The value must be >= 0, otherwise the default value will be assigned. Note: the resulting segment length also depends on the given grid spacing (com.yworks.yfiles.layout.router.polyline.Grid.spacing), i.e., segment length >= (int) Math.ceil(length / grid spacing).
Note: the first segment length starts, if present, at the halo of the source.
public function get minimalFirstSegmentLength():Number public function set minimalFirstSegmentLength(value:Number):voidSee also
| minimalLastSegmentLength | property |
minimalLastSegmentLength:Number
Getter:
Returns the minimal length of the last segment (at the target).
Default is 10.0.
Note: the last segment length ends, if present, at the halo of the target.
Setter: Sets the minimal length of the last segment (at the target). By default this value is set to10.0. The value must be >= 0, otherwise the default value will be assigned. Note: the resulting segment length also depends on the given grid spacing (com.yworks.yfiles.layout.router.polyline.Grid.spacing), i.e., segment length >= (int) Math.ceil(length / grid spacing).
Note: the last segment length ends, if present, at the halo of the target.
public function get minimalLastSegmentLength():Number public function set minimalLastSegmentLength(value:Number):voidSee also
| minimalNodeCornerDistance | property |
minimalNodeCornerDistance:Number
Getter:
Returns the minimal distance the edge shall keep from node corners when entering or leaving the node.
Default is 3.0.
3.0. The value must be >= 0, otherwise the default value will be assigned.
public function get minimalNodeCornerDistance():Number public function set minimalNodeCornerDistance(value:Number):void| monotonicPathRestriction | property |
monotonicPathRestriction:intSpecifies the monotonic path restrictions for this edge. The edge can be used with one of the following values: MONOTONIC_HORIZONTAL, MONOTONIC_VERTICAL, MONOTONIC_BOTH, or MONOTONIC_NONE. Default is MONOTONIC_NONE.
public function get monotonicPathRestriction():int public function set monotonicPathRestriction(value:int):voidSee also
| penaltySettings | property |
penaltySettings:PenaltySettingsSpecifies the penalty settings that should be used for this edge. Besides specifying a completely customized setting, the user can choose between four predefined optimization strategies: com.yworks.yfiles.layout.router.polyline.PenaltySettings.OPTIMIZATION_BALANCED, com.yworks.yfiles.layout.router.polyline.PenaltySettings.OPTIMIZATION_EDGE_BENDS, com.yworks.yfiles.layout.router.polyline.PenaltySettings.OPTIMIZATION_EDGE_CROSSINGS and com.yworks.yfiles.layout.router.polyline.PenaltySettings.OPTIMIZATION_EDGE_LENGTHS.
public function get penaltySettings():PenaltySettings public function set penaltySettings(value:PenaltySettings):voidSee also
| EdgeLayoutDescriptor | () | Constructor |
public function EdgeLayoutDescriptor(init:Boolean = true)Creates a new instance of an EdgeLayoutDescriptor using the default values.
Parametersinit:Boolean (default = true) |
| createCopy | () | method |
public function createCopy():EdgeLayoutDescriptorCreates a copy of this instance.
ReturnsEdgeLayoutDescriptor — the copy.
|
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| 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():EdgeLayoutDescriptorCreates a new instance of an EdgeLayoutDescriptor using the default values.
ReturnsEdgeLayoutDescriptor |
| MONOTONIC_BOTH | Constant |
public static const MONOTONIC_BOTH:intConstant that specifies monotonic path restrictions for edges. This constant specifies restrictions for the horizontal and vertical direction, i.e., each horizontal as well as each vertical edge segment is directed from the source to the target.
See also
| MONOTONIC_HORIZONTAL | Constant |
public static const MONOTONIC_HORIZONTAL:intConstant that specifies monotonic path restrictions for edges. This constant specifies restrictions for the horizontal direction, i.e., each horizontal edge segment is directed from the source to the target.
See also
| MONOTONIC_NONE | Constant |
public static const MONOTONIC_NONE:intConstant that specifies monotonic path restrictions for edges. This constant specifies that there are no restrictions.
See also
| MONOTONIC_VERTICAL | Constant |
public static const MONOTONIC_VERTICAL:intConstant that specifies monotonic path restrictions for edges. This constant specifies restrictions for the vertical direction, i.e., each vertical edge segment is directed from the source to the target.
See also