Spread
QuickLinks
Hierarchy
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 | readonly | 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 | MasterSpreadNothingEnum | readonly | The master spread applied to the Spread. Can also accept: NothingEnum enumerator. |
buttons | Buttons | readonly | A collection of buttons. |
epstexts | EPSTexts | readonly | EPSTexts |
eventListeners | EventListeners | readonly | A collection of event listeners. |
events | Events | readonly | A collection of events. |
formFields | FormFields | readonly | A collection of form fields. |
graphicLines | GraphicLines | readonly | A collection of graphic lines. |
groups | Groups | readonly | A collection of groups. |
guides | Guides | 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. |
multiStateObjects | MultiStateObjects | 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 | readonly | A collection of ellipses. |
pageItems | PageItems | 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. |
pages | Pages | readonly | A collection of pages. |
parent | Document | readonly | The parent of the Spread (a Document). |
polygons | Polygons | readonly | A collection of polygons. |
properties | Object | r/w | A property that allows setting of several properties at the same time. |
rectangles | Rectangles | readonly | A collection of rectangles. |
splineItems | SplineItems | readonly | The spline items collection. |
textFrames | TextFrames | readonly | A collection of text frames. |
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) |
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. |
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) |
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.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) |
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.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.SPREAD_COORDINATES | The coordinate space to use |
Element of
Guide.parent
Page.parent
Window.activeSpread
Used in:
Spread Spreads.nextItem (obj: Spread)
Spread Spreads.previousItem (obj: Spread)
Return
Array of Spread Spread.getElements ()
Spread Spreads.[] (index: number)
Spread Spreads.anyItem ()
Array of Spread Spreads.everyItem ()
Spread Spreads.firstItem ()
Spread Spreads.item (index: varies)
Spread Spreads.itemByID (id: number)
Spread Spreads.itemByName (name: string)
Array of Spread Spreads.itemByRange (from: varies, to: varies)
Spread Spreads.lastItem ()
Spread Spreads.middleItem ()
Spread Spreads.nextItem (obj: Spread)
Spread Spreads.previousItem (obj: Spread)
Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |