YPointPath

Show usages

This class represents an ordered list of points in the plane.

Inheritance Hierarchy

YPointPath

Type Details

yfiles module: algorithms
yfiles-umd modules: All layout modules, view-layout-bridge
Legacy UMD name: yfiles.algorithms.YPointPath

Constructors

YPointPath

()

Creates a new empty path.

YPointPath

(l: IList<Object>)

Creates a new path from a list of points.

Parameters

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

l - IList<Object>: a list of YPoint instances.

YPointPath

(path: YPoint[])

Creates a new path from an array of points.

Properties

first

: YPoint

Gets the first point in the path.

last

: YPoint

Gets the last point in the path.

lineSegmentCount

: number

Gets the number of line segments in the path.

Methods

calculateLength

() : number

Calculate the (geometric) length of the path.

Remarks

The length of the path is the sum of lengths of all line segments making up the path.

Returns

↪number: the (geometric) length of the path

createReverse

() : YPointPath

Create a point path with reverse ordering of the points.

cursor

() : ICursor

Get the points in the path.

getLineSegment

(i: number) : LineSegment

Returns a line segment in the path.

length

() : number

Get the number of points in the path.

lineSegments

() : ILineSegmentCursor

Get the points in the path.

points

() : IPointCursor

Get the points in the path.

toArray

() : YPoint

Get the points in the list as array.

toList

() : IList<any>

Get the points in the path as list.

Returns

↪IList<any>: a list of YPoint instances.

toString

() : string

Returns a string representation for this object.

Returns

↪string: a string describing this object

Constants

EMPTY_PATH

: YPointPath

Defines a path with no points.