PathPoints
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
PathPoint [] (index:
number)
Returns the PathPoint with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
PathPoint add ([withProperties:
Object])
Creates a new PathPoint.
| Parameter | Type | Description |
|---|---|---|
| withProperties | Object | Initial values for properties of the new PathPoint (Optional) |
PathPoint anyItem ()
Returns any PathPoint in the collection.
number count ()
Displays the number of elements in the PathPoint.
Array of PathPoint everyItem ()
Returns every PathPoint in the collection.
PathPoint firstItem ()
Returns the first PathPoint in the collection.
PathPoint item (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. |
PathPoint itemByName (name:
string)
Returns the PathPoint with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of PathPoint itemByRange (from:
any, to:
any)
Returns the PathPoints within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer PathPoint String | The PathPoint, index, or name at the beginning of the range. Can accept: PathPoint, Long Integer or String. |
| to | Long Integer PathPoint String | The PathPoint, index, or name at the end of the range. Can accept: PathPoint, Long Integer or String. |
PathPoint lastItem ()
Returns the last PathPoint in the collection.
PathPoint middleItem ()
Returns the middle PathPoint in the collection.
PathPoint nextItem (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. |
PathPoint previousItem (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
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |