PathPoint
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchor | Array of Measurement Unit (Number or String) | r/w | The location of the path point on the page, in the format [x, y]. |
| index | number | readonly | The index of the PathPoint within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| leftDirection | Array of Measurement Unit (Number or String) | r/w | 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.LINE_TYPE PointType.SMOOTH PointType.CORNER PointType.SYMMETRICAL |
r/w | The path point type. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rightDirection | Array of Measurement Unit (Number or String) | r/w | The right-direction point, which controls the curve of the line segment following the path point on the path, in the format [x, y]. |
Methods
Instances
Array of PathPoint getElements ()
Resolves the object specifier, creating an array of object references.
void 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.CONNECT JoinOptions.COMBINE | The join option to use. (Optional) |
void remove ()
Deletes the PathPoint.
string toSource ()
Generates a string which, if executed, will return the PathPoint.
string toSpecifier ()
Retrieves the object specifier.
Used in:
void PathPoint.join (reference: PathPoint[, given: JoinOptions])
array of PathPoint PathPoints.itemByRange (from: any, to: any)
PathPoint PathPoints.nextItem (obj: PathPoint)
PathPoint PathPoints.previousItem (obj: PathPoint)
Return
Array of PathPoint PathPoint.getElements ()
PathPoint PathPoints.[] (index: number)
PathPoint PathPoints.add ([withProperties: Object])
PathPoint PathPoints.anyItem ()
Array of PathPoint PathPoints.everyItem ()
PathPoint PathPoints.firstItem ()
PathPoint PathPoints.item (index: any)
PathPoint PathPoints.itemByName (name: string)
Array of PathPoint PathPoints.itemByRange (from: any, to: any)
PathPoint PathPoints.lastItem ()
PathPoint PathPoints.middleItem ()
PathPoint PathPoints.nextItem (obj: PathPoint)
PathPoint PathPoints.previousItem (obj: PathPoint)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |