PathPoint

A path point of a path.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, PointType, String

Property Listing

Property

Type

Access

Description

anchor

Array of Number

Array of String

read/write

The location of the path point on the page, in the format [x, y].

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

index

Number

readonly

The index of the PathPoint within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

leftDirection

Array of Number

Array of String

read/write

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.CORNER

PointType.PLAIN

PointType.SMOOTH

PointType.SYMMETRICAL

read/write

The path point type.

properties

Object

read/write

A property that allows setting of several properties at the same time.

rightDirection

Array of Number

Array of String

read/write

The right-direction point, which controls the curve of the line segment following the path point on the path, in the format [x, y].

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

PathPoint getElements ()

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

undefined 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.COMBINE

JoinOptions.CONNECT

The join option to use. (Optional)

undefined remove ()

Deletes the PathPoint.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

PathPoints.add()

PathPoint.getElements()

PathPoints.anyItem()

PathPoints.everyItem()

PathPoints.nextItem()

PathPoints.previousItem()

PathPoints.item()

PathPoints.[]()

PathPoints.itemByRange()

PathPoints.firstItem()

PathPoints.lastItem()

PathPoints.middleItem()