A path.
Go to Property Listing | Method Listing
remove, reverse, toSource, getElements, toSpecifier, addEventListener, removeEventListener
Boolean, Button, ClippingPathSettings, EventListeners, Events, GraphicLine, MediaItem, Movie, MultiStateObject, Number, Object, Oval, PathPoints, PathType, Polygon, Rectangle, Sound, SplineItem, TextFrame, TextWrapPreference,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
entirePath |
Array of Arrays of 2 Units. |
read/write |
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 |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
index |
readonly |
The index of the Path within its containing object. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
parent |
readonly |
The parent of the Path (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, MediaItem, Sound, Movie, Button, MultiStateObject, ClippingPathSettings or TextWrapPreference). |
|
|
pathPoints |
readonly |
A collection of path points. |
|
|
pathType |
PathType.OPEN_PATH PathType.CLOSED_PATH |
read/write |
The path type. |
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
Path getElements ()
Resolves the object specifier, creating an array of object references.
undefined remove ()
Deletes the Path.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined reverse ()
Reverses the path.
String toSource ()
Generates a string which, if executed, will return the Path.
String toSpecifier ()
Retrieves the object specifier.