LayoutSpreads

Instance Properties

Methods

add(

[at=LocationOptions.UNKNOWN], reference ​[, withProperties])

→ Spread

Creates a new spread.

at	LocationOptions The location of the spread relative to the reference object or within the document. (Optional)
reference	The reference object. Note: Required when the at parameter specifies before or after. Can accept: Spread or Document. (Optional)
withProperties	Object Initial values for properties of the new Spread (Optional)

anyItem(

)

→ Spread

Returns any Spread in the collection.

count(

)

→ number

Displays the number of elements in the Spread.

everyItem(

)

→ Spread

Returns every Spread in the collection.

firstItem(

)

→ Spread

Returns the first Spread in the collection.

item(

index)

→ Spread

Returns the Spread with the specified index or name.

index

The index or name. Can accept: Long Integer or String.

itemByID(

id)

→ Spread

Returns the Spread with the specified ID.

id	number The ID.

itemByName(

name)

→ Spread

Returns the Spread with the specified name.

name	string The name.

itemByRange(

from, to)

→ Spread

Returns the Spreads within the specified range.

from	The Spread, index, or name at the beginning of the range. Can accept: Spread, Long Integer or String.
to	The Spread, index, or name at the end of the range. Can accept: Spread, Long Integer or String.

lastItem(

)

→ Spread

Returns the last Spread in the collection.

middleItem(

)

→ Spread

Returns the middle Spread in the collection.

nextItem(

obj)

→ Spread

Returns the Spread whose index follows the specified Spread in the collection.

obj	Spread The Spread whose index comes before the desired Spread.

previousItem(

obj)

→ Spread

Returns the Spread with the index previous to the specified index.

obj	Spread The index of the Spread that follows the desired Spread.

toSource(

)

→ string

Generates a string which, if executed, will return the Spread.