ADOBE PHOTOSHOP

JAVASCRIPT SCRIPTING REFERENCE

© 2020 Adobe. All rights reserved.
Adobe® Photoshop® JavaScript Scripting Reference for Windows® and Macintosh®.
NOTICE: All information contained herein is the property of Adobe. No part of this publication (whether in hardcopy or electronic form) may
be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior
written consent of Adobe. The software described in this document is furnished under license and may only be used or copied in accordance
with the terms of such license.
This publication and the information herein is furnished AS IS, is subject to change without notice, and should not be construed as a
commitment by Adobe. Adobe assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express,
implied, or statutory) with respect to this publication, and expressly disclaims any and all warranties of merchantability, fitness for particular
purposes, and noninfringement of third party rights.
Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual
organization.
Adobe®, the Adobe logo, Acrobat®, GoLive®, InDesign®, Illustrator®, Photoshop® are either registered trademarks or trademarks of Adobe. in
the United States and/or other countries.
Apple®, Mac OS®, and Macintosh® are trademarks of Apple Computer, Inc., registered in the United States and other countries. Microsoft®, and
Windows®. are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. JavaScriptTM and
all Java-related marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. UNIX® is a
registered trademark of The Open Group.
All other trademarks are the property of their respective owners.
If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished
under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part
of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording,
or otherwise, without the prior written permission of Adobe. Please note that the content in this guide is protected under copyright law even
if it is not distributed with software that includes an end user license agreement.
The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a
commitment by Adobe. Adobe assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational
content contained in this guide.
Adobe Inc., 345 Park Avenue, San Jose, CA 95110-2704 USA, www.adobe.com
 Contents

1 Introduction ............................................................................................................................... 32
JavaScript support in Adobe Photoshop.............................................................................................................................32
Executing scripts ....................................................................................................................................................................33
Installing scripts ...............................................................................................................................................................33
Executing other scripts ..................................................................................................................................................33
Startup scripts .........................................................................................................................................................................33
Object model usage and naming...........................................................................................................................................34
2 JavaScript Object Reference ..................................................................................................... 35
Object descriptions......................................................................................................................................................................35
Properties notation ...............................................................................................................................................................35
displayDialogs.................................................................................................................................................................35
Methods notation ..................................................................................................................................................................35
crop.....................................................................................................................................................................................36
ActionDescriptor ..........................................................................................................................................................................37
Properties..................................................................................................................................................................................37
count ..................................................................................................................................................................................37
typename .........................................................................................................................................................................37
Methods ....................................................................................................................................................................................37
clear ....................................................................................................................................................................................37
erase ...................................................................................................................................................................................37
fromStream......................................................................................................................................................................37
getBoolean.......................................................................................................................................................................37
getClass .............................................................................................................................................................................37
getData..............................................................................................................................................................................37
getDouble ........................................................................................................................................................................37
getEnumerationType ...................................................................................................................................................37
getEnumerationValue..................................................................................................................................................37
getInteger.........................................................................................................................................................................37
getKey................................................................................................................................................................................37
getLargeInteger .............................................................................................................................................................38
getList ................................................................................................................................................................................38
getObjectType................................................................................................................................................................38
getObjectValue...............................................................................................................................................................38
getPath ..............................................................................................................................................................................38
getReference ...................................................................................................................................................................38
getString ...........................................................................................................................................................................38
getType .............................................................................................................................................................................38
getUnitDoubleType ......................................................................................................................................................38
getUnitDoubleValue.....................................................................................................................................................38
hasKey................................................................................................................................................................................38
isEqual................................................................................................................................................................................38
putBoolean ......................................................................................................................................................................38
putClass.............................................................................................................................................................................38
putData .............................................................................................................................................................................38
putDouble ........................................................................................................................................................................38

3
 Adobe Photoshop
JavaScript Scripting Reference 4

putEnumerated ..............................................................................................................................................................38
putInteger ........................................................................................................................................................................39
putLargeInteger .............................................................................................................................................................39
putList ................................................................................................................................................................................39
putObject..........................................................................................................................................................................39
putPath..............................................................................................................................................................................39
putReference...................................................................................................................................................................39
putString...........................................................................................................................................................................39
putUnitDouble................................................................................................................................................................39
toStream ...........................................................................................................................................................................39
ActionList.........................................................................................................................................................................................40
Properties..................................................................................................................................................................................40
count ..................................................................................................................................................................................40
typename .........................................................................................................................................................................40
Methods ....................................................................................................................................................................................40
clear ....................................................................................................................................................................................40
getBoolean.......................................................................................................................................................................40
getClass .............................................................................................................................................................................40
getData..............................................................................................................................................................................40
getDouble ........................................................................................................................................................................40
getEnumerationType ...................................................................................................................................................40
getEnumerationValue..................................................................................................................................................40
getInteger.........................................................................................................................................................................40
getLargeInteger .............................................................................................................................................................41
getList ................................................................................................................................................................................41
getObjectType................................................................................................................................................................41
getObjectValue...............................................................................................................................................................41
getPath ..............................................................................................................................................................................41
getReference ...................................................................................................................................................................41
getString ...........................................................................................................................................................................41
getType .............................................................................................................................................................................41
getUnitDoubleType ......................................................................................................................................................41
getUnitDoubleValue.....................................................................................................................................................41
putBoolean ......................................................................................................................................................................41
putClass.............................................................................................................................................................................41
putData .............................................................................................................................................................................41
putDouble ........................................................................................................................................................................41
putEnumerated ..............................................................................................................................................................41
putInteger ........................................................................................................................................................................41
putLargeInteger .............................................................................................................................................................41
putList ................................................................................................................................................................................41
putObject..........................................................................................................................................................................42
putPath..............................................................................................................................................................................42
putReference...................................................................................................................................................................42
putString...........................................................................................................................................................................42
putUnitDouble................................................................................................................................................................42
ActionReference ...........................................................................................................................................................................43
Properties..................................................................................................................................................................................43
typename .........................................................................................................................................................................43
Methods ....................................................................................................................................................................................43
getContainer ...................................................................................................................................................................43
 Adobe Photoshop
JavaScript Scripting Reference 5

getDesiredClass..............................................................................................................................................................43
getEnumeratedType.....................................................................................................................................................43
getEnumeratedValue ...................................................................................................................................................43
getForm.............................................................................................................................................................................43
getIdentifier.....................................................................................................................................................................43
getIndex............................................................................................................................................................................43
getName ...........................................................................................................................................................................43
getOffset ...........................................................................................................................................................................43
getProperty......................................................................................................................................................................43
putClass.............................................................................................................................................................................44
putEnumerated ..............................................................................................................................................................44
putIdentifier.....................................................................................................................................................................44
putIndex............................................................................................................................................................................44
putName...........................................................................................................................................................................44
putOffset...........................................................................................................................................................................44
putProperty......................................................................................................................................................................44
Application .....................................................................................................................................................................................45
Properties..................................................................................................................................................................................45
activeDocument.............................................................................................................................................................45
backgroundColor...........................................................................................................................................................45
build....................................................................................................................................................................................45
cloudWorkAreaDirectory ............................................................................................................................................45
colorSettings ...................................................................................................................................................................45
currentTool ......................................................................................................................................................................45
displayDialogs.................................................................................................................................................................45
documents .......................................................................................................................................................................45
fonts....................................................................................................................................................................................45
foregroundColor ............................................................................................................................................................45
freeMemory .....................................................................................................................................................................46
locale ..................................................................................................................................................................................46
macintoshFileTypes......................................................................................................................................................46
measurementLog ..........................................................................................................................................................46
name...................................................................................................................................................................................46
notifiers .............................................................................................................................................................................46
notifiersEnabled .............................................................................................................................................................46
path.....................................................................................................................................................................................46
playbackDisplayDialogs ..............................................................................................................................................46
playbackParameters .....................................................................................................................................................46
preferences ......................................................................................................................................................................46
preferencesFolder .........................................................................................................................................................46
recentFiles ........................................................................................................................................................................46
scriptingBuildDate ........................................................................................................................................................46
scriptingVersion .............................................................................................................................................................46
systemInformation........................................................................................................................................................46
typename .........................................................................................................................................................................46
version ...............................................................................................................................................................................47
windowsFileTypes.........................................................................................................................................................47
Methods ....................................................................................................................................................................................47
batch ..................................................................................................................................................................................47
beep....................................................................................................................................................................................47
bringToFront ...................................................................................................................................................................47
 Adobe Photoshop
JavaScript Scripting Reference 6

changeProgressText .....................................................................................................................................................47
charIDToTypeID..............................................................................................................................................................47
compareWithNumbers ................................................................................................................................................47
doAction ...........................................................................................................................................................................48
doForcedProgress .........................................................................................................................................................48
doProgress .......................................................................................................................................................................48
doProgressSegmentTask ............................................................................................................................................48
doProgressSubTask.......................................................................................................................................................49
doProgressTask ..............................................................................................................................................................49
eraseCustomOptions....................................................................................................................................................49
executeAction.................................................................................................................................................................49
executeActionGet..........................................................................................................................................................49
featureEnabled ...............................................................................................................................................................49
getCustomOptions........................................................................................................................................................49
isQuicktimeAvailable....................................................................................................................................................49
load .....................................................................................................................................................................................49
makeContactSheet........................................................................................................................................................50
makePDFPresentation .................................................................................................................................................50
makePhotoGallery.........................................................................................................................................................50
makePhotomerge..........................................................................................................................................................50
makePicturePackage ....................................................................................................................................................50
open ...................................................................................................................................................................................50
openDialog ......................................................................................................................................................................50
purge..................................................................................................................................................................................51
putCustomOptions .......................................................................................................................................................51
refresh................................................................................................................................................................................51
refreshFonts.....................................................................................................................................................................51
runMenuItem ..................................................................................................................................................................51
showColorPicker ............................................................................................................................................................51
stringIDToTypeID...........................................................................................................................................................51
togglePalettes.................................................................................................................................................................51
toolSupportsBrushes....................................................................................................................................................51
(tool) ...................................................................................................................................................................................51
toolSupportsBrushPresets..........................................................................................................................................51
(tool) ...................................................................................................................................................................................51
typeIDToCharID..............................................................................................................................................................51
typeIDToStringID ...........................................................................................................................................................52
updateProgress ..............................................................................................................................................................52
ArtLayer............................................................................................................................................................................................55
Properties..................................................................................................................................................................................55
allLocked...........................................................................................................................................................................55
blendMode.......................................................................................................................................................................55
bounds...............................................................................................................................................................................55
boundsNoEffects ...........................................................................................................................................................55
fillOpacity..........................................................................................................................................................................55
filterMaskDensity ...........................................................................................................................................................55
filterMaskFeather...........................................................................................................................................................55
grouped ............................................................................................................................................................................55
isBackgroundLayer........................................................................................................................................................55
kind .....................................................................................................................................................................................55
layerMaskDensity...........................................................................................................................................................56
 Adobe Photoshop
JavaScript Scripting Reference 7

layerMaskFeather ..........................................................................................................................................................56
linkedLayers.....................................................................................................................................................................56
name...................................................................................................................................................................................56
opacity ...............................................................................................................................................................................56
parent.................................................................................................................................................................................56
pixelsLocked....................................................................................................................................................................56
positionLocked...............................................................................................................................................................56
textItem.............................................................................................................................................................................56
transparentPixelsLocked.............................................................................................................................................56
typename .........................................................................................................................................................................56
vectorMaskDensity........................................................................................................................................................56
vectorMaskFeather .......................................................................................................................................................56
visible .................................................................................................................................................................................56
xmpMetadata..................................................................................................................................................................56
Methods ....................................................................................................................................................................................57
adjustBrightnessContrast ...........................................................................................................................................57
adjustColorBalance .......................................................................................................................................................57
adjustCurves....................................................................................................................................................................57
adjustLevels .....................................................................................................................................................................57
applyAddNoise...............................................................................................................................................................57
applyAverage..................................................................................................................................................................57
applyBlur...........................................................................................................................................................................57
applyBlurMore ................................................................................................................................................................57
applyClouds.....................................................................................................................................................................57
applyCustomFilter.........................................................................................................................................................57
applyDeInterlace............................................................................................................................................................58
applyDespeckle ..............................................................................................................................................................58
applyDifferenceClouds................................................................................................................................................58
applyDiffuseGlow ..........................................................................................................................................................58
applyDisplace..................................................................................................................................................................58
applyDustAndScratches..............................................................................................................................................58
applyGaussianBlur.........................................................................................................................................................58
applyGlassEffect.............................................................................................................................................................58
applyHighPass ................................................................................................................................................................58
applyLensBlur .................................................................................................................................................................59
applyLensFlare................................................................................................................................................................59
applyMaximum ..............................................................................................................................................................59
applyMedianNoise ........................................................................................................................................................59
applyMinimum ...............................................................................................................................................................60
applyMotionBlur ............................................................................................................................................................60
applyNTSC........................................................................................................................................................................60
applyOceanRipple .........................................................................................................................................................60
applyOffset.......................................................................................................................................................................60
applyPinch .......................................................................................................................................................................60
applyPolarCoordinates................................................................................................................................................60
applyRadialBlur ..............................................................................................................................................................60
applyRipple......................................................................................................................................................................60
applySharpen..................................................................................................................................................................60
applySharpenEdges......................................................................................................................................................60
applySharpenMore .......................................................................................................................................................60
applyShear .......................................................................................................................................................................61
 Adobe Photoshop
JavaScript Scripting Reference 8

applySmartBlur...............................................................................................................................................................61
applySpherize .................................................................................................................................................................61
applyStyle.........................................................................................................................................................................61
applyTextureFill..............................................................................................................................................................61
applyTwirl.........................................................................................................................................................................61
applyUnSharpMask.......................................................................................................................................................61
applyWave........................................................................................................................................................................61
applyZigZag.....................................................................................................................................................................61
autoContrast....................................................................................................................................................................61
autoLevels ........................................................................................................................................................................61
clear ....................................................................................................................................................................................62
copy ....................................................................................................................................................................................62
cut........................................................................................................................................................................................62
desaturate ........................................................................................................................................................................62
duplicate ...........................................................................................................................................................................62
equalize .............................................................................................................................................................................62
invert ..................................................................................................................................................................................62
link.......................................................................................................................................................................................62
merge.................................................................................................................................................................................62
mixChannels....................................................................................................................................................................63
move...................................................................................................................................................................................63
photoFilter .......................................................................................................................................................................63
posterize ...........................................................................................................................................................................63
rasterize.............................................................................................................................................................................63
remove...............................................................................................................................................................................63
resize ..................................................................................................................................................................................64
rotate..................................................................................................................................................................................64
selectiveColor..................................................................................................................................................................64
shadowHighlight ...........................................................................................................................................................64
threshold...........................................................................................................................................................................64
translate ............................................................................................................................................................................64
unlink .................................................................................................................................................................................64
ArtLayers..........................................................................................................................................................................................67
Properties..................................................................................................................................................................................67
length.................................................................................................................................................................................67
parent.................................................................................................................................................................................67
typename .........................................................................................................................................................................67
Methods ....................................................................................................................................................................................67
add ......................................................................................................................................................................................67
getByName ......................................................................................................................................................................67
removeAll .........................................................................................................................................................................67
BatchOptions .................................................................................................................................................................................68
Properties..................................................................................................................................................................................68
destination .......................................................................................................................................................................68
destinationFolder ..........................................................................................................................................................68
errorFile .............................................................................................................................................................................68
fileNaming........................................................................................................................................................................68
macintoshCompatible .................................................................................................................................................68
overrideOpen..................................................................................................................................................................68
overrideSave....................................................................................................................................................................68
startingSerial ...................................................................................................................................................................68
 Adobe Photoshop
JavaScript Scripting Reference 9

suppressOpen.................................................................................................................................................................68
suppressProfile ...............................................................................................................................................................69
typename .........................................................................................................................................................................69
unixCompatible..............................................................................................................................................................69
windowsCompatible ....................................................................................................................................................69
BitmapConversionOptions .......................................................................................................................................................70
Properties..................................................................................................................................................................................70
angle...................................................................................................................................................................................70
frequency..........................................................................................................................................................................70
method..............................................................................................................................................................................70
patternName ...................................................................................................................................................................70
resolution..........................................................................................................................................................................70
shape..................................................................................................................................................................................70
typename .........................................................................................................................................................................70
BMPSaveOptions ..........................................................................................................................................................................71
Properties..................................................................................................................................................................................71
alphaChannels ................................................................................................................................................................71
depth..................................................................................................................................................................................71
flipRowOrder ...................................................................................................................................................................71
osType................................................................................................................................................................................71
rleCompression ..............................................................................................................................................................71
typename .........................................................................................................................................................................71
CameraRAWOpenOptions ........................................................................................................................................................72
Properties..................................................................................................................................................................................72
bitsPerChannel ...............................................................................................................................................................72
blueHue.............................................................................................................................................................................72
blueSaturation ................................................................................................................................................................72
brightness.........................................................................................................................................................................72
chromaticAberrationBY...............................................................................................................................................72
chromaticAberrationRC...............................................................................................................................................72
colorNoiseReduction....................................................................................................................................................72
colorSpace........................................................................................................................................................................72
contrast .............................................................................................................................................................................72
exposure ...........................................................................................................................................................................72
greenHue..........................................................................................................................................................................72
greenSaturation .............................................................................................................................................................72
luminanceSmoothing ..................................................................................................................................................72
redHue...............................................................................................................................................................................72
redSaturation ..................................................................................................................................................................72
resolution..........................................................................................................................................................................72
saturation .........................................................................................................................................................................72
settings..............................................................................................................................................................................72
shadows ............................................................................................................................................................................72
shadowTint ......................................................................................................................................................................72
sharpness..........................................................................................................................................................................72
size ......................................................................................................................................................................................72
temperature.....................................................................................................................................................................72
tint.......................................................................................................................................................................................73
typename .........................................................................................................................................................................73
vignettingAmount ........................................................................................................................................................73
vignettingMidpoint ......................................................................................................................................................73
 Adobe Photoshop
JavaScript Scripting Reference 10

whiteBalance...................................................................................................................................................................73
Channel............................................................................................................................................................................................74
Properties..................................................................................................................................................................................74
color....................................................................................................................................................................................74
histogram .........................................................................................................................................................................74
kind .....................................................................................................................................................................................74
name...................................................................................................................................................................................74
opacity ...............................................................................................................................................................................74
parent.................................................................................................................................................................................74
typename .........................................................................................................................................................................74
visible .................................................................................................................................................................................74
Methods ....................................................................................................................................................................................74
duplicate ...........................................................................................................................................................................74
merge.................................................................................................................................................................................75
remove...............................................................................................................................................................................75
Channels ..........................................................................................................................................................................................76
Properties..................................................................................................................................................................................76
length.................................................................................................................................................................................76
parent.................................................................................................................................................................................76
typename .........................................................................................................................................................................76
Methods ....................................................................................................................................................................................76
add ......................................................................................................................................................................................76
getByName ......................................................................................................................................................................76
removeAll .........................................................................................................................................................................76
CMYKColor......................................................................................................................................................................................81
Properties..................................................................................................................................................................................81
black ...................................................................................................................................................................................81
cyan.....................................................................................................................................................................................81
magenta............................................................................................................................................................................81
typename .........................................................................................................................................................................81
yellow.................................................................................................................................................................................81
ColorSampler .................................................................................................................................................................................82
Properties..................................................................................................................................................................................82
color....................................................................................................................................................................................82
position .............................................................................................................................................................................82
parent.................................................................................................................................................................................82
typename .........................................................................................................................................................................82
Methods ....................................................................................................................................................................................82
move...................................................................................................................................................................................82
remove...............................................................................................................................................................................82
ColorSamplers ...............................................................................................................................................................................83
Properties..................................................................................................................................................................................83
length.................................................................................................................................................................................83
parent.................................................................................................................................................................................83
typename .........................................................................................................................................................................83
Methods ....................................................................................................................................................................................83
add ......................................................................................................................................................................................83
removeAll .........................................................................................................................................................................83
ContactSheetOptions .................................................................................................................................................................84
Properties..................................................................................................................................................................................84
acrossFirst.........................................................................................................................................................................84
 Adobe Photoshop
JavaScript Scripting Reference 11

bestFit ................................................................................................................................................................................84
caption...............................................................................................................................................................................84
columnCount ..................................................................................................................................................................84
flatten.................................................................................................................................................................................84
font......................................................................................................................................................................................84
fontSize..............................................................................................................................................................................84
height.................................................................................................................................................................................84
horizontal .........................................................................................................................................................................84
mode ..................................................................................................................................................................................84
resolution..........................................................................................................................................................................84
rowCount..........................................................................................................................................................................84
typename .........................................................................................................................................................................84
useAutoSpacing.............................................................................................................................................................84
vertical ...............................................................................................................................................................................84
width ..................................................................................................................................................................................84
CountItem .......................................................................................................................................................................................85
Properties..................................................................................................................................................................................85
position .............................................................................................................................................................................85
parent.................................................................................................................................................................................85
typename .........................................................................................................................................................................85
Methods ....................................................................................................................................................................................85
remove...............................................................................................................................................................................85
CountItems .....................................................................................................................................................................................86
Properties..................................................................................................................................................................................86
length.................................................................................................................................................................................86
parent.................................................................................................................................................................................86
typename .........................................................................................................................................................................86
Methods ....................................................................................................................................................................................86
add ......................................................................................................................................................................................86
getByName ......................................................................................................................................................................86
removeAll .........................................................................................................................................................................86
DCS1_SaveOptions......................................................................................................................................................................87
Properties..................................................................................................................................................................................87
dCS ......................................................................................................................................................................................87
embedColorProfile........................................................................................................................................................87
encoding...........................................................................................................................................................................87
halftoneScreen ...............................................................................................................................................................87
interpolation....................................................................................................................................................................87
preview..............................................................................................................................................................................87
transferFunction.............................................................................................................................................................87
typename .........................................................................................................................................................................87
vectorData........................................................................................................................................................................87
DCS2_SaveOptions......................................................................................................................................................................88
Properties..................................................................................................................................................................................88
dCS ......................................................................................................................................................................................88
embedColorProfile........................................................................................................................................................88
encoding...........................................................................................................................................................................88
halftoneScreen ...............................................................................................................................................................88
interpolation....................................................................................................................................................................88
multiFileDCS....................................................................................................................................................................88
preview..............................................................................................................................................................................88
 Adobe Photoshop
JavaScript Scripting Reference 12

spotColors ........................................................................................................................................................................88
transferFunction.............................................................................................................................................................88
typename .........................................................................................................................................................................88
vectorData........................................................................................................................................................................88
DICOMOpenOptions ...................................................................................................................................................................89
Properties..................................................................................................................................................................................89
anonymize........................................................................................................................................................................89
columns.............................................................................................................................................................................89
reverse ...............................................................................................................................................................................89
rows ....................................................................................................................................................................................89
showOverlays..................................................................................................................................................................89
typename .........................................................................................................................................................................89
windowLevel ...................................................................................................................................................................89
windowWidth .................................................................................................................................................................89
Document .......................................................................................................................................................................................90
Properties..................................................................................................................................................................................90
activeChannels ...............................................................................................................................................................90
activeHistoryBrushSource ..........................................................................................................................................90
activeHistoryState .........................................................................................................................................................90
activeLayer .......................................................................................................................................................................90
artLayers............................................................................................................................................................................90
backgroundLayer...........................................................................................................................................................90
bitsPerChannel ...............................................................................................................................................................90
channels............................................................................................................................................................................90
cloudDocument .............................................................................................................................................................90
cloudWorkAreaDirectory ............................................................................................................................................90
colorProfileName...........................................................................................................................................................90
colorProfileType .............................................................................................................................................................90
colorSamplers .................................................................................................................................................................90
componentChannels....................................................................................................................................................91
countItems .......................................................................................................................................................................91
fullName............................................................................................................................................................................91
guides ................................................................................................................................................................................91
height.................................................................................................................................................................................91
histogram .........................................................................................................................................................................91
historyStates....................................................................................................................................................................91
info ......................................................................................................................................................................................91
layerComps ......................................................................................................................................................................91
layers ..................................................................................................................................................................................91
layerSets............................................................................................................................................................................91
managed...........................................................................................................................................................................91
measurementScale .......................................................................................................................................................91
mode ..................................................................................................................................................................................91
name...................................................................................................................................................................................91
parent.................................................................................................................................................................................91
path.....................................................................................................................................................................................91
pathItems .........................................................................................................................................................................91
pixelAspectRatio ............................................................................................................................................................91
printSettings....................................................................................................................................................................92
quickMaskMode.............................................................................................................................................................92
resolution..........................................................................................................................................................................92
 Adobe Photoshop
JavaScript Scripting Reference 13

saved ..................................................................................................................................................................................92
selection............................................................................................................................................................................92
typename .........................................................................................................................................................................92
width ..................................................................................................................................................................................92
xmpMetadata..................................................................................................................................................................92
Methods ....................................................................................................................................................................................93
autoCount ........................................................................................................................................................................93
changeMode ...................................................................................................................................................................93
close....................................................................................................................................................................................93
convertProfile..................................................................................................................................................................93
crop.....................................................................................................................................................................................93
duplicate ...........................................................................................................................................................................93
exportDocument ...........................................................................................................................................................94
flatten.................................................................................................................................................................................94
flipCanvas .........................................................................................................................................................................94
importAnnotations .......................................................................................................................................................94
mergeVisibleLayers.......................................................................................................................................................94
paste...................................................................................................................................................................................94
print ....................................................................................................................................................................................94
printOneCopy .................................................................................................................................................................94
rasterizeAllLayers...........................................................................................................................................................94
recordMeasurements...................................................................................................................................................94
resizeCanvas ....................................................................................................................................................................94
resizeImage......................................................................................................................................................................95
revealAll.............................................................................................................................................................................95
rotateCanvas ...................................................................................................................................................................95
save.....................................................................................................................................................................................95
saveAs ................................................................................................................................................................................95
splitChannels...................................................................................................................................................................95
suspendHistory...............................................................................................................................................................95
trap......................................................................................................................................................................................95
trim......................................................................................................................................................................................96
DocumentPrintSettings .............................................................................................................................................................98
Properties..................................................................................................................................................................................98
backgroundColor...........................................................................................................................................................98
bleedWidth ......................................................................................................................................................................98
caption...............................................................................................................................................................................98
centerCropMarks ...........................................................................................................................................................98
colorBars ...........................................................................................................................................................................98
copies.................................................................................................................................................................................98
cornerCropMarks ...........................................................................................................................................................98
colorHandling .................................................................................................................................................................98
activePrinter ....................................................................................................................................................................98
flip........................................................................................................................................................................................98
hardProof..........................................................................................................................................................................98
interpolate........................................................................................................................................................................98
labels ..................................................................................................................................................................................98
mapBlack ..........................................................................................................................................................................98
negative ............................................................................................................................................................................98
renderIntent ....................................................................................................................................................................98
posX....................................................................................................................................................................................98
 Adobe Photoshop
JavaScript Scripting Reference 14

posY ....................................................................................................................................................................................98
printBorder.......................................................................................................................................................................98
printerName ....................................................................................................................................................................98
printSpace ........................................................................................................................................................................98
registrationMarks...........................................................................................................................................................98
scale ....................................................................................................................................................................................99
vectorData........................................................................................................................................................................99
Methods ................................................................................................................................................................................. 100
setPagePosition........................................................................................................................................................... 100
DocumentInfo ............................................................................................................................................................................ 101
Properties............................................................................................................................................................................... 101
author ............................................................................................................................................................................. 101
authorPosition ............................................................................................................................................................. 101
caption............................................................................................................................................................................ 101
captionWriter ............................................................................................................................................................... 101
category ......................................................................................................................................................................... 101
city.................................................................................................................................................................................... 101
copyrighted .................................................................................................................................................................. 101
copyrightNotice .......................................................................................................................................................... 101
country ........................................................................................................................................................................... 101
creationDate................................................................................................................................................................. 101
credit ............................................................................................................................................................................... 101
exif.................................................................................................................................................................................... 101
headline ......................................................................................................................................................................... 101
instructions ................................................................................................................................................................... 101
jobName ........................................................................................................................................................................ 101
keywords........................................................................................................................................................................ 101
ownerUrl ........................................................................................................................................................................ 101
parent.............................................................................................................................................................................. 102
provinceState............................................................................................................................................................... 102
source.............................................................................................................................................................................. 102
supplementalCategories.......................................................................................................................................... 102
title ................................................................................................................................................................................... 102
transmissionReference ............................................................................................................................................. 102
typename ...................................................................................................................................................................... 102
urgency .......................................................................................................................................................................... 102
Documents .................................................................................................................................................................................. 104
Properties............................................................................................................................................................................... 104
length.............................................................................................................................................................................. 104
parent.............................................................................................................................................................................. 104
typename ...................................................................................................................................................................... 104
Methods ................................................................................................................................................................................. 104
add ................................................................................................................................................................................... 104
getByName ................................................................................................................................................................... 104
EPSOpenOptions ....................................................................................................................................................................... 105
Properties............................................................................................................................................................................... 105
antiAlias.......................................................................................................................................................................... 105
constrainProportions ................................................................................................................................................ 105
height.............................................................................................................................................................................. 105
mode ............................................................................................................................................................................... 105
resolution....................................................................................................................................................................... 105
 Adobe Photoshop
JavaScript Scripting Reference 15

typename ...................................................................................................................................................................... 105

width ............................................................................................................................................................................... 105
EPSSaveOptions......................................................................................................................................................................... 106
Properties............................................................................................................................................................................... 106
embedColorProfile..................................................................................................................................................... 106
encoding........................................................................................................................................................................ 106
halftoneScreen ............................................................................................................................................................ 106
interpolation................................................................................................................................................................. 106
preview........................................................................................................................................................................... 106
psColorManagement ................................................................................................................................................ 106
transferFunction.......................................................................................................................................................... 106
transparentWhites...................................................................................................................................................... 106
typename ...................................................................................................................................................................... 106
vectorData..................................................................................................................................................................... 106
ExportOptionsIllustrator ......................................................................................................................................................... 107
Properties............................................................................................................................................................................... 107
path.................................................................................................................................................................................. 107
pathName...................................................................................................................................................................... 107
typename ...................................................................................................................................................................... 107
ExportOptionsSaveForWeb ................................................................................................................................................... 108
Properties............................................................................................................................................................................... 108
blur................................................................................................................................................................................... 108
colorReduction ............................................................................................................................................................ 108
colors............................................................................................................................................................................... 108
dither............................................................................................................................................................................... 108
ditherAmount .............................................................................................................................................................. 108
format ............................................................................................................................................................................. 108
includeProfile ............................................................................................................................................................... 108
interlaced....................................................................................................................................................................... 108
lossy ................................................................................................................................................................................. 108
matteColor .................................................................................................................................................................... 108
optimized ...................................................................................................................................................................... 108
PNG8................................................................................................................................................................................ 108
quality ............................................................................................................................................................................. 109
transparency................................................................................................................................................................. 109
transparencyAmount ................................................................................................................................................ 109
transparencyDither .................................................................................................................................................... 109
typename ...................................................................................................................................................................... 109
webSnap ........................................................................................................................................................................ 109
File................................................................................................................................................................................................... 110
Folder............................................................................................................................................................................................. 110
GalleryBannerOptions ............................................................................................................................................................. 111
Properties............................................................................................................................................................................... 111
contactInfo.................................................................................................................................................................... 111
date.................................................................................................................................................................................. 111
font................................................................................................................................................................................... 111
fontSize........................................................................................................................................................................... 111
photographer............................................................................................................................................................... 111
siteName........................................................................................................................................................................ 111
typename ...................................................................................................................................................................... 111
GalleryCustomColorOptions ................................................................................................................................................. 112
 Adobe Photoshop
JavaScript Scripting Reference 16

Properties............................................................................................................................................................................... 112
activeLinkColor............................................................................................................................................................ 112
backgroundColor........................................................................................................................................................ 112
bannerColor.................................................................................................................................................................. 112
linkColor......................................................................................................................................................................... 112
textColor ........................................................................................................................................................................ 112
typename ...................................................................................................................................................................... 112
visitedLinkColor........................................................................................................................................................... 112
GalleryImagesOptions ............................................................................................................................................................. 113
Properties............................................................................................................................................................................... 113
border ............................................................................................................................................................................. 113
caption............................................................................................................................................................................ 113
dimension...................................................................................................................................................................... 113
font................................................................................................................................................................................... 113
fontSize........................................................................................................................................................................... 113
imageQuality................................................................................................................................................................ 113
includeCopyright........................................................................................................................................................ 113
includeCredits.............................................................................................................................................................. 113
includeFilename.......................................................................................................................................................... 113
includeTitle ................................................................................................................................................................... 113
numericLinks ................................................................................................................................................................ 113
resizeConstraint .......................................................................................................................................................... 114
resizeImages................................................................................................................................................................. 114
typename ...................................................................................................................................................................... 114
GalleryOptions............................................................................................................................................................................ 115
Properties............................................................................................................................................................................... 115
addSizeAttributes....................................................................................................................................................... 115
bannerOptions ............................................................................................................................................................ 115
customColorOptions ................................................................................................................................................. 115
emailAddress................................................................................................................................................................ 115
imagesOptions ............................................................................................................................................................ 115
includeSubFolders ..................................................................................................................................................... 115
layoutStyle .................................................................................................................................................................... 115
preserveAllMetadata ................................................................................................................................................. 115
securityOptions ........................................................................................................................................................... 115
thumbnailOptions...................................................................................................................................................... 115
typename ...................................................................................................................................................................... 115
useShortExtension ..................................................................................................................................................... 115
useUTF8Encoding ...................................................................................................................................................... 115
GallerySecurityOptions ........................................................................................................................................................... 116
Properties............................................................................................................................................................................... 116
content ........................................................................................................................................................................... 116
font................................................................................................................................................................................... 116
fontSize........................................................................................................................................................................... 116
opacity ............................................................................................................................................................................ 116
text ................................................................................................................................................................................... 116
textColor ........................................................................................................................................................................ 116
textPosition................................................................................................................................................................... 116
textRotate...................................................................................................................................................................... 116
typename ...................................................................................................................................................................... 116
GalleryThumbnailOptions...................................................................................................................................................... 117
 Adobe Photoshop
JavaScript Scripting Reference 17

Properties............................................................................................................................................................................... 117
border ............................................................................................................................................................................. 117
caption............................................................................................................................................................................ 117
columnCount ............................................................................................................................................................... 117
dimension...................................................................................................................................................................... 117
font................................................................................................................................................................................... 117
fontSize........................................................................................................................................................................... 117
includeCopyright........................................................................................................................................................ 117
includeCredits.............................................................................................................................................................. 117
includeFilename.......................................................................................................................................................... 117
includeTitle ................................................................................................................................................................... 117
rowCount....................................................................................................................................................................... 117
size ................................................................................................................................................................................... 117
typename ...................................................................................................................................................................... 117
GIFSaveOptions.......................................................................................................................................................................... 118
Properties............................................................................................................................................................................... 118
colors............................................................................................................................................................................... 118
dither............................................................................................................................................................................... 118
ditherAmount .............................................................................................................................................................. 118
forced .............................................................................................................................................................................. 118
interlaced....................................................................................................................................................................... 118
matte............................................................................................................................................................................... 118
palette............................................................................................................................................................................. 118
preserveExactColors .................................................................................................................................................. 118
transparency................................................................................................................................................................. 118
typename ...................................................................................................................................................................... 118
GrayColor...................................................................................................................................................................................... 119
Properties............................................................................................................................................................................... 119
gray .................................................................................................................................................................................. 119
typename ...................................................................................................................................................................... 119
Guide.............................................................................................................................................................................................. 120
Properties............................................................................................................................................................................... 120
direction......................................................................................................................................................................... 120
coordinate ..................................................................................................................................................................... 120
Guides............................................................................................................................................................................................ 121
Properties............................................................................................................................................................................... 121
length.............................................................................................................................................................................. 121
parent.............................................................................................................................................................................. 121
typename ...................................................................................................................................................................... 121
Methods ................................................................................................................................................................................. 121
add ................................................................................................................................................................................... 121
getByName ................................................................................................................................................................... 121
HistoryState ................................................................................................................................................................................. 122
Properties............................................................................................................................................................................... 122
name................................................................................................................................................................................ 122
parent.............................................................................................................................................................................. 122
snapshot ........................................................................................................................................................................ 122
typename ...................................................................................................................................................................... 122
HistoryStates ............................................................................................................................................................................... 123
Properties............................................................................................................................................................................... 123
length.............................................................................................................................................................................. 123
 Adobe Photoshop
JavaScript Scripting Reference 18

parent.............................................................................................................................................................................. 123
typename ...................................................................................................................................................................... 123
Methods ................................................................................................................................................................................. 123
getByName ................................................................................................................................................................... 123
HSBColor....................................................................................................................................................................................... 124
Properties............................................................................................................................................................................... 124
brightness...................................................................................................................................................................... 124
hue ................................................................................................................................................................................... 124
saturation ...................................................................................................................................................................... 124
typename ...................................................................................................................................................................... 124
IndexedConversionOptions .................................................................................................................................................. 125
Properties............................................................................................................................................................................... 125
colors............................................................................................................................................................................... 125
dither............................................................................................................................................................................... 125
ditherAmount .............................................................................................................................................................. 125
forced .............................................................................................................................................................................. 125
matte............................................................................................................................................................................... 125
palette............................................................................................................................................................................. 125
preserveExactColors .................................................................................................................................................. 125
transparency................................................................................................................................................................. 125
typename ...................................................................................................................................................................... 125
JPEGSaveOptions ...................................................................................................................................................................... 126
Properties............................................................................................................................................................................... 126
embedColorProfile..................................................................................................................................................... 126
formatOptions ............................................................................................................................................................. 126
matte............................................................................................................................................................................... 126
quality ............................................................................................................................................................................. 126
scans................................................................................................................................................................................ 126
typename ...................................................................................................................................................................... 126
LabColor ....................................................................................................................................................................................... 127
Properties............................................................................................................................................................................... 127
a......................................................................................................................................................................................... 127
b ........................................................................................................................................................................................ 127
l.......................................................................................................................................................................................... 127
typename ...................................................................................................................................................................... 127
LayerComp................................................................................................................................................................................... 128
Properties............................................................................................................................................................................... 128
appearance ................................................................................................................................................................... 128
childLayerCompState................................................................................................................................................ 128
comment ....................................................................................................................................................................... 128
name................................................................................................................................................................................ 128
parent.............................................................................................................................................................................. 128
position .......................................................................................................................................................................... 128
selected .......................................................................................................................................................................... 128
typename ...................................................................................................................................................................... 128
visibility .......................................................................................................................................................................... 128
Methods ................................................................................................................................................................................. 128
apply................................................................................................................................................................................ 128
recapture ....................................................................................................................................................................... 128
remove............................................................................................................................................................................ 128
resetfromComp ........................................................................................................................................................... 128
 Adobe Photoshop
JavaScript Scripting Reference 19

LayerComps................................................................................................................................................................................. 129
Properties............................................................................................................................................................................... 129
length.............................................................................................................................................................................. 129
parent.............................................................................................................................................................................. 129
typename ...................................................................................................................................................................... 129
Methods ................................................................................................................................................................................. 129
add ................................................................................................................................................................................... 129
getByName ................................................................................................................................................................... 129
removeAll ...................................................................................................................................................................... 129
Layers............................................................................................................................................................................................. 130
Properties............................................................................................................................................................................... 130
length.............................................................................................................................................................................. 130
parent.............................................................................................................................................................................. 130
typename ...................................................................................................................................................................... 130
Methods ................................................................................................................................................................................. 130
getByName ................................................................................................................................................................... 130
removeAll ...................................................................................................................................................................... 130
LayerSet ........................................................................................................................................................................................ 131
Properties............................................................................................................................................................................... 131
allLocked........................................................................................................................................................................ 131
artLayers......................................................................................................................................................................... 131
blendMode.................................................................................................................................................................... 131
bounds............................................................................................................................................................................ 131
enabledChannels........................................................................................................................................................ 131
layers ............................................................................................................................................................................... 131
layerSets......................................................................................................................................................................... 131
linkedLayers.................................................................................................................................................................. 131
name................................................................................................................................................................................ 131
opacity ............................................................................................................................................................................ 131
parent.............................................................................................................................................................................. 131
typename ...................................................................................................................................................................... 131
visible .............................................................................................................................................................................. 131
Methods ................................................................................................................................................................................. 132
duplicate ........................................................................................................................................................................ 132
link.................................................................................................................................................................................... 132
merge.............................................................................................................................................................................. 132
move................................................................................................................................................................................ 132
remove............................................................................................................................................................................ 132
resize ............................................................................................................................................................................... 132
rotate............................................................................................................................................................................... 132
translate ......................................................................................................................................................................... 132
unlink .............................................................................................................................................................................. 132
LayerSets ...................................................................................................................................................................................... 133
Properties............................................................................................................................................................................... 133
length.............................................................................................................................................................................. 133
parent.............................................................................................................................................................................. 133
typename ...................................................................................................................................................................... 133
Methods ................................................................................................................................................................................. 133
add ................................................................................................................................................................................... 133
getByName ................................................................................................................................................................... 133
removeAll ...................................................................................................................................................................... 133
 Adobe Photoshop
JavaScript Scripting Reference 20

MeasurementLog ...................................................................................................................................................................... 135

Methods ................................................................................................................................................................................. 135
exportMeasurements................................................................................................................................................ 135
deleteMeasurements ................................................................................................................................................ 135
MeasurementScale ................................................................................................................................................................... 136
Properties............................................................................................................................................................................... 136
pixelLength................................................................................................................................................................... 136
logicalLength ............................................................................................................................................................... 136
logicalUnits ................................................................................................................................................................... 136
NoColor ......................................................................................................................................................................................... 137
Properties............................................................................................................................................................................... 137
typename ...................................................................................................................................................................... 137
Notifier........................................................................................................................................................................................... 138
Properties............................................................................................................................................................................... 138
event................................................................................................................................................................................ 138
eventClass ..................................................................................................................................................................... 138
eventFile ........................................................................................................................................................................ 138
parent.............................................................................................................................................................................. 138
typename ...................................................................................................................................................................... 138
Methods ................................................................................................................................................................................. 138
remove............................................................................................................................................................................ 138
Notifiers......................................................................................................................................................................................... 139
Properties............................................................................................................................................................................... 139
length.............................................................................................................................................................................. 139
parent.............................................................................................................................................................................. 139
typename ...................................................................................................................................................................... 139
Methods ................................................................................................................................................................................. 139
add ................................................................................................................................................................................... 139
removeAll ...................................................................................................................................................................... 139
PathItem ....................................................................................................................................................................................... 140
Properties............................................................................................................................................................................... 140
kind .................................................................................................................................................................................. 140
name................................................................................................................................................................................ 140
parent.............................................................................................................................................................................. 140
subPathItems ............................................................................................................................................................... 140
typename ...................................................................................................................................................................... 140
Methods ................................................................................................................................................................................. 140
deselect .......................................................................................................................................................................... 140
duplicate ........................................................................................................................................................................ 140
fillPath............................................................................................................................................................................. 140
makeClippingPath...................................................................................................................................................... 141
makeSelection ............................................................................................................................................................. 141
remove............................................................................................................................................................................ 141
select ............................................................................................................................................................................... 141
strokePath ..................................................................................................................................................................... 141
PathItems ..................................................................................................................................................................................... 144
Properties............................................................................................................................................................................... 144
length.............................................................................................................................................................................. 144
parent.............................................................................................................................................................................. 144
typename ...................................................................................................................................................................... 144
Methods ................................................................................................................................................................................. 144
 Adobe Photoshop
JavaScript Scripting Reference 21

add ................................................................................................................................................................................... 144

getByName ................................................................................................................................................................... 144
removeAll ...................................................................................................................................................................... 144
PathPoint...................................................................................................................................................................................... 145
Properties............................................................................................................................................................................... 145
anchor............................................................................................................................................................................. 145
kind .................................................................................................................................................................................. 145
leftDirection.................................................................................................................................................................. 145
parent.............................................................................................................................................................................. 145
rightDirection............................................................................................................................................................... 145
typename ...................................................................................................................................................................... 145
PathPointInfo.............................................................................................................................................................................. 146
Properties............................................................................................................................................................................... 146
anchor............................................................................................................................................................................. 146
kind .................................................................................................................................................................................. 146
leftDirection.................................................................................................................................................................. 146
rightDirection............................................................................................................................................................... 146
typename ...................................................................................................................................................................... 146
PathPoints.................................................................................................................................................................................... 148
Properties............................................................................................................................................................................... 148
length.............................................................................................................................................................................. 148
parent.............................................................................................................................................................................. 148
typename ...................................................................................................................................................................... 148
PDFOpenOptions ...................................................................................................................................................................... 149
Properties............................................................................................................................................................................... 149
antiAlias.......................................................................................................................................................................... 149
bitsPerChannel ............................................................................................................................................................ 149
constrainProportions ................................................................................................................................................ 149
cropPage........................................................................................................................................................................ 149
height.............................................................................................................................................................................. 149
mode ............................................................................................................................................................................... 149
name................................................................................................................................................................................ 149
object .............................................................................................................................................................................. 149
page................................................................................................................................................................................. 149
resolution....................................................................................................................................................................... 149
suppressWarnings...................................................................................................................................................... 149
typename ...................................................................................................................................................................... 149
use3DObjectNumber ................................................................................................................................................ 149
usePageNumber ......................................................................................................................................................... 149
width ............................................................................................................................................................................... 149
PDFSaveOptions ........................................................................................................................................................................ 150
Properties............................................................................................................................................................................... 150
alphaChannels ............................................................................................................................................................. 150
annotations................................................................................................................................................................... 150
colorConversion.......................................................................................................................................................... 150
convertToEightBit....................................................................................................................................................... 150
description .................................................................................................................................................................... 150
destinationProfile ....................................................................................................................................................... 150
downgradeColorProfile............................................................................................................................................ 150
downSample ................................................................................................................................................................ 150
downSampleSize ........................................................................................................................................................ 150
 Adobe Photoshop
JavaScript Scripting Reference 22

downSampleSizeLimit .............................................................................................................................................. 150

embedColorProfile..................................................................................................................................................... 150
embedFonts ................................................................................................................................................................. 150
embedThumbnail....................................................................................................................................................... 150
encoding........................................................................................................................................................................ 150
interpolation................................................................................................................................................................. 150
jpegQuality ................................................................................................................................................................... 151
layers ............................................................................................................................................................................... 151
optimizeForWeb ......................................................................................................................................................... 151
outputCondition......................................................................................................................................................... 151
outputConditionID..................................................................................................................................................... 151
PDFCompatibility........................................................................................................................................................ 151
PDFStandard ................................................................................................................................................................ 151
preserveEditing ........................................................................................................................................................... 151
presetFile ....................................................................................................................................................................... 151
profileInclusionPolicy................................................................................................................................................ 151
registryName................................................................................................................................................................ 151
spotColors ..................................................................................................................................................................... 151
tileSize............................................................................................................................................................................. 151
transparency................................................................................................................................................................. 151
typename ...................................................................................................................................................................... 151
useOutlines ................................................................................................................................................................... 151
vectorData..................................................................................................................................................................... 152
view.................................................................................................................................................................................. 152
PhotoCDOpenOptions ............................................................................................................................................................ 153
Properties............................................................................................................................................................................... 153
colorProfileName........................................................................................................................................................ 153
colorSpace..................................................................................................................................................................... 153
orientation..................................................................................................................................................................... 153
pixelSize ......................................................................................................................................................................... 153
resolution....................................................................................................................................................................... 153
typename ...................................................................................................................................................................... 153
PhotoshopSaveOptions .......................................................................................................................................................... 154
Properties............................................................................................................................................................................... 154
alphaChannels ............................................................................................................................................................. 154
annotations................................................................................................................................................................... 154
embedColorProfile..................................................................................................................................................... 154
layers ............................................................................................................................................................................... 154
spotColors ..................................................................................................................................................................... 154
typename ...................................................................................................................................................................... 154
PICTFileSaveOptions ................................................................................................................................................................ 155
Properties............................................................................................................................................................................... 155
alphaChannels ............................................................................................................................................................. 155
compression ................................................................................................................................................................. 155
embedColorProfile..................................................................................................................................................... 155
resolution....................................................................................................................................................................... 155
typename ...................................................................................................................................................................... 155
PICTResourceSaveOptions..................................................................................................................................................... 156
Properties............................................................................................................................................................................... 156
alphaChannels ............................................................................................................................................................. 156
compression ................................................................................................................................................................. 156
 Adobe Photoshop
JavaScript Scripting Reference 23

embedColorProfile..................................................................................................................................................... 156
name................................................................................................................................................................................ 156
resolution....................................................................................................................................................................... 156
resourceID ..................................................................................................................................................................... 156
typename ...................................................................................................................................................................... 156
PicturePackageOptions........................................................................................................................................................... 157
Properties............................................................................................................................................................................... 157
content ........................................................................................................................................................................... 157
flatten.............................................................................................................................................................................. 157
font................................................................................................................................................................................... 157
fontSize........................................................................................................................................................................... 157
layout .............................................................................................................................................................................. 157
mode ............................................................................................................................................................................... 157
opacity ............................................................................................................................................................................ 157
resolution....................................................................................................................................................................... 157
text ................................................................................................................................................................................... 157
textColor ........................................................................................................................................................................ 157
textPosition................................................................................................................................................................... 157
textRotate...................................................................................................................................................................... 157
typename ...................................................................................................................................................................... 157
PixarSaveOptions ...................................................................................................................................................................... 158
Properties............................................................................................................................................................................... 158
alphaChannels ............................................................................................................................................................. 158
typename ...................................................................................................................................................................... 158
PNGSaveOptions ....................................................................................................................................................................... 159
Properties............................................................................................................................................................................... 159
compression ................................................................................................................................................................. 159
interlaced....................................................................................................................................................................... 159
typename ...................................................................................................................................................................... 159
Preferences .................................................................................................................................................................................. 160
Properties............................................................................................................................................................................... 160
additionalPluginFolder............................................................................................................................................. 160
appendExtension........................................................................................................................................................ 160
askBeforeSavingLayeredTIFF.................................................................................................................................. 160
autoUpdateOpenDocuments ................................................................................................................................ 160
beepWhenDone.......................................................................................................................................................... 160
colorChannelsInColor ............................................................................................................................................... 160
colorPicker..................................................................................................................................................................... 160
columnGutter............................................................................................................................................................... 160
columnWidth ............................................................................................................................................................... 160
createFirstSnapshot................................................................................................................................................... 160
dynamicColorSliders.................................................................................................................................................. 160
editLogItems ................................................................................................................................................................ 160
exportClipboard.......................................................................................................................................................... 161
fontPreviewSize........................................................................................................................................................... 161
fullSizePreview............................................................................................................................................................. 161
gamutWarningOpacity............................................................................................................................................. 161
gridSize........................................................................................................................................................................... 161
gridStyle ......................................................................................................................................................................... 161
gridSubDivisions......................................................................................................................................................... 161
guideStyle...................................................................................................................................................................... 161
 Adobe Photoshop
JavaScript Scripting Reference 24

iconPreview .................................................................................................................................................................. 161

imageCacheLevels ..................................................................................................................................................... 161
imagePreviews ............................................................................................................................................................ 161
interpolation................................................................................................................................................................. 161
keyboardZoomResizesWindows........................................................................................................................... 161
macOSThumbnail....................................................................................................................................................... 161
maximizeCompatibility ............................................................................................................................................ 161
maxRAMuse.................................................................................................................................................................. 161
nonLinearHistory ........................................................................................................................................................ 161
numberofHistoryStates ............................................................................................................................................ 162
otherCursors................................................................................................................................................................. 162
paintingCursors........................................................................................................................................................... 162
parent.............................................................................................................................................................................. 162
pixelDoubling .............................................................................................................................................................. 162
pointSize ........................................................................................................................................................................ 162
recentFileListLength.................................................................................................................................................. 162
rulerUnits ....................................................................................................................................................................... 162
saveLogItems ............................................................................................................................................................... 162
saveLogItemsFile ........................................................................................................................................................ 162
savePaletteLocations ................................................................................................................................................ 162
showAsianTextOptions ............................................................................................................................................ 162
showEnglishFontNames .......................................................................................................................................... 162
showSliceNumber ...................................................................................................................................................... 162
showToolTips ............................................................................................................................................................... 162
smartQuotes................................................................................................................................................................. 162
textFontSize.................................................................................................................................................................. 162
typename ...................................................................................................................................................................... 162
typeUnits ....................................................................................................................................................................... 163
useAdditionalPluginFolder ..................................................................................................................................... 163
useHistoryLog .............................................................................................................................................................. 163
useLowerCaseExtension .......................................................................................................................................... 163
useShiftKeyForToolSwitch....................................................................................................................................... 163
useVideoAlpha ............................................................................................................................................................ 163
windowsThumbnail................................................................................................................................................... 163
PresentationOptions ................................................................................................................................................................ 164
Properties............................................................................................................................................................................... 164
autoAdvance ............................................................................................................................................................... 164
includeFilename.......................................................................................................................................................... 164
interval............................................................................................................................................................................ 164
loop.................................................................................................................................................................................. 164
magnification............................................................................................................................................................... 164
PDFFileOptions............................................................................................................................................................ 164
presentation ................................................................................................................................................................ 164
transition........................................................................................................................................................................ 164
typename ...................................................................................................................................................................... 164
RawFormatOpenOptions ....................................................................................................................................................... 165
Properties............................................................................................................................................................................... 165
bitsPerChannel ............................................................................................................................................................ 165
byteOrder ...................................................................................................................................................................... 165
channelNumber .......................................................................................................................................................... 165
headerSize..................................................................................................................................................................... 165
 Adobe Photoshop
JavaScript Scripting Reference 25

height.............................................................................................................................................................................. 165
interleaveChannels .................................................................................................................................................... 165
retainHeader................................................................................................................................................................. 165
typename ...................................................................................................................................................................... 165
width ............................................................................................................................................................................... 165
RawSaveOptions........................................................................................................................................................................ 166
Properties............................................................................................................................................................................... 166
alphaChannels ............................................................................................................................................................. 166
spotColors ..................................................................................................................................................................... 166
typename ...................................................................................................................................................................... 166
RGBColor....................................................................................................................................................................................... 167
Properties............................................................................................................................................................................... 167
blue.................................................................................................................................................................................. 167
green ............................................................................................................................................................................... 167
hexValue ........................................................................................................................................................................ 167
red .................................................................................................................................................................................... 167
typename ...................................................................................................................................................................... 167
Selection ....................................................................................................................................................................................... 168
Properties............................................................................................................................................................................... 168
bounds............................................................................................................................................................................ 168
parent.............................................................................................................................................................................. 168
solid ................................................................................................................................................................................. 168
typename ...................................................................................................................................................................... 168
Methods ................................................................................................................................................................................. 168
clear ................................................................................................................................................................................. 168
contract .......................................................................................................................................................................... 168
copy ................................................................................................................................................................................. 168
cut..................................................................................................................................................................................... 168
deselect .......................................................................................................................................................................... 168
expand............................................................................................................................................................................ 168
feather............................................................................................................................................................................. 168
fill ...................................................................................................................................................................................... 169
grow ................................................................................................................................................................................ 169
invert ............................................................................................................................................................................... 169
load .................................................................................................................................................................................. 169
makeWorkPath ............................................................................................................................................................ 169
resize ............................................................................................................................................................................... 169
resizeBoundary............................................................................................................................................................ 169
rotate............................................................................................................................................................................... 169
rotateBoundary ........................................................................................................................................................... 169
select ............................................................................................................................................................................... 169
selectAll .......................................................................................................................................................................... 169
selectBorder.................................................................................................................................................................. 170
similar.............................................................................................................................................................................. 170
smooth ........................................................................................................................................................................... 170
store................................................................................................................................................................................. 170
stroke............................................................................................................................................................................... 170
translate ......................................................................................................................................................................... 170
translateBoundary...................................................................................................................................................... 170
SGIRGBSaveOptions ................................................................................................................................................................. 173
Properties............................................................................................................................................................................... 173
 Adobe Photoshop
JavaScript Scripting Reference 26

alphaChannels ............................................................................................................................................................. 173

spotColors ..................................................................................................................................................................... 173
typename ...................................................................................................................................................................... 173
SolidColor..................................................................................................................................................................................... 174
Properties............................................................................................................................................................................... 174
cmyk ................................................................................................................................................................................ 174
gray .................................................................................................................................................................................. 174
hsb.................................................................................................................................................................................... 174
lab..................................................................................................................................................................................... 174
model.............................................................................................................................................................................. 174
nearestWebColor........................................................................................................................................................ 174
rgb.................................................................................................................................................................................... 174
typename ...................................................................................................................................................................... 174
Methods ................................................................................................................................................................................. 174
isEqual............................................................................................................................................................................. 174
SubPathInfo................................................................................................................................................................................. 175
Properties............................................................................................................................................................................... 175
closed.............................................................................................................................................................................. 175
entireSubPath .............................................................................................................................................................. 175
operation ....................................................................................................................................................................... 175
typename ...................................................................................................................................................................... 175
SubPathItem................................................................................................................................................................................ 176
Properties............................................................................................................................................................................... 176
closed.............................................................................................................................................................................. 176
operation ....................................................................................................................................................................... 176
parent.............................................................................................................................................................................. 176
pathPoints ..................................................................................................................................................................... 176
typename ...................................................................................................................................................................... 176
SubPathItems.............................................................................................................................................................................. 177
Properties............................................................................................................................................................................... 177
length.............................................................................................................................................................................. 177
parent.............................................................................................................................................................................. 177
typename ...................................................................................................................................................................... 177
TargaSaveOptions..................................................................................................................................................................... 178
Properties............................................................................................................................................................................... 178
alphaChannels ............................................................................................................................................................. 178
resolution....................................................................................................................................................................... 178
rleCompression ........................................................................................................................................................... 178
typename ...................................................................................................................................................................... 178
TextFont........................................................................................................................................................................................ 179
Properties............................................................................................................................................................................... 179
family............................................................................................................................................................................... 179
name................................................................................................................................................................................ 179
parent.............................................................................................................................................................................. 179
postScriptName ......................................................................................................................................................... 179
style.................................................................................................................................................................................. 179
typename ...................................................................................................................................................................... 179
TextFonts...................................................................................................................................................................................... 180
Properties............................................................................................................................................................................... 180
length.............................................................................................................................................................................. 180
parent.............................................................................................................................................................................. 180
 Adobe Photoshop
JavaScript Scripting Reference 27

typename ...................................................................................................................................................................... 180

Methods ................................................................................................................................................................................. 180
getByName ................................................................................................................................................................... 180
TextItem........................................................................................................................................................................................ 181
Properties............................................................................................................................................................................... 181
alternateLigatures ...................................................................................................................................................... 181
antiAliasMethod.......................................................................................................................................................... 181
autoKerning.................................................................................................................................................................. 181
autoLeadingAmount................................................................................................................................................. 181
baselineShift................................................................................................................................................................. 181
capitalization................................................................................................................................................................ 181
color................................................................................................................................................................................. 181
contents ......................................................................................................................................................................... 181
desiredGlyphScaling.................................................................................................................................................. 181
desiredLetterScaling.................................................................................................................................................. 182
desiredWordScaling .................................................................................................................................................. 182
direction......................................................................................................................................................................... 182
fauxBold ......................................................................................................................................................................... 182
fauxItalic......................................................................................................................................................................... 182
firstLineIndent.............................................................................................................................................................. 182
font................................................................................................................................................................................... 182
hangingPunctuation ................................................................................................................................................. 182
height.............................................................................................................................................................................. 182
horizontalScale ............................................................................................................................................................ 182
hyphenateAfterFirst................................................................................................................................................... 183
hyphenateBeforeLast................................................................................................................................................ 183
hyphenateCapitalWords .......................................................................................................................................... 183
hyphenateWordsLongerThan................................................................................................................................ 183
hyphenation ................................................................................................................................................................. 183
hyphenationZone....................................................................................................................................................... 183
hyphenLimit ................................................................................................................................................................. 183
justification ................................................................................................................................................................... 183
kind .................................................................................................................................................................................. 183
language ........................................................................................................................................................................ 183
leading............................................................................................................................................................................ 183
leftIndent ....................................................................................................................................................................... 183
ligatures ......................................................................................................................................................................... 183
maximumGlyphScaling ............................................................................................................................................ 183
maximumLetterScaling ............................................................................................................................................ 184
maximumWordScaling............................................................................................................................................. 184
minimumGlyphScaling............................................................................................................................................. 184
minimumLetterScaling............................................................................................................................................. 185
minimumWordScaling.............................................................................................................................................. 185
noBreak .......................................................................................................................................................................... 185
oldStyle........................................................................................................................................................................... 185
parent.............................................................................................................................................................................. 185
position .......................................................................................................................................................................... 185
rightIndent .................................................................................................................................................................... 185
size ................................................................................................................................................................................... 185
spaceAfter ..................................................................................................................................................................... 185
spaceBefore .................................................................................................................................................................. 186
 Adobe Photoshop
JavaScript Scripting Reference 28

strikeThru....................................................................................................................................................................... 186
textComposer .............................................................................................................................................................. 186
tracking........................................................................................................................................................................... 186
typename ...................................................................................................................................................................... 186
underline........................................................................................................................................................................ 186
useAutoLeading.......................................................................................................................................................... 186
verticalScale.................................................................................................................................................................. 186
warpBend ...................................................................................................................................................................... 186
warpDirection .............................................................................................................................................................. 186
warpHorizontalDistortion........................................................................................................................................ 186
warpStyle....................................................................................................................................................................... 186
warpVerticalDistortion.............................................................................................................................................. 186
width ............................................................................................................................................................................... 186
Methods ................................................................................................................................................................................. 187
convertToShape.......................................................................................................................................................... 187
createPath ..................................................................................................................................................................... 187
TiffSaveOptions.......................................................................................................................................................................... 188
Properties............................................................................................................................................................................... 188
alphaChannels ............................................................................................................................................................. 188
annotations................................................................................................................................................................... 188
byteOrder ...................................................................................................................................................................... 188
embedColorProfile..................................................................................................................................................... 188
imageCompression.................................................................................................................................................... 188
interleaveChannels .................................................................................................................................................... 188
jpegQuality ................................................................................................................................................................... 188
layerCompression....................................................................................................................................................... 188
layers ............................................................................................................................................................................... 188
saveImagePyramid..................................................................................................................................................... 188
spotColors ..................................................................................................................................................................... 188
transparency................................................................................................................................................................. 188
typename ...................................................................................................................................................................... 188
UnitValue...................................................................................................................................................................................... 189
xmpMetadata ............................................................................................................................................................................. 190
Properties............................................................................................................................................................................... 190
parent.............................................................................................................................................................................. 190
rawData .......................................................................................................................................................................... 190
typename ...................................................................................................................................................................... 190
3 JavaScript Resource.................................................................................................................191
JavaScript resource syntax..................................................................................................................................................... 191
Basic JavaScript resource example ............................................................................................................................... 192
Enable-info grammar ............................................................................................................................................................... 192
Undefined values in enable-info evaluation ............................................................................................................. 195
Using the "in" function...................................................................................................................................................... 195
Action Manager automation................................................................................................................................................. 195
Terminology dictionary .................................................................................................................................................... 195
Value type defintions .................................................................................................................................................. 196
Uniqueness rules for terminology entries.................................................................................................................. 197
Terminology definition example................................................................................................................................... 197
4 Scripting Constants .................................................................................................................199
AdjustmentReference ............................................................................................................................................... 199
 Adobe Photoshop
JavaScript Scripting Reference 29

AnchorPosition............................................................................................................................................................ 199
AntiAlias ......................................................................................................................................................................... 199
AutoKernType.............................................................................................................................................................. 199
BatchDestinationType .............................................................................................................................................. 199
BitmapConversionType............................................................................................................................................ 200
BitmapHalfToneType ................................................................................................................................................ 200
BitsPerChannelType................................................................................................................................................... 200
BlendMode.................................................................................................................................................................... 200
BMPDepthType ........................................................................................................................................................... 200
ByteOrder ...................................................................................................................................................................... 201
CameraRAWSettingsType........................................................................................................................................ 201
CameraRAWSize.......................................................................................................................................................... 201
ChangeMode................................................................................................................................................................ 201
ChannelType ................................................................................................................................................................ 201
ColorBlendMode......................................................................................................................................................... 202
ColorModel ................................................................................................................................................................... 202
ColorPicker.................................................................................................................................................................... 202
ColorProfileType ......................................................................................................................................................... 202
ColorReductionType.................................................................................................................................................. 202
ColorSpaceType .......................................................................................................................................................... 202
CopyrightedType........................................................................................................................................................ 202
CreateFields .................................................................................................................................................................. 203
CropToType .................................................................................................................................................................. 203
DCSType......................................................................................................................................................................... 203
DepthMapSource ....................................................................................................................................................... 203
DescValueType ............................................................................................................................................................ 203
DialogModes ................................................................................................................................................................ 203
Direction ........................................................................................................................................................................ 203
DisplacementMapType ............................................................................................................................................ 204
Dither .............................................................................................................................................................................. 204
DocPositionStyle......................................................................................................................................................... 204
DocumentFill................................................................................................................................................................ 204
DocumentMode.......................................................................................................................................................... 204
EditLogItemsType....................................................................................................................................................... 204
ElementPlacement..................................................................................................................................................... 204
EliminateFields ............................................................................................................................................................ 204
ExportType.................................................................................................................................................................... 204
Extension ....................................................................................................................................................................... 204
FileNamingType .......................................................................................................................................................... 205
FontPreviewType........................................................................................................................................................ 205
FontSize.......................................................................................................................................................................... 205
ForcedColors ................................................................................................................................................................ 205
FormatOptions ............................................................................................................................................................ 205
GalleryConstrainType................................................................................................................................................ 205
GalleryFontType.......................................................................................................................................................... 206
GallerySecurityTextColorType ............................................................................................................................... 206
GallerySecurityTextPositionType.......................................................................................................................... 206
GallerySecurityTextRotateType ............................................................................................................................. 206
GallerySecurityType................................................................................................................................................... 206
GalleryThumbSizeType............................................................................................................................................. 206
Geometry....................................................................................................................................................................... 206
 Adobe Photoshop
JavaScript Scripting Reference 30

GridLineStyle ................................................................................................................................................................ 206

GridSize .......................................................................................................................................................................... 206
GuideLineStyle............................................................................................................................................................. 207
IllustratorPathType..................................................................................................................................................... 207
Intent............................................................................................................................................................................... 207
Justification................................................................................................................................................................... 207
Language....................................................................................................................................................................... 207
LayerCompression...................................................................................................................................................... 207
LayerKind....................................................................................................................................................................... 208
LensType........................................................................................................................................................................ 208
MagnificationType ..................................................................................................................................................... 208
MatteType ..................................................................................................................................................................... 208
MeasurementRange .................................................................................................................................................. 208
MeasurementSource ................................................................................................................................................. 208
NewDocumentMode................................................................................................................................................. 208
NoiseDistribution........................................................................................................................................................ 209
OffsetUndefinedAreas .............................................................................................................................................. 209
OpenDocumentMode............................................................................................................................................... 209
OpenDocumentType................................................................................................................................................. 209
OperatingSystem........................................................................................................................................................ 209
Orientation.................................................................................................................................................................... 209
OtherPaintingCursors ............................................................................................................................................... 210
PaintingCursors ........................................................................................................................................................... 210
PaletteType ................................................................................................................................................................... 210
PathKind......................................................................................................................................................................... 210
PDFCompatibility........................................................................................................................................................ 210
PDFEncoding................................................................................................................................................................ 210
PDFResample ............................................................................................................................................................... 211
PDFStandard ................................................................................................................................................................ 211
PhotoCDColorSpace.................................................................................................................................................. 211
PhotoCDSize................................................................................................................................................................. 211
PICTBitsPerPixels......................................................................................................................................................... 211
PICTCompression........................................................................................................................................................ 211
PicturePackageTextType.......................................................................................................................................... 211
PointKind ....................................................................................................................................................................... 211
PointType ...................................................................................................................................................................... 212
PolarConversionType ................................................................................................................................................ 212
Preview........................................................................................................................................................................... 212
PrintColorHandling .................................................................................................................................................... 212
PurgeTarget .................................................................................................................................................................. 212
QueryStateType........................................................................................................................................................... 212
RadialBlurMethod....................................................................................................................................................... 212
RadialBlurQuality ........................................................................................................................................................ 212
RasterizeType ............................................................................................................................................................... 212
ReferenceFormType .................................................................................................................................................. 212
ResampleMethod ....................................................................................................................................................... 213
RippleSize ...................................................................................................................................................................... 213
SaveBehavior................................................................................................................................................................ 213
SaveDocumentType .................................................................................................................................................. 213
SaveEncoding .............................................................................................................................................................. 213
SaveLogItemsType..................................................................................................................................................... 213
 Adobe Photoshop
JavaScript Scripting Reference 31

SaveOptions ................................................................................................................................................................. 213

SelectionType............................................................................................................................................................... 214
ShapeOperation.......................................................................................................................................................... 214
SmartBlurMode ........................................................................................................................................................... 214
SmartBlurQuality......................................................................................................................................................... 214
SourceSpaceType ....................................................................................................................................................... 214
SpherizeMode.............................................................................................................................................................. 214
StrikeThruType ............................................................................................................................................................ 214
StrokeLocation............................................................................................................................................................. 214
TargaBitsPerPixels ...................................................................................................................................................... 214
TextCase......................................................................................................................................................................... 215
TextComposer.............................................................................................................................................................. 215
TextType ........................................................................................................................................................................ 215
TextureType.................................................................................................................................................................. 215
TIFFEncoding................................................................................................................................................................ 215
ToolType ........................................................................................................................................................................ 215
TransitionType............................................................................................................................................................. 215
TrimType........................................................................................................................................................................ 216
TypeUnits....................................................................................................................................................................... 216
UndefinedAreas .......................................................................................................................................................... 216
UnderlineType ............................................................................................................................................................. 216
Units................................................................................................................................................................................. 216
Urgency.......................................................................................................................................................................... 216
WarpStyle ...................................................................................................................................................................... 216
WaveType...................................................................................................................................................................... 217
WhiteBalanceType...................................................................................................................................................... 217
ZigZagType................................................................................................................................................................... 217
Appendix A: Event ID Codes ...................................................................................................218
Index .........................................................................................................................................226
 1 Introduction

This reference describes the objects and methods in the Adobe® Photoshop® JavaScriptTM type library. A
companion document, Photoshop Scripting Guide, describes basic scripting concepts and the Photoshop
object model. This document provides reference details of the Photoshop object model, and additional
information on JavaScript-specific features.

Adobe Photoshop uses ExtendScript, Adobe’s extended implementation of JavaScript. See JavaScript
support in Adobe Photoshop for additional information.

This book contains the following sections:

? This introduction, which describes scripting support in Adobe Photoshop, and lists changes to the
JavaScript interface since the previous release.
? JavaScript Object Reference, which provides a complete reference for all Photoshop DOM objects and
commands.
? Scripting Constants, which lists all enumerations used in the Photoshop type library.

JavaScript support in Adobe Photoshop

For a JavaScript file to be recognized by Photoshop as a valid script file, it must use either a .js or a .jsx
extension.

On the Mac OS, there is no difference in the way scripts with the two extensions function. On Windows, if
the script files is opened from inside Photoshop, there is no difference between using the .js and .jsx
extension. However, if the script is launched by double-clicking on it, a script with the .js extension is
interpreted with the Microsoft JScript engine, and it cannot launch Adobe Photoshop. For Windows, using
the .jsx extension is preferrable, since it interprets the script with the ExtendScript engine.

All of the Adobe Creative Cloud applications, including Adobe Photoshop, use ExtendScript, Adobe’s
extended implementation of JavaScript. ExtendScript files are distinguished by the .jsx extension.
ExtendScript offers all standard JavaScript features, plus additional features and utilities, such as:
? A debugging environment (the ExtendScript Toolkit)
? A localization utility
? Tools that allow you to combine scripts and direct them to particular applications
? Platform-independent file and folder representation

Many of the JavaScript objects and methods use objects defined in ExtendScript, such as the File object,
the Folder object, and the UnitValue object. For that reason, using the .jsx extension for your script
files is preferable.

For details of these and additional features, see the JavaScript Tools Guide. This document is installed with
Creative Cloud applications at these locations:
? In Windows:
C:\Program Files\Adobe\Adobe Utilities\ExtendScript Toolkit CC\SDK

32
 Adobe Photoshop
JavaScript Scripting Reference Introduction 33

? In Mac OS:
Applications/Utilities/Adobe Utilities/ExtendScript Toolkit CC/SDK

The latest versions of this document and of the ExtendScript Tookit, can also be downloaded from Adobe
Developer Center, http://www.adobe.com/devnet/.

Executing scripts
The Adobe Photoshop interface includes a Scripts menu (File > Scripts) which provides quick and easy
access to your JavaScripts. Scripts can be listed directly as menu items that run when you select them, or
you can navigate to and run any JavaScript in your file system.

If Adobe Photoshop encounters an error during script execution, it displays the error message.

Installing scripts
To install a JavaScript in the Scripts menu, place it in the Scripts folder (Photoshop/Presets/Scripts). The
names of the scripts in the Scripts folder, without the file name extension, will be displayed in the Scripts
menu. Any number of scripts may be installed in the Scripts menu.

Scripts added to the Scripts folder while Adobe Photoshop is running will not appear in the Scripts menu
until the next time you launch the application.

All scripts found in the Scripts folder and sub-folders are displayed at the top level of the File > Scripts
menu. The addition of sub-folders does not add a hierarchical organization to the Scripts menu.

Executing other scripts

The Browse item at the end of the Scripts menu (File > Scripts > Browse) allows you to execute scripts
which are not installed in the Scripts folder. You can also use Browse to select scripts installed in the Scripts
folder after the application was last launched.

Selecting Browse displays a file browser dialog which allows you to select a script file for execution. Only
.js or .jsx files are displayed in the browse dialog. When you select a script file, it is executed the same
way as an installed script.

Startup scripts
On startup, Adobe Photoshop executes all .jsx files that it finds in the startup folders.
? On Windows, the startup folder for user-defined scripts is:
C:\Program Files\Common Files\Adobe\Startup Scripts CC\Adobe Photoshop
? On Mac OS, the startup folder for user-defined scripts is:
~/Library/Application Support/Adobe/Startup Scripts CC/Adobe Photoshop

If a script is meant to be executed only by Adobe Photoshop, it must include code such as the following:
if( BridgeTalk.appName == "photoshop" ) {
//continue executing script
}

For additional details, see the JavaScript Tools Guide.

 Adobe Photoshop
JavaScript Scripting Reference Introduction 34

Object model usage and naming

The JavaScript API follows JavaScript naming conventions in that all classes (object types) begin with
uppercase letters and have mixed case. Typically, in JavaScript, you instantiate classes using the new
operator:
new ClassName();

However, in the Photoshop Object Model, it is often not necessary to do this. Major object types are
collected into collection classes; for example, a list of Document objects is contained in a Documents
collection object. You then access the collection object through a corresponding collection property in its
container in the object hierarchy.

For example, the collection of all open documents is contained in the top-level Application object. You
can access this through the global variable app, or simply reference its properties directly at the top level:
app.documents[0] // get the first loaded documented
documents[0] // this is the same

A collection property has the same name as the collection object, but begins with lowercase. For example,
a Document contains a collection of LayerSets, and a LayerSet contains a collection of ArtLayers. To
access one ArtLayer object in a set:
var myLayer = activeDocument.layerSets[0].artLayers[0];

The collections, as in this example, can be treated as arrays, which is useful for iteration. They also provide
methods to create their contained objects, and to access them by name:
var newLayer = activeDocument.artLayers.add(); // Create a new ArtLayer object
newLayer.name = "My Layer"; // name it for later reference
...
var layerRef = activeDocument.artLayers.getByName("My Layer");

Some objects, such as the Font objects contained in the app.fonts collection, are created by the
application, and never by your scripts.

Your scripts do use the JavaScript new operator to create helper objects, such as those that encapsulate a
set of options for opening or saving a document in a particular format:
var opts = new PDFOpenOptions();
opts.page = 10;
app.open(myPDFFile, opts);
 2 JavaScript Object Reference

The Photoshop objects (the JavaScript type library for Adobe® Photoshop®) 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.

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.

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.

35
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 36

Method Parameter type Returns What it does

crop Crops the document. The
(bounds array of 4 bounds parameter is an array of
UnitValue
[, angle] number four coordinates for the region
[, width] UnitValue remaining after cropping, [left,
[, height]) UnitValue top, right, bottom].

When a parameter type or return value is a constant or another object, the value is a hypertext link to the
listing for that constant or object.

Parameters can be required or optional. Optional parameters are indicated in the table by square brackets
([]). In the example, the first parameters, bounds, is required. The remaining parameters are all optional.

You must pass a value for each required parameter. You can leave out optional parameters if there are no
remaining values to pass; however, if you wish to use the default value for any optional parameter that is
not the last one specified, pass undefined as a placeholder. You must enter the values in the order they are
listed, so that the JavaScript compiler knows which value you are entering.

For example, the following passes only the required parameter (using a previously-defined variable for the
bounding region):
app.activeDocument.crop( myRegion );

The following skips the angle parameter, specifies the width value, and omits the final height value:
var myWidth = new UnitValue( "500 pixels" );
app.executeAction( myRegion,undefined,myWidth );
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 37

ActionDescriptor
This object provides a dictionary-style mechanism for storing data as key-value pairs. It can be used for
low-level access into Photoshop. See an example of this usage in ‘Selection sample script’ on page 170.

Many configuration files use serialized action descriptors to represent their data. It is used, for example, to
encapsulate playback options in Application.playbackParameters, and is returned by
Application.getCustomOptions().

Properties
Property Value type What it is
count number Read-only. The number of keys contained in the descriptor.
typename string Read-only. The class name of the referenced
actionDescriptor object.

Methods
Method Parameter type Returns What it does
clear Clears the descriptor.
()

erase Erases a key from the descriptor.

(key) number

fromStream Creates a descriptor from a stream

(value) string of bytes; for reading from disk.
getBoolean boolean Gets the value of a key of type
(key) number boolean.
getClass number Gets the value of a key of type
(key) number class.
getData string Gets raw byte data as a string
(key) number value.
getDouble number Gets the value of a key of type
(key) number double.
getEnumerationType number Gets the enumeration type of a
(key) number key.
getEnumerationValue number Gets the enumeration value of a
(key) number key.
getInteger number Gets the value of a key of type
(key) number integer.
getKey number Gets the ID of the Nth key,
(index) number provided by index.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 38

Method Parameter type Returns What it does (Continued)

getLargeInteger number Gets the value of a key of type
(key) number large integer.
getList ActionList Gets the value of a key of type list.
(key) number

getObjectType number Gets the class ID of an object in a

(key) number key of type object.
getObjectValue ActionDescriptor Gets the value of a key of type
(key) number object.
getPath File Gets the value of a key of type
(key) number File.

getReference ActionReference Gets the value of a key of type

(key) number ActionReference.

getString string Gets the value of a key of type

(key) number string.
getType DescValueType Gets the type of a key.
(key) number

getUnitDoubleType number Gets the unit type of a key of type

(key) number UnitDouble.
getUnitDoubleValue number Gets the value of a key of type
(key) number UnitDouble.
hasKey boolean Checks whether the descriptor
(key) number contains the provided key.
isEqual boolean Determines whether the
(otherDesc) ActionDescriptor descriptor is the same as another
descriptor.
putBoolean Sets the value for a key whose type
(key, number is boolean.
value) boolean

putClass Sets the value for a key whose type

(key, number is class.
value) number

putData Puts raw byte data as a string

(key, number value.
value) string

putDouble Sets the value for a key whose type

(key, number is double.
value) number

putEnumerated Sets the enumeration type and

(key, number value for a key.
enumType, number number
value)
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 39

Method Parameter type Returns What it does (Continued)

putInteger Sets the value for a key whose type
(key, number is integer.
value) number

putLargeInteger Sets the value for a key whose type

(key, number is large integer.
value) number

putList Sets the value for a key whose type

(key, number is an ActionList object.
value) ActionList

putObject Sets the value for a key whose type

(key, number is an object, represented by an
classID, number
ActionDescriptor Action Descriptor.
value)

putPath Sets the value for a key whose type

(key, number is path.
value) File

putReference Sets the value for a key whose type

(key, number is an object reference.
value) ActionReference

putString Sets the value for a key whose type

(key, number is string.
value) string

putUnitDouble Sets the value for a key whose type

(key, number is a unit value formatted as a
unitID, number
number double.
value)

toStream string Gets the entire descriptor as a

() stream of bytes, for writing to disk.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 40

ActionList
This object provides an array-style mechanism for storing data. It can be used for low-level access into
Photoshop.

This object is ideal when storing data of the same type. All items in the list must be of the same type.

You can use the "put" methods, such as putBoolean(), to append new elements, and can clear the entire
list using clear(), but cannot otherwise modify the list.

Note: The ActionList object is part of the Action Manager functionality. For details on using the Action
Manager, see the Photoshop Scripting Guide.

Properties
Property Value type What it is
count number Read-only. The number of commands that comprise the
action.
typename string Read-only. The class name of the referenced
ActionList object.

Methods
With the exception of the clear() method, you use the methods of this object to either get the value of a
specific type of data in the list or set (put) the value type.

Method Parameter type Returns What it does

clear Clears the list.
()

getBoolean boolean Gets the value of a list element of

(index) number type boolean.
getClass number Gets the value of a list element of
(index) number type class.
getData string Gets raw byte data as a string
(index) number value.
getDouble number Gets the value of a list element of
(index) number type double.
getEnumerationType number Gets the enumeration type of a list
(index) number element.
getEnumerationValue number Gets the enumeration value of a
(index) number list element.
getInteger number Gets the value of a list element of
(index) number type integer.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 41

Method Parameter type Returns What it does (Continued)

getLargeInteger number Gets the value of a list element of
(index) number type large integer.
getList ActionList Gets the value of a list element of
(index) number type list.
getObjectType number Gets the class ID of a list element
(index) number of type object.
getObjectValue ActionDescriptor Gets the value of a list element of
(index) number type object.
getPath File Gets the value of a list element of
(index) number type File.
getReference ActionReference Gets the value of a list element of
(index) number type ActionReference.
getString string Gets the value of a list element of
(index) number type string.
getType DescValueType Gets the type of a list element.
(index) number

getUnitDoubleType number Gets the unit value type of a list

(index) number element of type Double.
getUnitDoubleValue number Gets the unit value of a list
(index) number element of type double.
putBoolean Appends a new value, true or
(value) boolean false.
putClass Appends a new value, a class or
(value) number data type.
putData Appends a new value, a string
(value) string containing raw byte data.
putDouble Appends a new value, a double.
(value) number

putEnumerated Appends a new value, an

(enumType, number enumerated (constant) value.
value) number

putInteger Appends a new value, an integer.

(value) number

putLargeInteger Appends a new value, a large

(value) number integer.
putList Appends a new value, a nested
(value) ActionList action list.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 42

Method Parameter type Returns What it does (Continued)

putObject Appends a new value, an object.
(classID, number
value) ActionDescriptor

putPath Appends a new value, a path.

(value) File

putReference Appends a new value, a reference

(value) ActionReference to an object created in the script.
putString Appends a new value, a string.
(value) string

putUnitDouble Appends a new value, a unit/value

(classID, number pair.
value) number
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 43

ActionReference
This object provides information about what the action is refering to. For example, when referring to the
name of something you might use keyName. The reference would also need to know what name you are
referring to. In this case you could use classDocument for the name of the document or classLayer for the
name of the layer. It can be used for low-level access into Photoshop.Contains data associated with an
ActionDescriptor.

Properties
Property Value type What it does
typename string Read-only. The class name of the referenced Action
object.

Methods
Method Parameter type Returns What it does
getContainer ActionReference Gets a reference contained in this
() reference.
Container references provide
additional pieces to the reference.
This looks like another reference,
but it is actually part of the same
reference.
getDesiredClass number Gets a number representing the
() class of the object.
getEnumeratedType number Gets the enumeration type.
()

getEnumeratedValue number Gets the enumeration value.

()

getForm ReferenceFormType Gets the form of this action

() reference.
getIdentifier number Gets the identifier value for a
() reference whose form is identifier.
getIndex number Gets the index value for a
() reference in a list or array.
getName string Gets the name of a reference.
()

getOffset number Gets the offset of the object’s

() index value.
getProperty number Gets the property ID value.
()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 44

Method Parameter type Returns What it does (Continued)

putClass Puts a new class form and class
(desiredClass) number type into the reference.
putEnumerated Puts an enumeration type and ID
(desiredClass, number into a reference along with the
enumType, number
number desired class for the reference.
value)

putIdentifier Puts a new identifier and value into

(desiredClass, number the reference.
value) number

putIndex Puts a new index and value into

(desiredClass, number the reference.
value) number

putName Puts a new name and value into

(desiredClass, number the reference.
value) string

putOffset Puts a new offset and value into

(desiredClass, number the reference.
value) number

putProperty Puts a new property and value into

(desiredClass, number the reference.
value) number
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 45

Application
The Adobe Adobe Photoshop application object, which is the root of the object model and provides
access to all other objects. This object provides application-wide information, such as application defaults
and available fonts. It provides many important methods , such as those for opening files and loading
documents.

To access the properties and methods, you can use the pre-defined global variable app. For example:
var docRef = app.documents.add(800, 600, 72, "docRef", NewDocumentMode.RGB);

The properties and methods of the Application object are also available at the top level; you can omit
references to the Application object altogether. For example:
var docRef = documents.add(800, 600, 72, "docRef", NewDocumentMode.RGB);

This usage can be somewhat ambiguous; for clarity, it is recommended that you use an explicit reference
to app.

Properties
Property Value type What it is
activeDocument Document Read-write. The frontmost document.
Setting this property is equivalent to clicking an
open document in the Adobe Photoshop
application to bring it to the front of the screen.

Tip: If there is no open document, accessing this

property throws an exception.
backgroundColor SolidColor Read-write. The default background color and color
style for documents.
build string Read-only. Information about the application.
cloudWorkAreaDirectory alias Read-only. Local directory for all cloud documents.
colorSettings string Read-write. The name of the current color settings,
as selected with Edit > Color Settings.
currentTool string Read-write. The name of the current tool selected.
displayDialogs DialogModes Read-write. The dialog mode for the application,
which controls what types of dialogs should be
displayed when running scripts.
documents Documents Read-only. The collection of open documents.
This is the primary point of access for documents
that are currently open in the application. The array
allows you to access any open document, or to
iterate through all open documents.
fonts TextFonts Read-only. The fonts installed on this system.
foregroundColor SolidColor Read-write. The default foreground color (used to
paint, fill, and stroke selections).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 46

Property Value type What it is (Continued)

freeMemory number Read-only. The amount of unused memory
available to Adobe Photoshop.
locale string Read-only. The language location of the
application.
An Adobe locale code consists of a 2-letter ISO-639
language code and an optional 2-letter ISO 3166
country code separated by an underscore. Case is
significant. For example, en_US, en_UK, ja_JP, de_DE,
fr_FR.

macintoshFileTypes array of string Read-only. A list of file image types Adobe

Photoshop can open.
measurementLog MeasurementLog The log of measurements taken.
name string Read-only. The application's name.
notifiers Notifiers Read-only. The collection of notifiers currently
configured (in the Scripts Events Manager menu in
the Adobe Photoshop application).
notifiersEnabled boolean Read-write. True if all notifiers are enabled.
path File Read-only. The full path to the location of the
Adobe Photoshop application.
playbackDisplayDialogs DialogModes Read-write. The dialog mode for playback mode,
which controls what types of dialog to display
when playing back a recorded action with the
Actions palette.
playbackParameters ActionDescriptor Read-write. Stores and retrieves parameters used as
part of a recorded action. Can be used, for example,
to control playback speed.
preferences Preferences Read-only. The application preference settings
(equivalent to selecting Edit > Preferences in the
Adobe Photoshop application in Windows or
Photoshop > Preferences in Mac OS).
preferencesFolder File Read-only. The full path to the Preferences folder.
recentFiles array of File Read-only. Files in the Recent Files list.
scriptingBuildDate string Read-only. The build date of the Scripting interface.
scriptingVersion string Read-only. The version of the Scripting interface.
systemInformation string Read-only. Runtime details of the application and
system.
typename string Read-only. The class name of the referenced app
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 47

Property Value type What it is (Continued)

version string Read-only. The version of Adobe Photoshop
application you are running.
windowsFileTypes array of string Read-only. A list of file image extensions Adobe
Photoshop can open.

Methods
Method Parameter type Returns What it does
batch string Runs the batch automation routine
(inputFiles, array of File (similar to the File > Automate >
action, string
string Batch command).
from
[, options]) BatchOptions The inputFiles parameter specifies
the sources for the files to be
manipulated by the batch command.
beep Causes a "beep" sound.
()

bringToFront Makes Adobe Photoshop the active

() (front-most) application.
changeProgressText Changes the text that appears in the
(progressString) string progress window.
The progressString parameter is the
string to show in the progress
window.
charIDToTypeID number Converts from a four character code
(charID) string (character ID) to a runtime ID.
compareWithNumbers number 0: They are equal.
(first, second) string
string Less than 0: Either the value of the
first character that does not match is
lower in the compared string, or all
compared characters match but the
compared string is shorter.
Greater than 0: Either the value of the
first character that does not match is
greater in the compared string, or all
compared characters match but the
compared string is longer.
When a number is encountered it is
converted from a string to a number.
For example, A1, A2, A10 would be
the sorting order, instead of A1, A10,
A2 with the normal sort routine.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 48

Method Parameter type Returns What it does (Continued)

doAction Plays an action from the Actions
(action, string palette. The action parameter is the
from) string
name of the action, the from
parameter is the name of the action
set.
doForcedProgress Performs a task with a progress bar.
(progressString, string Forces progress bar to display,
javaScriptString) string
ignoring the normal heuristics that
keep it from showing unnecessarily
(for example, during very short tasks).
Other progress APIs must be called
periodically to update the progress
bar and allow canceling.
The progressString parameter is the
string to show in the progress
window, the javaScriptString
parameter is the string to execute.
doProgress Performs a task with a progress bar.
(progressString, string Other progress APIs must be called
javaScriptString) string
periodically to update the progress
bar and allow canceling.
The progressString parameter is the
string to show in the progress
window, the javaScriptString
parameter is the string to execute.
doProgressSegmentTask boolean Sections-off a portion of the unused
(segmentLength, number progress bar for execution of a
done, number
number subtask. Returns false on cancel. This
total,
javaScriptString) string method should be used when
iterating a list of tasks with unequal
run times.
The segmentLength parameter is the
length of the current task, the done
parameter is the total length of all
completed tasks, the total
parameter is the total length of all
tasks. The javaScriptString
parameter is the string to execute.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 49

Method Parameter type Returns What it does (Continued)

doProgressSubTask boolean Sections-off a portion of the unused
(index, number progress bar for execution of a
limit, number
string subtask. Returns false on cancel. This
javaScriptString)
method should be used when
iterating a list of tasks with equal run
times.
The index parameter is the 0-based
index of the current task, the limit
parameter is the total number of
tasks, and the javaScriptString
parameter is the string to execute.
doProgressTask boolean Sections-off a portion of the unused
(taskLength, number progress bar for execution of a
javaScriptString) string
subtask. Returns false on cancel.
The taskLength parameter is the
amount of the unused progress bar to
section-off between 0.0 and 1.0. The
javaScriptString parameter is the
string to execute.
eraseCustomOptions Erases the user object with specified
(key) string ID value from the Photoshop registry.

executeAction ActionDescriptor Plays an Action Manager event.

(eventID number
[, descriptor] ActionDescriptor
[, displayDialogs]) DialogModes

executeActionGet ActionDescriptor Obtains information about a

(reference) ActionReference predefined or recorded action.
featureEnabled boolean Determines whether the feature
(name) string specified by name is enabled.
The following features are supported
as values for name:
"photoshop/extended"
"photoshop/standard"
"photoshop/trial"

getCustomOptions ActionDescriptor Retreives user objects in the

(key) string Photoshop registry for the ID with
value key.
isQuicktimeAvailable boolean Returns true if Quicktime is installed.
()

load Loads a support file (as opposed to a

(document) File Photoshop image document) from
the specified location.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 50

Method Parameter type Returns What it does (Continued)

makeContactSheet string DEPRECATED for Adobe Photoshop CS4.
(inputFiles array of File
[, options]) ContactSheetOptions

makePDFPresentation string DEPRECATED for Adobe Photoshop CS4.

(inputFiles, array of File
outputFiles File
[, options]) PresentationOptions

makePhotoGallery string DEPRECATED for Adobe Photoshop CS4.

(inputFolder, File
outputFolder File
[, options]) GalleryOptions

makePhotomerge string DEPRECATED for Adobe Photoshop. Use

(inputFiles) array of File provided script:
runphotomergeFromScript = true;
$.evalFile( app.path +
"Presets/Scripts/Photomerge.jsx")
photomerge.createPanorama(
fileList, displayDialog );
Merges multiple files into one, with
user interaction required.
makePicturePackage string DEPRECATED for Adobe Photoshop CS4.
(inputFiles array of File
[, options]) PicturePackageOptio
ns

open Document Opens the specified document.

(document File
[, as] object or Use the optional as parameter to
OpenDocumentType specify the file format using the
[, asSmartObject])
boolean
constants in OpenDocumentType; or,
you can specify a file format together
with its open options using these
objects:
CameraRAWOpenOptions
DICOMOpenOptions
EPSOpenOptions
PDFOpenOptions
PhotoCDOpenOptions
RawFormatOpenOptions
Use the optional parameter
asSmartObject (default: false) to
create a smart object around the
opened document.
See the Application sample scripts for
an example of using the File object
in the open method.
openDialog array of File Invokes the Photoshop Open dialog
() box for the user to select files.
Returns an array of File objects for
the files selected in the dialog.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 51

Method Parameter type Returns What it does (Continued)

purge Purges one or more caches.
(target) PurgeTarget

putCustomOptions Saves a customized settings object in

(key, string the Photoshop registry.
customObject ActionDescriptor
[, persistent]) boolean key is the unique identifier for your
custom settings.
customObject is the object to save in
the registry.
persistent indicates whether the
object should persist once the script
has finished.
refresh Pauses the script while the
() application refreshes. Use to slow
down execution and show the results
to the user as the script runs. Use
carefully; your script runs much more
slowly when using this method.
refreshFonts Force the font list to get updated.
()

runMenuItem number Run a menu item given the menu ID.

(menuID)

showColorPicker boolean Returns false if dialog is cancelled,

() true otherwise.
stringIDToTypeID number Converts from a string ID to a runtime
(stringID) string ID.
togglePalettes Toggle palette visibility.
()

toolSupportsBrushes string boolean Returns true if the specified tool

(tool) supports brushes, false otherwise.
toolSupportsBrushPresets string boolean Returns true if the brush supports
(tool) presets.
typeIDToCharID string Converts from a runtime ID to a
(typeID) number character ID.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 52

Method Parameter type Returns What it does (Continued)

typeIDToStringID string Converts from a runtime ID to a string
(typeID) number ID.
updateProgress boolean Updates the progress bar started by
(done, number doProgress method. This method
total) number
should be used for manual non-task
based progress updating. Returns
false on cancel.
The done parameter is the number of
tasks completed and the total
parameter the total number of tasks.

Application sample scripts

Application.jsx
This script invokes an alert box to display Properties important to an application such as version number,
the path to the application, the amount of memory available, and the number of documents open.

When a user presses the OK button on the alert box, a second dialog opens, which asks users whether they
would like the foreground and background colors set for the document presently open. If no document is
open, the script opens a new document for the user.

The script (with no document open) produces a progression of three dialogs.

//Create a Welcome message
// Use the name and version properties of the application object to
// Append the application’s name and version to the Welcome message
// use "\r" to insert a carriage return
// use the combination operator += to append info to the message
var message = "Welcome to " + app.name
message += " version " + app.version + "\r\r"

// find out where Adobe Photoshop is installed

// and add the path to the message
// add the optional parameter fsName to the path property
// to display the file system name in the most common format
message += "I’m installed in " + app.path.fsName + "\r\r"

// see how much memory Adobe Photoshop has to play with

message += "You have this much memory available for Adobe Photoshop CC: " +
app.freeMemory + "\r\r"

// use the length property of the documents object to

// see how many documents are open
var documentsOpen = app.documents.length
message += "You currently have " + documentsOpen + " document(s) open.\r\r"

// display the message to the user

alert(message)

// answer will be true for a "Yes" answer and false for a "No" answer
var answer = confirm("Set the foreground and background to my favorite colors?")

// set the colors

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 53

if (answer) {
// I don’t have a favorite color. Why did I ask you may wonder?
app.foregroundColor.rgb.red = Math.random() * 255
app.foregroundColor.rgb.green = Math.random() * 255
app.foregroundColor.rgb.blue = Math.random() * 255
app.backgroundColor.rgb.red = Math.random() * 255
app.backgroundColor.rgb.green = Math.random() * 255
app.backgroundColor.rgb.blue = Math.random() * 255
}

// Open a document
if (app.documents.length == 0) {

// use the application’s path and the offset to the samples folder
var sampleDocToOpen = File(app.path + "/Samples/Fish.psd")

// compose a message with the name of the file

message = "Would you like me to open a sample for you? ("
message += sampleDocToOpen.fsName
message += ")"

// ask the user another question

answer = confirm(message)

// open the document accordingly

if (answer) {
open(sampleDocToOpen)
}
}

PDFPresentation.jsx
This script presents a progression of images as an Adobe PDF slide show.
// use all the files in the Samples folder
var inputFolder = new Folder(app.path + "/Samples/")

// see if we have something interesting

if (inputFolder != null) {

// get all the files found in this folder that are Adobe Photoshop (.psd
format)
var inputFiles = inputFolder.getFiles("*.psd")

// output to the desktop

var outputFile = File("~/Desktop/JavaScriptPresentation.pdf")

// there are defaults but I like to set the options myself

var options = new PresentationOptions
options.presentation = true
options.view = true
options.autoAdvance = true
options.interval = 5
options.loop = true
options.transition = TransitionType.RANDOM

// create the presentation

makePDFPresentation(inputFiles, outputFile, options)

alert("Presentation file saved to: " + outputFile.fsName)

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 54

}
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 55

ArtLayer
An object within a document that contains the visual elements of the image (equivalent to a layer in the
Adobe Photoshop application).

Access an art layer in a document through the Document.artLayers collection. You can access a layer by
name; for example:
var layerRef = app.activeDocument.artLayers.getByName("my layer");
layerRef.allLocked = true;

Access the art layers in a layer set through the LayerSet.artLayers collection in the parent set.

Properties
Property Value type What it is
allLocked boolean Read-write. True to completely lock the contents and
settings of this layer.
blendMode BlendMode Read-write. The blending mode.
bounds array of Read-only. An array of coordinates that describes the
UnitValue
bounding rectangle of the layer.
boundsNoEffects array of Read-only. An array of coordinates that describes the
UnitValue
bounding rectangle of the layer not including effects.
fillOpacity number [0.0..100] Read-write. The interior opacity of the layer, a
percentage value.
filterMaskDensity double Read-write. The density of the filter mask (between
0.0 and 250.0)
filterMaskFeather double Read-write. The feather of the filter mask (between 0.0
and 250.0)
grouped boolean Read-write. True if this layer is grouped with the layer
beneath it.
isBackgroundLayer boolean Read-write. True if this is the background layer of the
document. A document can have only one
background layer. If there is no background layer,
setting this to true causes this to become the
background layer.
kind LayerKind Read-write. Sets the type (such as 'text layer') for an
empty layer.
Valid only when the layer is empty and when
isBackgroundLayer is false. See
isBackgroundLayer.
You can use the kind property to make a background
layer a normal layer; however, to make a layer a
background layer, you must set isBackgroundLayer
to true.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 56

Property Value type What it is (Continued)

layerMaskDensity double Read-write. The density of the layer mask (between
0.0 and 100.0)
layerMaskFeather double Read-write. The feather of the layer mask (between
0.0 and 250.0)
linkedLayers array of ArtLayer Read-only. The layers linked to this layer. See
or LayerSet
ArtLayer.link.
name string Read-write. The name.
opacity number [0.0..100.0]. Read-write. The master opacity of the layer, a
percentage value.
parent Document Read-only. The object's container.
pixelsLocked boolean Read-write. True if the pixels in the layer’s image
cannot be edited using the paintbrush tool.
positionLocked boolean Read-write. True if the pixels in the layer’s image
cannot be moved within the layer.
textItem TextItem Read-only. The text item that is associated with the
layer.
Valid only when kind = LayerKind.TEXT.
transparentPixelsLocked boolean Read-write. True if editing is confined to the opaque
portions of the layer.
typename string Read-only. The class name of the referenced
artLayer object.

vectorMaskDensity double Read-write. The density of the vector mask (between

0.0 and 250.0)
vectorMaskFeather double Read-write. The feather of the vector mask (between
0.0 and 250.0)
visible boolean Read-write. True if the layer is visible.
xmpMetadata xmpMetadata Read-write. Metadata for the layer.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 57

Methods
Method Parameter type Returns What it does
adjustBrightnessContrast Adjusts the brightness in the
(brightness, number range [-100..100] and contrast
contrast) number
[-100..100].
adjustColorBalance Adjusts the color balance of the
([shadows] array of number layer’s component channels. For
[, midtones] array of number
array of number shadows, midtones, and
[, highlights]
[, preserveLuminosity] boolean highlights, the array must
include three values in the
range [-100..100], which
represent cyan or red, magenta
or green, and yellow or blue,
when the document mode is
CMYK or RGB.
See Document.mode.
adjustCurves Adjusts the tonal range of the
(curveShape) array of array of number selected channel using up to
fourteen points.
Each value in the curveShape
array is a point pair, an array of
an x and y integer value.
adjustLevels Adjusts the levels of the
(inputRangeStart, number [0..253] selected channels
inputRangeEnd, number [(start + 2)..255]
inputRangeGamma, number [0.10..9.99]
outputRangeStart, number [0..253]
outputRangeEnd) number [(start + 2)..255]

applyAddNoise Applies the Add Noise filter

(amount, number [0.1..400] amount is a percentage value.
distribution, NoiseDistribution
monochromatic) boolean

applyAverage Applies the Average filter.

()

applyBlur Applies the Blur filter.

()

applyBlurMore Applies the Blur More filter.

()

applyClouds Applies the Clouds filter.

()

applyCustomFilter Applies a custom filter.

(characteristics, array of number
scale, number The characteristics array has
offset) number 25 members.
See Adobe Photoshop Help for
specific instructions.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 58

Method Parameter type Returns What it does (Continued)

applyDeInterlace Applies the De-Interlace filter.
(eliminateFields, EliminateFields
createFields) CreateFields

applyDespeckle Applies the Despeckle filter.

()

applyDifferenceClouds Applies the Difference Clouds

() filter.
applyDiffuseGlow Applies the Diffuse Glow filter.
(graininess, number [0..10]
glowAmount, number [0..20]
clearAmount) number [0..20]

applyDisplace Applies the Displace filter using

(horizontalScale, number [-999..999] the specified horizontal and
verticalScale, number [-999..999]
DisplacementMapType vertical scale, mapping type,
displacement,
undefinedareas, UndefinedAreas treatment of undistorted areas,
displacementMapFiles) File and path to the distortion
image map.
applyDustAndScratches Applies the Dust & Scratches
(radius, number [1..100] filter.
threshold) number [0..255]

applyGaussianBlur Applies the Gaussian Blur filter

(radius) number [0.1..250.0] within the specified radius (in
pixels)
applyGlassEffect Applies the Glass filter.
(distortion, number [0..20]
smoothness, number [1..15] scaling is a percentage value.
scaling number [50..200]
[, invert] boolean
[, texture] TextureType
[, textureFile]) File

applyHighPass Applies the High Pass filter

(radius) number [0.1..250.0] within the specified radius.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 59

Method Parameter type Returns What it does (Continued)

applyLensBlur Applies the Lens Blur filter.
([source] DepthMapSource
[, focalDistance] number source: The source for the
[, invertDepthMap] boolean depth map (default:
[, shape] Geometry DepthMapSource.NONE)
[, radius] number
[, bladeCurvature] number focalDistance : The blur focal
[, rotation] number distance for the depth map
[, brightness] number
number (default: 0).
[, threshold]
[, amount] number invertDepthMask : True if the
[, distribution] NoiseDistribution
boolean depth map is inverted (default:
[, monochromatic]
) false).
shape: The shape of the iris
(default: Geometry.HEXAGON)
radius: The radius of the iris
(default: 15).
bladeCurvature: The blade
curvature of the iris (default: 0).
rotation: The rotation of the
iris (default: 0)
brightness: The brightness for
the specular highlights (default:
0).
threshold: The threshold for
the specular highlights (default:
0).
amount: The amount of noise
(default: 0)
distribution: The distribution
value for the noise (default:
NoiseDistribution.UNIFORM).
monochromatic: True if the
noise is monochromatic
(default: false).
applyLensFlare Applies the Lens Flare filter with
(brightness, number the specified brightness (0 - 300,
flareCenter, array(UnitValue)
LensType as a percentage), the x and y
lensType)
coordinates (unit value) of the
flare center, and the lens type.
applyMaximum Applies the Maximum filter
(radius) number [1..100] within the specified radius (in
pixels).
applyMedianNoise Applies the Median Noise filter
(radius) number [1..100] within the specified radius (in
pixels).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 60

Method Parameter type Returns What it does (Continued)

applyMinimum Applies the Minimum filter
(radius) number [1..100] within the specified radius (in
pixels) (1 - 100).
applyMotionBlur Applies the Motion Blur filter.
(angle, number [-360..360]
radius) number [1..999]

applyNTSC Applies the NTSC colors filter.

()

applyOceanRipple Applies the Ocean Ripple filter.

(size, number [1..15]
magnitude) number [0..20]

applyOffset Moves the layer the specified

(horizontal, UnitValue amount horizontally and
vertical, UnitValue
OffsetUndefinedAreas vertically (min/max amounts
undefinedAreas)
depend on layer size), leaving
an undefined area at the layer’s
original location.
applyPinch Applies the Pinch filter.
(amount) number [-100..100]
amount is a percentage value.

applyPolarCoordinates Applies the Polar Coordinates

(conversion) PolarConversionType filter.
applyRadialBlur Applies the Radial Blur filter in
(amount, number [1..100] the specified amount, using
blurMethod, RadialBlurMethod
RadialBlurQuality either a spin or zoom effect and
blurQuality
UnitValue the specified quality. The
[, blurCenter]
) parameter blurCenter is the
position (unit value).
applyRipple Applies the Ripple filter in the
(amount, number [-999..999] specified amount, throughout
size) RippleSize
the image and in the specified
size.
applySharpen Applies the Sharpen filter.
()

applySharpenEdges Applies the Sharpen Edges filter.

()

applySharpenMore Applies the Sharpen More filter.

()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 61

Method Parameter type Returns What it does (Continued)

applyShear Applies the Shear filter. The
(curve, array of array of number curve defines a curve with
undefinedAreas) UndefinedAreas
[2..255] points.
Each value in the curve array is a
point pair, an array of an x and y
integer value.
applySmartBlur Applies the Smart Blur filter.
(radius, number [0.1..100.0]
threshold, number [0.1..100.0]
blurQuality, SmartBlurQuality
mode) SmartBlurMode

applySpherize Applies the Spherize filter.

(amount, number [-100..100]
SpherizeMode amount is a percentage value.
mode)

applyStyle Applies the specified style to the

(styleName) string layer. You must use a style from
the Styles list in the Layer Styles
Palette.
applyTextureFill Applies the Texture Fill filter.
(textureFile) File

applyTwirl Applies the Twirl filter.

(angle) number [-999..999]

applyUnSharpMask Applies the Unsharp Mask filter.

(amount, number [1..500] (amount is a percentage value.
radius, number [0.1..250.0]
threshold) number [0..255]

applyWave Applies the Wave filter.

(generatorNumber, number [1..999]
number [1..998] Scale factors are percentage
minimumWavelength,
maximumWavelength, number [2..min+1] values.
minimumAmplitude, number[1..998]
maximumAmplitude, number [2..min+1]
horizontalScale, number [1..100]
verticalScale, number [1..100]
waveType, WaveType
undefinedAreas, UndefinedAreas
randomSeed) number

applyZigZag Applies the Zigzag filter.

(amount, number [-100..100]
ridges, number [0..20]
style) ZigZagType

autoContrast Adjusts the contrast of the

() selected channels automatically.
autoLevels Adjusts the levels of the
() selected channels using the
auto levels option.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 62

Method Parameter type Returns What it does (Continued)

clear Cuts the layer without moving it
() to the clipboard.
copy Copies the layer to the
([merge]) boolean clipboard. When the optional
argument is set to true, a
merged copy is performed (that
is, all visible layers are copied to
the clipboard).
cut Cuts the layer to the clipboard.
()

desaturate Converts a color image to a

() grayscale image in the current
color mode by assigning equal
values of each component color
to each pixel.
duplicate ArtLayer Creates a duplicate of the object
ArtLayer or LayerSet or
([relativeObject]
ElementPlacement LayerSet on the screen.
[, insertionLocation])

equalize Redistributes the brightness

() values of pixels in an image to
more evenly represent the
entire range of brightness levels
within the image.
invert Inverts the colors in the layer by
() converting the brightness value
of each pixel in the channels to
the inverse value on the
256-step color-values scale.
link Links the layer with the
(with) ArtLayer or LayerSet specified layer.
merge ArtLayer Merges the layer down,
() removing the layer from the
document; returns a reference
to the art layer that this layer is
merged into.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 63

Method Parameter type Returns What it does (Continued)

mixChannels Modifies a targeted (output)
(outputChannels array of array of number color channel using a mix of the
[, monochrome]) boolean
existing color channels in the
image.
The outputChannels
parameter is an array of channel
specifications. For each
component channel, specify a
list of adjustment values in the
range [-200..200] followed by a
'constant' value [-200..200].)
When monochrome = true, the
maximum number of channel
value specifications is 1.
Valid only when docRef.mode =
DocumentMode.RGB or CMYK.
RGB arrays must include four
values. CMYK arrays must
include five values.
move Moves the layer relative to the
(relativeObject, ArtLayer or LayerSet object specified in parameters.
insertionLocation) ElementPlacement
For art layers, only the constant
values ElementPlacement.
PLACEBEFORE and PLACEAFTER
are valid.
For layer sets, only the constant
values ElementPlacement.
PLACEBEFORE and INSIDE are
valid.
photoFilter Adjust the layer’s color balance
([fillColor] SolidColor and temperature as if a color
[, density] number [1..100]
boolean filter had been applied.
[, preserveLuminosity])
density is a percentage value.

posterize Specifies the number of tonal

(levels) number [2..225] levels for each channel and then
maps pixels to the closest
matching level.
rasterize Converts the targeted contents
(target) RasterizeType in the layer into a flat, raster
image.
remove Deletes the object.
()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 64

Method Parameter type Returns What it does (Continued)

resize Resizes the layer to the specified
([horizontal] number dimensions (as a percentage of
[, vertical] number
AnchorPosition its current size) and places it in
[, anchor])
the specified position.
rotate Rotates rotates the layer around
(angle number the specified anchor point
[, anchor]) AnchorPosition
(default: MIDDLECENTER).
selectiveColor Modifies the amount of a
(selectionMethod AdjustmentReference process color in a specified
[, reds] array of number
array of number primary color without affecting
[, yellows]
array of number the other primary colors.
[, greens]
[, cyans] array of number
array of number Each color array must have four
[, blues]
array of number values.
[, magentas]
[, whites] array of number
[, neutrals] array of number
[, blacks]) array of number

shadowHighlight Adjusts the range of tones in the

([shadowAmount] number [0..100] image’s shadows and highlights.
[, shadowWidth] number [0.100]
[, shadowRadius] number [0..2500] Amounts and widths are
[, highlightAmount] number [0..100] percentage values. Radius
[, highlightWidth] number [0..100]
number [0..2500] values are in pixels.
[, highlightRadius]
[, colorCorrection] number [-100..100]
[, midtoneContrast] number [-100..100]
[, blackClip] number [0.000..50.000]
[, whiteClip]) number [0.000..50.000]

threshold Converts grayscale or color

(level) number [1..255] images to high-contrast, B/W
images by converting pixels
lighter than the specified
threshold to white and pixels
darker than the threshold to
black.
translate Moves the layer the specified
([deltaX] UnitValue amount (in the given unit)
[, deltaY]) UnitValue
relative to its current position.

unlink Unlinks the layer.

()

ArtLayer sample Script

The following script opens all the files in the samples folder, creating one multi-layered document. Each
layer is pasted into one of four quadrants and given 50% transparency. Finally the layers are sorted by
name.

ArtLayer.jsx
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 65

// Save the current preferences

var startRulerUnits = app.preferences.rulerUnits
var startTypeUnits = app.preferences.typeUnits
var startDisplayDialogs = app.displayDialogs

// Set Adobe Photoshop to use pixels and display no dialogs

app.preferences.rulerUnits = Units.PIXELS
app.preferences.typeUnits = TypeUnits.PIXELS
app.displayDialogs = DialogModes.NO

//Close all the open documents

while (app.documents.length) {
app.activeDocument.close()
}

// Create a new document to merge all the samples into

var mergedDoc = app.documents.add(1000, 1000, 72, "Merged Samples",
NewDocumentMode.RGB, DocumentFill.TRANSPARENT, 1)

// Use the path to the application and append the samples folder
var samplesFolder = Folder(app.path + "/Samples/")

//Get all the files in the folder

var fileList = samplesFolder.getFiles()

// open each file

for (var i = 0; i < fileList.length; i++) {
// The fileList is folders and files so open only files
if (fileList[i] instanceof File) {
open(fileList[i])

// use the document name for the layer name in the merged document
var docName = app.activeDocument.name

// flatten the document so we get everything and then copy

app.activeDocument.flatten()
app.activeDocument.selection.selectAll()
app.activeDocument.selection.copy()

// don’t save anything we did

app.activeDocument.close(SaveOptions.DONOTSAVECHANGES)

// make a random selection on the document to paste into

// by dividing the document up in 4 quadrants and pasting
// into one of them by selecting that area
var topLeftH = Math.floor(Math.random() * 2)
var topLeftV = Math.floor(Math.random() * 2)
var docH = app.activeDocument.width.value / 2
var docV = app.activeDocument.height.value / 2
var selRegion = Array(Array(topLeftH * docH, topLeftV * docV),
Array(topLeftH * docH + docH, topLeftV * docV),
Array(topLeftH * docH + docH, topLeftV * docV + docV),
Array(topLeftH * docH, topLeftV * docV + docV),
Array(topLeftH * docH, topLeftV * docV))
app.activeDocument.selection.select(selRegion)
app.activeDocument.paste()

// change the layer name and opacity

app.activeDocument.activeLayer.name = docName
app.activeDocument.activeLayer.fillOpacity = 50
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 66

}
}

// sort the layers by name

for (var x = 0; x < app.activeDocument.layers.length; x++) {
for (var y = 0; y < app.activeDocument.layers.length - 1 - x; y++) {
// Compare in a non-case sensitive way
var doc1 = app.activeDocument.layers[y].name
var doc2 = app.activeDocument.layers[y + 1].name
if (doc1.toUpperCase() > doc2.toUpperCase()) {
app.activeDocument.layers[y].move(app.activeDocument.layers[y+1],
ElementPlacement.PLACEAFTER)
}
}
}

// Reset the application preferences

app.preferences.rulerUnits = startRulerUnits
app.preferences.typeUnits = startTypeUnits
app.displayDialogs = startDisplayDialogs
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 67

ArtLayers
The collection of ArtLayer objects in a document or layer set.

Access through the Document.artLayers or LayerSet.artLayers collection. For example:

var layerRef = docRef.artLayers.add()

Properties
Property Value type What it is
length number Read-only. The number of elements in the artLayers
collection.
parent Document Read-only. The object's container.
typename string Read-only. The class name of the referenced
artLayers object.

Methods
Method Parameter type Returns What it does
add ArtLayer Creates a new art layer in the
() document and adds the new object to
this collection.
getByName ArtLayer Get the first element in the artLayers
(name) string collection with the provided name.
removeAll Removes all elements from the
() artLayers collection.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 68

BatchOptions
Options for running a batch operation using the Application.batch() method.

JavaScript only supports folders as sources for batch commands. Specify the batch source folder as the
inputFiles parameter of the Application.batch() method.

Properties
Property Value type What it is
destination BatchDestinationType Read-write. The type of destination for the
processed files (default:
BatchDestinationType.NODESTINATION).

destinationFolder Folder Read-write. The folder location for the processed

files.
Valid only when destination =
BatchDestinationType.FOLDER.

errorFile File Read-write. The file in which to log errors

encountered.
To display errors on the screen (and stop batch
processing when errors occur) leave blank.
fileNaming array of Read-write. A list of file naming options
FileNamingType
(maximum: 6).
Valid only when destination =
BatchDestinationType.FOLDER.

macintoshCompatible boolean Read-write. True to make the final file names

Macintosh compatible (default: true).
Valid only when destination =
BatchDestinationType.FOLDER.

overrideOpen boolean Read-write. True to override action open

commands (default: false).
overrideSave boolean Read-write. True to override save as action steps
with the specified destination (default: false).
Valid only when destination =
BatchDestinationType.FOLDER or
SAVEANDCLOSE.

startingSerial number Read-write. The starting serial number to use in

naming files (default: 1).
Valid only when destination =
BatchDestinationType.FOLDER.

suppressOpen boolean Read-write. True to suppress the file open options

dialogs (default: false).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 69

Property Value type What it is (Continued)

suppressProfile boolean Read-write. True to suppress the color profile
warnings (default: false).
typename string Read-only. The class name of the referenced
batchOptions object.

unixCompatible boolean Read-write. True to make the final file name Unix
compatible (default: true).
Valid only when destination =
BatchDestinationType.FOLDER.

windowsCompatible boolean Read-write. True to make the final file names

Windows compatible (default: true).
Valid only when destination =
BatchDestinationType.FOLDER.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 70

BitmapConversionOptions
Options for converting an image to bitmap mode, using Document.changeMode() with
ChangeMode.Bitmap.

Convert color images to grayscale before converting the image to bitmap mode. See the
ArtLayer.desaturate() method.

Properties
Property Value type What it is
angle number [-180..180] Read-write. The angle (in degrees) at which to
orient individual dots. See shape.
Valid only when method =
BitmapConversionType.HALFTONESCREEN.

frequency number [1.0..999.99] Read-write. The number of printer dots (per inch) to
use.
Valid only when method =
BitmapConversionType.HALFTONESCREEN.

method BitmapConversionType Read-write. The conversion method to use (default:

BitmapConversionType.DIFFUSIONDITHER).

patternName string Read-write. The name of the pattern to use.

For information about pre-installed valid patterns,
see Adobe Photoshop Help on the bitmap
conversion command, or view the options availabe
in the Custom Color drop down box after choosing
the bitmap conversion command.
Valid only when method =
BitmapConversionType.CUSTOMPATTERN.

resolution number Read-write. The output resolution in pixels per inch

(default: 72.0).
shape BitmapHalfToneType Read-write. The dot shape to use.
Valid only when method =
BitmapConversionType.HALFTONESCREEN.

typename string Read-only. The class name of the referenced

bitmapConversionOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 71

BMPSaveOptions
Options for saving a document in BMP format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha channels.
depth BMPDepthType Read-write. The number of bits per channel.
flipRowOrder boolean Read-write. True to write the image from top
to bottom (default: false).
Available only when osType =
OperatingSystem.WINDOWS.

osType OperatingSystem Read-write. The target OS.

(default: OperatingSystem.WINDOWS).
rleCompression boolean Read-write. True to use RLE compression.
Available only when osType =
OperatingSystem.WINDOWS.

typename string Read-only. The class name of the referenced

BMPSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 72

CameraRAWOpenOptions
Options for opening a document in Camera RAW format using the Application.open() method.

Properties
Property Value type What it is
bitsPerChannel BitsPerChannelType Read-write. The number of bits per channel.
blueHue number [-100..100] Read-write. The blue hue of the shot.
blueSaturation number [-100..100] Read-write. The blue saturation of the shot.
brightness number [0..150] Read-write. The brightness of the shot.
chromaticAberrationBY number [-100..100] Read-write. The chromatic aberration B/Y of the
shot.
chromaticAberrationRC number [-100..100] Read-write. The chromatic aberration R/C of the
shot
colorNoiseReduction number [0..100] Read-write. The color noise reduction of the
shot.
colorSpace ColorSpaceType Read-write. The colorspace for the image.
contrast number [-50..100] Read-write. The contrast of the shot.
exposure number [-4.0..4.0] Read-write. The exposure of the shot.
greenHue number [-100..100] Read-write. The green hue of the shot.
greenSaturation number [-100..100] Read-write. The green saturation of the shot.
luminanceSmoothing number [0..100] Read-write. The luminance smoothing of the
shot.
redHue number [-100..100] Read-write. The red hue of the shot.
redSaturation number [-100..100] Read-write. The red saturation of the shot.
resolution number [1..999] Read-write. The resolution of the document in
pixels per inch.
saturation number [-100..100] Read-write. The saturation of the shot.
settings CameraRAWSettingsType Read-write. The global settings for all Camera
RAW options. Default:
CameraRAWSettingsType.CAMERA.

shadows number [0..100] Read-write. The shadows of the shot.

shadowTint number [-100..100] Read-write. The shadow tint of the shot.
sharpness number [0..100] Read-write. The sharpness of the shot.
size CameraRAWSize Read-write. The size of the new document.
temperature number [2000..50000] Read-write. The temperature of the shot.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 73

Property Value type What it is (Continued)

tint number [-150..150] Read-write. The tint of the shot.
typename string Read-only. The class name of the referenced
cameraRAWOpenOptions object.

vignettingAmount number [-100..100] Read-write. The vignetting amount of the shot.

vignettingMidpoint number [-100..100] Read-write. The vignetting mid point of the
shot.
whiteBalance WhiteBalanceType Read-write. The white balance options for the
image. These are lighting conditions that affect
color balance.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 74

Channel
Information about a color element in the image.

Access through the Document.channels collection. You can access an individual channel object in this list
by index or by name. For example, this accesses a channel object in the active document by name and
assigns an opacity value:
var channelRef = app.activeDocument.channels.getByName("my channel");
channelRef.opacity = 22;

A channel is analogous to a plate in the printing process that applies a single color. The document’s color
mode determines the number of default channels; for example, an RGB document has three channels, red,
green, and blue. A color can also have an alpha channel, which stores selections as masks, or a spot
channel, which stores spot colors.

Properties
Property Value type What it is
color SolidColor Read-write. The color of the channel.
Not valid when kind = ChannelType.COMPONENT.
histogram array of number Read-only. A histogram of the color of the channel. The
array contains 256 members.
Not valid when kind = ChannelType.COMPONENT. For
component channel histogram values, use the histogram
property of the Document object instead.
kind ChannelType Read-write. The type of the channel.
name string Read-write. The name of the channel.
opacity number [0..100] Read-write. The opacity to use for alpha channels or the
solidity to use for spot channels.
Valid only when kind = ChannelType.MASKEDAREA or
SELECTEDAREA.

parent Document Read-only. The containing document.

typename string Read-only. The class name of the referenced channel
object.
visible boolean Read-write. True if the channel is visible.

Methods
Method Parameter type Returns What it does
duplicate Channel Duplicates the channel.
([targetDocument]) Document
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 75

Method Parameter type Returns What it does

merge Merges a spot channel into the
() component channels.
remove Deletes the channel.
()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 76

Channels
The collection of Channel objects in a document.

Access through the Document.channels collection property. For example:

var channelRef = app.activeDocument.channels.add()

Properties
Property Value type What it is
length number Read-only. The number of elements in the channels
collection.
parent Document Read-only. The containing document.
typename string Read-only. The class name of the referenced channels
object.

Methods
Method Parameter type Returns What it does
add Channel Creates a new channel object and
() adds it to this collection.
getByName Channel Get the first element in the channels
(name) string collection with the provided name.
removeAll Removes all alpha channel objects
() from the channels collection.

Channels sample script

The following script opens a file if one is not already open, and then writes a histogram report
(histogram.log) for the channels in the active document.

Note: This script contains a switch construction that uses a break statement. The break statement
requires an ending semicolon (;), as in the following sample:
break;

Histogram.jsx

// Function to activate all the channels according to the documents mode

// Takes a document reference for input
function TurnOnDocumentHistogramChannels(inDocument) {

// see how many channels we need to activate

var visibleChannelCount = 0

// based on the mode of the document

switch (inDocument.mode) {

case DocumentMode.BITMAP:
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 77

case DocumentMode.GRAYSCALE:
case DocumentMode.INDEXEDCOLOR:
visibleChannelCount = 1
break;

case DocumentMode.DUOTONE:
visibleChannelCount = 2
break;

case DocumentMode.RGB:
case DocumentMode.LAB:
visibleChannelCount = 3
break;

case DocumentMode.CMYK:
visibleChannelCount = 4
break;

case DocumentMode.MULTICHANNEL:
default:
visibleChannelCount = inDocument.channels.length + 1
break;
}

// now get the channels to activate into a local array

var aChannelArray = new Array()

// index for the active channels array

var aChannelIndex = 0

for(var channelIndex = 0; channelIndex < inDocument.channels.length;

channelIndex++) {
if (channelIndex < visibleChannelCount) {
aChannelArray[aChannelIndex++] = inDocument.channels[channelIndex]
}
}

// now activate them

inDocument.activeChannels = aChannelArray

// Save the current preferences

var startRulerUnits = app.preferences.rulerUnits
var startTypeUnits = app.preferences.typeUnits
var startDisplayDialogs = app.displayDialogs

// Set Adobe Photoshop to use pixels and display no dialogs

app.preferences.rulerUnits = Units.PIXELS
app.preferences.typeUnits = TypeUnits.PIXELS
app.displayDialogs = DialogModes.NO

// if there are no documents open then try to open a sample file

if (app.documents.length == 0) {
open(File(app.path + "/Samples/Fish.psd"))
}

// get a reference to the working document

var docRef = app.activeDocument
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 78

// create the output file

// first figure out which kind of line feeds we need
if ($.os.search(/windows/i) != -1) {
fileLineFeed = "Windows"
} else {
fileLineFeed = "Macintosh"
}

// create the output file accordingly

fileOut = new File("~/Desktop/Histogram.log")
fileOut.lineFeed = fileLineFeed
fileOut.open("w", "TEXT", "????")

// write out a header

fileOut.write("Histogram report for " + docRef.name)

// find out how many pixels I have

var totalCount = docRef.width.value * docRef.height.value

// more info to the out file

fileOut.write(" with a total pixel count of " + totalCount + "\n")

// channel indexer
var channelIndex = 0

// remember which channels are currently active

var myActiveChannels = app.activeDocument.activeChannels

// document histogram only works in these modes

if (docRef.mode == DocumentMode.RGB ||
docRef.mode == DocumentMode.INDEXEDCOLOR ||
docRef.mode == DocumentMode.CMYK) {

// activate the main channels so we can get the documents histogram

TurnOnDocumentHistogramChannels(docRef)

// Output the documents histogram

OutputHistogram(docRef.histogram, "Luminosity", fileOut)
}

// local reference to work from

var myChannels = docRef.channels

// loop through each channel and output the histogram

for (var channelIndex = 0; channelIndex < myChannels.length; channelIndex++) {

// the channel has to be visible to get a histogram

myChannels[channelIndex].visible= true

// turn off all the other channels

for (var secondaryIndex = 0; secondaryIndex < myChannels.length;
secondaryIndex++) {
if (channelIndex != secondaryIndex) {
myChannels[secondaryIndex].visible= false
}
}

// Use the function to dump the histogram

OutputHistogram(myChannels[channelIndex].histogram,
myChannels[channelIndex].name, fileOut)
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 79

// close down the output file

fileOut.close()
alert("Histogram file saved to: " + fileOut.fsName)

// reset the active channels

docRef.activeChannels = myActiveChannels

// Reset the application preferences

app.preferences.rulerUnits = startRulerUnits
app.preferences.typeUnits = startTypeUnits
app.displayDialogs = startDisplayDialogs

// Utility function that takes a histogram and name

// and dumps to the output file
function OutputHistogram(inHistogram, inHistogramName, inOutFile) {

// find ouch which count has the largest number

// I scale everything to this number for the output
var largestCount = 0

// a simple indexer I can reuse

var histogramIndex = 0

// see how many samples we have total

var histogramCount = 0

// search through all and find the largest single item

for (histogramIndex = 0; histogramIndex < inHistogram.length;
histogramIndex++) {
histogramCount += inHistogram[histogramIndex]
if (inHistogram[histogramIndex] > largestCount)
largestCount = inHistogram[histogramIndex]
}

// These should match

if (histogramCount != totalCount) {
alert("Something bad is happening!")
}

// see how much each "X" is going to count as

var pixelsPerX = largestCount / 100

// output this data to the file

inOutFile.write("One X = " + pixelsPerX + " pixels.\n")

// output the name of this histogram

inOutFile.write(inHistogramName + "\n")

// loop through all the items and output in the following format
// 001
// 002
for (histogramIndex = 0; histogramIndex < inHistogram.length;
histogramIndex++) {

// I need an extra "0" for this line item to keep everything in line
if (histogramIndex < 10)
inOutFile.write("0")
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 80

// I need an extra "0" for this line item to keep everything in line
if (histogramIndex < 100)
inOutFile.write("0")

// output the index to file

inOutFile.write(histogramIndex)

// some spacing to make it look nice

inOutFile.write(" ")

// figure out how many X’s I need

var outputX = inHistogram[histogramIndex] / largestCount * 100

// output the X’s

for (var a = 0; a < outputX; a++)
inOutFile.write("X")

inOutFile.write("\n")
}

inOutFile.write("\n")
}
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 81

CMYKColor
Defines a CMYK color, used in the SolidColor object.

See also GrayColor, HSBColor, LabColor, NoColor, RGBColor

Properties
Property Value type What it is
black number [0.0..100.00] Read-write. The black color value (as percent).
cyan number [0.0..100.00] Read-write. The cyan color value (as percent).
magenta number [0.0..100.00] Read-write. The magenta color value (as percent).
typename string Read-only. The class name of the referenced CMYKColor
object.
yellow number [0.0..100.00] Read-write. The yellow color value (as percent).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 82

ColorSampler
A color sampler for a document. Access through the Document.colorSamplers collection. For example:
var colorSamplerRef = app.activeDocument.colorSamplers[0];
var currentColor = colorSamplerRef.color;

Note: For additional information about color samplers, see Adobe Photoshop help on the Color
SamplerTool.

Properties
Property Value type What it is
color SolidColor Read-only. The color of the color sampler.
position array of Read-only. The position of the color sampler in the
UnitValue
document. The array (x,y) represents the horizontal and
vertical location of the count item.
parent Document Read-only. The containing document.
typename string Read-only. The class name of the referenced ColorSampler
object.

Methods
Method Parameter type Returns What it does
move Moves the color sampler to a new location
(position) array of in the document.
UnitValue
The position parameter (x,y) represents
the new horizontal and vertical locations
of the moved color sampler.
remove Deletes the ColorSampler object.
()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 83

ColorSamplers
The collection of ColorSampler objects in a document. Access through the Document.colorSamplers
collection property. For example:
app.activeDocument.colorSamplers.removeAll()

Properties
Property Value type What it is
length number Read-only. The number of elements in the
ColorSamplers collection.

parent Document Read-only. The containing document.

typename string Read-only. The class name of the referenced
ColorSamplers object.

Methods
Method Parameter type Returns What it does
add ColorSampler Creates a new color sampler object
(position) array of UnitValue and adds it to this collection.
The position parameter (x,y)
represents the new horizontal and
vertical locations of the moved color
sampler.
removeAll Removes all ColorSampler objects
() from the ColorSamplers collection.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 84

ContactSheetOptions
Options for creating a contact sheet with the Application.makeContactSheet() method.

Properties
Property Value type What it is
acrossFirst boolean Read-write. True to place the images horizontally
(left to right, then top to bottom) first (default: true).
bestFit boolean Read-write. True to rotate images for the best fit
(default: false).
caption boolean Read-write. True to use the filename as a caption for
the image (default: true).
columnCount number[1..100] Read-write. The number of columns to include
(default: 5).
flatten boolean Read-write. True to flatten all layers in the final
document (default: true).
font GalleryFontType Read-write. The font used for the caption (default:
GalleryFontType.ARIAL).

fontSize number Read-write. The font size to use for the caption
(default: 12).
height number [0..29000] Read-write. The height (in pixels) of the resulting
document (default: 720).
horizontal number Read-write. The horizontal spacing (in pixels)
between images (default: 1).
mode NewDocumentMode Read-write. The document color mode (default:
NewDocumentMode.RGB).

resolution number [35..1200] Read-write. The resolution of the document in pixels

per inch (default: 72.0).
rowCount number [1..100] Read-write. The number of rows to use (default: 6).
typename string Read-only. The class name of the referenced
contactSheetOptions object.

useAutoSpacing boolean Read-write. True to auto space the images (default:

true).

vertical number [0..29000] Read-write. The vertical spacing (in pixels) between
images (default: 1).
Valid only when useAutoSpacing = false.
width number [100..29000] Read-write. The width (in pixels) of the resulting
document (default: 576).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 85

CountItem
A counted item in a document. Access through the Document.countItems collection. See the
Document.autoCount() method.

Note: This feature is available in the Extended Version only.

For additional information about count items, see Adobe Photoshop help on the Count Tool.

Properties
Property Value type What it is
position array of Read-only. The position of the count item in the document.
UnitValue

parent Document Read-only. The containing document.

typename string Read-only. The class name of the referenced CountItem
object.

Methods
Method Parameter type Returns What it does
remove Deletes the CountItem object.
()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 86

CountItems
The collection of CountItem objects in the document.

Access through the Document.countItems collection property. For example:

app.activeDocument.countItems.removeAll()

Note: This feature is available in the Extended Version only.

Properties
Property Value type What it is
length number Read-only. The number of elements in the CountItems
collection.
parent Document Read-only. The containing document.
typename string Read-only. The class name of the referenced CountItems
object.

Methods
Method Parameter type Returns What it does
add CountItem Creates a new count item object and
(position) array of UnitValue adds it to this collection.
Parameter position (x,y) represents
the horizontal and vertical positions,
respectively, of the CountItem object.
getByName CountItem Get the first element in the
(name) string CountItems collection with the
provided name.
removeAll Removes all CountItem objects from
() the CountItems collection.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 87

DCS1_SaveOptions
Options for saving a CMYK document in DCS1 format using the Document.saveAs() method.

Properties
Property Value type What it is
dCS DCSType Read-write. (default: DCSType.COLORCOMPOSITE).
embedColorProfile boolean Read-write. True to embed the color profile in the
document
encoding SaveEncoding Read-write. The type of encoding to use for document
(default: SaveEncoding.BINARY).
halftoneScreen boolean Read-write. True to include halftone screen (default:
false).

interpolation boolean Read-write. True to use image interpolation (default:

false)

preview Preview Read-write. The type of preview (default:

Preview.MACOSEIGHTBIT).

transferFunction boolean Read-write. True to include the Transfer functions to

compensate for dot gain between the image and film
(default: false).
typename string Read-only. The class name of the referenced
DCS1_SaveOptions object.

vectorData boolean Read-write. True to include vector data.

Valid only if the document includes vector data
(unrasterized text).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 88

DCS2_SaveOptions
Options for saving a CMYK document in DCS2 format using the Document.saveAs() method.

Properties
Property Value type What it is
dCS DCSType Read-write. The type of composite file to create
(default: DCSType.NOCOMPOSITE).
embedColorProfile boolean Read-write. True to embed the color profile in the
document.
encoding SaveEncoding Read-write. The type of encoding to use (default:
SaveEncoding.BINARY).

halftoneScreen boolean Read-write. True to include the halftone screen

(default: false).
interpolation boolean Read-write. True to use image interpolation (default:
false).

multiFileDCS boolean Read-write. True to save color channels as multiple

files or a single file (default: false).
preview Preview Read-write. The preview type (default:
Preview.MACOSEIGHTBIT).

spotColors boolean Read-write. True to save spot colors.

transferFunction boolean Read-write. True to include the Transfer functions to
compensate for dot gain between the image and film
(default: false).
typename string Read-only. The class name of the referenced
DCS2_SaveOptions object.

vectorData boolean Read-write. True to include vector data.

Valid only if the document includes vector data
(unrasterized text).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 89

DICOMOpenOptions
Options for opening a document in DICOM format using the Application.open() method.

Note: This feature is available in the Extended Version only.

Properties
Property Value type What it is
anonymize boolean Read-write. True to make the patient
information anonymous.
columns number Read-write. Number of columns in n-up
configuration.
reverse boolean Read-write. True to reverse (invert) the image.
rows number Read-write. The number of rows in n-up
configuration.
showOverlays boolean Read-write. True to show overlays.
typename string Read-only. The class name of the referenced
DICOMOpenOptions object.

windowLevel number Read-write. The contrast of the image in

Houndsfield units.
windowWidth number Read-write. The brightness of the image in
Houndsfield units.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 90

Document
The active containment object for layers and all other objects in the script; the basic canvas for the file.
? Access the object for the currently active document through Application.activeDocument.
? You can access other documents, or iterate through all open documents using the list in the
Application.documents collection. You can access individual documents in the list by index, or use
Documents.getByName() to retrieve them by name.
? Create documents programmatically using the Documents.add() method.

See Document sample script and the Documents collection object for examples.

Note: In Adobe Photoshop, a document can also be referred to as an image or a canvas.

? The term image refers to the entire document and its contents. You can trim or crop an image.
You resize an image using the resizeImage() method.
? The term canvas refers to the space in which the document sits on the screen. You can rotate or
flip the canvas. You resize the canvas using the resizeCanvas() method.

Properties
Property Value type What it is
activeChannels array of Channel Read-write. The selected channels.
activeHistoryBrushSource Guide Read-write. The history state to use with the
history brush.
activeHistoryState Guide Read-write. The selected HistoryState object.
activeLayer ArtLayer or Read-write. The selected layer.
LayerSet

artLayers ArtLayers Read-only. The art layers collection.

backgroundLayer ArtLayer Read-only. The background layer of the
document.
bitsPerChannel BitsPerChannelType Read-write. The number of bits per channel.
channels Channels Read-only. The channels collection.
cloudDocument boolean Read-only. This document is in the cloud.
cloudWorkAreaDirectory alias Read-only. Local directory for this cloud
document.
colorProfileName string Read-write. The name of the color profile.
Valid only when colorProfileType =
ColorProfile.CUSTOM or WORKING.

colorProfileType ColorProfileType Read-write. Whether the document uses the

working color profile, a custom profile, or no
profile.
colorSamplers ColorSamplers Read-only. The current color samplers
associated with this document.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 91

Property Value type What it is (Continued)

componentChannels array of Channel Read-only. The color channels that make up
the document; for instance, the Red, Green,
and Blue channels for an RGB document.
countItems CountItems Read-only. The current count items.

Note: For additional information about count

items, see Adobe Photoshop help on the
Count Tool.
fullName File Read-only. The full path name of the
document.
guides Guides Read-only. The guides collection.
height UnitValue Read-only. The height of the document (unit
value).
histogram array of number Read-only. A histogram showing the number
of pixels at each color intensity level for the
composite channel. The array c ontains 256
members.
Valid only when mode = DocumentMode.RGB,
CMYK; or INDEXEDCOLOR.

historyStates HistoryStates Read-only. The history states collection.

info DocumentInfo Read-only. Metadata about the document.
layerComps LayerComps Read-only. The layer compositions collection.
layers Layers Read-only. The layers collection.
layerSets LayerSets Read-only. The layer set collection.
managed boolean Read-only. True if the document a is workgroup
document.
measurementScale MeasurementScale Read-only. The measurement scale for the
document.

Note: The measurement scale feature is

available in the Extended version only.
mode DocumentMode Read-only. The color profile.
name string Read-only. The document's name.
parent Application Read-only. The application object that contains
this document.
path File Read-only. The path to the document.
pathItems PathItems Read-only. The path items collection.
pixelAspectRatio number Read-write. The (custom) pixel aspect ratio to
[0.100..10.000]
use.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 92

Property Value type What it is (Continued)

printSettings DocumentPrintSettin Read-only. The print settings for the document.
gs

quickMaskMode boolean Read-write. True if the document is in Quick

Mask mode.
resolution number Read-only. The document’s resolution (in pixels
per inch).
saved boolean Read-only. True if the document has been
saved since the last change.
selection Selection Read-only. The selected area of the document.
typename string Read-only. The class name of the Document
object.
width UnitValue Read-only. The width of the document (unit
value).
xmpMetadata xmpMetadata Read-only. XMP metadata for the document.
Camera RAW settings for the image are stored
here for example.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 93

Methods
Method Parameter type Returns What it does
autoCount Counts the number of objects in a
(channel, Channel document. Available in the Extended
threshold) number
Version only.
Creates a CountItem object for each
object counted.
For additional information about how to
set up objects to count, see the Count Tool
in the Adobe Photoshop Help
changeMode Changes the color profile of the
(destinationMode ChangeMode document.
[, options]) BitmapConversionOptions
or
IndexedConversionOptions

close Closes the document. If any changes have

([saving]) SaveOptions been made, the script presents an alert
with three options: save, do not save,
prompt to save. The optional parameter
specifies a selection in the alert box
(default: SaveOptionsType.
PROMPTTOSAVECHANGES).

convertProfile Changes the color profile.

(destinationProfile, string
Intent The destinationProfile parameter must
intent
[, blackPointCompensation] boolean be either a string that names the color
[, dither]) boolean mode or Working RGB, Working CMYK,
Working Gray, Lab Color (meaning one
of the working color spaces or Lab color).
crop Crops the document. The bounds
(bounds array of 4 UnitValue parameter is an array of four coordinates
[, angle] number
UnitValue for the region remaining after cropping,
[, width]
UnitValue [left, top, right, bottom].
[, height])

duplicate Document Creates a duplicate of the document

([name ] string object.
[, mergeLayersOnly] boolean
) The optional parameter name provides the
name for the duplicated document.
The optional parameter
mergeLayersOnly indicates whether to
only duplicate merged layers.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 94

Method Parameter type Returns What it does (Continued)

exportDocument Exports the paths in the document to an
(exportIn File Illustrator file, or exports the document to
[, exportAs] ExportType
ExportOptionsIllustrator a file with Web or device viewing
[, options]) —or— optimizations.
ExportOptionsSaveForWeb
This is equivalent to choosing File >
Export > Paths To Illustrator, or File >
Save For Web and Devices.
flatten Flattens all layers in the document.
()

flipCanvas Flips the image within the canvas in the

(direction) Direction specified direction.
importAnnotations Imports annotations into the document.
(file) File

mergeVisibleLayers Flattens all visible layers in the document.

()

paste ArtLayer Pastes the contents of the clipboard into

([intoSelection]) boolean the document. If the optional argument is
set to true and a selection is active, the
contents are pasted into the selection.
print Prints the document.
([sourceSpace] SourceSpaceType
string printSpace specifies the color space for
[, printSpace]
[, intent] Intent the printer. Valid values are nothing (that
[blackPointCompensation]) boolean is, the same as the source); or Working
RGB, Working CMYK, Working Gray, Lab
Color (meaning one of the working color
spaces or Lab color); or a string specifying
a specific colorspace (default is same as
source).
printOneCopy Print one copy of the document.
()

rasterizeAllLayers Rasterizes all layers.

()

recordMeasurements Record measurements of document.

([source] MeasurementSource
[, dataPoints]) array of string

resizeCanvas Changes the size of the canvas to display

([width] UnitValue more or less of the image but does not
[, height] UnitValue
AnchorPosition change the image size. See resizeImage.
[, anchor])
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 95

Method Parameter type Returns What it does (Continued)

resizeImage Changes the size of the image.
([width] UnitValue
UnitValue The amount parameter controls the
[, height]
[, resolution] number amount of noise value when using
[, resampleMethod] ResampleMethod preserve details (Range: 0 - 100).
[, amount]) number

revealAll Expands the document to show clipped

() sections.
rotateCanvas Rotates the canvas (including the image)
(angle) number in clockwise direction.
save Saves the document.
()

saveAs Saves the document in a specific format.

(saveIn File
object (see description) Specify the save options appropriate to
[, options]
[, asCopy] boolean the format by passing one of these
[, extensionType]) Extension objects:
BMPSaveOptions
DCS1_SaveOptions
DCS2_SaveOptions
EPSSaveOptions
GIFSaveOptions
JPEGSaveOptions
PDFSaveOptions
PhotoshopSaveOptions
PICTFileSaveOptions
PICTResourceSaveOptions
PixarSaveOptions
PNGSaveOptions
RawSaveOptions
SGIRGBSaveOptions
TargaSaveOptions
TiffSaveOptions

splitChannels array of Splits the document channels into

Document
() separate images.
suspendHistory Provides a single entry in history states for
(historyString string the entire script provided by
javaScriptString) string
javaScriptString. Allows a single undo
for all actions taken in the script.
The historyString parameter provides
the string to use for the history state.
The javaScriptString parameter
provides a string of JavaScript code to
excute while history is suspended.
trap Applies trapping to a CMYK document.
(width) number
Valid only when docRef.mode =
DocumentMode.CMYK.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 96

Method Parameter type Returns What it does (Continued)

trim Trims the transparent area around the
([type] TrimType image on the specified sides of the canvas.
[, top] boolean
[, left] boolean Default is true for all Boolean parameters.
[, bottom] boolean
[, right]) boolean

Document sample script

The following script creates a document that contains two images (a sunflower and a duck) obtained from
the Adobe Photoshop Samples folder and employs the following steps:
? Determines which image is larger.
? Resizes the smaller image to match the larger image.
? Creates a merged document twice as high as either image in order to hold both images.
? Selects part of the document and pastes the sunflower into the selection.
? Inverts the selection and pastes the duck into the lower part of the document.
? Positions the sunflower over the duck.

Document.jsx
// Save the current preferences
var startRulerUnits = app.preferences.rulerUnits
var startTypeUnits = app.preferences.typeUnits
var startDisplayDialogs = app.displayDialogs

// Set Adobe Photoshop to use pixels and display no dialogs

app.preferences.rulerUnits = Units.PIXELS
app.preferences.typeUnits = TypeUnits.PIXELS
app.displayDialogs = DialogModes.NO

// first close all the open documents

while (app.documents.length) {
app.activeDocument.close()
}

// Open the sunflower and duck files from the samples folder
var flowerDoc = open(File(app.path + "/Samples/Sunflower.psd"))
var duckDoc = open(File(app.path + "/Samples/Ducky.tif"))

// Find out which document is larger

// Resize the smaller document the to the larger document’s size
// The resize requires the document be the active/front document
if ((flowerDoc.width.value * flowerDoc.height.value) >
(duckDoc.width.value * duckDoc.height.value)) {
app.activeDocument = duckDoc
duckDoc.resize(flowerDoc.width, flowerDoc.height)
}
else {
app.activeDocument = flowerDoc
flowerDoc.resizeImage(duckDoc.width, duckDoc.height)
}

// Create a new document twice as high as two files

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 97

var mergedDoc = app.documents.add(duckDoc.width, duckDoc.height * 2,

duckDoc.resolution, "FlowerOverDuck")

// Copy the flower to the top; make it the active document so we can manipulate it
app.activeDocument = flowerDoc
flowerDoc.activeLayer.copy()

//Paste the flower to the merged document, making the merged document active
app.activeDocument = mergedDoc

// Select a square area at the top of the new document

var selRegion = Array(Array(0, 0),
Array(mergedDoc.width.value, 0),
Array(mergedDoc.width.value, mergedDoc.height.value / 2),
Array(0, mergedDoc.height.value / 2),
Array(0, 0))
// Create the selection
mergedDoc.selection.select(selRegion)

//Paste in the flower

mergedDoc.paste(TRUE)

// do the same thing for the duck

app.activeDocument = duckDoc
duckDoc.activeLayer.copy()

app.activeDocument = mergedDoc
mergedDoc.selection.select(selRegion)

// Inverting the selection so the bottom of the document is now selected

mergedDoc.selection.invert()

// Paste the duck

mergedDoc.paste(TRUE)

// get rid of our originals without modifying them

duckDoc.close(SaveOptions.DONOTSAVECHANGES)
flowerDoc.close(SaveOptions.DONOTSAVECHANGES)

// Reset the application preferences

app.preferences.rulerUnits = startRulerUnits
app.preferences.typeUnits = startTypeUnits
app.displayDialogs = startDisplayDialogs
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 98

DocumentPrintSettings
The print settings for a document.

Properties
Property Value type What it is
backgroundColor SolidColor Read-write. Background color of page.
bleedWidth UnitValue Read-write. Bleed width
caption boolean Read-write. Print the caption found in FileInfo.
centerCropMarks boolean Read-write. Print center crop marks.
colorBars boolean Read-write. Print color calibration bars.
copies number Read-write. Number of copies to print.
cornerCropMarks boolean Read-write. Print corner crop marks.
colorHandling PrintColorHandling Read-only. Color handling.
activePrinter string Read-write. The currently active printer.
flip boolean Read-write. Flip the image horizontally.
hardProof boolean Read-write. Print a hard proof.
interpolate boolean Read-write.
labels boolean Read-write. Prints the document title.
mapBlack boolean Read-write. Map blacks.
negative boolean Read-write. Invert the image colors.
renderIntent Intent Read-write. Color conversion intent when print
space is different from the source space.
posX UnitValue Read-only. The x position of the image on
page.
posY UnitValue Read-only. The y position of the image on
page.
printBorder UnitValue Read-write. The width of the print border.
printerName string Read-write. Name of the printer.
printSpace string Read-write. color space for printer. Can be
nothing (meaning same as source); 'Working
RGB', 'Working CMYK', 'Working Gray', 'Lab
Color' (meaning one of the working spaces or
Lab color); or a string specifying a specific
colorspace (default is same as source)
registrationMarks boolean Read-write. Print registration marks.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 99

Property Value type What it is (Continued)

scale number Read-only. Scale of image on page.
vectorData boolean Read-write. Include vector data.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 100

Methods
Method Parameter type Returns What it does
setPagePosition Set the position of the image on the page.
(docPosition, DocPositionStyle
posX, UnitValue
posY, UnitValue
scale) number
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 101

DocumentInfo
Metadata about a document object.

Access through the Document.info property. For example, the following sets the author, caption, and
copyrighted properties:
var docRef = open(fileList[i])
// set the file info
docRef.info.author = "Mr. Adobe programmer"
docRef.info.caption = "Adobe Photo shoot"
docRef.info.copyrighted = CopyrightedType.COPYRIGHTEDWORK

These values can be set interactively by choosing File > File Info.

Properties
Property Value type What it is
author string Read-write.
authorPosition string Read-write.
caption string Read-write.
captionWriter string Read-write.
category string Read-write.
city string Read-write.
copyrighted CopyrightedType Read-write. The copyrighted status.
copyrightNotice string Read-write.
country string Read-write.
creationDate string Read-write.
credit string Read-write.
exif array of array [tag data] Read-only. Camera data that includes
camera settings used when the image
was taken.
Each array member is a tag pair, an array
of [tag, tag_data]; for example, [
"camera" "Cannon"].

headline string Read-write.

instructions string Read-write.
jobName string Read-write.
keywords array of string Read-write. A list of keywords that can
identify the document or its contents.
ownerUrl string Read-write.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 102

Property Value type What it is (Continued)

parent Document Read-only. The info object's container.
provinceState string Read-write.
source string Read-write.
supplementalCategories array of string Read-write.
title string Read-write.
transmissionReference string Read-write.
typename string Read-only. The class name of the
referenced info object.
urgency Urgency Read-write.

DocumentInfo sample Script

The following script sets document info (metadata) for all of the files in a specified folder and then saves
the modified files as low-quality JPEG images in a new folder without changing the originals.
? Ask the user to specify the folder that contains the original files and the output folder for the JPEG
images, and then check that the folders exist.
? Open each file and use the documentInfo object properties to tag it with the following metadata:
? author: Adobe programmer
? caption: Adobe Photo shoot
? captionWriter: Adobe programmer
? city: San Jose
? copyrightNotice: Copyright (c) Adobe programmer Photography
? copyrighted status: Copyrighted Work
? country: USA
? state: CA
? Save the new documents in JPEG format with a low quality setting.

DocumentInfo.jsx

// Save the current preferences

var startDisplayDialogs = app.displayDialogs

// Set Adobe Photoshop to use pixels and display no dialogs

app.displayDialogs = DialogModes.NO

// ask the user for the input and output folders

var inputFolder = Folder.selectDialog("Select a folder to tag")
var outputFolder = Folder.selectDialog("Select a folder for the output files")

// see if we got something interesting from the dialog

if (inputFolder != null && outputFolder != null) {
// get all the files found in this folder
var fileList = inputFolder.getFiles()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 103

// save the outputs in JPEG

var jpegOptions = new JPEGSaveOptions()
// set the jpeg quality really low so the files are small
jpegOptions.quality = 1
// open each one in turn
for (var i = 0; i < fileList.length; i++) {
// The fileList includes both folders and files so open only files
if (fileList[i] instanceof File && fileList[i].hidden == false) {
// get a reference to the new document
var docRef = open(fileList[i])

// tag all of the documents with photo shoot information

docRef.info.author = "Adobe programmer"
docRef.info.caption = "Adobe Photo shoot"
docRef.info.captionWriter = "Adobe programmer"
docRef.info.city = "San Jose"
docRef.info.copyrightNotice = "Copyright (c) Adobe programmer
Photography"
docRef.info.copyrighted = CopyrightedType.COPYRIGHTEDWORK
docRef.info.country = "USA"
docRef.info.provinceState = "CA"

// change the date to a Adobe Photoshop date format

// "YYYYMMDD"
var theDate = new Date()
// the year is from 1900 ????
var theYear = (theDate.getYear() + 1900).toString()
// convert the month from 0..12 to 00..12
var theMonth = theDate.getMonth().toString()
if (theDate.getMonth() < 10) {
theMonth = "0" + theMonth
}
// convert the day from 0..31 to 00.31
var theDay = theDate.getDate().toString()
if (theDate.getDate() < 10) {
theDay = "0" + theDay
}
// stick them all together
docRef.info.creationDate = theYear + theMonth + theDay

// flatten because we are saving to JPEG

docRef.flatten()
// go to 8 bit because we are saving to JPEG
docRef.bitsPerChannel = BitsPerChannelType.EIGHT

// save and close

docRef.saveAs(new File(outputFolder + "/Output" + i + ".jpg"), jpegOptions)

// don’t modify the original

docRef.close(SaveOptions.DONOTSAVECHANGES)
}
}
}

// Reset the application preferences

app.displayDialogs = startDisplayDialogs
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 104

Documents
The collection of open Document objects.

Access this list through the Application.documents collection property, which is available through the app
global variable, or directly at the top level. For example, the following adds a new document to the
collection:
app.documents.add(800, 500, 72, "myDocument", NewDocumentMode.RGB)
—or—
documents.add(800, 500, 72, "myDocument", NewDocumentMode.RGB)

Properties
Property Value type What it is
length number Read-only. The number of elements in the documents
collection.
parent Application Read-only. The containing application.
typename string Read-only. The class name of the referenced documents
object.

Methods
Method Parameter type Returns What it does
add Document Creates a new document object and
([width] UnitValue adds it to this collection.
[, height] UnitValue
[, resolution] number pixelAspectRatio: Default is 1.0, a
[, name] string square aspect ratio.
[, mode] NewDocumentMode
[, initialFill] DocumentFill bitsPerChannelType: Default is
[,pixelAspectRatio] number [0.1..10.00] BitsPerChannelType.EIGHT.
[, bitsPerChannel] BitsPerChannelType
string
[,colorProfileName])

getByName string Document Gets the first element in the

(name) documents collection with the
provided name
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 105

EPSOpenOptions
Options for opening a document in EPS format using the Application.open() method.

Properties
Property Value type What it is
antiAlias boolean Read-write. True to use antialias.
constrainProportions boolean Read-write. True to constrain the proportions of
the image.
height UnitValue Read-write. The height of the image (unit
value).
mode OpenDocumentMode Read-write. The color profile to use as the
document mode.
resolution number Read-write. The resolution of the document in
pixels per inch.
typename string Read-only. The class name of the referenced
EPSOpenOptions object.

width UnitValue Read-write. The width of the image (unit value).

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 106

EPSSaveOptions
Options for saving a document in EPS format using the Document.saveAs() method.

Properties
Property Value type What it is
embedColorProfile boolean Read-write. True to embed the color profile in this
document.
encoding SaveEncoding Read-write. The type of encoding to use (default:
SaveEncoding.BINARY).

halftoneScreen boolean Read-write. True to include the halftone screen

(default: false).
interpolation boolean Read-write. True to use image interpolation (default:
false).

preview Preview Read-write. The preview type.

psColorManagement boolean Read-write. True to use Postscript color management
(default: false).
transferFunction boolean Read-write. True to include the Transfer functions to
compensate for dot gain between the image and film
(default: false).
transparentWhites boolean Read-write. True to display white areas as
transparent.
Valid only when document.mode =
DocumentMode.BITMAP. See also changeMode().

typename string Read-only. The class name of the referenced

EPSSaveOptions object.

vectorData boolean Read-write. True to include vector data.

Valid only if the document includes vector data (text).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 107

ExportOptionsIllustrator
Options for exporting PathItem objects to an Adobe Illustrator® file using using the
Document.exportDocument() method. These options are the options that you can provide when you
choose File > Export > Paths To Illustrator.

Properties
Property Value type What it is
path IllustratorPathType Read-write. The type of path to export
(default:
IllustratorPathType.DOCUMENTBOUNDS).

pathName string Read-write. The name of the path to export.

Valid only when path =
IllustratorPathType.NAMEDPATH.

typename string Read-only. The class name of the referenced

exportOptionsIllustrator object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 108

ExportOptionsSaveForWeb
Options for optimizing a document for the web or devices using the Document.exportDocument()
method. These are the options that you can provide when you choose File > Save For Web and Devices.

Properties
Property Value type What it is
blur number Read-write. Applies blur to the image to reduce
artifacts (default: 0.0).
colorReduction ColorReductionType Read-write. The color reduction algorithm (default:
ColorReductionType.SELECTIVE).

colors number Read-write. The number of colors in the palette

(default: 256).
dither Dither Read-write. The type of dither (default:
Dither.DIFFUSION).

ditherAmount number Read-write. The amount of dither (default: 100).

Valid only when
dither = Dither.DIFFUSION.
format SaveDocumentType Read-write. The file format to use (default:
SaveDocumentType.COMPUSERVEGIF).

Note: For this property, only COMPUSERVEGIF,

JPEG, PNG-8, PNG-24, and BMP are
supported.
includeProfile boolean Read-write. True to include the document’s
embedded color profile (default: false).
interlaced boolean Read-write. True to download in multiple passes;
progressive (default: false).
lossy number Read-write. The amount of lossiness allowed
(default: 0).
matteColor RGBColor Read-write. The colors to blend transparent pixels
against.
optimized boolean Read-write. True to create smaller but less
compatible files (default: true).
Valid only when
format = SaveDocumentType.JPEG.
PNG8 boolean Read-write. Indicates the number of bits; true = 8,
false = 24 (default: true).
Valid only when
format = SaveDocumentType.PNG.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 109

Property Value type What it is (Continued)

quality number [0..100] Read-write. The quality of the produced image as a
percentage; default: 60.
transparency boolean Read-write. Indication of transparent areas of the
image should be included in the saved
image(default: true).
transparencyAmount number Read-write. The amont of transparency dither
(default: 100).
Valid only if transparency = true.
transparencyDither Dither Read-write. The transparency dither algorithm
(default: transparencyDither = Dither.NONE).
typename string Read-only. The class name of the referenced
ExportOptionsSaveForWeb object.

webSnap number Read-write. The tolerance amount within which to

snap close colors to web palette colors (default: 0).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 110

File

Folder
ExtendScript defines the JavaScript classes File and Folder to encapsulate file-system references in a
platform-independent manner; see ‘JavaScript support in Adobe Photoshop’ on page 32. For references
details of these classes, see the JavaScript Tools Guide.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 111

GalleryBannerOptions
Options for the bannerOptions property of the GalleryOptions object.

Tip: You can preserve default values for many of these properties by setting the GalleryOptions property
preserveAllMetadata to true; this is the same as choosing File > Automate > Web Photo Gallery, and
then choosing Preserve all metadata in the Options area of the Web Photo Gallery dialog.

Properties
Property Value type What it is
contactInfo string Read-write. The web photo gallery
contact info.
date string Read-write. The web photo gallery date
(default: current date).
font GalleryFontType Read-write. The font setting for the
banner text (default:
GalleryFontType.ARIAL).

fontSize number [1..7] Read-write. The font size for the banner
text (default: 3).
photographer string Read-write. The web photo gallery
photographer.
siteName string Read-write. The web photo gallery site
name (default:
Adobe Web Photo Gallery).

typename string Read-only. The class name of the

referenced galleryBannerOptions
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 112

GalleryCustomColorOptions
Options for the customColorOptions property of the GalleryOptions object.

Tip: You can preserve default values for many of these properties by setting the GalleryOptions property
preserveAllMetadata to true; this is the same as choosing File > Automate > Web Photo Gallery, and
then choosing Preserve all metadata in the Options area of the Web Photo Gallery dialog.

Properties
Property Value type What it is
activeLinkColor RGBColor Read-write. The color to use to indicate
an active link.
backgroundColor RGBColor Read-write. The background color.
bannerColor RGBColor Read-write. The banner color.
linkColor RGBColor Read-write. The color to use to indicate a
link.
textColor RGBColor Read-write. The text color.
typename string Read-only. The class name of the
referenced
galleryCustomColorOptions object.

visitedLinkColor RGBColor Read-write. The color to use to indicate a

visited link.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 113

GalleryImagesOptions
Options for the imagesOptions property of the GalleryOptions object.

Tip: You can preserve default values for many of these properties by setting the GalleryOptions property
preserveAllMetadata to true; this is the same as choosing File > Automate > Web Photo Gallery, and
then choosing Preserve all metadata in the Options area of the Web Photo Gallery dialog.

Properties
Property Value type What it is
border number [0..99] Read-write. The size (in pixels) of the border
that separates images (default: 0).
caption boolean Read-write. True to generate image captions
(default: false).
dimension number Read-write. The resized image dimensions in
pixels (default: 350).
Valid only when resizeImages = true.
font GalleryFontType Read-write. The font to use for image
captions (default: GalleryFontType.ARIAL).
fontSize number [1..7] Read-write. The font size for image captions
(default: 3).
Valid only when caption = true.
imageQuality number [0..12] Read-write. The quality setting for a JPEG
image (default: 5).
includeCopyright boolean Read-write. True to include copyright
information in captions (default: false).
Valid only when caption = true.
includeCredits boolean Read-write. True to include the credits in
image captions (default: false).
Valid only when caption = true.
includeFilename boolean Read-write. True to include the file name in
image captions (default: true).
Valid only when caption = true.
includeTitle boolean Read-write. True to include the title in image
captions (default: false).
Valid only when caption = true.
numericLinks boolean Read-write. True to add numeric links
(default: true).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 114

Property Value type What it is (Continued)

resizeConstraint GalleryConstrainType Read-write. The image dimensions to
constrain in the gallery image (default:
GalleryConstrainType.CONSTRAINBOTH).
Valid only when resizeImages = true.
resizeImages boolean Read-write. True to automatically resize
images for placement on the gallery pages
(default: true).
typename string Read-only. The class name of the referenced
galleryImagesOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 115

GalleryOptions
Options for a Web photo gallery, created with Application.makePhotoGallery().

Tip: You can preserve default values for many of these properties by choosing File > Automate > Web
Photo Gallery, and then choosing Preserve all metadata in the Options area of the Web Photo
Gallery dialog.

Properties
Property Value type What it is
addSizeAttributes boolean Read-write. True to add width and
height attributes for images (default:
true).

bannerOptions GalleryBannerOptions Read-write. The options related to

banner settings.
customColorOptions GalleryCustomColorOptions Read-write. The options related to
custom color settings.
emailAddress string Read-write. The email address to show
on the web page.
imagesOptions GalleryImagesOptions Read-write. The options related to
images settings.
includeSubFolders boolean Read-write. True to include all files
found in sub folders of the input
folder (default: true).
layoutStyle string Read-write. The style to use for laying
out the web page (default: Centered
Frame 1 - Basic).

preserveAllMetadata boolean Read-write. True to save metadata

(default: false).
securityOptions GallerySecurityOptions Read-write. The options related to
security settings.
thumbnailOptions GalleryThumbnailOptions Read-write. The options related to
thumbnail image settings.
typename string Read-only. The class name of the
referenced galleryOptions object.
useShortExtension boolean Read-write. True to use the short web
page extension .htm. If false, use the
web page extension .html (default:
true).

useUTF8Encoding boolean Read-write. True to use UTF-8

encoding for the web page (default:
false).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 116

GallerySecurityOptions
Options for the securityOptions property of the GalleryOptions object.

Tip: You can preserve default values for many of these properties by setting the GalleryOptions property
preserveAllMetadata to true; this is the same as choosing File > Automate > Web Photo Gallery, and
then choosing Preserve all metadata in the Options area of the Web Photo Gallery dialog.

Properties
Property Value type What it is
content GallerySecurityType Read-write. The web photo gallery
security content (default:
GallerySecurityType.NONE).

font GalleryFontType Read-write. The web photo gallery

security font (default:
GalleryFontType.ARIAL).

fontSize number [1..72] Read-write. The web photo gallery

security font size (default: 3).
opacity number Read-write. The web page security
opacity as a percent (default: 100).
text string Read-write. The web photo gallery
security custom text.
textColor GallerySecurityTextColorType Read-write. The web page security text
color.
textPosition GallerySecurityTextPositionType Read-write. The web photo gallery
security text position (default:
GallerySecurityTextPositionType.
CENTERED).

textRotate GallerySecurityTextRotateType Read-write. The web photo gallery

security text orientation to use (default:
GallerySecurityTextRotateType.
ZERO).

typename string Read-only. The class name of the

referenced gallerySecurityOptions
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 117

GalleryThumbnailOptions
Options for the thumbnailOptions property of the GalleryOptions object.

Tip: You can preserve default values for many of these properties by setting the GalleryOptions property
preserveAllMetadata to true; this is the same as choosing File > Automate > Web Photo Gallery, and
then choosing Preserve all metadata in the Options area of the Web Photo Gallery dialog.

Properties
Property Value type What it is
border number [0..99] Read-write. The amount of border pixels you
want around your thumbnail images (default:
0).

caption boolean Read-write. True if there is a caption (default:

false).

columnCount number Read-write. The number of columns on the

page (default: 5).
dimension number Read-write. The web photo gallery thumbnail
dimension in pixels (default: 75).
font GalleryFontType Read-write. The web photo gallery font
(default: GalleryFontType.ARIAL).
fontSize number [1..7] Read-write. The font size for thumbnail
images text (default: 3).
includeCopyright boolean Read-write. True to include copyright
information for thumbnails (default: false).
includeCredits boolean Read-write. True to include credits for
thumbnails (default: false).
includeFilename boolean Read-write. True to include file names for
thumbnails (default: false).
includeTitle boolean Read-write. True to include titles for
thumbnails (default: false).
rowCount number Read-write. The number of rows on the page
(default: 3).
size GalleryThumbSizeType Read-write. The thumbnail image size
(default: GalleryThumbSizeType.MEDIUM).
typename string Read-only. The class name of the referenced
GalleryThumbnailOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 118

GIFSaveOptions
Options for saving a document in GIF format using the Document.saveAs() method.

Properties
Property Value type What it is
colors number Read-write. The number of palette colors.
Valid only when palette =
Palette.LOCALADAPTIVE, LOCALPERCEPTUAL,
LOCALSELECTIVE, MACOSPALETTE, UNIFORM,
WEBPALETTE; or WINDOWSPALETTE .

dither Dither Read-write. The dither type.

ditherAmount number [1..100] Read-write. The amount of dither (default: 75).
Valid only when dither = Dither.DIFFUSION.
forced ForcedColors Read-write. The type of colors to force into the
color palette.
interlaced boolean Read-write. True if rows should be interlaced
(default: false).
matte MatteType Read-write. The color to use to fill anti-aliased
edges adjacent to transparent areas of the image
(default: MatteType.WHITE).
When transparency = false, the matte color is
applied to transparent areas.
palette PaletteType Read-write. The type of palette to use (default:
Palette.LOCALSELECTIVE).

preserveExactColors boolean Read-write. True to protect colors in the image

that contain entries in the color table from being
dithered.
Valid only when dither = Dither.DIFFUSION.
transparency boolean Read-write. True to preserve transparent areas of
the image during conversion to GIF format.
typename string Read-only. The class name of the referenced
GIFSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 119

GrayColor
Defines a gray color, used in the SolidColor object.

See also CMYKColor, HSBColor, LabColor, NoColor, RGBColor

Properties
Property Value type What it is
gray number [0.0..100.0] Read-write. The gray value (default: 0.0).

typename string Read-only. The class name of the referenced grayColor

object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 120

Guide
Properties
Property Value type What it is
direction Direction Read-write. Indicates whether the guide is
vertical or horizontal.
coordinate UnitValue Read-write. Location of the guide from origin
of image.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 121

Guides
The collection of open Guide objects.

Access this list through the Document.guides collection property, which is available through the
activeDocument object. For example, the following adds a new guide to the collection:
activeDocument.guides.add (Direction.HORIZONTAL,UnitValue(20,20))

Properties
Property Value type What it is
length number Read-only. The number of elements in the guides
collection.
parent Document Read-only. The containing document.
typename string Read-only. The class name of the referenced guides
object.

Methods
Method Parameter type Returns What it does
add Guide Creates a new guide object and adds
(direction Direction it to this collection.
, coordinate) UnitValue

getByName string Guide Gets the first element in the guides

(name) collection with the provided name
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 122

HistoryState
A version of the document stored automatically (and added to the HistoryStates collection), which
preserves the document’s state, each time the document is changed.

Access through Document.historyStates collection. You can access a state in the list by name. For example,
this assigns a property value in the state object named "AddLayerMask":
var stateRef = app.activeDocument.historyState.getByName("AddLayerMask");
stateRef.snapshot = true;

Properties
Property Value type What it is
name string Read-only. The HistoryState object's name.
parent Document Read-only. The containing document.
snapshot boolean Read-only. True if the history state is a snapshot.
typename string Read-only. The class name of the referenced HistoryState
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 123

HistoryStates
The collection of Guide objects in the document.

Access through Document.historyStates collection property. For example, this accesses one of the states in
the collection by index:
myState = app.activeDocument.historyStates[7];

Properties
Property Value type What it is
length number Read-only. The number of elements in the HistoryStates
collection.
parent Document Read-only. The containing document.
typename string Read-only. The class name of the referenced
HistoryStates object.

Methods
Method Parameter type Returns What it does
getByName Guide Get the first element in the
(name) string HistoryStates collection with the
provided name.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 124

HSBColor
Defines an HSB color, used in the SolidColor object.

See also CMYKColor, GrayColor, LabColor, NoColor, RGBColor

Properties
Property Value type What it is
brightness number[0.0..100.0] Read-write. The brightness value.
hue number [0.0..360.0] Read-write. The hue value.

saturation number [0.0..100.0] Read-write. The saturation value.

typename string Read-only. The class name of the referenced HSBColor

object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 125

IndexedConversionOptions
Options for converting an RGB image to an indexed color model using Document.changeMode().

Properties
Property Value type What it is
colors number Read-write. The number of palette colors.
Valid only when palette =
Palette.LOCALADAPTIVE, LOCALPERCEPTUAL,
LOCALSELECTIVE, MACOSPALETTE, UNIFORM,
WEBPALETTE, or WINDOWSPALETTE.

dither Dither Read-write. The dither type.

ditherAmount number [1..100] Read-write. The amount of dither.
Valid only when dither = Dither.diffusion.
forced ForcedColors Read-write. The type of colors to force into the
color palette.
matte MatteType Read-write. The color to use to fill anti-aliased
edges adjacent to transparent areas of the image
(default: MatteType.WHITE).
When transparency = false, the matte color is
applied to transparent areas.
palette PaletteType Read-write. The palette type (default:
Palette.EXACT).

preserveExactColors boolean Read-write. True to protect colors in the image

that contain entries in the color table from being
dithered.
Valid only when dither = Dither.DIFFUSION.
transparency boolean Read-write. True to preserve transparent areas of
the image during conversion to GIF format.
typename string Read-only. The class name of the referenced
IndexedConversionOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 126

JPEGSaveOptions
Options for saving a document in JPEG format using the Document.saveAs() method.

Properties
Property Value type What it is
embedColorProfile boolean Read-write. True to embed the color profile in the
document.
formatOptions FormatOptions Read-write.The download format to use (default:
FormatOptions.STANDARDBASELINE).

matte MatteType Read-write. The color to use to fill anti-aliased edges

adjacent to transparent areas of the image (default:
MatteType.WHITE).
When transparency is turned off for an image, the
matte color is applied to transparent areas.
quality number [0..12] Read-write. The image quality setting to use; affects
file size and compression (default: 3).
scans number [3..5] Read-write. The number of scans to make to
incrementally display the image on the page
(default: 3).
Valid only for when formatOptions =
FormatOptions.PROGRESSIVE.

typename string Read-only. The class name of the referenced

JPEGSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 127

LabColor
Defines an LAB color, used in the SolidColor object.

See also CMYKColor, GrayColor, HSBColor, NoColor, RGBColor

Properties
Property Value type What it is
a number [-128.0..127.0] Read-write. The a-value.
b number [-128.0..127.0] Read-write. The b-value.
l number [0.0..100.0] Read-write. The L-value.
typename string Read-only. The class name of the referenced
LabColor object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 128

LayerComp
A snapshot of a state of the layers in a document, which can be used to view different page layouts or
compositions.

Access through Document.layerComps collection. You can access a layer comp by its name. For example,
this sets the comment property value for a LayerComp object named myLayerComp:
var layercompRef = app.activeDocument.layerComps.getByName("myLayerComp");
layercompRef.comment = "View from shoreline";

Properties
Property Value type What it is
appearance boolean Read-write. True to use layer appearance (layer styles)
settings.
childLayerCompState boolean Read-write. True to track child Smart Objects layer comp.
comment string Read-write. A description of the layer comp.
name string Read-write. The name of the layer comp.
parent Document Read-write. The containing document.
position boolean Read-write. True to use layer position.
selected boolean Read-only. True if the layer comp is currently selected.
typename string Read-only. The class name of the referenced layerComp
object.
visibility boolean Read-write. True to use layer visibility settings.

Methods
Method Parameter type Returns What it does
apply Applies the layer comp to the document.
()

recapture Recaptures the current layer state(s) for

() this layer comp.
remove Deletes the layerComp object.
()

resetfromComp Resets the layer comp state to the

() document state.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 129

LayerComps
The collection of LayerComp objects in the document.

Access through the Document.layerComps collection property. For example:

app.activeDocument.layerComps.add("myLayerComp", "View from Shoreline",
true, true, true);

Properties
Property Value type What it is
length number Read-only. The number of elements in the layerComps
collection.
parent Document Read-only. The containing document.
typename string Read-only. The class name of the referenced
layerComps object.

Methods
Method Parameter type Returns What it does
add LayerComp Creates a new layer composition
(name, string object and adds it to this collection.
comment, string
appearance, boolean
position, boolean
visibility, boolean
childLayerCompState) boolean

getByName LayerComp Gets the first element in the

(name) string collection with the provided name.
removeAll Removes all member objects from
() the layerComps collection.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 130

Layers
The collection of layer objects, including ArtLayer and LayerSet objects, in the document. Access through
Document.layers, or the LayerSet.layers collections properties.

For example, this uses the length property to count the number of layer objects in the active document,
then displays the number on the screen:
var layerNum = app.activeDocument.layers.length
alert(layerNum)

Properties
Property Value type What it is
length number Read-only. The number of elements in the layers
collection.
parent Document or Read-only. The containing document or layer set.
LayerSet
typename string Read-only. The class name of the referenced layers object.

Methods
Method Parameter type Returns What it does
getByName Layer Gets the first element in the layers
(name) string collection with the provided name.
removeAll Removes all layers from the collection.
()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 131

LayerSet
A group of layer objects, which can include ArtLayer objects and other (nested) LayerSet objects. A single
command can manipulate all layers in the set.

Access top-level layers sets in a document through the Document.layerSets collection. You can access a
layer set by name. For example, the following sets the allLocked value for "myLayerSet":
var layerSetRef = app.activeDocument.layerSets.getByName("myLayerSet");
layerSetRef.allLocked = true

Access nested layer sets through the LayerSet.layerSets collection in the parent set. For example:
app.activeDocument.layerSets[0].layerSets[0];

Properties
Property Value type What it is
allLocked boolean Read-write. True if the contents in the layers in this set
are not editable.
artLayers ArtLayers Read-only. The art layers in this layer set.
blendMode BlendMode Read-write. The blend mode to use for the layer set.
bounds array of UnitValue Read-only. The bounding rectangle of the layer set.

enabledChannels array of Channel Read-write. The channels enabled for the layer set; must
be a list of component channels. See Channel.kind.
layers Layers Read-only. The layers in this layer set.
layerSets LayerSets Read-only. Nested layer sets contained within this layer
set.
linkedLayers array of ArtLayer Read-only. The layers linked to this layerSet object.
and/or LayerSet

name string Read-write. The name of this layer set.

opacity number [0.0..100.0] Read-write. The master opacity of the set.

parent Document or Read-only. The containing document or layer set.

LayerSet

typename string Read-only. The class name of the referenced LayerSet

object.
visible boolean Read-write. True if the set is visible.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 132

Methods
Method Parameter type Returns What it does
duplicate LayerSet Creates a duplicate of the object.
([relativeObject] ArtLayer or
LayerSet
ElementPlacement
[, insertionLocation])

link Links the layer set with another

(with) ArtLayer or layer.
LayerSet

merge ArtLayer Merges the layerset; returns a

() reference to the art layer created
by this method.
move Moves the object.
(relativeObject, ArtLayer or
LayerSet
ElementPlacement
insertionLocation)

remove Deletes the object.

()

resize Resizes all layers in the layer set to

([horizontal] number to the specified dimensions (as a
[, vertical] number
AnchorPosition percentage of its current size) and
[, anchor])
places the layer set in the
specified position.
rotate Rotates all layers in the layer set
(angle number around the specified anchor point
[, anchor]) AnchorPosition
(default:
AnchorPosition.MIDDLECENTER)

translate Moves the position relative to its

([deltaX] UnitValue current position.
[, deltaY]) UnitValue

unlink Unlinks the layer set.

()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 133

LayerSets
The collection of LayerSet objects in the document.

Access the top-level layer sets in a document through the Document.layerSets collection property. For
example:
var layerSetRef = app.activeDocument.layerSets.add()

Access the nested layer sets through the LayerSet.layerSets collection property in the parent set. For
example:
var layerSetRef = app.activeDocument.layerSets.getByName("myParentSet");
var childSet = layerSetRef.layerSets.getByName("myChildSet");

Properties
Property Value type What it is
length number Read-only. The number of elements in the LayerSets
collection.
parent Document or Read-only. The containing document or layer set.
LayerSet

typename string Read-only. The class name of the referenced layerSets

object.

Methods
Method Parameter type Returns What it does
add LayerSet Creates a new layer set object and adds it to
() the collection.
getByName LayerSet Gets the first element in the collection with
(name) string the provided name.
removeAll Removes all member layer sets, and any
() layers or layer sets they contain, from the
document.

LayerSets sample script

The following script creates three layer sets, then nests a second layer set in each layer set, and then
creates a text layer in each nested set that that displays the text "Layer in n Set Inside n Set", where n
represents the ordinal number of the set (first, second, or third).

Note: This script uses the ExtendScript $ debugging object. For further details, see the JavaScript Tools
Guide.

LayerSets.jsx
$.level = 1

//close all open documents

while (app.documents.length) {
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 134

app.activeDocument.close()
}

// create a working document

var docRef = app.documents.add()

// create an array to hold the layer sets

var myLayerSets = new Array()

// Create an array to hold the text

var textArray = Array("First", "Second", "Third")

//Create an indexer variable

var i = 0

// Create three layer sets at the top level

for (i = 0; i < 3; i++) {
myLayerSets[i] = new Array()
myLayerSets[i][0] = docRef.layerSets.add()
}

// Rearrange the layer sets with the first one on top, second next, etc.
myLayerSets[1][0].moveAfter(myLayerSets[0][0])
myLayerSets[2][0].moveAfter(myLayerSets[1][0])

// Create a layer set inside each layer set

for (i = 0; i < 3; i++) {
myLayerSets[i][0].name = textArray[i] + " Set"
myLayerSets[i][1] = myLayerSets[i][0].layerSets.add()
myLayerSets[i][1].name = "Inside " + textArray[i] + " Set"
}

// Create an array to hold the layers

var myLayers = new Array()

// Create a text layer with a description inside each layer set

for (i = 0; i < 3; i++) {
myLayers[i] = myLayerSets[i][1].artLayers.add()
myLayers[i].kind = LayerKind.TEXT
myLayers[i].textItem.contents = "Layer in " + textArray[i] + " Set Inside "
+ textArray[i] + " Set"
myLayers[i].textItem.position = Array(app.activeDocument.width * i * 0.33,
app.activeDocument.height * (i + 1) * 0.25)
myLayers[i].textItem.size = 12
}
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 135

MeasurementLog
The measurement log for the application. Access through the Application.measurementLog property.

Note: This feature is available in the Extended Version only.

Methods
Method Parameter type Returns What it does
exportMeasurements Export measurement to a file.
([file] File
[, range]) MeasurementRange
[, dataPoints]) array of string

deleteMeasurements Delete measurements from

([range]) MeasurementRange the log.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 136

MeasurementScale
The measurement scale for the document. Access through the Document.measurementScale property.
For example:
app.activeDocument.measurementScale.pixelLength = 25

Note: This feature is available in the Extended Version only.

Properties
Property Value type What it is
pixelLength number Read-write. The length in pixels this scale equates to.
logicalLength number Read-write. The logical length this scale equates to.
logicalUnits string Read-write. The logical units for this scale.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 137

NoColor
Represents a missing color object, used in the SolidColor object.

See also CMYKColor, GrayColor, HSBColor, LabColor, RGBColor

Properties
Property Value type What it is
typename string Read-only. The class name of the referenced noColor
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 138

Notifier
An event-handler object that tells a script to execute specified code when a specified event occurs.
Notifiers must be enabled using the Application.notifiersEnabled property.

Access through the Application.notifiers collection.

Note: Events that occur within scripts do not generally trigger notifiers, because they occur inside a "play
script" event.

Properties
Property Value type What it is
event string Read-only. The event identifier, a four-character code or a
unique string.
For a list of four-character codes, see Appendix A: Event ID
Codes.
eventClass string Read-only. The class identifier, a four-character code or a
unique string.
When an event applies to multiple types of objects, use this
propery to distinguish which object this notifier applies to.
For example, the Make event ("Mk ") can apply to
documents ("Dcmn"), channels ("Chnl") and other objects.
eventFile File Read-only. The path to the file to execute when the event
occurs and activates the notifier.
parent Application Read-only. The containing application.
typename string Read-only. The class name of the referenced object.

Methods
Method Parameter type Returns What it does
remove Deletes this object.
()
You can also remove a Notifier object
from the Script Events Manager
drop-down list by deleting the file named
Script Events Manager.xml from the
Photoshop preferences folder. See Adobe
Photoshop help for more information.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 139

Notifiers
The collection of Notifier objects in the document. Access through the Application.notifiers collection
property. For example:
var notRef = app.notifiers.add("OnClickGoButton", eventFile)

Notifiers must be enabled using the Application.notifiersEnabled property.

Properties
Property Value type What it is
length number Read-only. The number of elements in the notifiers
collection.
parent Application Read-only. The notifiers object’s container
typename string Read-only. The class name of the referenced notifiers object.

Methods
Method Parameter type Returns What it does
add Notifier Creates a notifier object and adds it to this
(event, string collection.
eventFile File
[, eventClass]) string event defines the class ID of the event: use a
4-characters code or a unique string. See
Appendix A: Event ID Codes.
eventFile defines the script file that
executes when the event occurs.
When an event applies to multiple types of
objects, use the eventClass (a 4-character ID
or unique string) to distinguish which object
this Notifier applies to. For example, the
Make event ("Mk ") applies to documents
("Dcmn"), channels ("Chnl") and other
objects.

Tip: When specifying an event or event calss

wtih a 4-character ID code, omit the
single quotes in your code.
removeAll Removes all member objects from the
() notifiers collection.
You can also remove a notifier object from
the Script Events Manager drop-down list by
deleting the file named Script Events
Manager.xml from the Photoshop
preferences folder. See Adobe Photoshop
help for more information.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 140

PathItem
A path or drawing object, such as the outline of a shape or a straight or curved line, which contains sub
paths that define its geometry.

Access through the collection in the Document.pathItems property. For example, this selects a named
path item:
var currentPathItem = app.activeDocument.pathItems.getByName("myPath");
currentPathItem.select()

Create these objects by passing a set of SubPathInfo objects to the PathItems.add() method. This method
creates a SubPathItem object for each SubPathInfo object, and creates and returns a new PathItem object
for the path represented by all of the subpaths.

Properties
Property Value type What it is
kind PathKind Read-write. The type.
name string Read-write. The name.
parent Document Read-only. The containing document.
subPathItems SubPathItems Read-only. The contained sub-path objects.
typename string Read-only. The class name of the referenced
pathItem object.

Methods
Method Parameter type Returns What it does
deselect Deselects this pathItem
() object.
duplicate Duplicates this
(name) string pathItem object with
the new name.
fillPath Fills the area enclosed by
([fillColor] SolidColor this path.
[, mode] ColorBlendMode
[, opacity] number [0..100] opacity is a percentage.
[, preserveTransparency] boolean
number [0.0..250.0] feather is in pixels.
[, feather]
[, wholePath] boolean
boolean If wholePath is true, all
[, antiAlias])
subpaths are used when
doing the fill (default:
true).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 141

Method Parameter type Returns What it does

makeClippingPath Makes this the clipping
([flatness]) number [0.2..100] path for this document.
flatness tells the
PostScript printer how to
approximate curves in
the path.
makeSelection Makes a Selection object
([feather] number [0.0..250.0] whose border is this
[, antiAlias] boolean
SelectionType path.
[, operation])
feather is in pixels.

remove Deletes this object.

()

select Makes this the active or

() selected PathItem
object.
strokePath Strokes the path with
([tool] ToolType the specified tool.
[, simulatePressure]) boolean

PathItem sample script

The following creates a path in three segments: two diagonal lines that form a V, and a curved line above
the V that makes it look like a 2D ice cream cone.

Paths.jsx

// Save the current preferences

var startRulerUnits = app.preferences.rulerUnits
var startTypeUnits = app.preferences.typeUnits
var startDisplayDialogs = app.displayDialogs

// Set Adobe Photoshop to use pixels and display no dialogs

app.preferences.rulerUnits = Units.PIXELS
app.preferences.typeUnits = TypeUnits.PIXELS
app.displayDialogs = DialogModes.NO

// first close all the open documents

while (app.documents.length) {
app.activeDocument.close()
}

// create a document to work with

var docRef = app.documents.add(5000, 7000, 72, "Simple Line")

//line 1--it’s a straight line so the coordinates for anchor, left, and right
//for each point have the same coordinates
var lineArray = new Array()
lineArray[0] = new PathPointInfo
lineArray[0].kind = PointKind.CORNERPOINT
lineArray[0].anchor = Array(100, 100)
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 142

lineArray[0].leftDirection = lineArray[0].anchor
lineArray[0].rightDirection = lineArray[0].anchor

lineArray[1] = new PathPointInfo

lineArray[1].kind = PointKind.CORNERPOINT
lineArray[1].anchor = Array(150, 200)
lineArray[1].leftDirection = lineArray[1].anchor
lineArray[1].rightDirection = lineArray[1].anchor

var lineSubPathArray = new Array()

lineSubPathArray[0] = new SubPathInfo()
lineSubPathArray[0].operation = ShapeOperation.SHAPEXOR
lineSubPathArray[0].closed = false
lineSubPathArray[0].entireSubPath = lineArray

// line 2
var lineArray2 = new Array()
lineArray2[0] = new PathPointInfo
lineArray2[0].kind = PointKind.CORNERPOINT
lineArray2[0].anchor = Array(150, 200)
lineArray2[0].leftDirection = lineArray2[0].anchor
lineArray2[0].rightDirection = lineArray2[0].anchor

lineArray2[1] = new PathPointInfo

lineArray2[1].kind = PointKind.CORNERPOINT
lineArray2[1].anchor = Array(200, 100)
lineArray2[1].leftDirection = lineArray2[1].anchor
lineArray2[1].rightDirection = lineArray2[1].anchor

lineSubPathArray[1] = new SubPathInfo()

lineSubPathArray[1].operation = ShapeOperation.SHAPEXOR
lineSubPathArray[1].closed = false
lineSubPathArray[1].entireSubPath = lineArray2

//ice cream curve

//it’s a curved line, so there are 3 points, not 2
//coordinates for the middle point (lineArray3[1]) are different.
//The left direction is positioned "above" the anchor on the screen.
//The right direction is positioned "below" the anchor
//You can change the coordinates for these points to see
//how the curve works...
var lineArray3 = new Array()
lineArray3[0] = new PathPointInfo
lineArray3[0].kind = PointKind.CORNERPOINT
lineArray3[0].anchor = Array(200, 100)
lineArray3[0].leftDirection = lineArray3[0].anchor
lineArray3[0].rightDirection = lineArray3[0].anchor

lineArray3[1] = new PathPointInfo

lineArray3[1].kind = PointKind.CORNERPOINT
lineArray3[1].anchor = Array(150, 50)
lineArray3[1].leftDirection = Array(100, 50)
lineArray3[1].rightDirection = Array(200, 50)

lineArray3[2] = new PathPointInfo

lineArray3[2].kind = PointKind.CORNERPOINT
lineArray3[2].anchor = Array(100, 100)
lineArray3[2].leftDirection = lineArray3[2].anchor
lineArray3[2].rightDirection = lineArray3[2].anchor
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 143

lineSubPathArray[2] = new SubPathInfo()

lineSubPathArray[2].operation = ShapeOperation.SHAPEXOR
lineSubPathArray[2].closed = false
lineSubPathArray[2].entireSubPath = lineArray3

//create the path item

var myPathItem = docRef.pathItems.add("A Line", lineSubPathArray)

// stroke it so we can see something

myPathItem.strokePath(ToolType.BRUSH)

// Reset the application preferences

preferences.rulerUnits = startRulerUnits
preferences.typeUnits = startTypeUnits
displayDialogs = startDisplayDialogs
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 144

PathItems
The collection of PathItem objects in a document.

Access through the Document.pathItems collection property. For example, this creates a new path item
using a previously-defined set of subpaths:
app.activeDocument.pathItems.add("myPath", lineSubPathInfoArray);

Properties
Property Value type What it is
length number Read-only. The number of pathItem objects in the
pathItems collection.

parent Document Read-only. The pathItems object's container.

typename string Read-only. The class name of the referenced pathItems
object.

Methods
Method Parameter type Returns What it does
add PathItem Creates a new path item object and adds it
(name, string to this collection.
entirePath) array of SubPathInfo
A new SubPathItem object is created for
each SubPathInfo object provided in
entirePath, and those SubPathItem
objects are added to the subPathItems
collection of the returned PathItem.
getByName PathItem Get the first element in the pathItems
(name) string collection with the provided name.
removeAll Removes all pathItem objects from the
() pathItems collection.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 145

PathPoint
Represents the anchor and control-handle endpoints for a path segment. Each point (the anchor point,
left-direction point, and right-direction point) is an array containing X and Y position coordinates.
? Use the PathPoint object to retrieve information about the points that describe existing path
segments. The properties are read-only. Access PathPoint objects through the SubPathItem.pathPoints
property.
? Use PathPointInfo with PathItems.add() to create path points. The properties are writeable.

For paths that are straight segments (not curved), the coordinates of all three points are the same. For
curved segements, the the coordinates are different. The difference between the anchor point and the left
or right direction points determines the arc of the curve. You use the left direction point to bend the curve
"outward" or make it convex; you use the right direction point to bend the curve "inward" or make it
concave.

Properties
Property Value type What it is
anchor array of number Read-only. The X and Y coordinates of the anchor point of the
curve.
kind PointKind Read-only. The role (corner or smooth) this point plays in the
containing path segment.
leftDirection array of number Read-only. The location of the left-direction endpoint (’in’
position).
parent SubPathItem Read-only. The containing subpath object.
rightDirection array of number Read-only. The location of the right-direction endpoint (’out’
position).
typename string Read-only. The class name of the referenced PathPoint
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 146

PathPointInfo
Used to create a PathPoint, which represents the anchor and control-handle endpoints for a path segment.
Each point (the anchor point, left-direction point, and right-direction point) is an array containing X and Y
position coordinates.
? Use the JavaScript new operator to create these objects, and store them in the
SubPathInfo.entireSubPath property before using that object to create a path item with
PathItems.add().
See the PathPointInfo sample script below.
? The resulting SubPathItem objects contain the resulting PathPoint objects. Use the PathPoint object to
retrieve information about the points that describe existing path segments. The properties are
read-only.

For paths that are straight segments (not curved), the coordinates of all three points are the same. For
curved segements, the the coordinates are different. The difference between the anchor point and the left
or right direction points determines the arc of the curve. You use the left direction point to bend the curve
"outward" or make it convex; you use the right direction point to bend the curve "inward" or make it
concave.

Properties
Property Value type What it is
anchor array of number Read-write. The X and Y coordinates of the anchor point of
the curve.
kind PointKind Read-write. The role (corner or smooth) this point plays in the
containing path segment.
leftDirection array of number Read-write. The location of the left-direction endpoint (’in’
position).
rightDirection array of number Read-write. The location of the right-direction endpoint (’out’
position).
typename string Read-only. The class name of the referenced PathPointInfo
object.

PathPointInfo sample script

function drawLine(doc, start, stop) {

var startPoint = new PathPointInfo();

startPoint.anchor = start;
startPoint.leftDirection = start;
startPoint.rightDirection = start;
startPoint.kind = PointKind.CORNERPOINT;

var stopPoint = new PathPointInfo();

stopPoint.anchor = stop;
stopPoint.leftDirection = stop;
stopPoint.rightDirection = stop;
stopPoint.kind = PointKind.CORNERPOINT;
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 147

var spi = new SubPathInfo();

spi.closed = false;
spi.operation = ShapeOperation.SHAPEXOR;
spi.entireSubPath = [startPoint, stopPoint];

var line = doc.pathItems.add("Line", [spi]);

line.strokePath(ToolType.PENCIL);
line.remove();
};

drawLine(app.activeDocument, [100,100], [200,200]);

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 148

PathPoints
A collection of PathPoint objects that define a subpath, kept in the SubPathItem.pathPoints property.

Properties
Property Value type What it is
length number Read-only. The number of elements in the collection.
parent SubPathItem Read-only. The containing subpath object.
typename string Read-only. The class name of the referenced PathPoints
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 149

PDFOpenOptions
Options for opening a document in generic Adobe PDF format using the Application.open() method.

Properties
Property Value type What it is
antiAlias boolean Read-write. True to use antialias.
bitsPerChannel BitsPerChannelType Read-write. The number of bits per channel.

constrainProportions boolean DEPRECATED for Adobe Photoshop.

cropPage CropToType Read-write. The method of cropping to use.
height UnitValue DEPRECATED for Adobe Photoshop.
mode OpenDocumentMode Read-write. The color model to use.
name string Read-write. The name of the object.
object number Read-write. The number of 3d objects to open.
page number Read-write. The page or image to which to open
the document, depending on the value of
usePageNumber.
resolution number Read-write. The resolution of the document (in
pixels per inch).
suppressWarnings boolean Read-write. True to suppress warnings when
opening the document.
typename string Read-only. The class name of the referenced
PDFOpenOptions object.

use3DObjectNumber boolean Read-write. If true, the 3d property refers to using

3d object; if false, then usePageNumber is used.
usePageNumber boolean Read-write. When true, the page property refers
to a page number; when false, it refers to an
image number.
width UnitValue DEPRECATED for Adobe Photoshop.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 150

PDFSaveOptions
Options for saving a document in Adobe PDF format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha channels
with the file.
annotations boolean Read-write. True to save comments with the
file.
colorConversion boolean Read-write. True to convert the color profile
to a destination profile.
convertToEightBit boolean Read-write. True to convert a 16-bit image
to 8-bit for better compatibility with other
applications.
description string Read-write. Description of the save options
to use.
destinationProfile string Read-write. Description of the final RGB or
CMYK output device, such as a monitor or a
press standard.
downgradeColorProfile boolean DEPRECATED for Adobe Photoshop.
downSample PDFResample Read-write. The down sample method to
use.
downSampleSize number Read-write. The size to downsample images
if they exceed the limit in pixels per inch.
downSampleSizeLimit number Read-write. Limits downsampling or
subsampling to images that exceed this
value in pixels per inch.
embedColorProfile boolean Read-write. True to embed the color profile
in the document.
embedFonts boolean DEPRECATED for Adobe Photoshop.
embedThumbnail boolean Read-write. True to include a small preview
image in Adobe PDF files.
encoding PDFEncoding Read-write. The type of compression to use
(default: PDFEncoding.PDFZIP).
interpolation boolean DEPRECATED for Adobe Photoshop.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 151

Property Value type What it is (Continued)

jpegQuality number [0..12] Read-write. The quality of the produced
image, which is inversely proportionate to
the compression amount.
Valid only when encoding =
PDFEncoding.JPEG .

layers boolean Read-write. True to save the document’s

layers.
optimizeForWeb boolean Read-write. True to improve performance of
PDF files on Web servers.
outputCondition string Read-write. An optional comment field for
inserting descriptions of the output
condition. The text is stored in the PDF/X
file.
outputConditionID string Read-write. Indentifier for the output
condition.
PDFCompatibility PDFCompatibility Read-write. The PDF version to make the
document compatible with.
PDFStandard PDFStandard Read-write. The PDF standard to make the
document compatible with.
preserveEditing boolean Read-write. True to reopen the PDF in
Adobe Photoshop with native Photoshop
data intact.
presetFile string Read-write. The preset file to use for
settings.

Note: This option overrides other settings.

profileInclusionPolicy boolean Read-write. True to show which profiles to
include.
registryName string Read-write. URL where the output condition
is registered.
spotColors boolean Read-write. True to save spot colors.
tileSize nunber Read-write. Compression option.
Valid only when encoding =
PDFEncoding.JPEG2000.

transparency boolean DEPRECATED for Adobe Photoshop.

typename string Read-only. The class name of the referenced
PDFSaveOptions object.

useOutlines boolean DEPRECATED for Adobe Photoshop.

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 152

Property Value type What it is (Continued)

vectorData boolean DEPRECATED for Adobe Photoshop.
view boolean Read-write. True to open the saved PDF in
Adobe Acrobat.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 153

PhotoCDOpenOptions
DEPRECATED in Adobe Photoshop. Kodak PhotoCD is now found in the Goodies folder on the Adobe
Photoshop Install DVD.

Options for opening a document in Kodak Photo CD (PCD) format (including high-resolution files from Pro
Photo CD discs) using the Application.open() method.

Properties
Property Value type What it is
colorProfileName string Read-write. The profile to use when reading the
image.
colorSpace PhotoCDColorSpace Read-write. The colorspace for the image.
orientation Orientation Read-write. The image orientation.
pixelSize PhotoCDSize Read-write. The image dimensions.
resolution number Read-write. The image resolution (in pixels per
inch).
typename string Read-only. The class name of the referenced
photoCDOpenOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 154

PhotoshopSaveOptions
Options for saving a document in PSD format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha channels.
annotations boolean Read-write. True to save the annotations.
embedColorProfile boolean Read-write. True to embed the color profile in the
document.
layers boolean Read-write. True to preserve the layers.
spotColors boolean Read-write. True to save the spot colors.
typename string Read-only. The class name of the referenced
photoshopSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 155

PICTFileSaveOptions
Options for saving a document in PICT format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha channels.
compression PICTCompression Read-write. The type of compression to use
(default: PICTCompression.NONE).
embedColorProfile boolean Read-write. True to embed the color profile in the
document.
resolution PICTBitsPerPixels Read-write. The number of bits per pixel.
typename string Read-only. The class name of the referenced
PICTFileSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 156

PICTResourceSaveOptions
Options for saving a document as a PICT Resource file using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha channels.
compression PICTCompression Read-write. The type of compression to use (default:
PICTCompression.NONE).

embedColorProfile boolean Read-write. True to embed the color profile in the

document.
name string Read-write. The name of the PICT resource.
resolution PICTBitsPerPixels Read-write. The number of bits per pixel.
resourceID number Read-write. The ID of the PICT resource (default:
128).

typename string Read-only. The class name of the referenced

PICTResourceSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 157

PicturePackageOptions
Options for a picture package created with Application.makePicturePackage().

Properties
Property Value type What it is
content PicturePackageTextType Read-write. The content information (default:
PicturePackageTextType.NONE).

flatten boolean Read-write. True if all layers in the final

document are flattened (default: true).
font GalleryFontType Read-write. The font used for security text
(default: GalleryFontType.ARIAL).
fontSize number Read-write. The font size used for security
text (default: 12).
layout string Read-write. The layout to use to generate the
picture package (default: "(2)5x7").
mode NewDocumentMode Read-write. Read-write. The color profile to
use as the document mode (default:
NewDocumentMode.RGB).

opacity number Read-write. The web page security opacity as

a percent (default: 100).
resolution number Read-write. The resolution of the document
in pixels per inch (default: 72.0).
text string Read-write. The picture package custom text.
Valid only when content =
PicturePackageType.USER.

textColor RGBColor Read-write. The color to use for security text.

textPosition GallerySecurityTextPositionType Read-write. The security text position
(default:
GallerySecurityTextPositionType.
CENTERED).

textRotate GallerySecurityTextRotateType Read-write. The orientation to use for

security text (default:
GallerySecurityTextRotateType.ZERO).

typename string Read-only. The class name of the referenced

PicturePackageOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 158

PixarSaveOptions
Options for saving a document in Pixar format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha
channels.
typename string Read-only. The class name of the
referenced PixarSaveOptions
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 159

PNGSaveOptions
Options for saving a document in PNG format using the Document.saveAs() method.

Properties
Property Value type What it is
compression number [0..9] Read-write. The compression value (default: 0).
interlaced boolean Read-write. True to interlace rows (default: false).
typename string Read-only. The class name of the referenced
PNGSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 160

Preferences
Represents application preferences for Photoshop. Access this object through the Application.preferences
property. For example:
app.preferences.rulerUnits = Units.PIXELS
app.preferences.typeUnits = TypeUnits.PIXELS

Setting values in this object is equivalent to selecting Edit > Preferences (in Windows) or Photoshop >
Preferences (in Mac OS) in the Adobe Photoshop application. For explanations of individual settings, see
Adobe Photoshop Help.

Properties
Property Value type What it is
additionalPluginFolder File Read-write. The path to an additional
plug-in folder.
Valid only when
useAdditionalPluginFolder = true.
appendExtension SaveBehavior Read-write. The preferred policy for
writing file extensions in Windows.
askBeforeSavingLayeredTIFF boolean Read-write. True to ask the user to verify
layer preservation options when saving a
file in TIFF format.
autoUpdateOpenDocuments boolean Read-write. True to automatically update
open documents.
beepWhenDone boolean Read-write. True to beep when a process
finishes.
colorChannelsInColor boolean Read-write. True to display component
channels in the Channels palette in color.
colorPicker ColorPicker Read-write. The preferred color selection
tool.
columnGutter number [0.1..600.0] Read-write. The width of the column
gutters (in points).
columnWidth number [0.1..600.0] Read-write. Column width (in points)
createFirstSnapshot boolean Read-write. True to automatically make
the first snapshot when a new document
is created.
dynamicColorSliders boolean Read-write. True if dynamic color sliders
appear in the Color palette.
editLogItems EditLogItemsType Read-write. The preferred level of detail
in the history log. Valid only when
useHistoryLog = true.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 161

Property Value type What it is (Continued)

exportClipboard boolean Read-write. True to retain Adobe
Photoshop contents on the clipboard
after you exit the application.
fontPreviewSize FontPreviewType Read-write. The preferred type size to use
for font previews in the type tool font
menus.
fullSizePreview boolean Read-write. True to show image preview
as a full size image, false to show
thumbnail (in Mac OS only).
gamutWarningOpacity number [0..100] Read-write. Opacity value as a
percentage.
gridSize GridSize Read-write. The preferred size to use for
squares in the grid.
gridStyle GridLineStyle Read-write. The preferred formatting
style for non-printing grid lines.
gridSubDivisions number [1..100] Read-write. Number of grid subdivisions.
guideStyle GuideLineStyle Read-write. The preferred formatting
style for non-printing guide lines.
iconPreview boolean Read-write. True to use icon previews (in
Mac OS only).
imageCacheLevels number [1..8] Read-write. The number of images to
hold in the cache.
imagePreviews SaveBehavior Read-write. The preferred policy for
writing image previews in Windows.
interpolation ResampleMethod Read-write. The method to use to assign
color values to any new pixels created
when an image is resampled or resized.
keyboardZoomResizesWindows boolean Read-write. True to automatically resize
the window when zooming in or out
using keyboard shortcuts.
macOSThumbnail boolean Read-write. True to create a thumbnail
when saving the image (in Mac OS only).
maximizeCompatibility QueryStateType Read-write. The preferred policy for
checking whether to maximize
compatibility when opening PSD files.
maxRAMuse number [5..100] Read-write. The maximum percentage of
available RAM used by Adobe Photoshop
(5 - 100).
nonLinearHistory boolean Read-write. True to allow non-linear
history.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 162

Property Value type What it is (Continued)

numberofHistoryStates number Read-write. The number of history states
to preserve.
otherCursors OtherPaintingCursors Read-write. The preferred type of pointer
to use with certain tools.
paintingCursors PaintingCursors Read-write. The preferred type of pointer
to use with certain tools.
parent Application Read-write. The containing application.
pixelDoubling boolean Read-write. True to halve the resolution
(double the size of pixels) to make
previews display more quickly.
pointSize PointType Read-write. The point/pica size.
recentFileListLength number [0..30] Read-write. The number of items in the
recent file list.
rulerUnits Units Read-write. The unit the scripting system
will use when receiving and returning
values.
saveLogItems SaveLogItemsType Read-write. Thepreferred location of
history log data when saving the history
items.
saveLogItemsFile File Read-write. The path to the history log
file, when the preferred location is a file.
savePaletteLocations boolean Read-write. True to make new palette
locations the default location.
showAsianTextOptions boolean Read-write. True to display Asian text
options in the Paragraph palette.
showEnglishFontNames boolean Read-write. True to list Asian font names
in English.
showSliceNumber boolean Read-write. True to display slice numbers
in the document window when using the
Slice tool.
showToolTips boolean Read-write. True to show pop up
definitions on mouse over.
smartQuotes boolean Read-write. True to use curly, false to use
straight quote marks.
textFontSize FontSize Read-write. Size of the small font used in
panels and dialogs.
typename string Read-only. The class name of the
referenced preferences object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 163

Property Value type What it is (Continued)

typeUnits TypeUnits Read-write. The preferred unit for text
character measurements.
useAdditionalPluginFolder boolean Read-write. True to use an additional
folder for compatible plug-ins stored
with a different application.
useHistoryLog boolean Read-write. True to create a log file for
history states.
useLowerCaseExtension boolean Read-write. True to use lowercase for file
extensions.
useShiftKeyForToolSwitch boolean Read-write. True to enable cycling
through a set of hidden tools.
useVideoAlpha boolean Read-write. True to enable Adobe
Photoshop to send transparency
information to your computer’s video
board. (Requires hardware support.)
windowsThumbnail boolean Read-write. True to create a thumbnail
when saving the image in Windows.
(Requires hardware support.)
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 164

PresentationOptions
Options for Adobe PDF presentations created using Application.makePDFPresentation().

Properties
Property Value type What it is
autoAdvance boolean Read-write. True to auto advance images when when
viewing the presentation (default: true).
Valid only when presentation = true.
includeFilename boolean Read-write. True to include the file name for the image
(default: false).
interval number [1..60] Read-write. The time in seconds before the view is auto
advanced (default: 5).
Valid only when autoAdvance = true.
loop boolean Read-write. True to begin the presentation again after
the last page (default: false).
Valid only when autoAdvance = true.
magnification MagnificationType Read-write. The magnification type to use when viewing
the image.
PDFFileOptions PDFSaveOptions Read-write. Options to use when creating the PDF file.
presentation boolean Read-write. True if the output will be a presentation
(default: false); when false, the output is a Multi-Page
document.
transition TransitionType Read-write. The method for transition from one image to
the next (default: TransitionType.NONE).
Valid only when autoAdvance = true. .
typename string Read-only. The class name of the referenced
PresentationOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 165

RawFormatOpenOptions
Options for opening a document in RAW format using the Application.open() method.

Properties
Property Value type What it is
bitsPerChannel number Read-write. The number of bits for each channel.
The only valid values are BitsPerChannelType.EIGHT
or BitsPerChannelType.SIXTEEN.
byteOrder ByteOrder Read-write. The order in which multibyte values are
read.
Valid only when bitsPerChannel =
BitsPerChannelType.SIXTEEN.

channelNumber number [1..56] Read-write. The number of channels in the image. The
value of cannot exceed the number of channels in the
image.
When bitsPerChannel =
BitsPerChannelType.SIXTEEN, the only valid values
are 1, 3, or 4.
headerSize number Read-write. The number of bytes of information that
[0..1919999]
will appear in the file before actual image information
begins; that is, the number of zeroes inserted at the
beginning of the file as placeholders.
height number Read-write. The height of the image (in pixels).
interleaveChannels boolean Read-write. True to store color values sequentially.
retainHeader boolean Read-write. True to retain the header when saving.
Valid only when headerSize is 1 or greater.
typename string Read-only. The class name of the referenced
RawFormatOpenOptions object.

width number Read-write. The image width in pixels.

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 166

RawSaveOptions
Options for saving a document in RAW format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True if alpha channels should be saved.
spotColors boolean Read-write. True if the spot colors should be saved.
typename string Read-only. The class name of the referenced RawSaveOptions
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 167

RGBColor
Defines an RGB color, used in the SolidColor object.

See also CMYKColor, GrayColor, HSBColor, LabColor, NoColor.

Properties
Property Value type What it is
blue number [0..255] Read-write. The blue color value (default: 255).
green number [0..255] Read-write. The green color value (default: 255)
hexValue string Read-write. The hexadecimal representation of the color.
red number [0..255] Read-write. The red color value (default: 255)
typename string Read-only. The class name of the referenced RGBColor object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 168

Selection
The selected area of a document or layer. Access through the Document.selection property. For example:
app.activeDocument.selection.fill(app.foregroundColor)

Many of the properties and methods use the UnitValue type, which combines measurement values with
the measurement unit. For information about this type, see the JavaScript Tools Guide.

Properties
Property Value type What it is
bounds array of UnitValue Read-only. The bounding rectangle of the entire selection.
parent Document Read-only. The object's container.
solid boolean Read-only. True if the bounding rectangle is a solid.
typename string Read-only. The class name of the referenced selection
object.

Methods
Method Parameter type Returns What it does
clear Clears the selection and
() does not copy it to the
clipboard.
contract Contracts (reduces) the
(by) UnitValue selection by the specified
amount.
copy Copies the selection to the
([merge]) boolean clipboard. When the
optional argument is used
and set to true, a merged
copy is performed (all visible
layers in the selection are
copied).
cut Clears the current selection
() and copies it to the
clipboard.
deselect Deselects the current
() selection.
expand Expands the selection by the
(by) UnitValue specified amount.
feather Feathers the edges of the
(by) UnitValue selection by the specified
amount.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 169

Method Parameter type Returns What it does (Continued)

fill Fills the selection.
(filltype SolidColor
ColorBlendMode opacity is a percentage
[, mode]
[, opacity] number [1..100] value.
[, preserveTransparency]) boolean

grow Grows the selection to

(tolerance, number include all adjacent pixels
antiAlias) boolean
falling within the specified
tolerance range.
invert Inverts the selection
() (deselects the selection and
selects the rest of the layer
or document).

Tip: To flip the selection

shape, see rotate.
load Loads the selection from the
(from Channel specified channel.
[, combination] SelectionType
[, inverting]) boolean

makeWorkPath number Makes this selection item

([tolerance]) the work path for this
document.
resize Resizes the selected area to
([horizontal] number the specified dimensions
[, vertical] number
AnchorPosition and anchor position.
[, anchor])

resizeBoundary Changes the size of the

([horizontal] number selection to the specified
[, vertical] number
AnchorPosition dimensions around the
[, anchor])
specified anchor.
rotate Rotates the selection by the
(angle number specified amount around
[, anchor]) AnchorPosition
the specified anchor point.
rotateBoundary Rotates the boundary of the
(angle number selection around the
[, anchor]) AnchorPosition
specified anchor.
select Selects the specified region.
(region array of number
SelectionType The region parameter is an
[, type]
[, feather] number array of four coordinates,
[, antiAlias]) boolean [left, top, right, bottom].
selectAll Selects the entire layer.
()
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 170

Method Parameter type Returns What it does (Continued)

selectBorder Selects the selection border
(width) UnitValue only (in the specified width);
subsequent actions do not
affect the selected area
within the borders.
similar Grows the selection to
(tolerance, number include pixels throughout
antiAlias) boolean
the image falling within the
tolerance range.
smooth Cleans up stray pixels left
(radius) number inside or outside a
color-based selection
(within the radius specified
in pixels).
store Saves the selection as a
(into Channel channel.
[, combination]) SelectionType

stroke Strokes the selection border.

(strokeColor, SolidColor opacity is a percentage
width number
StrokeLocation value.
[, location]
[, mode] ColorBlendMode
[, opacity] number [1..100]
[, preserveTransparency]) boolean

translate Moves the entire selection

([deltaX] UnitValue relative to its current
[, deltaY]) UnitValue
position.
translateBoundary Moves the selection relative
([deltaX] UnitValue to its current position.
[, deltaY]) UnitValue

Selection sample script

The following script creates a checkerboard using the following steps:
? Create an 800 x 800 pixel document.
? Divide the entire document into 100 x 100 pixel squares.
? Select every other square in the first row, then shift the selection criteria to select the alternate squares
in the following row. Repeat until every other square in the document is selected.
? Fill the selected squares with the foreground color from the palette.
? Invert the selection and fill the newly selected squares with the background color from the palette.
? Deselect the squares to remove the selection outlines (the "marching ants").

Selection.jsx

// Save the current preferences

var startRulerUnits = app.preferences.rulerUnits
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 171

var startTypeUnits = app.preferences.typeUnits

var startDisplayDialogs = app.displayDialogs

// Set Adobe Photoshop to use pixels and display no dialogs

app.preferences.rulerUnits = Units.PIXELS
app.preferences.typeUnits = TypeUnits.PIXELS
app.displayDialogs = DialogModes.NO

//Close all the open documents

while (app.documents.length) {
app.activeDocument.close()
}

//Create variables for the 800 pixel board divided in even 100 x 100 squares
var docSize = 800
var cells = 8
var cellSize = docSize / cells

// create a new document

var checkersDoc = app.documents.add(docSize, docSize, 72, "Checkers")

// Create a variable to use for selecting the checker board

// That allows me to shift the selection one square to the right
//on every other row, and then shift back for the rows in between.
var shiftIt = true

// loop through vertically to create the first row

for (var v = 0; v < docSize; v += cellSize) {

// Switch the shift for a new row

shiftIt = !shiftIt

// loop through horizontally

for (var h = 0; h < docSize; h += (cellSize * 2)) {

// push over the cellSize to start with only

if (shiftIt && h == 0) {
h += cellSize
}

// Select a square
selRegion = Array(Array(h, v),
Array(h + cellSize, v),
Array(h + cellSize, v + cellSize),
Array(h, v + cellSize),
Array(h, v))

// In the first ineration of the loop, start the selection

//In subsequent iterations, use the EXTEND constant value
//of the select() method to add to the selection (in the loop’s else clause)
if (h == 0 && v == 0) {
checkersDoc.selection.select(selRegion)
} else {
checkersDoc.selection.select(selRegion, SelectionType.EXTEND)
}

// turn this off for faster execution

// turn this on for debugging
WaitForRedraw()
}
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 172

// Fill the current selection with the foreground color

checkersDoc.selection.fill(app.foregroundColor)

//Invert the selection

checkersDoc.selection.invert()

// Fill the new selection with the background color

checkersDoc.selection.fill(app.backgroundColor)

// Clear the selection to get rid of the non-printing borders

checkersDoc.selection.deselect()

// Reset the application preferences

app.preferences.rulerUnits = startRulerUnits
app.preferences.typeUnits = startTypeUnits
app.displayDialogs = startDisplayDialogs

// A helper function for debugging

// It also helps the user see what is going on
// if you turn it off for this example you
// get a flashing cursor for a number time
function WaitForRedraw()
{
var eventWait = charIDToTypeID("Wait")
var enumRedrawComplete = charIDToTypeID("RdCm")
var typeState = charIDToTypeID("Stte")
var keyState = charIDToTypeID("Stte")

var desc = new ActionDescriptor()

desc.putEnumerated(keyState, typeState, enumRedrawComplete)

executeAction(eventWait, desc, DialogModes.NO)

}
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 173

SGIRGBSaveOptions
Options for saving a document in SGIRGB format using the Document.saveAs() method.

Note: The SGIRGB format is not installed automatically with Adobe Photoshop.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha
channels.
spotColors boolean Read-write. True to save the spot
colors.
typename string Read-only. The class name of the
referenced SGIRGBSaveOptions
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 174

SolidColor
A color definition used in the document. Maps a color to equivalents in all available color models.
? Used in Application.backgroundColor and foregroundColor properties, in Channel.color, in
ColorSampler.color, and in TextItem.color
? Passed to PathItem.fillPath(), Selection.fill(), and Selection.stroke().

Properties
Property Value type What it is
cmyk CMYKColor Read-write. The CMYK color mode.
gray GrayColor Read-write. The Grayscale color mode.
hsb HSBColor Read-write. The HSB color mode.
lab LabColor Read-write. The LAB color mode.
model ColorModel Read-write. The color model.
nearestWebColor RGBColor Read-only. The nearest web color to the current color.
rgb RGBColor Read-write. The RGB color mode.
typename string Read-only. The class name of the referenced SolidColor
object.

Methods
Method Parameter type Returns What it does
isEqual boolean True if the SolidColor object is visually
(color) SolidColor equal to the specified color.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 175

SubPathInfo
An array of PathPoint objects that describes a straight or curved segment of a path, used to create a
SubPathItem.

Pass an array of these objects to the PathItems.add() method. This method creates a SubPathItem object
for each SubPathInfo object, and creates and returns a new PathItem object for the path represented by
all of the subpaths.
? Use SubPathInfo to create subpaths; the properties are writeable.
? Use the SubPathItem object to retrieve information about existing subpaths. The properties are
read-only.

Properties
Property Value type What it is
closed boolean Read-write. True if the path describes an enclosed area.
entireSubPath array of PathPoint Read-write.
operation ShapeOperation Read-write. The subpath’s operation on other
subpaths. Specifies how to combine the shapes if the
destination path already has a selection.
typename string Read-only. The class name of the referenced
SubPathInfo object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 176

SubPathItem
Represents a subpath; a collection of subpaths make up a PathItem.

Create these objects by passing SubPathInfo objects to the PathItems.add() method. This method creates
a SubPathItem object for each SubPathInfo object, and creates and returns a new PathItem object for the
path represented by all of the subpaths. Access these objects in the PathItem.subPathItems collection.
? Use the SubPathItem object to retrieve information about existing subpaths. The properties are
read-only.
? Use SubPathInfo to create subpaths; the properties are writeable.

Properties
Property Value type What it is
closed boolean Read-only. True if the path is closed.
operation ShapeOperation Read-only. How this object behaves when it intersects
another SubPathItem object. Specifies how to combine the
shapes if the destination path already has a selection.
parent PathItem Read-only. The object's container.
pathPoints PathPoints Read-only. The PathPoints collection.
typename string Read-only. The class name of the referenced SubPathItem
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 177

SubPathItems
A collection of SubPathItem objects that make up a PathItem. Access this object in the
PathItem.subPathItems collection property.
? Use SubPathInfo to create subpaths; the properties are writeable.
? Use the SubPathItem object to retrieve information about existing subpaths. The properties are
read-only.

Properties
Property Value type What it is
length number Read-only. The number of elements in the collection.
parent PathItem Read-only. The containing path item.
typename string Read-only. The class name of the referenced SubPathItems
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 178

TargaSaveOptions
Options for saving a document in TGA (Targa) format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha channels.
resolution TargaBitsPerPixels Read-write. The number of bits per pixel (default:
TargaBitsPerPixels.TWENTYFOUR).

rleCompression boolean Read-write. True to use RLE compression (default: true).

typename string Read-only. The class name of the referenced
TargaSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 179

TextFont
Describes a font that is available to the application. Access this object in the Application.fonts collection.
For example:
var myFont = app.fonts.getByName("ArialMT");

Properties
Property Value type What it is
family string Read-only. The font family.
name string Read-only. The name of the font.
parent Application Read-only. The containing application.
postScriptName string Read-only. The PostScript name of the font.
style string Read-only. The font style.
typename string Read-only. The class name of the referenced TextFont
object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 180

TextFonts
The collection of fonts available on your computer. Fonts are represented by TextFont objects. Access this
object in the Application.fonts collection property. For example, this displays the number of available
fonts:
alert(app.fonts.length);

Properties
Property Value type What it is
length number Read-only. The number of elements in the collection.
parent Application Read-only. The containing application.
typename string Read-only. The class name of the referenced TextFonts object.

Methods
Method Parameter type Returns What it does
getByName TextFont Gets the first element in the TextFonts
(name) string collection with the provided name.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 181

TextItem
The text in an ArtLayer object whose kind property is LayerKind.TEXT. Access this object in the
ArtLayer.textItem property. For example:
myLayers[i].textItem.contents = "Layer in " + textArray[i] + " Set Inside "

Many of the properties use the UnitValue type, which combines a measurement value with a
measurement unit. For information about this type, see the JavaScript Tools Guide.

Properties
Property Value type What it is
alternateLigatures boolean Read-write. True to use alternate ligatures.

Note: Alternate ligatures are the same as

Discretionary Ligatures. See Adobe Photoshop
Help for more information.
antiAliasMethod AntiAlias Read-write. The method of anti aliasing to use.
autoKerning AutoKernType Read-write. The auto kerning option to use.
autoLeadingAmount number Read-write. The percentage to use for auto (default)
[0.01..5000.00]
leading (in points).
Valid only when useAutoLeading = true.
baselineShift UnitValue Read-write. The unit value to use in the baseline
offset of text.
capitalization TextCase Read-write. The text case.
color SolidColor Read-write. The text color.
contents string Read-write. The actual text in the layer.
desiredGlyphScaling number [50..200] Read-write. The desired amount by which to scale the
horizontal size of the text letters. A percentage value;
at 100, the width of characters is not scaled.
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the minimumGlyphScaling and
maximumGlyphScaling values are also required.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 182

Property Value type What it is (Continued)

desiredLetterScaling number Read-write. The amount of space between letters (at
[100..500]
0, no space is added between letters).
Equivalent to Letter Spacing in the Justification
dialog (Select Justification on the Paragraphs
palette menu).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the minimumLetterScaling and
maximumLetterScaling values are also required.
desiredWordScaling number [0..1000] Read-write. The amount (percentage) of space
between words (at 100, no additional space is added
between words).
Equivalent to Word Spacing in the Justification
dialog (Select Justification on the Paragraphs
palette menu).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the minimumWordScaling and
maximumWordScaling values are also required.
direction Direction Read-write. The text orientation.
fauxBold boolean Read-write. True to use faux bold (default: false).
Setting this to true is equivalent to selecting text and
clicking Faux Bold in the Character palette.
fauxItalic boolean Read-write. True to use faux italic (default: false).
Setting this to true is equivalent to selecting text and
clicking Faux Italic in the Character palette.
firstLineIndent UnitValue Read-write. The amount (unit value) to indent the
[-1296..1296]
points first line of paragraphs.

font string Read-write. The text face of the character. Use the
PostScript Name of the font. See TextFont and use
the postScriptName property.
hangingPunctuation boolean Read-write. True to use Roman hanging punctuation.
height UnitValueX Read-write. The height of the bounding box (unit
value) for paragraph text.
Valid only when kind = TextType.PARAGRAPHTEXT.
horizontalScale number [0..1000] Read-write. Character scaling (horizontal) in
proportion to verticalScale (a percentage value).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 183

Property Value type What it is (Continued)

hyphenateAfterFirst number [1..15] Read-write. The number of letters after which
hyphenation in word wrap is allowed.
hyphenateBeforeLast number [1..15] Read-write. The number of letters before which
hyphenation in word wrap is allowed.
hyphenateCapitalWords boolean Read-write. True to allow hyphenation in word wrap
of capitalized words.
hyphenateWordsLongerThan number [2..25] Read-write. The minimum number of letters a word
must have in order for hyphenation in word wrap to
be allowed.
hyphenation boolean Read-write. True to use hyphenation in word wrap.
hyphenationZone UnitValue Read-write. The distance at the end of a line that will
[0..720] pica
cause a word to break in unjustified type.
hyphenLimit number Read-write. The maximum number of consecutive
lines that can end with a hyphenated word.
justification Justification Read-write. The paragraph justification.
kind TextType Read-write. The text-wrap type.
language Language Read-write. The language to use.
leading UnitValue Read-write. The leading amount.
leftIndent UnitValue Read-write. The amoun of space to indent text from
[-1296..1296]
points the left.

ligatures boolean Read-write. True to use ligatures.

maximumGlyphScaling number [50..200] Read-write. The maximum amount to scale the
horizontal size of the text letters (a percentage value;
at 100, the width of characters is not scaled).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the minimumGlyphScaling and
desiredGlyphScaling values are also required.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 184

Property Value type What it is (Continued)

maximumLetterScaling number Read-write. The maximum amount of space to allow
[100..500]
between letters (at 0, no space is added between
letters).
Equivalent to Letter Spacing in the Justification
dialog (Select Justification on the Paragraphs
palette menu).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the minimumLetterScaling and
desiredLetterScaling values are also required.
maximumWordScaling number [0..1000] Read-write. The maximum amount of space to allow
between words (a percentage value; at 100, no
additional space is added between words).
Equivalent to Word Spacing in the Justification
dialog (Select Justification on the Paragraphs
palette menu).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the minimumWordScaling and
desiredWordScaling values are also required.
minimumGlyphScaling number [50..200] Read-write. The minimum amount to scale the
horizontal size of the text letters (a percentage value;
at 100, the width of characters is not scaled).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the maximumGlyphScaling and
desiredGlyphScaling values are also required.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 185

Property Value type What it is (Continued)

minimumLetterScaling number Read-write. The minimum amount of space to allow
[100..500]
between letters (a percentage value; at 0, no space is
removed between letters).
Equivalent to Letter Spacing in the Justification
dialog (Select Justification on the Paragraphs
palette menu).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the maximumLetterScaling and
desiredLetterScaling values are also required.
minimumWordScaling number [0..1000] Read-write. The minimum amount of space to allow
between words (a percentage value; at 100, no
additional space is removed between words).
Equivalent to Word Spacing in the Justification
dialog (Select Justification on the Paragraphs
palette menu).
Valid only when justification =
Justification.CENTERJUSTIFIED,
FULLYJUSTIFIED, LEFTJUSTIFIED, or
Justification.RIGHTJUSTIFIED.
When used, the maximumWordScaling and
desiredWordScaling values are also required.
noBreak boolean Read-write. True to disallow line breaks in this text.

Tip: When true for many consecutive characters, can

prevent word wrap and thus may prevent some
text from appearing on the screen.
oldStyle boolean Read-write. True to use old style type.
parent ArtLayer Read-write. The containing layer.
position array of Read-write. The position of origin for the text. The
UnitValue
array members specify the X and Y coordinates.
Equivalent to clicking the text tool at a point in the
document to create the point of origin for text.
rightIndent UnitValue Read-write. The amount of space to indent text from
[-1296..1296]
points the right.

size UnitValue Read-write. The font size in UnitValue . NOTE: Type

was points for CS3 and older..
spaceAfter UnitValue Read-write. The amount of space to use after each
[-1296..1296]
points paragraph.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 186

Property Value type What it is (Continued)

spaceBefore UnitValue Read-write. The amount of space to use before each
[-1296..1296]
points paragraph.

strikeThru StrikeThruType Read-write. The text strike-through option to use.

textComposer TextComposer Read-write. The composition method to use to
evaluate line breaks and optimize the specified
hyphenation and justification options.
Valid only when kind = TextType.PARAGRAPHTEXT.
tracking number Read-write. The amount of uniform spacing between
[-1000..10000]
multiple characters.
Tracking units are 1/1000 of an em space. The width
of an em space is relative to the current type size. In a
1-point font, 1 em equals 1 point; in a 10-point font, 1
em equals 10 points. So, for example, 100 units in a
10-point font are equivalent to 1 point.
typename string Read-only. The class name of the referenced
textItem object.

underline UnderlineType Read-write. The text underlining options.

useAutoLeading boolean Read-write. True to use a font's built-in leading
information.
verticalScale number [0-1000] Read-write. Vertical character scaling in proportion to
horizontalScale (a percentage value).
warpBend number Read-write. The warp bend percentage.
[-100..100]

warpDirection Direction Read-write. The warp direction.

warpHorizontalDistortion number Read-write. The horizontal distortion of the warp (a
[-100..100]
percentage value).
warpStyle WarpStyle Read-write. The style of warp to use.
warpVerticalDistortion number Read-write. The vertical distortion of the warp (a
[-100..100]
percentage value).
width UnitValue Read-write. The width of the bounding box for
paragraph text.
Valid only when kind = TextType.PARAGRAPHTEXT.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 187

Methods
Method Parameter type Returns What it does
convertToShape Converts the text item and its containing layer to
() a fill layer with the text changed to a clipping
path.
createPath Creates a clipping path from the outlines of the
() actual text items (such as letters or words).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 188

TiffSaveOptions
Options for saving a document in TIFF format using the Document.saveAs() method.

Properties
Property Value type What it is
alphaChannels boolean Read-write. True to save the alpha channels.
annotations boolean Read-write. True to save the annotations.
byteOrder ByteOrder Read-write. The order in which the document’s
multibyte values are read (default:
ByteOrder.MACOS in Mac OS, ByteOrder.IBM
in Windows).
embedColorProfile boolean Read-write. True to embed the color profile in
the document.
imageCompression TIFFEncoding Read-write. The compression type (default:
TIFFEncoding.NONE).

interleaveChannels boolean Read-write. True if the channels in the image

will be interleaved.
jpegQuality number [0..12] Read-write. The quality of the produced
image, which is inversely proportionate to the
amount of JPEG compression.
Valid only when imageCompression =
TIFFEncoding.JPEG.

layerCompression LayerCompression Read-write. The method of compression to use

when saving layers (as opposed to saving
composite data).
Valid only when layers = true.
layers boolean Read-write. True to save the layers.
saveImagePyramid boolean Read-write. True to preserve multi-resolution
information (default: false).
spotColors boolean Read-write. True to save the spot colors.
transparency boolean Read-write. True to save the transparency as
an additional alpha channel when the file is
opened in another application.
typename string Read-only. The class name of the referenced
TiffSaveOptions object.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 189

UnitValue
ExtendScript defines the JavaScript class UnitValue to represent measurement values together with their
measurement units; see ‘JavaScript support in Adobe Photoshop’ on page 32. For references details of
these classes, see the JavaScript Tools Guide.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Object Reference 190

xmpMetadata
Camera RAW image XMP metadata.

For camera RAW image files, the XMP metadata is stored in a sidecar file, which is a file in the same folder as
the RAW file with the same base name and an XMP extension.

Properties
Property Value type What it is
parent Document Read-only. The containing document.
rawData string Read-write. A string containing the XMP metadata in
XML (RDF) format. See the XMP Specification for
details of this format.
typename string Read-only. The class name of the referenced
xmpMetadata object.
 3 Adobe Photoshop JavaScript
Reference Guide
JavaScript Resource
This section describes the JavaScript resource that enables your JavaScripts to behave like a plug-in. This
includes:
? the ability to specify a menu the script appears in as a command,
? a terminology resource so the script can function with the Action Manager, which allows your script to
record and be automated by scripting parameters,
? a category to enable ordering and grouping of commands within menus, and
? an enable string that indicates whether the command is enabled or disabled given a set of conditions.
? The strings must be valid XML syntax. The "&" character will not work for example. Use the &amp;&amp;
for example to get logical ‘&&’ in the enableinfo block.

JavaScript resource syntax

The JavaScript Resource has an HTML-style syntax, with each <tag> matched by a closing </tag>. This
resource needs to appear within comments ( /* ... */) and should be defined at the top of your script
file (within the first 10,240 characters of the file.)

Tag Description
<javascriptresource> The resource definition tag.
<name> The command name that appears in the Photoshop menu.
If this tag is not provided in the resource, the name of the command in the
menu defaults to the name of the script.
<menu> The menu the command appears in. If this tag is not provided, the
command appears in the File > Scripts menu.

Note: Currently the only supported values for <menu> are automate,
filter and help. automate puts the script in the File >
Automate menu for example.
<about> A string that appears in an About box, which the user can select from the
Help > About Plug-in menu.

191
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Resource 192

Tag Description
<enableinfo> A boolean expression that indicates whether the command is enabled in
the menu. See Enable-info grammar.

Note: If you provide this tag, the menu item is enabled if and only if there
is at least one document open, and the boolean expression
evaluates to true. If you always want the menu item enabled, do not
use this tag.
<eventid> A unique string that identifies the event. Using a UUID will ensure that your
script wont share this identifier with another script.
<category> The category the command appears within in the menu. Used to group
and order commands in the menu. Commands are placed in the menu
alphabetically based on the string in <category>. If two commands use
the same category, they are grouped together.
<terminology> The terminology dictionary for the script to function with the Action
Manager. See the Terminology dictionary.

Basic JavaScript resource example

This example shows a very basic <javascriptresource>. With this resource, the script can be executed
by selecting the command Add a Document, which appears in the Automate menu. This command is
enabled in the menu, provided at least one document is already open. If the user requests information
about the script from the About Plug-in menu, the string contained in the <about> tag is displayed in a
dialog box.
/*
<javascriptresource>
<name>Add a Document</name>
<type>automate</type>
<about>A short string providing information about the script.</about>
<enableinfo>true</enableinfo>
</javascriptresource>
*/

app.documents.add();

Enable-info grammar
The <enableinfo> tag provides a boolean expression that, when evaluated, indicates whether the
command is enabled in the menu. You can use this expression to enable or disable the menu item based
on various characteristics of the document. The Enable Info grammar is as follows:
<booleanExpression> := <conjunction> { "||" <conjunction> }

<conjunction> := <relation> {"&&" <relation> }

<relation> := <equality> {<relationOperator><equality>}

<equality> := <simpleExpression> {<equalityOperator><simpleExpression>}

<simpleExpression> := <term> {<addOperator><term>}

<term> := <factor> {<mulOperator><factor>}

 Adobe Photoshop
JavaScript Scripting Reference JavaScript Resource 193

<factor> := <integer> | <intrinsic> | <ident> |

"(" <booleanExpression ")" | "(" simpleExpression ")" |
"+" <factor> | "-" <factor> | "!" <factor>

<integer> := digit {digit}

<intrinsic> := <limitFunction> | <dimFunction> | <inFunction>

<limitFunction> := ( "min" | "max") "(" <simpleExpression> ","

<simpleExpression> { "," <simpleExpression> } ")"

<dimFunction> := "dim" "(" <simpleExpression> "," <simpleExpression> ")"

<ident> := (alpha | "_") {alpha | digit | "_" }

<mulOperator> := "*" | "/"

<addOperator> := "+" | "-"

<equalityOperator> := "==" | "!="

<relationOperator> := "<" | "<=" | ">=" | ">"

<inFunction> := "in" "(" <simpleExpression> {"," <simpleExpression> } ")"

Operator precedence is shown in the following table. Operators are listed with the highest order of
precedence at the top of the table

Operator Description
|| Or
&& And
+ - Addition or subtraction
* / Multiply or divide
< <= >= > Less than, less than or equal, greater than or equal, greater than
== != Equals, or does not equal.
(..) in() max() min() Functions
unary + - ! Unary operators: increment, decrement, not

The grammar provides variables and constants that you can use in the <enableinfo> expression. The
following table provides a list of the constants that are available.

Constant Name Description

true Boolean true
false Boolean false
BitmapMode Bitmap mode.
GrayScaleMode Grayscale mode, 8 bit depth.
IndexedMode Indexed color mode.
RGBMode RGB color mode.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Resource 194

Constant Name Description

CMYKMode CMYK color mode.
HSLMode HSL color mode.
HSBMode HSB color mode
MultiChannelMode Multichannel mode.
DuotoneMode Duotone mode.
LabMode Lab color mode.
Gray16Mode Grayscale mode, 16 bits per channel
RGB48Mode RGB color mode, 16 bits per channel.
Lab48Mode LAB mode, 16 bits per channel.
CMYK64Mode CMYK mode, 16 bits per channel.
DeepMultichannelMode Deep multichannel mode.
Duotone16Mode Duotone mode, 16 bit depth.
RGB96Mode RGB color mode, 32 bits per channel.
Gray32Mode Grayscale mode, 32 bit depth.

The following table show the set of variables you can use in the <enableinfo> expression. The value of
these variables is set based on the properties of the active document.

Variable Name Description

PSHOP_ImageMode Image mode of the active document.
PSHOP_ImageDepth Depth of the active document.
PSHOP_HasLayerMask Boolean indicating presence of layer mask.
PSHOP_HasSelectionMask Boolean indicating presence of selection mask.
PSHOP_HasTransparencyMask Boolean indicating presence of transparency mask.
PSHOP_NumTargetChannels Number of target channels.
PSHOP_NumTrueChannels Numer of image channels.
PSHOP_IsAdjustorSheet Boolean
PSHOP_IsTargetComposite Boolean indicating whether channels are flattened.
PSHOP_IsTargetSection Boolean.
PSHOP_IsTargetVisible Boolean.
PSHOP_ImageWidth Width of the image.
PSHOP_ImageHeight Height of the image.
PSHOP_TargetProtectFlags.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Resource 195

Undefined values in enable-info evaluation

If any arithmetic or relation operation contains an operand whose value is undefined, or a variable that is
undefined, the result of that evaluation is false.

Boolean values are treated as in C/C++, where non-zero values are true, and zero is false, with the
exception that an undefined value is also false.

Using the "in" function

The in function (see <inFunction>) returns true is the first parameter is equal to at least one of the
subsequent parameters. A typical use might be to see if the image mode of the active document is one of
a set of image modes. For example:
in(PSHOP_ImageMode, RGBMode, CMYKMode, LabMode)

Action Manager automation

For your script to be able to record scripting parameters and be automated by them, it requires the
addition of two basic mechanisms:

? A terminology dictionary that maps your script’s user interface to human readable text, providing text
and type information for each parameter the script uses.
? Code to read parameter information when it comes from the Action Manager, rather than from the
user-interface, and code to write parameter information to the Action Manger. This code uses the
Action Manager classes ActionDescriptor, ActionList, and ActionReference.

See Conditional Mode Change.jsx for an example of a script that can record and be automated by
scripting parameters. This file can be found in the Presets/Scripts folder.

Terminology dictionary
The JavaScript resource provides a <terminology> tag that allows you to provide the terminology
dictionary for your script. The first step in creating a terminology dictionary is to review your script’s user
interface, and create human-readable strings for each element in your user interface.

For example, in the Conditional Mode Change command, the user interface requests a source mode and a
target mode. Both source mode and target mode have several options. All of these elements of the user
interface need to have entries in the terminology dictionary.

The terminology dictionary is created in a PDF dictionary format, with the following entries, and must have
the following format in the <javascriptresource>:
<terminology><![CDATA[<<<
/Version integer
/Events <<event dictionary>>
/Classes <<class dictionary>>
/Enumerations <<enumeration dictionary>>
>>> ]]></terminology>

Note: The information in the terminology tag needs to be wrapped in a CDATA block so the xml parser will
ignore "/" and other tags that appear in the terminology.

The defintions for events, classes and enumerations dictionaries are provided below.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Resource 196

The /Events dictionary contains an entry for each event:

/eventName [ // Name used in string-based API

(String event name) // required
/direct parameter type // optional; if omitted, no parameter
<< // optional parameter dictionary
/parameterName [ // Name used in string-based API
(String name) // required
/parameter type // required
]
... // other parameters
>>
]

The /Classes dictionary contains and entry for each class:

/className [ // Name used in string-based API

(ZString class name) // required
<< // property dictionary
/propertyName [ // Name used in string-based API
(String name) // required
/property type // required
]
... // other properties
>>
]

The /Enumerations dictionary contains an entry for each enumerated type:

/enumTypeName // Name used in string-based API

<<
/enumValue (String name) // required
...
>>

Value type defintions

For /parameter type and /property type definitons, you can use the Class and Enumeration type
declarations you make in your own terminology dictionary, you can use declarations provided by
Photoshop or you can use basic value types.

Basic Value Types

The basic value types are shown in the following table:

Name Code Description

typeInteger 'long' int32

typeFloat 'doub' IEEE 64 bit double

typeBoolean 'bool' TRUE or FALSE.

typeText 'TEXT' Block of any number of readable characters.

typeAlias 'alis' Macintosh file system path.
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Resource 197

Name Code Description

typePaths 'Pth ' Windows file system path.
typePlatformFilePath 'alis' or'Pth typeAlias for Mac OS, typePath for Windows.

Predefined Class Types

Photoshop provides a number of predefined classes that are available for use in the terminology
dictionary. A useful subset of those classes is shown in the table below. Use these classes when they are
appropriate, but you can define new classes in the terminology resource, if necessary.

Name Code Description

classColor 'Clr ' Class for color classes.
classRGBColor 'RGBC' keyRed, keyGreen, keyBlue
classCMYKColor 'CMYC' keyCyan, keyMagenta, keyYellow, keyBlack.
classUnspecifiedColo 'UnsC' Unspecified.
r

classGrayscale 'Grsc' keyGray

classBookColor 'BkCl ' Book color
classLabColor 'LbCl' keyLuminance, keyA, keyB.

Uniqueness rules for terminology entries

Generally, the names for terminology entries must be unique within a particular category and scope. It is
best to not make names unique unnecessarily; generic terms are prefereable, and if a name already exists
for something, go ahead and use it. Case matters in considering uniqueness of terminology entries.

The uniqueness rules for terminology entries are:

? All event names must be different from all other event names.
? All class names must be different from all other names.
? All enumeration type names must be different from all other enumeration type names.
? All keys must be different from all other keys used in the same class or event.
? All enumeration values must be different from all other enumeration values in the same enumeration
type.
? A class, event, enumeration type, key, and enumeration value can all have the same name.

Terminology definition example

This example demonstrates the terminology definition for a new event; the example uses ZStrings. The
event is called newAnnot, and it takes three parameters:
? annotType, an enumeration (annotType)
? at, a class (point), and
? size, a class (annotSizeClass).
 Adobe Photoshop
JavaScript Scripting Reference JavaScript Resource 198

The annotSizeClass has two properties: width, and height, both of type floatType. The enumeration
annotType has three values: annotUnknown, annotText, and annotSound.
<terminology><![CDATA[<<<
/Version 1
/Events
/newAnnot [(New Annotation) <<
/annotType [(Type) /annotType]
/at [(At) /Point]
/size [(Size) /annotSizeClass] >>]
/Classes
/annotSizeClass [(Size) <<
/width [(Width) /floatType]
/height [(Height) /floatType]
>>]
/Enumerations
/annotType <<
/annotUnknown (Unknown)
/annotText (Text)
/annotSound (Sound)
>>> ]]></terminology>
4 Scripting Constants

This section lists and describes the enumerations defined for use with Adobe Photoshop JavaScript
properties and methods.

Constant type Values What it means

AdjustmentReference ABSOLUTE Method to use for interpreting
RELATIVE selective color adjustment
specifications:

ABSOLUTE = % of the whole.

RELATIVE = % of the existing color

amount.

Pass to ArtLayer.selectiveColor().
AnchorPosition BOTTOMCENTER The point around which to transform
BOTTOMLEFT an object. This is the point that does
BOTTOMRIGHT
MIDDLECENTER not move when an object is rotated or
MIDDLELEFT resized using methods in ArtLayer,
MIDDLERIGHT LayerSet, and Selection, or when the
TOPCENTER entire canvas is resized with
TOPLEFT
TOPRIGHT Document.resizeCanvas().

AntiAlias CRISP Method to use to smooth edges by

NONE softening the color transition between
SHARP
SMOOTH edge pixels and background pixels.
STRONG Used in a TextItem.antiAliasMethod.

AutoKernType MANUAL The type of kerning to use for

METRICS characters. Used in
OPTICAL
TextItem.autoKerning.
BatchDestinationType FOLDER The destination, if any, for
NODESTINATION batch-processed files, specified in the
SAVEANDCLOSE
BatchOptions used with the
Application.batch() method:
FOLDER: Save modified versions of the
files to a new location (leaving the
originals unchanged).
NODESTINATIONTYPE: Leave all files
open.
SAVEANDCLOSE: Save changes and
close the files.

199
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 200

Constant type Values What it means

BitmapConversionType CUSTOMPATTERN Specifies the quality of an image you
DIFFUSIONDITHER are converting to bitmap mode. Used
HALFTHRESHOLD
HALFTONESCREEN in BitmapConversionOptions.
PATTERNDITHER

BitmapHalfToneType CROSS Specifies the shape of the dots (ink

DIAMOND deposits) in the halftone screen. Used
ELLIPSE
LINE in BitmapConversionOptions.
ROUND
SQUARE

BitsPerChannelType EIGHT The number of bits per color channel.

ONE Value of Document.bitsPerChannel;
SIXTEEN
THIRTYTWO pass to Documents.add(). Also used in
PDFOpenOptions and
CameraRAWOpenOptions.
BlendMode COLORBLEND Controls how pixels in an image are
COLORBURN blended when a filter is applied. The
COLORDODGE
DARKEN value of ArtLayer.blendMode and
DIFFERENCE LayerSet.blendMode.
DISSOLVE
DIVIDE
EXCLUSION
HARDLIGHT
HARDMIX
HUE
LIGHTEN
LINEARBURN
LINEARDODGE
LINEARLIGHT
LUMINOSITY
MULTIPLY
NORMAL
OVERLAY
PASSTHROUGH
PINLIGHT
SATURATION
SCREEN
SOFTLIGHT
SUBTRACT
VIVIDLIGHT

BMPDepthType BMP_A1R5G5B5 The number of bits per channel (also

BMP_A4R4G4B4 called pixel depth or color depth). The
BMP_A8R8G8B8
BMP_R5G6B5 number selected indicates the
BMP_R8G8B8 exponent of 2. For example, a pixel
BMP_X1R5G5B5 with a bit-depth of EIGHT has 28, or
BMP_X4R4G4B4 256, possible color values.
BMP_X8R8G8B8
EIGHT Used in BMPSaveOptions.
FOUR
ONE
SIXTEEN
THIRTYTWO
TWENTYFOUR
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 201

Constant type Values What it means

ByteOrder IBM The platform-specific order in which
MACOS multibyte values are read.
CameraRAWSettingsType CAMERA The default CameraRaw settings to
CUSTOM use: the camera settings, custom
SELECTEDIMAGE
settings, or the settings of the selected
image. Set in
CameraRAWOpenOptions.
CameraRAWSize EXTRALARGE The camera RAW size type options:.
LARGE
MAXIMUM EXTRALARGE=5120 x 4096
MEDIUM LARGE=4096 x 2731
MINIMUM MAXIMUM=6144 X 4096
SMALL
MEDIUM=3072 x 2048
MINIMUM=1536 x 1024
SMALL=2048 x 1365
Set in CameraRAWOpenOptions.
ChangeMode BITMAP The new color profile or mode for a
CMYK document, specified in
GRAYSCALE
INDEXEDCOLOR Document.changeMode().
LAB
MULTICHANNEL Note: Color images must be changed
RGB to GRAYSCALE mode before you
can change them to BITMAP
mode.
ChannelType COMPONENT The type of a color channel:
MASKEDAREA
SELECTEDAREA COMPONENT: related to document color
SPOTCOLOR mode.
MASKEDAREA: Alpha channel where
color indicates masked area.
SELECTEDAREA: Alpha channel where
color indicates selected are.
SPOTCOLOR: Alpha channel to store a
spot color.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 202

Constant type Values What it means

ColorBlendMode BEHIND The way color should be blended in a
CLEAR fill or stroke operation. Pass to
COLOR
COLORBURN PathItem.fillPath(), Selection.fill(),
COLORDODGE Selection.stroke()
DARKEN
DARKERCOLOR
DIFFERENCE
DISSOLVE
EXCLUSION
HARDLIGHT
HARDMIXBLEND
HUE
LIGHTEN
LIGHTERCOLOR
LINEARBURN
LINEARDODGE
LINEARLIGHT
LUMINOSITY
MULTIPLY
NORMAL
OVERLAY
PINLIGHT
SATURATION
SCREEN
SOFTLIGHT
VIVIDLIGHT

ColorModel CMYK The color model to use for a

GRAYSCALE SolidColor.
HSB
LAB
NONE
RGB

ColorPicker ADOBE The preferred color-selection tool, set

APPLE in Preferences.
PLUGIN
WINDOWS

ColorProfileType CUSTOM The type of color profile used to

NONE manage this document, set in
WORKING
Document.colorProfileType.
ColorReductionType ADAPTIVE The color reduction algorithm option
BLACKWHITE for ExportOptionsSaveForWeb.
CUSTOM
GRAYSCALE
MACINTOSH
PERCEPTUAL
RESTRICTIVE
SELECTIVE
WINDOWS

ColorSpaceType ADOBERGB The type of color space to use in

COLORMATCHRGB CameraRAWOpenOptions.
PROPHOTORGB
SRGB

CopyrightedType COPYRIGHTEDWORK The copyright status of a document.

PUBLICDOMAIN Used in
UNMARKED
DocumentPrintSettings.copyrighted.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 203

Constant type Values What it means

CreateFields DUPLICATION The method to use for creating fields.
INTERPOLATION Pass to ArtLayer.applyDeInterlace().
CropToType ARTBOX The style to use when cropping a page
BLEEDBOX in a PDF document. Set in
BOUNDINGBOX
CROPBOX PDFOpenOptions.cropPage.
MEDIABOX
TRIMBOX

DCSType COLORCOMPOSITE The type of composite DCS file to

GRAYSCALECOMPOSITE create with DCS1_SaveOptions or
NOCOMPOSITE
DCS2_SaveOptions:
COLORCOMPOSITE: Creates a color
composite file in addition to DCS files.
GRAYSCALECOMPOSITE: Creates a
grayscale composite file in addition to
DCS files.
NOCOMPOSITE: Does not create a
composite file.
DepthMapSource IMAGEHIGHLIGHT The source to use for the depth map.
LAYERMASK Pass to ArtLayer.applyLensBlur().
NONE
TRANSPARENCYCHANNEL

DescValueType ALIASTYPE The value type of an action key,

BOOLEANTYPE returned by
CLASSTYPE
DOUBLETYPE ActionDescriptor.getType() and
ENUMERATEDTYPE ActionList.getType().
INTEGERTYPE
LARGEINTEGERTYPE
LISTTYPE
OBJECTTYPE
RAWTYPE
REFERENCETYPE
STRINGTYPE
UNITDOUBLE

DialogModes ALL Controls the type of dialogs

ERROR Photoshop displays when running
NO
scripts.
Direction HORIZONTAL ? The direction in which to flip the
VERTICAL document canvas, passed to
Document.flipCanvas().
? The orientation of text in
TextItem.direction.
? The direction of text warping in
TextItem.warpDirection.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 204

Constant type Values What it means

DisplacementMapType STRETCHTOFIT Describes how the displacement map
TILE fits the image if the image is not the
same size as the map. Pass to
ArtLayer.applyDisplace().
Dither DIFFUSION The type of dithering to use in
NOISE GIFSaveOptions,
NONE
PATTERN IndexedConversionOptions and
ExportOptionsSaveForWeb.
DocPositionStyle PRINTCENTERED The type of positioning to use in
USERDEFINED DocPosition
DocumentFill BACKGROUNDCOLOR The fill type of a new document,
TRANSPARENT passed to Documents.add().
WHITE

DocumentMode BITMAP The color mode of a open document,

CMYK Document.mode. See also
DUOTONE
GRAYSCALE Document.changeMode().
INDEXEDCOLOR
LAB
MULTICHANNEL
RGB

EditLogItemsType CONCISE The preferred level of detail in th

DETAILED history log, set in Preferences:
SESSIONONLY
CONCISE: Save a concise history log.
DETAILED: Save a detailed history log.
SESSIONONLY: Save history log only for
the session.
ElementPlacement INSIDE The object’s position in the Layers
PLACEATBEGINNING palette.
PLACEATEND
PLACEBEFORE
PLACEAFTER Note: Not all values are valid for all
object types. See the specific
object description to make sure
you are using a valid value.
EliminateFields EVENFIELDS The type of fields to eliminate. Pass to
ODDFIELDS ArtLayer.applyDeInterlace().
ExportType ILLUSTRATORPATHS The type of export for
SAVEFORWEB Document.exportDocument().
This is equivalent to choosing File >
Export > Paths To Illustrator, or File
> Save For Web and Devices.
Extension LOWERCASE The policy and format for appending
NONE an extension to the filename when
UPPERCASE
saving with Document.saveAs().
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 205

Constant type Values What it means

FileNamingType DDMM File naming options for the
DDMMYY BatchOptions used with the
DOCUMENTNAMELOWER
DOCUMENTNAMEMIXED Application.batch() method.
DOCUMENTNAMEUPPER
EXTENSIONLOWER
EXTENSIONUPPER
MMDD
MMDDYY
SERIALLETTERLOWER
SERIALLETTERUPPER
SERIALNUMBER1
SERIALNUMBER2
SERIALNUMBER3
SERIALNUMBER4
YYDDMM
YYMMDD
YYYYMMDD

FontPreviewType HUGE The preferred type size to use for font

EXTRALARGE previews in the type tool font menus ,
LARGE
MEDIUM set in Preferences.
NONE
SMALL

FontSize LARGE The preferred type size to use for

MEDIUM panels and dialogs, set in Preferences.
SMALL

ForcedColors BLACKWHITE The type of colors to be included the

NONE color table regardless of their usage.
PRIMARIES
WEB Used in GIFSaveOptions and
IndexedConversionOptions.
BLACKWHITE: Pure black and pure
white.
NONE: None
PRIMARIES: Red, green, blue, cyan,
magenta, yellow, black, and white.
WEB: the 216 web-safe colors.

FormatOptions OPTIMIZEDBASELINE The option with which to save a JPEG

PROGRESSIVE file, in JPEGSaveOptions.
STANDARDBASELINE
OPTIMIZEDBASELINE: Optimized color
and a slightly reduced file size.
PROGRESSIVE: Displays a series of
increasingly detailed scans as the
image downloads.
STANDARDBASELINE: Format
recognized by most web browsers.
GalleryConstrainType CONSTRAINBOTH The type of proportions to constrain
CONSTRAINHEIGHT for images. Used in
CONSTRAINWIDTH
GalleryImagesOptions.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 206

Constant type Values What it means

GalleryFontType ARIAL The fonts to use for the Web photo
COURIERNEW gallery captions and other text. Used
HELVETICA
TIMESNEWROMAN in GalleryBannerOptions,
GalleryImagesOptions, and
GalleryThumbnailOptions.
Also used in PicturePackageOptions.
GallerySecurityTextColorType BLACK The color to use for text displayed over
CUSTOM gallery images as an antitheft
WHITE
deterrent. Used in
GallerySecurityOptions.
GallerySecurityTextPositionType CENTERED The position of the text displayed over
LOWERLEFT gallery images as an antitheft
LOWERRIGHT
UPPERLEFT deterrent. Used in
UPPERRIGHT GallerySecurityOptions.
Also used in PicturePackageOptions.
GallerySecurityTextRotateType CLOCKWISE45 The orientation of the text displayed
CLOCKWISE90 over gallery images as an antitheft
COUNTERCLOCKWISE45
COUNTERCLOCKWISE90 deterrent. Used in
ZERO GallerySecurityOptions.
Also used in PicturePackageOptions.
GallerySecurityType CAPTION The content to use for text displayed
COPYRIGHT over gallery images as an antitheft
CREDIT
CUSTOMTEXT deterrent. Used in
FILENAME GallerySecurityOptions.
NONE
TITLE Note: All types draw from the image’s
file information except
CUSTOMTEXT.

GalleryThumbSizeType CUSTOM The size of thumbnail images in the

LARGE web photo gallery. Used in
MEDIUM
SMALL GalleryThumbnailOptions.

Geometry HEPTAGON Geometric options for shapes, such as

HEXAGON the iris shape in the Lens Blur Filter.
OCTAGON
PENTAGON Pass to ArtLayer.applyLensBlur().
SQUARE
TRIANGLE

GridLineStyle DASHED The preferred line style for the

DOTTED nonprinting grid displayed over
SOLID
images, set in Preferences.
GridSize LARGE The preferred size of grid line spacing,
MEDIUM set in Preferences.
NONE
SMALL
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 207

Constant type Values What it means

GuideLineStyle DASHED The preferred line style for
SOLID nonprinting guides displayed over
images, set in Preferences.
IllustratorPathType ALLPATHS The paths to export to an Illustrator
DOCUMENTBOUNDS file using
NAMEDPATH
Document.exportDocument().
Intent ABSOLUTECOLORIMETRIC The rendering intent to use when
PERCEPTUAL converting from one color space to
RELATIVECOLORIMETRIC
SATURATION another with
Document.convertProfile() or
Document.print()
Justification CENTER The placement of paragraph text
CENTERJUSTIFIED within the bounding box. Used in
FULLYJUSTIFIED
LEFT TextItem.justification.
LEFTJUSTIFIED
RIGHT
RIGHTJUSTIFIED

Language BRAZILLIANPORTUGUESE The language to use for text. Used in

CANADIANFRENCH TextItem.language.
DANISH
DUTCH
ENGLISHUK
ENGLISHUSA
FINNISH
FRENCH
GERMAN
ITALIAN
NORWEGIAN
NYNORSKNORWEGIAN
OLDGERMAN
PORTUGUESE
SPANISH
SWEDISH
SWISSGERMAN

LayerCompression RLE Compression methods for data for

ZIP pixels in layers, when saving to TIFF
format. Used in TiffSaveOptions.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 208

Constant type Values What it means

LayerKind BLACKANDWHITE The type of a layer object, in
BRIGHTNESSCONTRAST ArtLayer.kind.
CHANNELMIXER
COLORBALANCE
CURVES Note: You can create a text layer only
EXPOSURE from an empty art layer.
GRADIENTFILL
GRADIENTMAP
HUESATURATION
INVERSION
LEVELS
NORMAL
PATTERNFILL
PHOTOFILTER
POSTERIZE
SELECTIVECOLOR
SMARTOBJECT
SOLIDFILL
TEXT
THRESHOLD
LAYER3D
VIBRANCE
VIDEO

LensType MOVIEPRIME The type of lens to use. Pass to

PRIME105 ArtLayer.applyLensFlare().
PRIME35
ZOOMLENS

MagnificationType ACTUALSIZE The type of magnification to use when

FITPAGE viewing an image. Used in
PresentationOptions.
MatteType BACKGROUND The color to use to fill anti-aliased
BLACK edges adjacent to transparent areas of
FOREGROUND
NETSCAPE the image. When transparency is
NONE turned off for an image, the matte
SEMIGRAY color is applied to transparent areas.
WHITE
Used in GIFSaveOptions,
IndexedConversionOptions, and
JPEGSaveOptions.
MeasurementRange ALLMEASUREMENTS The measurement to act upon. Pass to
ACTIVEMEASUREMENTS MeasurementLog methods.
MeasurementSource MEASURESELECTION The source for recording
MEASURECOUNTTOOL measurements. Pass to
MEASURERULERTOOL
Document.recordMeasurements().
NewDocumentMode BITMAP The color profile to use for a new
CMYK document.
GRAYSCALE
LAB Pass to Documents.add().
RGB
Also used in ContactSheetOptions and
PicturePackageOptions.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 209

Constant type Values What it means

NoiseDistribution GAUSSIAN Distribution method to use when
UNIFORM applying an Add Noise filter. Pass to
ArtLayer.applyAddNoise().
OffsetUndefinedAreas REPEATEDGEPIXELS Method to use to fill the empty space
SETTOBACKGROUND left by offsetting a an image or
WRAPAROUND
selection. Pass to
ArtLayer.applyOffset().
OpenDocumentMode CMYK The color profile to use when opening
GRAYSCALE an EPS or PDF document. Pass to
LAB
RGB app.open() in EPSOpenOptions or
PDFOpenOptions.
OpenDocumentType ALIASPIX The format in which to open the
BMP document, using app.open().
CAMERARAW
COMPUSERVEGIF
DICOM Note: PHOTOCD is deprecated. Kodak
ELECTRICIMAGE PhotoCD is now found in the
EPS Goodies folder on the Adobe
EPSPICTPREVIEW Photoshop Install DVD.
EPSTIFFPREVIEW
FILMSTRIP
JPEG Note: The DICOM option is for the
PCX Extended version only.
PDF
PHOTOCD
PHOTOSHOP
PHOTOSHOPDCS_1
PHOTOSHOPDCS_2
PHOTOSHOPEPS
PHOTOSHOPPDF
PICTFILEFORMAT
PICTRESOURCEFORMAT
PIXAR
PNG
PORTABLEBITMAP
RAW
SCITEXCT
SGIRGB
SOFTIMAGE
TARGA
TIFF
WAVEFRONTRLA
WIRELESSBITMAP

OperatingSystem OS2 The target operating system in

WINDOWS BMPSaveOptions.
Orientation LANDSCAPE Page orientation for
PORTRAIT PhotoCDOpenOptions, deprecated in
Photoshop CS3.
Note: Kodak PhotoCD is now found in
the Goodies folder on the
Adobe Photoshop Install DVD.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 210

Constant type Values What it means

OtherPaintingCursors PRECISEOTHER The preferred pointer for the following
STANDARDOTHER tools: Eraser, Pencil, Paintbrush,
Healing Brush, Rubber Stamp, Pattern
Stamp, Smudge, Blur, Sharpen, Dodge,
Burn, Sponge.
Set in Preferences.
PaintingCursors BRUSHSIZE The preferred pointer for the following
PRECISE tools: Marquee, Lasso, Polygonal
STANDARD
Lasso, Magic Wand, Crop, Slice, Patch
Eyedropper, Pen, Gradient, Line, Paint
Bucket, Magnetic Lasso, Magnetic Pen,
Freeform Pen, Measure, Color Sampler.
Set in Preferences.
PaletteType EXACT The palette type to use in
LOCALADAPTIVE GIFSaveOptions and
LOCALPERCEPTUAL
LOCALSELECTIVE IndexedConversionOptions.
MACOSPALETTE
MASTERADAPTIVE
MASTERPERCEPTUAL
MASTERSELECTIVE
PREVIOUSPALETTE
UNIFORM
WEBPALETTE
WINDOWSPALETTE

PathKind CLIPPINGPATH The type of a PathItem.

NORMALPATH
TEXTMASK
VECTORMASK
WORKPATH

PDFCompatibility PDF13 The PDF version to make the

PDF14 document compatible with. Used in
PDF15
PDF16 PDFSaveOptions.
PDF17

PDFEncoding JPEG The type of compression to use when

JPEG2000HIGH saving a document in PDF format.
JPEG2000LOSSLESS
JPEG2000LOW Used in PDFSaveOptions.
JPEG2000MED
JPEG2000MEDHIGH
JPEG2000MEDLOW
JPEGHIGH
JPEGLOW
JPEGMED
JPEGMEDHIGH
JPEGMEDLOW
NONE
PDFZIP
PDFZIP4BIT
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 211

Constant type Values What it means

PDFResample NONE The down sample method to use.
PDFAVERAGE Used in PDFSaveOptions.
PDFBICUBIC
PDFSUBSAMPLE

PDFStandard NONE The PDF standard to make the

PDFX1A2001 document compatible with. Used in
PDFX1A2003
PDFX32002 PDFSaveOptions.
PDFX32003
PDFX42008

PhotoCDColorSpace LAB16 The color space for

LAB8 PhotoCDOpenOptions, deprecated in
RGB16
RGB8 Photoshop CS3.
Note: Kodak PhotoCD is now found in
the Goodies folder on the
Adobe Photoshop Install DVD.
PhotoCDSize EXTRALARGE The pixel dimensions of the image in
LARGE PhotoCDOpenOptions, deprecated in
MAXIMUM
MEDIUM Photoshop CS3.
MINIMUM EXTRALARGE = 1024x1536
SMALL LARGE = 512x768
MAXIMUM = 2048x3072
MEDIUM = 256x384
MINIMUM = 64x96
SMALL = 128x192
Note: Kodak PhotoCD is now found in
the Goodies folder on the
Adobe Photoshop Install DVD.
PICTBitsPerPixels EIGHT The number of bits per pixel to use
FOUR when compression a PICT file. Used in
SIXTEEN
THIRTYTWO PICTFileSaveOptions and
TWO PICTResourceSaveOptions.

Note: Use 16 or 32 for RGB images;

use 2, 4, or 8 for bitmap and
grayscale images.
PICTCompression JPEGHIGHPICT The type of compression to use when
JPEGLOWPICT saving an image as a PICT file. Used in
JPEGMAXIMUMPICT
JPEGMEDIUMPICT PICTFileSaveOptions and
NONE PICTResourceSaveOptions.

PicturePackageTextType CAPTION The function or meaning of text in a

COPYRIGHT Picture Package. Used in
CREDIT
FILENAME PicturePackageOptions.
NONE
ORIGIN
USER

PointKind CORNERPOINT The role a PathPoint plays in a

SMOOTHPOINT PathItem.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 212

Constant type Values What it means

PointType POSTSCRIPT The preferred measurement to use for
TRADITIONAL type points, set in
Preferences.pointSize:
POSTSCRIPT = 72 points/inch.
TRADITIONAL = 72.27 points/inch.

PolarConversionType POLARTORECTANGULAR The method of polar distortion to use.

RECTANGULARTOPOLAR Pass to
ArtLayer.applyPolarCoordinates().
Preview EIGHTBITTIFF The type of image to use as a
MACOSEIGHTBIT low-resolution preview in the
MACOSJPEG
MACOSMONOCHROME destination application.
MONOCHROMETIFF Used in DCS1_SaveOptions,
NONE
DCS2_SaveOptions, and
EPSSaveOptions.
PrintColorHandling PRINTERMANAGED The type of color handling to use for
PHOTOSHOPMANAGED ColorHandling
SEPARATIONS

PurgeTarget ALLCACHES Cache to be targeted in an

CLIPBOARDCACHE Application.purge() operation.
HISTORYCACHES
UNDOCACHES

QueryStateType ALWAYS The preferred policy for checking

ASK whether to maximize compatibility
NEVER
when opening PSD files, set in
Preferences.maximizeCompatibility.
RadialBlurMethod SPIN The blur method to use. Pass to
ZOOM ArtLayer.applyRadialBlur().
RadialBlurQuality BEST The smoothness or graininess of the
DRAFT blurred image. Pass to
GOOD
ArtLayer.applyRadialBlur().
RasterizeType ENTIRELAYER The layer element to rasterize, using
FILLCONTENT ArtLayer.rasterize().
LAYERCLIPPINGPATH
LINKEDLAYERS
SHAPE
TEXTCONTENTS

ReferenceFormType CLASSTYPE The type of an ActionReference

ENUMERATED object, returned by getForm().
IDENTIFIER
INDEX
NAME
OFFSET
PROPERTY
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 213

Constant type Values What it means

ResampleMethod AUTOMATIC The method to use for image
BICUBIC interpolation. Passed to
BICUBICAUTOMATIC
BICUBICSHARPER Document.resizeImage(), and used as
BICUBICSMOOTHER the value of Preferences.interpolation.
BILINEAR
NEARESTNEIGHBOR
NONE
PRESERVEDETAILS

RippleSize LARGE The size of undulations to use. Pass to

MEDIUM ArtLayer.applyRipple().
SMALL

SaveBehavior ALWAYSSAVE The application’s preferred behavior

ASKWHENSAVING when saving a document. See
NEVERSAVE
Preferences.appendExtension and
imagePreviews
SaveDocumentType ALIASPIX The format in which to save a
BMP document when exporting with
COMPUSERVEGIF
ELECTRICIMAGE Document.exportDocument(). Pass in
JPEG ExportOptionsSaveForWeb.format, to
PCX to specify the type of file to write. Only
PHOTOSHOP the following are supported for
PHOTOSHOPDCS_1
PHOTOSHOPDCS_2 export: COMPUSERVEGIF, JPEG, PNG-8,
PHOTOSHOPEPS PNG-24, and BMP.
PHOTOSHOPPDF
PICTFileFORMAT
PICTRESOURCEFORMAT
PIXAR
PNG
PORTABLEBITMAP
RAW
SCITEXCT
SGIRGB
SOFTIMAGE
TARGA
TIFF
WAVEFRONTRLA
WIRELESSBITMAP

SaveEncoding ASCII The type of encoding to use when

BINARY saving a file to DCS or EPS with
JPEGHIGH
JPEGLOW Document.saveAs().
JPEGMAXIMUM
JPEGMEDIUM

SaveLogItemsType LOGFILE The preferred location of history log

LOGFILEANDMETADATA data, set in Preferences.saveLogItems.
METADATA

SaveOptions DONOTSAVECHANGES The policy for closing a document

PROMPTTOSAVECHANGES with Document.close().
SAVECHANGES
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 214

Constant type Values What it means

SelectionType DIMINISH The selection behavior when a
EXTEND selection already exists:
INTERSECT
REPLACE DIMINISH: Remove the selection from
the already selected area.
EXTEND: Add the selection to an
already selected area.
INTERSECT: Make the selection only
the area where the new selection
intersects the already selected area.
REPLACE: Replace the selected area.
Used in PathItem.makeSelection(),
Selection.load(), Selection.select(), and
Selection.store().
ShapeOperation SHAPEADD How to combine the shapes if the
SHAPEINTERSECT destination path already has a
SHAPESUBTRACT
SHAPEXOR selection.
Set for SubPathInfo.operation, stored
in the resulting SubPathItem.
SmartBlurMode EDGEONLY The method to use for smart blurring:
NORMAL
OVERLAYEDGE EDGEONLY, OVERLAYEDGES: Apply blur
only to edges of color transitions.
NORMAL: Apply blur to entire image.
Pass to ArtLayer.applySmartBlur().
SmartBlurQuality HIGH The blur quality to use. Pass to
LOW ArtLayer.applySmartBlur().
MEDIUM

SourceSpaceType DOCUMENT The color space for source when

PROOF printing with Document.print().
SpherizeMode HORIZONTAL The curve (or stretch shape) to use for
NORMAL the distortion. Pass to
VERTICAL
ArtLayer.applySpherize().
StrikeThruType STRIKEBOX The style of strikethrough to use in
STRIKEHEIGHT text. Used in TextItem.strikeThru.
STRIKEOFF

StrokeLocation CENTER The placement of path or selection

INSIDE boundary strokes. Pass to
OUTSIDE
Selection.stroke().
TargaBitsPerPixels SIXTEEN The resolution to use when saving an
THIRTYTWO image in Targa format. Used in
TWENTYFOUR
TargaSaveOptions.
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 215

Constant type Values What it means

TextCase ALLCAPS The capitalization style to use in text.
NORMAL Used in TextItem.capitalization.
SMALLCAPS

TextComposer ADOBEEVERYLINE The composition method to use to

ADOBESINGLELINE optimize the specified hyphenation
and justification options. Used in
TextItem.textComposer.
TextType PARAGRAPHTEXT The type of text, used in TextItem.kind.
POINTTEXT
PARAGRAPHTEXT: Text that wraps
within a bounding box.
POINTTEXT: Text that does not wrap.

TextureType BLOCKS The type of texture or glass surface

CANVAS image to load for a texturizer or glass
FILE
FROSTED filter. Pass to
TINYLENS ArtLayer.applyGlassEffect().

TIFFEncoding JPEG The type of compression to use for

NONE TIFF files. Used in TiffSaveOptions.
TIFFLZW
TIFFZIP

ToolType ARTHISTORYBRUSH The tool to use with

BACKGROUNDERASER PathItem.strokePath().
BLUR
BRUSH
BURN
CLONESTAMP
COLORREPLACEMENTTOOL
DODGE
ERASER
HEALINGBRUSH
HISTORYBRUSH
PATTERNSTAMP
PENCIL
SHARPEN
SMUDGE
SPONGE

TransitionType BLINDSHORIZONTAL The method to use for transition from

BLINDSVERTICAL one image to the next in a PDF
BOXIN
BOXOUT presentation. Used in
DISSOLVE PresentationOptions.
GLITTERDOWN
GLITTERRIGHT
GLITTERRIGHTDOWN
NONE
RANDOM
SPLITHORIZONTALIN
SPLITHORIZONTALOUT
SPLITVERTICALIN
SPLITVERTICALOUT
WIPEDOWN
WIPELEFT
WIPERIGHT
WIPEUP
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 216

Constant type Values What it means

TrimType BOTTOMRIGHT Type of pixels to trim around an
TOPLEFT image, passed to Document.trim().:
TRANSPARENT
BOTTOMRIGHT = bottom right pixel
color.
TOPLEFT = top left pixel color.

TypeUnits MM The preferred unit for text character

PIXELS measurements, set in Preferences.
POINTS

UndefinedAreas REPEATEDGEPIXELS The method to use to treat

WRAPAROUND undistorted areas or areas left blank in
an image to which the a filter in the
Distort category has been applied.
Pass to ArtLayer.applyDisplace(),
applyShear(), applyWave().
UnderlineType UNDERLINELEFT The placement of text underlining.
UNDERLINEOFF Used in TextItem.underline.
UNDERLINERIGHT
Note: UNDERLINELEFT and
UNDELINERIGHT are valid only when
direction = Direction.VERTICAL.

Units CM The preferred measurement unit for

INCHES type and ruler increments, set in
MM
PERCENT Preferences.rulerUnits.
PICAS
PIXELS
POINTS

Urgency FOUR The editorial urgency status of a

HIGH document, set in
LOW
NONE DocumentPrintSettings.urgency.
NORMAL
SEVEN
SIX
THREE
TWO

WarpStyle ARC The warp style to use for text. Used in

ARCH TextItem.warpStyle.
ARCLOWER
ARCUPPER
BULGE
FISH
FISHEYE
FLAG
INFLATE
NONE
RISE
SHELLLOWER
SHELLUPPER
SQUEEZE
TWIST
WAVE
 Adobe Photoshop
JavaScript Scripting Reference Scripting Constants 217

Constant type Values What it means

WaveType SINE The type of wave to use. Pass to
SQUARE ArtLayer.applyWave().
TRIANGULAR

WhiteBalanceType ASSHOT Lighting conditions that affect color

AUTO balance. Set in
CLOUDY
CUSTOM CameraRAWOpenOptions.
DAYLIGHT
FLASH
FLUORESCENT
SHADE
TUNGSTEN

ZigZagType AROUNDCENTER The method of zigzagging to use. Pass

OUTFROMCENTER to ArtLayer.applyZigZag().
PONDRIPPLES
Appendix A: Event ID Codes

The following table lists events and their four-character ID codes or string identifiers for use with the
notifier object.

Note: Do not include single quotes ( ' ) with four-character IDs in your code. The single quotes are
used in this table to illustrate the placement of required spaces in codes that do not contain four
letters. However, string identifiers, which are longer than four characters, require double quotes in
the code.

Tip: If you can’t find the event you want to use for notification in this table, you can use ScriptListener to
determine the event ID code. See the ScriptListener documentation in the Action Manager chapter of
the Photoshop Scripting Guide.

Event 4-char ID or String

3DTransform 'TdT '

Average 'Avrg'

ApplyStyle 'ASty'

Assert 'Asrt'

AccentedEdges 'AccE'

Add 'Add '

AddNoise 'AdNs'

AddTo 'AddT'

Align 'Algn'

All 'All '

AngledStrokes 'AngS'

ApplyImage 'AppI'

BasRelief 'BsRl'

Batch 'Btch'

BatchFromDroplet 'BtcF'

Blur 'Blr '

BlurMore 'BlrM'

Border 'Brdr'

Brightness 'BrgC'

CanvasSize 'CnvS'

ChalkCharcoal 'ChlC'

ChannelMixer 'ChnM'

218
 Adobe Photoshop
JavaScript Scripting Reference Appendix A: Event ID Codes 219

Event 4-char ID or String

Charcoal 'Chrc'

Chrome 'Chrm'

Clear 'Cler'

Close 'Cls '

Clouds 'Clds'

ColorBalance 'ClrB'

ColorHalftone 'ClrH'

ColorRange 'ClrR'

ColoredPencil 'ClrP'

ContactSheet "0B71D221-F8CE-11d2-B21B-0008C75B322C"

ConteCrayon 'CntC'

Contract 'Cntc'

ConvertMode 'CnvM'

Copy 'copy'

CopyEffects 'CpFX'

CopyMerged 'CpyM'

CopyToLayer 'CpTL'

Craquelure 'Crql'

CreateDroplet 'CrtD'

Crop 'Crop'

Crosshatch 'Crsh'

Crystallize 'Crst'

Curves 'Crvs'

Custom 'Cstm'

Cut 'cut '

CutToLayer 'CtTL'

Cutout 'Ct '

DarkStrokes 'DrkS'

DeInterlace 'Dntr'

DefinePattern 'DfnP'

Defringe 'Dfrg'

Delete 'Dlt '

Desaturate 'Dstt'
 Adobe Photoshop
JavaScript Scripting Reference Appendix A: Event ID Codes 220

Event 4-char ID or String

Deselect 'Dslc'

Despeckle 'Dspc'

DifferenceClouds 'DrfC'

Diffuse 'Dfs '

DiffuseGlow 'DfsG'

DisableLayerFX 'dlfx'

Displace 'Dspl'

Distribute 'Dstr'

Draw 'Draw'

DryBrush 'DryB'

Duplicate 'Dplc'

DustAndScratches 'DstS'

Emboss 'Embs'

Equalize 'Eqlz'

Exchange 'Exch'

Expand 'Expn'

Export 'Expr'

Jumpto 'Jpto'

ExportTransparentImage "02879e00-cb66-11d1-bc43-0060b0a13dc4"

Extrude 'Extr'

Facet 'Fct '

Fade 'Fade'

Feather 'Fthr'

Fibers 'Fbrs'

Fill 'Fl '

FilmGrain 'FlmG'

Filter 'Fltr'

FindEdges 'FndE'

FitImage "3caa3434-cb67-11d1-bc43-0060b0a13dc4"

FlattenImage 'FltI'

Flip 'Flip'

Fragment 'Frgm'

Fresco 'Frsc'
 Adobe Photoshop
JavaScript Scripting Reference Appendix A: Event ID Codes 221

Event 4-char ID or String

GaussianBlur 'GsnB'

Get 'getd'

Glass 'Gls '

GlowingEdges 'GlwE'

Gradient 'Grdn'

GradientMap 'GrMp'

Grain 'Grn '

GraphicPen 'GraP'

Group 'GrpL'

Grow 'Grow'

HalftoneScreen 'HlfS'

Hide 'Hd '

HighPass 'HghP'

HSBHSL 'HsbP'

HueSaturation 'HStr'

ImageSize 'ImgS'

Import 'Impr'

InkOutlines 'InkO'

Intersect 'Intr'

IntersectWith 'IntW'

Inverse 'Invs'

Invert 'Invr'

LensFlare 'LnsF'

Levels 'Lvls'

LightingEffects 'LghE'

Link 'Lnk '

Make 'Mk '

Maximum 'Mxm '

Median 'Mdn '

MergeLayers 'Mrg2'

MergeLayersOld 'MrgL'

MergeSpotChannel 'MSpt'

MergeVisible 'MrgV'
 Adobe Photoshop
JavaScript Scripting Reference Appendix A: Event ID Codes 222

Event 4-char ID or String

Mezzotint 'Mztn'

Minimum 'Mnm '

ModeChange "8cba8cd6-cb66-11d1-bc43-0060b0a13dc4"

Mosaic 'Msc '

Mosaic_PLUGIN 'MscT'

MotionBlur 'MtnB'

Move 'move'

NTSCColors 'NTSC'

NeonGlow 'NGlw'

Next 'Nxt '

NotePaper 'NtPr'

Notify 'Ntfy'

Null typeNull

OceanRipple 'OcnR'

Offset 'Ofst'

Open 'Opn '

Paint 'Pnt '

PaintDaubs 'PntD'

PaletteKnife 'PltK'

Paste 'past'

PasteEffects 'PaFX'

PasteInto 'PstI'

PasteOutside 'PstO'

Patchwork 'Ptch'

Photocopy 'Phtc'

PicturePackage "4C1ABF40-DD82-11d2-B20F-0008C75B322C"

Pinch 'Pnch'

Place 'Plc '

Plaster 'Plst'

PlasticWrap 'PlsW'

Play 'Ply '

Pointillize 'Pntl'

Polar 'Plr '

 Adobe Photoshop
JavaScript Scripting Reference Appendix A: Event ID Codes 223

Event 4-char ID or String

PosterEdges 'PstE'

Posterize 'Pstr'

Previous 'Prvs'

Print 'Prnt'

ProfileToProfile 'PrfT'

Purge 'Prge'

Quit 'quit'

RadialBlur 'RdlB'

Rasterize 'Rstr'

RasterizeTypeSheet 'RstT'

RemoveBlackMatte 'RmvB'

RemoveLayerMask 'RmvL'

RemoveWhiteMatte 'RmvW'

Rename 'Rnm '

ReplaceColor 'RplC'

Reset 'Rset'

ResizeImage "1333cf0c-cb67-11d1-bc43-0060b0a13dc4"

Reticulation 'Rtcl'

Revert 'Rvrt'

Ripple 'Rple'

Rotate 'Rtte'

RoughPastels 'RghP'

Save 'save'

Select 'slct'

SelectiveColor 'SlcC'

Set 'setd'

SharpenEdges 'ShrE'

Sharpen 'Shrp'

SharpenMore 'ShrM'

Shear 'Shr '

Show 'Shw '

Similar 'Smlr'

SmartBlur 'SmrB'
 Adobe Photoshop
JavaScript Scripting Reference Appendix A: Event ID Codes 224

Event 4-char ID or String

Smooth 'Smth'

SmudgeStick 'SmdS'

Solarize 'Slrz'

Spatter 'Spt '

Spherize 'Sphr'

SplitChannels 'SplC'

Sponge 'Spng'

SprayedStrokes 'SprS'

StainedGlass 'StnG'

Stamp 'Stmp'

Stop 'Stop'

Stroke 'Strk'

Subtract 'Sbtr'

SubtractFrom 'SbtF'

Sumie 'Smie'

TakeMergedSnapshot 'TkMr'

TakeSnapshot 'TkSn'

TextureFill 'TxtF'

Texturizer 'Txtz'

Threshold 'Thrs'

Tiles 'Tls '

TornEdges 'TrnE'

TraceContour 'TrcC'

Transform 'Trnf'

Trap 'Trap'

Twirl 'Twrl'

Underpainting 'Undr'

Undo 'undo'

Ungroup 'Ungr'

Unlink 'Unlk'

UnsharpMask 'UnsM'

Variations 'Vrtn'

Wait 'Wait'
 Adobe Photoshop
JavaScript Scripting Reference Appendix A: Event ID Codes 225

Event 4-char ID or String

WaterPaper 'WtrP'

Watercolor 'Wtrc'

Wave 'Wave'

Wind 'Wnd '

ZigZag 'ZgZg'

BackLight 'BacL'

FillFlash 'FilE'

ColorCast 'ColE'
 Index

A available memory 46
Action Manager 195 Average filter 57
actions
command lists 40 B
descriptions 43 background color
descriptors 37 application 45
playing 47 galleries 112
active document 45 background layers 55
activePrinter 98 backgroundColor 98
Add Noise filter baseline shift 181
adjustments batch command 47
brightness 57 batches
color 199 destination folder 68, 199
color balance 57, 63 specifying options 68
contrast 57, 61 beeping 160
curves 57 bitmap documents
highlights 64 converting to 200
levels 57, 61 depth type 200
shadows 64 halftone type 200
temperature 63 opening 209
Adobe Illustrator, exporting paths to 107 saving 71
alpha channels bitmap images
defined 74 See bitmap documents
from transparency (TIFF documents) 188 black and white images 64
opacity 74 bleedWidth 98
saving blending modes
in BMP documents 71 layer sets 131
in PDF documents 150 layers 55
in PICT documents 155 Blur filter 57
in PICT resources 156 blur filters
in Pixar documents 158 Average 57
in PSD documents 154 Blur More 57
in RAW documents 166 Gaussian Blur 58
in SGIRGB documents 173 Lens Blur 59
in Targa documents 178 Motion Blur 60
in TIFF documents 188 Radial Blur 60
anchor points Smart Blur 61
adding 145 Blur More filter 57
annotations, importing 94 BMP documents
anti aliasing See bitmap documents
text 181 brightness 57
application adjusting 57
activating 47 equalizing 62
checking if feature enabled 49 build 45
defaults 160
location 46
preferences 160 C
artLayers, See layers caches
Asian text 162 images 161
authors 101 purging 51
auto kerning 181, 199 camera raw documents
auto leading 186 opening 72
auto spacing, contact sheets 84 settings 201
size options 201

226
 Adobe Photoshop
JavaScript Scripting Reference Index 227

canvas settings 45
flipping 94 solid color objects 174
resizing 94 testing if equal 174
canvas, defined 90 visited links 112
caption 98 comments, layer comps 128
captions compatibility, maximizing 161
contact sheets 84 component channels
documents 101 color balance 57
gallery images 113 defined 74
gallery thumbnails 117 listing 90
images 101 See composite channels
centerCropMarks 98 composite channels 74
changeProgressText 47 See component channels
channels Compuserve GIF documents
activating 90 opening 209
adding 76 saving 118
adjusting 57 contact sheets
alpha See alpha channels captions 84
creating 76 columns 84
deleting 74 dimensions 84
displaying in color 160 making 50
duplicating 74 rows 84
making visible 74 contrast
merging 74 adjusting 57
mixing 63 adjusting automatically 61
splitting 95 camera raw settings 72
spot See spot channels midtones 64
types of 74 copies 98
clipping paths copyrights 101
from paths 141 cornerCropMarks 98
from text 187 count items
Clouds filter 57 adding 86
CMYKColor 81 creating 86
color balance, adjusting 63 removing 85
color picker 160 cropping 93
color profiles current tool name 45
changing 93 cursors 162
determining type of 91 curves, adjusting 57
naming 90 Custom filters 57
color profiles, see individual document formats
color samplers
D
adding 83
DCS 1 documents, saving 87
creating 83
De-Interlace filter 58
moving 82
desaturate 62
removing 82
Despeckle filter 58
colorBars 98
dialogs
colorHandling 98
displaying 45
colors
Difference Clouds filter 58
active links 112
Diffuse Glow filter 58
adjusting 199
Displace filter 58
balancing 57
distort filters
channels 74
Diffuse Glow 58
CMYK 81
Displace 58
custom settings 115
Glass Effect 58
in galleries 112
Ocean Ripple 60
inverting 62
Pinch 60
modifying 64
Polar Coordinates 60
none 137
Ripple 60
preserving (GIF only) 118
Shear 61
reduction 108
 Adobe Photoshop
JavaScript Scripting Reference Index 228

Spherize 61 ExportOptionsIllustrator 107

Twirl 61 ExportOptionsSaveForWeb 108
Wave 61
Zigzag 61
F
doAction 48
file extensions
document formats, see individual document formats
format 163
DocumentPrintSettings 98
including 160
documents 90
script files 32
activating 45
file metadata 101
adding 104
files
closing 92
merging 50
code sample 96
filetypes
color profiles 90
macOS 46
color samplers 90
Windows 47
counting items 91
filling
counting objects 93
paths 140
cropping 36, 93
selections 169
dimensions 90
filter, see individual filter names
duplicating 36, 93
flip 98
exporting 94
Folder object 32
info 101
fonts
loading 49
detecting 45
managed 91
determining family of 179
measurement scale 91
determining style of 179
metadata 91, 101
formats, see individual document formats
open with Photoshop dialog 50
opening 50
optimizing for web 108 G
printing 94 galleries 115
resizing 94 background color 112
resolution 92 banners 111
saving 94, 95 captions 113
suspending history 95 color options 112
trapping (CMYK) 95 credits 113
trimming 96 dimensions 113
doForcedProgress 48 filenames 113
doProgress 48 link colors 112
doProgressSegmentTask 48 making 47, 50
doProgressTask 49 metadata 115
Dust and Scratches filter 58 photographer 111
security text 116
E thumbnail images 117
GalleryBannerOptions 111
Enable Info
GalleryCustomColorOptions 112
constants 193
GalleryImagesOptions 113, 114
grammar 192
GalleryOptions 115
operator precendence 193
GallerySecurityOptions 116
variables 194
GalleryThumbnailOptions 117
EPSSaveOptions 106
Gaussian Blur filter 58
equalize 62
GIF documents
event IDs
See Compuserve GIF documents
using ScriptListener to find 218
GIFSaveOptions 118
Events Manager 46
Glass Effect filter 58
executing scripts 33
glyph scaling 181–184
exif 101
GrayColor 119
exporting
grids 161
documents 94
grouped layers 55
paths 107
guides 161
to Illustrator 107
to Web 108
 Adobe Photoshop
JavaScript Scripting Reference Index 229

H J
halftone screen 70 JavaScript
hanging punctuation 182 supported features 32
hardProof 98 JavaScript Resource
High Pass filter 58 Enable Info grammar 192
highlights javascriptresource syntax 191
adjusting 64 javascriptresource tag 191
color balance 57 JPEG
histograms quality 126
channels 74 JPEG documents
history log 163 quality 126
history states saving 126
activating 90 JPEG options
allowing nonlinear 161 scans 126
default number of 162 JPEGSaveOptions 126
snapshot 122 justification 183
suspending 95
HSBColor 124
K
hypenation 183
kerning 181
text
I auto kerning 199
IDs keyboard behavior 161
getting 37
PICT Resource 156
L
property 43
LabColor 127
runtime 47
labels 98
runtime to string 52
languages 183
string to runtime 51
layer comps 128
string to type 51
adding 129
type to char 51
applying 128
Illustrator
in documents 91
See Adobe Illustrator
layer sets
image
adding 133
resizing 95
art layers in 131
image pyramids 188
duplicating 132
images
in documents 91
bitmap 70
linked layers in 131
black and white 64
linking 132
caches 161
locking contents 131
captions 113
moving 132
definition of 90
nesting 131
desaturating 62
opacity 131
equalizing 62
unlinking 132
filetypes 46
layer styles, applying 61
from split channels 95
LayerComps 129
inverting colors 62
layered TIFFdocuments, saving 160
previewing 161
Layers 130
pyramids 188
layers
resizing 94
adding 67
resizing in galleries 114
applying styles 61
thumbnails 117
background 55
indexed color model 125
blending mode 55
IndexedConversionOptions 125
bounds 55
individual document formats, examples 95
clipboard commands 61
installing scripts 33
comps 128
Intent 98
copying 61
interpolate 98
duplicating 62
interpolation 161
flattening 94
grouping 55
 Adobe Photoshop
JavaScript Scripting Reference Index 230

in documents 91 N
inverting 62 negative 98
kind 55 noise filters
linking 62 Add Noise
locking contents 55–56 Despeckle 58
making visible 56 Dust and Scratches 58
merging 62 Median Noise 59
merging visible 94 nonlinear history 161
moving 63 notifications
rasterizing 94 events within scripts 138
rasterizing contents 63 notifiers
removing 67 adding 139
resizing 64 event IDs 218
rotating 64 removing 138
saving in PDF documents 150 NTSC filter 60
unlinking 64
LayerSet 131
LayerSets 133 O
layersets Ocean Ripple filter 60
merging 132 Offset filter 60
leading 183, 186 old style type 185
Lens Blur filter opacity
applying 59 channels 74
Lens Flare filter 59 gallery security text 116
letter spacing 182–185 layer fill 55
levels layer sets 131
adjusting 57 layers 56
adjusting automatically 57 picture packages 157
ligatures 181–183 open options
linked layers 62 DICOM format 89
unlinking 64 EPS format 105
links PDF format 149
colors 112 Photo CD format 153
RAW format 72, 165
optimizing 108
M other filters
MacOS Custom 57
filetypes 46 High Pass 58
managed documents 91 Maximum 59
mapBlack 98 Minimum 60
maximizing compatibility 161 Offset 60
Maximum filter 59
Median Noise filter 59
memory 46 P
merging palettes 162
layers 62 pasting 94
visible layers 94 path 46
metadata path items
document 91 adding 144
document object 101 deselecting 140
galleries 115 filling 140
xmp 92, 190 from text 187
methods making selection 141
batch 47 path points 176
midtones selecting 141
color balance 57 specifying path kind 140
Minimum filter 60 stroking 141
Motion Blur filter 60 sub items 140
sub path info 175
sub path items 176
work path from selection 169
 Adobe Photoshop
JavaScript Scripting Reference Index 231

path point info PNGSaveOptions 159

anchor points 146 Polar Coordinates filter 60
left direction 146 posterrize 63
right direction 146 postscript encoding 94
path points PostScript names 179
anchor points 145 posX 98
left direction 145 posY 98
right direction 145 Preferences 160
PathItems 144 PresentationOptions 164
paths presentations
See path items making 50
PDF documents PDF presentations
opening 149 printBorder 98
saving 150 printing, documents 94
PDF presentations printOneCopy 94
auto advance 164 printSelected 98
making 50 printSettings 92
output format 164 printSpace 98
transition type 164 property
Photo CD discs, opening 153 measurementLog 46
photo filtering 63 PSD documents
photo galleries opening 209
See galleries saving 154
photomerge 50 purging 51
Photoshop documents
opening 209
Q
saving 154
quickMaskMode 92
Photoshop files, maximizing compatibility 161
quote style 162
PICT documents
opening 209
saving 155 R
PICT resources Radial Blur filter 60
opening 209 rasterize 63
saving 156 rasterizing
picture packages document layers 94
contents 157 RAW documents
flattening 157 opening 165
making 50 RawSaveOptions 166
opacity 157 recentFiles 46
options 157 registrationMarks 98
text properties 157 render filters
Pinch filter 60 Clouds 57
Pixar documents Difference Clouds 58
opening 209 Lens Flare 59
saving 158 renderIntent 98
PixarSaveOptions 158 resolution
pixels bitmap conversions 70
aspect ratio 91 documents 92
doubling 162 RGBColor 167
equalizing 62 Ripple filter 60
interpolation 161 rotation 64
locking 56 ruler units 162
unit measures 216 runMenuItem 51
playback options 46
playbackDisplayDialogs 46
plug-in folder
S
additional plug-in folder 163 save as 95
PNG 8 documents, saving 108 saved 92
PNG documents saving 94
saving 159 saving, see individual document formats.
 Adobe Photoshop
JavaScript Scripting Reference Index 232

scale 99 spotColors 173

scripting interface startup scripts 33
build date 46 strike thru 186
version 46 stroking
scriptingVersion 46 default stroke color 45
scripts path items 141
automation 191, 195 selections 170
enabling/disabling in menu 191 styles, applying 61
executing 33 sub path items 140
grouping in menu 191 systemInformation 46
installing 33
startup 33
T
terminology dictionary 195
temperature 63
valid file extensions 32
terminology dictionary
Scripts Events Manager 46
defined 195
selected areas 92
syntax 195
selections 168
text
boundaries 168
Asian 162
clearing 168
auto kerning 181
copying 168
auto leading 186
cutting 168
captions 113
deselecting 168
color
feathering 168
composer 186
filling 169
content 181
from paths 141
creating paths from 187
making work path from 169
formatting 186
resizing 168, 169
gallery security 116, 206
rotating 169
hyphenation 183
smoothing 170
in picture packages 157
stroking 170
justification 183
selective color 64
languages 183
SGIRGB documents
offset 181
saving 173, 213
orientation 182
SGIRGBSaveOptions 173, 199
spacing 182–185
shadows
tracking 186
adjusting 64
wrapping 183
color balance 57
text composer 186
Sharpen Edges filter 60
text fonts
Sharpen filter 60
See fonts
sharpen filters
text items
Sharpen 60
See text
Sharpen Edges 60
text layers
Sharpen More 60
adding contents 181
Unsharp Mask 61
creating 55
Sharpen More filter 60
Texture Fill filter 61
Shear filter 61
texture filters, Texture Fill 61
Smart Blur filter 61
threshold 64
smart quotes 162
thumbnails 117
Spherize filter 61
Mac OS 161
spot channels
Windows 163
defined 74
TIFF documents
merging into component channels 75
layered 160
opacity 74
saving 188
saving
togglePalettes 51
in DCS 2 documents 88
tool tips 162
in PDF documents 151
toolSupportsBrushes 51
in PSD documents 154
tracking, text 186
in RAW documents 166
transmission info 101
in SGIRGB documents 173
trapping 95
in TIFF documents 188
 Adobe Photoshop
JavaScript Scripting Reference Index 233

Twirl filter 61 layers 56

type units 163
W
U warp 186
underlining 186 Wave filter 61
units Web photo galleries
ruler 162 See galleries.
type 163 webSnap 109
UnitValue object 32, 189 width 92
Unsharp Mask filter 61 Windows
URLs, document 101 filetypes 47
UTF8 Encoding 115 word spacing 182–185
work paths
designating 210
V
from selected area 169
vectorData 99
wrapping, text 183
version
application 47
scripting interface 46 X
video alpha 163 XML 190
video filters xmp metadata 92, 190
De-Interlace 58
NTSC 60
Z
visibility
Zigzag filter 61
channels 74
zoom 161
layer comps 128