K4 InDesign Javascript API Documentation

LayoutMediaItems

The media items collection.

Instance Properties

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

Methods

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