K4 InDesign Javascript API Documentation

LayoutMasterSpreads

A collection of master spreads.

Instance Properties

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

Methods

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