Back to Uxp Photoshop

Constants

src/pages/ps_reference/modules/constants.md

2.2.046.7 KB
Original Source

Constants

To use any constant, import the constants object from the photoshop module first.

javascript
const {app, constants} = require("photoshop");

await app.activeDocument.resizeImage(
    800, 600, 100,
    constants.InterpolationMethod.AUTOMATIC
);

Enumerations

AnchorPosition

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The point around which to transform an object.

This is the point that does not move when an object is rotated or resized

NameDescription
BOTTOMCENTER-
BOTTOMLEFT-
BOTTOMRIGHT-
MIDDLECENTER-
MIDDLELEFT-
MIDDLERIGHT-
TOPCENTER-
TOPLEFT-
TOPRIGHT-

AntiAlias

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

Method to use to smooth edges by softening the color transition between edge pixels and the background. Used in a CharacterStyle.antiAliasMethod

NameDescription
CRISP-
NONE-
SHARP-
SMOOTH-
STRONG-

ApplyImageBlendMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.5</span>

The kind of blending used in a Layer.applyImage operation.

NameDescription
ADD-
COLORBURN-
COLORDODGE-
DARKEN-
DARKERCOLOR-
DIFFERENCE-
DIVIDE-
EXCLUSION-
HARDLIGHT-
HARDMIX-
LIGHTEN-
LIGHTERCOLOR-
LINEARBURN-
LINEARDODGE-
LINEARLIGHT-
MULTIPLY-
NORMAL-
OVERLAY-
PINLIGHT-
SCREEN-
SOFTLIGHT-
SUBTRACT-
VIVIDLIGHT-

ApplyImageChannel

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.5</span>

Special channels used in Layer.applyImage.

NameDescription
CMYK-
LAB-
RGB-
SELECTION-
TRANSPARENCY-

ApplyImageLayer

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.5</span>

Use merged layers as a source in Layer.applyImage.

NameDescription
MERGED-

AutoKernType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The type of kerning to use for characters. Used in CharacterStyle.autoKerning

NameDescription
MANUAL-
METRICS-
OPTICAL-

BMPDepthType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Number of bits per channel (also called pixel depth or color depth).

The number selected indicates the exponent of 2. With 8 bits per channel, we have 256 possible colors.

NameDescription
EIGHT-
FOUR-
ONE-
SIXTEEN-
THIRTYTWO-
TWENTYFOUR-

Baseline

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The baseline style to use in text. Used in CharacterStyle.baseline

NameDescription
NORMAL-
SUBSCRIPT-
SUPERSCRIPT-

BitmapConversionType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Specifies the quality of an image you are converting to bitmap mode. Used in BitmapConversionOptions

NameDescription
CUSTOMPATTERN-
DIFFUSIONDITHER-
HALFTHRESHOLD-
HALFTONESCREEN-
PATTERNDITHER-

BitmapHalfToneType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Specifies the shape of the dots (ink deposits) in the halftone screen. Used in BitmapConversionOptions

NameDescription
CROSS-
DIAMOND-
ELLIPSE-
LINE-
ROUND-
SQUARE-

BitsPerChannelType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

The number of bits per color channel.

NameDescription
EIGHT-
ONE-
SIXTEEN-
THIRTYTWO-

BlendMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Blending mode

NameDescription
COLOR-
COLORBURN-
COLORDODGE-
DARKEN-
DARKERCOLOR-
DIFFERENCE-
DISSOLVE-
DIVIDE-
EXCLUSION-
HARDLIGHT-
HARDMIX-
HUE-
LIGHTEN-
LIGHTERCOLOR-
LINEARBURN-
LINEARDODGE-
LINEARLIGHT-
LUMINOSITY-
MULTIPLY-
NORMAL-
OVERLAY-
PASSTHROUGH-
PINLIGHT-
SATURATION-
SCREEN-
SOFTLIGHT-
SUBTRACT-
VIVIDLIGHT-

CalculationsBlendMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.5</span>

The kind of blending used in a Document.calculations operation.

