K4 InDesign Javascript API Documentation

Interactive ElementsViewZoomBehaviors

A collection of view zoom behavior objects.

Instance Properties

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

Methods

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