NavigationPoints
A collection of navigation points.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
NavigationPoint [] (index:Number)
Returns the NavigationPoint with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
NavigationPoint add (withProperties:Object)
Creates a new NavigationPoint.
|
Parameter |
Type |
Description |
|---|---|---|
|
withProperties |
Initial 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.
NavigationPoint everyItem ()
Returns every NavigationPoint in the collection.
NavigationPoint firstItem ()
Returns the first NavigationPoint in the collection.
NavigationPoint item (index:Varies LongInteger String)
Returns the NavigationPoint with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
NavigationPoint itemByID (id:Number)
Returns the NavigationPoint with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
NavigationPoint itemByName (name:String)
Returns the NavigationPoint with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
NavigationPoint itemByRange (from:Varies LongInteger NavigationPoint String, to:Varies LongInteger NavigationPoint String)
Returns the NavigationPoints within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The NavigationPoint, index, or name at the beginning of the range. Can accept: NavigationPoint, Long Integer or String. |
|
to |
LongInteger |
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The NavigationPoint whose index comes before the desired NavigationPoint. |
NavigationPoint previousItem (obj:NavigationPoint)
Returns the NavigationPoint with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the NavigationPoint that follows the desired NavigationPoint. |
String toSource ()
Generates a string which, if executed, will return the NavigationPoint.
Object of
Movie.navigationPoints