InDesign2026
API 21.5.1.73
Collection of PathPoint

PathPoints

A collection of path points.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

→ PathPoint

Returns the PathPoint with the specified index.

index Number The index.
→ PathPoint

Creates a new PathPoint.

withProperties? Object Initial values for properties of the new PathPoint
→ PathPoint

Returns any PathPoint in the collection.

→ Number

Displays the number of elements in the PathPoint.

→ PathPoint[]

Returns every PathPoint in the collection.

→ PathPoint

Returns the first PathPoint in the collection.

→ PathPoint

Returns the PathPoint with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
→ PathPoint[]

Returns the PathPoints within the specified range.

from LongInteger | PathPoint | String The PathPoint, index, or name at the beginning of the range. Can accept: PathPoint, Long Integer or String.
to LongInteger | PathPoint | String The PathPoint, index, or name at the end of the range. Can accept: PathPoint, Long Integer or String.
→ PathPoint

Returns the last PathPoint in the collection.

→ PathPoint

Returns the middle PathPoint in the collection.

→ PathPoint

Returns the PathPoint whose index follows the specified PathPoint in the collection.

obj PathPoint The PathPoint whose index comes before the desired PathPoint.
→ PathPoint

Returns the PathPoint with the index previous to the specified index.

obj PathPoint The index of the PathPoint that follows the desired PathPoint.
→ String

Generates a string which, if executed, will return the PathPoint.

Object of 1

Properties elsewhere that hold a PathPoints.