A path.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| entirePath | Array of any | 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. |
| index | number | readonly | The index of the Path within its containing object. |
| parent | any | readonly | The parent of the Path (a PageItem, Oval, Rectangle, GraphicLine, TextFrame, Polygon, ClippingPathSettings or TextWrapPreference). |
| pathPoints | PathPoints | readonly | A collection of path points. |
| pathType | PathType : OPEN_PATH CLOSED_PATH |
r/w | The path type. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
Array of PathgetElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the Path.
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:
Paths.previousItem (
obj:
Path )
Paths.nextItem (
obj:
Path )
Returned by:
Array of Path Path .getElements (
)
Path Paths.add (
[withProperties:
Object]
)
Path Paths.anyItem (
)
Array of Path Paths.everyItem (
)
Path Paths.firstItem (
)
Path Paths.item (
index:
any
)
Path Paths.itemByName (
name:
string
)
Array of Path Paths.itemByRange (
from:
any, to:
any
)
Path Paths.lastItem (
)
Path Paths.middleItem (
)
Path Paths.nextItem (
obj:
Path
)
Path Paths.previousItem (
obj:
Path
)