C

LayoutBend

Show Usages
Represents a bend on an LayoutEdge, which is a shared point between two consecutive straight-line segments of the edge's path.
ImplementsInheritance Hierarchy

Remarks

A bend defines a control point in the polyline representation of an edge. Along with the source port and target port, the bends form the entire path of an edge in a graph layout.

This class cannot be instantiated

See Also

API

bends, pathPoints, addBend

Members

No filters for this type

Properties

graph

: LayoutGraph
readonly
Gets the LayoutGraph this bend belongs to.
This property indirectly references the graph via the owning LayoutEdge.
readonlyfinal

Property Value

The graph that contains this bend, or null if the bend has been removed from its edge or if the edge itself has been removed from the graph.

index

: number
readonly
Gets the index of this bend in the list of bends on its owning LayoutEdge.
The bend index is recalculated by iterating through the list of bends on the edge each time this property is accessed. As a result, this property should not be used in performance-critical code.
Accessing this property repeatedly can cause performance issues, as it involves iteration through the bend list.
readonlyfinal

Property Value

The index of this bend in the list of bends on the edge. The index corresponds to the bend's position in the sequence of bends, where the sequence follows the order from the source port to the target port of the edge.

location

: Point
Gets or sets the Point representing the location of the bend.
The bend's location can be set using a Point object, which modifies both the x- and y-coordinates at once.
conversionfinal

Property Value

A Point representing the bend's current location, consisting of both its x- and y-coordinates.

owner

: LayoutEdge
readonly
Gets the LayoutEdge that owns this bend.
If the bend is removed from its edge, this property will return null.
readonlyfinal

Property Value

The edge to which this bend belongs, or null if this bend has been removed from its edge.

tag

: any
Gets or sets the tag object associated with this item instance.
The tag is an optional user-defined object which can be used to store arbitrary data related to this item. The item itself just provides the storage for the object.
final

Implements

ITagOwner.tag

x

: number
Gets or sets the x-coordinate of this bend's location.
The x-coordinate defines the horizontal position of the bend.
final

Property Value

The x-coordinate of the bend's position in the coordinate system of the graph layout.

y

: number
Gets or sets the y-coordinate of this bend's location.
The y-coordinate defines the vertical position of the bend.
final

Property Value

The y-coordinate of the bend's position in the coordinate system of the graph layout.