Adobe InDesign CS2 (4.0) Object Model JS: Layer

InDesign CS2

Class

Layer

 A layer.

QuickLinks

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

Hierarchy

Document
Layer
Button | FormField | GraphicLine | Group | Guide | Oval | PageItem | Polygon | Rectangle | TextFrame

Properties

PropertyTypeAccessDescription
allGraphics Array of Graphic readonlyLists all graphics contained by the Layer.
allPageItems Array of PageItem readonlyLists all page items contained by the Layer.
buttonsButtons readonlyA collection of buttons.
formFieldsFormFields readonlyA collection of form fields.
graphicLinesGraphicLines readonlyA collection of graphic lines.
groupsGroups readonlyA collection of groups.
guidesGuides readonlyA collection of guides.
idnumber readonlyThe unique ID of the Layer.
ignoreWrapbool r/wIf true, text wrap settings applied to objects on the layer will not affect text on other layers when the layer is hidden.
indexnumber readonlyThe index of the Layer within its containing object.
labelstring r/wA property that can be set to any string.
layerColor3 Reals (0 - 255)
UIColors
r/wThe 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.
lockGuidesbool r/wIf true, the guide positions on the layer are locked.
lockedbool r/wIf true, the Layer is locked.
namestring r/wThe name of the Layer.
ovalsOvals readonlyA collection of ellipses.
pageItemsPageItems readonlyThe 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.
parentDocument readonlyThe parent of the Layer (a Document).
polygonsPolygons readonlyA collection of polygons.
propertiesObject r/wA property that allows setting of several properties at the same time.
rectanglesRectangles readonlyA collection of rectangles.
showGuidesbool r/wIf true, guides are visible on the layer.
textFramesTextFrames readonlyA collection of text frames.
visiblebool r/wIf 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.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
with Array of LayerThe layer(s) with which to merge.

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

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceLayerThe 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])

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

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

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

Return

Layer Layer.duplicate ()

Layer Layer.merge (with: Array of Layer)

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

Layer Layers.add ([withProperties: Object])

Layer Layers.anyItem ()

Array of Layer Layers.everyItem ()

Layer Layers.firstItem ()

Layer Layers.item (index: any)

Layer Layers.itemByID (id: number)

Layer Layers.itemByName (name: string)

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

Layer Layers.lastItem ()

Layer Layers.middleItem ()

Layer Layers.nextItem (obj: Layer)

Layer Layers.previousItem (obj: Layer)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index