LayoutGraphUtilities

Show usages

The LayoutGraphUtilities provides several helper and utility functions for LayoutGraph and the layout algorithms.

Inheritance Hierarchy

LayoutGraphUtilities

Type Details

yfiles module: layout-core
yfiles-umd modules: All layout modules, view-layout-bridge
Legacy UMD name: yfiles.layout.LayoutGraphUtilities

Static Methods

alignNodeLayouts

(graph: LayoutGraph, nodes: YNodeList, referenceNode: YNode, vertical: boolean, mode: NodeAlignment)

Aligns the specified nodes either vertically or horizontally according to the specified node alignment mode.

Remarks

For vertical arrangements, nodes are either top-aligned, center-aligned, bottom-aligned, or vertically distributed.

For horizontal arrangements, nodes are either left-aligned, center-aligned, right-aligned, or horizontally distributed.

In this context, distributed means that the specified nodes are placed in such a way that the projections of their bounds onto the vertical or horizontal coordinate axis do not overlap. For example, after vertically distributing nodes, (n1.y + n1.height) <= n2.y for two consecutively placed nodes n1 and n2.

Parameters

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

graph - LayoutGraph: the graph that contains the specified nodes
nodes - YNodeList: the subset of the specified graph's nodes that is arranged
referenceNode - YNode: if null, the common coordinate for aligning the specified nodes is calculated as the the vertical minimum (top-aligned), the vertical center, the vertical maximum (bottom-aligned), the horizontal minimum (left-aligned), the horizontal center, or the horizontal maximum (right-aligned) of the bounds of the specified nodes; otherwise the appropriate coordinate of the given reference node's bounds is used as common coordinate for aligning the specified nodes. The reference node is ignored when distributing nodes.
vertical - boolean: true if nodes should be aligned (or distributed) according to their y-coordinates; otherwise nodes are aligned (or distributed) according to their x-coordinates.
mode - NodeAlignment: one of the valid alignment modes

arrangeRectangleGrid

(rectangles: Rectangle2D[], finalRect: Rectangle2D, aspectRatio: number) : YDimension

Reassigns the bounds of the rectangles in a grid to fit in a large rectangle with an aspect ratio close to the specified aspect ratio.

Remarks

The aspect ratio must be greater than 0.

Parameters

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

rectangles - Rectangle2D[]: the rectangles whose coordinates will be modified
finalRect - Rectangle2D: the exact dimension will be placed in this rectangle
aspectRatio - number: the preferred aspect ratio of the grid

Returns

↪YDimension: the dimension of the grid

Throws

Exception({ name: 'ArgumentError' }): if the given aspect ratio is less than or equal to zero

arrangeRectangleMultiRows

(rectangles: Rectangle2D[], finalRect: Rectangle2D, preferredWidth: number, preferredHeight: number, compaction: boolean, constraintMode: MultiRowConstraint, alignment?: RowAlignment) : number

Reassigns the bounds of the rectangles in multiple rows to fit the preferred width and height.

Remarks

The rectangles will be placed within this bound, arranged in rows, where each row may be split into more sub-rows. This often leads to more compact results than provided by the procedure used in arrangeRectangleRows. A row will be subdivided into more rows, if two successive rectangles to be placed in the row could be placed stacked within this row without making the row larger in height.

The preferred width and height should be greater than 0, otherwise the nodes are not arranged.

Parameters

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

rectangles - Rectangle2D[]: the rectangles to arrange (coordinates will be assigned)
finalRect - Rectangle2D: the exact resulting dimension will be stored in this rectangle
preferredWidth - number: the preferred width of the result rectangle
preferredHeight - number: the preferred height of the result rectangle
compaction - boolean: true if the algorithm tries to always minimize the resulting dimension, whilst respecting the given constraints, false otherwise
constraintMode - MultiRowConstraint: the width or height constraints to consider
alignment - RowAlignment: the alignment inside a row

Returns

↪number: the number of rows used

arrangeRectangleRows

(rectangles: Rectangle2D[], finalRect: Rectangle2D, aspectRatio: number, alignment?: RowAlignment) : number

Reassigns the bounds of the rectangles to fit in a large rectangle with an aspect ratio close to the specified aspect ratio.

Remarks

This is achieved by arranging the rectangles in rows.

The aspect ratio must be greater than 0.

Parameters

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

