K4 InDesign Javascript API Documentation

DatamergeDataMergeImagePlaceholders

A collection of data merge image placeholders.

Instance Properties

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

Methods

add(
placeholder, field ​[, withProperties])
  → DataMergeImagePlaceholder
anyItem(
)
  → DataMergeImagePlaceholder
count(
)
  → number
everyItem(
)
  → DataMergeImagePlaceholder
firstItem(
)
  → DataMergeImagePlaceholder
item(
index)
  → DataMergeImagePlaceholder
itemByRange(
from, to)
  → DataMergeImagePlaceholder
lastItem(
)
  → DataMergeImagePlaceholder
middleItem(
)
  → DataMergeImagePlaceholder
nextItem(
obj)
  → DataMergeImagePlaceholder
previousItem(
obj)
  → DataMergeImagePlaceholder
toSource(
)
  → string
add(
placeholder, field ​[, withProperties])
  → DataMergeImagePlaceholder
Creates a data merge image placeholder.
placeholder PageItem The page item on which to place the placeholder.
field DataMergeField The data merge field to insert.
withProperties Object Initial values for properties of the new DataMergeImagePlaceholder (Optional)
anyItem(
)
  → DataMergeImagePlaceholder
Returns any DataMergeImagePlaceholder in the collection.
count(
)
  → number
Displays the number of elements in the DataMergeImagePlaceholder.
everyItem(
)
  → DataMergeImagePlaceholder
Returns every DataMergeImagePlaceholder in the collection.
firstItem(
)
  → DataMergeImagePlaceholder
Returns the first DataMergeImagePlaceholder in the collection.
item(
index)
  → DataMergeImagePlaceholder
Returns the DataMergeImagePlaceholder with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → DataMergeImagePlaceholder
Returns the DataMergeImagePlaceholders within the specified range.
from The DataMergeImagePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String.
to The DataMergeImagePlaceholder, index, or name at the end of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String.
lastItem(
)
  → DataMergeImagePlaceholder
Returns the last DataMergeImagePlaceholder in the collection.
middleItem(
)
  → DataMergeImagePlaceholder
Returns the middle DataMergeImagePlaceholder in the collection.
nextItem(
obj)
  → DataMergeImagePlaceholder
Returns the DataMergeImagePlaceholder whose index follows the specified DataMergeImagePlaceholder in the collection.
obj DataMergeImagePlaceholder The DataMergeImagePlaceholder whose index comes before the desired DataMergeImagePlaceholder.
previousItem(
obj)
  → DataMergeImagePlaceholder
Returns the DataMergeImagePlaceholder with the index previous to the specified index.
obj DataMergeImagePlaceholder The index of the DataMergeImagePlaceholder that follows the desired DataMergeImagePlaceholder.
toSource(
)
  → string
Generates a string which, if executed, will return the DataMergeImagePlaceholder.