Edit in GitHubLog an issue

Constants

Enumerations#

AnchorPosition#

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-

BMPDepthType#

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

The number selected indicates the exponent of 2.

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

BitmapConversionType#

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

NameDescription
CUSTOMPATTERN-
DIFFUSIONDITHER-
HALFTHRESHOLD-
HALFTONESCREEN-
PATTERNDITHER-

BitmapHalfToneType#

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

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

BitsPerChannelType#

The number of bits per color channel.

NameDescription
EIGHT-
ONE-
SIXTEEN-
THIRTYTWO-

BlendMode#

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-

ChangeMode#

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#

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

ColorModel#

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

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

ColorProfileType#

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

DialogModes#

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#

Used in multiple places to represent orientation.

Orientation of a guide in Guide.direction

NameDescription
HORIZONTAL-
VERTICAL-

Dither#

The type of dithering

NameDescription
DIFFUSION-
NOISE-
NONE-
PATTERN-

DocumentFill#

Fill methods available for the new document background

NameDescription
BACKGROUNDCOLOR-
BLACK-
COLOR-
TRANSPARENT-
WHITE-

DocumentMode#

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

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

ElementPlacement#

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

ForcedColors#

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

Intent#

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

NameDescription
ABSOLUTECOLORIMETRIC-
PERCEPTUAL-
RELATIVECOLORIMETRIC-
SATURATION-

JPEGFormatOptions#

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.

LabelColors#

Options for layer list label colors

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

LayerKind#

Kinds of different layers in a document

NameDescription
BLACKANDWHITE-
BRIGHTNESSCONTRAST-
CHANNELMIXER-
COLORBALANCE-
COLORLOOKUP-
CURVES-
EXPOSURE-
GRADIENTFILL-
GRADIENTMAP-
GROUP-
HUESATURATION-
INVERSION-
LAYER3D-
LEVELS-
NORMAL-
PATTERNFILL-
PHOTOFILTER-
POSTERIZE-
SELECTIVECOLOR-
SMARTOBJECT-
SOLIDFILL-
TEXT-
THRESHOLD-
VIBRANCE-
VIDEO-

MatteColor#

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-

NewDocumentMode#

Color Modes available for new document

NameDescription
BITMAP-
CMYK-
GRAYSCALE-
LAB-
RGB-

OperatingSystem#

NameDescription
OS2-
WINDOWS-

PNGMethod#

Compression method for saving a PNG file

NameDescription
MODERATE-
QUICK-
THOROUGH-

Palette#

The palette type to use

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

RasterizeType#

The type of layer to get rasterized.

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

ResampleMethod#

The method to use for image interpolation

NameDescription
AUTOMATICChoose best 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
NONEDuplicates pixels
PRESERVEDETAILSAttempt to preserve details by using machine learning

SaveMethod#

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#

The policy for 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

TrimType#

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

NameDescription
BOTTOMRIGHTBottom right pixel color.
TOPLEFTTop left pixel color.
TRANSPARENTTransparent pixels.
Copyright © 2021 Adobe. All rights reserved.