rectangles - Rectangle2D[]: the rectangles whose coordinates will be modified
finalRect - Rectangle2D: the exact dimension of the resulting rectangle
aspectRatio - number: the preferred aspect ratio of the resulting rectangle
alignment - RowAlignment: one of the valid row alignments

Returns

↪number: the number of used rows

Throws

Exception({ name: 'ArgumentError' }): if the aspect ratio is 0 or less

assignReverseLayout

(graph: LayoutGraph, edge1: Edge, edge2: Edge)

Applies the reversed layout of the first edge to the second edge.

Parameters

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

graph - LayoutGraph: the graph to which both edges belong
edge1 - Edge: the edge which adopts the points
edge2 - Edge: the template

autoFlipBox

(rect: YOrientedRectangle) : boolean

Flips the orientation of a given rectangle, if its up vector points downward (upY > 0).

Remarks

That means, it rotates the rectangle by 180 degrees without changing the rectangle's center.

Parameters

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

rect - YOrientedRectangle: the given rectangle

Returns

↪boolean: true if the given rectangle was flipped, false otherwise

clipEdgeOnBounds

(graph: LayoutGraph, edge: Edge)

Clips the path of the given edge on the bounding box of the source and target points.

Remarks

On a clipped edge, the source and target port will be located at the border of the corresponding node.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the edge to clip

If the source/target end of the edge's path is not contained in the source/target node layout, the algorithm just keeps that end of the path as it is, i.e., this method does never extend the path.

clipEdgePathOnBounds

(graph: LayoutGraph, edge: Edge) : YPointPath

Returns the path of an edge clipped on the bounding box of the source and target node.

Remarks

On the clipped edge, the source and target port will be located at the border of the corresponding node.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the clipped edge

Returns

↪YPointPath: the clipped path of the edge

If the source/target end of the edge's path is not contained in the source/target node layout, the algorithm just keeps that end of the path as it is, i.e., this method does never extend the path.

clipEdgePathOnBounds

(edge: IEdgeLayout, source: INodeLayout, target: INodeLayout, inset?: number) : YPointPath

Returns the path of an edge clipped on insets of the bounding box of the source and target node.

Remarks

On the clipped edge, the source and target port will be located inside the node with an inset to the border of the corresponding node.

Parameters

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

edge - IEdgeLayout: the clipped edge
source - INodeLayout: the source of the edge
target - INodeLayout: the target of the edge
inset - number: the inset of the node

Returns

↪YPointPath: the clipped path of the edge

If the source/target end of the given path is not contained in the specified source/target node layout, the algorithm just keeps that end of the path as it is, i.e., this method does never extend the path.

clipEdgesOnBounds

(graph: LayoutGraph)

Clips the path of all edges in the graph on the bounding box of their source and target points.

Remarks

On a clipped edge, the source and target port will be located at the border of the corresponding node.

Parameters

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

graph - LayoutGraph: the graph

clipPathOnBounds

(path: YPointPath, sourceBox: YRectangle, targetBox: YRectangle) : YPointPath

Returns the path of a given edge path clipped on the given bounding boxes of the source and target node.

Parameters

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

path - YPointPath: the path that will be clipped
sourceBox - YRectangle: the box of the source node that the given path should be clipped at
targetBox - YRectangle: the box of the target node that the given path should be clipped at

Returns

↪YPointPath: the path clipped on the given nodes boxes

In contrast to methods clipEdgePathOnBounds and clipEdgePathOnBounds, the path can explicitly be specified and is not queried from a given graph and edge. Furthermore, this method does not consider any insets on the given boxes

If the source/target end of the given path is not contained in the specified source/target rectangle, the algorithm just keeps that end of the path as it is, i.e., this method does never extend the path.

determineEdgeFlowDirection

(graph: LayoutGraph, considerEdges: IDataProvider) : EdgeFlow

Determines the main direction of the edge flow by analyzing the current layout of the graph.

Remarks

The method only considers edges that are marked in the given IDataProvider. If the provider is null, all edges are considered.

Parameters

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

graph - LayoutGraph

the underlying graph

considerEdges - IDataProvider

the edges to consider

Domain	Edge
Values	boolean	`true` if the edge should be considered, `false` otherwise

Returns

↪EdgeFlow: one of the predefined flow directions

edgeLayoutString

(graph: LayoutGraph, edge: Edge) : string