NameDescription
ADD-
COLORBURN-
COLORDODGE-
DARKEN-
DARKERCOLOR-
DIFFERENCE-
DIVIDE-
EXCLUSION-
HARDLIGHT-
HARDMIX-
LIGHTEN-
LIGHTERCOLOR-
LINEARBURN-
LINEARDODGE-
LINEARLIGHT-
MULTIPLY-
NORMAL-
OVERLAY-
PINLIGHT-
SCREEN-
SOFTLIGHT-
SUBTRACT-
VIVIDLIGHT-

CalculationsChannel

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.5</span>

Special channels used in Document.calculations.

NameDescription
GRAY-
SELECTION-
TRANSPARENCY-

CalculationsLayer

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.5</span>

Use merged layers as a source in [Document.calculations]].

NameDescription
MERGED-

CalculationsResult

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.5</span>

The result of Document.calculations can go into a new document, a new channel in the active document, or a new selection in the active document.

NameDescription
NEWCHANNEL-
NEWDOCUMENT-
SELECTION-

ChangeMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The new color profile or mode for a document, specified in Document.changeMode

NOTE: Color images must be changed to GRAYSCALE mode before you can change them to BITMAP mode.

NameDescription
BITMAP-
CMYK-
GRAYSCALE-
INDEXEDCOLOR-
LAB-
MULTICHANNEL-
RGB-

ChannelType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The type of a color channel.

NameDescription
COMPONENTSpecific to document color mode
MASKEDAREAAlpha channel where color indicates masked area
SELECTEDAREAAlpha channel where color indicates selected area
SPOTCOLORAlpha channel to store a spot color

CharacterAlignment

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The character alignment to use in text. Used in CharacterStyle.characterAlignment

NameDescription
EMBOXBOTTOMLEFT-
EMBOXCENTER-
EMBOXTOPRIGHT-
ICFBOTTOMLEFT-
ICFBOXTOPRIGHT-
ROMAN-

ColorBlendMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

The kind of blending used in a fill or stroke operation. Pass to PathItem.fillPath()

NameDescription
BEHIND-
CLEAR-
COLOR-
COLORBURN-
COLORDODGE-
DARKEN-
DARKERCOLOR-
DIFFERENCE-
DISSOLVE-
EXCLUSION-
HARDLIGHT-
HARDMIXBLEND-
HUE-
LIGHTEN-
LIGHTERCOLOR-
LINEARBURN-
LINEARDODGE-
LINEARLIGHT-
LUMINOSITY-
MULTIPLY-
NORMAL-
OVERLAY-
PINLIGHT-
SATURATION-
SCREEN-
SOFTLIGHT-
VIVIDLIGHT-

ColorModel

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The color model representing the current color space of a SolidColor object.

NameDescription
CMYK-
GRAYSCALE-
HSB-
LAB-
NONE-
RGB-

ColorPicker

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The provider of the color picker dialog. Pass to PreferencesGeneral.colorPicker

NameDescription
ADOBEThe Adobe Photoshop Color Picker.
OSNATIVEThe built-in Apple or Windows color picker.
PLUGINA plugin-provided color picker. The`pluginID` property must be provided in the PreferencesGeneral.colorPicker argument object and must contain the internal ID of the plugin as a string.

ColorProfileType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Type of color profile used to manage a document, used in Document.colorProfileType

NameDescription
CUSTOMSet for all custom profiles
NONESet when document is not color managed
WORKINGSet when document uses the working color profile

CreateFields

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The method used for creating fields. Pass to Layer.applyDeInterlace.

NameDescription
DUPLICATION-
INTERPOLATION-

DepthMapSource

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The source to use for the depth map. Pass to Layer.applyLensBlur().

NameDescription
IMAGEHIGHLIGHT-
LAYERMASK-
NONE-
TRANSPARENCYCHANNEL-

DialogModes

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Controls the type of dialogs Photoshop displays during API calls

NameDescription
ALLAll dialogs will be shown
ERRORDialogs will be shown only if Photoshop raises an error
NONEAll dialogs will be hidden, and bad calls will silently fail

