Class

Path

A path.

QuickLinks

addEventListener, getElements, remove, removeEventListener, reverse, toSource, toSpecifier

Hierarchy

Path

Event | EventListener | MutationEvent | PathPoint

Properties

Property	Type	Access	Description
entirePath	Array of Arrays of 2 Units	r/w	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	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
index	number	readonly	The index of the Path within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
parent	Button ClippingPathSettings GraphicLine MediaItem Movie MultiStateObject Oval Polygon Rectangle Sound SplineItem TextFrame TextWrapPreference	readonly	The parent of the Path (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, MediaItem, Sound, Movie, Button, MultiStateObject, ClippingPathSettings or TextWrapPreference).
pathPoints	PathPoints PathPoint	readonly	A collection of path points.
pathType	PathType: PathType.OPEN_PATH PathType.CLOSED_PATH	r/w	The path type.
properties	Object	r/w	A property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of Path getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the Path.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)