Class

Path

 A path.

QuickLinks

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

Hierarchy

Button | ClippingPathSettings | GraphicLine | MediaItem | Movie | MultiStateObject | Oval | Polygon | Rectangle | Sound | SplineItem | TextFrame | TextWrapPreference
Path
Event | EventListener | MutationEvent | PathPoint

Properties

PropertyTypeAccessDescription
entirePath Array of
Arrays of 2 Units
r/wA 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.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the Path within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentButton
ClippingPathSettings
GraphicLine
MediaItem
Movie
MultiStateObject
Oval
Polygon
Rectangle
Sound
SplineItem
TextFrame
TextWrapPreference
readonlyThe parent of the Path (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, MediaItem, Sound, Movie, Button, MultiStateObject, ClippingPathSettings or TextWrapPreference).
pathPointsPathPoints readonlyA collection of path points.
pathTypePathType:
PathType.OPEN_PATH
PathType.CLOSED_PATH
r/wThe path type.
propertiesObject r/wA 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.

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

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)

void reverse ()
Reverses the path.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

PathPoint.parent

Used in:

Path Paths.nextItem (obj: Path)

Path Paths.previousItem (obj: Path)

Return

Array of Path Path.getElements ()

Path Paths.[] (index: number)

Path Paths.add ([withProperties: Object])

Path Paths.anyItem ()

Array of Path Paths.everyItem ()

Path Paths.firstItem ()

Path Paths.item (index: varies)

Array of Path Paths.itemByRange (from: varies, to: varies)

Path Paths.lastItem ()

Path Paths.middleItem ()

Path Paths.nextItem (obj: Path)

Path Paths.previousItem (obj: Path)

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