Direction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Used in multiple places to represent orientation.

Orientation of a guide in Guide.direction

NameDescription
HORIZONTAL-
VERTICAL-

DisplacementMapType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

Describes how the displacement map fits the image if the image is not the same size as the map. Pass to Layer.applyDisplace.

NameDescription
STRETCHTOFIT-
TILE-

Dither

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The type of dithering

NameDescription
DIFFUSION-
NOISE-
NONE-
PATTERN-

DocumentFill

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Fill methods available for the new document background

NameDescription
BACKGROUNDCOLOR-
BLACK-
COLOR-
TRANSPARENT-
WHITE-

DocumentMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Color mode of an open document. See also Document.mode and Document.changeMode

NameDescription
BITMAP-
CMYK-
DUOTONE-
GRAYSCALE-
INDEXEDCOLOR-
LAB-
MULTICHANNEL-
RGB-

EditLogItemsType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The history log edit options. Pass to PreferencesHistory.editLogItems

NameDescription
CONCISEIncludes the text that appears in the History panel in addition to the Sessions information.
DETAILEDIncludes the text that appears in the Actions panel in addition to the Concise information. If you need a complete history of all changes made to files, choose Detailed.
SESSIONONLYKeeps a record of each time you start or quit Photoshop and each time you open and close files (each image’s filename is included). Does not include any information about edits made to the file.

ElementPlacement

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Placement modes for Layer.move method

NameDescription
PLACEAFTERPlace below a layer, below group if group layer
PLACEATBEGINNINGPlace at the top
PLACEATENDPlace at the bottom, above background if background layer exists
PLACEBEFOREPlace above a layer, above group if group layer
PLACEINSIDEPlace inside a group layer, throws error if not group layer

EliminateFields

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The type of field to eliminate. Pass to Layer.applyDeInterlace.

NameDescription
EVENFIELDS-
ODDFIELDS-

FlipAxis

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

Axis (or both) to flip a layer on. Pass to Layer.flip().

NameDescription
BOTH-
HORIZONTAL-
VERTICAL-

FontSize

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

Font size in panels and dialogs. Pass to PreferencesInterface.textFontSize

NameDescription
LARGELarge size.
MEDIUMMedium size.
SMALLSmall size.
TINYTiny size.

ForcedColors

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The type of colors to be included the color table regardless of their usage

NameDescription
BLACKANDWHITEPure black and pure white
NONENone
PRIMARIESRed, green, blue, cyan, magenta, yellow, black, and white.
WEBThe 216 web-safe colors

GenerativeUpscaleModel

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">27.2</span>

The generative upscale model to use for AI-powered upscaling.

Pass to Document.generativeUpscale()

NameDescription
FIREFLYAdobe Firefly generative upscale model

Geometry

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

Geometric options for shapes, such as the iris shape in the Lens Blur filter. Pass to Layer.applyLensBlur().

NameDescription
HEPTAGON-
HEXAGON-
OCTAGON-
PENTAGON-
SQUARE-
TRIANGLE-

GridLineStyle

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The line style for nonprinting grids displayed over images. Pass to PreferencesGuidesGridsAndSlices.gridStyle

NameDescription
DASHED-
DOTTED-
SOLID-

GridSize

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The size of grid squares. Pass to PreferencesTransparencyAndGamut.gridSize

NameDescription
LARGELarge grid squares.
MEDIUMMedium grid squares.
NONENo grid is displayed.
SMALLSmall grid squares.

GuideLineStyle

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The line style for nonprinting guides displayed over images. Pass to PreferencesGuidesGridsAndSlices.guideStyle

NameDescription
DASHED-
SOLID-

Intent

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The rendering intent to use when converting from one color space to another with Document.convertProfile

NameDescription
ABSOLUTECOLORIMETRIC-
PERCEPTUAL-
RELATIVECOLORIMETRIC-
SATURATION-

InterpolationMethod

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The method to use for bitmap interpolation.

Pass to

