Path
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| entirePath | Array of Arrays of 2 Units |
r/w | 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 | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the Path within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Button ClippingPathSettings GraphicLine MediaItem Movie MultiStateObject Oval Polygon Rectangle Sound SplineItem TextFrame TextWrapPreference |
readonly | The parent of the Path (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, MediaItem, Sound, Movie, Button, MultiStateObject, ClippingPathSettings or TextWrapPreference). |
| pathPoints | PathPoints | readonly | A collection of path points. |
| pathType | PathType: PathType.OPEN_PATH PathType.CLOSED_PATH |
r/w | The path type. |
| properties | Object | r/w | A 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.
| 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 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.
| 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) |
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, 20-Jun-2010 v3.0.3d | Contents :: Index |