PathPoints

A collection of path points.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

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.

PathPoint everyItem ()

Returns every PathPoint in the collection.

PathPoint firstItem ()

Returns the first PathPoint in the collection.

PathPoint item (index:Varies LongInteger String)

Returns the PathPoint with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

PathPoint itemByRange (from:Varies LongInteger PathPoint String, to:Varies LongInteger PathPoint String)

Returns the PathPoints within the specified range.

Parameter

Type

Description

from

LongInteger

PathPoint

String

The PathPoint, index, or name at the beginning of the range. Can accept: PathPoint, Long Integer or String.

to

LongInteger

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.

Object of

Path.pathPoints