K4 InDesign Javascript API Documentation

Interactive ElementsAnimationBehaviors

A collection of animation behaviors.

Instance Properties

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

Methods

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