Returns a string representation of the path of the given edge.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the edge

Returns

↪string: the string that contains all control points of the edge

The source and target ports are not included in the representation.

getBoundingBox

(graph: LayoutGraph, nodes: INodeCursor, edges: IEdgeCursor) : Rectangle2D

Returns the bounding box of the nodes and edges accessible through the given cursors.

Remarks

In this case, the bounding box is the smallest paraxial rectangle which contains the given nodes and the control points as well as the source and target points of all edges.

Parameters

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

graph - LayoutGraph: the graph that contains the nodes and edges
nodes - INodeCursor: the nodes to include in the bounding box
edges - IEdgeCursor: the edges to include in the bounding box

Returns

↪Rectangle2D: the bounding box containing the given nodes and edges

getBoundingBox

(graph: LayoutGraph, node: YNode) : Rectangle2D

Returns the bounding box of the given node.

Remarks

In this case, the bounding box is the smallest paraxial rectangle which contains the given node. It is identical to the node's bounds.

Parameters

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

graph - LayoutGraph: the graph that contains the node
node - YNode: the node

Returns

↪Rectangle2D: the bounding box of the node

getBoundingBox

(graph: LayoutGraph, edge: Edge) : Rectangle2D

Returns the bounding box of the given edge.

Remarks

In this case, the bounding box is the smallest paraxial rectangle which contains the control points as well as the absolute coordinates of the source and target point of the edge.

Parameters

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

graph - LayoutGraph: the graph that contains the edge
edge - Edge: the edge

Returns

↪Rectangle2D: the bounding box of the edge

getBoundingBox

(graph: LayoutGraph, nodes: INodeCursor, edges: IEdgeCursor, includeLabels: boolean) : Rectangle2D

Returns the bounding box of the nodes and edges accessible through the given cursors, optionally including node labels and edge labels.

Remarks

In this case, the bounding box is the smallest paraxial rectangle which contains the given nodes and the control points as well as the source and target points of all edges. If labels should be included, it also contains their boxes.

Parameters

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

graph - LayoutGraph: the graph that contains the given nodes and edges
nodes - INodeCursor: the nodes to include in the bounding box
edges - IEdgeCursor: the edges to include in the bounding box
includeLabels - boolean: true if labels of nodes and edges should be included, false otherwise

Returns

↪Rectangle2D: the bounding box of the given nodes and edges

getBoundingBox

(graph: LayoutGraph, nodes: INodeCursor, edges: IEdgeCursor, includeNodeLabels: boolean, includeEdgeLabels: boolean, includeHalos?: boolean) : Rectangle2D

Returns the bounding box of the nodes and edges accessible through the given cursors, optionally including node labels, edge labels or NodeHalos.

Remarks

In this case, the bounding box is the smallest paraxial rectangle which contains the given nodes and the control points as well as the source and target points of all edges. If node or edge labels should be included, it also contains their boxes. NodeHalos can also extend the bounding box if desired.

Parameters

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

graph - LayoutGraph: the graph that contains the given nodes and edges
nodes - INodeCursor: the nodes to include in the bounding box
edges - IEdgeCursor: the edges to include in the bounding box
includeNodeLabels - boolean: true if labels of nodes should be included, false otherwise
includeEdgeLabels - boolean: true if labels of edges should be included, false otherwise
includeHalos - boolean: true if NodeHalos should be included, false otherwise

Returns

↪Rectangle2D: the bounding box of the given nodes and edges

getBoundingBoxOfEdges

(graph: LayoutGraph, edges: IEdgeCursor) : Rectangle2D

Returns the bounding box of the edges accessible through the given cursor.

Remarks

In this case, the bounding box is the smallest paraxial rectangle which contains the control points as well as the absolute coordinates of the source and target points of all given edges.

Parameters

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

graph - LayoutGraph: the graph that contains the edges
edges - IEdgeCursor: the edges to include in the bounding box

Returns

↪Rectangle2D: the bounding box containing the given edges

getBoundingBoxOfNodes

(graph: LayoutGraph, nodes: INodeCursor) : Rectangle2D

Returns the bounding box of the nodes accessible through the given cursor.

Remarks

In this case, the bounding box is the smallest paraxial rectangle which contains the given nodes.

Parameters

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

graph - LayoutGraph: the graph that contains the nodes
nodes - INodeCursor: the nodes to include in the bounding box

Returns

↪Rectangle2D: the bounding box containing the given nodes

getLabelFactory

(graph: LayoutGraph) : ILabelLayoutFactory

Returns the ILabelLayoutFactory for the given graph.

Parameters

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

graph - LayoutGraph: the graph

Returns

↪ILabelLayoutFactory: the label factory of the graph

getLabelPlacement

(model: INodeLabelLayoutModel, labelSize: YDimension, nodeLayout: INodeLayout, param: Object) : YPoint

Returns the upper-left corner of the paraxial bounding box of the given node label as encoded by the specified model parameter.

Remarks

The parameter describes the abstract position of the label within the specified model. The parameter must have been generated by that model.

Parameters

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

model - INodeLabelLayoutModel: the INodeLabelLayoutModel used for placing the label
labelSize - YDimension: the size of the label
nodeLayout - INodeLayout: the layout of the node to which the label belongs
param - Object: the model parameter

Returns

↪YPoint: the upper-left corner of the label's bounding box

getLabelPlacement

(model: IEdgeLabelLayoutModel, labelSize: YDimension, edgeLayout: IEdgeLayout, sourceLayout: INodeLayout, targetLayout: INodeLayout, param: Object) : YPoint

Returns the upper-left corner of the paraxial bounding box of the given edge label as encoded by the specified model parameter.

Remarks

The parameter describes the abstract position of the label within the specified model. The parameter must have been generated by that model.

Parameters

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

model - IEdgeLabelLayoutModel: the IEdgeLabelLayoutModel used for placing the label
labelSize - YDimension: the size of the label that should be placed
edgeLayout - IEdgeLayout: the layout of the edge to which the label belongs
sourceLayout - INodeLayout: the layout of the edge's source node
targetLayout - INodeLayout: the layout of the edge's target node
param - Object: the model parameter

Returns

↪YPoint: the upper-left corner of the label's bounding box

getNodeDistance

(graph: LayoutGraph, node1: YNode, node2: YNode) : number

Returns the distance between the centers of the two given nodes.

Parameters

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

graph - LayoutGraph: the graph to which the nodes belong
node1 - YNode: the first node
node2 - YNode: the second node

Returns

↪number: the distance between the nodes' centers

getNodePositions

(graph: LayoutGraph) : string

Returns a string representation of all node positions in the graph.

Parameters

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

graph - LayoutGraph: the graph

Returns

↪string: the string containing all node locations

getPathLength

(graph: LayoutGraph, edge: Edge) : number

Returns the length of the path of the given edge.

Remarks

The path starts at the source point, traverses through all control points and ends at the target point.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the edge

Returns

↪number: the length of the edge's path

isEdgeOutsideNodes

(graph: LayoutGraph, edge: Edge) : boolean

Checks whether or not the path of an edge is outside the bounding box of the source and target node.

Remarks

The edge is outside the nodes if its control points as well as the source and target point are not inside the nodes' bounding boxes.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the edge

Returns

↪boolean: true if the edge is outside the nodes, false otherwise

isEdgeOutsideNodes

(edge: IEdgeLayout, source: INodeLayout, target: INodeLayout, halo: number) : boolean

Checks whether or not the path of an edge is outside the bounding box of the source and target node, considering the given halo.

Remarks

The edge is outside the nodes if its control points as well as the source and target point are not inside the nodes' bounding boxes.

The nodes can be enlarged by a halo to check if the edge keeps some distance to the nodes.

Parameters

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

edge - IEdgeLayout: the edge
source - INodeLayout: the source of the edge
target - INodeLayout: the target of the edge
halo - number: the halo for the nodes

Returns

↪boolean: true if the edge is outside the nodes, false otherwise

isUsingOctilinearEdgeRoutes

(graph: LayoutGraph, considerEdges: IDataProvider) : boolean

Determines whether or not most of the edges of the graph are routed octilinear.

Remarks

The method only considers edges that are marked in the given IDataProvider. If the provider is null, all edges are considered.

Parameters

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

graph - LayoutGraph

the underlying graph

considerEdges - IDataProvider

the edges to consider

Domain	Edge
Values	boolean	`true` if the edge should be considered, `false` otherwise

Returns

↪boolean: true if most of the edges in the graph are routed octilinear, false otherwise

This method also returns true for orthogonal layouts.

isUsingOrthogonalEdgeRoutes

