A collection of path points.
Methods
PathPointadd ([withProperties:
Object])
Creates a new PathPoint.
| Parameter | Type | Description |
|---|---|---|
| withProperties | Object | Initial values for properties of the new PathPoint (Optional) |
PathPointanyItem ()
Returns any PathPoint in the collection.
number count ()
Displays the number of elements in the PathPoint.
Array of PathPointeveryItem ()
Returns every PathPoint in the collection.
PathPointfirstItem ()
Returns the first PathPoint in the collection.
PathPointitem (index:
any)
Returns the PathPoint with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
PathPointitemByName (name:
string)
Returns the PathPoint with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of PathPointitemByRange (from:
any, to:
any)
Returns the PathPoints within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | PathPoint Long Integer String |
The PathPoint, index, or name at the beginning of the range. Can accept: PathPoint, Long Integer or String. |
| to | PathPoint Long Integer String |
The PathPoint, index, or name at the end of the range. Can accept: PathPoint, Long Integer or String. |
PathPointlastItem ()
Returns the last PathPoint in the collection.
PathPointmiddleItem ()
Returns the middle PathPoint in the collection.
PathPointnextItem (obj:
PathPoint)
Returns the PathPoint whose index follows the specified PathPoint in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | PathPoint | The PathPoint whose index comes before the desired PathPoint. |
PathPointpreviousItem (obj:
PathPoint)
Returns the PathPoint with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | PathPoint | The index of the PathPoint that follows the desired PathPoint. |
string toSource ()
Generates a string which, if executed, will return the PathPoint.
Element of:
Path.pathPoints