photoshop cs5 object reference 3.0 - documentation.help · adobe photoshop cs5 object library....

AdobePhotoshopCS5ObjectLibrary

Contents

JavaScriptReferenceGuideScriptingisoneofthemostpowerfulfeaturesinPhotoshop.Itcansavelotsoftime:almostanythingyoucandowiththeuserinterface,youcandowithscripts,andthereareevenafewthingsyoucandoinscriptingthatyoucannotdofromwithintheuserinterface.Thecontentsontherightiscategorizedbyfunction;intheindexatthebottom,youcanfindallobjectsinalphabeticalorder.Eachobjectdescriptionlistsitselements,properties,andmethods.Thisentiresitewasentirelycreatedautomatically!Ohwow-readmore!

SuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobePhotoshopClassesforspecifyingoptionswhenopeningdocumentsClassesforspecifyingoptionswhensavingdocumentsClassesforspecifyingoptionswhenexportingdocumentsScriptingcommandsforapplyingfilterstodocumentsScriptingcommandsforapplyingadjustmentstodocumentsColorclassesforAdobePhotoshopClassesforworkingwithartpathitemsClassesforworkingwithnotifiers

ActionsMiscellaneousstandardcommandsandclassesCollectionsOtherClasses

Jongware,28-Aug-2012v3.0.3i

Contents::Index

AdobePhotoshopCS5

Aboutthesepages TheExtendScriptToolkit

Editorcomeswithabuilt-inHelpfunction,whichdisplaysallobjectsaccessibleinJavaScriptforInDesign,Bridge,Illustrator,andPhotoshop.ItdoessobysendingarequesttothetargetprogramtooutputanXMLdatafile,containingtheprototypesanddefinitionsforallofitsscriptablecomponents.ThisXMLfileissavedinacache(presumablybecauseit'salengthyoperation)andsubsequentiallydisplayedwhenrequested.Ifitdetectsanewplugin,therequestissentagainandtheXMLfileisrebuiltfromscratch.Thatmeansthatonlinehelpforanynewscriptableplugincommandsareavailableimmediatelyforyournewscripts.Amazing!

XMLisaveryreadabledataformat...ifyou'reabitheadlikeme!Butwouldn'titbenicetobeabletoformatthishelptextjustasyoulike,andbereadable(and

searchable!)inyourfavouriteprogram,suchasyourwebbrowser?Well,theXMLformathasauniqueadvantageoverjustaboutanyotherdatafile.It'shighlystructured,andthiscontentcanbemanipulatedusingXSLT—theExtensibleStylesheetLanguageTransformationslanguage,asdefinedbytheWorldWideWebConsortium(W3C).AnXSLTstylesheetcansortandmanipulateXMLinput,insertallkindsofextradata(suchas,oh,acopyrightmanifestatthetopofeveryoutput),andwritetheresulttooneormoreoutputfiles.Whathasthattodowiththese750pagesofHTML?Ididn'tcreateasingleoneofthem.(Thispageiscreated'AllByHand'TM—butit'snotpartofAdobe'sXMLfiles.)

SoIwroteanXSLTstylesheettoread,parse,split,andsortthehugeinputfile,andtooutputitasformattedandhyperlinkedHTMLpages.Thiswasnomeantaskatall—theinputfileisover

113,000lineslong,andthelatestversionofthestylesheetcontainsjustunderathousandlines.Allinall,ittookmemorethan50hoursofhardworktocreatetheoutputyouseebeforeyou.Butwait!couldn'tIjusthavesearch-and-replacedtheXMLcommandsintoHTML?Sure—manuallysortingandsuch,butstilldoable.ButifIeverwanttochangesomething—say,Iwant4columnsofindexinsteadof3,orIdon'twanttousetablesanymore,butrealCSS3columns—allIhavetodoisre-writea(small)partoftheXSLTstylesheetandlettheSaxonXSLTinterpretergoovertheXMLagain.IfmyinstallationofInDesignisupgradedwithsomescriptableplugin,allIhavetodoisrunSaxonagain.SincetheXMLhelpforCS4hasthesameformatting,IcanrunSaxonagainonitshelpfile.Andthereyouhaveit!Anotherentirelynewsetofmorethan750files,allproperlyindexedandhyperlinked,withoutmedoinganymorethan

changinghowitshouldlook!a

UnderstandingXMLiseasy,especiallyifyouarewell-versedinHTML.Ifthelatter,youshouldreallyknowaboutXHTML—thewell-formattedyoungerbrotherofthatplainoldtack-together-with-sticky-tapethatgrewsobloatedovertheyears.XMLisevenmoresostructured,andthestepovershouldn'tbedifficult.XSLTissomethingquiteelse.Firstoff,it'sdefinedintermsofXML(meaning:youcanrunanXSLTstylesheetoveranXSLTstylesheet,forexampletoformatitforprintingorviewing).It'saprogramminglanguage,butitdoesn'tworkinthedo-this-then-thatsequentialsteps;instead,it'saprocedurallanguage,anditdescribeswhattodooneachandeveryXMLelementitencountersintheinputXMLdocument.WritingyourfirstXSLTstylesheetcanbefrustrating(usually,becauseyourfirstattemptsdon'tappeartodoanythingatall)untilyou

getintothepropermindset.SoonyouwillbescanningeveryfolderonyourcomputerforXMLfilestoexamine!(MacOSXusers:a.plistconfigurationfileisalsoXML;lotsofotherfilesinthatsystemareaswell.)

So,whydidIworksohardonwritingthesheetforthis?Well,itwasfuntocreatesomethingnew—agoodreasoninitself.Besides,Ineededthetraining.Asatypesetter,oneofmyupcomingjobsincludesadictionarythatisbeingassembledasExceldata.Iexperimentedwithasmalldataset,exportingitfromExcelasXML,andthenconvertingittoplaintext,sortingentriesandconcatenatingduplicatesallinonego.AfterthatIreckoned,"INX"—InDesign'scompatibilityfileformat—"isalsoanXMLfile",andwentontoincludeallnecessaryformatting,frompagesandparagraphs,rightuptothestyleandformattingofindividualwords.Saxonstilldidn'tbreakintoasweat—andnowallIhavetodoifthe

completedatacomesin,isexportittoXML,runmysheetoverittocreateanINXoutputfile,andopenthatonewithInDesign.Thepublisherwillbeamazedifhereceivesacompletesetofproofswithinacoupleofhours(let'sbegenerous),nomatterifit'sahundredpagesofoutputorathousand.Howdoesthatsoundforpagethroughput!?

AcknowledgementsThefirstCHMconversionofthefilesforCS3wasdonebyfellowscriptingenthousiastABCGREEN.Additionally,hehelpedmesetupmysystemtocompileotherversionsaswell.Thanks,mate!

NoteaDuetoaharddiskcrashofmyWindowsmachineIlostallofmyinstalledprograms.Fortunately,mygoodfriendRenéKramer(1967-2010)wasabletorescuemost(ifnotall)ofmydata.Thanks,René-thatbottleofwhiskeywaswellearned.Enjoyit,whereeveryouare.SothisversionisnotcreatedwithSaxononaWindowscomputer.WorkingonmyMac,IdownloadedKernowforSaxon.Theolderversion1.4comescompletewithaJavainterfaceandSaxon8B,andtomysurprise(andrelief)ittookjust

http://sourceforge.net/projects/kernowforsaxon/

afewclickstore-generatetheentireHelpsetanew.IsaiditbeforeandI'llsayitagain:SupportOpenSourceSoftware!


Contents::Index

ContentsSuitethatappliestoallapplications

SuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobePhotoshopClassesforspecifyingoptionswhenopeningdocumentsClassesforspecifyingoptionswhensavingdocumentsClassesforspecifyingoptionswhenexportingdocumentsScriptingcommandsforapplyingfilterstodocumentsScriptingcommandsforapplyingadjustmentstodocumentsColorclassesforAdobePhotoshopClassesforworking

ApplicationDocument

withartpathitemsClassesforworkingwithnotifiersActionsMiscellaneousstandardcommandsandclassesCollectionsOtherClasses


Contents::Index

Contents

ScriptingcommandsandclassesforAdobePhotoshop

SuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobePhotoshopClassesforspecifyingoptionswhenopeningdocumentsClassesforspecifyingoptionswhensavingdocumentsClassesforspecifyingoptionswhenexportingdocumentsScriptingcommandsforapplyingfilterstodocumentsScriptingcommandsforapplyingadjustmentsto

AdjustmentReferenceAnchorPositionAntiAliasArtLayerAutoKernTypeBatchDestinationTypeBatchOptionsBitmapConversionOptionsBitmapConversionTypeBitmapHalfToneTypeBitsPerChannelTypeBlendModeByteOrderCameraRAWSettingsTypeCameraRAWSizeCaseChangeModeChannelChannelTypeColorBlendModeColorPickerColorProfileColorReductionTypeColorSamplerColorSpaceTypeContactSheetOptionsCopyrightedTypeCountItemCropToTypeDCSTypeDepthMapSourceDialogModesDirection

documentsColorclassesforAdobePhotoshopClassesforworkingwithartpathitemsClassesforworkingwithnotifiersActionsMiscellaneousstandardcommandsandclassesCollectionsOtherClasses

DitherDocPositionStyleDocumentConversionOptionsDocumentFillDocumentInfoDocumentModeDocumentPrintSettingsEditLogItemsTypeExportTypeExtensionFileNamingTypeFontPreviewTypeForcedColorsFormatOptionsGalleryBannerOptionsGalleryConstrainTypeGalleryCustomColorOptionsGalleryFontTypeGalleryImagesOptionsGalleryOptionsGallerySecurityOptionsGallerySecurityTextColorTypeGallerySecurityTextPositionTypeGallerySecurityTextRotateTypeGallerySecurityTypeGalleryThumbSizeTypeGalleryThumbnailOptionsGeometryGridLineStyleGridSizeGuideLineStyleHistoryStateIllustratorPathTypeIndexedConversionOptionsIntentJavaScriptExecutionModeJustificationLanguageLayer

LayerCompLayerCompressionLayerKindLayerSetMagnificationTypeMatteTypeMeasurementLogMeasurementRangeMeasurementScaleMeasurementSourceNewDocumentModeOpenDocumentModeOpenDocumentTypeOperatingSystemOrientationOtherPaintingCursorsPDFCompatibilityPDFResamplePDFStandardPICTCompressionPaintingCursorsPalettePhotoCDColorSpacePicturePackageOptionsPicturePackageTextTypePointTypePreferencesPresentationOptionsPreviewPrintColorHandlingPrintEncodingPurgeTargetQueryStateTypeRasterizeTypeResampleMethodResetTargetSaveBehaviorSaveDocumentTypeSaveEncoding

SaveLogItemsTypeSaveOptionsSaveOptionsSelectionSelectionTypeSourceSpaceTypeStrikeThruTypeStrokeLocationTIFFEncodingTextComposerTextFontTextItemTextTypeTransitionTypeTrimTypeTypeUnitsUnderlineTypeUnitsUrgencyWarpStyleWhiteBalanceTypeXMPMetadata


Contents::Index

Contents

Classesforspecifyingoptionswhenopeningdocuments

SuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobePhotoshopClassesforspecifyingoptionswhenopeningdocumentsClassesforspecifyingoptionswhensavingdocumentsClassesforspecifyingoptionswhenexportingdocumentsScriptingcommandsforapplyingfilterstodocumentsScriptingcommandsforapplyingadjustmentstodocumentsColorclassesfor

CameraRAWOpenOptionsDICOMOpenOptionsOpenOptionsPhotoCDOpenOptionsPhotoCDSizeRawFormatOpenOptions

AdobePhotoshopClassesforworkingwithartpathitemsClassesforworkingwithnotifiersActionsMiscellaneousstandardcommandsandclassesCollectionsOtherClasses


Contents::Index

Contents

Classesforspecifyingoptionswhensavingdocuments


BMPDepthTypeBMPSaveOptionsDCS1_SaveOptionsDCS2_SaveOptionsEPSSaveOptionsGIFSaveOptionsJPEGSaveOptionsPDFSaveOptionsPICTBitsPerPixelsPICTFileSaveOptionsPICTResourceSaveOptionsPNGSaveOptionsPhotoshopSaveOptionsPixarSaveOptionsRawSaveOptionsSGIRGBSaveOptionsSaveOptionsSaveOptionsTargaBitsPerPixelsTargaSaveOptionsTiffSaveOptions



Contents::Index

Contents

Classesforspecifyingoptionswhenexportingdocuments


ExportOptionsExportOptionsIllustratorExportOptionsSaveForWeb



Contents::Index

Contents

Scriptingcommandsforapplyingfilterstodocuments


CreateFieldsDisplacementMapTypeEliminateFieldsLensTypeNoiseDistributionOffsetUndefinedAreasPolarConversionTypeRadialBlurMethodRadialBlurQualityRippleSizeSmartBlurModeSmartBlurQualitySpherizeModeTextureTypeUndefinedAreasWaveTypeZigZagType



Contents::Index

Contents

Scriptingcommandsforapplyingadjustmentstodocuments

SuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobePhotoshopClassesforspecifyingoptionswhenopeningdocumentsClassesforspecifyingoptionswhensavingdocumentsClassesforspecifyingoptionswhenexportingdocumentsScriptingcommandsforapplyingfilterstodocumentsScriptingcommandsforapplyingadjustmentstodocuments

ColorclassesforAdobePhotoshopClassesforworkingwithartpathitemsClassesforworkingwithnotifiersActionsMiscellaneousstandardcommandsandclassesCollectionsOtherClasses


Contents::Index

ContentsColorclassesforAdobePhotoshop


CMYKColorColorGrayColorHSBColorLabColorNoColorRGBColor



Contents::Index

ContentsClassesforworkingwithartpathitems


PathItemPathKindPathPointPathPointInfoPointKindShapeOperationSubPathInfoSubPathItemToolType



Contents::Index

ContentsClassesforworkingwithnotifiers


Notifier



Contents::Index

Contents Actions

SuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobePhotoshopClassesforspecifyingoptionswhenopeningdocumentsClassesforspecifyingoptionswhensavingdocumentsClassesforspecifyingoptionswhenexportingdocumentsScriptingcommandsforapplyingfilterstodocumentsScriptingcommandsforapplyingadjustmentstodocumentsColorclassesforAdobePhotoshopClassesforworkingwithartpathitems

ActionDescriptorActionListActionReference

ClassesforworkingwithnotifiersActionsMiscellaneousstandardcommandsandclassesCollectionsOtherClasses


Contents::Index

Contents

Miscellaneousstandardcommandsandclasses

SuitethatappliestoallapplicationsScriptingcommandsandclassesforAdobePhotoshopClassesforspecifyingoptionswhenopeningdocumentsClassesforspecifyingoptionswhensavingdocumentsClassesforspecifyingoptionswhenexportingdocumentsScriptingcommandsforapplyingfilterstodocumentsScriptingcommandsforapplyingadjustmentstodocumentsColorclassesforAdobePhotoshop

ClassesforworkingwithartpathitemsClassesforworkingwithnotifiersActionsMiscellaneousstandardcommandsandclassesCollectionsOtherClasses


Contents::Index

Contents Collections


ArtLayersChannelsColorSamplersCountItemsDocumentsHistoryStatesLayerCompsLayerSetsLayersNotifiersPathItemsPathPointsSubPathItemsTextFonts



Contents::Index

Contents OtherClasses


PointRectangle



Contents::Index

ClassIndex

$ABCDEFGHIJKLMNOPQActionDescriptor

ActionList

ActionReference

AdjustmentReference(enum)

AnchorPosition(enum)

AntiAlias(enum)

Application

ArtLayer

$ABCDEFGHIJKLMNOPQBMPDepthType(enum)

BMPSaveOptions

BatchDestinationType(enum)

BatchOptions

BitmapConversionOptions

BitmapConversionType(enum)

BitmapHalfToneType(enum)

BitsPerChannelType(enum)

$ABCDEFGHIJKLMNOPQCMYKColor

CameraRAWOpenOptions

CameraRAWSettingsType(enum)

CameraRAWSize(enum)

Case(enum)

ChangeMode(enum)

Channel

ChannelType(enum)

Channels

Color

ColorBlendMode(enum)

ColorModel(enum)

ColorPicker(enum)

ColorProfile(enum)

ColorReductionType(enum)

ColorSampler

$ABCDEFGHIJKLMNOPQDCS1_SaveOptions

DCS2_SaveOptions

DCSType(enum)

DICOMOpenOptions

DepthMapSource(enum)

DescValueType(enum)

DialogModes(enum)

Direction(enum)

DisplacementMapType(enum)

Dither(enum)

DocPositionStyle(enum)

Document

DescValueType(enum) Document

$ABCDEFGHIJKLMNOPQEPSOpenOptions

EPSSaveOptions

EditLogItemsType(enum)

ElementPlacement(enum)

EliminateFields(enum)

ExportOptions

ExportOptionsIllustrator

ExportOptionsSaveForWeb

$ABCDEFGHIJKLMNOPQFileNamingType(enum)

FontPreviewType(enum)

ForcedColors(enum)

FormatOptions(enum)

$ABCDEFGHIJKLMNOPQGIFSaveOptions

GalleryBannerOptions

GalleryConstrainType(enum)

GalleryCustomColorOptions

GalleryFontType(enum)

GalleryImagesOptions

GalleryOptions

GallerySecurityOptions

GallerySecurityTextColorType(enum)

GallerySecurityTextPositionType(enum)

GallerySecurityTextRotateType(enum)

GallerySecurityType(enum)

GalleryThumbSizeType(enum)

GalleryThumbnailOptions

$ABCDEFGHIJKLMNOPQHSBColor HistoryState

$ABCDEFGHIJKLMNOPQIllustratorPathType(enum) IndexedConversionOptions

$ABCDEFGHIJKLMNOPQJPEGSaveOptions JavaScriptExecutionMode

(enum)

(enum)

$ABCDEFGHIJKLMNOPQLabColor

Language(enum)

Layer

LayerComp

LayerCompression(enum)

LayerComps

LayerKind(enum)

LayerSet

$ABCDEFGHIJKLMNOPQMagnificationType(enum)

MatteType(enum)

MeasurementLog

MeasurementRange(enum)

$ABCDEFGHIJKLMNOPQNewDocumentMode(enum)

NoColor

NoiseDistribution(enum)

Notifier

$ABCDEFGHIJKLMNOPQOffsetUndefinedAreas(enum)

OpenDocumentMode(enum)

OpenDocumentType(enum)

OpenOptions

OperatingSystem(enum)

Orientation(enum)

$ABCDEFGHIJKLMNOPQPDFCompatibility(enum)

PDFEncodingType(enum)

PDFOpenOptions

PDFResample(enum)

PDFSaveOptions

PDFStandard(enum)

PICTBitsPerPixels(enum)

PICTCompression(enum)

PICTFileSaveOptions

Palette(enum)

PathItem

PathItems

PathKind(enum)

PathPoint

PathPointInfo

PathPoints

PhotoCDColorSpace(enum)

PhotoCDOpenOptions

PICTResourceSaveOptions

PNGSaveOptions

PaintingCursors(enum)

PhotoCDSize(enum)

PhotoshopSaveOptions

PicturePackageOptions

$ABCDEFGHIJKLMNOPQueryStateType(enum)

$ABCDEFGHIJKLMNOPRGBColor

RadialBlurMethod(enum)

RadialBlurQuality(enum)

RasterizeType(enum)

RawFormatOpenOptions

RawSaveOptions

Rectangle

ReferenceFormType(enum)

$ABCDEFGHIJKLMNOPSGIRGBSaveOptions

SaveBehavior(enum)

SaveDocumentType(enum)

SaveEncoding(enum)

SaveLogItemsType(enum)

SaveOptions(enum)

Selection

SelectionType(enum)

ShapeOperation(enum)

SmartBlurMode(enum)

SmartBlurQuality(enum)

SolidColor

SourceSpaceType(enum)

SpherizeMode(enum)

$ABCDEFGHIJKLMNOPTIFFEncoding(enum)

TargaBitsPerPixels(enum)

TargaSaveOptions

TextComposer(enum)

TextFont

TextFonts

TextItem

TextType(enum)

TextureType(enum)

TiffSaveOptions

$ABCDEFGHIJKLMNOPUndefinedAreas(enum) Units(enum)

UndefinedAreas(enum)

UnderlineType(enum)

Units(enum)

Urgency(enum)

$ABCDEFGHIJKLMNOPWarpStyle(enum) WaveType(enum)

$ABCDEFGHIJKLMNOPXMPMetadata

$ABCDEFGHIJKLMNOPZigZagType(enum)


Contents::Index

Application TheAdobePhotoshopapplicationobject.

Thisistherootoftheobjectmodel,andprovidesaccesstoallotherobjects.Toaccessthepropertiesandmethods,youcanusethepre-definedglobalvariableapp.Forexample:varcurrentDoc=app.activeDocument;

QuickLinks batch,beep,bringToFront,charIDToTypeID,doActioneraseCustomOptions,executeAction,executeActionGetgetCustomOptions,load,makeContactSheet,makePDFPresentationmakePhotoGallery,makePhotomerge,makePicturePackageopenDialog,purge,putCustomOptions,refresh,runMenuItemstringIDToTypeID,togglePalettes,typeIDToCharID,typeIDToStringID

Hierarchy Object

Application

Properties Property Type Access

activeDocument Document r/w

backgroundColor SolidColor r/w

build string readonly

colorSettings any r/w

displayDialogs DialogModes:DialogModes.ALL

r/w

DialogModes.ERRORDialogModes.NO

documents Documents Document readonly

fonts TextFonts TextFont readonly

foregroundColor SolidColor r/w

freeMemory number readonly

locale string readonly

macintoshFileTypes Arrayofstring readonly

measurementLog MeasurementLog readonly

name string readonly

notifiers Notifiers Notifier readonly

notifiersEnabled bool r/w

parent Object readonly

path Folder readonly

playbackDisplayDialogs DialogModes:DialogModes.ALLDialogModes.ERRORDialogModes.NO

r/w

playbackParameters ActionDescriptor r/w

preferences Preferences readonly

preferencesFolder File readonly

recentFiles FileArray readonly

scriptingBuildDate string readonly

scriptingVersion string readonly

systemInformation string readonly

typename string readonly

version string readonly

windowsFileTypes Arrayofstring readonly

Methods Instancesstringbatch(inputFiles:AliasArray,action:string,fromBatchOptions])Runsthebatchautomationroutine;analogoustousingtheBatchcommandinPhotoshop.Parameter Type Description

inputFiles AliasArray Thefilestooperateon.

action string Thenameoftheactiontoplay(notethattheActionnameiscase-sensitiveandmustmatchthenameintheActionspalette).

from string Thenameoftheactionsetcontainingtheactionbeingplayed(notethattheActionSetnameiscase-sensitiveandmustmatchthenameintheActionspalette).

options BatchOptions Optionsforbatchautomation.(Optional)

voidbeep()Alertstheuser.

voidbringToFront()MakesPhotoshoptheactiveapplication.

intcharIDToTypeID(charID:string)ConvertsfromafourcharactercodetoaruntimeID.Parameter Type Description

charID string TheIDtoconvert.

voiddoAction(action:string,from:string)PlaysthespecifiedactionfromtheActionspalette.Parameter Type Description

action string Thenameoftheactiontoplay.(Notethattheactionnameiscase-sensitiveandmustmatchthenameasitappearsintheActionspalette.)

from string Thenameoftheactionsetcontainingtheactionbeingplayed.(NotethattheActionSetnameiscase-sensitiveandmustmatchthenameasitappearsintheActionspalette.)

voideraseCustomOptions(key:string)RemovesthespecifieduserobjectsfromthePhotoshopregistry.Parameter Type Description

key string TheuniquestringIDforuserobject(s)toremove.

ActionDescriptorexecuteAction(eventID:int[,descriptorActionDescriptor][,displayDialogs:DialogModes])PlaysanActionManagerevent.Parameter Type Description

eventID int Theeventtoplay.

descriptor ActionDescriptor Theactiondescriptortoplay.(Optional)

displayDialogs DialogModes:DialogModes.ALLDialogModes.ERRORDialogModes.NO

Thedisplaypermissionsfordialogsandalertmessages.(Optional)

ActionDescriptorexecuteActionGet(reference:ActionReferenceObtainsanactiondescriptor.Parameter Type Description

reference ActionReference Thereferencespecificationoftheproperty.

boolfeatureEnabled(name:string)Iftrue,thespecifiedfeatureisenabled.Parameter Type Description

name string Thenameofthefeature.

ActionDescriptorgetCustomOptions(key:string)RetrievesuserobjectsfromthePhotoshopregistryfortheIDwithvaluekey.Parameter Type Description

key string TheuniquestringIDfortheuserobject.

voidload(document:File)Loadsasupportdocument.Parameter Type Description

document File Thedocumenttoload.

stringmakeContactSheet(inputFiles:AliasArray[,optionsContactSheetOptions])Createsacontactsheetfrommultiplefiles.Parameter Type Description

inputFiles AliasArray Thefilestoinclude.

options ContactSheetOptions Optionsforcreatingthecontactsheet.(Optional)

stringmakePDFPresentation(inputFiles:AliasArray

options:PresentationOptions])CreatesaPDFpresentationfile.Parameter Type Description

inputFiles AliasArray Theinputfilestoincludeinthepresentation.

outputFile File Thelocationoftheoutputfile.

options PresentationOptions OptionsforthePDFpresentation.(Optional)

stringmakePhotoGallery(inputFolder:any,outputFolderGalleryOptions])DeprecatedforAdobePhotoshopCS3.Createsawebphotogallery.Parameter Type Description

inputFolder any Foldertoprocessoranarrayoffilestoprocess.

outputFolder File Locationforoutputfiles.

options GalleryOptions Optionsforthewebphotogallery.(Optional)

stringmakePhotomerge(inputFiles:AliasArray)DeprecatedforAdobePhotoshopCS3.Mergesmultiplefilesintoone,userinteractionrequired.Parameter Type Description

inputFiles AliasArray Listofinputfilestoinclude.

stringmakePicturePackage(inputFiles:AliasArray[,PicturePackageOptions])Createsapicturepackagefrommultiplefiles.Parameter Type Description

inputFiles AliasArray Thefilestoinclude.

options PicturePackageOptions OptionsforcreatingaPicturePackage.(Optional)