(graph: LayoutGraph, considerEdges: IDataProvider) : boolean

Determines whether or not most of the edges of the graph are routed orthogonally.

Remarks

The method only considers edges that are marked in the given IDataProvider. If the provider is null, all edges are considered.

Parameters

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

graph - LayoutGraph

the underlying graph

considerEdges - IDataProvider

the edges to consider

Domain	Edge
Values	boolean	`true` if the edge should be considered, `false` otherwise

Returns

↪boolean: true if most of the edges in the graph are routed orthogonally, false otherwise

moveEdge

(graph: LayoutGraph, edge: Edge, dx: number, dy: number)

Moves all control points of the given edge by the vector (dx,dy).

Parameters

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

graph - LayoutGraph: the graph
edge - Edge: the edge
dx - number: the horizontal distance to move
dy - number: the vertical distance to move

moveEdges

(graph: LayoutGraph, edges: IEdgeCursor, dx: number, dy: number)

Moves the control points of all edges accessible through the given IEdgeCursor by the vector (dx,dy).

Parameters

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

graph - LayoutGraph: the graph
edges - IEdgeCursor: the edges to be moved
dx - number: the horizontal distance to move
dy - number: the vertical distance to move

moveNode

(graph: LayoutGraph, node: YNode, dx: number, dy: number)

Moves the given node by the vector (dx,dy).

Parameters

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

graph - LayoutGraph: the graph
node - YNode: the node
dx - number: the horizontal distance to move
dy - number: the vertical distance to move

moveNodes

(graph: LayoutGraph, nodes: INodeCursor, dx: number, dy: number)

Moves all nodes accessible through the given INodeCursor by the vector (dx,dy).

Parameters

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

graph - LayoutGraph: the graph
nodes - INodeCursor: the nodes to be moved
dx - number: the horizontal distance to move
dy - number: the vertical distance to move

moveSubgraph

(graph: LayoutGraph, nodes: INodeCursor, dx: number, dy: number)

Moves the subgraph induced by the nodes accessible through the given INodeCursor by the vector (dx,dy).

Parameters

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

graph - LayoutGraph: the graph that contains the subgraph
nodes - INodeCursor: the nodes that induce the subgraph
dx - number: the horizontal distance to move
dy - number: the vertical distance to move

moveSubgraphOfEdges

(graph: LayoutGraph, edges: IEdgeCursor, dx: number, dy: number)

Moves the subgraph induced by the edges accessible through the given IEdgeCursor by the vector (dx,dy).

Parameters

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

graph - LayoutGraph: the graph that contains the subgraph
edges - IEdgeCursor: the edges that induce the subgraph
dx - number: the horizontal distance to move
dy - number: the vertical distance to move

pathIntersectsRect

(graph: LayoutGraph, edge: Edge, rect: Rectangle2D) : boolean

Checks whether or not the path of the given edge intersects the interior of a given rectangular area.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the edge
rect - Rectangle2D: the rectangular area to check for intersection

Returns

↪boolean: true if the edge path intersects with the given rectangle, false otherwise

removeDuplicateBends

(graph: LayoutGraph)

Removes successive bends that have the same coordinates from all edges in the graph.

Parameters

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

graph - LayoutGraph: the graph

removeDuplicateBends

(graph: LayoutGraph, edge: Edge)

Removes successive bends that have the same coordinates from the given edge.

Parameters

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

graph - LayoutGraph: the graph
edge - Edge: the edge

resetPath

(graph: LayoutGraph, edge: Edge, resetPorts?: boolean)

Assigns a trivial path which has no control points to the specified edge.

Parameters

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

graph - LayoutGraph: the graph
edge - Edge: the edge
resetPorts - boolean: true if the ports of the edge should be set to the center of the corresponding nodes, false otherwise

resetPaths

(graph: LayoutGraph, resetPorts?: boolean)

Assigns a trivial path which has no control points to all edges in the specified graph.

Parameters

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

graph - LayoutGraph: the graph
resetPorts - boolean: true if the ports of the edges should be set to the center of the corresponding nodes, false otherwise

resetPorts

(graph: LayoutGraph)

Sets the ports of all edges in the graph to the center of the nodes.

Parameters

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

graph - LayoutGraph: the graph

reverseEdgeLayout

(el: IEdgeLayout)

Reverses the layout of an edge.

Remarks

