Spread

A spread.

Methods:

addEventListener, contentPlace, createGuides, detach, duplicate, extractLabel, getElements, insertLabel, move, place, placeAndLink, placeXML, remove, removeEventListener, removeOverride, resolve, select, setContent, toSource, toSpecifier, transform, transformValuesOf

Objects:

Boolean, Buttons, CheckBoxes, ComboBoxes, EPSTexts, EndnoteTextFrames, EventListeners, Events, FlattenerPreference, FormFields, Graphic, GraphicLines, Groups, Guides, ListBoxes, MasterSpread, MultiStateObjects, NothingEnum, Number, Object, Ovals, PageItem, PageItems, PageTransitionDirectionOptions, PageTransitionDurationOptions, PageTransitionTypeOptions, Pages, Polygons, Preferences, RadioButtons, Rectangles, SignatureFields, SplineItems, SpreadFlattenerLevel, String, TextBoxes, TextFrames, TimingSetting, TypefiElementAnchors

Preferences:

FlattenerPreference, Preferences

Property Listing

Property

Type

Access

Description

allGraphics

Array of Graphic

readonly

Lists all graphics contained by the Spread.

allPageItems

Array of PageItem

readonly

Lists all page items contained by the Spread.

allowPageShuffle

Boolean

read/write

If true, guarantees that when pages are added to a spread it will contain a maximum of two pages. If false, allows pages to be added or moved into existing spreads. For override information, see preserve layout when shuffling.

appliedMaster

MasterSpread

NothingEnum.NOTHING

read/write

The master spread applied to the Spread. Can also accept: NothingEnum enumerator.

buttons

Buttons Button

readonly

A collection of buttons.

checkBoxes

CheckBoxes

readonly

A collection of checkboxes.

comboBoxes

ComboBoxes

readonly

A collection of comboboxes.

endnoteTextFrames

EndnoteTextFrames EndnoteTextFrame

readonly

A collection of endnote text frames.

epstexts

EPSTexts EPSText

readonly

EPSTexts

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

flattenerOverride

SpreadFlattenerLevel

SpreadFlattenerLevel.CUSTOM

SpreadFlattenerLevel.DEFAULT_VALUE

SpreadFlattenerLevel.NONE

read/write

The transparency flattener preferences override for the spread.

flattenerPreferences

FlattenerPreference

readonly

Flattener preference settings.

formFields

FormFields FormField

readonly

A collection of form fields.

graphicLines

GraphicLines GraphicLine

readonly

A collection of graphic lines.

groups

Groups Group

readonly

A collection of groups.

guides

Guides Guide

readonly

A collection of guides.

id

Number

readonly

The unique ID of the Spread.

idmlComponentName

String

read/write

The IDML component name of the Spread.

index

Number

readonly

The index of the Spread within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

listBoxes

ListBoxes

readonly

A collection of listboxes.

multiStateObjects

MultiStateObjects MultiStateObject

readonly

A collection of multi-state objects.

name

String

read/write

The name of the Spread; this is an alias to the Spread's label property.

ovals

Ovals Oval

readonly

A collection of ellipses.

pageItems

PageItems PageItem

readonly

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.

pageTransitionDirection

PageTransitionDirectionOptions

PageTransitionDirectionOptions.DOWN

PageTransitionDirectionOptions.HORIZONTAL

PageTransitionDirectionOptions.HORIZONTAL_IN

PageTransitionDirectionOptions.HORIZONTAL_OUT

PageTransitionDirectionOptions.IN

PageTransitionDirectionOptions.LEFT_DOWN

PageTransitionDirectionOptions.LEFT_TO_RIGHT

PageTransitionDirectionOptions.LEFT_UP

PageTransitionDirectionOptions.NOT_APPLICABLE

PageTransitionDirectionOptions.OUT

PageTransitionDirectionOptions.RIGHT_DOWN

PageTransitionDirectionOptions.RIGHT_TO_LEFT

PageTransitionDirectionOptions.RIGHT_UP

PageTransitionDirectionOptions.UP

PageTransitionDirectionOptions.VERTICAL

PageTransitionDirectionOptions.VERTICAL_IN

PageTransitionDirectionOptions.VERTICAL_OUT

read/write

The direction of the page transition.

pageTransitionDuration

