Document

Represents a single Photoshop document that is currently open You can access instances of documents using one of these methods:

const app = require('photoshop').app;
const constants = require('photoshop').constants;

// The currently active document from the Photoshop object
const currentDocument = app.activeDocument;

// Choose one of the open documents from the Photoshop object
const secondDocument = app.documents[1];

// You can also create an instance of a document via a UXP File entry
let fileEntry = require('uxp').storage.localFileSystem.getFileForOpening();
const newDocument = await app.open('/project.psd');
CopyCopied to your clipboard
1const app = require('photoshop').app;
2const constants = require('photoshop').constants;
3
4// The currently active document from the Photoshop object
5const currentDocument = app.activeDocument;
6
7// Choose one of the open documents from the Photoshop object
8const secondDocument = app.documents[1];
9
10// You can also create an instance of a document via a UXP File entry
11let fileEntry = require('uxp').storage.localFileSystem.getFileForOpening();
12const newDocument = await app.open('/project.psd');

Properties

saveAs

• saveAs: object

Save the document to a desired file type.

For operations that require a UXP File token, use the UXP storage APIs to generate one.

let entry = await require('uxp').storage.localFileSystem.getFileForSaving("target.psd");
document.saveAs.psd(entry);

// Save as a Copy (High JPG quality)
document.saveAs.jpg(entryJpg, { quality: 12 }, true);

// Save a PSB, with some options:
document.saveAs.psb(entryPsb, { embedColorProfile: true });
CopyCopied to your clipboard
1let entry = await require('uxp').storage.localFileSystem.getFileForSaving("target.psd");
2document.saveAs.psd(entry);
3
4// Save as a Copy (High JPG quality)
5document.saveAs.jpg(entryJpg, { quality: 12 }, true);
6
7// Save a PSB, with some options:
8document.saveAs.psb(entryPsb, { embedColorProfile: true });

Type declaration

selection

• Readonly selection: Selection

The object containing the document's currently active selection

Properties

Methods

calculations

async : Promise<void | Channel | Document>

The Calculations command lets you blend two individual channels from one or more source images. You can then apply the results to a new image or to a new channel or selection in the active image.

Performs Image > Calculations on the document. See the CalculationsOptions object for more info and examples.

const doc = app.activeDocument;
const options = {
    source1: {
        document: doc,
        layer: doc.layers[0],
        channel: CalculationsChannel.GRAY
        invert: true
    },
    source2: {
        document: doc,
        layer: CalculationsLayer.MERGED,
        channel: doc.channels[2]
    },
    blending: CalculationsBlendMode.DARKEN,
    opacity: 50,
    result: CalculationsResult.NEWCHANNEL
};
doc.calculations(options);

CopyCopied to your clipboard
1const doc = app.activeDocument;
2const options = {
3    source1: {
4        document: doc,
5        layer: doc.layers[0],
6        channel: CalculationsChannel.GRAY
7        invert: true
8    },
9    source2: {
10        document: doc,
11        layer: CalculationsLayer.MERGED,
12        channel: doc.channels[2]
13    },
14    blending: CalculationsBlendMode.DARKEN,
15    opacity: 50,
16    result: CalculationsResult.NEWCHANNEL
17};
18doc.calculations(options);
19

Known issue: currently calculations requires having exactly one unlocked pixel layer being selected otherwise it won't work. In future there should not be any layer requirements since this cannot output into layer.

Parameters

changeMode

async : Promise<void>

Changes the color mode of the document.

Parameters

close

async : Promise<void>

Closes the document, showing a prompt to save unsaved changes if specified.

Parameters

closeWithoutSaving

void

Close the document, discarding all unsaved changes.

convertProfile

async : Promise<void>

Changes the color profile.

destinationProfile must be either a string that names the color mode, or one of these below, meaning of the working color spaces or Lab color.

"Working RGB", "Working CMYK", "Working Gray", "Lab Color"

Parameters

createLayer

async : Promise<Layer>

Create a new layer.

await doc.createLayer() // defaults to pixel layer
CopyCopied to your clipboard
await doc.createLayer() // defaults to pixel layer

async : Promise<Layer>

Create a new pixel layer.

await doc.createLayer(
  Constants.LayerKind.NORMAL,
  { name: "myLayer", opacity: 80, blendMode: Constants.BlendMode.COLORDODGE })
CopyCopied to your clipboard
1await doc.createLayer(
2  Constants.LayerKind.NORMAL,
3  { name: "myLayer", opacity: 80, blendMode: Constants.BlendMode.COLORDODGE })

Parameters

async : Promise<Layer>

Create a new layer group.

await doc.createLayer( Constants.LayerKind.GROUP, { name: "myLayer", opacity: 80 })
CopyCopied to your clipboard
await doc.createLayer( Constants.LayerKind.GROUP, { name: "myLayer", opacity: 80 })

Parameters

createLayerGroup

async : Promise<Layer>

Create a layer group using options described by GroupLayerCreateOptions.

const myEmptyGroup = await doc.createLayerGroup()
const myGroup = await doc.createLayerGroup({ name: "myLayer", opacity: 80, blendMode: "colorDodge" })
const nonEmptyGroup = await doc.createLayerGroup({ name: "group", fromLayers: [layer1, layer2] })
const selectedGroup = await doc.createLayerGroup({ name: "group", fromLayers: doc.activeLayers })
CopyCopied to your clipboard
1const myEmptyGroup = await doc.createLayerGroup()
2const myGroup = await doc.createLayerGroup({ name: "myLayer", opacity: 80, blendMode: "colorDodge" })
3const nonEmptyGroup = await doc.createLayerGroup({ name: "group", fromLayers: [layer1, layer2] })
4const selectedGroup = await doc.createLayerGroup({ name: "group", fromLayers: doc.activeLayers })

Parameters

createPixelLayer

async : Promise<Layer>

Create a pixel layer using options described by PixelLayerCreateOptions.

await doc.createPixelLayer()
await doc.createPixelLayer({ name: "myLayer", opacity: 80, fillNeutral: true })
CopyCopied to your clipboard
1await doc.createPixelLayer()
2await doc.createPixelLayer({ name: "myLayer", opacity: 80, fillNeutral: true })

Parameters

createTextLayer

async : Promise<Layer>

Create a text layer using options described by TextLayerCreateOptions.

await doc.createTextLayer()
await doc.createTextLayer({ name: "myTextLayer", contents: "Hello, World!", fontSize: 32 })
CopyCopied to your clipboard
1await doc.createTextLayer()
2await doc.createTextLayer({ name: "myTextLayer", contents: "Hello, World!", fontSize: 32 })

Parameters

crop

async : Promise<void>

Crops the document to given bounds

Parameters

duplicate

Promise<Document>

Creates a duplicate of the document, making the duplicate active.

The optional parameter name provides the name for the duplicated document.

The optional parameter mergeLayersOnly indicates whether to only duplicate merged layers.

Parameters

duplicateLayers

async : Promise<Layer[]>

Duplicates given layer(s), creating all copies above the top most one in layer stack, and returns the newly created layers.

// duplicate some layers
const layerCopies = await document.duplicateLayers([layer1, layer3])
layerCopies.forEach((layer) => { layer.blendMode = 'multiply' })
// ...to another document
const finalDoc = await photoshop.open('~/path/to/collated/image.psd')
await document.duplicateLayers([logo1, textLayer1], finalDoc)
await finalDoc.close(SaveOptions.SAVECHANGES)
CopyCopied to your clipboard
1// duplicate some layers
2const layerCopies = await document.duplicateLayers([layer1, layer3])
3layerCopies.forEach((layer) => { layer.blendMode = 'multiply' })
4// ...to another document
5const finalDoc = await photoshop.open('~/path/to/collated/image.psd')
6await document.duplicateLayers([logo1, textLayer1], finalDoc)
7await finalDoc.close(SaveOptions.SAVECHANGES)

