Packagecom.yworks.yfiles.layout.hierarchic.incremental
Classpublic class RoutingStyle
InheritanceRoutingStyle Inheritance YObject Inheritance Object

This class is used by com.yworks.yfiles.layout.hierarchic.incremental.EdgeLayoutDescriptor to specify the routing style for different edge types.

See also

com.yworks.yfiles.layout.hierarchic.incremental.EdgeLayoutDescriptor.routingStyle
com.yworks.yfiles.layout.hierarchic.incremental.EdgeLayoutDescriptor


Public Properties
 PropertyDefined By
  backloopRoutingStyle : int
Specifies the routing style for back-loops.
RoutingStyle
  defaultEdgeRoutingStyle : int
Specifies the default routing style.
RoutingStyle
  edgeGroupRoutingStyle : int
Specifies the routing style for grouped edges at the common segments.
RoutingStyle
  sameLayerEdgeRoutingStyle : int
Specifies the routing style for same layer edges (i.e., edges whose source/target are assigned to the same layer).
RoutingStyle
  selfloopRoutingStyle : int
Specifies the routing style for self-loops.
RoutingStyle
Public Methods
 MethodDefined By
  
RoutingStyle(routingStyle:int, init:Boolean = true)
Sets the routing style for each edge type to the specified value.
RoutingStyle
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
RoutingStyle
 Inherited
hashCode():int
YObject
  
newRoutingStyle(routingStyle:int):RoutingStyle
[static] Sets the routing style for each edge type to the specified value.
RoutingStyle
Protected Methods
 MethodDefined By
  
initRoutingStyle(routingStyle:int):void
Initializes this object.
RoutingStyle
Public Constants
 ConstantDefined By
  EDGE_STYLE_OCTILINEAR : int = 1
[static] Routing style constant.
RoutingStyle
  EDGE_STYLE_ORTHOGONAL : int = 0
[static] Routing style constant.
RoutingStyle
  EDGE_STYLE_POLYLINE : int = 2
[static] Routing style constant.
RoutingStyle
Property Detail
backloopRoutingStyleproperty
backloopRoutingStyle:int

Specifies the routing style for back-loops. This style is used for routing u-turns of common edges (i.e., edges that are neither self-loops nor same layer edges). A u-turn is a non-monotonic part of the edge route that is required for reversed edges if option com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.backloopRouting is enabled or in some other scenarios with port constraints/candidates.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.


Implementation
    public function get backloopRoutingStyle():int
    public function set backloopRoutingStyle(value:int):void

See also

defaultEdgeRoutingStyleproperty 
defaultEdgeRoutingStyle:int

Specifies the default routing style. This style is used for edges or part of edges for which no other routing style applies.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.


Implementation
    public function get defaultEdgeRoutingStyle():int
    public function set defaultEdgeRoutingStyle(value:int):void

See also

edgeGroupRoutingStyleproperty 
edgeGroupRoutingStyle:int

Specifies the routing style for grouped edges at the common segments. More precisely, grouped edges are routed in bus-style (i.e., the paths of the edges will share a common edge segment) and this option allows to specify the routing style at the bus.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.


Implementation
    public function get edgeGroupRoutingStyle():int
    public function set edgeGroupRoutingStyle(value:int):void

See also

sameLayerEdgeRoutingStyleproperty 
sameLayerEdgeRoutingStyle:int

Specifies the routing style for same layer edges (i.e., edges whose source/target are assigned to the same layer).

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.


Implementation
    public function get sameLayerEdgeRoutingStyle():int
    public function set sameLayerEdgeRoutingStyle(value:int):void

See also

selfloopRoutingStyleproperty 
selfloopRoutingStyle:int

Specifies the routing style for self-loops.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.


Implementation
    public function get selfloopRoutingStyle():int
    public function set selfloopRoutingStyle(value:int):void

See also

Constructor Detail
RoutingStyle()Constructor
public function RoutingStyle(routingStyle:int, init:Boolean = true)

Sets the routing style for each edge type to the specified value.

Parameters
routingStyle:int — the routing style.
 
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
initRoutingStyle()method 
protected final function initRoutingStyle(routingStyle:int):void

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

Parameters

routingStyle:int

See also

newRoutingStyle()method 
public static function newRoutingStyle(routingStyle:int):RoutingStyle

Sets the routing style for each edge type to the specified value.

Parameters

routingStyle:int — the routing style.

Returns
RoutingStyle
Constant Detail
EDGE_STYLE_OCTILINEARConstant
public static const EDGE_STYLE_OCTILINEAR:int = 1

Routing style constant.

This constant specifies that the route should be octilinear, i.e., the route consists of vertical and horizontal segments as well as segments with slope -1 and 1.

EDGE_STYLE_ORTHOGONALConstant 
public static const EDGE_STYLE_ORTHOGONAL:int = 0

Routing style constant.

This constant specifies that the route should be orthogonal, i.e., the route only consists of vertical and horizontal segments.

EDGE_STYLE_POLYLINEConstant 
public static const EDGE_STYLE_POLYLINE:int = 2

Routing style constant.

This constant specifies that the route should be polyline.