InDesign Server2025
API 20.5.0.49

Properties

NameType AccessDescription
Arrays of 2 Units[] read/write A list of the coordinates of all of the path points on the path, including anchor points and left- and right-direction points. When creating a path using this property, supply either a list of anchor point coordinates ([[x1, y1], [x2, y2], ...]) or a list of anchor point, left-direction point, and right-direction point coordinates ([[[x1, y1], [x2, y2], [x3, y3]], [[x4, y4], [x5, y5], [x6, y6]], ...]). Note: Providing only anchor points results in a path on which all of the path points are connected with straight line segments; supplying the positions of left- and right-direction points specifies curved line segments. Can return: Array of Arrays of 2 Units.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The index of the Path within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Button | ClippingPathSettings | EndnoteTextFrame | GraphicLine | MediaItem | Movie | MultiStateObject | Oval | Polygon | Rectangle | Sound | TextFrame | SplineItem | TextWrapPreference readonly The parent of the Path (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, EndnoteTextFrame, MediaItem, Sound, Movie, Button, MultiStateObject, ClippingPathSettings or TextWrapPreference).
PathPoints<PathPoint> readonly A collection of path points.
PathType
read/write The path type.
Object read/write A property that allows setting of several properties at the same time.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
Path[]

Resolves the object specifier, creating an array of object references.

void

Deletes the Path.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
void

Reverses the path.

String

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a Path.

Parameter of 3

Method parameters that accept a Path.

Return 12

Methods that return a Path.