Spreads

A collection of spreads.

Methods:

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Spread add ([at:LocationOptions=LocationOptions], reference:Varies Spread Document, withProperties:Object)

Creates a new spread.

Parameter	Type	Description
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location of the spread relative to the reference object or within the document. (Optional) (default: LocationOptions.UNKNOWN)
reference	Spread Document	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)

Parameter

Type

Description

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the spread relative to the reference object or within the document. (Optional)

(default: LocationOptions.UNKNOWN)

reference