Parameters

flatten

async : Promise<void>

Flatten all layers in the document.

groupLayers

async : Promise<Layer>

Create a layer group from existing layers.

const layers = doc.layers
const group = await doc.groupLayers([layers[1], layers[2], layers[4]])
CopyCopied to your clipboard
1const layers = doc.layers
2const group = await doc.groupLayers([layers[1], layers[2], layers[4]])

Parameters

linkLayers

Layer[]

Links layers together if possible, and returns a list of linked layers.

Parameters

mergeVisibleLayers

async : Promise<void>

Merges all visible layers in the document into a single layer.

paste

async : Promise<Layer>

Pastes the contents of the clipboard into the document. If the optional argument is set to true and a selection is active, the contents are pasted into the selection.

Parameters

rasterizeAllLayers

async : Promise<void>

Rasterizes all layers.

resizeCanvas

async : Promise<void>

Changes the size of the canvas, but does not change image size To change the image size, see resizeImage

// grow the canvas by 400px
let width = await document.width
let height = await document.height
await document.resizeCanvas(width + 400, height + 400)
CopyCopied to your clipboard
1// grow the canvas by 400px
2let width = await document.width
3let height = await document.height
4await document.resizeCanvas(width + 400, height + 400)

Parameters

resizeImage

async : Promise<void>

Changes the size of the image

await document.resizeImage(800, 600)
CopyCopied to your clipboard
await document.resizeImage(800, 600)

Parameters

revealAll

async : Promise<void>

Expands the document to show clipped sections.

rotate

async : Promise<void>

Rotates the image clockwise in given angle, expanding canvas if necessary. (Previously rotateCanvas)

Parameters

sampleColor

async : Promise<SolidColor | NoColor>

Returns a SolidColor object sampled from the document at the given position.

let col = await app.activeDocument.sampleColor({x: 100, y: 100});
console.log(col.rgb);
// {
//    red: 233,
//    green: 179,
//    blue: 135,
//    hexValue: "E9B387"
// }
CopyCopied to your clipboard
1let col = await app.activeDocument.sampleColor({x: 100, y: 100});
2console.log(col.rgb);
3// {
4//    red: 233,
5//    green: 179,
6//    blue: 135,
7//    hexValue: "E9B387"
8// }

Parameters

save

async : Promise<void>

Performs a save of the document. The user will be presented with a Save dialog if the file has yet to be saved on disk.

// To save a document in the current location
document.save()

// Shows the save dialog
unsavedDocument.save()
CopyCopied to your clipboard
1// To save a document in the current location
2document.save()
3
4// Shows the save dialog
5unsavedDocument.save()

splitChannels

async : Promise<Document[]>

Splits the document channels into separate, single-channel documents.

suspendHistory

Promise<void>

Creates a single history state encapsulating everything that is done in the callback, only for this document. All changes to the document should be done in this callback.

Note: If you make changes to any other document, those changes will not be suspended in the same history state.

The callback is passed in a SuspendHistoryContext object, which contains the current document in a variable document.

For more info and advanced context, see core.executeAsModal API, for which this API is a simple wrapper for.

   require("photoshop").app.activeDocument.suspendHistory(async (context) => {
       // context.document is the `app.activeDocument`
       context.document.activeLayers[0].name = "Changed name";
   });
CopyCopied to your clipboard
1   require("photoshop").app.activeDocument.suspendHistory(async (context) => {
2       // context.document is the `app.activeDocument`
3       context.document.activeLayers[0].name = "Changed name";
4   });

Parameters

trap

async : Promise<void>

Applies trapping to a CMYK document.

Valid only when Document.mode is Constants.DocumentMode.CMYK

Parameters

trim

async : Promise<void>

Trims the transparent area around the image on the specified sides of the canvas base on trimType

Parameters

Last updated 9/27/2022

Was this helpful?

Yes

No