NameDescription
AUTOMATICChoose best bicubic option automatically
BICUBICBicubic interpolation
BICUBICSHARPERApply a sharpening mask
BICUBICSMOOTHERApply a smoothing mask
BILINEARBilinear interpolate
NEARESTNEIGHBORDetermine value based on nearest neighbor

JPEGFormatOptions

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The option with which to save a JPEG file.

NameDescription
OPTIMIZEDBASELINEOptimized color and a slightly reduced file size.
PROGRESSIVEDisplays a series of increasing detailed scans as the image downloads.
STANDARDBASELINEFormat recognized by most web browsers.

Justification

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The placement of paragraph text within the bounding box. Used in ParagraphStyle.justification

NameDescription
CENTER-
CENTERJUSTIFIED-
FULLYJUSTIFIED-
LEFT-
LEFTJUSTIFIED-
RIGHT-
RIGHTJUSTIFIED-

KashidaWidthType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The width of kashida (tatweel) character Used in ParagraphStyle.kashidaWidth

NameDescription
LONG-
MEDIUM-
NONE-
SHORT-
STYLISTIC-

Kinsoku

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

Line breaking rules in Japanese text Used in ParagraphStyle.kinsoku

NameDescription
JISMAXIMUM-
JISWEAK-
NONE-

LabelColors

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Options for layer list label colors

NameDescription
BLUE-
GRAY-
GREEN-
NONE-
ORANGE-
RED-
VIOLET-
YELLOW-

Language

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The language to use for text. Used in CharacterStyle.language

NameDescription
ARABIC-
BANGLAINDIA-
BRAZILLIANPORTUGUESE-
BULGARIAN-
BURMESE-
CANADIANFRENCH-
CATALAN-
CHINESE-
CROATIAN-
CZECH-
DANISH-
DUTCH-
ENGLISHCANADA-
ENGLISHUK-
ENGLISHUSA-
ESTONIAN-
FINNISH-
FRENCH-
GERMAN-
GERMAN1996-
GREEK-
GUJARATI-
HEBREW-
HINDI-
HUNGARIAN-
ICELANDIC-
INDONESIAN-
ITALIAN-
JAPANESE-
KANNADA-
KHMER-
LAO-
LATVIAN-
LITHUANIAN-
MALAYALAM-
MARATHI-
NORWEGIAN-
NYNORSKNORWEGIAN-
ODIA-
OLDDUTCH-
OLDGERMAN-
OLDSWISSGERMAN-
POLISH-
PORTUGUESE-
PUNJABI-
ROMANIAN-
RUSSIAN-
SERBIAN-
SINHALESE-
SLOVAK-
SLOVENIAN-
SPANISH-
SWEDISH-
SWISSGERMAN-
TAMIL-
TELUGU-
THAI-
TURKISH-
UKRAINIAN-

LayerKind

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Kinds of document layers, including adjustment layers. Grain and Clarity are new in Photoshop 27.4.

NameDescription
BLACKANDWHITEBlack & White adjustment
BRIGHTNESSCONTRASTBrightness/Contrast adjustment
CHANNELMIXERChannel Mixer adjustment
CLARITYClarity and dehaze adjustment
COLORBALANCEColor Balance adjustment
COLORLOOKUPColor Lookup adjustment
CURVESCurves adjustment
EXPOSUREExposure adjustment
GRADIENTFILLGradient
GRADIENTMAPGradient Map adjustment
GRAINGrain adjustment
GROUPLayer group
HUESATURATIONHue/Saturation adjustment
INVERSIONInvert adjustment
LAYER3D3D
LEVELSLevels adjustment
NORMALRaster (pixel)
PATTERNFILLPattern
PHOTOFILTERPhoto Filter adjustment
POSTERIZEPosterize adjustment
SELECTIVECOLORSelective Color adjustment
SMARTOBJECTSmart object
SOLIDFILLSolid Color
TEXTText
THRESHOLDThreshold adjustment
VIBRANCEColor and vibrance adjustment
VIDEOVideo

LensType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The type of Lens to use. Pass to Layer.applyLensFlare().

NameDescription
MOVIEPRIME-
PRIME105-
PRIME35-
ZOOMLENS-