PageTransitionDurationOptions

PageTransitionDurationOptions.FAST

PageTransitionDurationOptions.MEDIUM

PageTransitionDurationOptions.SLOW

read/write

The duration of the page transition.

pageTransitionType

PageTransitionTypeOptions

PageTransitionTypeOptions.BLINDS_TRANSITION

PageTransitionTypeOptions.BOX_TRANSITION

PageTransitionTypeOptions.COMB_TRANSITION

PageTransitionTypeOptions.COVER_TRANSITION

PageTransitionTypeOptions.DISSOLVE_TRANSITION

PageTransitionTypeOptions.FADE_TRANSITION

PageTransitionTypeOptions.NONE

PageTransitionTypeOptions.PAGE_TURN_TRANSITION

PageTransitionTypeOptions.PUSH_TRANSITION

PageTransitionTypeOptions.SPLIT_TRANSITION

PageTransitionTypeOptions.UNCOVER_TRANSITION

PageTransitionTypeOptions.WIPE_TRANSITION

PageTransitionTypeOptions.ZOOM_IN_TRANSITION

PageTransitionTypeOptions.ZOOM_OUT_TRANSITION

read/write

The type of page transition.

pages

Pages Page

readonly

A collection of pages.

parent

Document

readonly

The parent of the Spread (a Document).

polygons

Polygons Polygon

readonly

A collection of polygons.

preferences

Preferences Preference

readonly

A collection of preferences objects.

properties

Object

read/write

A property that allows setting of several properties at the same time.

radioButtons

RadioButtons RadioButton

readonly

A collection of radio buttons.

rectangles

Rectangles Rectangle

readonly

A collection of rectangles.

showMasterItems

Boolean

read/write

If true, displays master page items on document pages in the spread.

signatureFields

SignatureFields SignatureField

readonly

A collection of signature fields.

splineItems

SplineItems SplineItem

readonly

The spline items collection.

textBoxes

TextBoxes

readonly

A collection of text boxes.

textFrames

TextFrames TextFrame

readonly

A collection of text frames.

timingSettings

TimingSetting

readonly

The object timing settings.

typefiElementAnchors

TypefiElementAnchors TypefiElementAnchor

readonly

A list of Typefi element anchors

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

Varies contentPlace (pageItems:Array of PageItem, [linkPageItems:Boolean=Boolean], [linkStories:Boolean=Boolean], [mapStyles:Boolean=Boolean], placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean])

Duplicate an object and place it into the target.

Parameter

Type

Description

pageItems

Array of PageItem

One or more page items to place or load

linkPageItems

Boolean

Whether to link pageItems in content placer (if true it will override link stories value) (Optional)

(default: false)

linkStories

Boolean

Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional)

(default: false)

mapStyles

Boolean

Whether to map styles in content placer (Optional)

(default: false)

placePoint

Array of Number

Array of String

The point at which to place (Optional)

destinationLayer

Layer

The layer on which to place (Optional)

showingOptions

Boolean

Whether to display the link options dialog (Optional)

(default: false)

undefined createGuides ([numberOfRows:Number=Number], [numberOfColumns:Number=Number], [rowGutter:Number String], [columnGutter:Number String], guideColor:Array of Varies 3 Reals (0 - 255) UIColors, [fitMargins:Boolean=Boolean], [removeExisting:Boolean=Boolean], layer:Layer)

Creates multiple guides on all pages of the spread.

Parameter

Type

Description

numberOfRows

Number (range 0 - 40)

The number of rows to create on each page. (Optional)

(default: 0)

numberOfColumns

Number (range 0 - 40)

The number of columns to create on each page. (Optional)

(default: 0)

rowGutter

Number

String

The height of the gutter between rows. (Optional)

columnGutter

Number

String

The width of the gutter between columns. (Optional)

guideColor

Array of 3 Reals (0 - 255)

UIColors

The color to make the guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional)

fitMargins

Boolean

If true, the row height and column width are calculated based on the space within the page margins. If false, row height and column width are calculated based on the full page. (Optional)

(default: false)

removeExisting

Boolean

If true, removes existing guides when creating new ones. (Optional)

(default: false)

layer

Layer

The layer on which to create the guides. (Optional)

undefined detach ()

Detaches an overridden master page item from the master page.

