Adobe InDesign CS2 (4.0) Object Model JS: Layer

From InDesign CS2

previous page next page

Class

Layer

A layer.

QuickLinks

duplicate, extractLabel, getElements, insertLabel, merge, move, remove, toSource, toSpecifier

Hierarchy

Document

Layer

Properties

Property	Type	Access	Description
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Layer.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Layer.
buttons	Buttons	readonly	A collection of buttons.
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 Layer.
ignoreWrap	bool	r/w	If true, text wrap settings applied to objects on the layer will not affect text on other layers when the layer is hidden.
index	number	readonly	The index of the Layer within its containing object.
label	string	r/w	A property that can be set to any string.
layerColor	3 Reals (0 - 255) UIColors	r/w	The color of the layer, 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 return: Array of 3 Reals (0 - 255) or UIColors enumerator.
lockGuides	bool	r/w	If true, the guide positions on the layer are locked.
locked	bool	r/w	If true, the Layer is locked.
name	string	r/w	The name of the Layer.
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.
parent	Document	readonly	The parent of the Layer (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.
showGuides	bool	r/w	If true, guides are visible on the layer.
textFrames	TextFrames	readonly	A collection of text frames.
visible	bool	r/w	If true, the Layer is visible.

Methods

Instances

Layer duplicate ()
Duplicates the Layer.

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of Object 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.

Layer merge (with: Array of Layer)
Merges the layer with other layer(s).

Parameter	Type	Description
with	Array of Layer	The layer(s) with which to merge.

Layer move (to: LocationOptions[, reference: Layer])
Moves the Layer to the specified location.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object.
reference	Layer	The reference object. Note: Required when the to value specifies before or after. (Optional)

void remove ()
Deletes the Layer.

string toSource ()
Generates a string which, if executed, will return the Layer.

string toSpecifier ()
Retrieves the object specifier.

Element of

Button.itemLayer

FormField.itemLayer

GraphicLine.itemLayer

Group.itemLayer

Guide.itemLayer

LayoutWindow.activeLayer

Movie.itemLayer

Oval.itemLayer

PageItem.itemLayer

Polygon.itemLayer

Rectangle.itemLayer

Sound.itemLayer

TextFrame.itemLayer

Used in:

void Button.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

Button Buttons.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

array of Story Document.createTOC (using: TOCStyle[, replacing: bool=false][, fromBook: Book][, placePoint: Array of Measurement Unit (Number or String)][, includeOverset: bool=false][, destinationLayer: Layer])

void EPS.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

void FormField.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

void Graphic.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

void GraphicLine.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

GraphicLine GraphicLines.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void Group.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

Group Groups.add (groupItems: Array of PageItem[, layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

Guide Guides.add ([layer: Layer][, withProperties: Object])

void Image.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

array of Story Index.generate ([on: any][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, autoflowing: bool=false][, includeOverset: bool=false])

Layer Layer.merge (with: Array of Layer)

Layer Layer.move (to: LocationOptions[, reference: Layer])

array of Layer Layers.itemByRange (from: any, to: any)

Layer Layers.nextItem (obj: Layer)

Layer Layers.previousItem (obj: Layer)

void MasterSpread.createGuides ([numberOfRows: number=0][, numberOfColumns: number=0][, rowGutter: Measurement Unit (Number or String)=0][, columnGutter: Measurement Unit (Number or String)=0][, guideColor: any][, fitMargins: bool=false][, removeExisting: bool=false][, layer: Layer])

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

void Movie.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

Movie Movies.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void Oval.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

Oval Ovals.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void PDF.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

void PICT.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

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

void PageItem.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

void Polygon.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

Polygon Polygons.add ([layer: Layer][, numberOfSides: number][, insetPercentage: number][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void Rectangle.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

Rectangle Rectangles.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void Sound.move ([to: any][, by: Array of Measurement Unit (Number or String)][, transformingContent: bool=true])

Sound Sounds.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void Spread.createGuides ([numberOfRows: number=0][, numberOfColumns: number=0][, rowGutter: Measurement Unit (Number or String)=0][, columnGutter: Measurement Unit (Number or String)=0][, guideColor: any][, fitMargins: bool=false][, removeExisting: bool=false][, layer: Layer])

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