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

InDesign Server CS6

Class

GraphicLayer

 A layer in a PSD image or PDF file.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

GraphicLayer | GraphicLayerOption
GraphicLayer
Event | EventListener | GraphicLayer | MutationEvent

Properties

PropertyTypeAccessDescription
adjustmentLayerbool readonlyIf true, the layer is an adjustment layer. Note: Must occur in the script before overriding the visibility state of the layer with a current visibility statement.
currentVisibilitybool r/wIf true, the layer is visible in the document.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
exportStatebool readonlyIf true, the export state is on.
fxLayerbool readonlyIf true, layer effects have been applied to the layer. Note: Must occur in the script before overriding the visibility state of the layer with a current visibility statement.
graphicLayersGraphicLayers GraphicLayer readonlyA collection of graphic layers.
hasExportStatebool readonlyIf true, the layer has an export state.
hasPrintStatebool readonlyIf true, the layer has a print state.
hasViewStatebool readonlyIf true, the layer has a view state.
idnumber readonlyThe unique ID of the GraphicLayer.
indexnumber readonlyThe index of the GraphicLayer within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
lockedbool readonlyIf true, the GraphicLayer is locked.
namestring readonlyThe name of the GraphicLayer.
originalVisibilitybool readonlyReturns the visibility setting set for the layer before the graphic file was imported. Note: Must occur in the script before overriding the visibility state with a current visibility statement.
parentGraphicLayerGraphicLayerOption readonlyThe parent of the GraphicLayer (a GraphicLayerOption or GraphicLayer).
printStatebool readonlyIf true, the print state is on.
propertiesObject r/wA property that allows setting of several properties at the same time.
sectionDividerLayerbool readonlyIf true, the layer is a section divider layer.
separatorLayerbool readonlyIf true, the layer is a separator layer.
viewStatebool readonlyIf true, the view state is on.

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

GraphicLayer.parent

Used in:

GraphicLayer GraphicLayers.nextItem (obj: GraphicLayer)

GraphicLayer GraphicLayers.previousItem (obj: GraphicLayer)

Return

Array of GraphicLayer GraphicLayer.getElements ()

GraphicLayer GraphicLayers.[] (index: number)

GraphicLayer GraphicLayers.anyItem ()

Array of GraphicLayer GraphicLayers.everyItem ()

GraphicLayer GraphicLayers.firstItem ()

GraphicLayer GraphicLayers.item (index: varies)

GraphicLayer GraphicLayers.itemByID (id: number)

GraphicLayer GraphicLayers.itemByName (name: string)

Array of GraphicLayer GraphicLayers.itemByRange (from: varies, to: varies)

GraphicLayer GraphicLayers.lastItem ()

GraphicLayer GraphicLayers.middleItem ()

GraphicLayer GraphicLayers.nextItem (obj: GraphicLayer)

GraphicLayer GraphicLayers.previousItem (obj: GraphicLayer)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index