Photoshop

The top level application object, root of the Photoshop DOM

const {app} = require('photoshop');

From here you can access open documents, tools, UI elements and run commands or menu items.

Properties

Methods

batchPlay

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

<br/> Promise<ActionDescriptor[]>

At the heart of all our APIs is batchPlay. It is the evolution of executeAction. It accepts ActionDescriptors deserialized from JS objects, and can play multiple descriptors sequentially without updating the UI. This API is subject to change and may be accessible in other ways in the future.

Parameters

bringToFront

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

<br/> void

Brings application to focus, useful when your script ends, or requires an input.

convertUnits

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.4</span>

<br/> number

Convert the given value from one unit to another. Available units are: Constants.Units.{CM, MM, INCHES, PIXELS, POINTS, PICAS}. Use Document.resolution when converting from or to PIXELS. For example, use this routine for converting a document's width from pixels to inches.

// convert the current document's width to inches
const exportDoc = psApp.activeDocument;
let widthInInches = psApp.convertUnits(exportDoc.width, 
                                       Constants.Units.PIXELS, 
                                       Constant.Units.INCHES, 
                                       exportDoc.resolution);

Parameters

createDocument

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

<br/> async : Promise<Document>

Create a new document.

No options will create a document of 7 x 5 inches at 300 pixels per inch. This is the same as the "Default Photoshop Size" preset.

An object with a 'preset' string parameter can be used to specify any of the other presets that come installed with Photoshop or created by users.

An object with one or more parameters can also be supplied. Any parameter missing will be set to the default of: width 2100 pixels, height 1500 pixels, resolution 300 pixels per inch, mode: RGB, and a fill of white with no transparency.

// "Default Photoshop Size" 7x5 inches at 300ppi
let defaultDoc = await app.createDocument({
  preset: "Default Photoshop Size"
});

let transparentDoc = await app.createDocument({
  width: 800, 
  height: 600, 
  resolution: 300, 
  mode: "RGBColorMode", 
  fill: "transparent"
});

const redColor = new SolidColor();
redColor.rgb.green = 0;
redColor.rgb.blue = 0;
let fillColorDoc = await app.createDocument({
  mode: "RGBColorMode", 
  fillColor: redColor
});

Updates: (26.9)

Parameters

getColorProfiles

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

<br/> string[]

List of installed color profiles, for RGB and Gray modes.

Parameters

open

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

<br/> async : Promise<Document>

Opens the specified document and returns the model

*Note that this API requires a UXPFileEntry object as its argument.

// Open a file given entry
let entry = await require('uxp').storage.localFileSystem.getFileForOpening()
const document = await app.open(entry);

// Show open file dialog
const document = await app.open();

Parameters

showAlert

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

<br/> Promise<void>

Shows an alert in Photoshop with the given message.

Parameters

updateUI

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">26.0</span>

<br/> async : Promise<void>

Force an update to the following panels: Layers, Channels, and Paths. The primary use case is within the handler function of a slider control. Normally, the panels will not update until after the handle is released. Note: this function will have no apparent effect outside of a tracking context like a slider handle. Inside a plain loop (encapsulated in executeAsModal), a slight pause can be used to demonstrate the need to refresh.

    // Inside slider handler function.
    await app.activeDocument.createPixelLayer();
    await app.updateUI();