OctilinearRoutingStage

Show usages

OctilinearRoutingStage creates octilinear edge routes by extending given orthogonal edge paths with polyline segments.

Inheritance Hierarchy

LayoutStageBase

OctilinearRoutingStage

Implemented Interfaces

ILayoutStage

ILayoutAlgorithm

Remarks

Important: The current implementation only adds octilinear segments to all given orthogonal edges. Non-orthogonal edges are completely ignored. To create new routes in any case, apply EdgeRouter with routing style OCTILINEAR.

An octilinear segment is added between two consecutive vertical and horizontal segments. The length of an octilinear segment can be influenced by the maximumNonOrthogonalSegmentRatio and the preferredOctilinearSegmentLength. The inserted segments maintain a customizable minimum distance between the edges and all nodes in the graph if possible.

Default Values of Properties

maximumNonOrthogonalSegmentRatio	`0.5`
minimumNodeToEdgeDistance	`10`
preferredOctilinearSegmentLength	`50`

Type Details

yFiles module: algorithms

Constructors

OctilinearRoutingStage

(coreLayout?: ILayoutAlgorithm)

Creates a new instance of OctilinearRoutingStage using the given coreLayout.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

coreLayout - ILayoutAlgorithm: the core layout routine
minimumNodeToEdgeDistance - number: The minimum distance between edges and node bounds. This option sets the minimumNodeToEdgeDistance property on the created object.
maximumNonOrthogonalSegmentRatio - number: The maximum segment length ratio at each end of an orthogonal segment that may get converted into a (non-orthogonal) octilinear segment. This option sets the maximumNonOrthogonalSegmentRatio property on the created object.
preferredOctilinearSegmentLength - number: The preferred segment length for (non-orthogonal) octilinear segments. This option sets the preferredOctilinearSegmentLength property on the created object.
enabled - boolean

Properties

coreLayout

: ILayoutAlgorithm?

Gets or sets the core ILayoutAlgorithm that is wrapped by this stage.

Default Value

The default value is null.

Property Value

the core layout routine

Implements

ILayoutStage

enabled

: boolean

Gets or sets a value that determines whether this stage should do anything but execute the coreLayout.

Remarks

By default, when constructed, stages should be enabled. Users may disable a stage's functionality by setting this property to false.

Stages that can guarantee that the graph will not change can choose to not even execute the coreLayout when disabled.

Implements

ILayoutStage

maximumNonOrthogonalSegmentRatio

: number

Gets or sets the maximum segment length ratio at each end of an orthogonal segment that may get converted into a (non-orthogonal) octilinear segment.

Remarks

The ratio must be between 0 and 0.5.

Default Value

The default value is 0.5.

Property Value

a value from the interval [0,0.5]

Throws

Exception({ name: 'ArgumentError' }): if the ratio does not lie within [0,0.5] interval

minimumNodeToEdgeDistance

: number

Gets or sets the minimum distance between edges and node bounds.

Remarks

Values should be greater than or equal to 0.

Default Value

The default value is 10.

Property Value

the minimum distance between edges and node bounds

Throws

Exception({ name: 'ArgumentError' }): if the distance is negative

preferredOctilinearSegmentLength

: number

Gets or sets the preferred segment length for (non-orthogonal) octilinear segments.

Remarks

Values should be greater than or equal to 0.

Default Value

The default value is 50.

Property Value

the preferred segment length for (non-orthogonal) octilinear segments

Throws

Exception({ name: 'ArgumentError' }): if the length is negative

Methods

applyLayout

(graph: LayoutGraph)

Implementation of the ILayoutAlgorithm interface and main entry point for the layout calculation.

Remarks

This implementation checks the enabled state and when it's not enabled, will delegate to the coreLayout, directly. When the stage is enabled, all the work will be delegated to applyLayoutImpl, instead.

Parameters

options - Object
A map of options to pass to the method.

graph - LayoutGraph: The graph to apply the layout to.

Implements

ILayoutAlgorithm

applyLayoutImpl

(graph: LayoutGraph)

Adds octilinear segments to the edge routes produced by the coreLayout.

Parameters

options - Object
A map of options to pass to the method.

graph - LayoutGraph: the input graph

Implements

LayoutStageBase

createLayoutData

(graph: LayoutGraph) : EdgeScopeData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel,boolean>

Returns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to define the edges affected by the OctilinearRoutingStage.

Remarks

The generic type arguments of the created layout data are compatible with instances of LayoutGraph, but the layout data is not bound to a specific graph instance. Therefore, the created layout data still has to be passed as an argument of applyLayout in order to be applied.

Parameters

options - Object
A map of options to pass to the method.

graph - LayoutGraph: the graph that determines the generic type arguments of the created layout data

Returns

↪EdgeScopeData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel,boolean>: an instance of layout data that can be used to perform item-specific configurations for the given OctilinearRoutingStage.

createLayoutData

(graph: IGraph) : EdgeScopeData<INode,IEdge,ILabel,ILabel,boolean>

Returns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to define the edges affected by the OctilinearRoutingStage.

Remarks

The generic type arguments of the created layout data are compatible with instances of IGraph, but the layout data is not bound to a specific graph instance. Therefore, the created layout data still has to be passed as an argument of applyLayout in order to be applied.

Parameters

options - Object
A map of options to pass to the method.

graph - IGraph: the graph that determines the generic type arguments of the created layout data

Returns

↪EdgeScopeData<INode,IEdge,ILabel,ILabel,boolean>: an instance of layout data that can be used to perform item-specific configurations for the given OctilinearRoutingStage.

This method is not available unless the module view-layout-bridge is loaded. Either load the module 'view-layout-bridge' explicitly or ensure that the LayoutExecutor type is available at runtime.