Specifications
Table Of Contents
- Introduction
- JavaScript Object Reference
- Object descriptions
- ActionDescriptor
- Properties
- Methods
- clear
- erase
- fromStream
- getBoolean
- getClass
- getData
- getDouble
- getEnumerationType
- getEnumerationValue
- getInteger
- getKey
- getLargeInteger
- getList
- getObjectType
- getObjectValue
- getPath
- getReference
- getString
- getType
- getUnitDoubleType
- getUnitDoubleValue
- hasKey
- isEqual
- putBoolean
- putClass
- putData
- putDouble
- putEnumerated
- putInteger
- putLargeInteger
- putList
- putObject
- putPath
- putReference
- putString
- putUnitDouble
- toStream
- ActionList
- Properties
- Methods
- clear
- getBoolean
- getClass
- getData
- getDouble
- getEnumerationType
- getEnumerationValue
- getInteger
- getLargeInteger
- getList
- getObjectType
- getObjectValue
- getPath
- getReference
- getString
- getType
- getUnitDoubleType
- getUnitDoubleValue
- putBoolean
- putClass
- putData
- putDouble
- putEnumerated
- putInteger
- putLargeInteger
- putList
- putObject
- putPath
- putReference
- putString
- putUnitDouble
- ActionReference
- Application
- Properties
- activeDocument
- backgroundColor
- build
- colorSettings
- displayDialogs
- documents
- fonts
- foregroundColor
- freeMemory
- locale
- macintoshFileTypes
- measurementLog
- name
- notifiers
- notifiersEnabled
- path
- playbackDisplayDialogs
- playbackParameters
- preferences
- preferencesFolder
- recentFiles
- scriptingBuildDate
- scriptingVersion
- systemInformation
- typename
- version
- windowsFileTypes
- Methods
- batch
- beep
- bringToFront
- charIDToTypeID
- doAction
- eraseCustomOptions
- executeAction
- executeActionGet
- featureEnabled
- getCustomOptions
- isQuicktimeAvailable
- load
- makeContactSheet
- makePDFPresentation
- makePhotoGallery
- makePhotomerge
- makePicturePackage
- open
- openDialog
- purge
- putCustomOptions
- refresh
- refreshFonts
- runMenuItem
- showColorPicker
- stringIDToTypeID
- togglePalettes
- typeIDToCharID
- typeIDToStringID
- Properties
- ArtLayer
- Properties
- Methods
- adjustBrightnessContrast
- adjustColorBalance
- adjustCurves
- adjustLevels
- applyAddNoise
- applyAverage
- applyBlur
- applyBlurMore
- applyClouds
- applyCustomFilter
- applyDeInterlace
- applyDespeckle
- applyDifferenceClouds
- applyDiffuseGlow
- applyDisplace
- applyDustAndScratches
- applyGaussianBlur
- applyGlassEffect
- applyHighPass
- applyLensBlur
- applyLensFlare
- applyMaximum
- applyMedianNoise
- applyMinimum
- applyMotionBlur
- applyNTSC
- applyOceanRipple
- applyOffset
- applyPinch
- applyPolarCoordinates
- applyRadialBlur
- applyRipple
- applySharpen
- applySharpenEdges
- applySharpenMore
- applyShear
- applySmartBlur
- applySpherize
- applyStyle
- applyTextureFill
- applyTwirl
- applyUnSharpMask
- applyWave
- applyZigZag
- autoContrast
- autoLevels
- clear
- copy
- cut
- desaturate
- duplicate
- equalize
- invert
- link
- merge
- mixChannels
- move
- photoFilter
- posterize
- rasterize
- remove
- resize
- rotate
- selectiveColor
- shadowHighlight
- threshold
- translate
- unlink
- ArtLayers
- BatchOptions
- BitmapConversionOptions
- BMPSaveOptions
- CameraRAWOpenOptions
- Properties
- bitsPerChannel
- blueHue
- blueSaturation
- brightness
- chromaticAberrationBY
- chromaticAberrationRC
- colorNoiseReduction
- colorSpace
- contrast
- exposure
- greenHue
- greenSaturation
- luminanceSmoothing
- redHue
- redSaturation
- resolution
- saturation
- settings
- shadows
- shadowTint
- sharpness
- size
- temperature
- tint
- typename
- vignettingAmount
- vignettingMidpoint
- whiteBalance
- Properties
- Channel
- Channels
- CMYKColor
- ColorSampler
- ColorSamplers
- ContactSheetOptions
- CountItem
- CountItems
- DCS1_SaveOptions
- DCS2_SaveOptions
- DICOMOpenOptions
- Document
- Properties
- activeChannels
- activeHistoryBrushSource
- activeHistoryState
- activeLayer
- artLayers
- backgroundLayer
- bitsPerChannel
- channels
- colorProfileName
- colorProfileType
- colorSamplers
- componentChannels
- countItems
- fullName
- guides
- height
- histogram
- historyStates
- info
- layerComps
- layers
- layerSets
- managed
- measurementScale
- mode
- name
- parent
- path
- pathItems
- pixelAspectRatio
- printSettings
- quickMaskMode
- resolution
- saved
- selection
- typename
- width
- xmpMetadata
- Methods
- Properties
- DocumentPrintSettings
- DocumentInfo
- Documents
- EPSOpenOptions
- EPSSaveOptions
- ExportOptionsIllustrator
- ExportOptionsSaveForWeb
- File
- Folder
- GalleryBannerOptions
- GalleryCustomColorOptions
- GalleryImagesOptions
- GalleryOptions
- GallerySecurityOptions
- GalleryThumbnailOptions
- GIFSaveOptions
- GrayColor
- Guide
- Guides
- HistoryState
- HistoryStates
- HSBColor
- IndexedConversionOptions
- JPEGSaveOptions
- LabColor
- LayerComp
- LayerComps
- Layers
- LayerSet
- LayerSets
- MeasurementLog
- MeasurementScale
- NoColor
- Notifier
- Notifiers
- PathItem
- PathItems
- PathPoint
- PathPointInfo
- PathPoints
- PDFOpenOptions
- PDFSaveOptions
- Properties
- alphaChannels
- annotations
- colorConversion
- convertToEightBit
- description
- destinationProfile
- downgradeColorProfile
- downSample
- downSampleSize
- downSampleSizeLimit
- embedColorProfile
- embedFonts
- embedThumbnail
- encoding
- interpolation
- jpegQuality
- layers
- optimizeForWeb
- outputCondition
- outputConditionID
- PDFCompatibility
- PDFStandard
- preserveEditing
- presetFile
- profileInclusionPolicy
- registryName
- spotColors
- tileSize
- transparency
- typename
- useOutlines
- vectorData
- view
- Properties
- PhotoCDOpenOptions
- PhotoshopSaveOptions
- PICTFileSaveOptions
- PICTResourceSaveOptions
- PicturePackageOptions
- PixarSaveOptions
- PNGSaveOptions
- Preferences
- Properties
- additionalPluginFolder
- appendExtension
- askBeforeSavingLayeredTIFF
- autoUpdateOpenDocuments
- beepWhenDone
- colorChannelsInColor
- colorPicker
- columnGutter
- columnWidth
- createFirstSnapshot
- dynamicColorSliders
- editLogItems
- exportClipboard
- fontPreviewSize
- fullSizePreview
- gamutWarningOpacity
- gridSize
- gridStyle
- gridSubDivisions
- guideStyle
- iconPreview
- imageCacheLevels
- imagePreviews
- interpolation
- keyboardZoomResizesWindows
- macOSThumbnail
- maximizeCompatibility
- maxRAMuse
- nonLinearHistory
- numberofHistoryStates
- otherCursors
- paintingCursors
- parent
- pixelDoubling
- pointSize
- recentFileListLength
- rulerUnits
- saveLogItems
- saveLogItemsFile
- savePaletteLocations
- showAsianTextOptions
- showEnglishFontNames
- showSliceNumber
- showToolTips
- smartQuotes
- textFontSize
- typename
- typeUnits
- useAdditionalPluginFolder
- useHistoryLog
- useLowerCaseExtension
- useShiftKeyForToolSwitch
- useVideoAlpha
- windowsThumbnail
- Properties
- PresentationOptions
- RawFormatOpenOptions
- RawSaveOptions
- RGBColor
- Selection
- SGIRGBSaveOptions
- SolidColor
- SubPathInfo
- SubPathItem
- SubPathItems
- TargaSaveOptions
- TextFont
- TextFonts
- TextItem
- Properties
- alternateLigatures
- antiAliasMethod
- autoKerning
- autoLeadingAmount
- baselineShift
- capitalization
- color
- contents
- desiredGlyphScaling
- desiredLetterScaling
- desiredWordScaling
- direction
- fauxBold
- fauxItalic
- firstLineIndent
- font
- hangingPunctuation
- height
- horizontalScale
- hyphenateAfterFirst
- hyphenateBeforeLast
- hyphenateCapitalWords
- hyphenateWordsLongerThan
- hyphenation
- hyphenationZone
- hyphenLimit
- justification
- kind
- language
- leading
- leftIndent
- ligatures
- maximumGlyphScaling
- maximumLetterScaling
- maximumWordScaling
- minimumGlyphScaling
- minimumLetterScaling
- minimumWordScaling
- noBreak
- oldStyle
- parent
- position
- rightIndent
- size
- spaceAfter
- spaceBefore
- strikeThru
- textComposer
- tracking
- typename
- underline
- useAutoLeading
- verticalScale
- warpBend
- warpDirection
- warpHorizontalDistortion
- warpStyle
- warpVerticalDistortion
- width
- Methods
- Properties
- TiffSaveOptions
- UnitValue
- xmpMetadata
- JavaScript Resource
- Scripting Constants
- AdjustmentReference
- AnchorPosition
- AntiAlias
- AutoKernType
- BatchDestinationType
- BitmapConversionType
- BitmapHalfToneType
- BitsPerChannelType
- BlendMode
- BMPDepthType
- ByteOrder
- CameraRAWSettingsType
- CameraRAWSize
- ChangeMode
- ChannelType
- ColorBlendMode
- ColorModel
- ColorPicker
- ColorProfileType
- ColorReductionType
- ColorSpaceType
- CopyrightedType
- CreateFields
- CropToType
- DCSType
- DepthMapSource
- DescValueType
- DialogModes
- Direction
- DisplacementMapType
- Dither
- DocPositionStyle
- DocumentFill
- DocumentMode
- EditLogItemsType
- ElementPlacement
- EliminateFields
- ExportType
- Extension
- FileNamingType
- FontPreviewType
- FontSize
- ForcedColors
- FormatOptions
- GalleryConstrainType
- GalleryFontType
- GallerySecurityTextColorType
- GallerySecurityTextPositionType
- GallerySecurityTextRotateType
- GallerySecurityType
- GalleryThumbSizeType
- Geometry
- GridLineStyle
- GridSize
- GuideLineStyle
- IllustratorPathType
- Intent
- Justification
- Language
- LayerCompression
- LayerKind
- LensType
- MagnificationType
- MatteType
- MeasurementRange
- MeasurementSource
- NewDocumentMode
- NoiseDistribution
- OffsetUndefinedAreas
- OpenDocumentMode
- OpenDocumentType
- OperatingSystem
- Orientation
- OtherPaintingCursors
- PaintingCursors
- PaletteType
- PathKind
- PDFCompatibility
- PDFEncoding
- PDFResample
- PDFStandard
- PhotoCDColorSpace
- PhotoCDSize
- PICTBitsPerPixels
- PICTCompression
- PicturePackageTextType
- PointKind
- PointType
- PolarConversionType
- Preview
- PrintColorHandling
- PurgeTarget
- QueryStateType
- RadialBlurMethod
- RadialBlurQuality
- RasterizeType
- ReferenceFormType
- ResampleMethod
- RippleSize
- SaveBehavior
- SaveDocumentType
- SaveEncoding
- SaveLogItemsType
- SaveOptions
- SelectionType
- ShapeOperation
- SmartBlurMode
- SmartBlurQuality
- SourceSpaceType
- SpherizeMode
- StrikeThruType
- StrokeLocation
- TargaBitsPerPixels
- TextCase
- TextComposer
- TextType
- TextureType
- TIFFEncoding
- ToolType
- TransitionType
- TrimType
- TypeUnits
- UndefinedAreas
- UnderlineType
- Units
- Urgency
- WarpStyle
- WaveType
- WhiteBalanceType
- ZigZagType
- Appendix A: Event ID Codes
- Index

35
2
JavaScript Object Reference
The Photoshop objects (the JavaScript type library for Adobe® Photoshop® CS6) are presented
alphabetically and in tabular format in this chapter. Sample code for several object model classes is given
to help illustrate the syntax as well as usage of the object class.
Object descriptions
Object properties and methods are described in separate tables for each object. The following sections
describe the conventions used in these descriptions.
Properties notation
The Properties table for an object lists the following:
● The properties defined in each object.
● The value type for each property.
When the value type is a constant or another object, the value is a hypertext link to the listing for that
constant or object.
● The property’s input status: read-only or read-write.
● A description that explains what the property does.
For constants, like DialogModes in the sample, click the link to go to the table that shows allowed values.
Constants are represented by objects, and allowed values are properties of those objects. Specify a
constant value in the form ConstantName.VALUE. For example:
app.displayDialogs = DialogModes.ERROR;
Methods notation
The Methods table for an object lists the following:
● The method name.
● The parameters list.
● The parameter value types, on lines corresponding to each parameter.
● Return value type
● A description of what the method does, and further descriptions of parameters, if needed.
Property Value type What it is
displayDialogs
DialogModes
Read-write. The dialog mode for the application, which controls
what types of dialogs should be displayed when running
scripts.