MatteColor

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The color to use to fill anti-aliased edges adjacent to transparent areas of the image. When transparency is turned off for an image, the matte color is applied to transparent areas.

NameDescription
BACKGROUND-
BLACK-
FOREGROUND-
NETSCAPE-
SEMIGRAY-
WHITE-

MaximizeCompatibility

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The permission state for queries. Pass to PreferencesFileHandling.maximizeCompatibility

NameDescription
ALWAYSAlways maximize compatibility.
ASKAlways ask about maximize compatibility.
NEVERNever ask about maximize compatibility.

MiddleEasternDigitsType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

Digit type to use in text (Middle Eastern features). Used in CharacterStyle.middleEasternDigitsType

NameDescription
FARSI-
HINDI-
LTRARABIC-
RTLARABIC-

MiddleEasternTextDirection

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

Text flow direction (Middle Eastern features). Used in CharacterStyle.middleEasternTextDirection

NameDescription
DEFAULT-
LEFTTORIGHT-
RIGHTTOLEFT-

Mojikumi

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

Spacing between punctuation, symbols, numbers, and other character classes in Japanese text Used in ParagraphStyle.mojikumi

NameDescription
NONE-
SET1-
SET2-
SET3-
SET4-

NewDocumentMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Color Modes available for new document

NameDescription
BITMAP-
CMYK-
GRAYSCALE-
LAB-
RGB-

NoiseDistribution

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

Distribution model to use when applying an Add Noise filter. Pass to Layer.applyAddNoise.

NameDescription
GAUSSIAN-
UNIFORM-

OffsetUndefinedAreas

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

Method to use to fill the empty space left by offsetting an image or selection. Pass to Layer.applyOffset()

NameDescription
REPEATEDGEPIXELS-
SETTOBACKGROUND-
WRAPAROUND-

OperatingSystem

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The target operating system in BMPSaveOptions.

NameDescription
OS2-
WINDOWS-

Orientation

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

Used in multiple places to represent orientation e.g., TextItem.orientation

NameDescription
HORIZONTAL-
VERTICAL-

OtherCursors

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The style of the cursors for the following tools: Marquee, Lasso, Polygonal Lasso, Magic Wand, Crop, Slice, Patch Eyedropper, Pen, Gradient, Line, Paint Bucket, Magnetic Lasso, Magnetic Pen, Freeform Pen, Measure, and Color Sampler. Pass to PreferencesCursors.otherCursors

NameDescription
PRECISEUse crosshair cursors for tools.
STANDARDUse small iconic cursors for tools.

PNGMethod

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

Compression method for saving a PNG file

NameDescription
MODERATE-
QUICK-
THOROUGH-

PaintingCursors

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The style of the cursors for the following tools: Eraser, Pencil, Paintbrush, Healing Brush, Rubber Stamp, Pattern Stamp, Smudge, Blur, Sharpen, Dodge, Burn, Sponge. Pass to PreferencesCursors.paintingCursors

NameDescription
BRUSHSIZEDisplays cursors as brush shapes representing the size of the current brush where boundaries have 50% brush opacity
FULLSIZEUse the full size of the brush regardless of brush opacity
PRECISEUse crosshair cursors when painting.
STANDARDUse small iconic cursors when painting.

Palette

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The palette type to use

NameDescription
EXACT-
LOCALADAPTIVE-
LOCALPERCEPTUAL-
LOCALSELECTIVE-
MACOSPALETTE-
MASTERADAPTIVE-
MASTERPERCEPTUAL-
MASTERSELECTIVE-
PREVIOUSPALETTE-
UNIFORM-
WEBPALETTE-
WINDOWSPALETTE-

ParagraphFeatures

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The paragraph features to use in text. Used in ParagraphStyle.features

NameDescription
DEFAULT-
EASTASIAN-
MIDDLEASTERN-

ParagraphLayout

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The paragraph layout to use in text. Used in ParagraphStyle.layoutMode

NameDescription
LATINEASTASIAN-
WORLDREADY-

PathKind

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The type of a PathItem

