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>

创建一个新的文件。

没有选项将创建一个每英寸300像素的7×5英寸的文档。 这与 "Photoshop默认尺寸 "的预设相同。

一个带有 "预设 "字符串参数的对象可以用来指定任何 其他预设，这些预设随Photoshop安装或由用户创建。

一个带有一个或多个参数的对象也可以被提供。任何参数 缺少将被设置为默认的：宽度2100像素，高度1500像素。 分辨率300像素/英寸，模式。模式：@RGBColorMode和白色填充，无透明度。 无透明度。

// "默认的Photoshop大小 "7x5英寸，300ppi
let newDoc1 = await app.documents.add();
let newDoc2 = await app.documents.add({
   width: 800, 
   height: 600, 
   resolution: 300, 
   mode: "RGBColorMode", 
   fill: "transparent"
});
let newDoc3 = await app.documents.add({preset: "My Default Size 1"});
CopyCopied to your clipboard
1// "默认的Photoshop大小 "7x5英寸，300ppi
2let newDoc1 = await app.documents.add();
3let newDoc2 = await app.documents.add({
4   width: 800, 
5   height: 600, 
6   resolution: 300, 
7   mode: "RGBColorMode", 
8   fill: "transparent"
9});
10let newDoc3 = await app.documents.add({preset: "My Default Size 1"});

Parameters

getColorProfiles

string[]

已安装的颜色配置文件列表，适用于RGB和灰度模式。

Parameters

open

async : Promise<Document>

Opens the specified document and returns the model

*注意，这个API需要一个UXPFileEntry 作为其参数的对象。

// 打开一个已选定的文件
let entry = await require('uxp').storage.localFileSystem.getFileForOpening()
const document = await app.open(entry);

// 显示打开文件的对话框
const document = await app.open();
CopyCopied to your clipboard
1// 打开一个已选定的文件
2let entry = await require('uxp').storage.localFileSystem.getFileForOpening()
3const document = await app.open(entry);
4
5// 显示打开文件的对话框
6const document = await app.open();

Parameters

showAlert

Promise<void>

在Photoshop中显示一个带有确定信息的警告。

Parameters