photoshopAction

The module that facilitates Actions being performed in the UXP-Photoshop world. You may perform your own batchPlay commands, or attach listeners using this module.

var PhotoshopAction = require('photoshop').action;
CopyCopied to your clipboard
var PhotoshopAction = require('photoshop').action;

Functions

addNotificationListener

Promise<void>

Attach a listener to a Photoshop event. A callback in the form of (eventName: string, descriptor: Descriptor) => void will be performed.

await PhotoshopAction.addNotificationListener(['open'], onOpenNewDocument)
CopyCopied to your clipboard
await PhotoshopAction.addNotificationListener(['open'], onOpenNewDocument)

Parameters

batchPlay

Promise<ActionDescriptor[]>

Performs a batchPlay call with the provided commands. Equivalent to an executeAction in ExtendScript.

var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
var commands = [{ _obj: 'hide', _target: target }]
await PhotoshopAction.batchPlay(commands)
CopyCopied to your clipboard
1var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
2var commands = [{ _obj: 'hide', _target: target }]
3await PhotoshopAction.batchPlay(commands)

Parameters

batchPlaySync

ActionDescriptor[]

Performs a batchPlay call with the provided commands. Equivalent to an executeAction in ExtendScript.

var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
var commands = [{ _obj: 'hide', _target: target }]
await PhotoshopAction.batchPlay(commands)
CopyCopied to your clipboard
1var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
2var commands = [{ _obj: 'hide', _target: target }]
3await PhotoshopAction.batchPlay(commands)

Parameters

getIDFromString

number

Return the identifier number assigned to an action string value. If the string is not already registered, a new ID will be created and returned.

Parameters

recordAction

Promise<void>

Records this plugin's action to an active Action recording. See Action Recording for usage and manifest requirements.

await PhotoshopAction.recordAction("name": "My Command", methodName: "actionHandler", info: {"prop": value})
CopyCopied to your clipboard
await PhotoshopAction.recordAction("name": "My Command", methodName: "actionHandler", info: {"prop": value})

When the action is invoked, the following top level JavaScript function will be invoked:

async function actionHandler(executionContext, info) {
    let propValue = info["prop"];
}
CopyCopied to your clipboard
1async function actionHandler(executionContext, info) {
2    let propValue = info["prop"];
3}

Parameters

removeNotificationListener

Promise<void>

Detaches a listener from a Photoshop event. See addNotificationListener

await PhotoshopAction.removeNotificationListener(['open'], onOpenNewDocument)
CopyCopied to your clipboard
await PhotoshopAction.removeNotificationListener(['open'], onOpenNewDocument)

Parameters

validateReference

boolean

Synchronously validates the given action reference, returning true if it still exists. For example, calling this with a closed document would return false.

This feature is intended for advanced developers who understand well how batchPlay works. Validate reference could get handy when you want to add new DOM functionality or use low-level code for performance optimization.

See Action references for details.

Supported reference classes: action, document, channel, layer, guide, historyState, compsClass, path, actionSet

Parameters

Last updated 2/8/2022

Was this helpful?

Yes

No