NameDescription
CLIPPINGPATH-
DUPLICATE-
INTERPOLATE-
NORMALPATH-
TEXTMASK-
VECTORMASK-
WORKPATH-

PointKind

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

The role a PathPoint plays in a PathItem

NameDescription
CORNERPOINT-
SMOOTHPOINT-

PointType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The point/pica size: either 72 or 72.27 points per inch. Pass to PreferencesUnitsAndRulers.pointSize

NameDescription
POSTSCRIPT72 points per inch.
TRADITIONAL72.27 points per inch.

PolarConversionType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The kind of polar conversion. Pass to Layer.applyPolarCoordinates().

NameDescription
POLARTORECTANGULARThe distortion applied will take the input pixel grid as polar coordinates and convert them to rectangular coordinates.
RECTANGULARTOPOLARThe distortion applied will take the input pixel grid as rectangular coordinates and convert them to polar coordinates.

PreserveShape

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

Favor the promotion of either corners or curves. Pass to Layer.applyMaximum() and Layer.applyMinimum().

NameDescription
ROUNDNESS-
SQUARENESS-

RasterizeType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The type of layer to get rasterized.

NameDescription
ENTIRELAYER-
FILLCONTENT-
LAYERCLIPPINGPATH-
LAYERSTYLE-
LINKEDLAYERS-
PLACED-
SHAPE-
TEXTCONTENTS-
VECTORMASK-
VIDEO-

ResampleMethod

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The method to use for document interpolation

Pass to Document.resizeImage()

NameDescription
AUTOMATICChoose best bicubic option automatically
BICUBICBicubic interpolation
BICUBICSHARPERApply a sharpening mask
BICUBICSMOOTHERApply a smoothing mask
BILINEARBilinear interpolate
DEEPUPSCALEUsing deep learning, predict what the picture will look like larger.
NEARESTNEIGHBORDetermine value based on nearest neighbor
NONEChanges image resolution value without affecting document dimension Currently unsupported
PRESERVEDETAILSAttempt to preserve details by using machine learning

RippleSize

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The size of undulations. Pass to Layer.applyRipple().

NameDescription
LARGE-
MEDIUM-
SMALL-

RulerUnits

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The measurement unit for ruler increments. Pass to PreferencesUnitsAndRulers.rulerUnits

NameDescription
CENTIMETERS-
INCHES-
MILLIMETERS-
PERCENT-
PICAS-
PIXELS-
POINTS-

SampleSize

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

Sample size for the EyeDropper tool and ColorSampler instances.

NameDescription
POINTSAMPLE-
SAMPLE101X101-
SAMPLE11X11-
SAMPLE31X31-
SAMPLE3X3-
SAMPLE51X51-
SAMPLE5X5-

SaveLogItemsType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

Options for logging the history items. Pass to PreferencesHistory.saveLogItems

NameDescription
LOGFILESave history log in a text file.
LOGFILEANDMETADATASave history log in file metadata and a text file.
METADATASave history log in file metadata.

SaveMethod

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The type of save operation.

NameDescription
SAVESaves the current document at the current format.
SAVEASChanges the format of document, changing the file.
SAVEASCOPYCreates a copy of the document in the new format.

SaveOptions

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

The policy for handling new changes upon closing a document.

NameDescription
DONOTSAVECHANGESWill close document without saving, discarding changes
PROMPTTOSAVECHANGESWill ask the user if they'd like to save changes, blocking the script
SAVECHANGESWill save all existing changes before closing, prompting if document is not saved yet

SavePreview

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The application's behavior regarding image previews. Pass to PreferencesFileHandling.imagePreviews

NameDescription
ALWAYSSAVEAlways save the item with the file.
ASKWHENSAVINGPrompt the user whether to save the item with the file.
NEVERSAVENever save the item with the file.

SelectionType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

The selection behavior when a selection already exists. Used in PathItem.makeSelection(), Selection.saveTo() and Selection.load()

NameDescription
DIMINISHRemove the selection from the already selected area
EXTENDAdd the selection to an already selected area
INTERSECTMake the selection only the area where the new selection intersectes the already selected area
REPLACEReplace the selected area