The order of the control points is reversed and source and target point are swapped.

Parameters

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

el - IEdgeLayout: the layout information of an edge

This method will not reverse the edge in the graph structure.

roundEdgeLayout

(graph: LayoutGraph, edge: Edge)

Rounds the locations of the control points and ports of the given edge to integer values.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the edge whose values are rounded

roundLayout

(graph: LayoutGraph)

Rounds coordinates and sizes in the layout of an entire graph to integer values.

Parameters

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

graph - LayoutGraph: the graph

roundNodeLayout

(graph: LayoutGraph, node: YNode)

Rounds the location and size of the given node to integer values.

Parameters

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

graph - LayoutGraph: the graph to which the node belongs
node - YNode: the node whose values are rounded

routeEdgesParallel

(graph: LayoutGraph, leadingEdge: Edge, edge: Edge, lineDistance: number, joinEnds?: boolean, absJoinDistance?: number, relJoinDistance?: number)

Routes two edges which are incident to the same nodes in parallel, optionally joining the end points.

Remarks

The second edge gets a path that is parallel to the path of the first (leading) edge.

ParametersOptions Overload

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

graph - LayoutGraph: the graph
leadingEdge - Edge: the leading edge
edge - Edge: the edge to be adjusted
lineDistance - number: the distance between the two edges
joinEnds - boolean: true if the edges should share their end points (the ones of the leading edge), false otherwise
absJoinDistance - number: the absolute distance between the end points and the beginning of the parallel segment routing if the ends are joined
relJoinDistance - number: the relative distance, measured relative to the length of the first/last segments if the ends are joined

routeEdgesParallel

(graph: LayoutGraph, leadingEdge: Edge, edges: EdgeList, lineDistance: number, adjustLeadingEdge?: boolean, joinEnds?: boolean, absJoinDistance?: number, relJoinDistance?: number)

Routes a list of edges which are incident to the same nodes in parallel, optionally joining the end points.

Remarks

All edges get a path that is parallel to the path of the first (leading) edge.

The position of the leading edge may be adjusted if there is an odd number of parallel edges. It will be moved from the center to achieve a more symmetric port assignment.

ParametersOptions Overload

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

graph - LayoutGraph: the graph
leadingEdge - Edge: the leading edge
edges - EdgeList: the list of edges that will be aligned with the leading edge
lineDistance - number: the distance between two edges
adjustLeadingEdge - boolean: true if the leading edge should be adjusted if the size of list is odd, false otherwise
joinEnds - boolean: true if the edges should share their end points (the ones of the leading edge), false otherwise
absJoinDistance - number: the absolute distance between the end points and the beginning of the parallel segment routing if the ends are joined
relJoinDistance - number: the relative distance, measured relative to the length of the first/last segments if the ends are joined

routeSelfLoop

(graph: LayoutGraph, edge: Edge)

Routes a self-loop.

Remarks

For a self-loop edge, source and target are identical. The path of the self-loop will start at the top of the node, go around the upper-left corner and end at the left side of the node.

Parameters

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

graph - LayoutGraph: the graph to which the edge belongs
edge - Edge: the self-loop

LayoutGraphUtilities

Type Details

See Also

Static Methods

alignNodeLayouts

Remarks

Parameters

arrangeRectangleGrid

Remarks

Parameters

Returns

Throws

arrangeRectangleMultiRows

Remarks

Parameters

Returns

See Also

arrangeRectangleRows

Remarks

Parameters

Returns

Throws

assignReverseLayout

Parameters

autoFlipBox

Remarks

Parameters

Returns

clipEdgeOnBounds

Remarks

Parameters

clipEdgePathOnBounds

Remarks

Parameters

Returns

clipEdgePathOnBounds

Remarks

Parameters

Returns

clipEdgesOnBounds

Remarks

Parameters

See Also

clipPathOnBounds

Parameters

Returns

determineEdgeFlowDirection

Remarks

Parameters

Returns

edgeLayoutString

Parameters

Returns

getBoundingBox

Remarks

Parameters

Returns

See Also

getBoundingBox

Remarks

Parameters

Returns

See Also

getBoundingBox

Remarks

Parameters

Returns

See Also

getBoundingBox

Remarks

Parameters

Returns

See Also

getBoundingBox

Remarks

Parameters

Returns

getBoundingBoxOfEdges

Remarks

Parameters