C

EdgePathPoint

Show Usages
Represents a point on the path of an LayoutEdge, which can either correspond to a bend on the edge or to one of the two ports (source or target) of the edge.
Inheritance Hierarchy

Remarks

An edge path consists of multiple points, represented by EdgePathPoint instances. These points define the edge's geometry, either as bends along the path or as port positions. The collection of all path points can be accessed via the pathPoints property.

This class cannot be instantiated

See Also

Developer's Guide

API

bends, pathPoints, addBend

Members

No filters for this type

Properties

index

: number
readonly
Gets the index of this path point within the edge's path.
The index reflects the order of path points from the source to the target port. Path points that represent bends are indexed sequentially, with the source port at index 0 and the target port at the last index.
The index calculation involves iterating over the list of bends. For performance-critical scenarios, avoid repeated calls to this property.
readonlyfinal

Property Value

The zero-based index of this path point within the edge's path.

isFirst

: boolean
readonly
Gets a value indicating whether this path point represents the edge's source port.
A path point is considered the source port when it does not correspond to a bend and is not the target port.
readonlyfinal

Property Value

true if this path point represents the source port; otherwise, false.

isLast

: boolean
readonly
Gets a value indicating whether this path point represents the edge's target port.
A path point is considered the target port when it does not correspond to a bend and is not the source port.
readonlyfinal

Property Value

true if this path point represents the target port; otherwise, false.

location

: Point
readonly
Gets the position of the path point.
readonlyfinal

Property Value

The position of the path point.

owner

: LayoutEdge
readonly
Gets the LayoutEdge to which this path point belongs.
readonlyfinal

Property Value

The edge to which this path point belongs.

x

: number
Gets or sets the x-coordinate of the path point.
If the path point represents a bend, the x-coordinate corresponds to the bend's position. If the path point represents a port, the x-coordinate corresponds to the port's position, adjusted by the port's offset relative to its node's center.
final

Property Value

The x-coordinate of the path point.

y

: number
Gets or sets the y-coordinate of the path point.
If the path point represents a bend, the y-coordinate corresponds to the bend's position. If the path point represents a port, the y-coordinate corresponds to the port's position, adjusted by the port's offset relative to its node's center.
final

Property Value

The y-coordinate of the path point.

Methods

equals

(obj: any): boolean
Determines whether the specified object is equal to the current EdgePathPoint.
final

Parameters

obj: any
The object to compare with the current instance.

Return Value

boolean
true if the specified object is equal to the current instance, otherwise, false.

hashCode

(): number
Returns a hash code for this object.

The hash code is a numeric value that can be used to treat this object as a key in a hash table or similar data structure.

Two objects that are considered equal must have the same hash code. However, the reverse does not hold and two objects having the same hash code don't have to be equal. Ideally, the hash code should be roughly uniformly-distributed to prevent hash tables from performing poorly. Calculating the hash code is also a potentially frequent operation and should therefore be fast.

final

Return Value

number
the hash code for this object

toString

(): string
Returns a string representation for this object.
final

Return Value

string
a string describing this object