Specifications

Adobe Photoshop CS6
JavaScript Scripting Reference JavaScript Object Reference 88
Document
The active containment object for layers and all other objects in the script; the basic canvas for the file.
● Access the object for the currently active document through Application.activeDocument.
● You can access other documents, or iterate through all open documents using the list in the
Application
.documents collection. You can access individual documents in the list by index, or use
Documents
.getByName() to retrieve them by name.
● Create documents programmatically using the Documents.add() method.
See Document sample script
and the Documents collection object for examples.
Note: In Adobe Photoshop CS6, a document can also be referred to as an image or a canvas.
● The term image refers to the entire document and its contents. You can trim or crop an image.
You resize an image using the
resizeImage() method.
● The term canvas refers to the space in which the document sits on the screen. You can rotate or
flip the canvas. You resize the canvas using the
resizeCanvas() method.
Properties
Property Value type What it is
activeChannels
array of Channel
Read-write. The selected channels.
activeHistoryBrushSource
Guide
Read-write. The history state to use with the
history brush.
activeHistoryState
Guide
Read-write. The selected HistoryState object.
activeLayer
ArtLayer or
LayerSet
Read-write. The selected layer.
artLayers
ArtLayers
Read-only. The art layers collection.
backgroundLayer
ArtLayer
Read-only. The background layer of the
document.
bitsPerChannel
BitsPerChannelType
Read-write. The number of bits per channel.
channels
Channels
Read-only. The channels collection.
colorProfileName
string
Read-write. The name of the color profile.
Valid only when colorProfileType
=
ColorProfile.CUSTOM
or WORKING.
colorProfileType
ColorProfileType
Read-write. Whether the document uses the
working color profile, a custom profile, or no
profile.
colorSamplers
ColorSamplers
Read-only. The current color samplers
associated with this document.
componentChannels
array of Channel
Read-only. The color channels that make up
the document; for instance, the Red, Green,
and Blue channels for an RGB document.