Documentopen(document:File[,as:any][,asSmartObjectOpensthespecifieddocumentfile(s).Parameter Type Description

document File Thedocument(s)toopend.

as any Thedocumenttype(ThedefaultistoletPhotoshopdeducetheformat).(Optional)

asSmartObject bool Createsasmartobjectaroundthedocument.(default:false)(Optional)

FileArrayopenDialog()UsesthePhotoshopopendialogtoselectfiles.

voidpurge(target:PurgeTarget)Purgesoneormorecaches.Parameter Type Description

target PurgeTarget:PurgeTarget.UNDOCACHESPurgeTarget.HISTORYCACHESPurgeTarget.CLIPBOARDCACHEPurgeTarget.ALLCACHES

Thecachestopurge.

voidputCustomOptions(key:string,customObject:persistent:bool=true])SavesuserobjectsinthePhotoshopregistry.Parameter Type Description

key string TheuniquestringIDfortheuserobject.

customObject ActionDescriptor Theuser-definedcustomobjecttosaveintheregistry.

persistent bool Iftrue,theobjectpersistsafterthescripthasfinished.(default:

voidrefresh()Pausesthescriptuntiltheapplicationrefreshes.

intrunMenuItem()RunamenuitemwiththegivenID.UsethisforInsertMenuItem.

intstringIDToTypeID(stringID:string)ConvertsfromastringIDtoaruntimeID.Parameter Type Description

stringID string TheIDtoconvert.

voidtogglePalettes()Togglepalettevisibility.

stringtypeIDToCharID(typeID:int)ConvertsfromaruntimeIDtoacharacterID.Parameter Type Description

typeID int TheIDtoconvert.

stringtypeIDToStringID(typeID:int)ConvertsfromaruntimeIDtoastringID.Parameter Type Description

typeID int TheIDtoconvert.

Elementof global.app


Contents::Index

Document Theactivecontainmentobjectforthelayersandallotherobjectsinthescript;thebasiccanvasforthefile.

QuickLinks autoCount,changeMode,close,convertProfile,crop,duplicateflipCanvas,importAnnotations,mergeVisibleLayers,pasterecordMeasurements,resizeCanvas,resizeImage,revealAllsuspendHistory,trap,trim

Hierarchy Object

Document

Properties Property Type

ColorProfile ColorProfile:ColorProfile.NONEColorProfile.WORKINGColorProfile.CUSTOM

activeChannels ArrayofChannel

activeHistoryBrushSource HistoryState

activeHistoryState HistoryState

activeLayer Layer

artLayers ArtLayers ArtLayer

backgroundLayer ArtLayer

bitsPerChannel BitsPerChannelType:BitsPerChannelType.ONEBitsPerChannelType.EIGHTBitsPerChannelType.SIXTEENBitsPerChannelType.THIRTYTWO

channels Channels Channel

colorProfileName string

colorSamplers ColorSamplers ColorSampler

componentChannels ArrayofChannel

countItems CountItems CountItem

fullName File

height UnitValue

histogram Arrayofint

historyStates HistoryStates HistoryState

info DocumentInfo

layerComps LayerComps LayerComp

layerSets LayerSets LayerSet

layers Layers Layer

managed bool

measurementScale MeasurementScale

mode DocumentMode:DocumentMode.GRAYSCALEDocumentMode.RGBDocumentMode.CMYKDocumentMode.LABDocumentMode.BITMAPDocumentMode.INDEXEDCOLORDocumentMode.MULTICHANNELDocumentMode.DUOTONE

name string

parent Object

path File

pathItems PathItems PathItem

pixelAspectRatio number

printSettings DocumentPrintSettings

quickMaskMode bool

resolution number

saved bool

selection Selection

typename string

width UnitValue

xmpMetadata XMPMetadata

Methods InstancesvoidautoCount(channel:Channel,threshold:int)Countstheobjectsinthedocument.Parameter Type Description

channel Channel Thechanneltouseforcounting.

threshold int(range:0-255) Thresholdtouseforcounting.Range:0to255.

voidchangeMode(destinationMode:ChangeMode[,optionsChangesthemodeofthedocument.Parameter Type

destinationMode ChangeMode:ChangeMode.GRAYSCALEChangeMode.RGBChangeMode.CMYKChangeMode.LABChangeMode.BITMAPChangeMode.INDEXEDCOLORChangeMode.MULTICHANNEL

options DocumentConversionOptions

voidclose([saving:SaveOptions=SaveOptions.PROMPTTOSAVECHANGESClosesthedocument.Parameter Type

saving SaveOptions:SaveOptions.SAVECHANGESSaveOptions.DONOTSAVECHANGESSaveOptions.PROMPTTOSAVECHANGES

voidconvertProfile(destinationProfile:string,intent:Intent

bool=true])Convertsthedocumentfromusingonecolorprofiletousinganother.Parameter Type

destinationProfile string

intent Intent:Intent.PERCEPTUALIntent.SATURATIONIntent.RELATIVECOLORIMETRICIntent.ABSOLUTECOLORIMETRIC

blackPointCompensation bool

dither bool

voidcrop(bounds:UnitRect[,angle:number=0][,width:Cropsthedocument.Parameter Type Description

bounds UnitRect Theareatocrop.

angle number Theangleofcroppingbounds.(default:

width UnitValue Thewidthoftheresultingdocument.(Optional)

height UnitValue Theheightoftheresultingdocument.(Optional)

Documentduplicate(relativeObject:Object,insertionLocationDuplicatethisobject.Parameter Type

relativeObject Object

insertionLocation ElementPlacement:ElementPlacement.PLACEAFTERElementPlacement.PLACEBEFOREElementPlacement.PLACEATEND

Documentduplicate([name:string][,mergeLayersOnly:Createsaduplicateofthedocumentobject.Parameter Type Description

name string Thenameofthenewdocument.(Optional)

mergeLayersOnly bool Ifture,duplicatesmergedlayersonly.(Optional)

voidexportDocument(exportIn:File[,exportAs:ExportTypeoptions:ExportOptions])Exportsthedocument.Parameter Type Description

exportIn File Thefiletoexportto.

exportAs ExportType:ExportType.ILLUSTRATORPATHSExportType.SAVEFORWEB

Thetypeofexport.(default:ExportType.ILLUSTRATORPATHS

options ExportOptions Optionsforthespecifiedexporttype.(Optional)

voidflatten()Flattensalllayers.

voidflipCanvas(direction:Direction)Flipsthecanvashorizontallyorvertically.Parameter Type Description

direction Direction:Direction.HORIZONTALDirection.VERTICAL

Thedirectioninwhichtoflipthecanvas.

voidimportAnnotations(file:File)Importsannotationsintothedocument.Parameter Type Description

file File Thedocumenttoimportannotationsfrom.

voidmergeVisibleLayers()Flattensallvisiblelayersinthedocument.

ArtLayerpaste([intoSelection:bool=false])Pastescontentsoftheclipboardintothedocument.

Parameter Type Description

intoSelection bool Iftrue,contentsarepastedintothecurrentselection.(default:

voidprint([postScriptEncoding:PrintEncoding=PrintEncoding.BINARYSourceSpaceType=SourceSpaceType.DOCUMENT][,printSpaceIntent=Intent.RELATIVECOLORIMETRIC][,blackPointCompensationPrintsthedocument.Parameter Type

postScriptEncoding PrintEncoding:PrintEncoding.BINARYPrintEncoding.JPEGPrintEncoding.ASCII

sourceSpace SourceSpaceType:SourceSpaceType.DOCUMENTSourceSpaceType.PROOF

printSpace string

intent Intent:Intent.PERCEPTUALIntent.SATURATIONIntent.RELATIVECOLORIMETRICIntent.ABSOLUTECOLORIMETRIC

blackPointCompensation bool

voidprintOneCopy()Printonecopyofthedocument.

voidrasterizeAllLayers()Rasterizesalllayers.

voidrecordMeasurements([source:MeasurementSourceRecordsthemeasurementsofdocument.

Parameter Type

source MeasurementSource:MeasurementSource.MEASURESELECTIONMeasurementSource.MEASURECOUNTTOOLMeasurementSource.MEASURERULERTOOL

dataPoints Arrayofstring

voidresizeCanvas([width:UnitValue][,height:UnitValueAnchorPosition=AnchorPosition.MIDDLECENTER])Changesthesizeofthecanvas.Parameter Type Description

width UnitValue Thedesiredwidthofthecanvas.(Optional)

height UnitValue Thedesiredheightofthecanvas.(Optional)

anchor AnchorPosition:AnchorPosition.TOPLEFTAnchorPosition.TOPCENTERAnchorPosition.TOPRIGHTAnchorPosition.MIDDLELEFTAnchorPosition.MIDDLECENTERAnchorPosition.MIDDLERIGHTAnchorPosition.BOTTOMLEFTAnchorPosition.BOTTOMCENTERAnchorPosition.BOTTOMRIGHT

Theanchorpointtoresizearound.(default:AnchorPosition.MIDDLECENTER

voidresizeImage([width:UnitValue][,height:UnitValueResampleMethod=ResampleMethod.BICUBIC])Changesthesizeoftheimage.Parameter Type

width UnitValue

height UnitValue

resolution number

resampleMethod ResampleMethod:ResampleMethod.NONEResampleMethod.NEARESTNEIGHBORResampleMethod.BILINEARResampleMethod.BICUBICResampleMethod.BICUBICSHARPERResampleMethod.BICUBICSMOOTHER

voidrevealAll()Expandsthedocumenttoshowclippedsections.

voidrotateCanvas(angle:number)Rotatesthecanvas.Parameter Type Description

angle number Thenumberofdegreestorotate.Apositiveanglerotatesthecanvasclockwise;anegativevaluerotatesthecanvascounter-clockwise.

voidsave()Savesthedocument.

voidsaveAs(saveIn:File[,options:any][,asCopy:bool][,Savesthedocumentwiththespecifiedsaveoptions.Parameter Type Description

saveIn File Thefiletosaveto,specifiedasastringcontainingthefullfilepathoranalias.Ifnotspecified,thedocumentissavedtoitsexistingfile.

options any Optionsforthespecifiedfiletype.(Optional)

asCopy bool Savesthedocumentasacopy,leavingtheoriginalopen.(Optional)

extensionType Extension:Extension.NONEExtension.LOWERCASEExtension.UPPERCASE

Appendsthespecifiedextensiontothefilename.(Optional)

ArrayofDocumentsplitChannels()Splitsthechannelsofthedocument.

voidsuspendHistory(historyString:string,javaScriptString

Providesasinglehistorystatefortheentirescript.Allowsasingleundoforallactionstakeninthescript.Parameter Type Description

historyString string Thestringtouseforthehistorystate.

javaScriptString string AstringofJavaScriptcodetoexecuteduringthesuspensionofhistory.

voidtrap(width:int)AppliestrappingtoaCMYKdocument.Validonlywhen'mode'=CMYK.Parameter Type Description

width int Thetrapwidthinpixels.

voidtrim([type:TrimType=TrimType.TOPLEFT][,topbool=true][,right:bool=true])Trimsthetransparentareaaroundtheimageonthespecifiedsidesofthecanvas.Parameter Type Description

type TrimType:TrimType.TRANSPARENTTrimType.TOPLEFTTrimType.BOTTOMRIGHT

Thecolorortypeofpixelstobasethetrimon.(default:TrimType.TOPLEFT

top bool Iftrue,trimsawaythetopofthedocument.(default:(Optional)

left bool Iftrue,trimsawaytheleftofthedocument.(default:(Optional)

bottom bool Iftrue,trimsawaythebottomofthedocument.(default:(Optional)

right bool Iftrue,trimsawaytherightofthedocument.(default:(Optional)

Elementof Application.activeDocument

Usedin: ChannelChannel.duplicate([targetDocument:Document

Return DocumentApplication.open(document:File[,as:any][,DocumentDocument.duplicate(relativeObject:Object,

DocumentDocument.duplicate([name:string][,mergeLayersOnlyArrayofDocumentDocument.splitChannels()DocumentDocuments.[](index:uint)DocumentDocuments.add([width:UnitValue][,height:

[,mode:NewDocumentMode=NewDocumentMode.RGBDocumentFill=DocumentFill.WHITE][,pixelAspectRatioBitsPerChannelType=BitsPerChannelType.EIGHT

DocumentDocuments.getByName(name:string)


Contents::Index

Enumeration

AdjustmentReference Methodtouseforinterpretingselectivecoloradjustment

specifications.

Value Name

AdjustmentReference.ABSOLUTE

AdjustmentReference.RELATIVE

Usage InfunctionvoidArtLayer.selectiveColor(selectionMethod

AdjustmentReference[,redsyellows:Arrayofnumber][,number][,cyans:Arrayofnumbernumber][,magentas:ArrayArrayofnumber][,neutralsblacks:Arrayofnumber])


Contents::Index

Enumeration

AnchorPosition Thepointaroundwhichtotransformtheobject.

Value Name Description

AnchorPosition.BOTTOMCENTER Themiddlepointofthebottomoftheobject.

AnchorPosition.BOTTOMLEFT Thebottomleftcorneroftheobject.

AnchorPosition.BOTTOMRIGHT Thebottomrightcorneroftheobject.

AnchorPosition.MIDDLECENTER Thecenteroftheobject.

AnchorPosition.MIDDLELEFT Themiddlepointontheleftsideoftheobject.

AnchorPosition.MIDDLERIGHT Themiddlepointontherightsideoftheobject.

AnchorPosition.TOPCENTER Themiddlepointonthetopoftheobject.

AnchorPosition.TOPLEFT Thetopleft

corneroftheobject.

AnchorPosition.TOPRIGHT Thetoprightcorneroftheobject.

Usage InfunctionvoidDocument.resizeCanvas([width:UnitValue

UnitValue][,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER

voidLayer.resize([horizontal:number=100][,number=100][,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER

voidLayer.rotate(angle:number[,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER

voidSelection.resize([horizontal:number=100number=100][,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER

voidSelection.resizeBoundary([horizontal:numbervertical:number=100][,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER

voidSelection.rotate(angle:number[,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER

voidSelection.rotateBoundary(angle:numberAnchorPosition=AnchorPosition.MIDDLECENTER


Contents::Index

Enumeration

AntiAlias Themethodtousetosmoothedgesbysofteningthe

colortransitionbetweenedgepixelsandbackgroundpixels.

Value Name Description Value

AntiAlias.CRISP Makestypeappearsomewhatsharp.

int3

AntiAlias.NONE Doesnotuseanti-aliasing.

int1

AntiAlias.SHARP Makestypeappearitssharpest.

int2

AntiAlias.SMOOTH Makestypeappearsmoother.

int5

AntiAlias.STRONG Makestypeappearheavier.

int4

Usage AspropertyTextItem.antiAliasMethod


Contents::Index

ArtLayer Anobjectwithinadocumentthatcontainsthevisualelementsoftheimage(equivalenttoalayerinthe

AdobePhotoshopapplication).BaseClass:Layer

QuickLinks adjustBrightnessContrast,adjustColorBalance,adjustCurvesapplyAverage,applyBlur,applyBlurMore,applyClouds,applyCustomFilterapplyDespeckle,applyDifferenceClouds,applyDiffuseGlowapplyGaussianBlur,applyGlassEffect,applyHighPass,applyLensBlurapplyMaximum,applyMedianNoise,applyMinimum,applyMotionBlurapplyOceanRipple,applyOffset,applyPinch,applyPolarCoordinatesapplySharpen,applySharpenEdges,applySharpenMore,applyShearapplyStyle,applyTextureFill,applyTwirl,applyUnSharpMaskautoLevels,clear,copy,cut,desaturate,equalize,invert,mergerasterize,selectiveColor,shadowHighlight,threshold

Hierarchy Object

Layer

ArtLayer


fillOpacity number

filterMaskDensity number

filterMaskFeather number

grouped bool

isBackgroundLayer bool

kind LayerKind:LayerKind.NORMALLayerKind.TEXTLayerKind.SOLIDFILLLayerKind.GRADIENTFILLLayerKind.PATTERNFILLLayerKind.LEVELSLayerKind.CURVESLayerKind.COLORBALANCELayerKind.BRIGHTNESSCONTRASTLayerKind.HUESATURATIONLayerKind.SELECTIVECOLORLayerKind.CHANNELMIXERLayerKind.GRADIENTMAPLayerKind.INVERSIONLayerKind.THRESHOLDLayerKind.POSTERIZELayerKind.SMARTOBJECTLayerKind.PHOTOFILTERLayerKind.EXPOSURELayerKind.LAYER3DLayerKind.VIDEOLayerKind.BLACKANDWHITELayerKind.VIBRANCE

layerMaskDensity number

layerMaskFeather number

parent Object

pixelsLocked bool

positionLocked bool

textItem TextItem

transparentPixelsLocked bool

typename string

vectorMaskDensity number

vectorMaskFeather number

Methods InstancesvoidadjustBrightnessContrast(brightness:int,contrast:Adjuststhebrightnessandconstrast.Parameter Type Description

brightness int Thebrightnessamount.Range:-100to100.

contrast int Thecontrastamount.Range:-100to100.

voidadjustColorBalance([shadows:Arrayofint][,midtonespreserveLuminosity:bool])Adjuststhecolorbalanceofthelayer'scomponentchannels.Parameter Type Description

shadows Arrayofint

Theadjustmentsfortheshadows.Thearraymustincludethreevalues(intherange-100to100),whichrepresentcyanorred,magentaorgreen,andyelloworblue,whenthedocumentmodeisCMYKorRGB.

(Optional)

midtones Arrayofint

Theadjustmentsforthemidtones.Thearraymustincludethreevalues(intherange-100to100),whichrepresentcyanorred,magentaorgreen,andyelloworblue,whenthedocumentmodeisCMYKorRGB.(Optional)

highlights Arrayofint

Theadjustmentsforthehighlights.Thearraymustincludethreevalues(intherange-100to100),whichrepresentcyanorred,magentaorgreen,andyelloworblue,whenthedocumentmodeisCMYKorRGB.(Optional)

preserveLuminosity bool Iftrue,luminosityispreserved.(Optional)

voidadjustCurves(curveShape:ArrayofPoint)Adjuststhetonalrangeoftheselectedchannelusinguptofourteenpoints.Parameter Type Description

curveShape ArrayofPoint Thecurvepoints.Thenumberofpointsmustbebetween2and14.

voidadjustLevels(inputRangeStart:int,inputRangeEnd:intoutputRangeStart:int,outputRangeEnd:int)Adjustslevelsoftheselectedchannels.Parameter Type Description

inputRangeStart int Theinputlevelsminimum.Range:0to253.

inputRangeEnd int Theinputlevelsmaximum.Range:(inputrangestart+2)to253.

inputRangeGamma number Theinputlevelsgamma.Range:0.10to9.99.

outputRangeStart int Theoutputlevelsminimum.Range:0to253.

outputRangeEnd int Theoutputlevelsmaximum.Range:(outputrangestart+2)to253.

voidapplyAddNoise(amount:number,distribution:NoiseDistributionAppliestheaddnoisefilter.Parameter Type Description

amount number Theamountofnoise(asapercentage).Range:0.1to400.0.

distribution NoiseDistribution: Thenoisedistributiontype.

NoiseDistribution.UNIFORMNoiseDistribution.GAUSSIAN

monochromatic bool Iftrue,appliesthefilteronlytothetonalelementsintheimagewithoutchangingthecolors.

voidapplyAverage()Appliestheaveragefilter.

voidapplyBlur()Appliestheblurfilter.

voidapplyBlurMore()Appliestheblurmorefilter.

voidapplyClouds()Appliesthecloudsfilter.

voidapplyCustomFilter(characteristics:Arrayofint,scaleAppliesthecustomfilter.Parameter Type Description

characteristics Arrayofint

Thecustomfiltercharacteristics.Thisisanarrayof25valuesthatcorrespondstoaleft-to-right,top-to-bottomtraversalofthearraypresentedintheCustomdialogintheuserinterface(Filter>Other>Custom).

scale int Thevaluebywhichtodividethesumofthebrightnessvaluesofthepixelsincludedinthecalculation.

offset int Thevaluetobeaddedtotheresultofthescalecalculation.

voidapplyDeInterlace(eliminateFields:EliminateFields,Appliesthede-interlacefilter.Parameter Type Description

eliminateFields EliminateFields:EliminateFields.ODDFIELDSEliminateFields.EVENFIELDS

Thefieldstoeliminate.

createFields CreateFields:CreateFields.DUPLICATIONCreateFields.INTERPOLATION

Themethodtousetoreplaceeliminatedfields.

voidapplyDespeckle()

Appliesthedespecklefilter.

voidapplyDifferenceClouds()Appliesthedifferencecloudsfilter.

voidapplyDiffuseGlow(graininess:int,glowAmount:int,Appliesthediffuseglowfilter.Parameter Type Description

graininess int Theamountofgraininess.Range:0to10.

glowAmount int Theglowamount.Range:0to20.

clearAmount int Theclearamount.Range:0to20.

voidapplyDisplace(horizontalScale:int,verticalScale:intundefinedAreas:UndefinedAreas,displacementMapFile:FileAppliesthedisplacefilter.Parameter Type

horizontalScale int

verticalScale int

displacementType DisplacementMapType:DisplacementMapType.STRETCHTOFITDisplacementMapType.TILE

undefinedAreas UndefinedAreas:UndefinedAreas.WRAPAROUNDUndefinedAreas.REPEATEDGEPIXELS

displacementMapFile File

voidapplyDustAndScratches(radius:int,threshold:int)Appliesthedustandscratchesfilter.Parameter Type Description

radius int Thesize(inpixels)oftheareasearchedfordissimilarpixels.Range:1to16.

threshold int Determineshowdissimilarthepixelsshouldbebeforetheyareeliminated.Range:0to255.

voidapplyGaussianBlur(radius:number)Appliesthegaussianblurfilter.Parameter Type Description

radius number Theblurwidthinpixels.Range:1.0to250.0.

voidapplyGlassEffect(distortion:int,smoothness:int,scalingTextureType][,textureFile:File])Appliestheglassfilter.Parameter Type Description

distortion int Theamountofdistortion.Range:0to20.

smoothness int Thesmoothness.Range:1to15.

scaling int Theamountofscaling.Range:50to200.

invert bool Iftrue,thetextureisinverted.(default:

texture TextureType:TextureType.BLOCKSTextureType.CANVASTextureType.FROSTEDTextureType.TINYLENSTextureType.FILE

Thetypeoftexture.(Optional)

textureFile File Thefilefromwhichtoloadthetexturetype.(Optional)

voidapplyHighPass(radius:number)Appliesthehighpassfilter.Parameter Type Description

radius number Thewidth(inpixels)oftheradiuswhereedgedetailsareretained.

voidapplyLensBlur([source:DepthMapSource=DepthMapSource.NONEinvertDepthMap:bool=false][,shape:Geometry=Geometry.HEXAGONbladeCurvature:int=0][,rotation:int=0][,brightness:int=0distribution:NoiseDistribution=NoiseDistribution.UNIFORMApplythelensblurfilter.Parameter Type

source DepthMapSource:

DepthMapSource.NONEDepthMapSource.TRANSPARENCYCHANNELDepthMapSource.LAYERMASKDepthMapSource.IMAGEHIGHLIGHT

focalDistance int

invertDepthMap bool

shape Geometry:Geometry.TRIANGLEGeometry.PENTAGONGeometry.HEXAGONGeometry.SQUAREGeometry.HEPTAGONGeometry.OCTAGON

radius int

bladeCurvature int

rotation int

brightness int

threshold int

amount int

distribution NoiseDistribution:NoiseDistribution.UNIFORMNoiseDistribution.GAUSSIAN

monochromatic bool

voidapplyLensFlare(brightness:int,flareCenter:UnitPointAppliesthelensflarefilter.Parameter Type Description

brightness int Theflarebrightness.Range:10to300.

flareCenter UnitPoint Thepositionoftheflarecenter.

lensType LensType:LensType.ZOOMLENSLensType.PRIME35LensType.PRIME105LensType.MOVIEPRIME

Thelenstype.

voidapplyMaximum(radius:number)Appliesthemaximumfilter.Parameter Type Description

radius number Thechokearea(inpixels).Range:0to100.

voidapplyMedianNoise(radius:number)Appliesthemediannoisefilter.Parameter Type Description

radius number Thesizeoftheareasearchedforpixelsofsimilarbrightness.Range:0to100.

voidapplyMinimum(radius:number)Appliestheminimumfilter.Parameter Type Description

radius number Thespreadarea(inpixels).Range:0to100.

voidapplyMotionBlur(angle:int,radius:number)Appliesthemotionblurfilter.Parameter Type Description

angle int Theangle(indegrees).Range:-360to360.

radius number Theradius(inpixels).Range:1to999.

voidapplyNTSC()AppliestheNTSCcolorsfilter.

voidapplyOceanRipple(size:int,magnitude:int)Appliestheoceanripplefilter.Parameter Type Description

size int Theripplesize.Range:1to15.

magnitude int Theripplemagnitude.Range:0to20.

voidapplyOffset(horizontal:UnitValue,vertical:UnitValueAppliestheoffsetfilter.Parameter Type

horizontal UnitValue

vertical UnitValue

undefinedAreas OffsetUndefinedAreas:OffsetUndefinedAreas.SETTOBACKGROUNDOffsetUndefinedAreas.WRAPAROUNDOffsetUndefinedAreas.REPEATEDGEPIXELS

voidapplyPinch(amount:int)Appliesthepinchfilter.Parameter Type Description

amount int Thepinchamount.Range:-100to100.

voidapplyPolarCoordinates(conversion:PolarConversionTypeAppliesthepolarcoordinatesfilter.Parameter Type

conversion PolarConversionType:PolarConversionType.RECTANGULARTOPOLARPolarConversionType.POLARTORECTANGULAR

voidapplyRadialBlur(amount:int,blurMethod:RadialBlurMethodAppliestheradialblurfilter.Parameter Type Description

amount int Theamountofblur.Range:1to100.

blurMethod RadialBlurMethod:RadialBlurMethod.SPINRadialBlurMethod.ZOOM

Theblurmethodtouse.

blurQuality RadialBlurQuality:RadialBlurQuality.DRAFTRadialBlurQuality.GOODRadialBlurQuality.BEST

Thesmoothnessorgraininessoftheblurredimage.

voidapplyRipple(amount:int,size:RippleSize)Appliestheripplefilter.Parameter Type Description

amount int Therippleamount.Range:-999to999.

size RippleSize:RippleSize.SMALLRippleSize.MEDIUMRippleSize.LARGE

Theripplesize.

voidapplySharpen()Appliesthesharpenfilter.

voidapplySharpenEdges()Appliesthesharpenedgesfilter.

voidapplySharpenMore()Appliesthesharpenmorefilter.

voidapplyShear(curve:Arrayofany,undefinedAreas:UndefinedAreasAppliestheshearfilter.Parameter Type

curve Arrayofany


voidapplySmartBlur(radius:number,threshold:numberSmartBlurMode)Appliesthesmartblurfilter.Parameter Type Description

radius number Theblurradius.Range:0-1000.

threshold number Theblurthreshold.Range:0-1000.

blurQuality SmartBlurQuality:SmartBlurQuality.LOWSmartBlurQuality.MEDIUMSmartBlurQuality.HIGH

Thesmoothnessorgraininessoftheblurredimage.

mode SmartBlurMode:SmartBlurMode.NORMALSmartBlurMode.EDGEONLYSmartBlurMode.OVERLAYEDGE

Thesmartblurmode.

voidapplySpherize(amount:int,mode:SpherizeMode)Appliesthespherizefilter.Parameter Type Description

amount int Theamountofdistortion.Range:-100to100.

mode SpherizeMode:SpherizeMode.NORMALSpherizeMode.HORIZONTALSpherizeMode.VERTICAL

Thedistortionmode.

voidapplyStyle(styleName:string)Appliesthespecifiedstyletothelayer.Parameter Type Description

styleName string Thelayerstyletoapply.

voidapplyTextureFill(textureFile:File)Appliesthetexturefillfilter.Parameter Type Description

textureFile File Thetexturefile.MustbeagrayscalePhotoshopfile.

voidapplyTwirl(angle:int)Appliesthetwirlfilter.Parameter Type Description

angle int Thetwirlangle.Range:-999to999.

voidapplyUnSharpMask(amount:number,radius:numberAppliestheunsharpmaskfilter.Parameter Type Description

amount number Theamountofsharpening(asapercentage).Range:1to500.

radius number Theradiusinpixels.Range:0.1to250.0.

threshold int Thecontrastthreshold.Range:0to255.

voidapplyWave(generatorNumber:int,minimumWavelengthminimumAmplitude:int,maximumAmplitude:int,horizontalScaleWaveType,undefinedAreas:UndefinedAreas,randomSeedAppliesthewavefilter.Parameter Type

generatorNumber int

minimumWavelength int

maximumWavelength int

minimumAmplitude int

maximumAmplitude int

horizontalScale int

verticalScale int

waveType WaveType:WaveType.SINEWaveType.TRIANGULARWaveType.SQUARE


randomSeed int

voidapplyZigZag(amount:int,ridges:int,style:ZigZagTypeAppliesthezigzagfilter.Parameter Type Description

amount int Theamountofzigzag.Range:-100to100.

ridges int Theridgelength.

style ZigZagType:ZigZagType.AROUNDCENTERZigZagType.OUTFROMCENTERZigZagType.PONDRIPPLES

Thezigzagstyle.

voidautoContrast()Adjuststhecontrastoftheselectedchannelsautomatically.

voidautoLevels()Adjustthelevelsoftheselectedchannelsusingtheautolevelsoption.

voidclear()Cutsthelayerwithoutmovingittotheclipboard.

voidcopy([merge:bool=false])Copiesthelayertotheclipboard.Parameter Type Description

merge bool Iftrue,thecopyincludesallvisiblelayers.Iffalse,thecopyonlycopiesfromthecurrentlayer.(default:false)(Optional)

voidcut()Cutsthelayertotheclipboard.

voiddesaturate()Convertsacolorimagetoagrayscaleimageinthecurrentcolormodebyassigningequalvaluesofeachcomponentcolortoeachpixel.

voidequalize()Redistributesthebrightnessvaluesofpixelsinanimagetomoreevenlyrepresenttheentirerangeofbrightnesslevelswithintheimage.

voidinvert()Invertsthecolorsinthelayerbyconvertingthebrightnessvalueofeachpixelinthechannelstotheinversevalueonthe256-stepcolor-valuesscale.

ArtLayermerge()Mergesthelayerdown,removingthelayerfromthedocument.Returnsareferencetotheartlayerthatthislayerismergedinto.

voidmixChannels(outputChannels:Arrayofany[,monochromeModifiesatargeted(output)colorchannelusingamixoftheexistingcolorchannelsintheimage.(outputchannels=Anarrayofchannelspecifications.Foreachcomponentchannel,specifyalistofadjustmentvalues(-200to200)followedbya'constant'value(-200to200).)Whenmonochrome=true,themaximumnumberofchannelvaluespecificationsis1.Validonlywhen'documentmode'=RGBorCMYK.RGBarraysmustincludefourdoubles.CMYKarraysmustincludefivedoubles.Parameter Type Description

outputChannels Arrayofany

Alistofchannelspecifications.Foreachcomponentchannelthatthedocumenthas,youmustspecifyalistofadjustmentvaluesfollowedbya'constant'value.

monochrome bool Iftrue,usesmonochromemixing.Note:Ifthisistrue,youcanonlyspecifyonechannelvalue.(default:false

voidphotoFilter([fillColor:SolidColor][,density:int=25][,Adjuststhelayer'scolorbalanceandtemperatureasifacolorfilterhadbeenapplied.Parameter Type Description

fillColor SolidColor Thecolortouseforthefill.(Optional)

density int Thedensity(asapercentage)ofthefiltereffect.Range:1to100.(default:25)(Optional)

preserveLuminosity bool Iftrue,luminosityispreserved.(default:

voidposterize(levels:int)Specifiesthenumberoftonallevelsforeachchannelandthenmapspixelstotheclosestmatchinglevel.Parameter Type Description

levels int Thetonallevels.Range:2to255.

voidrasterize(target:RasterizeType)Convertsthetargetedcontentinthelayerintoaflat,rasterimage.Parameter Type

target RasterizeType:RasterizeType.TEXTCONTENTSRasterizeType.SHAPERasterizeType.FILLCONTENTRasterizeType.LAYERCLIPPINGPATHRasterizeType.ENTIRELAYERRasterizeType.LINKEDLAYERS

voidselectiveColor(selectionMethod:AdjustmentReferenceofnumber][,greens:Arrayofnumber][,cyans:Arrayofnumbermagentas:Arrayofnumber][,whites:Arrayofnumber][,neutralsnumber])Parameter Type Description

selectionMethod AdjustmentReference:AdjustmentReference.RELATIVEAdjustmentReference.ABSOLUTE

Modifiestheamountofaprocesscolorinaspecifiedprimarycolorwithoutaffectingtheotherprimarycolors.

reds Arrayofnumber Arrayof4values:cyan,magenta,yellow,

black.(Optional)

yellows Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

greens Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

cyans Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

blues Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

magentas Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

whites Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

neutrals Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

blacks Arrayofnumber Arrayof4values:cyan,magenta,yellow,black.(Optional)

voidshadowHighlight([shadowAmount:int=50][,shadowWidthhighlightAmount:int=0][,highlightWidth:int=50][,highlightRaduisint=20][,midtoneContrast:int=0][,blackClip:number=0.01Adjuststherangeoftonesintheshadowsandhighlights.Parameter Type Description

shadowAmount int Theshadowamount,asapercentage.Range:0to100.(default:(Optional)

shadowWidth int Theshadowwidth,asapercentage.Range:0to100fortonalwidth(0=narrow),(100=broad).(default:

shadowRaduis int Theshadowradius(inpixels).Range:0to2500.(default:

highlightAmount int Thehighlightamount,asapercentage.Range:0to100.(default:(Optional)

highlightWidth int Thehighlightwidth.Range:0to100fortonalwidth(0=narrow),(100=

broad).(default:50)(Optional)

highlightRaduis int Thehighlightradius(inpixels).Range:0to2500.(default:(Optional)

colorCorrection int Theamounttoadjustthecolorsinthechangedportionoftheimage.Range:-100to100.(default:20

midtoneContrast int Theamountofmidtonecontrast.Range:-100to100.(default:(Optional)

blackClip number Fractionsofwhitestobeclipped.Range:0.000to50.000.(default:(Optional)

whiteClip number Fractionsofblackstobeclipped.Range:0.000to50.000.(default:(Optional)

voidthreshold(level:int)Convertsgrayscaleorcolorimagestohigh-contrast,B/Wimagesbyconvertingpixelslighterthanthespecifiedthresholdtowhiteandpixelsdarkerthanthethresholdtoblack.Parameter Type Description

level int Thethresholdlevel.

Elementof Document.backgroundLayer

Return ArtLayerArtLayer.merge()ArtLayerArtLayers.[](index:uint)ArtLayerArtLayers.add()ArtLayerArtLayers.getByName(name:string)ArtLayerDocument.paste([intoSelection:bool=false])ArtLayerLayerSet.merge()


Contents::Index

Enumeration

AutoKernType Thetypeofkerningtouseforcharacters.


AutoKernType.MANUAL Allowsmanualkerning.

int1

AutoKernType.METRICS Useskernpairs,whichcontaininformationaboutthespacingofspecificpairsofletters.

int2

AutoKernType.OPTICAL Adjuststhespacingbetweenadjacentcharactersbasedontheirshapes.

int3

Usage AspropertyTextItem.autoKerning


Contents::Index

Enumeration

BatchDestinationType Thedestination,ifany,forbatch-processedfiles.

Value Name

BatchDestinationType.FOLDER

BatchDestinationType.NODESTINATION

BatchDestinationType.SAVEANDCLOSE

Usage AspropertyBatchOptions.destination


Contents::Index

BatchOptions OptionstospecifywhenrunningaBatchcommand.

Class Property Type

destination BatchDestinationType:BatchDestinationType.NODESTINATIONBatchDestinationType.SAVEANDCLOSEBatchDestinationType.FOLDER

destinationFolder File

errorFile File

fileNaming ArrayofFileNamingTypeFileNamingType.DOCUMENTNAMEMIXEDFileNamingType.DOCUMENTNAMELOWERFileNamingType.DOCUMENTNAMEUPPERFileNamingType.SERIALNUMBER1FileNamingType.SERIALNUMBER2FileNamingType.SERIALNUMBER3FileNamingType.SERIALNUMBER4FileNamingType.SERIALLETTERLOWERFileNamingType.SERIALLETTERUPPERFileNamingType.MMDDYYFileNamingType.MMDDFileNamingType.YYYYMMDDFileNamingType.YYMMDDFileNamingType.YYDDMMFileNamingType.DDMMYYFileNamingType.DDMMFileNamingType.EXTENSIONLOWERFileNamingType.EXTENSIONUPPER

macintoshCompatible bool

overrideOpen bool

overrideSave bool

startingSerial int

suppressOpen bool

suppressProfile bool

unixCompatible bool

windowsCompatible bool

Usedin: stringApplication.batch(inputFiles:AliasArray,action


Contents::Index

BitmapConversionOptions OptionsforchangingthedocumentmodetoBitmap.BaseClass:

Class Property Type

angle number

frequency number

method BitmapConversionTypeBitmapConversionType.HALFTHRESHOLDBitmapConversionType.PATTERNDITHERBitmapConversionType.DIFFUSIONDITHERBitmapConversionType.HALFTONESCREENBitmapConversionType.CUSTOMPATTERN

patternName string

resolution number

shape BitmapHalfToneTypeBitmapHalfToneType.ROUNDBitmapHalfToneType.DIAMONDBitmapHalfToneType.ELLIPSEBitmapHalfToneType.LINEBitmapHalfToneType.SQUAREBitmapHalfToneType.CROSS


Contents::Index

Enumeration

BitmapConversionType Thequalityofanimageconvertedtobitmapmode.

Value Name

BitmapConversionType.CUSTOMPATTERN

BitmapConversionType.DIFFUSIONDITHER

BitmapConversionType.HALFTHRESHOLD

BitmapConversionType.HALFTONESCREEN

BitmapConversionType.PATTERNDITHER

Usage AspropertyBitmapConversionOptions.method


Contents::Index

Enumeration

BitmapHalfToneType Theshapeofthedots(inkdeposits)inthehalftone

screen.

Value Name

BitmapHalfToneType.CROSS

BitmapHalfToneType.DIAMOND

BitmapHalfToneType.ELLIPSE

BitmapHalfToneType.LINE

BitmapHalfToneType.ROUND

BitmapHalfToneType.SQUARE

Usage AspropertyBitmapConversionOptions.shape


Contents::Index

Enumeration

BitsPerChannelType Thenumberofbitspercolorchannel.

Value Name

BitsPerChannelType.EIGHT

BitsPerChannelType.ONE

BitsPerChannelType.SIXTEEN

BitsPerChannelType.THIRTYTWO

Usage InfunctionDocumentDocuments.add([width

UnitValue][,resolution:numbermode:NewDocumentMode=NewDocumentMode.RGBinitialFill:DocumentFill=DocumentFill.WHITEpixelAspectRatio:number=1.0BitsPerChannelType=BitsPerChannelType.EIGHT[,colorProfileName:string])

AspropertyCameraRAWOpenOptions.bitsPerChannelDocument.bitsPerChannelPDFOpenOptions.bitsPerChannel


Contents::Index

Enumeration

BlendMode Controlshowpixelsintheimageareblended.


BlendMode.COLORBLEND Createsaresultcolorwiththeluminanceofthebasecolorandthehueandsaturationoftheblendcolor.Thispreservesthegraylevelsintheimageandisusefulforcoloringmonochromeimagesandfortintingcolorimages.

BlendMode.COLORBURN Looksatthecolorinformationineachchannelanddarkensthebasecolortoreflecttheblendcolorbyincreasingthecontrast.Blendingwithwhiteproducesnochange.

BlendMode.COLORDODGE Looksatthecolorinformationineachchannelandbrightensthebasecolortoreflecttheblendcolorbydecreasingthecontrast.Blendingwithblackproducesnochange.

BlendMode.DARKEN Looksatthecolorinformationineachchannelandselectsthebaseorblendcolor�whicheverisdarker�astheresult

color.Pixelslighterthantheblendcolorarereplaced,andpixelsdarkerthantheblendcolordonotchange.

BlendMode.DARKERCOLOR Lightercolorslightentheresult,anddarkercolorsdarkentheresult.50%grayasablendcolorhasnoeffectontheresultcolor.Loweringthefillopacitycreateslessposterization/thresholding.

BlendMode.DIFFERENCE Looksatthecolorinformationineachchannelandsubtractseithertheblendcolorfromthebasecolororthebasecolorfromtheblendcolor,dependingonwhichhasthegreaterbrightnessvalue.Blendingwithwhiteinvertsthebasecolorvalues;blendingwithblackproducesnochange.

BlendMode.DISSOLVE Editsorpaintseachpixeltomakeittheresultcolor.However,theresultcolorisarandomreplacementofthepixelswiththebasecolorortheblendcolor,dependingontheopacityatanypixellocation.

BlendMode.EXCLUSION Createsaneffectsimilartobutlowerincontrast

thantheDifferencemode.Blendingwithwhiteinvertsthebasecolorvalues.Blendingwithblackproducesnochange.

BlendMode.HARDLIGHT Multipliesorscreensthecolors,dependingontheblendcolor.Theeffectissimilartoshiningaharshspotlightontheimage.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightened,asifitwerescreened.Thisisusefulforaddinghighlightstoanimage.Iftheblendcolorisdarkerthan50%gray,theimageisdarkened,asifitweremultiplied.Thisisusefulforaddingshadowstoanimage.Paintingwithpureblackorwhiteresultsinpureblackorwhite.

BlendMode.HARDMIX Lightercolorslightentheresult,anddarkercolorsdarkentheresult.50%grayasablendcolorhasnoeffectontheresultcolor.Loweringthefillopacitycreateslessposterization/thresholding.

BlendMode.HUE Createsaresultcolorwiththeluminanceandsaturationofthebasecolorandthehueofthe

blendcolor.

BlendMode.LIGHTEN Looksatthecolorinformationineachchannelandselectsthebaseorblendcolor�whicheverislighter�astheresultcolor.Pixelsdarkerthantheblendcolorarereplaced,andpixelslighterthantheblendcolordonotchange.

BlendMode.LIGHTERCOLOR Lightercolorslightentheresult,anddarkercolorsdarkentheresult.50%grayasablendcolorhasnoeffectontheresultcolor.Loweringthefillopacitycreateslessposterization/thresholding.

BlendMode.LINEARBURN Looksatthecolorinformationineachchannelanddarkensthebasecolortoreflecttheblendcolorbydecreasingthebrightness.Blendingwithwhiteproducesnochange.

BlendMode.LINEARDODGE Looksatthecolorinformationineachchannelandbrightensthebasecolortoreflecttheblendcolorbyincreasingthebrightness.Blendingwithblackproducesnochange.

BlendMode.LINEARLIGHT Burnsordodgesthecolorsbydecreasingorincreasingthebrightness,dependingontheblendcolor.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightenedbyincreasingthebrightness.Iftheblendcolorisdarkerthan50%gray,theimageisdarkenedbydecreasingthebrightness.

BlendMode.LUMINOSITY Createsaresultcolorwiththehueandsaturationofthebasecolorandtheluminanceoftheblendcolor.ThismodecreatesaninverseeffectfromthatoftheColormode.

BlendMode.MULTIPLY Looksatthecolorinformationineachchannelandmultipliesthebasecolorbytheblendcolor.Theresultcolorisalwaysadarkercolor.Multiplyinganycolorwithblackproducesblack.Multiplyinganycolorwithwhiteleavesthecolorunchanged.Whenyou�repaintingwithacolorotherthanblackorwhite,successivestrokeswithapaintingtoolproduceprogressivelydarkercolors.Theeffectissimilartodrawingon

theimagewithmultiplemarkingpens.

BlendMode.NORMAL Editsorpaintseachpixeltomakeittheresultcolor.(Called"Threshold"whenyou�reworkingwithabitmappedorindexed-colorimage.)

BlendMode.OVERLAY Multipliesorscreensthecolors,dependingonthebasecolor.Patternsorcolorsoverlaytheexistingpixelswhilepreservingthehighlightsandshadowsofthebasecolor.Thebasecolorisnotreplacedbutismixedwiththeblendcolortoreflectthelightnessordarknessoftheoriginalcolor.

BlendMode.PASSTHROUGH Allowsanyblendmodes,advancedblendingoptions,andopacityandfillvaluesappliedtolayerswithinasettoaffectlayersbelowthesetintheLayerspalette.Validonlyforlayersets.Torestrictblendmodesofthelayerswithinaset,changethelayerset'sblendmodetoNormal.

BlendMode.PINLIGHT Replacesthecolors,dependingontheblendcolor.Iftheblendcolor(lightsource)islighter

than50%gray,pixelsdarkerthantheblendcolorarereplaced,andpixelslighterthantheblendcolordonotchange.Iftheblendcolorisdarkerthan50%gray,pixelslighterthantheblendcolorarereplaced,andpixelsdarkerthantheblendcolordonotchange.Thisisusefulforaddingspecialeffectstoanimage.

BlendMode.SATURATION Createsaresultcolorwiththeluminanceandhueofthebasecolorandthesaturationoftheblendcolor.Paintingwiththismodeinanareawithno(0)saturation(gray)causesnochange.

BlendMode.SCREEN Looksateachchannel�scolorinformationandmultipliestheinverseoftheblendandbasecolors.Theresultcolorisalwaysalightercolor.Screeningwithblackleavesthecolorunchanged.Screeningwithwhiteproduceswhite.Theeffectissimilartoprojectingmultiplephotographicslidesontopofeachother.

BlendMode.SOFTLIGHT Darkensorlightensthe

colors,dependingontheblendcolor.Theeffectissimilartoshiningadiffusedspotlightontheimage.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightenedasifitweredodged.Iftheblendcolorisdarkerthan50%gray,theimageisdarkenedasifitwereburnedin.Paintingwithpureblackorwhiteproducesadistinctlydarkerorlighterareabutdoesnotresultinpureblackorwhite.

BlendMode.VIVIDLIGHT Burnsordodgesthecolorsbyincreasingordecreasingthecontrast,dependingontheblendcolor.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightenedbydecreasingthecontrast.Iftheblendcolorisdarkerthan50%gray,theimageisdarkenedbyincreasingthecontrast.

Usage AspropertyLayer.blendMode


Contents::Index

Enumeration

ByteOrder Theplatform-specificorderinwhichbyteswillbe

read.


ByteOrder.IBM IBMPC. int1

ByteOrder.MACOS MacOS. int2

Usage AspropertyRawFormatOpenOptions.byteOrderTiffSaveOptions.byteOrder


Contents::Index

Enumeration

CameraRAWSettingsType ThedefaultCameraRAWsettings.

Value Name

CameraRAWSettingsType.CAMERA

CameraRAWSettingsType.CUSTOM

CameraRAWSettingsType.SELECTEDIMAGE

Usage AspropertyCameraRAWOpenOptions


Contents::Index

Enumeration

CameraRAWSize ThecameraRAWimagesize.


CameraRAWSize.EXTRALARGE 5120x3413image.

CameraRAWSize.LARGE 4096x2731image.

CameraRAWSize.MAXIMUM 6144x4096image.

CameraRAWSize.MEDIUM 3072x2048image.

CameraRAWSize.MINIMUM 1536x1024image.

CameraRAWSize.SMALL 2048x1365image.

Usage AspropertyCameraRAWOpenOptions.size


Contents::Index

Enumeration

Case Thecapitalizationtouse.


Case.ALLCAPS Usesalluppercaseletters. int2

Case.NORMAL Usesuppercaseandlowercaseletters.

int1

Case.SMALLCAPS Usessmallcapsforlowercaseletters.

int3

Usage AspropertyTextItem.capitalization


Contents::Index

Enumeration

ChangeMode Thedestinationcolormode.Note:Colorimagesmustbe

changedtoGrayscalemodebeforeyoucanchangethemtoBitmapmode.


ChangeMode.BITMAP Bitmap.Note:ColorimagesmustbechangedtoGrayscalemodebeforeyoucanchangethemtoBitmapmode.

ChangeMode.CMYK CMYK.

ChangeMode.GRAYSCALE Grayscale.

ChangeMode.INDEXEDCOLOR Indexedcolor,inwhichthenumberofcolorsintheimageisreducedtoatmost256,thestandardnumberofcolorssupportedbytheGIFandPNG-8formatsandmanymultimedia

applications.Thisconversionreducesfilesizebydeletingcolorinformationfromtheimage.Toconverttoindexedcolor,youmuststartwithanimagethatis8bitsperchannelandineitherGrayscaleorRGBmode.

ChangeMode.LAB Lab.

ChangeMode.MULTICHANNEL Imagewithmultiplecolorchannels.Uses256levelsofgrayineachchannel.Usefulforspecializedprinting.Colorchannelsintheoriginalimagebecomespot

colorchannelsintheconvertedimage.ACMYKimageconvertedtoMultichannelmodecreatescyan,magenta,yellow,andblackspotchannels.AnRGBimageconvertedMultichannelmodecreatescyan,magenta,andyellowspotchannels.Thenewgrayscaleinformationisbasedonthecolorvaluesofthepixelsineachchannel.MultichannelmodeimagescanbesavedinPhotoshop,Photoshop2.0,

PhotoshopRaw,orPhotoshopDCS2.0format.Toexportamultichannelimage,saveitinPhotoshopDCS2.0format.

ChangeMode.RGB RGB.

Usage InfunctionvoidDocument.changeMode(destinationMode:

ChangeMode[,options:DocumentConversionOptions])


Contents::Index

Channel Objectthatstoresinformationaboutacolorelementintheimage,

analogoustoaplateintheprintingprocessthatappliesasinglecolor.Thedocument'scolormodedeterminesthenumberofdefaultchannels.Forexample,anRGBdocumenthasfourdefaultchannels:Acompositechannel:RGB;andthreecomponentchannels:red,green,andblue.Achannelcanalsobeanalphachannel,whichstoresselectionsasmasks;oraspotchannel,whichstoresspotcolors.

QuickLinks duplicate,duplicate,merge,remove,removeAll

Hierarchy Object

Channel

Properties Property Type Access Description

color SolidColor r/w Thecolorofthechannel.Notvalidforcomponentchannels.

histogram Arrayofint readonly Ahistogramofthecolorofthechannel.

kind ChannelType:ChannelType.COMPONENTChannelType.MASKEDAREAChannelType.SELECTEDAREAChannelType.SPOTCOLOR

r/w Thetypeofchannel.

name string r/w Thechannelname.

opacity number r/w Theopacityofalpha

channels(calledsolidityforspotchannels).Range:0to100.Validonlywhen'type'=maskedareaorselectedarea.

parent Object readonly Theobject'scontainer.

typename string readonly Theclassnameoftheobject.

visible bool r/w Iftrue,thechannelisvisible.

Methods InstancesChannelduplicate(relativeObject:Object,insertionLocationElementPlacement)Duplicatethisobject.Parameter Type Description



Channelduplicate([targetDocument:Document])Duplicatesthechannel.Parameter Type Description

targetDocument Document Thedocumenttoduplicatethechannelto.(Optional)

voidmerge()Mergesaspotchannelintothecomponentchannels.

voidremove()Deletesthisobject.

voidremoveAll()Deletesallelements.

Elementof Document.activeChannelsDocument.componentChannelsLayerSet.enabledChannels

Usedin: voidDocument.autoCount(channel:Channel,threshold:int)voidSelection.load(from:Channel[,combination:

SelectionType=SelectionType.REPLACE][,inverting:bool=false])

voidSelection.store(into:Channel[,combination:SelectionType=SelectionType.REPLACE])

Return ChannelChannel.duplicate(relativeObject:Object,insertionLocationElementPlacement)

ChannelChannel.duplicate([targetDocument:Document])ChannelChannels.[](index:uint)ChannelChannels.add()ChannelChannels.getByName(name:string)


Contents::Index

Enumeration

ChannelType Thetypeofchannel.


ChannelType.COMPONENT Thechannelrelatedtothedocumentcolormodel.

int

ChannelType.MASKEDAREA Theaphachannelwherecolorindicatesamaskedarea.

int

ChannelType.SELECTEDAREA Thelphachannelwherecolorindicatesaselectedarea.

int

ChannelType.SPOTCOLOR Thealphachanneltostoreaspotcolor.

int

Usage AspropertyChannel.kind


Contents::Index

Enumeration

ColorBlendMode Thecolorblendmodetype.


ColorBlendMode.BEHIND Editsorpaintsonlyonthetransparentpartofalayer.Worksonlyinlayersinwhichtransparentpixelslocked=falseandisanalogoustopaintingonthebackoftransparentareasonasheetofacetate.

ColorBlendMode.CLEAR Editsorpaintseachpixelandmakesittransparent.Worksonlyinlayersinwhichtransparentpixelslocked=false.

ColorBlendMode.COLOR Createsaresultcolorwiththeluminanceofthebasecolorandthehueandsaturationoftheblendcolor.Thispreservesthegraylevelsintheimageandisusefulforcoloringmonochromeimagesandfortintingcolorimages.

ColorBlendMode.COLORBURN Looksatthecolorinformationineachchannelanddarkensthebasecolortoreflecttheblendcolorbyincreasingthecontrast.Blendingwithwhiteproducesnochange.

ColorBlendMode.COLORDODGE Looksatthecolorinformationineachchannelandbrightensthebasecolortoreflecttheblendcolorbydecreasingthecontrast.Blendingwithblackproducesnochange.

ColorBlendMode.DARKEN Looksatthecolorinformationineachchannelandselectsthebaseorblendcolor�whicheverisdarker�astheresultcolor.Pixelslighterthantheblendcolorarereplaced,andpixelsdarkerthantheblendcolordonotchange.

ColorBlendMode.DIFFERENCE Looksatthecolorinformationineachchannelandsubtractseithertheblendcolorfromthebasecolororthebasecolorfromtheblendcolor,dependingonwhichhasthegreaterbrightnessvalue.Blendingwithwhiteinvertsthebasecolorvalues;blendingwithblackproducesnochange.

ColorBlendMode.DISSOLVE Editsorpaintseachpixeltomakeittheresultcolor,whichisarandomreplacementofthepixelswiththebasecolororthe

blendcolor,dependingontheopacityatanypixellocation.

ColorBlendMode.EXCLUSION CreatesaneffectsimilartobutlowerincontrastthantheDifferencemode.Blendingwithwhiteinvertsthebasecolorvalues.Blendingwithblackproducesnochange.

ColorBlendMode.HARDLIGHT Multipliesorscreensthecolors,dependingontheblendcolor.Theeffectissimilartoshiningaharshspotlightontheimage.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightened,asifitwerescreened.Thisisusefulforaddinghighlightstoanimage.Iftheblendcolorisdarkerthan50%gray,theimageisdarkened,asifitweremultiplied.Thisisusefulforaddingshadowstoanimage.Paintingwithpureblackorwhiteresultsinpureblackorwhite.

ColorBlendMode.HARDMIXBLEND Lightercolorslightentheresult,anddarkercolorsdarkentheresult.50%grayasablendcolorhasnoeffectontheresultcolor.Loweringthefillopacitycreatesless

posterization/thresholding.

ColorBlendMode.HUE Createsaresultcolorwiththeluminanceandsaturationofthebasecolorandthehueoftheblendcolor.

ColorBlendMode.LIGHTEN Looksatthecolorinformationineachchannelandselectsthebaseorblendcolor�whicheverislighter�astheresultcolor.Pixelsdarkerthantheblendcolorarereplaced,andpixelslighterthantheblendcolordonotchange.

ColorBlendMode.LINEARBURN Looksatthecolorinformationineachchannelanddarkensthebasecolortoreflecttheblendcolorbydecreasingthebrightness.Blendingwithwhiteproducesnochange.

ColorBlendMode.LINEARDODGE Looksatthecolorinformationineachchannelandbrightensthebasecolortoreflecttheblendcolorbyincreasingthebrightness.Blendingwithblackproducesnochange.

ColorBlendMode.LINEARLIGHT Burnsordodgesthecolorsbydecreasingorincreasingthebrightness,

dependingontheblendcolor.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightenedbyincreasingthebrightness.Iftheblendcolorisdarkerthan50%gray,theimageisdarkenedbydecreasingthebrightness.

ColorBlendMode.LUMINOSITY Createsaresultcolorwiththehueandsaturationofthebasecolorandtheluminanceoftheblendcolor.ThismodecreatesaninverseeffectfromthatoftheColormode.

ColorBlendMode.MULTIPLY Looksatthecolorinformationineachchannelandmultipliesthebasecolorbytheblendcolor.Theresultcolorisalwaysadarkercolor.Multiplyinganycolorwithblackproducesblack.Multiplyinganycolorwithwhiteleavesthecolorunchanged.Whenyou�repaintingwithacolorotherthanblackorwhite,successivestrokeswithapaintingtoolproduceprogressivelydarkercolors.Theeffectissimilartodrawingontheimagewithmultiplemarkingpens.

ColorBlendMode.NORMAL Editsorpaintseachpixeltomakeittheresultcolor.(Called"Threshold"whenyou�reworkingwithabitmappedorindexed-colorimage.)

ColorBlendMode.OVERLAY Multipliesorscreensthecolors,dependingonthebasecolor.Patternsorcolorsoverlaytheexistingpixelswhilepreservingthehighlightsandshadowsofthebasecolor.Thebasecolorisnotreplacedbutismixedwiththeblendcolortoreflectthelightnessordarknessoftheoriginalcolor.

ColorBlendMode.PINLIGHT Replacesthecolors,dependingontheblendcolor.Iftheblendcolor(lightsource)islighterthan50%gray,pixelsdarkerthantheblendcolorarereplaced,andpixelslighterthantheblendcolordonotchange.Iftheblendcolorisdarkerthan50%gray,pixelslighterthantheblendcolorarereplaced,andpixelsdarkerthantheblendcolordonotchange.Thisisusefulforaddingspecialeffectstoanimage.

ColorBlendMode.SATURATION Createsaresultcolorwith

theluminanceandhueofthebasecolorandthesaturationoftheblendcolor.Paintingwiththismodeinanareawithno(0)saturation(gray)causesnochange.

ColorBlendMode.SCREEN Looksateachchannel�scolorinformationandmultipliestheinverseoftheblendandbasecolors.Theresultcolorisalwaysalightercolor.Screeningwithblackleavesthecolorunchanged.Screeningwithwhiteproduceswhite.Theeffectissimilartoprojectingmultiplephotographicslidesontopofeachother.

ColorBlendMode.SOFTLIGHT Darkensorlightensthecolors,dependingontheblendcolor.Theeffectissimilartoshiningadiffusedspotlightontheimage.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightenedasifitweredodged.Iftheblendcolorisdarkerthan50%gray,theimageisdarkenedasifitwereburnedin.Paintingwithpureblackorwhiteproducesadistinctlydarkerorlighterareabutdoesnotresultinpure

blackorwhite.

ColorBlendMode.VIVIDLIGHT Burnsordodgesthecolorsbyincreasingordecreasingthecontrast,dependingontheblendcolor.Iftheblendcolor(lightsource)islighterthan50%gray,theimageislightenedbydecreasingthecontrast.Iftheblendcolorisdarkerthan50%gray,theimageisdarkenedbyincreasingthecontrast.

Usage InfunctionvoidPathItem.fillPath([fillColor:any][,mode

opacity:number][,preserveTransparencyantiAlias:bool][,wholePath:bool])

voidSelection.fill(fillType:any[,mode:ColorBlendMode=ColorBlendMode.NORMAL[,preserveTransparency:bool])

voidSelection.stroke(strokeColor:any,widthStrokeLocation=StrokeLocation.CENTERColorBlendMode=ColorBlendMode.NORMAL[,preserveTransparency:bool])


Contents::Index

Enumeration

ColorPicker Thecolorpickertouse.


ColorPicker.ADOBE TheAdobeColorPicker.

int1

ColorPicker.APPLE Thebuilt-inApplecolorpicker.

int2

ColorPicker.PLUGIN Aninstalledplug-incolorpicker.

int4

ColorPicker.WINDOWS Thebuilt-inWindowscolorpicker.

int3

Usage AspropertyPreferences.colorPicker


Contents::Index

Enumeration

ColorProfile Thetypeofcolormodelthatdefinesthe

document'sworkingspace.


ColorProfile.CUSTOM Colormanagesthisdocumentusingacustomcolorprofile.

int3

ColorProfile.NONE Thedocumentisnotcolormanaged.

int1

ColorProfile.WORKING Colormanagesthisdocumentusingtheworkingcolorprofile.

int2

Usage AspropertyDocument.ColorProfile


Contents::Index

Enumeration

ColorReductionType Thecolorreductionalgorithm.

Value Name

ColorReductionType.ADAPTIVE

ColorReductionType.BLACKWHITE

ColorReductionType.CUSTOM

ColorReductionType.GRAYSCALE

ColorReductionType.MACINTOSH

ColorReductionType.PERCEPTUAL

ColorReductionType.RESTRICTIVE

ColorReductionType.SELECTIVE

ColorReductionType.WINDOWS

Usage AspropertyExportOptionsSaveForWeb.colorReduction


Contents::Index

ColorSampler Acolorsamplerinadocument.

QuickLinks add,move,remove,removeAll

Hierarchy Object

ColorSampler


color SolidColor readonly Thecolorofthecolorsampler.


position UnitPoint readonly Thepositionofthecolorsamplerinthedocument.


Methods InstancesColorSampleradd()Addsanelement.

voidmove(position:UnitPoint)Movesthecolorsamplertoanewlocation.Parameter Type Description

position UnitPoint Positionof

destination(unitvalue)



Return ColorSamplerColorSampler.add()ColorSamplerColorSamplers.[](index:uint)ColorSamplerColorSamplers.add(position:

UnitPoint)ColorSamplerColorSamplers.getByName

(name:string)


Contents::Index

Enumeration

ColorSpaceType Thetypeofcolorspace.


ColorSpaceType.ADOBERGB UsetheAdobeRGBcolorspace.

ColorSpaceType.COLORMATCHRGB UsetheColorMatchRGBcolorspace.

ColorSpaceType.PROPHOTORGB UsetheProPhotoRGBcolorspace.

ColorSpaceType.SRGB UsethesRGBcolorspace.

Usage AspropertyCameraRAWOpenOptions.colorSpace


Contents::Index

ContactSheetOptions Optionsthatcanbespecifiedforacontactsheet.

Class Property Type

acrossFirst bool

bestFit bool

caption bool

columnCount int

flatten bool

font GalleryFontTypeGalleryFontType.ARIALGalleryFontType.COURIERNEWGalleryFontType.HELVETICAGalleryFontType.TIMESNEWROMAN

fontSize int

height int

horizontal int

mode NewDocumentModeNewDocumentMode.GRAYSCALENewDocumentMode.RGBNewDocumentMode.CMYKNewDocumentMode.LABNewDocumentMode.BITMAP

resolution number

rowCount int

useAutoSpacing bool

vertical int

width int

Usedin: stringApplication.makeContactSheet


Contents::Index

Enumeration

CopyrightedType Thecopyrightstatusofthedocument.

Value Name

CopyrightedType.COPYRIGHTEDWORK

CopyrightedType.PUBLICDOMAIN

CopyrightedType.UNMARKED

Usage AspropertyDocumentInfo.copyrighted


Contents::Index

CountItem Acountediteminthedocument.Thecountitem

featureisavailableintheExtendedVersiononly.

QuickLinks add,remove,removeAll

Hierarchy Object

CountItem



position UnitPoint readonly Thepositionofcountiteminthedocument.


Methods InstancesCountItemadd()Addsanelement.



Return CountItemCountItem.add()CountItemCountItems.[](index:uint)CountItemCountItems.add(position:UnitPoint)CountItemCountItems.getByName(name:string)

Jongware,28-Aug-2012 Contents::Index

v3.0.3i

Enumeration

CropToType Thestyletousewhencroppingapage.


CropToType.ARTBOX Croptotheartbox.

int5

CropToType.BLEEDBOX Croptothebleedbox.

int3

CropToType.BOUNDINGBOX Croptotheboundingbox.

int0

CropToType.CROPBOX Croptothecropbox.

int2

CropToType.MEDIABOX Croptothemediabox.

int1

CropToType.TRIMBOX Croptothetrimbox.

int4

Usage AspropertyPDFOpenOptions.cropPage


Contents::Index

Enumeration

DCSType TheDCSformat.


DCSType.COLORCOMPOSITE CreatesacolorcompositefileinadditiontoDCSfiles.

int

DCSType.GRAYSCALECOMPOSITE CreatesagrayscalecompositefileinadditiontoDCSfiles.

int

DCSType.NOCOMPOSITE Doesnotcreateacompositefile.

int

Usage AspropertyDCS1_SaveOptions.DCSDCS2_SaveOptions.DCS


Contents::Index

Enumeration

DepthMapSource Depthmapsourceoptions.

Value Name

DepthMapSource.IMAGEHIGHLIGHT

DepthMapSource.LAYERMASK

DepthMapSource.NONE

DepthMapSource.TRANSPARENCYCHANNEL

Usage InfunctionvoidArtLayer.applyLensBlur([source:

DepthMapSource=DepthMapSource.NONEint=0][,invertDepthMap:bool=falseGeometry=Geometry.HEXAGON][,bladeCurvature:int=0][,rotation:intthreshold:int=0][,amount:int=0][,distributionNoiseDistribution=NoiseDistribution.UNIFORMmonochromatic:bool=false])


Contents::Index

Enumeration

DialogModes ControlswhetherPhotoshopdisplaysdialogs

duringscripts.


DialogModes.ALL Showalldialogs.

int1

DialogModes.ERROR Showonlydialogsrelatedtoerrors.

int2

DialogModes.NO Shownodialogs.

int3

Usage InfunctionActionDescriptorApplication.executeAction

(eventID:int[,descriptor:ActionDescriptor][,displayDialogs:DialogModes])

AspropertyApplication.displayDialogsApplication.playbackDisplayDialogs


Contents::Index

Enumeration

Direction Theorientationoftheobject.


Direction.HORIZONTAL Horizontal. int1

Direction.VERTICAL Vertical. int2

Usage InfunctionvoidDocument.flipCanvas(direction:Direction)AspropertyTextItem.directionTextItem.warpDirection


Contents::Index

Enumeration

Dither Thetypeofdither.


Dither.DIFFUSION Diffusesdithereffectsinrandompatternsacrossadjacentpixels.

int2

Dither.NOISE Appliesarandompatternbutwithoutdiffusingthepatternacrossadjacentpixels;preventstheappearanceofseams.

int4

Dither.NONE Noditherisused. int1

Dither.PATTERN Appliesahalftone-likesquarepattern.

int3

Usage AspropertyExportOptionsSaveForWeb.ditherExportOptionsSaveForWeb.transparencyDitherGIFSaveOptions.ditherIndexedConversionOptions.dither


Contents::Index

Enumeration

DocPositionStyle Positionofdocumentwhenprinting.


DocPositionStyle.PRINTCENTERED Printimagecenteredonpage.

DocPositionStyle.SIZETOFIT Resizeimagetofitonpagewhenprinting.

DocPositionStyle.USERDEFINED Printusinguserdefinedspacing.

Usage InfunctionvoidDocumentPrintSettings.setPagePosition

DocPositionStyle[,posX:UnitValue][,UnitValue][,scale:number=100])

AspropertyDocumentPrintSettings.docPosition


Contents::Index

DocumentConversionOptions Optionsforconvertingdocuments.

SuperclassofBitmapConversionOptionsIndexedConversionOptions

Usedin: voidDocument.changeMode(destinationModeChangeModeDocumentConversionOptions


Contents::Index

Enumeration

DocumentFill Thedocumentwindowfilltype.


DocumentFill.BACKGROUNDCOLOR Thebackgroundcolorasdisplayedinthetoolbox.

DocumentFill.TRANSPARENT Transparent.

DocumentFill.WHITE White.

Usage InfunctionDocumentDocuments.add([width:UnitValue][,height

UnitValue][,resolution:number=72][,name:mode:NewDocumentMode=NewDocumentMode.RGB[,initialFill:DocumentFill=DocumentFill.WHITEpixelAspectRatio:number=1.0][,bitsPerChannelBitsPerChannelType=BitsPerChannelType.EIGHTcolorProfileName:string])


Contents::Index

DocumentInfo Metadataaboutadocumentobject.ThesevaluescanbesetbyselectingFile>FileInfointhe

AdobePhotoshopapplication.

Hierarchy Object

DocumentInfo


author string

authorPosition string

caption string

captionWriter string

category string

city string

copyrightNotice string

copyrighted CopyrightedType:CopyrightedType.COPYRIGHTEDWORKCopyrightedType.PUBLICDOMAINCopyrightedType.UNMARKED

country string

creationDate string

credit string

exif Arrayofany

headline string

instructions string

jobName string

keywords Arrayofstring

ownerUrl string

parent Object

provinceState string

source string

supplementalCategories Arrayofstring

title string

transmissionReference string

typename string

urgency Urgency:Urgency.NONEUrgency.LOWUrgency.TWOUrgency.THREEUrgency.FOURUrgency.NORMALUrgency.SIXUrgency.SEVENUrgency.HIGH

Elementof Document.info


Contents::Index

Enumeration

DocumentMode Thedocument'scolormode.


DocumentMode.BITMAP Bitmap,whichusesoneoftwocolorvalues(blackorwhite)torepresentthepixelsinanimage.

DocumentMode.CMYK CMYK.

DocumentMode.DUOTONE Duotonemode,whichcreatesmonotone,duotone(two-color),tritone(three-color),andquadtone(four-color)grayscaleimagesusingonetofourcustominks.

DocumentMode.GRAYSCALE Grayscale.

DocumentMode.INDEXEDCOLOR Indexedcolor,in

whichthenumberofcolorsintheimageisatmost256,thestandardnumberofcolorssupportedbytheGIFandPNG-8formatsandmanymultimediaapplications.

DocumentMode.LAB Lab.

DocumentMode.MULTICHANNEL Imagewithmultiplecolorchannels.

DocumentMode.RGB RGB.

Usage AspropertyDocument.mode


Contents::Index

DocumentPrintSettings Printsettingsforadocument.

QuickLinks setPagePosition

Hierarchy


activePrinter string

backgroundColor SolidColor

bleedWidth UnitValue

caption bool

centerCropMarks bool

colorBars bool

colorHandling PrintColorHandlingPrintColorHandling.PRINTERMANAGEDPrintColorHandling.PHOTOSHOPMANAGEDPrintColorHandling.SEPARATIONSPrintColorHandling.NOTMANAGED

copies number

cornerCropMarks bool

docPosition DocPositionStyleDocPositionStyle.PRINTCENTEREDDocPositionStyle.SIZETOFITDocPositionStyle.USERDEFINED

flip bool

hardProof bool

interpolate bool

labels bool

mapBlack bool

negative bool

parent Object

posX UnitValue

posY UnitValue

printBorder UnitValue

printSelected bool

printSpace string

printers Arrayofstring

registrationMarks bool

renderIntent Intent:

Intent.PERCEPTUALIntent.SATURATIONIntent.RELATIVECOLORIMETRICIntent.ABSOLUTECOLORIMETRIC

scale number

typename string

vectorData bool

Methods InstancesvoidsetPagePosition(docPosition[,scale:number=100])Setthepositionoftheimageonthepage.Parameter Type

docPosition DocPositionStyleDocPositionStyle.PRINTCENTEREDDocPositionStyle.SIZETOFITDocPositionStyle.USERDEFINED

posX UnitValue

posY UnitValue

scale number

Elementof Document.printSettings


Contents::Index

Enumeration

EditLogItemsType Thehistorylogeditoptions.


EditLogItemsType.CONCISE Saveaconcisehistorylog.

EditLogItemsType.DETAILED Saveadetailedhistorylog.

EditLogItemsType.SESSIONONLY Saveahistoryforonlyforthesession.

Usage AspropertyPreferences.editLogItems


Contents::Index

Enumeration

ExportType Theexportoptionstouse.


ExportType.ILLUSTRATORPATHS ExportsPhotoshoppathsasAdobeIllustratorfiles.

int

ExportType.SAVEFORWEB Usesthesaveforwebexportoptions.

int

Usage InfunctionvoidDocument.exportDocument(exportIn:File[,exportAs

ExportType=ExportType.ILLUSTRATORPATHS[,options:ExportOptions])


Contents::Index

Enumeration

Extension Theformattingforthefilenameextension.


Extension.LOWERCASE Theextensionisinlowercaseletters.

int2

Extension.NONE Doesnotuseanextension.

int1

Extension.UPPERCASE Theextensionisinuppercaseletters.

int3

Usage InfunctionvoidDocument.saveAs(saveIn:File[,options:any][,

asCopy:bool][,extensionType:Extension])


Contents::Index

Enumeration

FileNamingType Filenamingoptionsforthebatchcommand.

Value Name

FileNamingType.DDMM

FileNamingType.DDMMYY

FileNamingType.DOCUMENTNAMELOWER

FileNamingType.DOCUMENTNAMEMIXED

FileNamingType.DOCUMENTNAMEUPPER

FileNamingType.EXTENSIONLOWER

FileNamingType.EXTENSIONUPPER

FileNamingType.MMDD

FileNamingType.MMDDYY

FileNamingType.SERIALLETTERLOWER

FileNamingType.SERIALLETTERUPPER

FileNamingType.SERIALNUMBER1




FileNamingType.YYDDMM

FileNamingType.YYMMDD

FileNamingType.YYYYMMDD

Usage AspropertyBatchOptions.fileNaming


Contents::Index

Enumeration

FontPreviewType ThetypesizetouseforfontpreviewsintheType

toolfontmenus.


FontPreviewType.LARGE Largetype.

FontPreviewType.MEDIUM Mediumtype.

FontPreviewType.NONE Nopreview.

FontPreviewType.SMALL Smalltype.

Usage AspropertyPreferences.fontPreviewSize


Contents::Index

Enumeration

ForcedColors Thecolorswhoseinclusiontoforceinthecolortable.


ForcedColors.BLACKWHITE Forcespureblackandwhite.

int

ForcedColors.NONE Noforcedcolors.

int

ForcedColors.PRIMARIES Forcesred,green,blue,cyan,magenta,yellow,black,andwhite.

int

ForcedColors.WEB Forcesthe216web-safecolors.

int

Usage AspropertyGIFSaveOptions.forcedIndexedConversionOptions.forced


Contents::Index

Enumeration

FormatOptions TheoptionsforsavingaJPEGfile.


FormatOptions.OPTIMIZEDBASELINE Baseline(Optimized).Optimizedcolorandaslightlyreducedfilesize.

FormatOptions.PROGRESSIVE Displaysaseriesofincreasinglydetailedscansastheimagedownloads.

FormatOptions.STANDARDBASELINE Baseline(Standard).Recognizedbymostwebbrowsers.

Usage AspropertyJPEGSaveOptions.formatOptions


Contents::Index

GalleryBannerOptions DeprecatedforAdobePhotoshopCS3,themakephotogallerymethodhasmovedtoBridge.

Class Property Type

contactInfo string

date string


fontSize int(range:1-7)

photographer string

siteName string

Elementof GalleryOptions.bannerOptions


Contents::Index

Enumeration

GalleryConstrainType DeprecatedforAdobePhotoshopCS3.Constrainvaluesforimages.

Value Name

GalleryConstrainType.CONSTRAINBOTH

GalleryConstrainType.CONSTRAINHEIGHT

GalleryConstrainType.CONSTRAINWIDTH

Usage AspropertyGalleryImagesOptions.resizeConstraint


Contents::Index

GalleryCustomColorOptions DeprecatedforAdobePhotoshopCS3,themake

photogallerymethodhasmovedtoBridge.

Class Property

activeLinkColor

backgroundColor

bannerColor

linkColor

textColor

visitedLinkColor

Elementof GalleryOptions.customColorOptions


Contents::Index

Enumeration

GalleryFontType Fontsforwebphotogallerytext.

Value Name

GalleryFontType.ARIAL

GalleryFontType.COURIERNEW

GalleryFontType.HELVETICA

GalleryFontType.TIMESNEWROMAN

Usage AspropertyContactSheetOptions.fontGalleryBannerOptions.fontGalleryImagesOptions.fontGallerySecurityOptions.fontGalleryThumbnailOptions.fontPicturePackageOptions.font


Contents::Index

GalleryImagesOptions DeprecatedforAdobePhotoshopCS3,themakephotogallerymethodhasmovedtoBridge.

Class Property Type

border int(range:0-99)

caption bool

dimension int



imageQuality int(range:0-12)

includeCopyright bool

includeCredits bool

includeFilename bool

includeTitle bool

numericLinks bool

resizeConstraint GalleryConstrainTypeGalleryConstrainType.CONSTRAINWIDTH

GalleryConstrainType.CONSTRAINHEIGHTGalleryConstrainType.CONSTRAINBOTH

resizeImages bool

Elementof GalleryOptions.imagesOptions


Contents::Index

GalleryOptions DeprecatedforAdobePhotoshopCS3,themakephotogallerymethodhas

movedtoBridge.

Class Property Type

addSizeAttributes bool

bannerOptions GalleryBannerOptions

customColorOptions GalleryCustomColorOptions

emailAddress string

imagesOptions GalleryImagesOptions

includeSubFolders bool

layoutStyle string

preserveAllMetadata bool

securityOptions GallerySecurityOptions

thumbnailOptions GalleryThumbnailOptions

useShortExtension bool

useUTF8Encoding bool

Usedin: stringApplication.makePhotoGallery(inputFolderFile[,options:GalleryOptions])


Contents::Index

GallerySecurityOptions DeprecatedforAdobePhotoshopCS3,themakephotogallerymethodhasmovedtoBridge.

Class Property Type

content GallerySecurityTypeGallerySecurityType.NONEGallerySecurityType.CUSTOMTEXTGallerySecurityType.FILENAMEGallerySecurityType.COPYRIGHTGallerySecurityType.CAPTIONGallerySecurityType.CREDITGallerySecurityType.TITLE


fontSize int(min:1)

opacity int

text string

textColor RGBColor

textPosition GallerySecurityTextPositionTypeGallerySecurityTextPositionType.CENTEREDGallerySecurityTextPositionType.UPPERLEFTGallerySecurityTextPositionType.LOWERLEFTGallerySecurityTextPositionType.UPPERRIGHTGallerySecurityTextPositionType.LOWERRIGHT

textRotate GallerySecurityTextRotateTypeGallerySecurityTextRotateType.ZEROGallerySecurityTextRotateType.CLOCKWISE45GallerySecurityTextRotateType.CLOCKWISE90

GallerySecurityTextRotateType.COUNTERCLOCKWISE45GallerySecurityTextRotateType.COUNTERCLOCKWISE90

Elementof GalleryOptions.securityOptions


Contents::Index

Enumeration

GallerySecurityTextColorType Thecolortousefortextdisplayedovergalleryimagesasan

antitheftdeterrent.

Value Name

GallerySecurityTextColorType.BLACK

GallerySecurityTextColorType.CUSTOM

GallerySecurityTextColorType.WHITE

Usage


Contents::Index

Enumeration

GallerySecurityTextPositionType Thepositionofthetextdisplayedovergalleryimagesasanantitheft

deterrent.

Value Name

GallerySecurityTextPositionType.CENTERED

GallerySecurityTextPositionType.LOWERLEFT

GallerySecurityTextPositionType.LOWERRIGHT

GallerySecurityTextPositionType.UPPERLEFT

GallerySecurityTextPositionType.UPPERRIGHT

Usage AspropertyGallerySecurityOptionsPicturePackageOptions

Jongware,28-

Aug-2012v3.0.3i Contents::Index

Enumeration

GallerySecurityTextRotateType DeprecatedforAdobePhotoshopCS3.webphotogallerysecuritytextrotation

types.

Value Name

GallerySecurityTextRotateType.CLOCKWISE45

GallerySecurityTextRotateType.CLOCKWISE90

GallerySecurityTextRotateType.COUNTERCLOCKWISE45

GallerySecurityTextRotateType.COUNTERCLOCKWISE90

GallerySecurityTextRotateType.ZERO

Usage AspropertyGallerySecurityOptionsPicturePackageOptions


Contents::Index

Enumeration

GallerySecurityType DeprecatedforAdobePhotoshopCS3.Webphotogallery

securitytypes.

Value Name

GallerySecurityType.CAPTION

GallerySecurityType.COPYRIGHT

GallerySecurityType.CREDIT

GallerySecurityType.CUSTOMTEXT

GallerySecurityType.FILENAME

GallerySecurityType.NONE

GallerySecurityType.TITLE

Usage AspropertyGallerySecurityOptions.content


Contents::Index

Enumeration

GalleryThumbSizeType DeprecatedforAdobePhotoshopCS3.Webphotogallery

thumbsizetypes.

Value Name

GalleryThumbSizeType.CUSTOM

GalleryThumbSizeType.LARGE

GalleryThumbSizeType.MEDIUM

GalleryThumbSizeType.SMALL

Usage AspropertyGalleryThumbnailOptions.size


Contents::Index

GalleryThumbnailOptions DeprecatedforAdobePhotoshopCS3,themakephotogallerymethodhasmovedtoBridge.

Class Property Type

border int(range:0-99)

caption bool

columnCount int

dimension int



includeCopyright bool

includeCredits bool


includeTitle bool

rowCount int

size GalleryThumbSizeType

GalleryThumbSizeType.SMALLGalleryThumbSizeType.MEDIUMGalleryThumbSizeType.LARGEGalleryThumbSizeType.CUSTOM

Elementof GalleryOptions.thumbnailOptions


Contents::Index

Enumeration

Geometry Geometricoptionsforshapes,suchastheirisshapein

theLensBlurFilter.


Geometry.HEPTAGON Heptagon. int4

Geometry.HEXAGON Hexagon. int2

Geometry.OCTAGON Octagon. int5

Geometry.PENTAGON Pentagon. int1

Geometry.SQUARE Square. int3

Geometry.TRIANGLE Triangle. int0

Usage InfunctionvoidArtLayer.applyLensBlur([source:

DepthMapSource=DepthMapSource.NONE][,focalDistance:int=0][,invertDepthMap:bool=false][,shape:Geometry=Geometry.HEXAGON][,radius:int=15][,bladeCurvature:int=0][,rotation:int=0][,brightness:int=0][,threshold:int=0][,amount:int=0][,distribution:NoiseDistribution=NoiseDistribution.UNIFORM][,monochromatic:bool=false])


Contents::Index

Enumeration

GridLineStyle Thelinestylefornonprintinggridsdisplayed

overimages.


GridLineStyle.DASHED Dashed. int2

GridLineStyle.DOTTED Dotted. int3

GridLineStyle.SOLID Solid. int1

Usage AspropertyPreferences.gridStyle


Contents::Index

Enumeration

GridSize Thesizeofgridsquares.


GridSize.LARGE Largegridsquares. int4

GridSize.MEDIUM Mediumgridsquares. int3

GridSize.NONE Nogridisdisplayed. int1

GridSize.SMALL Smallgridsquares. int2

Usage AspropertyPreferences.gridSize


Contents::Index

Enumeration

GuideLineStyle Thelinestylefornonprintingguidesdisplayed

overimages.


GuideLineStyle.DASHED Dashed. int

GuideLineStyle.SOLID Solid. int

Usage AspropertyPreferences.guideStyle


Contents::Index

HistoryState Aversionofthedocumentstoredautomatically

(andaddedtothehistorystatescollection,whichpreservesthedocumentstateeachtimethedocumentischanged).

Hierarchy Object

HistoryState


name string readonly Thehistorystatename.


snapshot bool readonly Iftrue,thehistorystateisasnapshot.


Elementof Document.activeHistoryBrushSourceDocument.activeHistoryState

Return HistoryStateHistoryStates.[](index:uint)HistoryStateHistoryStates.getByName(name:

string)


Contents::Index

Enumeration

IllustratorPathType Thepathstoexport.

Value Name

IllustratorPathType.ALLPATHS

IllustratorPathType.DOCUMENTBOUNDS

IllustratorPathType.NAMEDPATH

Usage AspropertyExportOptionsIllustrator.path


Contents::Index

IndexedConversionOptions OptionsforconvertinganRGBimagetoanindexedcolormodel.BaseClass:

DocumentConversionOptions

Class Property

colors

dither

ditherAmount

forced

matte

palette

preserveExactColors

transparency


Contents::Index

Enumeration

Intent Thecolorconversionintent.


Intent.ABSOLUTECOLORIMETRIC Aimstomaintaincoloraccuracyattheexpenseofpreservingrelationshipsbetweencolorsandissuitableforproofingtosimulatetheoutputofaparticulardevice.Thisintentisparticularlyusefulforpreviewinghowpapercoloraffectsprintedcolors.Leavescolorsthatfallinsidethedestinationgamutunchanged.Outofgamutcolorsareclipped.Noscalingofcolorstodestination

int4

whitepointisperformed.

Intent.PERCEPTUAL Givesprioritytocolorsforwhichthehumaneyehasgreatersensitivity.Suitableforphotographicimageswithalotofoutofgamutcolors.ThisisthestandardrenderingintentfortheJapaneseprintingindustry.

int1

Intent.RELATIVECOLORIMETRIC Comparestheextremehighlightofthesourcecolorspacetothatofthedestinationcolorspaceandshiftsallcolorsaccordingly.Outofgamutcolorsareshiftedtotheclosestreproduciblecolorinthedestination

int3

colorspace.ThestandardrenderingintentforprintinginNorthAmericaandEurope.

Intent.SATURATION Triestoproducevividcolorsinanimageattheexpenseofcoloraccuracy.Suitableforbusinessgraphicslikegraphsorcharts,wherebrightsaturatedcolorsaremoreimportantthantheexactrelationshipbetweencolors.

int2

Usage InfunctionvoidDocument.convertProfile(destinationProfile:string,intent:

Intent[,blackPointCompensation:bool][,dither:bool=true])

voidDocument.print([postScriptEncoding:PrintEncoding=PrintEncoding.BINARY][,sourceSpace:SourceSpaceType=SourceSpaceType.DOCUMENT][,

printSpace:string][,intent:Intent=Intent.RELATIVECOLORIMETRIC][,blackPointCompensation:bool=true])

AspropertyDocumentPrintSettings.renderIntent


Contents::Index

Enumeration

JavaScriptExecutionMode WhenshouldaJavaScriptdebuggerbeshown.

Value Name

JavaScriptExecutionMode.BEFORERUNNING

JavaScriptExecutionMode.NEVER

JavaScriptExecutionMode.ONRUNTIMEERROR

Usage


Contents::Index

Enumeration

Justification Theplacementofparagraphtextwithinthebounding

box.


Justification.CENTER Textiscenteredoneachline.

int

Justification.CENTERJUSTIFIED Justifiesalllinesexceptthelast,whichiscenter-aligned.

int

Justification.FULLYJUSTIFIED Justifiesalllinesincludingthelast,whichisforce-justified.

int

Justification.LEFT Alignstheleftedges,leavingtherightedgeragged.

int

Justification.LEFTJUSTIFIED Justifiesalllinesexceptthelast,whichisleft-aligned.

int

Justification.RIGHT Alignstherightedges,

int

leavingtheleftedgeragged.

Justification.RIGHTJUSTIFIED Justifiesalllinesexceptthelast,whichisright-aligned.

int

Usage AspropertyTextItem.justification


Contents::Index

Enumeration

Language Thelanguagetouse.


Language.BRAZILLIANPORTUGUESE BrazillianPortuguese.

Language.CANADIANFRENCH CanadianFrench.

Language.DANISH Danish.

Language.DUTCH Dutch.

Language.ENGLISHUK BritishEnglish.

Language.ENGLISHUSA AmericanEnglish.

Language.FINNISH Finnish.

Language.FRENCH French.

Language.GERMAN German.

Language.ITALIAN Italian.

Language.NORWEGIAN Norwegian.

Language.NYNORSKNORWEGIAN NynorskNorwegian.

Language.OLDGERMAN OldGerman.

Language.PORTUGUESE Portuguese.

Language.SPANISH Spanish.

Language.SWEDISH Swedish.

Language.SWISSGERMAN Swiss

German.

Usage AspropertyTextItem.language


Contents::Index

Layer Alayerobject.

SuperclassofArtLayer,LayerSetLayersmaycontainnestedlayers,whicharecalledsublayersintheuserinterface.Thelayerobjectcontainsallofthepageitemsinthespecificlayeraselements.Yourscriptcanaccesspageitemsaselementsofeitherthelayerobjectorthedocumentobject.

QuickLinks duplicate,link,move,moveToEnd,remove,removeAll,resize,rotate

Hierarchy Object

Layer

ArtLayer|LayerSet


allLocked bool r/w Iftrue,thelayer'scontentsandsettingsarelocked.

blendMode BlendMode:BlendMode.PASSTHROUGHBlendMode.NORMALBlendMode.DISSOLVEBlendMode.DARKENBlendMode.MULTIPLYBlendMode.COLORBURNBlendMode.LINEARBURNBlendMode.LIGHTENBlendMode.SCREENBlendMode.COLORDODGEBlendMode.LINEARDODGEBlendMode.OVERLAYBlendMode.SOFTLIGHTBlendMode.HARDLIGHTBlendMode.VIVIDLIGHTBlendMode.LINEARLIGHT

r/w Themodetousewhencompositinganobject.

BlendMode.PINLIGHTBlendMode.DIFFERENCEBlendMode.EXCLUSIONBlendMode.HUEBlendMode.SATURATIONBlendMode.COLORBLENDBlendMode.LUMINOSITYBlendMode.HARDMIXBlendMode.LIGHTERCOLORBlendMode.DARKERCOLOR

bounds UnitRect readonly BoundingrectangleoftheLayer.

linkedLayers ArrayofLayer readonly Thelayerslinkedtothislayer.

name string r/w Thenameofthelayer.

opacity number(range:0-100) r/w Thelayer'smasteropacity(asapercentage).Range:0.0to100.0.



visible bool r/w Iftrue,thelayerisvisible.

xmpMetadata XMPMetadata readonly TheXMPpropertiesofthedocument.TheCameraRAWsettingsarestoredhere.

Methods InstancesLayerduplicate([relativeObject:Object][,insertionLocation:ElementPlacementDuplicatethisobject.Parameter Type


insertionLocation ElementPlacement:ElementPlacement.PLACEAFTERElementPlacement.PLACEBEFORE

ElementPlacement.PLACEATEND

voidlink(with:Layer)Linksthelayerwiththespecifiedlayer.Parameter Type Description

with Layer Thelayertolinkto.

Layermove(relativeObject:Object,insertionLocation:ElementPlacementMovetheobject.Parameter Type



voidmoveToEnd([layerSet:LayerSet])...Parameter Type Description

layerSet LayerSet (Optional)



voidresize([horizontal:number=100][,vertical:number=100][,AnchorPosition=AnchorPosition.MIDDLECENTER])Scalestheobject.Parameter Type Description

horizontal number Theamounttoscaletheobjecthorizontally(asapercentage).(default:100

vertical number Theamounttoscaletheobjectvertically(asapercentage).(default:

100)(Optional)


Thepointtoresizeabout.(default:AnchorPosition.MIDDLECENTER(Optional)

voidrotate(angle:number[,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER])Rotatestheobject.Parameter Type Description

angle number Thenumberofdegreestorotatetheobject.


Thepointtorotateabout.(default:AnchorPosition.MIDDLECENTER(Optional)

voidtranslate([deltaX:UnitValue][,deltaY:UnitValue])Movestheobjectrelativetoitscurrentposition.Parameter Type Description

deltaX UnitValue Theamounttomovetheobjecthorizontally.(Optional)

deltaY UnitValue Theamounttomovetheobjectvertically.(Optional)

voidunlink()

Unlinksthelayer.

Elementof Document.activeLayerLayer.linkedLayers

Usedin: voidLayer.link(with:Layer)

Return LayerLayer.duplicate([relativeObject:Object][,insertionLocationLayerLayer.move(relativeObject:Object,insertionLocation:ElementPlacementLayerLayers.[](index:uint)LayerLayers.getByName(name:string)


Contents::Index

LayerComp Asnapshotofastateofthelayersinadocument

(canbeusedtoviewdifferentpagelayoutsorcompostions).

QuickLinks add,apply,recapture,remove,removeAll,resetFromComp

Hierarchy Object

LayerComp


appearance bool r/w Iftrue,useslayerappearance(layerstyles)settings.

comment any r/w Thedescriptionofthelayercomp.

name string r/w Thenameofthelayercomp.


position bool r/w Iftrue,useslayerposition.

selected bool readonly Iftrue,thelayercompiscurrentlyselected.


visibility bool r/w Iftrue,thelayercompisvisible.

Methods InstancesLayerCompadd()Addsanelement.

voidapply()Appliesthelayercomptothedocument.

voidrecapture()Recapturesthecurrentlayerstate(s)forthislayercomp.



voidresetFromComp()Resetsthelayercompstatetothedocumentstate.

Return LayerCompLayerComp.add()LayerCompLayerComps.[](index:uint)LayerCompLayerComps.add(name:string[,

comment:string][,appearance:bool=false][,position:bool=false][,visibility:bool=true])

LayerCompLayerComps.getByName(name:string)


Contents::Index

Enumeration

LayerCompression Thelayercompressiontype.


LayerCompression.RLE RunLengthEncoding,whichislossless.

LayerCompression.ZIP Zipcompression,whichislosslessandmosteffectiveforimagesthatcontainlargeareasofsinglecolor.

Usage AspropertyTiffSaveOptions.layerCompression


Contents::Index

Enumeration

LayerKind Thetypesofartlayers.


LayerKind.BLACKANDWHITE Blackandwhitelayer.

LayerKind.BRIGHTNESSCONTRAST Brightnesscontrastadjustmentlayer.

LayerKind.CHANNELMIXER Channelmixeradjustmentlayer.

LayerKind.COLORBALANCE Colorbalanceadjustmentlayer.

LayerKind.CURVES Curvesadjustmentlayer.

LayerKind.EXPOSURE Exposurelayer.

LayerKind.GRADIENTFILL Gradientfill.

LayerKind.GRADIENTMAP Gradientmapadjustmentlaye.

LayerKind.HUESATURATION Huesaturationadjustment

laye.

LayerKind.INVERSION Invertadjustmentlayer.

LayerKind.LAYER3D 3Dlayer.

LayerKind.LEVELS Levelsadjustmentlayer.

LayerKind.NORMAL Normal.

LayerKind.PATTERNFILL Patternfill.

LayerKind.PHOTOFILTER Photofilterlayer.

LayerKind.POSTERIZE Posterizeadjustmentlayer.

LayerKind.SELECTIVECOLOR Selectivecoloradjustmentlayer.

LayerKind.SMARTOBJECT Smartobjectlayer.

LayerKind.SOLIDFILL Solidcolor.

LayerKind.TEXT Text.

LayerKind.THRESHOLD Thresholdadjustmentlayer.

LayerKind.VIBRANCE Vibrancelayer.

LayerKind.VIDEO Videolayer.

Usage AspropertyArtLayer.kind


Contents::Index

LayerSet Agroupoflayerobjects,whichcanincludeartlayer

objectsandother(nested)layersetobjects.Asinglecommandorsetofcommandsmanipulatesalllayersinalayersetobject.BaseClass:Layer

QuickLinks merge

Hierarchy Object

Layer

LayerSet


artLayers ArtLayersArtLayer

readonly Theartlayerscontainedinthislayerset.

enabledChannels ArrayofChannel

r/w Thechannelsthatareenabledforthelayerset.Mustbealistofcomponentchannels.

layerSets LayerSetsLayerSet

readonly Thelayersetscontainedwithinthelayerset.

layers LayersLayer

readonly Thelayersinthislayerset.



Methods InstancesArtLayermerge()Mergesthelayerset.

Usedin: voidLayer.moveToEnd([layerSet:LayerSet])

Return LayerSetLayerSets.[](index:uint)LayerSetLayerSets.add()LayerSetLayerSets.getByName(name:string)


Contents::Index

Enumeration

MagnificationType ThePDFmagnificationtype.


MagnificationType.ACTUALSIZE Displaystheimageatactualsize.

MagnificationType.FITPAGE Fitstheimagetothepage.

Usage AspropertyPresentationOptions.magnification


Contents::Index

Enumeration

MatteType Thecolortouseformatting.


MatteType.BACKGROUND Thecurrentbackgroundcolor.

int3

MatteType.BLACK Black. int5

MatteType.FOREGROUND Thecurrentforegroundcolor.

int2

MatteType.NETSCAPE Gray. int7

MatteType.NONE None. int1

MatteType.SEMIGRAY 50%gray. int6

MatteType.WHITE White. int4

Usage AspropertyGIFSaveOptions.matteIndexedConversionOptions.matteJPEGSaveOptions.matte


Contents::Index

MeasurementLog Thelogofmeasurementstaken.

QuickLinks deleteMeasurements,exportMeasurements

Hierarchy Object

MeasurementLog




Methods InstancesvoiddeleteMeasurements([range:MeasurementRangeDeletesthespecifiedmeasurements.Parameter Type

range MeasurementRange:MeasurementRange.ALLMEASUREMENTSMeasurementRange.ACTIVEMEASUREMENTS

voidexportMeasurements([file:File][,dataPoints:Arrayofstring])Exportsthespecifiedmeasurements.Parameter Type

file File

range MeasurementRange:MeasurementRange.ALLMEASUREMENTSMeasurementRange.ACTIVEMEASUREMENTS

dataPoints Arrayofstring

Elementof Application.measurementLog


Contents::Index

Enumeration

MeasurementRange Themeasurementuponwhichtotakeaction.

Value Name

MeasurementRange.ACTIVEMEASUREMENTS

MeasurementRange.ALLMEASUREMENTS

Usage InfunctionvoidMeasurementLog.deleteMeasurementsvoidMeasurementLog.exportMeasurements

MeasurementRange][,dataPoints


Contents::Index

MeasurementScale Themeasurementscaleforthedocument.

Hierarchy Object

MeasurementScale


logicalLength number r/w Thelogicallengththisscaleequatesto.

logicalUnits string r/w Thelogicalunitsforthisscale.

name string r/w Thenameofthescale.


pixelLength int r/w Thelength(inpixels)towhichthisscaleequates.


Elementof Document.measurementScale


Contents::Index

Enumeration

MeasurementSource Thesourceforrecordingmeasurements.

Value Name

MeasurementSource.MEASURECOUNTTOOL

MeasurementSource.MEASURERULERTOOL

MeasurementSource.MEASURESELECTION

Usage InfunctionvoidDocument.recordMeasurements

dataPoints:Arrayofstring])


Contents::Index

Enumeration

NewDocumentMode Thecolorprofiletouse.

Value Name

NewDocumentMode.BITMAP

NewDocumentMode.CMYK

NewDocumentMode.GRAYSCALE

NewDocumentMode.LAB

NewDocumentMode.RGB

Usage InfunctionDocumentDocuments.add([width:

UnitValue][,resolution:numbermode:NewDocumentMode=NewDocumentMode.RGBinitialFill:DocumentFill=DocumentFill.WHITEpixelAspectRatio:number=1.0BitsPerChannelType=BitsPerChannelType.EIGHT[,colorProfileName:string])

AspropertyContactSheetOptions.modePicturePackageOptions.mode


Contents::Index

Enumeration

OpenDocumentMode Thecolorprofiletouse.

Value Name

OpenDocumentMode.CMYK

OpenDocumentMode.GRAYSCALE

OpenDocumentMode.LAB

OpenDocumentMode.RGB

Usage AspropertyEPSOpenOptions.modePDFOpenOptions.mode


Contents::Index

Enumeration

OpenDocumentType DocumentformatsthatPhotoshopcanopen.

Value Name

OpenDocumentType.ALIASPIX

OpenDocumentType.BMP

OpenDocumentType.CAMERARAW

OpenDocumentType.COMPUSERVEGIF

OpenDocumentType.DICOM

OpenDocumentType.ELECTRICIMAGE

OpenDocumentType.EPS

OpenDocumentType.EPSPICTPREVIEW

OpenDocumentType.EPSTIFFPREVIEW

OpenDocumentType.FILMSTRIP

OpenDocumentType.JPEG

OpenDocumentType.PCX

OpenDocumentType.PDF

OpenDocumentType.PHOTOCD

OpenDocumentType.PHOTOSHOP

OpenDocumentType.PHOTOSHOPDCS_1

OpenDocumentType.PHOTOSHOPDCS_2

OpenDocumentType.PHOTOSHOPEPS

OpenDocumentType.PHOTOSHOPPDF

OpenDocumentType.PICTFILEFORMAT

OpenDocumentType.PICTRESOURCEFORMAT

OpenDocumentType.PIXAR

OpenDocumentType.PNG

OpenDocumentType.PORTABLEBITMAP

OpenDocumentType.RAW

OpenDocumentType.SCITEXCT

OpenDocumentType.SGIRGB

OpenDocumentType.SOFTIMAGE

OpenDocumentType.TARGA

OpenDocumentType.TIFF

OpenDocumentType.WAVEFRONTRLA

OpenDocumentType.WIRELESSBITMAP

Usage


Contents::Index

Enumeration

OperatingSystem Theoperatingsystem.


OperatingSystem.OS2 MacOS/2operatingsystem.

OperatingSystem.WINDOWS Windowsoperatingsystem.

Usage AspropertyBMPSaveOptions.osType


Contents::Index

Enumeration

Orientation Theimageorientationonthemedia.


Orientation.LANDSCAPE Landscape. int1

Orientation.PORTRAIT Portrait. int2

Usage AspropertyPhotoCDOpenOptions.orientation


Contents::Index

Enumeration

OtherPaintingCursors Thepointerforthefollowingtools:Eraser,Pencil,Paintbrush,

HealingBrush,RubberStamp,PatternStamp,Smudge,Blur,Sharpen,Dodge,Burn,Sponge.

Value Name

OtherPaintingCursors.PRECISEOTHER

OtherPaintingCursors.STANDARDOTHER

Usage AspropertyPreferences.otherCursors


Contents::Index

Enumeration

PDFCompatibility ThePDFversionwithwhichtomakethe

documentcompatible.


PDFCompatibility.PDF13 PDF1.3(Acrobat4orhigher).



PDFCompatibility.PDF16 PDF1.6(Acrobat7orhigher)

PDFCompatibility.PDF17 PDF1.7(Acrobat9orhigher)

Usage AspropertyPDFSaveOptions.PDFCompatibility


Contents::Index

Enumeration

PDFResample DownsamplingoptionswhensavingasPDF.


PDFResample.NONE Doesnotdownsample.

PDFResample.PDFAVERAGE Averagesthepixelsinasampleareaandreplacestheentireareawiththeaveragepixelcoloratthespecifiedresolution.

PDFResample.PDFBICUBIC Usesaweightedaveragetodeterminepixelcolor,whichusuallyyieldsbetterresultsthanthesimpleaveragingmethodofdownsampling.Theslowestbutmostprecisemethod,resultinginthesmoothestgradations.

PDFResample.PDFSUBSAMPLE Choosesapixelinthecenterofthesampleareaandreplacestheentireareawiththatpixelcolor;significantlyreducesconversiontimebutresultsinimagesthatarelesssmoothandcontinuous.

Usage AspropertyPDFSaveOptions.downSample


Contents::Index

Enumeration

PDFStandard ThePDF/Xstandardwithwhichthedocument

complies.


PDFStandard.NONE ThedocumentdoesnotusethePDF/Xstandard.

int0

PDFStandard.PDFX1A2001 PDF/X-1astandard,whichrequiresallfontstobeembedded,theappropriatePDFboundingboxestobespecified,andcolortoappearasCMYK,spotcolors,orboth;canbeopenedinAcrobat4.0andAcrobatReader4.0andlater.

int1

PDFStandard.PDFX1A2003 PDF/X-1astandard,which

int2

requiresallfontstobeembedded,theappropriatePDFboundingboxestobespecified,andcolortoappearasCMYK,spotcolors,orboth;canbeopenedinAcrobat4.0andAcrobatReader4.0andlater.

PDFStandard.PDFX32002 PDF/X-3standard,whichrequiresallfontstobeembeddedandtheappropriatePDFboundingboxestobespecified,andforcolorallowseithertheuseofcolormanagementanddevice-independent

int3

color(CIEL*a*b,ICC-basedcolorspaces,CalRGB,andCalGray)orCMYK,spotcolors,orboth;canbeopenedinAcrobat4.0andAcrobatReader4.0andlater.

PDFStandard.PDFX32003 PDF/X-3standard,whichrequiresallfontstobeembeddedandtheappropriatePDFboundingboxestobespecified,andforcolorallowseithertheuseofcolormanagementanddevice-independentcolor(CIEL*a*b,ICC-basedcolorspaces,

int4

CalRGB,andCalGray)orCMYK,spotcolors,orboth;canbeopenedinAcrobat4.0andAcrobatReader4.0andlater.

PDFStandard.PDFX42008 PDF/X-4standard,whichrequiresallfontstobeembeddedandtheappropriatePDFboundingboxestobespecified,andforcolorallowseithertheuseofcolormanagementanddevice-independentcolor(CIEL*a*b,ICC-basedcolorspaces,CalRGB,andCalGray)orCMYK,

int5

spotcolors,orboth;canbeopenedinAcrobat4.0andAcrobatReader4.0andlater.

Usage AspropertyPDFSaveOptions.PDFStandard


Contents::Index

Enumeration

PICTCompression ThecompressiontypetousewhansavingasPICT.

Value Name

PICTCompression.JPEGHIGHPICT

PICTCompression.JPEGLOWPICT

PICTCompression.JPEGMAXIMUMPICT

PICTCompression.JPEGMEDIUMPICT

PICTCompression.NONE

Usage AspropertyPICTFileSaveOptions.compressionPICTResourceSaveOptions.compression


Contents::Index

Enumeration

PaintingCursors Thepointerforthefollowingtools:Marquee,Lasso,

PolygonalLasso,MagicWand,Crop,Slice,PatchEyedropper,Pen,Gradient,Line,PaintBucket,MagneticLasso,MagneticPen,FreeformPen,Measure,andColorSampler.


PaintingCursors.BRUSHSIZE Displayscursorsasbrushshapesrepresentingthesizeofthecurrentbrush.Validonlyforpaintingcursors.Brushsizecursorsmaynotappearforverylargebrushes.

PaintingCursors.PRECISE Displayspointersascrosshairs.

PaintingCursors.STANDARD Displayspointersastoolicons.

Usage AspropertyPreferences.paintingCursors


Contents::Index

Enumeration

Palette Thepalettetypeforconvertinganimagetoindexedcolor.


Palette.EXACT ThepaletteusestheexactcolorsappearingintheRGBimage;availableonlyiftheimageuses256orfewercolors.Becausetheimage'spalettecontainsallcolorsintheimage,thereisnodithering.

int1

Palette.LOCALADAPTIVE Createsapalettebysamplingthecolorsfromthespectrumappearingmostcommonlyintheimage.Forexample,anRGBimagewithonlythecolorsgreenandblueproducesapalettemadeprimarilyofgreensandblues.

int8

Palette.LOCALPERCEPTUAL Createsa int6

custompalettebygivingprioritytocolorsforintheimagewhichthehumaneyehasgreatersensitivity.

Palette.LOCALSELECTIVE CreatesacolortablesimilartothePerceptualcolortable,butfavoringbroadareasofcolorintheimageandthepreservationofwebcolors.Usuallyproducesimageswiththegreatestcolorintegrity.

int7

Palette.MACOSPALETTE TheMacOSdefault8-bitpalette,whchisbasedonauniformsamplingofRGBcolors.

int2

Palette.MASTERADAPTIVE Createsapalettebysamplingthecolorsfromthespectrumappearingmostcommonlyinagroupofopenimagesthatsharethesame

int11

colorpalette.

Palette.MASTERPERCEPTUAL Createsacustompalettebygivingprioritytocolorsinagroupofopenimageswiththesamecolorpaletteforwhichthehumaneyehasgreatersensitivity.

int9

Palette.MASTERSELECTIVE CreatesacolortablesimilartotheMasterPerceptualcolortable,butfavoringbroadareasofcolorandthepreservationofwebcolors.

int10

Palette.PREVIOUSPALETTE Usesthecustompalettefromthepreviousconversion,makingiteasytoconvertseveralimageswiththesamecustompalette.

int12

Palette.UNIFORM CreatesapalettebyuniformlysamplingcolorsfromtheRGB

int5

colorcube.Forexample,ifPhotoshoptakessixevenlyspacedcolorlevelseachofred,green,andblue,thecombinationproducesauniformpaletteof216colors(6cubed=6x6x6=216).Thetotalnumberofcolorsdisplayedinanimagecorrespondstothenearestperfectcube(8,27,64,125,or216)thatislessthanthevalueintheColorstextbox.

Palette.WEBPALETTE The216-colorpalettethatwebbrowsers,regardlessofplatform,usetodisplayimagesonamonitorlimitedto256colors.AsubsetoftheMacOS8-bitpalette.Usethisoptiontoavoid

int4

browserditherwhenviewingimagesonamonitordisplaylimitedto256colors.

Palette.WINDOWSPALETTE TheWindowssystem'sdefault8-bitpalette,whchisbasedonauniformsamplingofRGBcolors.

int3

Usage AspropertyGIFSaveOptions.paletteIndexedConversionOptions.palette


Contents::Index

Enumeration

PhotoCDColorSpace DeprecatedforAdobePhotoshopCS3.


PhotoCDColorSpace.LAB16 Labwith16bitsperchannel.

PhotoCDColorSpace.LAB8 Labwith8bitsperchannel.

PhotoCDColorSpace.RGB16 RGBwith16bitsperchannel.

PhotoCDColorSpace.RGB8 RGBwith8bitsperchannel.

Usage AspropertyPhotoCDOpenOptions.colorSpace


Contents::Index

PicturePackageOptions OptionsthatcanbespecifiedforaPicturePackage.

Class Property Type

content PicturePackageTextTypePicturePackageTextType.NONEPicturePackageTextType.USERPicturePackageTextType.FILENAMEPicturePackageTextType.COPYRIGHTPicturePackageTextType.CAPTIONPicturePackageTextType.CREDITPicturePackageTextType.ORIGIN

flatten bool


fontSize int

layout string

mode NewDocumentModeNewDocumentMode.GRAYSCALENewDocumentMode.RGBNewDocumentMode.CMYKNewDocumentMode.LABNewDocumentMode.BITMAP

opacity int

resolution number

text string

textColor RGBColor

textPosition GallerySecurityTextPositionTypeGallerySecurityTextPositionType.CENTEREDGallerySecurityTextPositionType.UPPERLEFTGallerySecurityTextPositionType.LOWERLEFTGallerySecurityTextPositionType.UPPERRIGHTGallerySecurityTextPositionType.LOWERRIGHT

textRotate GallerySecurityTextRotateTypeGallerySecurityTextRotateType.ZEROGallerySecurityTextRotateType.CLOCKWISE45GallerySecurityTextRotateType.CLOCKWISE90GallerySecurityTextRotateType.COUNTERCLOCKWISE45GallerySecurityTextRotateType.COUNTERCLOCKWISE90

Usedin: stringApplication.makePicturePackage


Contents::Index

Enumeration

PicturePackageTextType ThefunctionormeaningoftextinaPicturePackage.

Value Name

PicturePackageTextType.CAPTION

PicturePackageTextType.COPYRIGHT

PicturePackageTextType.CREDIT

PicturePackageTextType.FILENAME

PicturePackageTextType.NONE

PicturePackageTextType.ORIGIN

PicturePackageTextType.USER

Usage AspropertyPicturePackageOptions.content


Contents::Index

Enumeration

PointType Thepointtype.


PointType.POSTSCRIPT 72pointsperinch.

int1

PointType.TRADITIONAL 72.27pointsperinch.

int2

Usage AspropertyPreferences.pointSize


Contents::Index

Preferences Optionstodefineforthepreferencespropertyoftheapplicationobject,basicallyequivalenttoselectingEdit

>Preferences(Windows)orPhotoshop>PreferencesintheAdobePhotoshopapplication.

Hierarchy Object

Preferences


additionalPluginFolder File

appendExtension SaveBehavior:SaveBehavior.NEVERSAVESaveBehavior.ALWAYSSAVESaveBehavior.ASKWHENSAVING

askBeforeSavingLayeredTIFF bool

autoUpdateOpenDocuments bool

beepWhenDone bool

colorChannelsInColor bool

colorPicker ColorPicker:ColorPicker.ADOBEColorPicker.APPLEColorPicker.WINDOWSColorPicker.PLUGIN

columnGutter number

columnWidth number

createFirstSnapshot bool

dynamicColorSliders bool

editLogItems EditLogItemsType:EditLogItemsType.SESSIONONLYEditLogItemsType.CONCISEEditLogItemsType.DETAILED

exportClipboard bool

fontPreviewSize FontPreviewType:FontPreviewType.NONEFontPreviewType.SMALLFontPreviewType.MEDIUMFontPreviewType.LARGE

fullSizePreview bool

gamutWarningOpacity number

gridSize GridSize:GridSize.NONEGridSize.SMALLGridSize.MEDIUMGridSize.LARGE

gridStyle GridLineStyle:GridLineStyle.SOLIDGridLineStyle.DASHEDGridLineStyle.DOTTED

gridSubDivisions int

guideStyle GuideLineStyle:GuideLineStyle.SOLIDGuideLineStyle.DASHED

iconPreview bool

imageCacheForHistograms bool

imageCacheLevels int

imagePreviews SaveBehavior:SaveBehavior.NEVERSAVESaveBehavior.ALWAYSSAVESaveBehavior.ASKWHENSAVING

interpolation ResampleMethod:ResampleMethod.NONEResampleMethod.NEARESTNEIGHBORResampleMethod.BILINEARResampleMethod.BICUBICResampleMethod.BICUBICSHARPERResampleMethod.BICUBICSMOOTHER

keyboardZoomResizesWindows bool

macOSThumbnail bool

maxRAMuse int(range:5-100)

maximizeCompatibility QueryStateType:QueryStateType.ALWAYSQueryStateType.ASKQueryStateType.NEVER

nonLinearHistory bool

numberOfHistoryStates int

otherCursors OtherPaintingCursorsOtherPaintingCursors.STANDARDOTHEROtherPaintingCursors.PRECISEOTHER

paintingCursors PaintingCursors:PaintingCursors.STANDARDPaintingCursors.PRECISEPaintingCursors.BRUSHSIZE

parent Object

pixelDoubling bool

pointSize PointType:PointType.POSTSCRIPTPointType.TRADITIONAL

recentFileListLength int

rulerUnits Units:Units.PIXELSUnits.INCHESUnits.CMUnits.MMUnits.POINTSUnits.PICASUnits.PERCENT

saveLogItems SaveLogItemsTypeSaveLogItemsType.METADATASaveLogItemsType.LOGFILESaveLogItemsType.LOGFILEANDMETADATA

saveLogItemsFile File

savePaletteLocations bool

showAsianTextOptions bool

showEnglishFontNames bool

showSliceNumber bool

showToolTips bool

smartQuotes bool

typeUnits TypeUnits:TypeUnits.PIXELSTypeUnits.MMTypeUnits.POINTS

typename string

useAdditionalPluginFolder bool

useDiffusionDither bool

useHistoryLog bool

useLowerCaseExtension bool

useShiftKeyForToolSwitch bool

useVideoAlpha bool

windowsThumbnail bool

Elementof Application.preferences


Contents::Index

PresentationOptions OptionsforthePDFpresentationcommand.

Class Property Type

PDFFileOptions PDFSaveOptions

autoAdvance bool


interval int

loop bool

magnification MagnificationTypeMagnificationType.ACTUALSIZEMagnificationType.FITPAGE

presentation bool

transition TransitionType:TransitionType.BLINDSHORIZONTALTransitionType.BLINDSVERTICALTransitionType.DISSOLVETransitionType.BOXINTransitionType.BOXOUTTransitionType.GLITTERDOWNTransitionType.GLITTERRIGHTTransitionType.GLITTERRIGHTDOWNTransitionType.NONETransitionType.RANDOM

TransitionType.SPLITHORIZONTALINTransitionType.SPLITHORIZONTALOUTTransitionType.SPLITVERTICALINTransitionType.SPLITVERTICALOUTTransitionType.WIPEDOWNTransitionType.WIPELEFTTransitionType.WIPERIGHTTransitionType.WIPEUP

Usedin: stringApplication.makePDFPresentationPresentationOptions])


Contents::Index

Enumeration

Preview Thetypeofimagetouseasalow-resolutionpreviewinthe

destinationapplication.


Preview.EIGHTBITTIFF 8-bitTIFF. int3

Preview.MACOSEIGHTBIT 8-bit. int5

Preview.MACOSJPEG JPEG. int6

Preview.MACOSMONOCHROME Monochrome. int4

Preview.MONOCHROMETIFF MonochromeTIFF.

int2

Preview.NONE Doesnotuseapreview.

int1

Usage AspropertyDCS1_SaveOptions.previewDCS2_SaveOptions.previewEPSSaveOptions.preview


Contents::Index

Enumeration

PrintColorHandling Colorconversiontypewhenprinting.

Value Name

PrintColorHandling.NOTMANAGED

PrintColorHandling.PHOTOSHOPMANAGED

PrintColorHandling.PRINTERMANAGED

PrintColorHandling.SEPARATIONS

Usage AspropertyDocumentPrintSettings.colorHandling


Contents::Index

Enumeration

PrintEncoding EncodingtousewhenprintingPostScript.


PrintEncoding.ASCII ASCII85encoding.ASCII85filescontainabouttwiceasmanycharactersandtaketwiceaslongtotransferasbinaryfiles.

int

PrintEncoding.BINARY Binaryencoding.Someprintspoolerprograms,computernetworks,andthird-partyprinterdriversdon'tsupportbinaryfiles.

int

PrintEncoding.JPEG JPEGencoding.JPEG-encodedfilesaresmallerthanbinaryfilesandtakelesstimetoprint;however,imagequalityisdecreased.OnlyPostScrptLevel2orhigherprinterssupportJPEGencoding.Someprintspooler

int

programs,computernetworks,andthird-partyprinterdriversdon'tsupportJPEG-encodedfiles.

Usage InfunctionvoidDocument.print([postScriptEncoding:

PrintEncoding=PrintEncoding.BINARYsourceSpace:SourceSpaceType=SourceSpaceType.DOCUMENT[,printSpace:string][,intent:Intent=Intent.RELATIVECOLORIMETRICblackPointCompensation:bool=true])


Contents::Index

Enumeration

PurgeTarget Thecachetobetargetedinapurgeoperation.


PurgeTarget.ALLCACHES Clearsallcaches.

int

PurgeTarget.CLIPBOARDCACHE Clearstheclipboard.

int

PurgeTarget.HISTORYCACHES DeletesallhistorystatesfromtheHistorypalette.

int

PurgeTarget.UNDOCACHES Clearstheundocache.

int

Usage InfunctionvoidApplication.purge(target:PurgeTarget)


Contents::Index

Enumeration

QueryStateType Thepermissionstateforqueries.


QueryStateType.ALWAYS Alwaysmaximizecompatibility.

QueryStateType.ASK Alwaysaskaboutmaximizecompatibility.

QueryStateType.NEVER Neveraskaboutmaximizecompatibility.

Usage AspropertyPreferences.maximizeCompatibility


Contents::Index

Enumeration

RasterizeType Thetypeofthelayercontenttorasterize.


RasterizeType.ENTIRELAYER Rasterizesallvectordataonthelayer.

RasterizeType.FILLCONTENT Rasterizesthefillofashapelayer,leavingthevectormask.

RasterizeType.LAYERCLIPPINGPATH Rasterizesthevectormaskofashapelayer,turningitintoalayermask.

RasterizeType.LINKEDLAYERS Rasterizestheselectedlayers.

RasterizeType.SHAPE Rasterizesashapelayer.

RasterizeType.TEXTCONTENTS Rasterizesthetypeonatypelayer.Doesn'trasterizeanyothervectordata

onthelayer.

Usage InfunctionvoidArtLayer.rasterize(target:RasterizeType)


Contents::Index

Enumeration

ResampleMethod Themethodtousetoresampletheimage.

Value Name

ResampleMethod.BICUBIC

ResampleMethod.BICUBICSHARPER

ResampleMethod.BICUBICSMOOTHER

ResampleMethod.BILINEAR

ResampleMethod.NEARESTNEIGHBOR

ResampleMethod.NONE

Usage InfunctionvoidDocument.resizeImage([width:UnitValue

[,resolution:number][,resampleMethodResampleMethod=ResampleMethod.BICUBIC

AspropertyPreferences.interpolation


Contents::Index

Enumeration

ResetTarget Thetypeofobject(s)toresettodefaultsettings.


ResetTarget.ALLTOOLS Tools. int2

ResetTarget.ALLWARNINGS Warningdialogs.

int1

ResetTarget.EVERYTHING Alltargets. int3

Usage


Contents::Index

Enumeration

SaveBehavior Theapplication'sbehaviorregardingimagepreviewsand

fileextensionswhenasavemethodiscalled.


SaveBehavior.ALWAYSSAVE Alwayssavetheitemwiththefile.

SaveBehavior.ASKWHENSAVING Prompttheuserwhethertosavetheitemwiththefile.

SaveBehavior.NEVERSAVE Neversavetheitemwiththefile.

Usage AspropertyPreferences.imagePreviewsPreferences.appendExtension


Contents::Index

Enumeration

SaveDocumentType DocumentformatsthatPhotoshopcansaveto.

Value Name

SaveDocumentType.ALIASPIX

SaveDocumentType.BMP

SaveDocumentType.COMPUSERVEGIF

SaveDocumentType.ELECTRICIMAGE

SaveDocumentType.JPEG

SaveDocumentType.PCX

SaveDocumentType.PHOTOSHOP

SaveDocumentType.PHOTOSHOPDCS_1

SaveDocumentType.PHOTOSHOPDCS_2

SaveDocumentType.PHOTOSHOPEPS

SaveDocumentType.PHOTOSHOPPDF

SaveDocumentType.PICTFileFORMAT

SaveDocumentType.PICTRESOURCEFORMAT

SaveDocumentType.PIXAR

SaveDocumentType.PNG

SaveDocumentType.PORTABLEBITMAP

SaveDocumentType.RAW

SaveDocumentType.SCITEXCT

SaveDocumentType.SGIRGB

SaveDocumentType.SOFTIMAGE

SaveDocumentType.TARGA

SaveDocumentType.TIFF

SaveDocumentType.WAVEFRONTRLA

SaveDocumentType.WIRELESSBITMAP

Usage AspropertyExportOptionsSaveForWeb.format


Contents::Index

Enumeration

SaveEncoding Theencodingtousewhensavingdocuments.


SaveEncoding.ASCII ASCII.

SaveEncoding.BINARY Binary.

SaveEncoding.JPEGHIGH HighqualityJPEGencoding.

SaveEncoding.JPEGLOW LowqualityJPEGencoding(highamountofcompression).

SaveEncoding.JPEGMAXIMUM MaximumqualityJPEGencoding(verylittlecompression).

SaveEncoding.JPEGMEDIUM MediumqualityJPEGencoding(mediumcompression).

Usage AspropertyDCS1_SaveOptions.encodingDCS2_SaveOptions.encodingEPSSaveOptions.encoding


Contents::Index

Enumeration

SaveLogItemsType Thelocationofhistorylogdata.

Value Name

SaveLogItemsType.LOGFILE

SaveLogItemsType.LOGFILEANDMETADATA

SaveLogItemsType.METADATA

Usage AspropertyPreferences.saveLogItems


Contents::Index

SaveOptions Optionsforsavingafile.

SuperclassofBMPSaveOptions,DCS1_SaveOptionsDCS2_SaveOptions,EPSSaveOptions,GIFSaveOptionsJPEGSaveOptions,PDFSaveOptions,PICTFileSaveOptionsPICTResourceSaveOptions,PNGSaveOptions,PhotoshopSaveOptions,PixarSaveOptions,RawSaveOptionsSGIRGBSaveOptions,TargaSaveOptions,andTiffSaveOptions

Class Property Type Access Description

DONOTSAVECHANGES int readonly Donotsavechanges.(default:

PROMPTTOSAVECHANGES int readonly Asktheuserwhethertosave.(default:3

SAVECHANGES int readonly Savechanges.(default:

Usedin: voidDocument.close([saving:SaveOptions=SaveOptions.PROMPTTOSAVECHANGES


Contents::Index

Enumeration

SaveOptions Optionsforsavingafile.


SaveOptions.DONOTSAVECHANGES Donotsavechanges.

SaveOptions.PROMPTTOSAVECHANGES Asktheuserwhethertosave.

SaveOptions.SAVECHANGES Savechanges.

Usage InfunctionvoidDocument.close([saving:

SaveOptions=SaveOptions.PROMPTTOSAVECHANGES


Contents::Index

Selection Theselectedareaofthedocumentorlayer.

QuickLinks clear,contract,copy,cut,deselect,expand,feather,fill,growresize,resizeBoundary,rotate,rotateBoundary,select,selectAllstore,stroke,translate,translateBoundary

Hierarchy Object

Selection


bounds UnitRect readonly Theboundingrectangleoftheentireselection.


solid bool readonly Iftrue,theboundingrectangleasolidrectangle.


Methods Instancesvoidclear()Clearstheselectionanddoesnotcopyittotheclipboard.

voidcontract(by:UnitValue)Contractstheselection.Parameter Type Description

by UnitValue Theamounttocontracttheselection.

voidcopy([merge:bool])Copiestheselectiontotheclipboard.Parameter Type Description

merge bool Iftruethecopyincludesallvisiblelayers.Iffalse,copiesonlyfromthecurrentlayer.(Optional)

voidcut()

Cutsthecurrentselectiontotheclipboard.

voiddeselect()Deselectsthecurrentselection.

voidexpand(by:UnitValue)Expandstheselection.Parameter Type Description

by UnitValue Theamounttoexpandtheselection.

voidfeather(by:UnitValue)Featherstheedgesoftheselection.Parameter Type Description

by UnitValue Theamounttofeathertheedge.

voidfill(fillType:any[,mode:ColorBlendMode=ColorBlendMode.NORMALint=100][,preserveTransparency:bool])Fillstheselection.Parameter Type

fillType any

mode ColorBlendMode:ColorBlendMode.NORMALColorBlendMode.DISSOLVEColorBlendMode.BEHINDColorBlendMode.CLEARColorBlendMode.DARKENColorBlendMode.MULTIPLYColorBlendMode.COLORBURNColorBlendMode.LINEARBURNColorBlendMode.LIGHTENColorBlendMode.SCREENColorBlendMode.COLORDODGEColorBlendMode.LINEARDODGEColorBlendMode.OVERLAYColorBlendMode.SOFTLIGHTColorBlendMode.HARDLIGHT

ColorBlendMode.VIVIDLIGHTColorBlendMode.LINEARLIGHTColorBlendMode.PINLIGHTColorBlendMode.DIFFERENCEColorBlendMode.EXCLUSIONColorBlendMode.HUEColorBlendMode.SATURATIONColorBlendMode.COLORColorBlendMode.LUMINOSITYColorBlendMode.HARDMIXBLEND

opacity int

preserveTransparency bool

voidgrow(tolerance:int,antiAlias:bool)Growstheselectiontoincludealladjacentpixelsfallingwithinthespecifiedtolerancerange.Parameter Type Description

tolerance int(range:0-255) Thetolerancerange.Range:0to255.

antiAlias bool Iftrue,anti-aliasingisused.

voidinvert()Invertstheselection.

voidload(from:Channel[,combination:SelectionType=SelectionType.REPLACEinverting:bool=false])Loadstheselectionfromthespecifiedchannel.Parameter Type Description

from Channel Thechanneltoloadtheselectionfrom.

combination SelectionType:SelectionType.REPLACESelectionType.EXTENDSelectionType.DIMINISHSelectionType.INTERSECT

Howtocombinethechannelcontentswiththeexistingselection.(default:SelectionType.REPLACE

inverting bool Iftrue,selectstheinverseofthechannelcontents.(default:false)(Optional)

voidmakeWorkPath([tolerance:number])Makesthisselectionitemtheworkpathforthisdocument.Parameter Type Description

tolerance number Thetoleranceinpixels.(Optional)

voidresize([horizontal:number=100][,vertical:number=100AnchorPosition=AnchorPosition.MIDDLECENTER])Resizestheselectedareatothespecifieddimensionsandanchorposition.Parameter Type Description

horizontal number Theamounttoscaletheselectionhorizontally(asapercentage).(default:100)(Optional)

vertical number Theamounttoscaletheselectionvertically(asapercentage).(default:


Thepointtoscalearound.(default:AnchorPosition.MIDDLECENTER(Optional)

voidresizeBoundary([horizontal:number=100][,vertical:AnchorPosition=AnchorPosition.MIDDLECENTER])Scalestheboundaryoftheselection.Parameter Type Description

horizontal number Theamounttoscaletheobjecthorizontally(asapercentage).(default:

vertical number Theamounttoscaletheobjectvertically

(asapercentage).(default:


Thepointtoscalearound.(default:AnchorPosition.MIDDLECENTER(Optional)

voidrotate(angle:number[,anchor:AnchorPosition=AnchorPosition.MIDDLECENTERRotatestheobject.Parameter Type Description

angle number Thenumberofdegreestorotatetheobject.



voidrotateBoundary(angle:number[,anchor:AnchorPosition=AnchorPosition.MIDDLECENTER])Rotatestheboundaryoftheselection.Parameter Type Description

angle number Therotationangle(indegrees)

anchor AnchorPosition:AnchorPosition.TOPLEFTAnchorPosition.TOPCENTERAnchorPosition.TOPRIGHT


AnchorPosition.MIDDLELEFTAnchorPosition.MIDDLECENTERAnchorPosition.MIDDLERIGHTAnchorPosition.BOTTOMLEFTAnchorPosition.BOTTOMCENTERAnchorPosition.BOTTOMRIGHT

voidselect(region:Arrayofany[,type:SelectionType=SelectionType.REPLACEnumber=0][,antiAlias:bool=true])Selectsthespecifiedregion.Parameter Type Description

region Arrayofany Arrayofxandycoordinatesthatdescribethecornersoftheselection,intheformat[[x1,y1],[x2,y2],[x3,y3],[x4,y4]]

type SelectionType:SelectionType.REPLACESelectionType.EXTENDSelectionType.DIMINISHSelectionType.INTERSECT

Themethodforcombiningthenewselectionwiththeexistingselection.(default:SelectionType.REPLACE

feather number Thefeatheramount.(default:

antiAlias bool Iftrue,anti-aliasingisused.(default:(Optional)

voidselectAll()Selectstheentirelayer.

voidselectBorder(width:UnitValue)Selectstheselectionborderonly(inthespecifiedwidth);subsequentactionsdonotaffecttheselectedareawithintheborders.Parameter Type Description

width UnitValue Thewidthoftheborderselection.

voidsimilar(tolerance:int,antiAlias:bool)Growstheselectiontoincludepixelsthroughouttheimagefallingwithinthetolerancerange.Parameter Type Description

tolerance int Thetolerancerange.Range:0to255.

antiAlias bool Iftrue,anti-aliasingisused.

voidsmooth(radius:int)Cleansupstraypixelsleftinsideoroutsideacolor-basedselection(withintheradiusspecifiedinpixels).Parameter Type Description

radius int(range:0-100) Thesampleradiusinpixels.Range:0to100.

voidstore(into:Channel[,combination:SelectionType=SelectionType.REPLACESavestheselectionasachannel.Parameter Type Description

into Channel Thechanneltosavetheselectionto.

combination SelectionType:SelectionType.REPLACESelectionType.EXTENDSelectionType.DIMINISHSelectionType.INTERSECT

Howtoaddtheselectiontotheexistingcontentsofthechannel.(default:SelectionType.REPLACE

voidstroke(strokeColor:any,width:int[,location:StrokeLocation=StrokeLocation.CENTER][,mode:ColorBlendMode=ColorBlendMode.NORMAL][,opacitybool])Strokestheselection.Parameter Type

strokeColor any

width int

location StrokeLocation:StrokeLocation.INSIDEStrokeLocation.CENTERStrokeLocation.OUTSIDE

mode ColorBlendMode:ColorBlendMode.NORMALColorBlendMode.DISSOLVE

ColorBlendMode.BEHINDColorBlendMode.CLEARColorBlendMode.DARKENColorBlendMode.MULTIPLYColorBlendMode.COLORBURNColorBlendMode.LINEARBURNColorBlendMode.LIGHTENColorBlendMode.SCREENColorBlendMode.COLORDODGEColorBlendMode.LINEARDODGEColorBlendMode.OVERLAYColorBlendMode.SOFTLIGHTColorBlendMode.HARDLIGHTColorBlendMode.VIVIDLIGHTColorBlendMode.LINEARLIGHTColorBlendMode.PINLIGHTColorBlendMode.DIFFERENCEColorBlendMode.EXCLUSIONColorBlendMode.HUEColorBlendMode.SATURATIONColorBlendMode.COLORColorBlendMode.LUMINOSITYColorBlendMode.HARDMIXBLEND

opacity int


voidtranslate([deltaX:UnitValue][,deltaY:UnitValue])Movestheobjectrelativetoitscurrentposition.Parameter Type Description



voidtranslateBoundary([deltaX:UnitValue][,deltaY:UnitValueMovestheboundaryofselectionrelativetoitscurrentposition.




Elementof Document.selection


Contents::Index

Enumeration

SelectionType Theselectionbehaviorwhenaselectionalready

exists.


SelectionType.DIMINISH Removetheselectionfromthealreadyselectedarea.

int3

SelectionType.EXTEND Addtheselectiontoanalreadyselectedarea.

int2

SelectionType.INTERSECT Maketheselectiononlytheareawherethenewselectionintersectsthealreadyselectedarea.

int4

SelectionType.REPLACE Replacetheselectedarea.

int1

Usage InfunctionvoidPathItem.makeSelection([feather:number][,

antiAlias:bool][,operation:SelectionType])voidSelection.load(from:Channel[,combination

SelectionType=SelectionType.REPLACE][,inverting:bool=false])

voidSelection.select(region:Arrayofany[,type:SelectionType=SelectionType.REPLACE][,feather:number=0][,antiAlias:bool=true])

voidSelection.store(into:Channel[,combinationSelectionType=SelectionType.REPLACE])


Contents::Index

Enumeration

SourceSpaceType Thecolorspaceforthesourcewhenprinting.


SourceSpaceType.DOCUMENT Thedocumentcolorspace.

SourceSpaceType.PROOF Theproofcolorspace.

Usage InfunctionvoidDocument.print([postScriptEncoding

PrintEncoding=PrintEncoding.BINARYsourceSpace:SourceSpaceType=SourceSpaceType.DOCUMENT[,printSpace:string][,intent:Intent=Intent.RELATIVECOLORIMETRICblackPointCompensation:bool=true


Contents::Index

Enumeration

StrikeThruType Thestrikethroughstyle.


StrikeThruType.STRIKEBOX (Forverticaltype)Thestrikethroughisthroughtheembox.

StrikeThruType.STRIKEHEIGHT (Forverticaltype)Thestrikethroughisthroughtheheightofthetext.

StrikeThruType.STRIKEOFF Nostrikethrough.

Usage AspropertyTextItem.strikeThru


Contents::Index

Enumeration

StrokeLocation Theplacementofpathorselectionboundary

strokes.


StrokeLocation.CENTER Theborderisplacedinthecenterofthetheselectionorlayerboundaries.

int

StrokeLocation.INSIDE Theborderisplacedinsidetheselectionorlayerboundaries.

int

StrokeLocation.OUTSIDE Theborderisplacedoutsidetheselectionorlayerboundaries.

int

Usage InfunctionvoidSelection.stroke(strokeColor:any,width

location:StrokeLocation=StrokeLocation.CENTERmode:ColorBlendMode=ColorBlendMode.NORMAL[,opacity:int=100][,preserveTransparencybool])


Contents::Index

Enumeration

TIFFEncoding TheencodingtousewhensavingtoTIFFformat.


TIFFEncoding.JPEG JPEGcompression,whichislossyandrecommendedforcontinuous-toneimages,suchasphotographs.

int

TIFFEncoding.NONE Nocompression.

int

TIFFEncoding.TIFFLZW LZWcompression,whichislosslessandmostusefulforimageswithlargeareasofsinglecolor.

int

TIFFEncoding.TIFFZIP Zipcompression,whichislosslessandmosteffectiveforimagesthatcontainlargeareasofsinglecolor.

int

Usage AspropertyTiffSaveOptions.imageCompression


Contents::Index

Enumeration

TextComposer Thetextcomposer.


TextComposer.ADOBEEVERYLINE Considersanetworkofbreakpointsforarangeoflinesandthusoptimizesearlierlinesintheparagraphtoeliminateespeciallyunattractivebreakslateron.Resultsinmoreevenspacingandfewerhyphens.TheAdobeEvery-linecomposerapproachescompositionbyidentifyingpossiblebreakpoints,evaluatingthem,andassigningaweighted

penaltybasedontheseprinciples:Highestimportanceisgiventoevennessofletterandwordspacing;Possiblebreakpointsareevaluatedandpenalizedaccordingtohowmuchtheydeviatefromoptimalspacing;Hyphenationisavoidedwhenpossible;Breakpointsthatrequirehyphenationarepenalizedmorethanthosethatcreateunevenspacing;Goodbreakpointsarepreferred

overbadbreakpoints.

TextComposer.ADOBESINGLELINE Offersatraditionalapproachtocomposingtypeonelineatatime.Usefulifyouprefertohavemanualcontroloverhowlinesbreak.Usesthefollowingprincipleswhenconsideringabreakpoint:Compressedorexpandedwordspacingispreferabletohyphenation;Hyphenationispreferabletocompressedorexpandedletterspacing;Ifspacingmustbeadjusted,compressionisbetterthanexpansion.

Usage AspropertyTextItem.textComposer


Contents::Index

TextFont Aninstalledfont.

Hierarchy Object

TextFont


family string readonly Thefontfamily.

name string readonly Thefontname.


postScriptName string readonly ThePostScriptnameofthefont.

style string readonly Thefontstyle.


Return TextFontTextFonts.[](index:uint)TextFontTextFonts.getByName(name:string)


Contents::Index

TextItem Thetextobjectcontainedinanartlayer.

QuickLinks convertToShape,createPath

Hierarchy Object

TextItem


alternateLigatures bool

antiAliasMethod AntiAlias:AntiAlias.NONEAntiAlias.SHARPAntiAlias.CRISPAntiAlias.STRONGAntiAlias.SMOOTH

autoKerning AutoKernType:AutoKernType.MANUALAutoKernType.METRICSAutoKernType.OPTICAL

autoLeadingAmount number

baselineShift UnitValue

capitalization Case:Case.NORMALCase.ALLCAPSCase.SMALLCAPS

color SolidColor

contents string

desiredGlyphScaling number

desiredLetterScaling number

desiredWordScaling number

direction Direction:Direction.HORIZONTALDirection.VERTICAL

fauxBold bool

fauxItalic bool

firstLineIndent UnitValue

font string

hangingPuntuation bool

height UnitValue

horizontalScale int

hyphenLimit int

hyphenateAfterFirst int

hyphenateBeforeLast int

hyphenateCapitalWords bool

hyphenateWordsLongerThan int(min:0)

hyphenation bool

hyphenationZone UnitValue

justification Justification:Justification.LEFTJustification.CENTERJustification.RIGHTJustification.LEFTJUSTIFIEDJustification.CENTERJUSTIFIEDJustification.RIGHTJUSTIFIEDJustification.FULLYJUSTIFIED

kind TextType:TextType.POINTTEXTTextType.PARAGRAPHTEXT

language Language:Language.ENGLISHUSALanguage.ENGLISHUKLanguage.FRENCHLanguage.CANADIANFRENCHLanguage.FINNISHLanguage.GERMANLanguage.OLDGERMANLanguage.SWISSGERMANLanguage.ITALIANLanguage.NORWEGIAN

Language.NYNORSKNORWEGIANLanguage.PORTUGUESELanguage.BRAZILLIANPORTUGUESELanguage.SPANISHLanguage.SWEDISHLanguage.DUTCHLanguage.DANISH

leading UnitValue

leftIndent UnitValue

ligatures bool

maximumGlyphScaling number

maximumLetterScaling number

maximumWordScaling number

minimumGlyphScaling number

minimumLetterScaling number

minimumWordScaling number

noBreak bool

oldStyle bool

parent Object

position UnitPoint

rightIndent UnitValue

size UnitValue

spaceAfter UnitValue

spaceBefore UnitValue

strikeThru StrikeThruType:StrikeThruType.STRIKEOFFStrikeThruType.STRIKEHEIGHTStrikeThruType.STRIKEBOX

textComposer TextComposer:TextComposer.ADOBESINGLELINETextComposer.ADOBEEVERYLINE

tracking number

typename string

underline UnderlineType:UnderlineType.UNDERLINEOFFUnderlineType.UNDERLINERIGHTUnderlineType.UNDERLINELEFT

useAutoLeading bool

verticalScale int

warpBend number

warpDirection Direction:Direction.HORIZONTALDirection.VERTICAL

warpHorizontalDistortion number

warpStyle WarpStyle:WarpStyle.NONEWarpStyle.ARCWarpStyle.ARCLOWERWarpStyle.ARCUPPERWarpStyle.ARCHWarpStyle.BULGEWarpStyle.SHELLLOWERWarpStyle.SHELLUPPERWarpStyle.FLAGWarpStyle.WAVE

WarpStyle.FISHWarpStyle.RISEWarpStyle.FISHEYEWarpStyle.INFLATEWarpStyle.SQUEEZEWarpStyle.TWIST

warpVerticalDistortion number

width UnitValue

Methods InstancesvoidconvertToShape()Convertsthetextobjectanditscontaininglayertoafilllayerwiththetextchangedtoaclippingpath.

voidcreatePath()Createsaclippingpathfromtheoutlinesoftheactualtextitems(suchaslettersorwords).

Elementof ArtLayer.textItem


Contents::Index

Enumeration

TextType Thetypeoftext.


TextType.PARAGRAPHTEXT Textthatwrapswithinaboundingbox.

int2

TextType.POINTTEXT Textthatdoesnotwrap.

int1

Usage AspropertyTextItem.kind


Contents::Index

Enumeration

TransitionType PDFpresentationtransitiontypes.


TransitionType.BLINDSHORIZONTAL ImagestransitioninhorizontalstripeslikeVenetianblinds.

TransitionType.BLINDSVERTICAL Imagestransitioninverticalstripes.

TransitionType.BOXIN Imagestransitionusingashrinkingboxshape.

TransitionType.BOXOUT Imagestransitionusinganexpandingboxshape.

TransitionType.DISSOLVE Oneimagedissolvesintothenext.

TransitionType.GLITTERDOWN Imagesdissolvetoptobottom.

TransitionType.GLITTERRIGHT Imagesdissolveleft

toright.

TransitionType.GLITTERRIGHTDOWN Imagesdissolvetop-lefttobottom-right.

TransitionType.NONE Imageschangewithnovisibletransition.

TransitionType.RANDOM Imagestransitionusingrandomeffects.

TransitionType.SPLITHORIZONTALIN Thenewimagesrollinfromthetopandbottomofthescreen.

TransitionType.SPLITHORIZONTALOUT Thenewimagespreadsfromthemiddleofthescreentothetopandbottomofthescreen.

TransitionType.SPLITVERTICALIN Thenewimagerollsinfromtheleftand

rightedgesofthescreen.

TransitionType.SPLITVERTICALOUT Thenewimagerollsoutfromthemiddleofthescreentotheleftandrightedgesofthescreen.

TransitionType.WIPEDOWN Thenewimagerollsinfromthetopofthescreen.

TransitionType.WIPELEFT Thenewimagerollsinfromtherightsideofthescreen.

TransitionType.WIPERIGHT Thenewimagerollsinfromtheleftsideofthescreen.

TransitionType.WIPEUP Thenewimagerollsinfromthebottomofthescreen.

Usage AspropertyPresentationOptions.transition


Contents::Index

Enumeration

TrimType Thetypeofpixelstotrimaroundanimage.


TrimType.BOTTOMRIGHT Removesfromtheimageanareathecolorofthelowerrightpixel.

int9

TrimType.TOPLEFT Removesfromtheimageanareathecoloroftheupperleftpixel.

int1

TrimType.TRANSPARENT Trimsawaytransparencyattheedgesoftheimage,leavingthesmallestimagecontainingnontransparentpixels.

int0

Usage InfunctionvoidDocument.trim([type:

TrimType=TrimType.TOPLEFT][,top:bool=true][,left:bool=true][,bottom:bool=true][,right:bool=true])


Contents::Index

Enumeration

TypeUnits Themeasurementunitfortype.


TypeUnits.MM Millimeters. int4

TypeUnits.PIXELS Pixels. int1

TypeUnits.POINTS Points. int5

Usage AspropertyPreferences.typeUnits


Contents::Index

Enumeration

UnderlineType Thetypeofunderline.


UnderlineType.UNDERLINELEFT (Forverticaltype)Theunderlineistotheleftofthetext.

UnderlineType.UNDERLINEOFF Nounderline.

UnderlineType.UNDERLINERIGHT (Forverticaltype)Theunderlineistotherightofthetext.

Usage AspropertyTextItem.underline


Contents::Index

Enumeration

Units Themeasurementunitforrulerincrements.


Units.CM Centimeters. int3

Units.INCHES Inches. int2

Units.MM Millimeters. int4

Units.PERCENT Percent. int7

Units.PICAS Picas. int6

Units.PIXELS Pixels. int1

Units.POINTS Points. int5

Usage AspropertyPreferences.rulerUnits


Contents::Index

Enumeration

Urgency Theeditorialurgencystatusoftheartwork.


Urgency.FOUR Level4(fourthhighest) int4

Urgency.HIGH Highestlevelofurgency.

int8

Urgency.LOW Low. int1

Urgency.NONE Nourgency. int0

Urgency.NORMAL Mediumurgency. int5

Urgency.SEVEN Level7(secondlowest)

int7

Urgency.SIX Level6(thirdlowest) int6

Urgency.THREE Level3(thirdhighest) int3

Urgency.TWO Level2(secondhighest)

int2

Usage AspropertyDocumentInfo.urgency


Contents::Index

Enumeration

WarpStyle Thewarpstylefortext.


WarpStyle.ARC Thetypeiswarpedintheshapeofanarc.

int2

WarpStyle.ARCH Textiswarpedintheformofanarch.

int5

WarpStyle.ARCLOWER Warpisheavieronthelowerorleftedgeofthetextthanontheupperorrightedge.

int3

WarpStyle.ARCUPPER Warpisheavierontheupperorrightedgeofthetextthanonthelowerorleftedge.

int4

WarpStyle.BULGE Textiswarpedoutwardonboththeupperandlowerorrightandleftedges.

int6

WarpStyle.FISH Textiswarpedintheshapeof

int11

afish.

WarpStyle.FISHEYE Textbulgesinthemiddleandissqueezedontheedgesasifviewedthroughafisheyelens.

int13

WarpStyle.FLAG Textiswarpedintheshapeofawavingflag.

int9

WarpStyle.INFLATE Textisinflated.

int14

WarpStyle.NONE Nowarp. int1

WarpStyle.RISE Textiswarpedinanundulating,risingpattern.

int12

WarpStyle.SHELLLOWER Textiswarpeddownwardortotherightintheshapeofafan-likeseashell.

int7

WarpStyle.SHELLUPPER Textiswarpedupwardortotheleftintheshapeofafan-likeseashell.

int8

WarpStyle.SQUEEZE Textissqueezed.

int15

WarpStyle.TWIST Textistwisted.

int16

WarpStyle.WAVE Textiswarpedintheshapeofawave.

int10

Usage AspropertyTextItem.warpStyle


Contents::Index

Enumeration

WhiteBalanceType Thelightingconditions(affectscolorbalance).

Value Name

WhiteBalanceType.ASSHOT

WhiteBalanceType.AUTO

WhiteBalanceType.CLOUDY

WhiteBalanceType.CUSTOM

WhiteBalanceType.DAYLIGHT

WhiteBalanceType.FLASH

WhiteBalanceType.FLUORESCENT

WhiteBalanceType.SHADE

WhiteBalanceType.TUNGSTEN

Usage AspropertyCameraRAWOpenOptions.whiteBalance


Contents::Index

XMPMetadata Camerarawimagefilesettingsstoredinan

XMPfileinthesamefolderastherawfilewiththesamebasenameandanXMPextension.

Hierarchy Object

XMPMetadata



rawData string r/w TherawXMLformoffileinformation.


Elementof Document.xmpMetadataLayer.xmpMetadata


Contents::Index

CameraRAWOpenOptions OptionsforopeningacameraRAWdocument.BaseClass:

Class Property

bitsPerChannel

blueHue

blueSaturation

brightness

chromaticAberrationBY

chromaticAberrationRC

colorNoiseReduction

colorSpace

contrast

exposure

greenHue

greenSaturation

luminanceSmoothing

redHue

redSaturation

resolution

saturation

settings

shadowTint

shadows

sharpness

size

temperature

tint

vignettingAmount

vignettingMidpoint

whiteBalance


Contents::Index

DICOMOpenOptions OptionsforopeningaDICOMdocument.

BaseClass:OpenOptions

Class Property Type Access

anonymize bool r/w

columns int r/w

reverse bool r/w

rows int r/w

showOverlays bool r/w

windowLevel int r/w

windowWidth int r/w


Contents::Index

OpenOptions Optionsthatcanbespecifiedwhenopeninga

document.

SuperclassofCameraRAWOpenOptions,DICOMOpenOptions,EPSOpenOptions,PDFOpenOptions,PhotoCDOpenOptions,andRawFormatOpenOptions


Contents::Index

PhotoCDOpenOptions DeprecatedinAdobePhotoshopCS3.BaseClass:

Class Property Type


colorSpace PhotoCDColorSpacePhotoCDColorSpace.RGB8PhotoCDColorSpace.RGB16PhotoCDColorSpace.LAB8PhotoCDColorSpace.LAB16

orientation OrientationOrientation.LANDSCAPEOrientation.PORTRAIT

pixelSize PhotoCDSizePhotoCDSize.MINIMUMPhotoCDSize.SMALLPhotoCDSize.MEDIUMPhotoCDSize.LARGEPhotoCDSize.EXTRALARGEPhotoCDSize.MAXIMUM

resolution number


Contents::Index

Enumeration

PhotoCDSize Thepixeldimensionsoftheimage.


PhotoCDSize.EXTRALARGE 1024x1536image.

int

PhotoCDSize.LARGE 512x768image.

int

PhotoCDSize.MAXIMUM 2048x3072image.

int

PhotoCDSize.MEDIUM 256x384image.

int

PhotoCDSize.MINIMUM 64x96image.

int

PhotoCDSize.SMALL 128x192image.

int

Usage AspropertyPhotoCDOpenOptions.pixelSize


Contents::Index

RawFormatOpenOptions OptionsthatcanbespecifiedwhenopeningadocumentinRAW

format.BaseClass:OpenOptions

Class Property Type

bitsPerChannel int

byteOrder ByteOrderByteOrder.IBMByteOrder.MACOS

channelNumber int

headerSize int

height int

interleaveChannels bool

retainHeader bool

width int


Contents::Index

Enumeration

BMPDepthType Thenumberofbitsperchannel(alsocalledpixeldepthor

colordepth).Thenumberselectedindicatestheexponentof2.Forexample,apixelwithabit-depthofEIGHThas2-to-the-8th,or256,possiblecolorvalues.


BMPDepthType.BMP_A1R5G5B5 A1R5G5B5advancedbitdepthspecification.

BMPDepthType.BMP_A4R4G4B4 A4R4G4B4advancedbitdepthspecification.

BMPDepthType.BMP_A8R8G8B8 A8R8G8B8advancedbitdepthspecification(sameasnormal32bitmode)

BMPDepthType.BMP_R5G6B5 R5G6B5advancedbitdepthspecification.

BMPDepthType.BMP_R8G8B8 R8G8B8advancedbitdepthspecification(sameasnormal24bitmode)

BMPDepthType.BMP_X1R5G5B5 X1R5G5B5advancedbitdepthspecification(sameasnormal16bitmode)

BMPDepthType.BMP_X4R4G4B4 X4R4G4B4advancedbitdepthspecification.

BMPDepthType.BMP_X8R8G8B8 X8R8G8B8advancedbitdepthspecification.

BMPDepthType.EIGHT 8bitsdepth.

BMPDepthType.FOUR 4bitsdepth.

BMPDepthType.ONE 1bitdepth.

BMPDepthType.SIXTEEN 16bitsdepth.

BMPDepthType.THIRTYTWO 32bitsdepth.

BMPDepthType.TWENTYFOUR 24bitsdepth.

Usage AspropertyBMPSaveOptions.depth


Contents::Index

BMPSaveOptions OptionsforsavingadocumentinBMPformat.BaseClass:

Class Property Type

alphaChannels bool

depth BMPDepthType:BMPDepthType.ONEBMPDepthType.FOURBMPDepthType.EIGHTBMPDepthType.SIXTEENBMPDepthType.TWENTYFOURBMPDepthType.THIRTYTWOBMPDepthType.BMP_X1R5G5B5BMPDepthType.BMP_A1R5G5B5BMPDepthType.BMP_R5G6B5BMPDepthType.BMP_X4R4G4B4BMPDepthType.BMP_A4R4G4B4BMPDepthType.BMP_R8G8B8BMPDepthType.BMP_X8R8G8B8BMPDepthType.BMP_A8R8G8B8

flipRowOrder bool

osType OperatingSystem:OperatingSystem.OS2OperatingSystem.WINDOWS

rleCompression bool


Contents::Index

DCS1_SaveOptions OptionsforsavingadocumentinPhotoshopDCS1.0format.BaseClass:

Class Property Type

DCS DCSType:DCSType.NOCOMPOSITEDCSType.GRAYSCALECOMPOSITEDCSType.COLORCOMPOSITE

embedColorProfile bool

encoding SaveEncoding:SaveEncoding.ASCIISaveEncoding.BINARYSaveEncoding.JPEGLOWSaveEncoding.JPEGMEDIUMSaveEncoding.JPEGHIGHSaveEncoding.JPEGMAXIMUM

halftoneScreen bool

interpolation bool

preview Preview:Preview.NONEPreview.MONOCHROMETIFFPreview.EIGHTBITTIFFPreview.MACOSMONOCHROMEPreview.MACOSEIGHTBITPreview.MACOSJPEG

transferFunction bool

vectorData bool


Contents::Index

DCS2_SaveOptions OptionsforsavingadocumentinPhotoshopDCS2.0format.BaseClass:

Class Property Type

DCS DCSType:DCSType.NOCOMPOSITEDCSType.GRAYSCALECOMPOSITEDCSType.COLORCOMPOSITE



halftoneScreen bool

interpolation bool

multiFileDCS bool


spotColors bool


vectorData bool


Contents::Index

EPSSaveOptions OptionsforsavingadocumentinEPSformat.BaseClass:

Class Property Type



halftoneScreen bool

interpolation bool


psColorManagement bool


transparentWhites bool

vectorData bool


Contents::Index

GIFSaveOptions OptionsforsavingadocumentinGIFformat.BaseClass:

Class Property Type

colors int

dither Dither:Dither.NONEDither.DIFFUSIONDither.PATTERNDither.NOISE

ditherAmount int(range:1-100)

forced ForcedColors:ForcedColors.NONEForcedColors.BLACKWHITEForcedColors.PRIMARIESForcedColors.WEB

interlaced bool

matte MatteType:MatteType.NONEMatteType.FOREGROUNDMatteType.BACKGROUNDMatteType.WHITEMatteType.BLACKMatteType.SEMIGRAYMatteType.NETSCAPE

palette Palette:Palette.EXACT

Palette.MACOSPALETTEPalette.WINDOWSPALETTEPalette.WEBPALETTEPalette.UNIFORMPalette.LOCALPERCEPTUALPalette.LOCALSELECTIVEPalette.LOCALADAPTIVEPalette.MASTERPERCEPTUALPalette.MASTERSELECTIVEPalette.MASTERADAPTIVEPalette.PREVIOUSPALETTE

preserveExactColors bool

transparency bool


Contents::Index

JPEGSaveOptions OptionsforsavingadocumentinJPEGformat.BaseClass:

Class Property Type


formatOptions FormatOptions:FormatOptions.STANDARDBASELINEFormatOptions.OPTIMIZEDBASELINEFormatOptions.PROGRESSIVE

matte MatteType:MatteType.NONEMatteType.FOREGROUNDMatteType.BACKGROUNDMatteType.WHITEMatteType.BLACKMatteType.SEMIGRAYMatteType.NETSCAPE

quality int(range:0-12)

scans int(range:3-5)


Contents::Index

PDFSaveOptions OptionsforsavingadocumentinPDFformat.BaseClass:

Class Property Type

PDFCompatibility PDFCompatibilityPDFCompatibility.PDF13PDFCompatibility.PDF14PDFCompatibility.PDF15PDFCompatibility.PDF16PDFCompatibility.PDF17

PDFStandard PDFStandard:PDFStandard.NONEPDFStandard.PDFX1A2001PDFStandard.PDFX1A2003PDFStandard.PDFX32002PDFStandard.PDFX32003PDFStandard.PDFX42008

alphaChannels bool

annotations bool

colorConversion bool

convertToEightBit bool

description string

destinationProfile string

downSample PDFResample:PDFResample.NONEPDFResample.PDFAVERAGEPDFResample.PDFSUBSAMPLEPDFResample.PDFBICUBIC

downSampleSize number

downSampleSizeLimit number

downgradeColorProfile bool


embedFonts bool

embedThumbnail bool

encoding PDFEncodingTypePDFEncodingType.NONEPDFEncodingType.PDFZIPPDFEncodingType.JPEGPDFEncodingType.PDFZIP4BITPDFEncodingType.JPEGHIGHPDFEncodingType.JPEGMEDHIGHPDFEncodingType.JPEGMEDPDFEncodingType.JPEGMEDLOWPDFEncodingType.JPEGLOWPDFEncodingType.JPEG2000HIGHPDFEncodingType.JPEG2000MEDHIGHPDFEncodingType.JPEG2000MEDPDFEncodingType.JPEG2000MEDLOWPDFEncodingType.JPEG2000LOWPDFEncodingType.JPEG2000LOSSLESS

interpolation bool

jpegQuality int(range:0-12)

layers bool

optimizeForWeb bool

outputCondition string

outputConditionID string

preserveEditing bool

presetFile string

profileInclusionPolicy bool

registryName string

spotColors bool

tileSize int

transparency bool

useOutlines bool

vectorData bool

view bool

Elementof PresentationOptions.PDFFileOptions


Contents::Index

Enumeration

PICTBitsPerPixels Thenumberofbitsperpixeltousewhencompressinga

PICTfile.


PICTBitsPerPixels.EIGHT 8bitsperpixel.

PICTBitsPerPixels.FOUR 4bitsperpixel.

PICTBitsPerPixels.SIXTEEN 16bitsperpixel.

PICTBitsPerPixels.THIRTYTWO 32bitsperpixel.

PICTBitsPerPixels.TWO 2bitsperpixel.

Usage AspropertyPICTFileSaveOptions.resolutionPICTResourceSaveOptions.resolution


Contents::Index

PICTFileSaveOptions OptionsforsavingadocumentinPICTformat.BaseClass:

Class Property Type

alphaChannels bool

compression PICTCompressionPICTCompression.NONEPICTCompression.JPEGLOWPICTPICTCompression.JPEGMEDIUMPICTPICTCompression.JPEGHIGHPICTPICTCompression.JPEGMAXIMUMPICT


resolution PICTBitsPerPixelsPICTBitsPerPixels.TWOPICTBitsPerPixels.FOURPICTBitsPerPixels.EIGHTPICTBitsPerPixels.SIXTEENPICTBitsPerPixels.THIRTYTWO


Contents::Index

PICTResourceSaveOptions OptionsforsavingadocumentasaPICTresourcefile.BaseClass:

Class Property

alphaChannels

compression

embedColorProfile

name

resolution

resourceID


Contents::Index

PNGSaveOptions OptionsforsavingadocumentinPNG

format.BaseClass:SaveOptions


interlaced bool r/w Iftrue,rowsareinterlaced.(default:false)


Contents::Index

PhotoshopSaveOptions OptionsforsavingaPhotoshopdocument.Base

Class:SaveOptions


alphaChannels bool r/w

annotations bool r/w

embedColorProfile bool r/w

layers bool r/w

spotColors bool r/w


Contents::Index

PixarSaveOptions OptionsforsavingadocumentinPixar



alphaChannels bool r/w Iftrue,thealphachannelsaresaved.


Contents::Index

RawSaveOptions OptionsforsavingadocumentinRAW



alphaChannels bool r/w Iftrue,thealphachannelsaresaved.

spotColors bool r/w Iftrue,spotcolorsaresaved.


Contents::Index

SGIRGBSaveOptions OptionsforsavingadocumentinSGIRGB



alphaChannels bool r/w

spotColors bool r/w


Contents::Index

Enumeration

TargaBitsPerPixels TheresolutiontousewhensavinganimageinTarga

format.

Value Name

TargaBitsPerPixels.SIXTEEN

TargaBitsPerPixels.THIRTYTWO

TargaBitsPerPixels.TWENTYFOUR

Usage AspropertyTargaSaveOptions.resolution


Contents::Index

TargaSaveOptions OptionsforsavingadocumentinTGA(Targa)format.BaseClass:

Class Property Type

alphaChannels bool

resolution TargaBitsPerPixels:TargaBitsPerPixels.SIXTEENTargaBitsPerPixels.TWENTYFOURTargaBitsPerPixels.THIRTYTWO

rleCompression bool


Contents::Index

TiffSaveOptions OptionsforsavingadocumentinTIFFformat.BaseClass:

Class Property Type

alphaChannels bool

annotations bool

byteOrder ByteOrder:ByteOrder.IBMByteOrder.MACOS


imageCompression TIFFEncoding:TIFFEncoding.NONETIFFEncoding.TIFFLZWTIFFEncoding.JPEGTIFFEncoding.TIFFZIP

interleaveChannels bool

jpegQuality int(range:0-12)

layerCompression LayerCompression:LayerCompression.RLELayerCompression.ZIP

layers bool

saveImagePyramid bool

spotColors bool

transparency bool


Contents::Index

ExportOptions Optionsforexportinganobject.

SuperclassofExportOptionsIllustrator,ExportOptionsSaveForWeb

Usedin: voidDocument.exportDocument(exportIn:FileexportAs:ExportType=ExportType.ILLUSTRATORPATHS[,options:ExportOptions])


Contents::Index

ExportOptionsIllustrator OptionsforexportingIllustratorpaths.BaseClass:

Class Property Type

path IllustratorPathTypeIllustratorPathType.DOCUMENTBOUNDSIllustratorPathType.ALLPATHSIllustratorPathType.NAMEDPATH

pathName string


Contents::Index

ExportOptionsSaveForWeb OptionsforexportingSaveForWebfiles.BaseClass:

Class Property

PNG8

blur

colorReduction

colors

dither

ditherAmount

format

includeProfile

interlaced

lossy

matteColor

optimized

quality

transparency

transparencyAmount

transparencyDither

webSnap


Contents::Index

Enumeration

CreateFields Themethodforreplacingeliminatedfields.


CreateFields.DUPLICATION Duplicatesexistingpixels.

int

CreateFields.INTERPOLATION AssignscolorvaluestoanynewpixelsthatPhotoshopcreatesbasedonthecolorvaluesofexistingpixelsintheimage.

int

Usage InfunctionvoidArtLayer.applyDeInterlace(eliminateFields:

EliminateFields,createFields:CreateFields)


Contents::Index

Enumeration

DisplacementMapType Describeshowthedisplacementmapfitstheimageiftheimage

isnotthesamesizeasthemap.

Value Name

DisplacementMapType.STRETCHTOFIT

DisplacementMapType.TILE

Usage InfunctionvoidArtLayer.applyDisplace(

int,displacementType:DisplacementMapTypeundefinedAreas:UndefinedAreasFile)


Contents::Index

Enumeration

EliminateFields Thetypeoffieldstoeliminate.


EliminateFields.EVENFIELDS Eliminateeveninterlacedlinesinavideoimage.

EliminateFields.ODDFIELDS Eliminateoddinterlacedlinesinavideoimage.

Usage InfunctionvoidArtLayer.applyDeInterlace(eliminateFields

EliminateFields,createFields:CreateFields


Contents::Index

Enumeration

LensType Thetypeoflens.


LensType.MOVIEPRIME MoviePrime. int5

LensType.PRIME105 105mmPrime. int3

LensType.PRIME35 35mmPrime. int2

LensType.ZOOMLENS 50-300mmZoom.

int1

Usage InfunctionvoidArtLayer.applyLensFlare(brightness:int,

flareCenter:UnitPoint,lensType:LensType)


Contents::Index

Enumeration

NoiseDistribution ThedistributionmethodtousewhenapplyinganAdd

Noisefilter.


NoiseDistribution.GAUSSIAN Distributescolorvaluesofnoisealongabell-shapedcurve,creatingaspeckledeffect.

NoiseDistribution.UNIFORM Distributescolorvaluesofnoiseusingrandomnumbersbetween0andplusorminusthespecifiedvalue,creatingasubtleeffect.

Usage InfunctionvoidArtLayer.applyAddNoise(amount:number

distribution:NoiseDistribution,monochromaticbool)

voidArtLayer.applyLensBlur([source:DepthMapSource=DepthMapSource.NONEfocalDistance:int=0][,invertDepthMap

bool=false][,shape:Geometry=Geometry.HEXAGON][,int=15][,bladeCurvature:int=0][,rotation[,brightness:int=0][,threshold:int=int=0][,distribution:NoiseDistribution=NoiseDistribution.UNIFORM[,monochromatic:bool=false])


Contents::Index

Enumeration

OffsetUndefinedAreas Themethodtousetofilltheemptyspaceleftbyoffsettingaanimageor

selection.

Value Name

OffsetUndefinedAreas.REPEATEDGEPIXELS

OffsetUndefinedAreas.SETTOBACKGROUND

OffsetUndefinedAreas.WRAPAROUND

Usage Infunction

voidArtLayer.applyOffset(horizontalundefinedAreas:OffsetUndefinedAreas


Contents::Index

Enumeration

PolarConversionType Themethodofpolardistortiontouse.

Value Name

PolarConversionType.POLARTORECTANGULAR

PolarConversionType.RECTANGULARTOPOLAR

Usage InfunctionvoidArtLayer.applyPolarCoordinates


Contents::Index

Enumeration

RadialBlurMethod Theblurmethodtouse.


RadialBlurMethod.SPIN Blursalongconcentriccircularlinesatthespecifieddegreeofrotation.

RadialBlurMethod.ZOOM Blursalongradiallines,asifzoomingintooroutoftheimage.

Usage InfunctionvoidArtLayer.applyRadialBlur(amount

blurMethod:RadialBlurMethodblurQuality:RadialBlurQuality)


Contents::Index

Enumeration

RadialBlurQuality Theradialblurquality.


RadialBlurQuality.BEST Producesbestresults.

RadialBlurQuality.DRAFT Producesfastbutgrainyresults.

RadialBlurQuality.GOOD Producesgoodresults.

Usage InfunctionvoidArtLayer.applyRadialBlur(amount

blurMethod:RadialBlurMethod,blurQualityRadialBlurQuality)


Contents::Index

Enumeration

RippleSize Thesizeofundulations.


RippleSize.LARGE Large. int3

RippleSize.MEDIUM Medium. int2

RippleSize.SMALL Small. int1

Usage InfunctionvoidArtLayer.applyRipple(amount:int,size:

RippleSize)


Contents::Index

Enumeration

SmartBlurMode Themethodtouseforsmartblurring.


SmartBlurMode.EDGEONLY Blurisappliedonlytoedgesofcolortransitions.Wheresignificantcontrastoccurs,appliesblack-and-whiteedges.

SmartBlurMode.NORMAL Blurisappliedtoentireimage.

SmartBlurMode.OVERLAYEDGE Blurisappliedonlytoedgesofcolortransitions.Wheresignificantcontrastoccurs,applieswhiteedges.

Usage InfunctionvoidArtLayer.applySmartBlur(radius:number

number,blurQuality:SmartBlurQualitySmartBlurMode)


Contents::Index

Enumeration

SmartBlurQuality Thesmartblurquality.


SmartBlurQuality.HIGH Highquality.

SmartBlurQuality.LOW Lowquality.

SmartBlurQuality.MEDIUM Mediumquality.

Usage InfunctionvoidArtLayer.applySmartBlur(radius:number

threshold:number,blurQuality:SmartBlurQuality,mode:SmartBlurMode


Contents::Index

Enumeration

SpherizeMode Thecurve(orstretchshape)touseforthedistortion.


SpherizeMode.HORIZONTAL Distortstheimageasifitiswrappedaroundahorizontalcylinder.

int

SpherizeMode.NORMAL Distortstheimageasifitiswrappedaroundasphere.

int

SpherizeMode.VERTICAL Distortstheimageasifitiswrappedaroundaverticalcylinder.

int

Usage InfunctionvoidArtLayer.applySpherize(amount:int,mode

SpherizeMode)


Contents::Index

Enumeration

TextureType Thetypeoftextureorglasssurfaceimagetoload

foratexturizerorglassfilter.


TextureType.BLOCKS Theimageappearsasifviewedthroughglassblocks.

int1

TextureType.CANVAS Theimageappearsasifpaintedoncanvas.

int2

TextureType.FILE Texturefromanexistingdocument.

int5

TextureType.FROSTED Theimageappearsasiffrosted.

int3

TextureType.TINYLENS Theimageappearsasifviewedthroughanarrayoftinylenses.

int4

Usage InfunctionvoidArtLayer.applyGlassEffect(distortion:int,

smoothness:int,scaling:int[,invert:bool=false][,texture:TextureType][,textureFile:File])


Contents::Index

Enumeration

UndefinedAreas Themethodtousetotreatundistortedareasorareasleftblank

inanimagetowhichafilterintheDistortcategoryhasbeenapplied.


UndefinedAreas.REPEATEDGEPIXELS Extendsthecolorsofpixelsalongtheedgeoftheimageinthedirectionspecified.Bandingmayresultiftheedgepixelsaredifferentcolors.

UndefinedAreas.WRAPAROUND Fillstheundefinedspacewithcontentfromtheoppositeedgeoftheimage.

Usage InfunctionvoidArtLayer.applyDisplace(horizontalScale

int,displacementType:DisplacementMapTypeundefinedAreas:UndefinedAreas,displacementMapFileFile)

voidArtLayer.applyShear(curve:Arrayofany

UndefinedAreas)voidArtLayer.applyWave(generatorNumber

minimumWavelength:int,maximumWavelengthminimumAmplitude:int,maximumAmplitudehorizontalScale:int,verticalScale:int,waveTypeWaveType,undefinedAreas:UndefinedAreasrandomSeed:int)


Contents::Index

Enumeration

WaveType Thetypeofwave.


WaveType.SINE Rolling. int1

WaveType.SQUARE Square. int3

WaveType.TRIANGULAR Triangular. int2

Usage InfunctionvoidArtLayer.applyWave(generatorNumber:int,

minimumWavelength:int,maximumWavelength:int,minimumAmplitude:int,maximumAmplitude:int,horizontalScale:int,verticalScale:int,waveType:WaveType,undefinedAreas:UndefinedAreas,randomSeed:int)


Contents::Index

Enumeration

ZigZagType Themethodofzigzagging.


ZigZagType.AROUNDCENTER Pixelsarerotatedaroundthecenteroftheselection.

int

ZigZagType.OUTFROMCENTER Pixelsaredisplacedtowardorawayfromthecenteroftheselection.

int

ZigZagType.PONDRIPPLES Pixelsaredisplacedtotheupperleftorlowerright.

int

Usage InfunctionvoidArtLayer.applyZigZag(amount:int,ridges:int,

style:ZigZagType)


Contents::Index

CMYKColor ACMYKcolorspecification.BaseClass:Color


black number r/w Theblackcolorvalue.Range:0.0to100.0.

cyan number r/w Thecyancolorvalue.Range:0.0to100.0.

magenta number r/w Themagentacolorvalue.Range:0.0to100.0.

yellow number r/w Theyellowcolorvalue.Range:0.0to100.0.


black number r/w Theblackcolorvalue.Range:0.0to100.0.

cyan number r/w Thecyancolorvalue.Range:0.0to100.0.

magenta number r/w Themagentacolorvalue.Range:0.0to100.0.

yellow number r/w Theyellowcolorvalue.Range:0.0to100.0.

Elementof SolidColor.cmykSolidColor.cmyk


Contents::Index

Color Acolorvalue.

SuperclassofCMYKColor,GrayColor,HSBColor,LabColor,NoColor,andRGBColor


Contents::Index

GrayColor Optionsfordefiningagraycolor.BaseClass:Color


gray number(range:0-100)

r/w Thegrayvalue.Range:0.0to100.0.(default:0)


gray number(range:0-100)

r/w Thegrayvalue.Range:0.0to100.0.(default:0)

Elementof SolidColor.graySolidColor.gray


Contents::Index

HSBColor AnHSBcolorspecification.BaseClass:Color


brightness number r/w Thebrightnessvalue.Range:0.0to100.0.

hue number r/w Thehuevalue.Range:0.0to360.0.

saturation number r/w Thesaturationvalue.Range:0.0to100.0.


brightness number r/w Thebrightnessvalue.Range:0.0to100.0.

hue number r/w Thehuevalue.Range:0.0to360.0.

saturation number r/w Thesaturationvalue.Range:0.0to100.0.

Elementof SolidColor.hsbSolidColor.hsb


Contents::Index

LabColor ALabcolorspecification.BaseClass:Color


A number r/w Thea-value.Range:-128.0and127.0.

B number r/w Theb-value.Range:-128.0and127.0.

L number r/w TheL-value.Range:0.0to100.0.


A number r/w Thea-value.Range:-128.0and127.0.

B number r/w Theb-value.Range:-128.0and127.0.

L number r/w TheL-value.Range:0.0to100.0.

Elementof SolidColor.labSolidColor.lab


Contents::Index

NoColor Representsamissingcolor.BaseClass:Color


Contents::Index

RGBColor ThedefinitionofanRGBcolormode.BaseClass:

Color


blue number(range:0-255)

r/w Thebluecolorvalue.Range:0.0to255.0.(default:255)

green number(range:0-255)

r/w Thegreencolorvalue.Range:0.0to255.0.(default:255)

hexValue string r/w Thehexrepresentationofthiscolor.

red number(range:0-255)

r/w Theredcolorvalue.Range:0.0to255.0.(default:255)


blue number(range:0-255)

r/w Thebluecolorvalue.Range:0.0to255.0.(default:255)

green number(range:0-255)

r/w Thegreencolorvalue.Range:0.0to255.0.(default:255)

hexValue string r/w Thehexrepresentationofthiscolor.

red number(range:0-255)

r/w Theredcolorvalue.Range:0.0to255.0.(default:255)

Elementof ExportOptionsSaveForWeb.matteColorGalleryCustomColorOptions.activeLinkColorGalleryCustomColorOptions.backgroundColorGalleryCustomColorOptions.bannerColorGalleryCustomColorOptions.linkColorGalleryCustomColorOptions.textColorGalleryCustomColorOptions.visitedLinkColorGallerySecurityOptions.textColorPicturePackageOptions.textColorSolidColor.nearestWebColorSolidColor.nearestWebColorSolidColor.rgbSolidColor.rgb


Contents::Index

PathItem Apathordrawingobject,suchastheoutlineofashapeorastraightorcurved

line,whichcontainssubpathsthatcompriseitsgeometry.

QuickLinks add,deselect,duplicate,duplicate,fillPath,makeClippingPathmakeSelection,remove,removeAll,select,strokePath

Hierarchy Object

PathItem


kind PathKind:PathKind.NORMALPATHPathKind.CLIPPINGPATHPathKind.WORKPATHPathKind.VECTORMASKPathKind.TEXTMASK

r/w Thetypeofpath.

name string r/w Thenameofthepathitem.


subPathItems SubPathItems SubPathItem readonly Thesubpathobjectsforthispathitem.


Methods InstancesPathItemadd()Addsanelement.

voiddeselect()Unselectstheselection,nopathitemsareselected.

PathItemduplicate(relativeObject:Object,insertionLocation

ElementPlacement)Duplicatethisobject.Parameter Type



PathItemduplicate([name:string])Duplicatesthispathitem.Parameter Type Description

name string Thenameforthenewpath.(Optional)

voidfillPath([fillColor:any][,mode:ColorBlendMode][,preserveTransparency:bool][,feather:number][,antiAlias:wholePath:bool])Fillstheareaenclosedbythepath.Parameter Type

fillColor any

mode ColorBlendMode:ColorBlendMode.NORMALColorBlendMode.DISSOLVEColorBlendMode.BEHINDColorBlendMode.CLEARColorBlendMode.DARKENColorBlendMode.MULTIPLYColorBlendMode.COLORBURNColorBlendMode.LINEARBURNColorBlendMode.LIGHTENColorBlendMode.SCREENColorBlendMode.COLORDODGE

ColorBlendMode.LINEARDODGEColorBlendMode.OVERLAYColorBlendMode.SOFTLIGHTColorBlendMode.HARDLIGHTColorBlendMode.VIVIDLIGHTColorBlendMode.LINEARLIGHTColorBlendMode.PINLIGHTColorBlendMode.DIFFERENCEColorBlendMode.EXCLUSIONColorBlendMode.HUEColorBlendMode.SATURATIONColorBlendMode.COLORColorBlendMode.LUMINOSITYColorBlendMode.HARDMIXBLEND

opacity number


feather number

antiAlias bool

wholePath bool

voidmakeClippingPath([flatness:number])Makesthispathitemtheclippingpathforthisdocument.Parameter Type Description

flatness number Flatnessindevicepixels;tellsthePostScriptprinterhowtoapproximatecurves.Range:0.2to100).(Optional)

voidmakeSelection([feather:number][,antiAlias:bool][,SelectionType])Makesaselectionobject,whoseborderisthepath,fromthispathitemobject.Parameter Type Description

feather number Thefeatheramountinpixels.Range:0.0to250.0.(Optional)

antiAlias bool Iftrue,theselectionusesanti-aliasing.(Optional)

operation SelectionType:SelectionType.REPLACESelectionType.EXTENDSelectionType.DIMINISHSelectionType.INTERSECT

Theselectionbehaviorrelativetotheexistingselection(whenaselectionalreadyexists).(Optional)



voidselect()Makesthispathitemtheactiveorselectedpathitem.

voidstrokePath([tool:ToolType][,simulatePressure:bool

Strokesthepath.Parameter Type

tool ToolType:ToolType.PENCILToolType.BRUSHToolType.ERASERToolType.BACKGROUNDERASERToolType.CLONESTAMPToolType.PATTERNSTAMPToolType.HEALINGBRUSHToolType.HISTORYBRUSHToolType.ARTHISTORYBRUSHToolType.SMUDGEToolType.BLURToolType.SHARPENToolType.DODGEToolType.BURNToolType.SPONGEToolType.COLORREPLACEMENTTOOL

simulatePressure bool

Return PathItemPathItem.add()PathItemPathItem.duplicate(relativeObject:Object,insertionLocation

ElementPlacement)PathItemPathItem.duplicate([name:string])PathItemPathItems.[](index:uint)PathItemPathItems.add(name:string,entirePath:ArrayofPathItemPathItems.getByName(name:string)


Contents::Index

Enumeration

PathKind Thetypeofpath.


PathKind.CLIPPINGPATH Clippingpath. int2

PathKind.NORMALPATH Normalpath. int1

PathKind.TEXTMASK Textmaskpath. int5

PathKind.VECTORMASK Vectormaskpath.

int4

PathKind.WORKPATH Workpath. int3

Usage AspropertyPathItem.kind


Contents::Index

PathPoint Informationaboutanarrayofpathpointinfoobjects.Youdonotuse

thepathpointobjecttocreatepointsthatmakeupapath.Rather,youusethepathpointobjecttoretrieveinformationaboutthepointsthatdescribepathsegments.Tocreatepathpoints,usethepathpointinfoobject.

Hierarchy Object

PathPoint


anchor Point readonly Theposition(coordinates)oftheanchorpoint.

kind PointKind:PointKind.SMOOTHPOINTPointKind.CORNERPOINT

readonly Thetypeofpoint.

leftDirection Point readonly Thelocationoftheleftdirectionpoint(the"in"position).


rightDirection Point readonly Thelocationoftherightdirectionpoint(the"out"position).


Return PathPointPathPoints.[](index:uint)PathPointPathPoints.getByName(name:string)


Contents::Index

PathPointInfo Apointonapath,expressedasanarrayofthreecoordinatearrays:

theanchorpoint,leftdirectionpoint,andrightdirectionpoint.Forpathsthatarestraightsegments(notcurved),thecoordinatesofallthreepointsarethesame.Forcurvedsegements,thecoordinatesaredifferent.Thedifferencebetweentheanchorpointandtheleftorrightdirectionpointsdeterminesthearcofthecurve.Youusetheleftdirectionpointtobendthecurve"outward"ormakeitconvex;youusetherightdirectionpointtobendthecurve"inward"ormakeitconcave.


anchor ArrayofPoint r/w


r/w

leftDirection ArrayofPoint r/w

rightDirection ArrayofPoint r/w


anchor ArrayofPoint r/w


r/w

leftDirection ArrayofPoint r/w

rightDirection ArrayofPoint r/w

Elementof SubPathInfo.entireSubPath


Contents::Index

Enumeration

PointKind Thepathpointkind.


PointKind.CORNERPOINT Thepointmustbeacorner.

int2

PointKind.SMOOTHPOINT Thepointcanbeacurve.

int1

Usage AspropertyPathPoint.kindPathPointInfo.kindPathPointInfo.kind


Contents::Index

Enumeration

ShapeOperation Specifieshowtocombinetheshapesifthedestinationimage

alreadyhasaselection.


ShapeOperation.SHAPEADD Addstheshapes.

ShapeOperation.SHAPEINTERSECT Theresultingshapeistheareaofintersectionbetweenthetwoshapes.

ShapeOperation.SHAPESUBTRACT Subtractstheloadedshapefromtheselectionisthedestinationimage.

ShapeOperation.SHAPEXOR Replacestheshapeinthedestinationimagewiththeloadedselection.

Usage AspropertySubPathInfo.operationSubPathItem.operation


Contents::Index

SubPathInfo Anarrayofpathpointinfoobjectsthatdescribesastraightorcurvedsegment

ofapath.


closed bool

entireSubPath ArrayofPathPointInfo

operation ShapeOperation:ShapeOperation.SHAPEADDShapeOperation.SHAPEXORShapeOperation.SHAPEINTERSECTShapeOperation.SHAPESUBTRACT

Usedin: PathItemPathItems.add(name:string,entirePath:Array


Contents::Index

SubPathItem Informationaboutapath.Youdonotusethesubpathitemobjecttocreate

apath.Rather,youcreatepathsegmentsusingthesubpathinfoobject.Usethesubpathitemobjecttoretrieveinformationaboutapath.Allpropertiesareread-only.

Hierarchy Object

SubPathItem


closed bool

operation ShapeOperation:ShapeOperation.SHAPEADDShapeOperation.SHAPEXORShapeOperation.SHAPEINTERSECTShapeOperation.SHAPESUBTRACT

parent Object

pathPoints PathPoints PathPoint

typename string

Return SubPathItemSubPathItems.[](index:uint)SubPathItemSubPathItems.getByName(name:string

Jongware,28-

Aug-2012v3.0.3i Contents::Index

Enumeration

ToolType Toolsforthestrokepathcommand.


ToolType.ARTHISTORYBRUSH Arthistorybrush.

ToolType.BACKGROUNDERASER Backgrounderaser.

ToolType.BLUR Blur.

ToolType.BRUSH Brush.

ToolType.BURN Burn.

ToolType.CLONESTAMP Clonestamp.

ToolType.COLORREPLACEMENTTOOL Colorreplacementtool.

ToolType.DODGE Dodge.

ToolType.ERASER Eraser.

ToolType.HEALINGBRUSH Healingbrush.

ToolType.HISTORYBRUSH Historybrush.

ToolType.PATTERNSTAMP Patternstamp.

ToolType.PENCIL Pencil.

ToolType.SHARPEN Sharpen.

ToolType.SMUDGE Smudge.

ToolType.SPONGE Sponge.

Usage InfunctionvoidPathItem.strokePath([tool:ToolType][,simulatePressure

bool])


Contents::Index

Notifier Anevent-handlerobjectthattellsthescripttoexecute

specifiedcodewhenaspecifiedeventoccurs.Fornotifierstowork,theymustbeenabled.Seethe'notifiersenabled'propertyoftheApplicationobject.Eventsthatoccurwithinscriptsdonotgenerallytriggernotifiers,becausetheyoccurinsideofa"playscript"event.

QuickLinks remove,removeAll

Hierarchy Object

Notifier


event string readonly TheeventIDinfourcharactersorauniquestringthatthenotifierisassociatedwith.

eventClass string readonly TheclassIDassociatedwiththeeventfortheNotifierobject,fourcharactersorauniquestring.

eventFile File readonly Thepathtothefiletoexecutewhentheeventoccurs/activatesthenotifier.



Methods Instancesvoidremove()Deletesthisobject.


Return NotifierNotifiers.[](index:uint)NotifierNotifiers.add(event:string,eventFile:File[,

eventClass:string])NotifierNotifiers.getByName(name:string)


Contents::Index

ActionDescriptor Arecordofkey-valuepairsforactions,such

asthoseincludedontheAdobePhotoshopActionsmenu.TheActionDescriptorclassispartoftheActionManagerfunctionality.FormoredetailsontheActionManager,seethePhotoshopScriptingGuide.

QuickLinks clear,erase,fromStream,getBoolean,getClass,getData,getDouble,getEnumerationType,getEnumerationValuegetInteger,getKey,getList,getObjectTypegetObjectValue,getPath,getReference,getString,getType,getUnitDoubleType,getUnitDoubleValue,hasKey,isEqual,putBoolean,putClass,putData,putDoubleputEnumerated,putInteger,putList,putObject,putPath,putReference,putStringputUnitDouble,toStream


count int readonly Thenumberofkeyscontainedinthedescriptor.


count int readonly Thenumberofkeyscontainedinthedescriptor.

Methods Instancesvoidclear()Clearsthedescriptor.

voiderase(key:number)Erasesakeyfromthedescriptor.Parameter Type Description

key number

voidfromStream(value:string)Createsadescriptorfromastreamofbytes;forreadingfromdisk.Parameter Type Description

value string

boolgetBoolean(key:number)Getsthevalueofakeyoftypeboolean.Parameter Type Description

key number

numbergetClass(key:number)Getsthevalueofakeyoftypeclass.Parameter Type Description

key number

stringgetData(key:number)Getsrawbytedataasastringvalue.Parameter Type Description

key number

numbergetDouble(key:number)Getsthevalueofakeyoftypedouble.Parameter Type Description

key number

numbergetEnumerationType(key:numberGetstheenumerationtypeofakey.Parameter Type Description

key number

numbergetEnumerationValue(key:number)Getstheenumerationvalueofakey.Parameter Type Description

key number

numbergetInteger(key:number)Getsthevalueofakeyoftypeinteger.Parameter Type Description

key number

numbergetKey(key:number)GetstheIDoftheNthkey,providedbyindex.Parameter Type Description

key number

ActionListgetList(key:number)Getsthevalueofakeyoftypelist.Parameter Type Description

key number

numbergetObjectType(key:number)GetstheclassIDofanobjectinakeyoftypeobject.Parameter Type Description

key number

ActionDescriptorgetObjectValue(key:number)Getsthevalueofakeyoftypeobject.Parameter Type Description

key number

FilegetPath(key:number)GetsthevalueofakeyoftypeFile.Parameter Type Description

key number

ActionReferencegetReference(key:number)GetsthevalueofakeyoftypeActionReference.Parameter Type Description

key number

stringgetString(key:number)Getsthevalueofakeyoftypestring.Parameter Type Description

key number

DescValueTypegetType(key:number)Getsthetypeofakey.Parameter Type Description

key number

numbergetUnitDoubleType(key:numberGetstheunittypeofakeyoftypeUnitDouble.Parameter Type Description

key number

numbergetUnitDoubleValue(key:number...Parameter Type Description

key number

boolhasKey(key:number)...


key number

boolisEqual(otherDesc:ActionDescriptor...Parameter Type Description

otherDesc ActionDescriptor

voidputBoolean(key:number,value:bool...Parameter Type Description

key number

value bool

voidputClass(key:number,value:number...Parameter Type Description

key number

value number

voidputData(key:number,value:string)...Parameter Type Description

key number

value string

voidputDouble(key:number,value:number)...Parameter Type Description

key number

value number

voidputEnumerated(key:number,enumType:number,value:number)...Parameter Type Description

key number

enumType number

value number

voidputInteger(key:number,value:number)...Parameter Type Description

key number

value number

voidputList(key:number,value:ActionList)...Parameter Type Description

key number

value ActionList

voidputObject(key:number,classID:number,value:ActionDescriptor)...Parameter Type Description

key number

classID number

value ActionDescriptor

voidputPath(key:number,value:File)...Parameter Type Description

key number

value File

voidputReference(key:number,value:ActionReference)...Parameter Type Description

key number

value ActionReference

voidputString(key:number,value:string...Parameter Type Description

key number

value string

voidputUnitDouble(key:number,unitIDnumber,value:number)...Parameter Type Description

key number

unitID number

value number

stringtoStream()...

Elementof Application.playbackParameters

Usedin: boolActionDescriptor.isEqual(otherDescActionDescriptor)

voidActionDescriptor.putObject(key:number,classID:number,value:ActionDescriptor)

ActionDescriptorApplication.executeAction(eventID:int[,descriptor:ActionDescriptor][,displayDialogs:DialogModes])

voidApplication.putCustomOptions(key:string,customObject:ActionDescriptor[,persistent:bool=true])

Return ActionDescriptorActionDescriptor.getObjectValue(keynumber)

ActionDescriptorApplication.executeAction(eventID:int[,descriptor:ActionDescriptor][,displayDialogs:DialogModes])

ActionDescriptorApplication.executeActionGet(reference:ActionReference)

ActionDescriptorApplication.getCustomOptions(key:string)


Contents::Index

ActionList ThelistofcommandsthatcompriseanAction(suchas

anActioncreatedusingtheActionspaletteintheAdobePhotoshopapplication).TheactionlistobjectispartoftheActionManagerfunctionality.FordetailsonusingtheActionManager,seethePhotoshopScriptingGuide.


count int readonly Thenumberofcommandsthatcomprisetheaction.

Usedin: voidActionDescriptor.putList(key:number,value:ActionList)

Return ActionListActionDescriptor.getList(key:number)


Contents::Index

ActionReference Containsdatadescribingareferenced

Action.TheactionreferenceobjectispartoftheActionManagerfunctionality.FordetailsonusingtheActionManager,seethePhotoshopScriptingGuide.

Usedin: voidActionDescriptor.putReference(key:number,value:ActionReference)

ActionDescriptorApplication.executeActionGet(reference:ActionReference)


Contents::Index

ArtLayers Thecollectionofartlayerobjectsinthedocument.

SeealsoArtLayer.

QuickLinks [],add,getByName,removeAll

Hierarchy Object

ArtLayers


length int readonly Numberofelementsinthecollection.



Methods InstancesArtLayer[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

ArtLayeradd()Addsanelement.

ArtLayergetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

voidremoveAll()

Deletesallelements.

Elementof Document.artLayersLayerSet.artLayers


Contents::Index

Channels Thecollectionofchannelobjectsinthedocument.

SeealsoChannel.


Hierarchy Object

Channels





Methods InstancesChannel[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

Channeladd()Addsanelement.

ChannelgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.channels


Contents::Index

ColorSamplers Thecollectionofcolorsamplersinthe

document.SeealsoColorSampler.

QuickLinks [],add,getByName

Hierarchy Object

ColorSamplers





Methods InstancesColorSampler[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

ColorSampleradd(position:UnitPoint)Createsacolorsampler.Parameter Type Description

position UnitPoint Thehorizontalandvertical(x,y)

locations,respectively,ofthecolorsampler.

ColorSamplergetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.colorSamplers


Contents::Index

CountItems Thecollectionofcountitemsinthedocument.

SeealsoCountItem.


Hierarchy Object

CountItems





Methods InstancesCountItem[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

CountItemadd(position:UnitPoint)Createsacountitem.Parameter Type Description

position UnitPoint Thepositionoforigin.

CountItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.


name string

Elementof Document.countItems


Contents::Index

Documents Acollectionofdocuments.

SeealsoDocument.


Hierarchy Object

Documents





Methods InstancesDocument[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type

index uint

Documentadd([width:UnitValue][,height:UnitValue][,string][,mode:NewDocumentMode=NewDocumentMode.RGBDocumentFill=DocumentFill.WHITE][,pixelAspectRatioBitsPerChannelType=BitsPerChannelType.EIGHT][,Adocument.Parameter Type

width UnitValue

height UnitValue

resolution number

name string

mode NewDocumentMode:NewDocumentMode.GRAYSCALENewDocumentMode.RGBNewDocumentMode.CMYKNewDocumentMode.LABNewDocumentMode.BITMAP

initialFill DocumentFill:DocumentFill.WHITEDocumentFill.BACKGROUNDCOLORDocumentFill.TRANSPARENT

pixelAspectRatio number

bitsPerChannel BitsPerChannelType:BitsPerChannelType.ONEBitsPerChannelType.EIGHTBitsPerChannelType.SIXTEENBitsPerChannelType.THIRTYTWO


DocumentgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type

name string

Elementof Application.documents


Contents::Index

HistoryStates Thehistorystateobjectsassociatedwiththe

document.SeealsoHistoryState.

QuickLinks [],getByName

Hierarchy Object

HistoryStates





Methods InstancesHistoryState[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

HistoryStategetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.historyStates


Contents::Index

LayerComps Thelayercompobjectsassociatedwiththe

document.SeealsoLayerComp.


Hierarchy Object

LayerComps





Methods InstancesLayerComp[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

LayerCompadd(name:string[,comment:string][,appearance:bool=false][,position:bool=false][,visibility:bool=true])Addsalayercomp.Parameter Type Description

name string Thenameofthelayer

comp.

comment string Thedescriptionofthelayercomp.(Optional)

appearance bool Iftrue,usesthelayerappearanceorstyleforthislayercomp.(default:false)(Optional)

position bool Iftrue,usesthelayerpositionforthislayercomp.(default:false)(Optional)

visibility bool Iftrue,usesthelayervisibilityforthislayercomp.(default:true)(Optional)

LayerCompgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.layerComps


Contents::Index

LayerSets Thecollectionoflayersetobjectsinthedocument.

SeealsoLayerSet.


Hierarchy Object

LayerSets





Methods InstancesLayerSet[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

LayerSetadd()Addsanelement.

LayerSetgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

voidremoveAll()

Deletesallelements.

Elementof Document.layerSetsLayerSet.layerSets


Contents::Index

Layers Thecollectionoflayerobjects,includingartlayerandlayer

setobjects,inthedocument.SeealsoLayer.

QuickLinks [],getByName,removeAll

Hierarchy Object

Layers





Methods InstancesLayer[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

LayergetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Document.layersLayerSet.layers


Contents::Index

Notifiers Acollectionofnotifierobjectsinthedocument.

SeealsoNotifier.


Hierarchy Object

Notifiers





Methods InstancesNotifier[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

Notifieradd(event:string,eventFile:File[,eventClass:string])Createsanotifier.Parameter Type Description

event string Theclassidoftheevent,fourcharactersorauniquestring.

eventFile File Thescriptfiletoexecutewhentheeventoccurs.

eventClass string Theclassoftheobjecttheeventis

appliedto,fourcharactersorauniquestring.Whenaneventappliestomultipletypesofobjects,youusetheeventclassparametertodistinguishwhichobjectthisNotifierappliesto.Forexample,theMakeevent(�Mk�)appliestodocuments(�Dcmn�),channels(�Chnl�)andotherobjects.(Optional)

NotifiergetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string


Elementof Application.notifiers


Contents::Index

PathItems Thecollectionofpathitemobjectsinthedocument.

SeealsoPathItem.


Hierarchy Object

PathItems





Methods InstancesPathItem[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

PathItemadd(name:string,entirePath:ArrayofSubPathInfo)Createsanewpathitem.Parameter Type Description

name string Thenameforthenewpath.

entirePath ArrayofSubPathInfo

Theitem'ssubpaths.

PathItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Document.pathItems


Contents::Index

PathPoints Acollectionofpathpointobjectsthatcomprisesthe

pathpointspropertyofthesubpathitemobject.SeealsoPathPoint.


Hierarchy Object

PathPoints





Methods InstancesPathPoint[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

PathPointgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof SubPathItem.pathPoints


Contents::Index

SubPathItems Anarrayofpathpointinfoobjectsthat

describesastraightorcurvedsegmentofapath.Youdonotusethesubpathitemobjecttocreateasubpath.Rather,youusethesubpathitemobjecttoretrieveinformationaboutasubpath.Tocreatesubpaths,seesubpathinfo.SeealsoSubPathItem.


Hierarchy Object

SubPathItems





Methods InstancesSubPathItem[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

SubPathItemgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.


name string

Elementof PathItem.subPathItems


Contents::Index

TextFonts Acollectionoffontsavailableonyourcomputer.

SeealsoTextFont.


Hierarchy Object

TextFonts





Methods InstancesTextFont[](index:uint)Getanelementinthecollectionwiththeprovidedindex.Parameter Type Description

index uint

TextFontgetByName(name:string)Getthefirstelementinthecollectionwiththeprovidedname.Parameter Type Description

name string

Elementof Application.fonts


Contents::Index

Point Describesapoint.Thisclassisalsoatwo-elementcollection.


left number r/w Theleftcoordinate.

length number readonly Thearraylength.(default:2)

top number r/w Thetopcoordinate.

x number r/w Theleftcoordinate.

y number r/w Thetopcoordinate.

Elementof PathPoint.anchorPathPoint.leftDirectionPathPoint.rightDirectionPathPointInfo.anchorPathPointInfo.anchorPathPointInfo.leftDirectionPathPointInfo.leftDirectionPathPointInfo.rightDirectionPathPointInfo.rightDirection

Usedin: voidArtLayer.adjustCurves(curveShape:ArrayofPoint)


Contents::Index

Rectangle Describesarectangle.Thisclassisalsoafour-element

collection.


bottom number r/w Thebottomcoordinate.

height number r/w Theheight.

left number r/w Theleftcoordinate.

length number readonly Thearraylength.(default:4)

right number r/w Therightcoordinate.

top number r/w Thetopcoordinate.

width number r/w Thewidth.

x number r/w Theleftcoordinate.

y number r/w Thetopcoordinate.


Contents::Index

Enumeration

ColorModel Colormodels.


ColorModel.CMYK CMYK. int3

ColorModel.GRAYSCALE Grayscale. int1

ColorModel.HSB HSB. int5

ColorModel.LAB Lab. int4

ColorModel.NONE Thecolormodelhasnotyetbeenassigned.

int50

ColorModel.RGB RGB. int2

Usage AspropertySolidColor.modelSolidColor.model


Contents::Index

Enumeration

DescValueType Thevaluetypeofanobject.


DescValueType.ALIASTYPE Alias.

DescValueType.BOOLEANTYPE Boolean.

DescValueType.CLASSTYPE Class.

DescValueType.DOUBLETYPE Double.

DescValueType.ENUMERATEDTYPE Enumeration.

DescValueType.INTEGERTYPE Integer.

DescValueType.LISTTYPE Actionlist.

DescValueType.OBJECTTYPE Object.

DescValueType.RAWTYPE Raw.

DescValueType.REFERENCETYPE Reference.

DescValueType.STRINGTYPE String.

DescValueType.UNITDOUBLE Unitvalueoftypedouble.

Usage ReturnDescValueTypeActionDescriptor.getType(key


Contents::Index

EPSOpenOptions OptionsthatcanbespecifiedwhenopeningagenericEPSdocument.BaseClass:

OpenOptions

Class Property Type

antiAlias bool

constrainProportions bool

height UnitValue

mode OpenDocumentModeOpenDocumentMode.GRAYSCALEOpenDocumentMode.RGBOpenDocumentMode.CMYKOpenDocumentMode.LAB

resolution number

width UnitValue


Contents::Index

Enumeration

ElementPlacement ControlswherePhotoshopplacesanelement.

Value Name

ElementPlacement.PLACEAFTER

ElementPlacement.PLACEATEND

ElementPlacement.PLACEBEFORE

Usage InfunctionChannelChannel.duplicate(relativeObject

insertionLocation:ElementPlacementDocumentDocument.duplicate(relativeObject

insertionLocation:ElementPlacementLayerLayer.duplicate([relativeObject:

insertionLocation:ElementPlacementLayerLayer.move(relativeObject:Object

insertionLocation:ElementPlacementPathItemPathItem.duplicate(relativeObject

insertionLocation:ElementPlacement


Contents::Index

Enumeration

PDFEncodingType ThetypeofcompressiontousewhensavingadocumentinPDF

format.

Value Name

PDFEncodingType.JPEG

PDFEncodingType.JPEG2000HIGH

PDFEncodingType.JPEG2000LOSSLESS

PDFEncodingType.JPEG2000LOW

PDFEncodingType.JPEG2000MED

PDFEncodingType.JPEG2000MEDHIGH

PDFEncodingType.JPEG2000MEDLOW

PDFEncodingType.JPEGHIGH

PDFEncodingType.JPEGLOW

PDFEncodingType.JPEGMED

PDFEncodingType.JPEGMEDHIGH

PDFEncodingType.JPEGMEDLOW

PDFEncodingType.NONE

PDFEncodingType.PDFZIP

PDFEncodingType.PDFZIP4BIT

Usage AspropertyPDFSaveOptions.encoding


Contents::Index

PDFOpenOptions OptionsthatcanbespecifiedwhenopeningagenericPDFdocument.BaseClass:

OpenOptions

Class Property Type

antiAlias bool

bitsPerChannel BitsPerChannelTypeBitsPerChannelType.ONEBitsPerChannelType.EIGHTBitsPerChannelType.SIXTEENBitsPerChannelType.THIRTYTWO

constrainProportions bool

cropPage CropToType:CropToType.BOUNDINGBOXCropToType.MEDIABOXCropToType.CROPBOXCropToType.BLEEDBOXCropToType.TRIMBOXCropToType.ARTBOX

height UnitValue

mode OpenDocumentModeOpenDocumentMode.GRAYSCALEOpenDocumentMode.RGBOpenDocumentMode.CMYKOpenDocumentMode.LAB

name string

page int

resolution number

suppressWarnings bool

usePageNumber bool

width UnitValue


Contents::Index

Enumeration

ReferenceFormType Thetypeofactionreferenceobject.

Value Name

ReferenceFormType.CLASSTYPE

ReferenceFormType.ENUMERATED

ReferenceFormType.IDENTIFIER

ReferenceFormType.INDEX

ReferenceFormType.NAME

ReferenceFormType.OFFSET

ReferenceFormType.PROPERTY

Usage


Contents::Index

SolidColor Acolordefinitionusedinthedocument.

QuickLinks isEqual


cmyk CMYKColor r/w

gray GrayColor r/w

hsb HSBColor r/w

lab LabColor r/w

model ColorModel:ColorModel.GRAYSCALEColorModel.RGBColorModel.CMYKColorModel.LABColorModel.HSBColorModel.NONE

r/w

nearestWebColor RGBColor readonly

rgb RGBColor r/w


cmyk CMYKColor r/w

gray GrayColor r/w

hsb HSBColor r/w

lab LabColor r/w

model ColorModel:ColorModel.GRAYSCALEColorModel.RGBColorModel.CMYKColorModel.LABColorModel.HSBColorModel.NONE

r/w

nearestWebColor RGBColor readonly

rgb RGBColor r/w

Methods InstancesboolisEqual(color:SolidColor)Comparestwocolors.


color SolidColor Anothercolortocomparewith.

Elementof Application.backgroundColorApplication.foregroundColorChannel.colorColorSampler.colorDocumentPrintSettings.backgroundColorTextItem.color

Usedin: voidArtLayer.photoFilter([fillColor:SolidColor][,densitypreserveLuminosity:bool=true])

boolSolidColor.isEqual(color:SolidColor)


Contents::Index

global Theglobalmethodsandproperties.

QuickLinks alert,confirm,decodeURI,decodeURIComponent,encodeURI,encodeURIComponent,escape,eval,isFinite,isNaN,isXMLName,localize,parseFloat,parseInt,prompt,setDefaultXMLNamespace,unescape,uneval


BridgeTalk BridgeTalk r/w TheglobalBridgeTalkobject.

Infinity number r/w TheInfinityglobalpropertyisapredefinedvariablewiththevalueforinfinity.

NaN number r/w TheNaNglobalpropertyisapredefinedvariablewiththevalueNaN(Not-a-Number),asspecifiedbytheIEEE-754standard.

app Application readonly Theapplicationobject

undefined Undefined r/w Thisglobalpropertyisapredefinedvariablewiththevalueforanundefinedvalue.

Methods voidalert(message:string[,title:string][,errorIcon:bool=false])DisplaysanalertboxParameter Type Description

message string Thetexttodisplay

title string Thetitleofthealert;ignoredontheMacintosh(Optional)

errorIcon bool DisplayanErroricon;ignoredontheMacintosh(default:false)

boolconfirm(message:string[,noAsDefault:bool=false][,title:string])DisplaysanalertboxwithYesandNobuttons;returnstrueforYesParameter Type Description

message string Thetexttodisplay

noAsDefault bool SettotruetosettheNobuttonasthedefaultbutton(default:false)

title string Thetitleofthealert;ignoredontheMacintosh(Optional)

stringdecodeURI(uri:string)DecodesastringcreatedwithencodeURI().Parameter Type Description

uri string Thetexttodecode.

stringdecodeURIComponent(uri:string)DecodesastringcreatedwithencodeURIComponent().Parameter Type Description

uri string Thetexttodecode.

stringencodeURI(text:string)EncodesastringafterRFC2396.CreateanUTF-8ASCIIencodedversionofthisstring.ThestringisconvertedintoUTF-8.Everynon-alphanumericcharacterisencodedasapercentescapecharacteroftheform%xx,wherexxisthehexvalueofthecharacter.AftertheconversiontoUTF-8encodingandescaping,itisguaranteedthatthestringdoesnotcontaincharacterscodesgreaterthan127.Thelistofcharactersnottobeencodedis-_.!~*'();/?:@&=+$,#.Themethodreturnsfalseonerrors.


text string Thetexttoencode.

stringencodeURIComponent(text:string)EncodesastringafterRFC2396.CreateanUTF-8ASCIIencodedversionofthisstring.ThestringisconvertedintoUTF-8.Everynon-alphanumericcharacterisencodedasapercentescapecharacteroftheform%xx,wherexxisthehexvalueofthecharacter.AftertheconversiontoUTF-8encodingandescaping,itisguaranteedthatthestringdoesnotcontaincharacterscodesgreaterthan127.Thelistofcharactersnottobeencodedis-_.!~*'().Themethodreturnsfalseonerrors.Parameter Type Description

text string Thetexttoencode.

stringescape(aString:string)CreatesaURL-encodedstringfromaString.Inthenewstring,charactersofaStringthatrequireURLencodingarereplacedwiththeformat%xx,wherexxisthehexadecimalvalueofthecharactercodeintheUnicodecharacterset.ThisformatisusedtotransmitinformationappendedtoaURLduring,forexample,executionoftheGETmethod.Usetheunescape()globalfunctiontotranslatethestringbackintoitsoriginalformat.ReturnsastringwhichisaStringURL-encoded.Parameter Type Description

aString string Thestringtobeencoded.

Example escape(aString)

anyeval(stringExpression:string)EvaluatesitsargumentasaJavaScriptscript,andreturnstheresultofevaluation.Youcanpasstheresultofanobject'stoSource()methodtoreconstructthatobject.Parameter Type Description

stringExpression string Thestringtoevaluate.

Example eval(stringExpression)

boolisFinite(expression:number)Evaluatesanexpressionandreportswhethertheresultisafinitenumber.Returnstrueiftheexpressionisafinitenumber,falseotherwise.Falseifthevalueisinfinityornegativeinfinity.Parameter Type Description

expression number AnyvalidJavaScriptexpression.

Example isFinite(expression)

boolisNaN(expression:number)Evaluatesanexpressionandreportswhethertheresultis"Not-a-Number"(NaN).Returnstrueiftheresultofevaluationisnotanumber(NaN),falseifthevalueisanumber.Parameter Type Description

expression number AnyvalidJavaScriptexpression.

Example isNaN(expression)

boolisXMLName(name:string)ReturnstrueisthesuppliedstringisavalidXMLname.Parameter Type Description

name string TheXMLnametotest.

stringlocalize(what:string[,argument:any])LocalizesaZString-encodedstringandmergesadditionalargumentsintothestring.Parameter Type Description

what string Thestringtolocalize.AZString-encodedstringthatcancontainplaceholderforadditionalargumentsintheform%1to%n.

argument any Optionalargument(s)tobemergedintothestring.(Optional)

numberparseFloat(text:string)Extractsafloating-pointnumberfromastring.Parsesastringtofindthefirstsetofcharactersthatcanbeconvertedtoafloatingpointnumber,andreturnsthatnumber,orNaNifitdoesnotencountercharactersthatitcanconvertedtoanumber.Thefunctionsupportsexponentialnotation.Parameter Type Description

text string Thestringfromwhichtoextractafloatingpointnumber.

Example parseFloat(aString)

numberparseInt(text:string[,base:number])Extractsanintegerfromastring.Parsesastringtofindthefirstsetofcharacters,inaspecifiedbase,thatcanbeconvertedtoaninteger,andreturnsthatinteger,orNaNifitdoesnotencountercharactersthatitcanconverttoanumber.Parameter Type Description

text string Thestringfromwhichtoextractaninteger.

base number(range:2-36)

Thebaseofthestringtoparse(frombase2tobase36).Ifnotsupplied,baseisdeterminedbytheformatofstring.(Optional)

Example parseInt(aString,base)

stringprompt(prompt:string[,default:string][,title:string])DisplaysadialogallowingtheusertoentertextReturnsnulliftheusercancelledthedialog,thetextotherwiseParameter Type Description

prompt string Thetexttodisplay

default string Thedefaulttexttopresettheeditfield

with(Optional)

title string Thetitleofthedialog;(Optional)

voidsetDefaultXMLNamespace(namespace:Namespace)DefinesthedefaultXMLnamespace.ThisisareplacementfunctionforthestandardJavaScriptstatementsetdefaultxmlnamespace.Parameter Type Description

namespace Namespace Thenamespacetouse.Omitthisparametertoreturntotheemptynamespace.ThisiseitheraNamespaceobjectorastring.

stringunescape(stringExpression:string)TranslatesURL-encodedstringintoaregularstring,andreturnsthatstring.Usetheescape()globalfunctiontoURL-encodestrings.Parameter Type Description

stringExpression string TheURL-encodedstringtoconvert.

Example unescape(stringExpression)

stringuneval(what:any)Createsasourcecoderepresentationofthesuppliedargument,andreturnsitasastring.Parameter Type Description

what any Theobjecttouneval.


Contents::Index