K4 InDesign Javascript API Documentation

Interactive ElementsMovies

A collection of movies.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → Movie
anyItem(
)
  → Movie
count(
)
  → number
everyItem(
)
  → Movie
firstItem(
)
  → Movie
item(
index)
  → Movie
itemByID(
id)
  → Movie
itemByName(
name)
  → Movie
itemByRange(
from, to)
  → Movie
lastItem(
)
  → Movie
middleItem(
)
  → Movie
nextItem(
obj)
  → Movie
previousItem(
obj)
  → Movie
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → Movie
Creates a new Movie
layer Layer The layer on which to create the Movie. (Optional)
at LocationOptions The location at which to insert the Movie relative to the reference object or within the container object. (Optional)
reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties Object Initial values for properties of the new Movie (Optional)
anyItem(
)
  → Movie
Returns any Movie in the collection.
count(
)
  → number
Displays the number of elements in the Movie.
everyItem(
)
  → Movie
Returns every Movie in the collection.
firstItem(
)
  → Movie
Returns the first Movie in the collection.
item(
index)
  → Movie
Returns the Movie with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Movie
Returns the Movie with the specified ID.
id number The ID.
itemByName(
name)
  → Movie
Returns the Movie with the specified name.
name string The name.
itemByRange(
from, to)
  → Movie
Returns the Movies within the specified range.
from The Movie, index, or name at the beginning of the range. Can accept: Movie, Long Integer or String.
to The Movie, index, or name at the end of the range. Can accept: Movie, Long Integer or String.
lastItem(
)
  → Movie
Returns the last Movie in the collection.
middleItem(
)
  → Movie
Returns the middle Movie in the collection.
nextItem(
obj)
  → Movie
Returns the Movie whose index follows the specified Movie in the collection.
obj Movie The Movie whose index comes before the desired Movie.
previousItem(
obj)
  → Movie
Returns the Movie with the index previous to the specified index.
obj Movie The index of the Movie that follows the desired Movie.
toSource(
)
  → string
Generates a string which, if executed, will return the Movie.