Adobe InDesign CS6 Server (8.0) Object Model JS: Spread

InDesign Server CS6

previous page next page

Class

Spread

A spread.

QuickLinks

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

Hierarchy

Document

Spread

Properties

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	bool	r/w	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	r/w	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.
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.DEFAULT_VALUE SpreadFlattenerLevel.NONE SpreadFlattenerLevel.CUSTOM	r/w	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	r/w	The IDML component name of the Spread.
index	number	readonly	The index of the Spread within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	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	r/w	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.NOT_APPLICABLE PageTransitionDirectionOptions.DOWN PageTransitionDirectionOptions.RIGHT_TO_LEFT PageTransitionDirectionOptions.LEFT_DOWN PageTransitionDirectionOptions.LEFT_UP PageTransitionDirectionOptions.LEFT_TO_RIGHT PageTransitionDirectionOptions.RIGHT_DOWN PageTransitionDirectionOptions.RIGHT_UP PageTransitionDirectionOptions.UP PageTransitionDirectionOptions.IN PageTransitionDirectionOptions.OUT PageTransitionDirectionOptions.HORIZONTAL PageTransitionDirectionOptions.VERTICAL PageTransitionDirectionOptions.HORIZONTAL_IN PageTransitionDirectionOptions.HORIZONTAL_OUT PageTransitionDirectionOptions.VERTICAL_IN PageTransitionDirectionOptions.VERTICAL_OUT	r/w	The direction of the page transition.
pageTransitionDuration	PageTransitionDurationOptions: PageTransitionDurationOptions.FAST PageTransitionDurationOptions.MEDIUM PageTransitionDurationOptions.SLOW	r/w	The duration of the page transition.
pageTransitionType	PageTransitionTypeOptions: PageTransitionTypeOptions.NONE PageTransitionTypeOptions.BLINDS_TRANSITION PageTransitionTypeOptions.BOX_TRANSITION PageTransitionTypeOptions.COMB_TRANSITION PageTransitionTypeOptions.COVER_TRANSITION PageTransitionTypeOptions.DISSOLVE_TRANSITION PageTransitionTypeOptions.FADE_TRANSITION PageTransitionTypeOptions.PAGE_TURN_TRANSITION PageTransitionTypeOptions.PUSH_TRANSITION PageTransitionTypeOptions.SPLIT_TRANSITION PageTransitionTypeOptions.UNCOVER_TRANSITION PageTransitionTypeOptions.WIPE_TRANSITION PageTransitionTypeOptions.ZOOM_IN_TRANSITION PageTransitionTypeOptions.ZOOM_OUT_TRANSITION	r/w	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	r/w	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	bool	r/w	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.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of any contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false])
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	bool	Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStories	bool	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	bool	Whether to map styles in content placer (Optional) (default: false)
placePoint	Array of Measurement Unit (Number or String)	The point at which to place (Optional)
destinationLayer	Layer	The layer on which to place (Optional)
showingOptions	bool	Whether to display the link options dialog (Optional) (default: false)

void createGuides ([numberOfRows: number=0][, numberOfColumns: number=0][, rowGutter: Measurement Unit (Number or String)=0][, columnGutter: Measurement Unit (Number or String)=0][, guideColor: varies][, fitMargins: bool=false][, removeExisting: bool=false][, 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	Measurement Unit (Number or String) (range: 0 - 1440)	The height of the gutter between rows. (Optional) (default: 0)
columnGutter	Measurement Unit (Number or String) (range: 0 - 1440)	The width of the gutter between columns. (Optional) (default: 0)
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	bool	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	bool	If true, removes existing guides when creating new ones. (Optional) (default: false)
layer	Layer	The layer on which to create the guides. (Optional)

void detach ()
Detaches an overridden master page item from the master page.

any duplicate ([to: LocationOptions=LocationOptions.AT_END][, reference: varies])
Duplicates the spread.

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

Array of Spread getElements ()
Resolves the object specifier, creating an array of object references.

void 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.AT_END][, reference: varies])
Moves the spread.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location of the spread relative to the reference object or within the document. (Optional) (default: LocationOptions.AT_END)
reference	Document Page Spread	The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document. (Optional)

Array of any place (fileName: File[, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, autoflowing: bool=false][, withProperties: Object])
Places the file.

Parameter	Type	Description
fileName	File	The file to place
placePoint	Array of Measurement Unit (Number or String)	The point at which to place (Optional)
destinationLayer	Layer	The layer on which to place (Optional)
autoflowing	bool	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 Measurement Unit (Number or String)][, destinationLayer: Layer][, showingOptions: bool=false])
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 Measurement Unit (Number or String)	The point at which to place (Optional)
destinationLayer	Layer	The layer on which to place (Optional)
showingOptions	bool	Whether to display the link options dialog (Optional) (default: false)

PageItem placeXML (using: XMLElement, placePoint: Array of Measurement Unit (Number or String)[, autoflowing: bool=false])
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 Measurement Unit (Number or String)	The point at which to place the object, specified in the format [x, y].
autoflowing	bool	If true, autoflows placed text. (Optional) (default: false)

void remove ()
Deletes the Spread.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void removeOverride ()
Removes the override from a previously overridden master page item.

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

Parameter	Type	Description
location	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use.
consideringRulerUnits	bool	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)

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.

void transform (in: CoordinateSpaces, from: varies, withMatrix: varies[, replacingCurrent: varies][, consideringRulerUnits: bool=false])
Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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 Long Integer MatrixContent	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	bool	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)

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use

Element of

FlattenerPreference.parent

Guide.parent

Page.parent

TimingSetting.parent

Used in:

void Document.createAlternateLayout (spreadItems: Array of Spread, name: string, width: Measurement Unit (Number or String), height: Measurement Unit (Number or String), createTextStyles: bool, linkTextStories: bool, layoutRule: LayoutRuleOptions)