Class

PathPoint

 A path point of a path.

QuickLinks

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

Hierarchy

Path
PathPoint
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
anchor Array of Measurement Unit (Number or String) r/wThe location of the path point on the page, in the format [x, y].
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the PathPoint within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
leftDirection Array of Measurement Unit (Number or String) r/wThe left-direction point, which controls the curve of the line segment preceding the path point on the path, in the format [x, y].
parentPath readonlyThe parent of the PathPoint (a Path).
pointTypePointType:
PointType.SMOOTH
PointType.CORNER
PointType.PLAIN
PointType.SYMMETRICAL
r/wThe path point type.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightDirection Array of Measurement Unit (Number or String) r/wThe 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
referencePathPointThe reference object. The path point to join to
givenJoinOptions:
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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

void PathPoint.join (reference: PathPoint[, given: JoinOptions])

PathPoint PathPoints.nextItem (obj: PathPoint)

PathPoint PathPoints.previousItem (obj: PathPoint)

Return

Array of PathPoint PathPoint.getElements ()

PathPoint PathPoints.[] (index: number)

PathPoint PathPoints.add ([withProperties: Object])

PathPoint PathPoints.anyItem ()

Array of PathPoint PathPoints.everyItem ()

PathPoint PathPoints.firstItem ()

PathPoint PathPoints.item (index: varies)

Array of PathPoint PathPoints.itemByRange (from: varies, to: varies)

PathPoint PathPoints.lastItem ()

PathPoint PathPoints.middleItem ()

PathPoint PathPoints.nextItem (obj: PathPoint)

PathPoint PathPoints.previousItem (obj: PathPoint)

Jongware, 17-May-2011 v3.0.3fContents :: Index