Layer

A layer.

Methods:

move, remove, removeAll, zOrder

Objects:

BlendModes, Boolean, CompoundPathItems, GraphItems, GridRepeatItems, GroupItems, KnockoutState, Layers, LegacyTextItems, MeshItems, NonNativeItems, Number, PageItems, PathItems, PlacedItems, PluginItems, RGBColor, RadialRepeatItems, RasterItems, String, SymbolItems, SymmetryRepeatItems, TextFrameItems

Property Listing

Property

Type

Access

Description

absoluteZOrderPosition

Int32

readonly

The absolute drawing order of the layer.

artworkKnockout

KnockoutState

KnockoutState.DISABLED

KnockoutState.ENABLED

KnockoutState.INHERITED

KnockoutState.Unknown

read/write

Is the artwork used to create a knockout.

blendingMode

BlendModes

BlendModes.COLORBLEND

BlendModes.COLORBURN

BlendModes.COLORDODGE

BlendModes.DARKEN

BlendModes.DIFFERENCE

BlendModes.EXCLUSION

BlendModes.HARDLIGHT

BlendModes.HUE

BlendModes.LIGHTEN

BlendModes.LUMINOSITY

BlendModes.MULTIPLY

BlendModes.NORMAL

BlendModes.OVERLAY

BlendModes.SATURATIONBLEND

BlendModes.SCREEN

BlendModes.SOFTLIGHT

read/write

The mode used when compositing an object.

color

RGBColor

read/write

Color used when outlining artwork in this layer.

compoundPathItems

CompoundPathItems CompoundPathItem

readonly

The compound path artwork in this layer.

dimPlacedImages

Boolean

read/write

Is rendered as dimmed in this layer?

graphItems

GraphItems GraphItem

readonly

The graph art items in this layer.

gridRepeatItems

GridRepeatItems GridRepeatItem

readonly

The grid repeat items in this layer.

groupItems

GroupItems GroupItem

readonly

The group items in this layer.

hasSelectedArtwork

Boolean

read/write

Is any artwork in this layer selected? Setting this property to false deselects all artwork in the layer.

isIsolated

Boolean

read/write

Is the artwork isolated.

layers

Layers Layer

readonly

Nested layers.

legacyTextItems

LegacyTextItems LegacyTextItem

readonly

The text frame items in this story.

locked

Boolean

read/write

Is the layer editable?

meshItems

MeshItems MeshItem

readonly

The mesh art items in this layer.

name

String

read/write

The layer's name.

nonNativeItems

NonNativeItems NonNativeItem

readonly

The non-native art items in this layer.

opacity

Number

read/write

The layer's opacity (between 0.0 and 100.0)

pageItems

PageItems PageItem

readonly

All the artwork in this layer.

parent

 

readonly

The object's container.

pathItems

PathItems PathItem

readonly

The path artwork in this layer.

placedItems

PlacedItems PlacedItem

readonly

The placed art items in this layer.

pluginItems

PluginItems PluginItem

readonly

The plugin art items in this layer.

preview

Boolean

read/write

Is the layer rendered in preview mode?

printable

Boolean

read/write

Is the layer printable?

radialRepeatItems

RadialRepeatItems RadialRepeatItem

readonly

The radial repeat items in this layer.

rasterItems

RasterItems RasterItem

readonly

The raster art items in this layer.

sliced

Boolean

read/write

Is the layer sliced (default: false)

symbolItems

SymbolItems SymbolItem

readonly

The symbol items in this layer.

symmetryRepeatItems

SymmetryRepeatItems SymmetryRepeatItem

readonly

The symmetry repeat items in this layer.

textFrames

TextFrameItems TextFrameItem

readonly

The text frame items in this layer.

typename

String

readonly

The class name of the object.

visible

Boolean

read/write

Is the layer visible?

zOrderPosition

Int32

readonly

The drawing order of the layer.

Method Listing

Layer move (relativeObject:Object, insertionLocation:ElementPlacement)

Move the object.

Parameter

Type

Description

relativeObject

Object

 

insertionLocation

ElementPlacement

 

undefined remove ()

Deletes this object.

undefined removeAll ()

Deletes all elements.

undefined zOrder (zOrderCmd:ZOrderMethod)

Arranges the layer relative to other layers.

Parameter

Type

Description

zOrderCmd

ZOrderMethod

ZOrderMethod.BRINGFORWARD

ZOrderMethod.BRINGTOFRONT

ZOrderMethod.SENDBACKWARD

ZOrderMethod.SENDTOBACK

How to arrange the layer.

Object of

Document.activeLayer

PageItem.layer

Return

Layers.add()

Layers.getByName()

Layer.move()