Photoshop

The top level application object, root of the Photoshop DOM

const app = require('photoshop').app
CopyCopied to your clipboard
const app = require('photoshop').app

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

Properties

Methods

batchPlay

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

void

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

convertUnits

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);

CopyCopied to your clipboard
1// convert the current document's width to inches
2const exportDoc = psApp.activeDocument;
3let widthInInches = psApp.convertUnits(exportDoc.width, 
4                                       Constants.Units.PIXELS, 
5                                       Constant.Units.INCHES, 
6                                       exportDoc.resolution);
7

Parameters

createDocument

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: @RGBColorMode and a fill of white with no transparency.

// "Default Photoshop Size" 7x5 inches at 300ppi
let newDoc1 = await app.createDocument();
let newDoc2 = await app.createDocument({
   width: 800, 
   height: 600, 
   resolution: 300, 
   mode: "RGBColorMode", 
   fill: "transparent"
});
let newDoc3 = await app.createDocument({preset: "My Default Size 1"});
CopyCopied to your clipboard
1// "Default Photoshop Size" 7x5 inches at 300ppi
2let newDoc1 = await app.createDocument();
3let newDoc2 = await app.createDocument({
4   width: 800, 
5   height: 600, 
6   resolution: 300, 
7   mode: "RGBColorMode", 
8   fill: "transparent"
9});
10let newDoc3 = await app.createDocument({preset: "My Default Size 1"});

Parameters

getColorProfiles

string[]

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

Parameters

open

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();
CopyCopied to your clipboard
1// Open a file given entry
2let entry = await require('uxp').storage.localFileSystem.getFileForOpening()
3const document = await app.open(entry);
4
5// Show open file dialog
6const document = await app.open();

Parameters

showAlert

Promise<void>

Shows an alert in Photoshop with the given message.

Parameters

Last updated 6/24/2022

Was this helpful?

Yes

No