Class

NavigationPoints

 A collection of navigation points.

See also NavigationPoint.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

NavigationPoint [] (index: number)
Returns the NavigationPoint with the specified index.

ParameterTypeDescription
indexnumberThe index.

NavigationPoint add ([withProperties: Object])
Creates a new NavigationPoint.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new NavigationPoint (Optional)

NavigationPoint anyItem ()
Returns any NavigationPoint in the collection.

number count ()
Displays the number of elements in the NavigationPoint.

Array of NavigationPoint everyItem ()
Returns every NavigationPoint in the collection.

NavigationPoint firstItem ()
Returns the first NavigationPoint in the collection.

NavigationPoint item (index: varies)
Returns the NavigationPoint with the specified index or name.

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

NavigationPoint itemByID (id: number)
Returns the NavigationPoint with the specified ID.

ParameterTypeDescription
idnumberThe ID.

NavigationPoint itemByName (name: string)
Returns the NavigationPoint with the specified name.

ParameterTypeDescription
namestringThe name.

Array of NavigationPoint itemByRange (from: varies, to: varies)
Returns the NavigationPoints within the specified range.

ParameterTypeDescription
fromLong Integer
NavigationPoint
String
The NavigationPoint, index, or name at the beginning of the range. Can accept: NavigationPoint, Long Integer or String.
toLong Integer
NavigationPoint
String
The NavigationPoint, index, or name at the end of the range. Can accept: NavigationPoint, Long Integer or String.

NavigationPoint lastItem ()
Returns the last NavigationPoint in the collection.

NavigationPoint middleItem ()
Returns the middle NavigationPoint in the collection.

NavigationPoint nextItem (obj: NavigationPoint)
Returns the NavigationPoint whose index follows the specified NavigationPoint in the collection.

ParameterTypeDescription
objNavigationPointThe NavigationPoint whose index comes before the desired NavigationPoint.

NavigationPoint previousItem (obj: NavigationPoint)
Returns the NavigationPoint with the index previous to the specified index.

ParameterTypeDescription
objNavigationPointThe index of the NavigationPoint that follows the desired NavigationPoint.

string toSource ()
Generates a string which, if executed, will return the NavigationPoint.

Element of

Movie.navigationPoints

Jongware, 28-Apr-2012 v3.0.3iContents :: Index