K4 InDesign Javascript API Documentation

Interactive ElementsNavigationPoints

A collection of navigation points.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
  → NavigationPoint
anyItem(
)
  → NavigationPoint
count(
)
  → number
everyItem(
)
  → NavigationPoint
firstItem(
)
  → NavigationPoint
item(
index)
  → NavigationPoint
itemByID(
id)
  → NavigationPoint
itemByName(
name)
  → NavigationPoint
itemByRange(
from, to)
  → NavigationPoint
lastItem(
)
  → NavigationPoint
middleItem(
)
  → NavigationPoint
nextItem(
obj)
  → NavigationPoint
previousItem(
obj)
  → NavigationPoint
toSource(
)
  → string
add(
[withProperties])
  → NavigationPoint
Creates a new NavigationPoint.
withProperties Object Initial values for properties of the new NavigationPoint (Optional)
anyItem(
)
  → NavigationPoint
Returns any NavigationPoint in the collection.
count(
)
  → number
Displays the number of elements in the NavigationPoint.
everyItem(
)
  → NavigationPoint
Returns every NavigationPoint in the collection.
firstItem(
)
  → NavigationPoint
Returns the first NavigationPoint in the collection.
item(
index)
  → NavigationPoint
Returns the NavigationPoint with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → NavigationPoint
Returns the NavigationPoint with the specified ID.
id number The ID.
itemByName(
name)
  → NavigationPoint
Returns the NavigationPoint with the specified name.
name string The name.
itemByRange(
from, to)
  → NavigationPoint
Returns the NavigationPoints within the specified range.
from The NavigationPoint, index, or name at the beginning of the range. Can accept: NavigationPoint, Long Integer or String.
to The NavigationPoint, index, or name at the end of the range. Can accept: NavigationPoint, Long Integer or String.
lastItem(
)
  → NavigationPoint
Returns the last NavigationPoint in the collection.
middleItem(
)
  → NavigationPoint
Returns the middle NavigationPoint in the collection.
nextItem(
obj)
  → NavigationPoint
Returns the NavigationPoint whose index follows the specified NavigationPoint in the collection.
obj NavigationPoint The NavigationPoint whose index comes before the desired NavigationPoint.
previousItem(
obj)
  → NavigationPoint
Returns the NavigationPoint with the index previous to the specified index.
obj NavigationPoint The index of the NavigationPoint that follows the desired NavigationPoint.
toSource(
)
  → string
Generates a string which, if executed, will return the NavigationPoint.