Class Photoshop

The top level application object, root of the Photoshop DOM.

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

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/

Example

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

Properties

Action

Action: Action

Allows for polyfills into the Action class

ActionSet

ActionSet: ActionSet

Allows for polyfills into the Action Set class

batchPlay

batchPlay: (commands: any, options: any) => 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.

Type Declaration

- (commands: any, options: any): Promise<ActionDescriptor[]>
- Parameters
  - commands: any
    Array of action descriptors to execute.
  - options: any
    Options for batchPlay execution.
  Returns Promise<ActionDescriptor[]>

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#batchplay

Min Version

23.0

bringToFront

bringToFront: () => void

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

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#bringtofront

Min Version

23.0

ColorSampler

ColorSampler: ColorSampler

convertUnits

convertUnits: (
    fromValue: number,
    fromUnits: Units,
    toUnits: Units,
    resolution?: number,
) => 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);

Type Declaration

- (
      fromValue: number,
      fromUnits: Units,
      toUnits: Units,
      resolution?: number,
  ): number
- Parameters
  - fromValue: number
    The value that is to be converted.
  - fromUnits: Units
    The unit that the fromValue is in. Use Constants.Units for valid values.
  - toUnits: Units
    The unit that the return value is in. Use Constants.Units for valid values.
  - Optionalresolution: number
    The pixels per inch value to use when converting to and from pixel values.
  Returns number

Min Version

23.4

createDocument

createDocument: (options?: DocumentCreateOptions) => Promise<Document | null>

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.

Updates: (26.9)

Type Declaration

- (options?: DocumentCreateOptions): Promise<Document | null>
- Parameters
  - Optionaloptions: DocumentCreateOptions
    An object literal containing the option values.
  Returns Promise<Document | null>

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#createdocument

Example

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

Example

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

Example

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

Async

Min Version

23.0

currentDialogMode

currentDialogMode: DialogModes

Document

Document: Document

Allows for polyfills into the Document class

getColorProfiles

getColorProfiles: (colorMode?: string) => string[]

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

Type Declaration

- (colorMode?: string): string[]
- Parameters
  - OptionalcolorMode: string
    Specify which color mode's profiles to list. (default: "RGB", options: "Gray")
  Returns string[]

Min Version

24.1

Guide

Guide: Guide

Allows for polyfills into the Guide class

Layer

Layer: Layer

Allows for polyfills into the Layer class

LayerComp

LayerComp: LayerComp

Allows for polyfills into the LayerComp class

open

open: (entry?: File) => Promise<Document>

Opens the specified document and returns the model.

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

Type Declaration

- (entry?: File): Promise<Document>
- Parameters
  - Optionalentry: File
    File entry to open, or undefined to show the open dialog.
  Returns Promise<Document>

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#open

Example

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

Example

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

Async

Min Version

23.0

PathPointInfo

PathPointInfo: PathPointInfo

Photoshop

Photoshop: Photoshop

Allows for polyfills into the Application object

Selection

Selection: Selection

Allows for polyfills into the Selection class

showAlert

showAlert: (message: string) => Promise<void>

Shows an alert in Photoshop with the given message.

Type Declaration

- (message: string): Promise<void>
- Parameters
  - message: string
    The message to display in the alert.
  Returns Promise<void>

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#showalert

Min Version

23.0

SolidColor

SolidColor: typeof SolidColor

Exposes SolidColor class for constructing objects

SubPathInfo

SubPathInfo: SubPathInfo

updateUI

updateUI: () => 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.

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#updateui

Example

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

Async

Min Version

26.0

Accessors

actionTree

get actionTree(): ActionSet[]
Returns the action tree shown in Actions panel, as an array of ActionSets, each containing Actions.

Returns ActionSet[]
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#actiontree

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:132

activeDocument

get activeDocument(): Document
The current document that has the application's focus.

Returns Document
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#activedocument

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:106
set activeDocument(doc: Document): void
Set the current active document to the provided Document.
Parameters
- doc: Document
Returns void
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#activedocument

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:113

backgroundColor

get backgroundColor(): SolidColor
The background color and color style for documents. (24.2)

Returns SolidColor
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/photoshop/#backgroundcolor

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:176
set backgroundColor(color: SolidColor): void
Parameters
- color: SolidColor
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:177

currentTool

get currentTool(): Tool
Current selected tool. For now, the Tool class is an object with only an id field. In the future, we aim to provide tools with their own classes.

Returns Tool
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:125

displayDialogs

get displayDialogs(): DialogModes
The dialog mode for the application, which controls what types of dialogs should be displayed when your code is interacting with Photoshop.

Returns DialogModes
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:98
set displayDialogs(mode: DialogModes): void
Parameters
- mode: DialogModes
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:99

preferences

get preferences(): Preferences
Contains Photoshop preferences grouped into several categories similar to the Preferences dialog.

Returns Preferences
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:92

typename

get typename(): "Photoshop"
The class name of the referenced object: "Photoshop".

Returns "Photoshop"
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:79

validation

set validation(enable: boolean): void
Disabled validation checks, use at your own risk!
Parameters
- enable: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Photoshop.d.ts:83

Class Photoshop

See

Example

Index

Properties

Accessors

Properties

Action

ActionSet

batchPlay

Type Declaration

Parameters

Returns Promise<ActionDescriptor[]>

See

Min Version

bringToFront

See

Min Version

ColorSampler

convertUnits

Type Declaration

Parameters

Returns number

Min Version

createDocument

Type Declaration

Parameters

Returns Promise<Document | null>

See

Example

Example

Example

Async

Min Version

currentDialogMode

Document

getColorProfiles

Type Declaration

Parameters

Returns string[]

Min Version

Guide

Layer

LayerComp

open

Type Declaration

Parameters

Returns Promise<Document>

See

Example

Example

Async

Min Version

PathPointInfo

Photoshop

Selection

showAlert

Type Declaration

Parameters

Returns Promise<void>

See

Min Version

SolidColor

SubPathInfo

updateUI

See

Example

Async

Min Version

Accessors

actionTree

Returns ActionSet[]

See

Min Version

activeDocument

Returns Document

See

Min Version

Parameters

Returns void