Varies duplicate ([to:LocationOptions=LocationOptions], reference:Varies Document Spread MasterSpread)

Duplicates the spread.

Parameter

Type

Description

to

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.AT_END)

reference

Document

Spread

MasterSpread

The reference object. Note: Required only when the to parameter specifies before or after. Can accept: Spread, Document or MasterSpread. (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Spread getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter

Type

Description

key

String

The key.

value

String

The value.

Spread move ([to:LocationOptions=LocationOptions], reference:Varies Page Spread Document)

Moves the spread.

Parameter

Type

Description

to

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.AT_END)

reference

Page

Spread

Document

The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document. (Optional)

Varies place (fileName:File, placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean], [autoflowing:Boolean=Boolean], withProperties:Object)

Places the file.

Parameter

Type

Description

fileName

File

The file to place

placePoint

Array of Number

Array of String

The point at which to place (Optional)

destinationLayer

Layer

The layer on which to place (Optional)

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

autoflowing

Boolean

Whether to autoflow placed text (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

Story placeAndLink (parentStory:Story, placePoint:Array of Number String, destinationLayer:Layer, [showingOptions:Boolean=Boolean])

Deprecated: Use contentPlace method. Original Description: Create a linked story and place it into the target.

Parameter

Type

Description

parentStory

Story

The story to place and link from.

placePoint

Array of Number

Array of String

The point at which to place (Optional)

destinationLayer

Layer

The layer on which to place (Optional)

showingOptions

Boolean

Whether to display the link options dialog (Optional)

(default: false)

PageItem placeXML (using:XMLElement, placePoint:Array of Number String, [autoflowing:Boolean=Boolean])

Places the XML element onto a page. If the place point is above an existing page item, place the XML element into the page item.

Parameter

Type

Description

using

XMLElement

The XML element to place.

placePoint

Array of Number

Array of String

The point at which to place the object, specified in the format [x, y].

autoflowing

Boolean

If true, autoflows placed text. (Optional)

(default: false)

undefined remove ()

Deletes the Spread.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined removeOverride ()

Removes the override from a previously overridden master page item.

Varies resolve (location:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, in:CoordinateSpaces, [consideringRulerUnits:Boolean=Boolean])

Get the coordinates of the given location in the specified coordinate system.

Parameter

Type

Description

location

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use.

consideringRulerUnits

Boolean

If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

SelectionOptions.SET_KEY

The selection status of the Spread in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

PageItem setContent (using:String, relativeBasePath:String)

Replaces the content of XML element with content imported from a file.

Parameter

Type

Description

using

String

The file path to the import file.

relativeBasePath

String

Base path used to resolve relative paths. (Optional)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])

Transform the page item.

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use

from

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

withMatrix

Array of 6 Reals

TransformationMatrix

Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.

replacingCurrent

Array of MatrixContent enumerators

MatrixContent

MatrixContent.ROTATION_VALUE

MatrixContent.SCALE_VALUES

MatrixContent.SHEAR_VALUE

MatrixContent.TRANSLATION_VALUES

LongInteger

Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)

consideringRulerUnits

Boolean

If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

TransformationMatrix transformValuesOf (in:CoordinateSpaces)

Get the transformation values of the page item.

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use

Object of

LayoutWindow.activeSpread

Button.parent

CheckBox.parent

ComboBox.parent

EPSText.parent

EndnoteTextFrame.parent

Event.parent

EventListener.parent

FlattenerPreference.parent

FormField.parent

GraphicLine.parent

Group.parent

Guide.parent

ListBox.parent

MultiStateObject.parent

MutationEvent.parent

Oval.parent

Page.parent

PageItem.parent

Polygon.parent

Preference.parent

RadioButton.parent

Rectangle.parent

SignatureField.parent

SplineItem.parent

TextBox.parent

TextFrame.parent

TimingSetting.parent

TypefiElementAnchor.parent

Return

Spreads.add()

Spread.move()

Spread.getElements()

Spreads.anyItem()

Spreads.everyItem()

Spreads.nextItem()

Spreads.previousItem()

Spreads.itemByID()

Spreads.item()

Spreads.[]()

Spreads.itemByName()

Spreads.itemByRange()

Spreads.firstItem()

Spreads.lastItem()

Spreads.middleItem()