The module that allows access to specialized commands within the application. Various application state can be modified or queried here.

Copy
var PhotoshopCore = require('photoshop').core;
Copied to your clipboard
var PhotoshopCore = require('photoshop').core;

Index

Functions

• calculateDialogSize
• endModalToolState
• getActiveTool
• getMenuCommandState
• getMenuCommandTitle
• performMenuCommand
• showAlert

Functions

calculateDialogSize

▸ calculateDialogSize(preferredSize: object, identifier?: string, minimumSize?: object): Promise‹object›

Returns the effective size of a dialog.

Copy
var idealSize = { width: 200, height: 500 }
{ width, height} = await PhotoshopCore.calculateDialogSize(idealSize)
Copied to your clipboard
var idealSize = { width: 200, height: 500 }
{ width, height} = await PhotoshopCore.calculateDialogSize(idealSize)

Parameters:

▪ preferredSize: object

▪Optional identifier: string

▪Optional minimumSize: object

endModalToolState

▸ endModalToolState(commit: boolean): Promise‹void›

End the current modal tool editing state.

Copy
// close the modal dialog, cancelling changes
await PhotoshopCore.endModalToolState(false)
Copied to your clipboard
// close the modal dialog, cancelling changes
await PhotoshopCore.endModalToolState(false)

Parameters:

getActiveTool

▸ getActiveTool(): Promise‹object›

Returns information about the active Photoshop tool.

Copy
{ title } = await PhotoshopCore.getActiveTool()
Copied to your clipboard
{ title } = await PhotoshopCore.getActiveTool()

getMenuCommandState

▸ getMenuCommandState(options: object): Promise‹boolean›

Returns whether a command menu item is available for invoking.

Copy
// can a Fill be performed?
var canFill = await PhotoshopCore.getMenuCommandState({ commandID: 1042 })
Copied to your clipboard
// can a Fill be performed?
var canFill = await PhotoshopCore.getMenuCommandState({ commandID: 1042 })

Parameters:

▪ options: object

getMenuCommandTitle

▸ getMenuCommandTitle(options: object): Promise‹string›

Returns the localized menu title of the menu command item.

Copy
var renameLayerStr = await PhotoshopCore.getMenuCommandTitle({ commandID: 2983 })
Copied to your clipboard
var renameLayerStr = await PhotoshopCore.getMenuCommandTitle({ commandID: 2983 })

Parameters:

▪ options: object

performMenuCommand

▸ performMenuCommand(options: object): Promise‹boolean›

Invokes the menu command via its commandID. Returns false on failure, or if the command is not available.

Copy
// select all
await PhotoshopCore.performMenuCommand({ commandID: 1017 })
Copied to your clipboard
// select all
await PhotoshopCore.performMenuCommand({ commandID: 1017 })

Parameters:

▪ options: object

showAlert

▸ showAlert(options: object): Promise‹void›

Show a generic alert box to the user. 'OK' to dismiss.

Copy
// script has completed.
await PhotoshopCore.showAlert({ message: 'Operation successful'})
Copied to your clipboard
// script has completed.
await PhotoshopCore.showAlert({ message: 'Operation successful'})

Parameters:

▪ options: object

Last updated 9/29/2021

Was this helpful?

Yes

No