Adobe InDesign CS5 (7.0) Object Model JS: PathPoint

InDesign CS5

previous page next page

Class

PathPoint

A path point of a path.

QuickLinks

addEventListener, getElements, join, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Path

PathPoint

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
anchor	Array of Measurement Unit (Number or String)	r/w	The location of the path point on the page, in the format [x, y].
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
index	number	readonly	The index of the PathPoint within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
leftDirection	Array of Measurement Unit (Number or String)	r/w	The left-direction point, which controls the curve of the line segment preceding the path point on the path, in the format [x, y].
parent	Path	readonly	The parent of the PathPoint (a Path).
pointType	PointType: PointType.SMOOTH PointType.CORNER PointType.PLAIN PointType.SYMMETRICAL	r/w	The path point type.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rightDirection	Array of Measurement Unit (Number or String)	r/w	The right-direction point, which controls the curve of the line segment following the path point on the path, in the format [x, y].

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 PathPoint getElements ()
Resolves the object specifier, creating an array of object references.

void join (reference: PathPoint[, given: JoinOptions])
Join this path point to another path point. The two points must be end points and their paths combined into a single path on a single page item.

Parameter	Type	Description
reference	PathPoint	The reference object. The path point to join to
given	JoinOptions: JoinOptions.CONNECT JoinOptions.COMBINE	The join option to use. (Optional)

void remove ()
Deletes the PathPoint.

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)