ShapeOperation

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

How to combine the shapes if the destination path already has a selection.

Set for SubPathInfo.operation, stored in the resulting SubPathItem

NameDescription
SHAPEADD-
SHAPEINTERSECT-
SHAPESUBTRACT-
SHAPEXOR-

SmartBlurMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The method to use for smart blurring. Pass to Layer.applySmartBlur().

NameDescription
EDGEONLY-
NORMAL-
OVERLAYEDGE-

SmartBlurQuality

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The smart blur quality. Pass to Layer.applySmartBlur().

NameDescription
HIGH-
LOW-
MEDIUM-

SpherizeMode

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The curve (or stretch shape) to use for the distortion. Pass to Layer.applySpherize().

NameDescription
HORIZONTAL-
NORMAL-
VERTICAL-

StrikeThrough

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The text strikethrough style to use in text. Used in CharacterStyle.strikeThrough

NameDescription
STRIKEBOX-
STRIKEHEIGHT-
STRIKEOFF-

TextCase

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The capitalization style to use in text. Used in CharacterStyle.capitalization

NameDescription
ALLCAPS-
NORMAL-
SMALLCAPS-

TextureType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The type of texture or glass surface image to load for a texturizer or glass filter. Pass to Layer.applyGlassEffect().

NameDescription
BLOCKS-
CANVAS-
FROSTED-
TINYLENS-

ToolType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

The tool to use with PathItem.strokePath()

NameDescription
ARTHISTORYBRUSH-
BACKGROUNDERASER-
BLUR-
BRUSH-
BURN-
CLONESTAMP-
COLORREPLACEMENTTOOL-
DODGE-
ERASER-
HEALINGBRUSH-
HISTORYBRUSH-
PATTERNSTAMP-
PENCIL-
SHARPEN-
SMUDGE-
SPONGE-

TrimType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.0</span>

Type of pixels to trim around an image, passed to Document.trim.

NameDescription
BOTTOMRIGHTThe color of the pixel in the bottom right corner of the image.
TOPLEFTThe color of the pixel in the top left right corner of the image.
TRANSPARENTFully transparent pixels.

TypeInterfaceFeatures

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

Options for changing user interface of Character and Paragraph panels. This option is not in Preferences dialog but instead it is located in: Main menu > Type > Language Options Pass to PreferencesType.showTextFeatures

NameDescription
DEFAULT-
EASTASIAN-
MIDDLEEASTERN-

TypeUnits

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

The measurement unit for type. Pass to PreferencesUnitsAndRulers.typeUnits

NameDescription
MILLIMETERS-
PIXELS-
POINTS-

UndefinedAreas

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

How to treat undistorted areas or areas left blank in an image to which a filter in the Distort category has been applied. Pass to Layer.applyDisplace(), Layer.applyShear(), Layer.applyWave()

NameDescription
REPEATEDGEPIXELS-
WRAPAROUND-

Underline

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The underline style to use in text. Used in CharacterStyle.underline

NameDescription
LEFTINVERTICAL-
NONE-
RIGHTINVERTICAL-

Units

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.4</span>

Valid Units for convertUnits method, used in Photoshop.convertUnits

NameDescription
CM-
INCHES-
MM-
PICAS-
PIXELS-
POINTS-

WarpStyle

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.1</span>

The warp style to use with Text. Used in a WarpStyle.style

NameDescription
ARC-
ARCH-
ARCLOWER-
ARCUPPER-
BULGE-
FISH-
FISHEYE-
FLAG-
INFLATE-
NONE-
RISE-
SHELLLOWER-
SHELLUPPER-
SQUEEZE-
TWIST-
WAVE-

WaveType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The type of wave. Pass to Layer.applyWave().

NameDescription
SINE-
SQUARE-
TRIANGULAR-

ZigZagType

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.5</span>

The method of zigzagging. Pass to Layer.applyZigZag().

NameDescription
AROUNDCENTER-
OUTFROMCENTER-
PONDRIPPLES-