{ "product": "Photoshop", "slug": "photoshop", "version": "Adobe Photoshop CC 2015.5 Object Library", "generated": "2026-09-16", "counts": { "objects": 226, "properties": 1524, "events": 0, "methods": 253 }, "objects": [ { "name": "ActionDescriptor", "kind": "Object", "description": "A record of key-value pairs for actions, such as those included on the Adobe Photoshop Actions menu. The ActionDescriptor class is part of the Action Manager functionality. For more details on the Action Manager, see the Photoshop Scripting Guide.", "properties": [ { "name": "count", "type": "number", "description": "The number of keys contained in the descriptor.", "access": "readonly", "static": true } ], "events": [], "methods": [] }, { "name": "ActionList", "kind": "Object", "description": "The list of commands that comprise an Action (such as an Action created using the Actions palette in the Adobe Photoshop application). The action list object is part of the Action Manager functionality. For details on using the Action Manager, see the Photoshop Scripting Guide.", "properties": [ { "name": "count", "type": "number", "description": "The number of commands that comprise the action.", "access": "readonly", "static": true } ], "events": [], "methods": [] }, { "name": "ActionReference", "kind": "Object", "description": "Contains data describing a referenced Action. The action reference object is part of the Action Manager functionality. For details on using the Action Manager, see the Photoshop Scripting Guide.", "properties": [], "events": [], "methods": [] }, { "name": "AdjustmentReference", "kind": "Enumeration", "description": "Method to use for interpreting selective color adjustment specifications.", "properties": [ { "name": "ABSOLUTE", "type": "number", "description": "A percentage of the whole.", "access": "readonly", "value": "2" }, { "name": "RELATIVE", "type": "number", "description": "A percentage of the existing color amount.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "AnchorPosition", "kind": "Enumeration", "description": "The point around which to transform the object.", "properties": [ { "name": "BOTTOMCENTER", "type": "number", "description": "The middle point of the bottom of the object.", "access": "readonly", "value": "8" }, { "name": "BOTTOMLEFT", "type": "number", "description": "The bottom left corner of the object.", "access": "readonly", "value": "7" }, { "name": "BOTTOMRIGHT", "type": "number", "description": "The bottom right corner of the object.", "access": "readonly", "value": "9" }, { "name": "MIDDLECENTER", "type": "number", "description": "The center of the object.", "access": "readonly", "value": "5" }, { "name": "MIDDLELEFT", "type": "number", "description": "The middle point on the left side of the object.", "access": "readonly", "value": "4" }, { "name": "MIDDLERIGHT", "type": "number", "description": "The middle point on the right side of the object.", "access": "readonly", "value": "6" }, { "name": "TOPCENTER", "type": "number", "description": "The middle point on the top of the object.", "access": "readonly", "value": "2" }, { "name": "TOPLEFT", "type": "number", "description": "The top left corner of the object.", "access": "readonly", "value": "1" }, { "name": "TOPRIGHT", "type": "number", "description": "The top right corner of the object.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "AntiAlias", "kind": "Enumeration", "description": "The method to use to smooth edges by softening the color transition between edge pixels and background pixels.", "properties": [ { "name": "CRISP", "type": "number", "description": "Makes type appear somewhat sharp.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "Does not use anti-aliasing.", "access": "readonly", "value": "1" }, { "name": "SHARP", "type": "number", "description": "Makes type appear its sharpest.", "access": "readonly", "value": "2" }, { "name": "SMOOTH", "type": "number", "description": "Makes type appear smoother.", "access": "readonly", "value": "5" }, { "name": "STRONG", "type": "number", "description": "Makes type appear heavier.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "Application", "kind": "Object", "description": "The Adobe Photoshop application object, which contains all other Adobe Photoshop objects.", "properties": [ { "name": "activeDocument", "type": "Document", "description": "The frontmost document.", "access": "read/write" }, { "name": "backgroundColor", "type": "SolidColor", "description": "The default background color (used to paint, fill, and stroke selections).", "access": "read/write" }, { "name": "build", "type": "string", "description": "The build number of Adobe Photoshop application.", "access": "readonly" }, { "name": "colorSettings", "type": "any", "description": "The name of the selected color setting's set.", "access": "read/write" }, { "name": "currentTool", "type": "string", "description": "Name of the current tool.", "access": "read/write" }, { "name": "displayDialogs", "type": "DialogModes", "description": "The dialog mode for the document, which indicates whether or not Photoshop displays dialogs when the script runs.", "access": "read/write" }, { "name": "documents", "type": "Documents", "description": "The collection of open documents.", "access": "readonly" }, { "name": "fonts", "type": "TextFonts", "description": "The fonts installed on this system.", "access": "readonly" }, { "name": "foregroundColor", "type": "SolidColor", "description": "The default foreground color (used to paint, fill, and stroke selections).", "access": "read/write" }, { "name": "freeMemory", "type": "number", "description": "The amount of unused memory available to Photoshop.", "access": "readonly" }, { "name": "locale", "type": "string", "description": "The language locale of the application.", "access": "readonly" }, { "name": "macintoshFileTypes", "type": "string[]", "description": "A list of the image file types Photoshop can open.", "access": "readonly" }, { "name": "measurementLog", "type": "MeasurementLog", "description": "The log of measurements taken.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The application name.", "access": "readonly" }, { "name": "notifiers", "type": "Notifiers", "description": "The notifiers currently configured (in the Scripts Events Manager menu in the application).", "access": "readonly" }, { "name": "notifiersEnabled", "type": "boolean", "description": "If true, notifiers are enabled.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "path", "type": "File", "description": "The full path of the location of the Adobe Photoshop application.", "access": "readonly" }, { "name": "playbackDisplayDialogs", "type": "DialogModes", "description": "The dialog mode for playback mode, which indicates whether or not Photoshop displays dialogs in playback mode.", "access": "read/write" }, { "name": "playbackParameters", "type": "ActionDescriptor", "description": "The playback options, which indicate the speed at which Photoshop plays actions.", "access": "read/write" }, { "name": "preferences", "type": "Preferences", "description": "The application preference settings (equivalent to selecting Edit > Preferences in the Adobe Photoshop application in Windows or Photoshop > Preferences in Mac OS).", "access": "readonly" }, { "name": "preferencesFolder", "type": "File", "description": "The full path to the preferences folder.", "access": "readonly" }, { "name": "recentFiles", "type": "FileArray", "description": "Files in the Recent Files list.", "access": "readonly" }, { "name": "scriptingBuildDate", "type": "string", "description": "The build date of the scripting interface.", "access": "readonly" }, { "name": "scriptingVersion", "type": "string", "description": "The version of the Scripting interface.", "access": "readonly" }, { "name": "systemInformation", "type": "string", "description": "System information of the host application and machine.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "version", "type": "string", "description": "The version of Adobe Photoshop application that you are running.", "access": "readonly" }, { "name": "windowsFileTypes", "type": "string[]", "description": "A list of the image file extensions Photoshop can open.", "access": "readonly" } ], "events": [], "methods": [ { "name": "applyToolBrushFromFile", "returns": "void", "description": "PRIVATE - set the current tool brush from a file.", "parameters": [ { "name": "file", "type": "File", "description": "Brush file to apply." } ] }, { "name": "batch", "returns": "string", "description": "Runs the batch automation routine; analogous to using the Batch command in Photoshop.", "parameters": [ { "name": "inputFiles", "type": "AliasArray", "description": "The files to operate on." }, { "name": "action", "type": "string", "description": "The name of the action to play (note that the Action name is case-sensitive and must match the name in the Actions palette)." }, { "name": "from", "type": "string", "description": "The name of the action set containing the action being played (note that the Action Set name is case-sensitive and must match the name in the Actions palette)." }, { "name": "options", "type": "BatchOptions", "description": "Options for batch automation.", "optional": true } ] }, { "name": "beep", "returns": "void", "description": "Alerts the user.", "parameters": [] }, { "name": "bringToFront", "returns": "void", "description": "Makes Photoshop the active application.", "parameters": [] }, { "name": "changeProgressText", "returns": "void", "description": "Changes the text that appears in the progress window.", "parameters": [ { "name": "progressString", "type": "string", "description": "String to show in the progress window." } ] }, { "name": "charIDToTypeID", "returns": "number", "description": "Converts from a four character code to a runtime ID.", "parameters": [ { "name": "charID", "type": "string", "description": "The ID to convert." } ] }, { "name": "doAction", "returns": "void", "description": "Plays the specified action from the Actions palette.", "parameters": [ { "name": "action", "type": "string", "description": "The name of the action to play. (Note that the action name is case-sensitive and must match the name as it appears in the Actions palette.)" }, { "name": "from", "type": "string", "description": "The name of the action set containing the action being played. (Note that the Action Set name is case-sensitive and must match the name as it appears in the Actions palette.)" } ] }, { "name": "doForcedProgress", "returns": "void", "description": "Performs a task with a progress bar. Forces progress bar to display, ignoring the normal heuristics that keep it from showing unnecessarily (e.g. during very short tasks). Other progress APIs must be called periodically to update the progress bar and allow cancelling.", "parameters": [ { "name": "progressString", "type": "string", "description": "String to show in the progress window." }, { "name": "javaScriptString", "type": "string", "description": "JavaScriptString to execute." } ] }, { "name": "doProgress", "returns": "void", "description": "Performs a task with a progress bar. Other progress APIs must be called periodically to update the progress bar and allow cancelling.", "parameters": [ { "name": "progressString", "type": "string", "description": "String to show in the progress window." }, { "name": "javaScriptString", "type": "string", "description": "JavaScriptString to execute." } ] }, { "name": "doProgressSegmentTask", "returns": "boolean", "description": "Sections off a portion of the unused progress bar for execution of a subtask. Returns false on cancel. Use when iterating a list of tasks with unequal run times.", "parameters": [ { "name": "segmentLength", "type": "number", "description": "The length of the current task." }, { "name": "done", "type": "number", "description": "The total length of all completed tasks." }, { "name": "total", "type": "number", "description": "The total length of all tasks." }, { "name": "javaScriptString", "type": "string", "description": "JavaScriptString to execute." } ] }, { "name": "doProgressSubTask", "returns": "boolean", "description": "Sections off a portion of the unused progress bar for execution of a subtask. Returns false on cancel. Use when iterating a simple list of tasks with equal run times.", "parameters": [ { "name": "index", "type": "number", "description": "The 0-based index of the current task." }, { "name": "limit", "type": "number", "description": "The total number of tasks." }, { "name": "javaScriptString", "type": "string", "description": "JavaScriptString to execute." } ] }, { "name": "doProgressTask", "returns": "boolean", "description": "Sections off a portion of the unused progress bar for execution of a subtask. Returns false on cancel.", "parameters": [ { "name": "taskLength", "type": "number", "description": "Amount of the unused progress bar to section off, between 0.0 and 1.0." }, { "name": "javaScriptString", "type": "string", "description": "JavaScriptString to execute." } ] }, { "name": "eraseCustomOptions", "returns": "void", "description": "Removes the specified user objects from the Photoshop registry.", "parameters": [ { "name": "key", "type": "string", "description": "The unique string ID for user object(s) to remove." } ] }, { "name": "executeAction", "returns": "ActionDescriptor", "description": "Plays an ActionManager event.", "parameters": [ { "name": "eventID", "type": "number", "description": "The event to play." }, { "name": "descriptor", "type": "ActionDescriptor", "description": "The action descriptor to play.", "optional": true }, { "name": "displayDialogs", "type": "DialogModes", "description": "The display permissions for dialogs and alert messages.", "optional": true } ] }, { "name": "executeActionGet", "returns": "ActionDescriptor", "description": "Obtains an action descriptor.", "parameters": [ { "name": "reference", "type": "ActionReference", "description": "The reference specification of the property." } ] }, { "name": "featureEnabled", "returns": "boolean", "description": "If true, the specified feature is enabled.", "parameters": [ { "name": "name", "type": "string", "description": "The name of the feature." } ] }, { "name": "getCustomOptions", "returns": "ActionDescriptor", "description": "Retrieves user objects from the Photoshop registry for the ID with value key.", "parameters": [ { "name": "key", "type": "string", "description": "The unique string ID for the user object." } ] }, { "name": "isQuicktimeAvailable", "returns": "boolean", "description": "Returns true if Quicktime is installed.", "parameters": [] }, { "name": "load", "returns": "void", "description": "Loads a support document.", "parameters": [ { "name": "document", "type": "File", "description": "The document to load." } ] }, { "name": "makeContactSheet", "returns": "string", "description": "Creates a contact sheet from multiple files.", "parameters": [ { "name": "inputFiles", "type": "AliasArray", "description": "The files to include." }, { "name": "options", "type": "ContactSheetOptions", "description": "Options for creating the contact sheet.", "optional": true } ] }, { "name": "makePDFPresentation", "returns": "string", "description": "Creates a PDF presentation file.", "parameters": [ { "name": "inputFiles", "type": "AliasArray", "description": "The input files to include in the presentation." }, { "name": "outputFile", "type": "File", "description": "The location of the output file." }, { "name": "options", "type": "PresentationOptions", "description": "Options for the PDF presentation.", "optional": true } ] }, { "name": "makePhotoGallery", "returns": "string", "description": "DEPRECATED. Creates a web photo gallery.", "parameters": [ { "name": "inputFolder", "type": "any", "description": "Folder to process or an array of files to process." }, { "name": "outputFolder", "type": "File", "description": "Location for output files." }, { "name": "options", "type": "GalleryOptions", "description": "Options for the web photo gallery.", "optional": true } ] }, { "name": "makePhotomerge", "returns": "string", "description": "DEPRECATED. Merges multiple files into one, user interaction required.", "parameters": [ { "name": "inputFiles", "type": "AliasArray", "description": "List of input files to include." } ] }, { "name": "makePicturePackage", "returns": "string", "description": "Creates a picture package from multiple files.", "parameters": [ { "name": "inputFiles", "type": "AliasArray", "description": "The files to include." }, { "name": "options", "type": "PicturePackageOptions", "description": "Options for creating a Picture Package.", "optional": true } ] }, { "name": "open", "returns": "Document", "description": "Opens the specified document file(s).", "parameters": [ { "name": "document", "type": "File", "description": "The document(s) to opend." }, { "name": "as", "type": "any", "description": "The document type (The default is to let Photoshop deduce the format).", "optional": true }, { "name": "asSmartObject", "type": "boolean", "description": "Creates a smart object around the document.", "optional": true } ] }, { "name": "openDialog", "returns": "FileArray", "description": "Uses the Photoshop open dialog to select files.", "parameters": [] }, { "name": "purge", "returns": "void", "description": "Purges one or more caches.", "parameters": [ { "name": "target", "type": "PurgeTarget", "description": "The caches to purge." } ] }, { "name": "putCustomOptions", "returns": "void", "description": "Save user objects in the Photoshop registry.", "parameters": [ { "name": "key", "type": "string", "description": "The unique string ID for the user object." }, { "name": "customObject", "type": "ActionDescriptor", "description": "The user-defined custom object to save in the registry." }, { "name": "persistent", "type": "boolean", "description": "If true, the object persists after the script has finished.", "optional": true } ] }, { "name": "refresh", "returns": "void", "description": "Pauses the script until the application refreshes.", "parameters": [] }, { "name": "refreshFonts", "returns": "void", "description": "Force the font list to get refreshed.", "parameters": [] }, { "name": "runMenuItem", "returns": "void", "description": "Run a menu item.", "parameters": [ { "name": "menuID", "type": "number", "description": "Id of menu to run." } ] }, { "name": "saveToolBrushToFile", "returns": "void", "description": "PRIVATE - save the current tool brush to a file.", "parameters": [ { "name": "file", "type": "File", "description": "File to save the brush to." } ] }, { "name": "showColorPicker", "returns": "boolean", "description": "Display color picker dialog. Returns false if dialog is cancelled, true otherwise.", "parameters": [ { "name": "pickForeground", "type": "boolean", "description": "If true the foreground color is chosen, if false the background color is chosen.", "optional": true } ] }, { "name": "stringIDToTypeID", "returns": "number", "description": "Converts from a string ID to a runtime ID.", "parameters": [ { "name": "stringID", "type": "string", "description": "The ID to convert." } ] }, { "name": "system", "returns": "number", "description": "Perform a system call.", "parameters": [ { "name": "callString", "type": "string", "description": "System call string." } ] }, { "name": "thumbnailStyleFile", "returns": "void", "description": "PRIVATE - write out a thumbnail file from a style file.", "parameters": [ { "name": "file", "type": "File", "description": "Style file to read." }, { "name": "dest", "type": "File", "description": "Thumb file to write." }, { "name": "thumbnailSize", "type": "number", "description": "Size of thumbnail to save.", "optional": true }, { "name": "backgroundValue", "type": "number", "description": "Background grayvalue.", "optional": true } ] }, { "name": "thumbnailText", "returns": "void", "description": "PRIVATE - write out a thumbnail file from text parameters.", "parameters": [ { "name": "dest", "type": "File", "description": "Thumb file to write." }, { "name": "text", "type": "string", "description": "Text to render.", "optional": true }, { "name": "font", "type": "string", "description": "PostScript name of font.", "optional": true }, { "name": "size", "type": "number", "description": "Size of type.", "optional": true }, { "name": "color", "type": "SolidColor", "description": "Color of type.", "optional": true } ] }, { "name": "togglePalettes", "returns": "void", "description": "Toggle palette visibility.", "parameters": [] }, { "name": "toolSupportsBrushes", "returns": "boolean", "description": "Check if the specified tool supports brushes.", "parameters": [ { "name": "tool", "type": "string", "description": "The name of the tool to check." } ] }, { "name": "typeIDToCharID", "returns": "string", "description": "Converts from a runtime ID to a character ID.", "parameters": [ { "name": "typeID", "type": "number", "description": "The ID to convert." } ] }, { "name": "typeIDToStringID", "returns": "string", "description": "Converts from a runtime ID to a string ID.", "parameters": [ { "name": "typeID", "type": "number", "description": "The ID to convert." } ] }, { "name": "updateProgress", "returns": "boolean", "description": "Updates the progress bar started by doProgress. Use for manual non-task based progress updating. Returns false on cancel.", "parameters": [ { "name": "done", "type": "number", "description": "The number of tasks completed." }, { "name": "total", "type": "number", "description": "The total number of tasks." } ] } ] }, { "name": "ArtLayer", "kind": "Object", "description": "An object within a document that contains the visual elements of the image (equivalent to a layer in the Adobe Photoshop application).", "extends": "Layer", "properties": [ { "name": "fillOpacity", "type": "number", "description": "The interior opacity of the layer. Range: 0.0 to 100.0.", "access": "read/write" }, { "name": "filterMaskDensity", "type": "number", "description": "The density of the filter mask (between 0.0 and 100.0)", "access": "read/write" }, { "name": "filterMaskFeather", "type": "number", "description": "The feather of the filter mask (between 0.0 and 250.0)", "access": "read/write" }, { "name": "grouped", "type": "boolean", "description": "If true, the layer is grouped with the layer below.", "access": "read/write" }, { "name": "isBackgroundLayer", "type": "boolean", "description": "If true, the layer is a background layer.", "access": "read/write" }, { "name": "kind", "type": "LayerKind", "description": "Sets the layer kind (such as 'text layer') for an empty layer. Valid only when the layer is empty and when 'is background layer ' is false. You can use the 'kind ' property to make a background layer a normal layer; however, to make a layer a background layer, you must set 'is background layer' to true.", "access": "read/write" }, { "name": "layerMaskDensity", "type": "number", "description": "The density of the layer mask (between 0.0 and 100.0)", "access": "read/write" }, { "name": "layerMaskFeather", "type": "number", "description": "The feather of the layer mask (between 0.0 and 250.0)", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pixelsLocked", "type": "boolean", "description": "If true, the pixels in the layer's image cannot be edited.", "access": "read/write" }, { "name": "positionLocked", "type": "boolean", "description": "If true, the pixels in the layer's image cannot be moved within the layer.", "access": "read/write" }, { "name": "textItem", "type": "TextItem", "description": "The text that is associated with the layer. Valid only when 'kind' is text layer.", "access": "readonly" }, { "name": "transparentPixelsLocked", "type": "boolean", "description": "If true, editing is confined to the opaque portions of the layer.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "vectorMaskDensity", "type": "number", "description": "The density of the vector mask (between 0.0 and 100.0)", "access": "read/write" }, { "name": "vectorMaskFeather", "type": "number", "description": "The feather of the vector mask (between 0.0 and 250.0)", "access": "read/write" } ], "events": [], "methods": [ { "name": "add", "returns": "ArtLayer", "description": "Adds an element.", "parameters": [] }, { "name": "adjustBrightnessContrast", "returns": "void", "description": "Adjusts the brightness and constrast.", "parameters": [ { "name": "brightness", "type": "number", "description": "The brightness amount. Range: -100 to 100." }, { "name": "contrast", "type": "number", "description": "The contrast amount. Range: -100 to 100." } ] }, { "name": "adjustColorBalance", "returns": "void", "description": "Adjusts the color balance of the layer's component channels.", "parameters": [ { "name": "shadows", "type": "number[]", "description": "The adjustments for the shadows. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.", "optional": true }, { "name": "midtones", "type": "number[]", "description": "The adjustments for the midtones. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.", "optional": true }, { "name": "highlights", "type": "number[]", "description": "The adjustments for the highlights. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.", "optional": true }, { "name": "preserveLuminosity", "type": "boolean", "description": "If true, luminosity is preserved.", "optional": true } ] }, { "name": "adjustCurves", "returns": "void", "description": "Adjusts the tonal range of the selected channel using up to fourteen points.", "parameters": [ { "name": "curveShape", "type": "Point[]", "description": "The curve points. The number of points must be between 2 and 14." } ] }, { "name": "adjustLevels", "returns": "void", "description": "Adjusts levels of the selected channels.", "parameters": [ { "name": "inputRangeStart", "type": "number", "description": "The input levels minimum. Range: 0 to 253.", "range": { "min": "0", "max": "253" } }, { "name": "inputRangeEnd", "type": "number", "description": "The input levels maximum. Range: (input range start + 2) to 253." }, { "name": "inputRangeGamma", "type": "number", "description": "The input levels gamma. Range: 0.10 to 9.99." }, { "name": "outputRangeStart", "type": "number", "description": "The output levels minimum. Range: 0 to 253.", "range": { "min": "0", "max": "253" } }, { "name": "outputRangeEnd", "type": "number", "description": "The output levels maximum. Range: (output range start + 2) to 253." } ] }, { "name": "applyAddNoise", "returns": "void", "description": "Applies the add noise filter.", "parameters": [ { "name": "amount", "type": "number", "description": "The amount of noise (as a percentage). Range: 0.1 to 400.0." }, { "name": "distribution", "type": "NoiseDistribution", "description": "The noise distribution type." }, { "name": "monochromatic", "type": "boolean", "description": "If true, applies the filter only to the tonal elements in the image without changing the colors." } ] }, { "name": "applyAverage", "returns": "void", "description": "Applies the average filter.", "parameters": [] }, { "name": "applyBlur", "returns": "void", "description": "Applies the blur filter.", "parameters": [] }, { "name": "applyBlurMore", "returns": "void", "description": "Applies the blur more filter.", "parameters": [] }, { "name": "applyClouds", "returns": "void", "description": "Applies the clouds filter.", "parameters": [] }, { "name": "applyCustomFilter", "returns": "void", "description": "Applies the custom filter.", "parameters": [ { "name": "characteristics", "type": "number[]", "description": "The custom filter characteristics. This is an array of 25 values that corresponds to a left-to-right, top-to- bottom traversal of the array presented in the Custom dialog in the user interface (Filter > Other > Custom)." }, { "name": "scale", "type": "number", "description": "The value by which to divide the sum of the brightness values of the pixels included in the calculation." }, { "name": "offset", "type": "number", "description": "The value to be added to the result of the scale calculation." } ] }, { "name": "applyDeInterlace", "returns": "void", "description": "Applies the de-interlace filter.", "parameters": [ { "name": "eliminateFields", "type": "EliminateFields", "description": "The fields to eliminate." }, { "name": "createFields", "type": "CreateFields", "description": "The method to use to replace eliminated fields." } ] }, { "name": "applyDespeckle", "returns": "void", "description": "Applies the despeckle filter.", "parameters": [] }, { "name": "applyDifferenceClouds", "returns": "void", "description": "Applies the difference clouds filter.", "parameters": [] }, { "name": "applyDiffuseGlow", "returns": "void", "description": "Applies the diffuse glow filter.", "parameters": [ { "name": "graininess", "type": "number", "description": "The amount of graininess. Range: 0 to 10.", "range": { "min": "0", "max": "10" } }, { "name": "glowAmount", "type": "number", "description": "The glow amount. Range: 0 to 20.", "range": { "min": "0", "max": "20" } }, { "name": "clearAmount", "type": "number", "description": "The clear amount. Range: 0 to 20.", "range": { "min": "0", "max": "20" } } ] }, { "name": "applyDisplace", "returns": "void", "description": "Applies the displace filter.", "parameters": [ { "name": "horizontalScale", "type": "number", "description": "The amount of horizontal distortion. Range: -999 to 999." }, { "name": "verticalScale", "type": "number", "description": "The amount of vertical distortion. Range: -999 to 999." }, { "name": "displacementType", "type": "DisplacementMapType", "description": "The displacement type." }, { "name": "undefinedAreas", "type": "UndefinedAreas", "description": "The treatment of undistorted areas." }, { "name": "displacementMapFile", "type": "File", "description": "The distortion image map." } ] }, { "name": "applyDustAndScratches", "returns": "void", "description": "Applies the dust and scratches filter.", "parameters": [ { "name": "radius", "type": "number", "description": "The size (in pixels) of the area searched for dissimilar pixels. Range: 1 to 16.", "range": { "min": "1", "max": "16" } }, { "name": "threshold", "type": "number", "description": "Determines how dissimilar the pixels should be before they are eliminated. Range: 0 to 255.", "range": { "min": "0", "max": "255" } } ] }, { "name": "applyGaussianBlur", "returns": "void", "description": "Applies the gaussian blur filter.", "parameters": [ { "name": "radius", "type": "number", "description": "The blur width in pixels. Range: 1.0 to 250.0." } ] }, { "name": "applyGlassEffect", "returns": "void", "description": "Applies the glass filter.", "parameters": [ { "name": "distortion", "type": "number", "description": "The amount of distortion. Range: 0 to 20.", "range": { "min": "0", "max": "20" } }, { "name": "smoothness", "type": "number", "description": "The smoothness. Range: 1 to 15.", "range": { "min": "1", "max": "15" } }, { "name": "scaling", "type": "number", "description": "The amount of scaling. Range: 50 to 200.", "range": { "min": "50", "max": "200" } }, { "name": "invert", "type": "boolean", "description": "If true, the texture is inverted.", "optional": true }, { "name": "texture", "type": "TextureType", "description": "The type of texture.", "optional": true }, { "name": "textureFile", "type": "File", "description": "The file from which to load the texture type.", "optional": true } ] }, { "name": "applyHighPass", "returns": "void", "description": "Applies the high pass filter.", "parameters": [ { "name": "radius", "type": "number", "description": "The width (in pixels) of the radius where edge details are retained." } ] }, { "name": "applyLensBlur", "returns": "void", "description": "Apply the lens blur filter.", "parameters": [ { "name": "source", "type": "DepthMapSource", "description": "The source for the depth map.", "optional": true }, { "name": "focalDistance", "type": "number", "description": "The blur focal distance (in pixels) for the depth map. RangeL 0 to 255. Valid only when 'source' is transparency or layer mask.", "optional": true }, { "name": "invertDepthMap", "type": "boolean", "description": "If true, inverts the depth map.", "optional": true }, { "name": "shape", "type": "Geometry", "description": "The shape of the iris.", "optional": true }, { "name": "radius", "type": "number", "description": "The radius of the iris. Range: 0 to 100.", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "bladeCurvature", "type": "number", "description": "The blade curvature of the iris. Range: 0 to 100.", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "rotation", "type": "number", "description": "The rotation of the iris (in degrees). Range: 0 to 360.", "range": { "min": "0", "max": "360" }, "optional": true }, { "name": "brightness", "type": "number", "description": "The brightness for the specular highlights. Range: 0 to 100.", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "threshold", "type": "number", "description": "The threshold for the specular highlights. Range: 0 to 255.", "range": { "min": "0", "max": "255" }, "optional": true }, { "name": "amount", "type": "number", "description": "The amount of noise. Range: 0 to 100.", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "distribution", "type": "NoiseDistribution", "description": "The distribution value for the noise.", "optional": true }, { "name": "monochromatic", "type": "boolean", "description": "If true, the noise is monochromatic.", "optional": true } ] }, { "name": "applyLensFlare", "returns": "void", "description": "Applies the lens flare filter.", "parameters": [ { "name": "brightness", "type": "number", "description": "The flare brightness. Range: 10 to 300.", "range": { "min": "10", "max": "300" } }, { "name": "flareCenter", "type": "number[]", "description": "The position of the flare center." }, { "name": "lensType", "type": "LensType", "description": "The lens type." } ] }, { "name": "applyMaximum", "returns": "void", "description": "Applies the maximum filter.", "parameters": [ { "name": "radius", "type": "number", "description": "The choke area (in pixels). Range: 0 to 100.", "range": { "min": "0", "max": "100" } } ] }, { "name": "applyMedianNoise", "returns": "void", "description": "Applies the median noise filter.", "parameters": [ { "name": "radius", "type": "number", "description": "The size of the area searched for pixels of similar brightness. Range: 0 to 100.", "range": { "min": "0", "max": "100" } } ] }, { "name": "applyMinimum", "returns": "void", "description": "Applies the minimum filter.", "parameters": [ { "name": "radius", "type": "number", "description": "The spread area (in pixels). Range: 0 to 100.", "range": { "min": "0", "max": "100" } } ] }, { "name": "applyMotionBlur", "returns": "void", "description": "Applies the motion blur filter.", "parameters": [ { "name": "angle", "type": "number", "description": "The angle (in degrees). Range: -360 to 360." }, { "name": "radius", "type": "number", "description": "The radius (in pixels). Range: 1 to 999.", "range": { "min": "1", "max": "999" } } ] }, { "name": "applyNTSC", "returns": "void", "description": "Applies the NTSC colors filter.", "parameters": [] }, { "name": "applyOceanRipple", "returns": "void", "description": "Applies the ocean ripple filter.", "parameters": [ { "name": "size", "type": "number", "description": "The ripple size. Range: 1 to 15.", "range": { "min": "1", "max": "15" } }, { "name": "magnitude", "type": "number", "description": "The ripple magnitude. Range: 0 to 20.", "range": { "min": "0", "max": "20" } } ] }, { "name": "applyOffset", "returns": "void", "description": "Applies the offset filter.", "parameters": [ { "name": "horizontal", "type": "UnitValue", "description": "The amount (in pixels) to move the selection horizontally (to the right). Range: -6144 to 6144." }, { "name": "vertical", "type": "UnitValue", "description": "The amount (in pixels) to move the selection vertically (downward). Range: -6144 to 6144." }, { "name": "undefinedAreas", "type": "OffsetUndefinedAreas", "description": "The method for filling areas left blank by the offset." } ] }, { "name": "applyPinch", "returns": "void", "description": "Applies the pinch filter.", "parameters": [ { "name": "amount", "type": "number", "description": "The pinch amount. Range: -100 to 100." } ] }, { "name": "applyPolarCoordinates", "returns": "void", "description": "Applies the polar coordinates filter.", "parameters": [ { "name": "conversion", "type": "PolarConversionType", "description": "The conversion type." } ] }, { "name": "applyRadialBlur", "returns": "void", "description": "Applies the radial blur filter.", "parameters": [ { "name": "amount", "type": "number", "description": "The amount of blur. Range: 1 to 100.", "range": { "min": "1", "max": "100" } }, { "name": "blurMethod", "type": "RadialBlurMethod", "description": "The blur method to use." }, { "name": "blurQuality", "type": "RadialBlurQuality", "description": "The smoothness or graininess of the blurred image." }, { "name": "blurCenter", "type": "number[]", "description": "Position (unit value)", "optional": true } ] }, { "name": "applyRipple", "returns": "void", "description": "Applies the ripple filter.", "parameters": [ { "name": "amount", "type": "number", "description": "The ripple amount. Range: -999 to 999." }, { "name": "size", "type": "RippleSize", "description": "The ripple size." } ] }, { "name": "applySharpen", "returns": "void", "description": "Applies the sharpen filter.", "parameters": [] }, { "name": "applySharpenEdges", "returns": "void", "description": "Applies the sharpen edges filter.", "parameters": [] }, { "name": "applySharpenMore", "returns": "void", "description": "Applies the sharpen more filter.", "parameters": [] }, { "name": "applyShear", "returns": "void", "description": "Applies the shear filter.", "parameters": [ { "name": "curve", "type": "any[]", "description": "Specification of the shear curve in points as x,y coordinate pairs in the format [[x1, y1],[x2, y2]]. Any number of coordinate pairs can be specified." }, { "name": "undefinedAreas", "type": "UndefinedAreas", "description": "The treatment of areas left blank by the distortion." } ] }, { "name": "applySmartBlur", "returns": "void", "description": "Applies the smart blur filter.", "parameters": [ { "name": "radius", "type": "number", "description": "The blur radius. Range: 0 - 1000." }, { "name": "threshold", "type": "number", "description": "The blur threshold. Range: 0 - 1000." }, { "name": "blurQuality", "type": "SmartBlurQuality", "description": "The smoothness or graininess of the blurred image." }, { "name": "mode", "type": "SmartBlurMode", "description": "The smart blur mode." } ] }, { "name": "applySpherize", "returns": "void", "description": "Applies the spherize filter.", "parameters": [ { "name": "amount", "type": "number", "description": "The amount of distortion. Range: -100 to 100." }, { "name": "mode", "type": "SpherizeMode", "description": "The distortion mode." } ] }, { "name": "applyStyle", "returns": "void", "description": "Applies the specified style to the layer.", "parameters": [ { "name": "styleName", "type": "string", "description": "The layer style to apply." } ] }, { "name": "applyStyleFile", "returns": "void", "description": "", "parameters": [ { "name": "file", "type": "File", "description": "Style file to apply." } ] }, { "name": "applyTextureFill", "returns": "void", "description": "Applies the texture fill filter.", "parameters": [ { "name": "textureFile", "type": "File", "description": "The texture file. Must be a grayscale Photoshop file." } ] }, { "name": "applyTwirl", "returns": "void", "description": "Applies the twirl filter.", "parameters": [ { "name": "angle", "type": "number", "description": "The twirl angle. Range: -999 to 999." } ] }, { "name": "applyUnSharpMask", "returns": "void", "description": "Applies the unsharp mask filter.", "parameters": [ { "name": "amount", "type": "number", "description": "The amount of sharpening (as a percentage). Range: 1 to 500.", "range": { "min": "1", "max": "500" } }, { "name": "radius", "type": "number", "description": "The radius in pixels. Range: 0.1 to 250.0." }, { "name": "threshold", "type": "number", "description": "The contrast threshold. Range: 0 to 255.", "range": { "min": "0", "max": "255" } } ] }, { "name": "applyWave", "returns": "void", "description": "Applies the wave filter.", "parameters": [ { "name": "generatorNumber", "type": "number", "description": "The number of generators. Range: 1 to 999.", "range": { "min": "1", "max": "999" } }, { "name": "minimumWavelength", "type": "number", "description": "The minimum wave length. Range: 1 to 998.", "range": { "min": "1", "max": "998" } }, { "name": "maximumWavelength", "type": "number", "description": "The maximum wave length. Range: 2 to (minimum wavelength + 1)" }, { "name": "minimumAmplitude", "type": "number", "description": "The minimum amplitude. Range: 1 to 998.", "range": { "min": "1", "max": "998" } }, { "name": "maximumAmplitude", "type": "number", "description": "The maximum amplitude. Range: 2 to (minimum amplitude + 1)" }, { "name": "horizontalScale", "type": "number", "description": "The amount of horizontal scale (as a percentage). Range: 1 to 100.", "range": { "min": "1", "max": "100" } }, { "name": "verticalScale", "type": "number", "description": "The amount of vertical scale (as a percentage). Range: 1 to 100.", "range": { "min": "1", "max": "100" } }, { "name": "waveType", "type": "WaveType", "description": "The wave type." }, { "name": "undefinedAreas", "type": "UndefinedAreas", "description": "The treatment of areas left blank by the distortion." }, { "name": "randomSeed", "type": "number", "description": "The random seed." } ] }, { "name": "applyZigZag", "returns": "void", "description": "Applies the zigzag filter.", "parameters": [ { "name": "amount", "type": "number", "description": "The amount of zigzag. Range: -100 to 100." }, { "name": "ridges", "type": "number", "description": "The ridge length." }, { "name": "style", "type": "ZigZagType", "description": "The zigzag style." } ] }, { "name": "autoContrast", "returns": "void", "description": "Adjusts the contrast of the selected channels automatically.", "parameters": [] }, { "name": "autoLevels", "returns": "void", "description": "Adjust the levels of the selected channels using the auto levels option.", "parameters": [] }, { "name": "clear", "returns": "void", "description": "Cuts the layer without moving it to the clipboard.", "parameters": [] }, { "name": "copy", "returns": "void", "description": "Copies the layer to the clipboard.", "parameters": [ { "name": "merge", "type": "boolean", "description": "If true, the copy includes all visible layers. If false, the copy only copies from the current layer.", "optional": true } ] }, { "name": "cut", "returns": "void", "description": "Cuts the layer to the clipboard.", "parameters": [] }, { "name": "desaturate", "returns": "void", "description": "Converts a color image to a grayscale image in the current color mode by assigning equal values of each component color to each pixel.", "parameters": [] }, { "name": "equalize", "returns": "void", "description": "Redistributes the brightness values of pixels in an image to more evenly represent the entire range of brightness levels within the image.", "parameters": [] }, { "name": "invert", "returns": "void", "description": "Inverts the colors in the layer by converting the brightness value of each pixel in the channels to the inverse value on the 256-step color-values scale.", "parameters": [] }, { "name": "merge", "returns": "ArtLayer", "description": "Merges the layer down, removing the layer from the document. Returns a reference to the art layer that this layer is merged into.", "parameters": [] }, { "name": "mixChannels", "returns": "void", "description": "Modifies a targeted (output) color channel using a mix of the existing color channels in the image. (output channels = An array of channel specifications. For each component channel, specify a list of adjustment values (-200 to 200) followed by a 'constant' value (-200 to 200).) When monochrome = true, the maximum number of channel value specifications is 1. Valid only when 'document mode' = RGB or CMYK. RGB arrays must include four doubles. CMYK arrays must include five doubles.", "parameters": [ { "name": "outputChannels", "type": "any[]", "description": "A list of channel specifications. For each component channel that the document has, you must specify a list of adjustment values followed by a 'constant' value." }, { "name": "monochrome", "type": "boolean", "description": "If true, uses monochrome mixing. Note: If this is true, you can only specify one channel value.", "optional": true } ] }, { "name": "photoFilter", "returns": "void", "description": "Adjusts the layer's color balance and temperature as if a color filter had been applied.", "parameters": [ { "name": "fillColor", "type": "SolidColor", "description": "The color to use for the fill.", "optional": true }, { "name": "density", "type": "number", "description": "The density (as a percentage) of the filter effect. Range: 1 to 100.", "range": { "min": "1", "max": "100" }, "optional": true }, { "name": "preserveLuminosity", "type": "boolean", "description": "If true, luminosity is preserved.", "optional": true } ] }, { "name": "posterize", "returns": "void", "description": "Specifies the number of tonal levels for each channel and then maps pixels to the closest matching level.", "parameters": [ { "name": "levels", "type": "number", "description": "The tonal levels. Range: 2 to 255.", "range": { "min": "2", "max": "255" } } ] }, { "name": "rasterize", "returns": "void", "description": "Converts the targeted content in the layer into a flat, raster image.", "parameters": [ { "name": "target", "type": "RasterizeType", "description": "What to rasterize." } ] }, { "name": "saveStyleFile", "returns": "void", "description": "", "parameters": [ { "name": "file", "type": "File", "description": "File to save the style to." }, { "name": "thumbnail", "type": "File", "description": "File to save the style thumbnail to.", "optional": true }, { "name": "thumbnailSize", "type": "number", "description": "Size of thumbnail to save.", "optional": true }, { "name": "backgroundValue", "type": "number", "description": "Background grayvalue.", "optional": true } ] }, { "name": "selectiveColor", "returns": "void", "description": "", "parameters": [ { "name": "selectionMethod", "type": "AdjustmentReference", "description": "Modifies the amount of a process color in a specified primary color without affecting the other primary colors." }, { "name": "reds", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "yellows", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "greens", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "cyans", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "blues", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "magentas", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "whites", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "neutrals", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true }, { "name": "blacks", "type": "number[]", "description": "Array of 4 values: cyan, magenta, yellow, black.", "optional": true } ] }, { "name": "shadowHighlight", "returns": "void", "description": "Adjusts the range of tones in the shadows and highlights.", "parameters": [ { "name": "shadowAmount", "type": "number", "description": "The shadow amount, as a percentage. Range: 0 to 100.", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "shadowWidth", "type": "number", "description": "The shadow width, as a percentage. Range: 0 to 100 for tonal width (0 = narrow), (100 = broad).", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "shadowRaduis", "type": "number", "description": "The shadow radius (in pixels). Range: 0 to 2500.", "range": { "min": "0", "max": "2500" }, "optional": true }, { "name": "highlightAmount", "type": "number", "description": "The highlight amount, as a percentage. Range: 0 to 100.", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "highlightWidth", "type": "number", "description": "The highlight width. Range: 0 to 100 for tonal width (0 = narrow), (100 = broad).", "range": { "min": "0", "max": "100" }, "optional": true }, { "name": "highlightRaduis", "type": "number", "description": "The highlight radius (in pixels). Range: 0 to 2500.", "range": { "min": "0", "max": "2500" }, "optional": true }, { "name": "colorCorrection", "type": "number", "description": "The amount to adjust the colors in the changed portion of the image. Range: -100 to 100.", "optional": true }, { "name": "midtoneContrast", "type": "number", "description": "The amount of midtone contrast. Range: -100 to 100.", "optional": true }, { "name": "blackClip", "type": "number", "description": "Fractions of whites to be clipped. Range: 0.000 to 50.000.", "optional": true }, { "name": "whiteClip", "type": "number", "description": "Fractions of blacks to be clipped. Range: 0.000 to 50.000.", "optional": true } ] }, { "name": "threshold", "returns": "void", "description": "Converts grayscale or color images to high-contrast, B/W images by converting pixels lighter than the specified threshold to white and pixels darker than the threshold to black.", "parameters": [ { "name": "level", "type": "number", "description": "The threshold level." } ] } ] }, { "name": "ArtLayers", "kind": "Collection", "description": "The collection of art layer objects in the document.", "elementType": "ArtLayer", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "ArtLayer", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "ArtLayer", "description": "Adds an element.", "parameters": [] }, { "name": "getByName", "returns": "ArtLayer", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "AutoKernType", "kind": "Enumeration", "description": "The type of kerning to use for characters.", "properties": [ { "name": "MANUAL", "type": "number", "description": "Allows manual kerning.", "access": "readonly", "value": "1" }, { "name": "METRICS", "type": "number", "description": "Uses kern pairs, which contain information about the spacing of specific pairs of letters.", "access": "readonly", "value": "2" }, { "name": "OPTICAL", "type": "number", "description": "Adjusts the spacing between adjacent characters based on their shapes.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "BMPDepthType", "kind": "Enumeration", "description": "The number of bits per channel (also called pixel depth or color depth). The number selected indicates the exponent of 2. For example, a pixel with a bit-depth of EIGHT has 2-to-the-8th, or 256, possible color values.", "properties": [ { "name": "BMP_A1R5G5B5", "type": "number", "description": "A1 R5 G5 B5 advanced bit depth specification.", "access": "readonly", "value": "61" }, { "name": "BMP_A4R4G4B4", "type": "number", "description": "A4 R4 G4 B4 advanced bit depth specification.", "access": "readonly", "value": "64" }, { "name": "BMP_A8R8G8B8", "type": "number", "description": "A8 R8 G8 B8 advanced bit depth specification (same as normal 32 bit mode)", "access": "readonly", "value": "67" }, { "name": "BMP_R5G6B5", "type": "number", "description": "R5 G6 B5 advanced bit depth specification.", "access": "readonly", "value": "62" }, { "name": "BMP_R8G8B8", "type": "number", "description": "R8 G8 B8 advanced bit depth specification (same as normal 24 bit mode)", "access": "readonly", "value": "65" }, { "name": "BMP_X1R5G5B5", "type": "number", "description": "X1 R5 G5 B5 advanced bit depth specification (same as normal 16 bit mode)", "access": "readonly", "value": "60" }, { "name": "BMP_X4R4G4B4", "type": "number", "description": "X4 R4 G4 B4 advanced bit depth specification.", "access": "readonly", "value": "63" }, { "name": "BMP_X8R8G8B8", "type": "number", "description": "X8 R8 G8 B8 advanced bit depth specification.", "access": "readonly", "value": "66" }, { "name": "EIGHT", "type": "number", "description": "8 bits depth.", "access": "readonly", "value": "8" }, { "name": "FOUR", "type": "number", "description": "4 bits depth.", "access": "readonly", "value": "4" }, { "name": "ONE", "type": "number", "description": "1 bit depth.", "access": "readonly", "value": "1" }, { "name": "SIXTEEN", "type": "number", "description": "16 bits depth.", "access": "readonly", "value": "16" }, { "name": "THIRTYTWO", "type": "number", "description": "32 bits depth.", "access": "readonly", "value": "32" }, { "name": "TWENTYFOUR", "type": "number", "description": "24 bits depth.", "access": "readonly", "value": "24" } ], "events": [], "methods": [] }, { "name": "BMPSaveOptions", "kind": "Object", "description": "Options for saving a document in BMP format.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "depth", "type": "BMPDepthType", "description": "The number of bits per sample.", "access": "read/write", "static": true, "value": "BMPDepthType.TWENTYFOUR" }, { "name": "flipRowOrder", "type": "boolean", "description": "If true, the image is written from bottom to top.", "access": "read/write", "static": true }, { "name": "osType", "type": "OperatingSystem", "description": "The target operating system.", "access": "read/write", "static": true, "value": "OperatingSystem.WINDOWS" }, { "name": "rleCompression", "type": "boolean", "description": "If true, RLE compression is used.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "BatchDestinationType", "kind": "Enumeration", "description": "The destination, if any, for batch-processed files.", "properties": [ { "name": "FOLDER", "type": "number", "description": "Outputs files to a folder.", "access": "readonly", "value": "3" }, { "name": "NODESTINATION", "type": "number", "description": "Leaves all files open.", "access": "readonly", "value": "1" }, { "name": "SAVEANDCLOSE", "type": "number", "description": "Saves changes and closes all files.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "BatchOptions", "kind": "Object", "description": "Options to specify when running a Batch command.", "properties": [ { "name": "destination", "type": "BatchDestinationType", "description": "The type of destination for the processed files.", "access": "read/write", "static": true, "value": "BatchDestinationType.NODESTINATION" }, { "name": "destinationFolder", "type": "File", "description": "The folder location for the processed files. Valid only when 'destination' = folder.", "access": "read/write", "static": true }, { "name": "errorFile", "type": "File", "description": "The file in which to log errors encountered. To display errors on the screen and stop batch processing when errors occur, leave blank.", "access": "read/write", "static": true }, { "name": "fileNaming", "type": "FileNamingType[]", "description": "A list of file naming options. Maximum: 6.", "access": "read/write", "static": true }, { "name": "macintoshCompatible", "type": "boolean", "description": "If true, the final file names are Macintosh compatible.", "access": "read/write", "static": true, "value": "true" }, { "name": "overrideOpen", "type": "boolean", "description": "If true, overrides action open commands.", "access": "read/write", "static": true, "value": "false" }, { "name": "overrideSave", "type": "boolean", "description": "If true, overrides save as action steps with the specified destination.", "access": "read/write", "static": true, "value": "false" }, { "name": "startingSerial", "type": "number", "description": "The starting serial number to use in naming files.", "access": "read/write", "static": true, "value": "1" }, { "name": "suppressOpen", "type": "boolean", "description": "If true, suppresses file open options dialogs.", "access": "read/write", "static": true, "value": "false" }, { "name": "suppressProfile", "type": "boolean", "description": "If true, suppresses color profile warnings.", "access": "read/write", "static": true, "value": "false" }, { "name": "unixCompatible", "type": "boolean", "description": "If true, the final file names are Unix compatible.", "access": "read/write", "static": true, "value": "true" }, { "name": "windowsCompatible", "type": "boolean", "description": "If true, the final file names are Windows compatible.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "BitmapConversionOptions", "kind": "Object", "description": "Options for changing the document mode to Bitmap.", "extends": "DocumentConversionOptions", "properties": [ { "name": "angle", "type": "number", "description": "The angle (in degrees) at which to orient individual dots. Valid only when 'method' = halftone screen. Range: -180 to 180.", "access": "read/write", "static": true }, { "name": "frequency", "type": "number", "description": "The number of printer dots per inch. Valid only when 'method' = halftone screen. Range: 1.0 to 999.99.", "access": "read/write", "static": true }, { "name": "method", "type": "BitmapConversionType", "description": "The conversion method.", "access": "read/write", "static": true, "value": "BitmapConversionType.DIFFUSIONDITHER" }, { "name": "patternName", "type": "string", "description": "The name of the pattern to use. Valid only when 'method' = custom.", "access": "read/write", "static": true }, { "name": "resolution", "type": "number", "description": "The output resolution (in pixels per inch)", "access": "read/write", "static": true, "value": "72" }, { "name": "shape", "type": "BitmapHalfToneType", "description": "The dot shape. Valid only when 'method' = halftone screen.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "BitmapConversionType", "kind": "Enumeration", "description": "The quality of an image converted to bitmap mode.", "properties": [ { "name": "CUSTOMPATTERN", "type": "number", "description": "Simulates the effect of printing a grayscale image through a custom halftone screen. This method lets you apply a screen texture, such as a wood grain, to an image. To use this option, you must first define a pattern.", "access": "readonly", "value": "5" }, { "name": "DIFFUSIONDITHER", "type": "number", "description": "Applies a random pattern that is usually less noticeable than pattern dither. The dither effects are diffused across adjacent pixels. If you select this algorithm, specify a dither percentage to control the amount of dithering applied to the image.", "access": "readonly", "value": "3" }, { "name": "HALFTHRESHOLD", "type": "number", "description": "50% Threshold.", "access": "readonly", "value": "1" }, { "name": "HALFTONESCREEN", "type": "number", "description": "Lets you convert a grayscale image to simulated halftone dots.", "access": "readonly", "value": "4" }, { "name": "PATTERNDITHER", "type": "number", "description": "Applies a halftone-like square pattern to determine the value of pixels.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "BitmapHalfToneType", "kind": "Enumeration", "description": "The shape of the dots (ink deposits) in the halftone screen.", "properties": [ { "name": "CROSS", "type": "number", "description": "Cross.", "access": "readonly", "value": "6" }, { "name": "DIAMOND", "type": "number", "description": "Diamond.", "access": "readonly", "value": "2" }, { "name": "ELLIPSE", "type": "number", "description": "Ellipse.", "access": "readonly", "value": "3" }, { "name": "LINE", "type": "number", "description": "Line.", "access": "readonly", "value": "4" }, { "name": "ROUND", "type": "number", "description": "Round.", "access": "readonly", "value": "1" }, { "name": "SQUARE", "type": "number", "description": "Square.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "BitsPerChannelType", "kind": "Enumeration", "description": "The number of bits per color channel.", "properties": [ { "name": "EIGHT", "type": "number", "description": "8 bits per channel.", "access": "readonly", "value": "8" }, { "name": "ONE", "type": "number", "description": "1 bit per channel.", "access": "readonly", "value": "1" }, { "name": "SIXTEEN", "type": "number", "description": "16 bits per channel.", "access": "readonly", "value": "16" }, { "name": "THIRTYTWO", "type": "number", "description": "32 bits per channel.", "access": "readonly", "value": "32" } ], "events": [], "methods": [] }, { "name": "BlendMode", "kind": "Enumeration", "description": "Controls how pixels in the image are blended.", "properties": [ { "name": "COLORBLEND", "type": "number", "description": "Creates a result color with the luminance of the base color and the hue and saturation of the blend color. This preserves the gray levels in the image and is useful for coloring monochrome images and for tinting color images.", "access": "readonly", "value": "22" }, { "name": "COLORBURN", "type": "number", "description": "Looks at the color information in each channel and darkens the base color to reflect the blend color by increasing the contrast. Blending with white produces no change.", "access": "readonly", "value": "6" }, { "name": "COLORDODGE", "type": "number", "description": "Looks at the color information in each channel and brightens the base color to reflect the blend color by decreasing the contrast. Blending with black produces no change.", "access": "readonly", "value": "10" }, { "name": "DARKEN", "type": "number", "description": "Looks at the color information in each channel and selects the base or blend color—whichever is darker—as the result color. Pixels lighter than the blend color are replaced, and pixels darker than the blend color do not change.", "access": "readonly", "value": "4" }, { "name": "DARKERCOLOR", "type": "number", "description": "Lighter colors lighten the result, and darker colors darken the result. 50% gray as a blend color has no effect on the result color. Lowering the fill opacity creates less posterization/thresholding.", "access": "readonly", "value": "28" }, { "name": "DIFFERENCE", "type": "number", "description": "Looks at the color information in each channel and subtracts either the blend color from the base color or the base color from the blend color, depending on which has the greater brightness value. Blending with white inverts the base color values; blending with black produces no change.", "access": "readonly", "value": "18" }, { "name": "DISSOLVE", "type": "number", "description": "Edits or paints each pixel to make it the result color. However, the result color is a random replacement of the pixels with the base color or the blend color, depending on the opacity at any pixel location.", "access": "readonly", "value": "3" }, { "name": "DIVIDE", "type": "number", "description": "", "access": "readonly", "value": "30" }, { "name": "EXCLUSION", "type": "number", "description": "Creates an effect similar to but lower in contrast than the Difference mode. Blending with white inverts the base color values. Blending with black produces no change.", "access": "readonly", "value": "19" }, { "name": "HARDLIGHT", "type": "number", "description": "Multiplies or screens the colors, depending on the blend color. The effect is similar to shining a harsh spotlight on the image. If the blend color (light source) is lighter than 50% gray, the image is lightened, as if it were screened. This is useful for adding highlights to an image. If the blend color is darker than 50% gray, the image is darkened, as if it were multiplied. This is useful for adding shadows to an image. Painting with pure black or white results in pure black or white.", "access": "readonly", "value": "14" }, { "name": "HARDMIX", "type": "number", "description": "Lighter colors lighten the result, and darker colors darken the result. 50% gray as a blend color has no effect on the result color. Lowering the fill opacity creates less posterization/thresholding.", "access": "readonly", "value": "26" }, { "name": "HUE", "type": "number", "description": "Creates a result color with the luminance and saturation of the base color and the hue of the blend color.", "access": "readonly", "value": "20" }, { "name": "LIGHTEN", "type": "number", "description": "Looks at the color information in each channel and selects the base or blend color—whichever is lighter—as the result color. Pixels darker than the blend color are replaced, and pixels lighter than the blend color do not change.", "access": "readonly", "value": "8" }, { "name": "LIGHTERCOLOR", "type": "number", "description": "Lighter colors lighten the result, and darker colors darken the result. 50% gray as a blend color has no effect on the result color. Lowering the fill opacity creates less posterization/thresholding.", "access": "readonly", "value": "27" }, { "name": "LINEARBURN", "type": "number", "description": "Looks at the color information in each channel and darkens the base color to reflect the blend color by decreasing the brightness. Blending with white produces no change.", "access": "readonly", "value": "7" }, { "name": "LINEARDODGE", "type": "number", "description": "Looks at the color information in each channel and brightens the base color to reflect the blend color by increasing the brightness. Blending with black produces no change.", "access": "readonly", "value": "11" }, { "name": "LINEARLIGHT", "type": "number", "description": "Burns or dodges the colors by decreasing or increasing the brightness, depending on the blend color. If the blend color (light source) is lighter than 50% gray, the image is lightened by increasing the brightness. If the blend color is darker than 50% gray, the image is darkened by decreasing the brightness.", "access": "readonly", "value": "16" }, { "name": "LUMINOSITY", "type": "number", "description": "Creates a result color with the hue and saturation of the base color and the luminance of the blend color. This mode creates an inverse effect from that of the Color mode.", "access": "readonly", "value": "23" }, { "name": "MULTIPLY", "type": "number", "description": "Looks at the color information in each channel and multiplies the base color by the blend color. The result color is always a darker color. Multiplying any color with black produces black. Multiplying any color with white leaves the color unchanged. When you’re painting with a color other than black or white, successive strokes with a painting tool produce progressively darker colors. The effect is similar to drawing on the image with multiple marking pens.", "access": "readonly", "value": "5" }, { "name": "NORMAL", "type": "number", "description": "Edits or paints each pixel to make it the result color. (Called \"Threshold\" when you’re working with a bitmapped or indexed-color image.)", "access": "readonly", "value": "2" }, { "name": "OVERLAY", "type": "number", "description": "Multiplies or screens the colors, depending on the base color. Patterns or colors overlay the existing pixels while preserving the highlights and shadows of the base color. The base color is not replaced but is mixed with the blend color to reflect the lightness or darkness of the original color.", "access": "readonly", "value": "12" }, { "name": "PASSTHROUGH", "type": "number", "description": "Allows any blend modes, advanced blending options, and opacity and fill values applied to layers within a set to affect layers below the set in the Layers palette.", "access": "readonly", "value": "1" }, { "name": "PINLIGHT", "type": "number", "description": "Replaces the colors, depending on the blend color. If the blend color (light source) is lighter than 50% gray, pixels darker than the blend color are replaced, and pixels lighter than the blend color do not change. If the blend color is darker than 50% gray, pixels lighter than the blend color are replaced, and pixels darker than the blend color do not change. This is useful for adding special effects to an image.", "access": "readonly", "value": "17" }, { "name": "SATURATION", "type": "number", "description": "Creates a result color with the luminance and hue of the base color and the saturation of the blend color. Painting with this mode in an area with no (0) saturation (gray) causes no change.", "access": "readonly", "value": "21" }, { "name": "SCREEN", "type": "number", "description": "Looks at each channel’s color information and multiplies the inverse of the blend and base colors. The result color is always a lighter color. Screening with black leaves the color unchanged. Screening with white produces white. The effect is similar to projecting multiple photographic slides on top of each other.", "access": "readonly", "value": "9" }, { "name": "SOFTLIGHT", "type": "number", "description": "Darkens or lightens the colors, depending on the blend color. The effect is similar to shining a diffused spotlight on the image. If the blend color (light source) is lighter than 50% gray, the image is lightened as if it were dodged. If the blend color is darker than 50% gray, the image is darkened as if it were burned in. Painting with pure black or white produces a distinctly darker or lighter area but does not result in pure black or white.", "access": "readonly", "value": "13" }, { "name": "SUBTRACT", "type": "number", "description": "", "access": "readonly", "value": "29" }, { "name": "VIVIDLIGHT", "type": "number", "description": "Burns or dodges the colors by increasing or decreasing the contrast, depending on the blend color. If the blend color (light source) is lighter than 50% gray, the image is lightened by decreasing the contrast. If the blend color is darker than 50% gray, the image is darkened by increasing the contrast.", "access": "readonly", "value": "15" } ], "events": [], "methods": [] }, { "name": "ByteOrderType", "kind": "Enumeration", "description": "The platform-specific order in which bytes will be read.", "properties": [ { "name": "IBM", "type": "number", "description": "IBM PC.", "access": "readonly", "value": "1" }, { "name": "MACOS", "type": "number", "description": "Mac OS.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "CMYKColor", "kind": "Object", "description": "A CMYK color specification.", "extends": "Color", "properties": [ { "name": "black", "type": "number", "description": "The black color value. Range: 0.0 to 100.0.", "access": "read/write", "static": true }, { "name": "black", "type": "number", "description": "The black color value. Range: 0.0 to 100.0.", "access": "read/write" }, { "name": "cyan", "type": "number", "description": "The cyan color value. Range: 0.0 to 100.0.", "access": "read/write", "static": true }, { "name": "cyan", "type": "number", "description": "The cyan color value. Range: 0.0 to 100.0.", "access": "read/write" }, { "name": "magenta", "type": "number", "description": "The magenta color value. Range: 0.0 to 100.0.", "access": "read/write", "static": true }, { "name": "magenta", "type": "number", "description": "The magenta color value. Range: 0.0 to 100.0.", "access": "read/write" }, { "name": "yellow", "type": "number", "description": "The yellow color value. Range: 0.0 to 100.0.", "access": "read/write", "static": true }, { "name": "yellow", "type": "number", "description": "The yellow color value. Range: 0.0 to 100.0.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "CameraRAWOpenOptions", "kind": "Object", "description": "Options for opening a camera RAW document.", "extends": "OpenOptions", "properties": [ { "name": "bitsPerChannel", "type": "BitsPerChannelType", "description": "The number of bits per channel.", "access": "read/write", "static": true }, { "name": "blueHue", "type": "number", "description": "The blue hue of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "blueSaturation", "type": "number", "description": "The blue saturation of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "brightness", "type": "number", "description": "The brightness of the shot. Range: 0 to 150.", "access": "read/write", "static": true, "range": { "min": "0", "max": "150" } }, { "name": "chromaticAberrationBY", "type": "number", "description": "The chromatic aberration B/Y of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "chromaticAberrationRC", "type": "number", "description": "The chromatic aberration R/C of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "colorNoiseReduction", "type": "number", "description": "The color noise reduction of the shot. Range: 0 to 100.", "access": "read/write", "static": true, "range": { "min": "0", "max": "100" } }, { "name": "colorSpace", "type": "ColorSpaceType", "description": "The image color space.", "access": "read/write", "static": true }, { "name": "contrast", "type": "number", "description": "The constrast of the shot. Range: -50 to 100.", "access": "read/write", "static": true }, { "name": "exposure", "type": "number", "description": "The exposure of the shot. Range: -4.0 to 4.0.", "access": "read/write", "static": true }, { "name": "greenHue", "type": "number", "description": "The green hue of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "greenSaturation", "type": "number", "description": "The green saturation of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "luminanceSmoothing", "type": "number", "description": "The luminance smoothing of the shot. Range: 0 to 100.", "access": "read/write", "static": true, "range": { "min": "0", "max": "100" } }, { "name": "redHue", "type": "number", "description": "The red hue of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "redSaturation", "type": "number", "description": "The red saturation of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "resolution", "type": "number", "description": "The resolution of the document (in pixels per inch)", "access": "read/write", "static": true }, { "name": "saturation", "type": "number", "description": "The saturation of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "settings", "type": "CameraRAWSettingsType", "description": "The global settings for all Camera RAW options.", "access": "read/write", "static": true, "value": "CameraRAWSettingsType.CAMERA" }, { "name": "shadowTint", "type": "number", "description": "The shadow tint of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "shadows", "type": "number", "description": "The shadows of the shot. Range: 0 to 100.", "access": "read/write", "static": true, "range": { "min": "0", "max": "100" } }, { "name": "sharpness", "type": "number", "description": "The sharpness of the shot. Range: 0 to 100.", "access": "read/write", "static": true, "range": { "min": "0", "max": "100" } }, { "name": "size", "type": "CameraRAWSize", "description": "The size of the new document.", "access": "read/write", "static": true }, { "name": "temperature", "type": "number", "description": "The temperature of the shot. Range: 2000 to 50000.", "access": "read/write", "static": true, "range": { "min": "2000", "max": "50000" } }, { "name": "tint", "type": "number", "description": "The tint of the shot. Range: -150 to 150.", "access": "read/write", "static": true }, { "name": "vignettingAmount", "type": "number", "description": "The vignetting amount of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "vignettingMidpoint", "type": "number", "description": "The vignetting mid point of the shot. Range: -100 to 100.", "access": "read/write", "static": true }, { "name": "whiteBalance", "type": "WhiteBalanceType", "description": "The white balance options for the image.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "CameraRAWSettingsType", "kind": "Enumeration", "description": "The default Camera RAW settings.", "properties": [ { "name": "CAMERA", "type": "number", "description": "Use the settings of the camera.", "access": "readonly", "value": "0" }, { "name": "CUSTOM", "type": "number", "description": "Use the custom settings.", "access": "readonly", "value": "2" }, { "name": "SELECTEDIMAGE", "type": "number", "description": "Use the settings of the selected image.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "CameraRAWSize", "kind": "Enumeration", "description": "The camera RAW image size.", "properties": [ { "name": "EXTRALARGE", "type": "number", "description": "5120 x 3413 image.", "access": "readonly", "value": "4" }, { "name": "LARGE", "type": "number", "description": "4096 x 2731 image.", "access": "readonly", "value": "3" }, { "name": "MAXIMUM", "type": "number", "description": "6144 x 4096 image.", "access": "readonly", "value": "5" }, { "name": "MEDIUM", "type": "number", "description": "3072 x 2048 image.", "access": "readonly", "value": "2" }, { "name": "MINIMUM", "type": "number", "description": "1536 x 1024 image.", "access": "readonly", "value": "0" }, { "name": "SMALL", "type": "number", "description": "2048 x 1365 image.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Case", "kind": "Enumeration", "description": "The capitalization to use.", "properties": [ { "name": "ALLCAPS", "type": "number", "description": "Uses all uppercase letters.", "access": "readonly", "value": "2" }, { "name": "NORMAL", "type": "number", "description": "Uses uppercase and lowercase letters.", "access": "readonly", "value": "1" }, { "name": "SMALLCAPS", "type": "number", "description": "Uses small caps for lowercase letters.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "ChangeMode", "kind": "Enumeration", "description": "The destination color mode. Note: Color images must be changed to Grayscale mode before you can change them to Bitmap mode.", "properties": [ { "name": "BITMAP", "type": "number", "description": "Bitmap. Note: Color images must be changed to Grayscale mode before you can change them to Bitmap mode.", "access": "readonly", "value": "5" }, { "name": "CMYK", "type": "number", "description": "CMYK.", "access": "readonly", "value": "3" }, { "name": "GRAYSCALE", "type": "number", "description": "Grayscale.", "access": "readonly", "value": "1" }, { "name": "INDEXEDCOLOR", "type": "number", "description": "Indexed color, in which the number of colors in the image is reduced to at most 256, the standard number of colors supported by the GIF and PNG-8 formats and many multimedia applications.", "access": "readonly", "value": "6" }, { "name": "LAB", "type": "number", "description": "Lab.", "access": "readonly", "value": "4" }, { "name": "MULTICHANNEL", "type": "number", "description": "Image with multiple color channels.", "access": "readonly", "value": "7" }, { "name": "RGB", "type": "number", "description": "RGB.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Channel", "kind": "Object", "description": "Object that stores information about a color element in the image, analogous to a plate in the printing process that applies a single color. The document's color mode determines the number of default channels. For example, an RGB document has four default channels: A composite channel: RGB; and three component channels: red, green, and blue. A channel can also be an alpha channel, which stores selections as masks; or a spot channel, which stores spot colors.", "properties": [ { "name": "color", "type": "SolidColor", "description": "The color of the channel. Not valid for component channels.", "access": "read/write" }, { "name": "histogram", "type": "number[]", "description": "A histogram of the color of the channel.", "access": "readonly" }, { "name": "kind", "type": "ChannelType", "description": "The type of channel.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The channel name.", "access": "read/write" }, { "name": "opacity", "type": "number", "description": "The opacity of alpha channels (called solidity for spot channels). Range: 0 to 100. Valid only when 'type' = masked area or selected area.", "access": "read/write", "range": { "min": "0", "max": "100" } }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "visible", "type": "boolean", "description": "If true, the channel is visible.", "access": "read/write" } ], "events": [], "methods": [ { "name": "add", "returns": "Channel", "description": "Adds an element.", "parameters": [] }, { "name": "duplicate", "returns": "Channel", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "duplicate", "returns": "Channel", "description": "Duplicates the channel.", "parameters": [ { "name": "targetDocument", "type": "Document", "description": "The document to duplicate the channel to.", "optional": true } ] }, { "name": "merge", "returns": "void", "description": "Merges a spot channel into the component channels.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "ChannelType", "kind": "Enumeration", "description": "The type of channel.", "properties": [ { "name": "COMPONENT", "type": "number", "description": "The channel related to the document color model.", "access": "readonly", "value": "1" }, { "name": "MASKEDAREA", "type": "number", "description": "The apha channel where color indicates a masked area.", "access": "readonly", "value": "2" }, { "name": "SELECTEDAREA", "type": "number", "description": "The lpha channel where color indicates a selected area.", "access": "readonly", "value": "3" }, { "name": "SPOTCOLOR", "type": "number", "description": "The alpha channel to store a spot color.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "Channels", "kind": "Collection", "description": "The collection of channel objects in the document.", "elementType": "Channel", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "Channel", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "Channel", "description": "Adds an element.", "parameters": [] }, { "name": "getByName", "returns": "Channel", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Color", "kind": "Object", "description": "A color value.", "properties": [], "events": [], "methods": [] }, { "name": "ColorBlendMode", "kind": "Enumeration", "description": "The color blend mode type.", "properties": [ { "name": "BEHIND", "type": "number", "description": "Edits or paints only on the transparent part of a layer. Works only in layers in which transparent pixels locked = false and is analogous to painting on the back of transparent areas on a sheet of acetate.", "access": "readonly", "value": "24" }, { "name": "CLEAR", "type": "number", "description": "Edits or paints each pixel and makes it transparent. Works only in layers in which transparent pixels locked = false.", "access": "readonly", "value": "25" }, { "name": "COLOR", "type": "number", "description": "Creates a result color with the luminance of the base color and the hue and saturation of the blend color. This preserves the gray levels in the image and is useful for coloring monochrome images and for tinting color images.", "access": "readonly", "value": "22" }, { "name": "COLORBURN", "type": "number", "description": "Looks at the color information in each channel and darkens the base color to reflect the blend color by increasing the contrast. Blending with white produces no change.", "access": "readonly", "value": "6" }, { "name": "COLORDODGE", "type": "number", "description": "Looks at the color information in each channel and brightens the base color to reflect the blend color by decreasing the contrast. Blending with black produces no change.", "access": "readonly", "value": "10" }, { "name": "DARKEN", "type": "number", "description": "Looks at the color information in each channel and selects the base or blend color—whichever is darker—as the result color. Pixels lighter than the blend color are replaced, and pixels darker than the blend color do not change.", "access": "readonly", "value": "4" }, { "name": "DARKERCOLOR", "type": "number", "description": "", "access": "readonly", "value": "28" }, { "name": "DIFFERENCE", "type": "number", "description": "Looks at the color information in each channel and subtracts either the blend color from the base color or the base color from the blend color, depending on which has the greater brightness value. Blending with white inverts the base color values; blending with black produces no change.", "access": "readonly", "value": "18" }, { "name": "DISSOLVE", "type": "number", "description": "Edits or paints each pixel to make it the result color, which is a random replacement of the pixels with the base color or the blend color, depending on the opacity at any pixel location.", "access": "readonly", "value": "3" }, { "name": "DIVIDE", "type": "number", "description": "", "access": "readonly", "value": "30" }, { "name": "EXCLUSION", "type": "number", "description": "Creates an effect similar to but lower in contrast than the Difference mode. Blending with white inverts the base color values. Blending with black produces no change.", "access": "readonly", "value": "19" }, { "name": "HARDLIGHT", "type": "number", "description": "Multiplies or screens the colors, depending on the blend color. The effect is similar to shining a harsh spotlight on the image. If the blend color (light source) is lighter than 50% gray, the image is lightened, as if it were screened. This is useful for adding highlights to an image. If the blend color is darker than 50% gray, the image is darkened, as if it were multiplied. This is useful for adding shadows to an image. Painting with pure black or white results in pure black or white.", "access": "readonly", "value": "14" }, { "name": "HARDMIX", "type": "number", "description": "Lighter colors lighten the result, and darker colors darken the result. 50% gray as a blend color has no effect on the result color. Lowering the fill opacity creates less posterization/thresholding.", "access": "readonly", "value": "26" }, { "name": "HUE", "type": "number", "description": "Creates a result color with the luminance and saturation of the base color and the hue of the blend color.", "access": "readonly", "value": "20" }, { "name": "LIGHTEN", "type": "number", "description": "Looks at the color information in each channel and selects the base or blend color—whichever is lighter—as the result color. Pixels darker than the blend color are replaced, and pixels lighter than the blend color do not change.", "access": "readonly", "value": "8" }, { "name": "LIGHTERCOLOR", "type": "number", "description": "", "access": "readonly", "value": "27" }, { "name": "LINEARBURN", "type": "number", "description": "Looks at the color information in each channel and darkens the base color to reflect the blend color by decreasing the brightness. Blending with white produces no change.", "access": "readonly", "value": "7" }, { "name": "LINEARDODGE", "type": "number", "description": "Looks at the color information in each channel and brightens the base color to reflect the blend color by increasing the brightness. Blending with black produces no change.", "access": "readonly", "value": "11" }, { "name": "LINEARLIGHT", "type": "number", "description": "Burns or dodges the colors by decreasing or increasing the brightness, depending on the blend color. If the blend color (light source) is lighter than 50% gray, the image is lightened by increasing the brightness. If the blend color is darker than 50% gray, the image is darkened by decreasing the brightness.", "access": "readonly", "value": "16" }, { "name": "LUMINOSITY", "type": "number", "description": "Creates a result color with the hue and saturation of the base color and the luminance of the blend color. This mode creates an inverse effect from that of the Color mode.", "access": "readonly", "value": "23" }, { "name": "MULTIPLY", "type": "number", "description": "Looks at the color information in each channel and multiplies the base color by the blend color. The result color is always a darker color. Multiplying any color with black produces black. Multiplying any color with white leaves the color unchanged. When you’re painting with a color other than black or white, successive strokes with a painting tool produce progressively darker colors. The effect is similar to drawing on the image with multiple marking pens.", "access": "readonly", "value": "5" }, { "name": "NORMAL", "type": "number", "description": "Edits or paints each pixel to make it the result color. (Called \"Threshold\" when you’re working with a bitmapped or indexed-color image.)", "access": "readonly", "value": "2" }, { "name": "OVERLAY", "type": "number", "description": "Multiplies or screens the colors, depending on the base color. Patterns or colors overlay the existing pixels while preserving the highlights and shadows of the base color. The base color is not replaced but is mixed with the blend color to reflect the lightness or darkness of the original color.", "access": "readonly", "value": "12" }, { "name": "PINLIGHT", "type": "number", "description": "Replaces the colors, depending on the blend color. If the blend color (light source) is lighter than 50% gray, pixels darker than the blend color are replaced, and pixels lighter than the blend color do not change. If the blend color is darker than 50% gray, pixels lighter than the blend color are replaced, and pixels darker than the blend color do not change. This is useful for adding special effects to an image.", "access": "readonly", "value": "17" }, { "name": "SATURATION", "type": "number", "description": "Creates a result color with the luminance and hue of the base color and the saturation of the blend color. Painting with this mode in an area with no (0) saturation (gray) causes no change.", "access": "readonly", "value": "21" }, { "name": "SCREEN", "type": "number", "description": "Looks at each channel’s color information and multiplies the inverse of the blend and base colors. The result color is always a lighter color. Screening with black leaves the color unchanged. Screening with white produces white. The effect is similar to projecting multiple photographic slides on top of each other.", "access": "readonly", "value": "9" }, { "name": "SOFTLIGHT", "type": "number", "description": "Darkens or lightens the colors, depending on the blend color. The effect is similar to shining a diffused spotlight on the image. If the blend color (light source) is lighter than 50% gray, the image is lightened as if it were dodged. If the blend color is darker than 50% gray, the image is darkened as if it were burned in. Painting with pure black or white produces a distinctly darker or lighter area but does not result in pure black or white.", "access": "readonly", "value": "13" }, { "name": "SUBTRACT", "type": "number", "description": "", "access": "readonly", "value": "29" }, { "name": "VIVIDLIGHT", "type": "number", "description": "Burns or dodges the colors by increasing or decreasing the contrast, depending on the blend color. If the blend color (light source) is lighter than 50% gray, the image is lightened by decreasing the contrast. If the blend color is darker than 50% gray, the image is darkened by increasing the contrast.", "access": "readonly", "value": "15" } ], "events": [], "methods": [] }, { "name": "ColorModel", "kind": "Enumeration", "description": "Color models.", "properties": [ { "name": "CMYK", "type": "number", "description": "CMYK.", "access": "readonly", "value": "3" }, { "name": "GRAYSCALE", "type": "number", "description": "Grayscale.", "access": "readonly", "value": "1" }, { "name": "HSB", "type": "number", "description": "HSB.", "access": "readonly", "value": "5" }, { "name": "LAB", "type": "number", "description": "Lab.", "access": "readonly", "value": "4" }, { "name": "NONE", "type": "number", "description": "The color model has not yet been assigned.", "access": "readonly", "value": "50" }, { "name": "RGB", "type": "number", "description": "RGB.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "ColorPicker", "kind": "Enumeration", "description": "The color picker to use.", "properties": [ { "name": "ADOBE", "type": "number", "description": "The Adobe Color Picker.", "access": "readonly", "value": "1" }, { "name": "APPLE", "type": "number", "description": "The built-in Apple color picker.", "access": "readonly", "value": "2" }, { "name": "PLUGIN", "type": "number", "description": "An installed plug-in color picker.", "access": "readonly", "value": "4" }, { "name": "WINDOWS", "type": "number", "description": "The built-in Windows color picker.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "ColorProfileType", "kind": "Enumeration", "description": "The type of color model that defines the document's working space.", "properties": [ { "name": "CUSTOM", "type": "number", "description": "Color manages this document using a custom color profile.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "The document is not color managed.", "access": "readonly", "value": "1" }, { "name": "WORKING", "type": "number", "description": "Color manages this document using the working color profile.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "ColorReductionType", "kind": "Enumeration", "description": "The color reduction algorithm.", "properties": [ { "name": "ADAPTIVE", "type": "number", "description": "Samples color from the spectrum appearing most commonly in the image.", "access": "readonly", "value": "2" }, { "name": "BLACKWHITE", "type": "number", "description": "Uses a set palette of colors.", "access": "readonly", "value": "5" }, { "name": "CUSTOM", "type": "number", "description": "Uses a color palette that is created or modified by the user. If you open an existing GIF or PNG-8 file, it will have a custom color palette.", "access": "readonly", "value": "4" }, { "name": "GRAYSCALE", "type": "number", "description": "Uses a set palette of colors.", "access": "readonly", "value": "6" }, { "name": "MACINTOSH", "type": "number", "description": "Uses a set palette of colors.", "access": "readonly", "value": "7" }, { "name": "PERCEPTUAL", "type": "number", "description": "Gives priority to colors for which the human eye has greater sensitivity.", "access": "readonly", "value": "0" }, { "name": "RESTRICTIVE", "type": "number", "description": "Uses the standard 216-color color table common to Windows and Mac OS 8-bit (256-color or web-safe palette); ensures that no browser dither is applied when the image is displayed using 8-bit color.", "access": "readonly", "value": "3" }, { "name": "SELECTIVE", "type": "number", "description": "Gives priority to broad areas of color and the preservation of web colors; usually produces images with the greatest color integrity.", "access": "readonly", "value": "1" }, { "name": "WINDOWS", "type": "number", "description": "Uses a set palette of colors.", "access": "readonly", "value": "8" } ], "events": [], "methods": [] }, { "name": "ColorSampler", "kind": "Object", "description": "A color sampler in a document.", "properties": [ { "name": "color", "type": "SolidColor", "description": "The color of the color sampler.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "position", "type": "number[]", "description": "The position of the color sampler in the document.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "ColorSampler", "description": "Adds an element.", "parameters": [] }, { "name": "move", "returns": "void", "description": "Moves the color sampler to a new location.", "parameters": [ { "name": "position", "type": "number[]", "description": "Position of destination (unit value)" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "ColorSamplers", "kind": "Collection", "description": "The collection of color samplers in the document.", "elementType": "ColorSampler", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "ColorSampler", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "ColorSampler", "description": "Creates a color sampler.", "parameters": [ { "name": "position", "type": "number[]", "description": "The horizontal and vertical (x,y) locations, respectively, of the color sampler." } ] }, { "name": "getByName", "returns": "ColorSampler", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "ColorSpaceType", "kind": "Enumeration", "description": "The type of color space.", "properties": [ { "name": "ADOBERGB", "type": "number", "description": "Use the Adobe RGB color space.", "access": "readonly", "value": "0" }, { "name": "COLORMATCHRGB", "type": "number", "description": "Use the ColorMatch RGB color space.", "access": "readonly", "value": "1" }, { "name": "PROPHOTORGB", "type": "number", "description": "Use the ProPhoto RGB color space.", "access": "readonly", "value": "2" }, { "name": "SRGB", "type": "number", "description": "Use the sRGB color space.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "ContactSheetOptions", "kind": "Object", "description": "Options that can be specified for a contact sheet.", "properties": [ { "name": "acrossFirst", "type": "boolean", "description": "If true, places the images horizontally first.", "access": "read/write", "static": true, "value": "true" }, { "name": "bestFit", "type": "boolean", "description": "If true, rotates images for best fit.", "access": "read/write", "static": true, "value": "false" }, { "name": "caption", "type": "boolean", "description": "If true, uses the filename as a caption for the image.", "access": "read/write", "static": true, "value": "true" }, { "name": "columnCount", "type": "number", "description": "The number of contact sheet columns.", "access": "read/write", "static": true, "value": "5" }, { "name": "flatten", "type": "boolean", "description": "If true, flattens all layers in the final document.", "access": "read/write", "static": true, "value": "true" }, { "name": "font", "type": "GalleryFontType", "description": "The font used for the caption.", "access": "read/write", "static": true, "value": "GalleryFontType.ARIAL" }, { "name": "fontSize", "type": "number", "description": "The caption font size.", "access": "read/write", "static": true, "value": "12" }, { "name": "height", "type": "number", "description": "The height (in pixels) of the resulting document. Range: 100 to 2900.", "access": "read/write", "static": true, "value": "720", "range": { "min": "100", "max": "2900" } }, { "name": "horizontal", "type": "number", "description": "The horizontal spacing (in pixels) between images. Range: 0 to 29000.", "access": "read/write", "static": true, "value": "1", "range": { "min": "0", "max": "29000" } }, { "name": "mode", "type": "NewDocumentMode", "description": "The document color mode.", "access": "read/write", "static": true, "value": "NewDocumentMode.RGB" }, { "name": "resolution", "type": "number", "description": "The resolution of the document (in pixels per inch). Range: 35 to 1200.", "access": "read/write", "static": true, "value": "72.0", "range": { "min": "35", "max": "1200" } }, { "name": "rowCount", "type": "number", "description": "The number of contact sheet rows.", "access": "read/write", "static": true, "value": "6" }, { "name": "useAutoSpacing", "type": "boolean", "description": "If true, auto spaces the images in the contact sheet.", "access": "read/write", "static": true, "value": "true" }, { "name": "vertical", "type": "number", "description": "The vertical spacing (in pixels) between images. Range: 0 to 29000.", "access": "read/write", "static": true, "value": "1", "range": { "min": "0", "max": "29000" } }, { "name": "width", "type": "number", "description": "The width (in pixels) of the resulting document. Range: 100 to 2900.", "access": "read/write", "static": true, "value": "576", "range": { "min": "100", "max": "2900" } } ], "events": [], "methods": [] }, { "name": "CopyrightedType", "kind": "Enumeration", "description": "The copyright status of the document.", "properties": [ { "name": "COPYRIGHTEDWORK", "type": "number", "description": "The document is copyrighted.", "access": "readonly", "value": "1" }, { "name": "PUBLICDOMAIN", "type": "number", "description": "The document is in the public domain.", "access": "readonly", "value": "2" }, { "name": "UNMARKED", "type": "number", "description": "The copyright status is not indicated.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "CountItem", "kind": "Object", "description": "A counted item in the document. The count item feature is available in the Extended Version only.", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "position", "type": "number[]", "description": "The position of count item in the document.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "CountItem", "description": "Adds an element.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "CountItems", "kind": "Collection", "description": "The collection of count items in the document.", "elementType": "CountItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "CountItem", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "CountItem", "description": "Creates a count item.", "parameters": [ { "name": "position", "type": "number[]", "description": "The position of origin." } ] }, { "name": "getByName", "returns": "CountItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "CreateFields", "kind": "Enumeration", "description": "The method for replacing eliminated fields.", "properties": [ { "name": "DUPLICATION", "type": "number", "description": "Duplicates existing pixels.", "access": "readonly", "value": "1" }, { "name": "INTERPOLATION", "type": "number", "description": "Assigns color values to any new pixels that Photoshop creates based on the color values of existing pixels in the image.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "CropToType", "kind": "Enumeration", "description": "The style to use when cropping a page.", "properties": [ { "name": "ARTBOX", "type": "number", "description": "Crop to the art box.", "access": "readonly", "value": "5" }, { "name": "BLEEDBOX", "type": "number", "description": "Crop to the bleed box.", "access": "readonly", "value": "3" }, { "name": "BOUNDINGBOX", "type": "number", "description": "Crop to the bounding box.", "access": "readonly", "value": "0" }, { "name": "CROPBOX", "type": "number", "description": "Crop to the crop box.", "access": "readonly", "value": "2" }, { "name": "MEDIABOX", "type": "number", "description": "Crop to the media box.", "access": "readonly", "value": "1" }, { "name": "TRIMBOX", "type": "number", "description": "Crop to the trim box.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "DCS1_SaveOptions", "kind": "Object", "description": "Options for saving a document in Photoshop DCS 1.0 format.", "extends": "SaveOptions", "properties": [ { "name": "DCS", "type": "DCSType", "description": "The DCS type.", "access": "read/write", "static": true, "value": "DCSType.COLORCOMPOSITE" }, { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "encoding", "type": "SaveEncoding", "description": "The type of encoding to use for the document.", "access": "read/write", "static": true, "value": "SaveEncoding.BINARY" }, { "name": "halftoneScreen", "type": "boolean", "description": "If true, includes halftone screen.", "access": "read/write", "static": true, "value": "false" }, { "name": "interpolation", "type": "boolean", "description": "If true, image interpolation is used.", "access": "read/write", "static": true, "value": "false" }, { "name": "preview", "type": "MacPreviewType", "description": "The type of preview.", "access": "read/write", "static": true, "value": "MacPreviewType.MACOSEIGHTBIT" }, { "name": "transferFunction", "type": "boolean", "description": "If true, includes transfer functions in the document to compensate for dot gain between the image and film.", "access": "read/write", "static": true, "value": "false" }, { "name": "vectorData", "type": "boolean", "description": "If true, includes vector data. Valid only if the document contains vector data (un-rasterized text).", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "DCS2_SaveOptions", "kind": "Object", "description": "Options for saving a document in Photoshop DCS 2.0 format.", "extends": "SaveOptions", "properties": [ { "name": "DCS", "type": "DCSType", "description": "The DCS type.", "access": "read/write", "static": true, "value": "DCSType.NOCOMPOSITE" }, { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "encoding", "type": "SaveEncoding", "description": "The type of encoding to use for document.", "access": "read/write", "static": true, "value": "SaveEncoding.BINARY" }, { "name": "halftoneScreen", "type": "boolean", "description": "If true, includes halftone screen.", "access": "read/write", "static": true, "value": "false" }, { "name": "interpolation", "type": "boolean", "description": "If true, image interpolation is used.", "access": "read/write", "static": true, "value": "false" }, { "name": "multiFileDCS", "type": "boolean", "description": "If true, saves color channels as multiple files.", "access": "read/write", "static": true, "value": "false" }, { "name": "preview", "type": "MacPreviewType", "description": "The type of preview.", "access": "read/write", "static": true, "value": "MacPreviewType.MACOSEIGHTBIT" }, { "name": "spotColors", "type": "boolean", "description": "If true, the spot colors are saved.", "access": "read/write", "static": true }, { "name": "transferFunction", "type": "boolean", "description": "If true, includes transfer functions in the document to compensate for dot gain between the image and film.", "access": "read/write", "static": true, "value": "false" }, { "name": "vectorData", "type": "boolean", "description": "If true, includes vector data. Valid only if the document contains vector data (un-rasterized text).", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "DCSType", "kind": "Enumeration", "description": "The DCS format.", "properties": [ { "name": "COLORCOMPOSITE", "type": "number", "description": "Creates a color composite file in addition to DCS files.", "access": "readonly", "value": "3" }, { "name": "GRAYSCALECOMPOSITE", "type": "number", "description": "Creates a grayscale composite file in addition to DCS files.", "access": "readonly", "value": "2" }, { "name": "NOCOMPOSITE", "type": "number", "description": "Does not create a composite file.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "DICOMOpenOptions", "kind": "Object", "description": "Options for opening a DICOM document.", "extends": "OpenOptions", "properties": [ { "name": "anonymize", "type": "boolean", "description": "If true, patient information is anonymized.", "access": "read/write", "static": true }, { "name": "columns", "type": "number", "description": "The number of columns in an n-up configuration.", "access": "read/write", "static": true }, { "name": "reverse", "type": "boolean", "description": "If true, the image is inverted.", "access": "read/write", "static": true }, { "name": "rows", "type": "number", "description": "The number of rows in an n-up configuration.", "access": "read/write", "static": true }, { "name": "showOverlays", "type": "boolean", "description": "If true, overlays are shown (if present).", "access": "read/write", "static": true }, { "name": "windowLevel", "type": "number", "description": "The contrast of the image in Houndsfield units.", "access": "read/write", "static": true }, { "name": "windowWidth", "type": "number", "description": "The brightness of the image in Houndsfield units.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "DepthMapSource", "kind": "Enumeration", "description": "Depth map source options.", "properties": [ { "name": "IMAGEHIGHLIGHT", "type": "number", "description": "Uses the image highlight for the depth map.", "access": "readonly", "value": "4" }, { "name": "LAYERMASK", "type": "number", "description": "Uses the layer mask for the depth map.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "No depth map in use.", "access": "readonly", "value": "1" }, { "name": "TRANSPARENCYCHANNEL", "type": "number", "description": "Uses the transparency channel for the depth map.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "DescValueType", "kind": "Enumeration", "description": "The value type of an object.", "properties": [ { "name": "ALIASTYPE", "type": "number", "description": "Alias.", "access": "readonly", "value": "11" }, { "name": "BOOLEANTYPE", "type": "number", "description": "Boolean.", "access": "readonly", "value": "5" }, { "name": "CLASSTYPE", "type": "number", "description": "Class.", "access": "readonly", "value": "10" }, { "name": "DOUBLETYPE", "type": "number", "description": "Double.", "access": "readonly", "value": "2" }, { "name": "ENUMERATEDTYPE", "type": "number", "description": "Enumeration.", "access": "readonly", "value": "8" }, { "name": "INTEGERTYPE", "type": "number", "description": "Integer.", "access": "readonly", "value": "1" }, { "name": "LARGEINTEGERTYPE", "type": "number", "description": "", "access": "readonly", "value": "13" }, { "name": "LISTTYPE", "type": "number", "description": "Action list.", "access": "readonly", "value": "6" }, { "name": "OBJECTTYPE", "type": "number", "description": "Object.", "access": "readonly", "value": "7" }, { "name": "RAWTYPE", "type": "number", "description": "Raw.", "access": "readonly", "value": "12" }, { "name": "REFERENCETYPE", "type": "number", "description": "Reference.", "access": "readonly", "value": "9" }, { "name": "STRINGTYPE", "type": "number", "description": "String.", "access": "readonly", "value": "4" }, { "name": "UNITDOUBLE", "type": "number", "description": "Unit value of type double.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "DialogModes", "kind": "Enumeration", "description": "Controls whether Photoshop displays dialogs during scripts.", "properties": [ { "name": "ALL", "type": "number", "description": "Show all dialogs.", "access": "readonly", "value": "1" }, { "name": "ERROR", "type": "number", "description": "Show only dialogs related to errors.", "access": "readonly", "value": "2" }, { "name": "NO", "type": "number", "description": "Show no dialogs.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "Direction", "kind": "Enumeration", "description": "The orientation of the object.", "properties": [ { "name": "HORIZONTAL", "type": "number", "description": "Horizontal.", "access": "readonly", "value": "1" }, { "name": "VERTICAL", "type": "number", "description": "Vertical.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "DisplacementMapType", "kind": "Enumeration", "description": "Describes how the displacement map fits the image if the image is not the same size as the map.", "properties": [ { "name": "STRETCHTOFIT", "type": "number", "description": "The map is resized.", "access": "readonly", "value": "1" }, { "name": "TILE", "type": "number", "description": "The selection is filled by repeating the map in a pattern.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "DitherType", "kind": "Enumeration", "description": "The type of dither.", "properties": [ { "name": "DIFFUSION", "type": "number", "description": "Diffuses dither effects in random patterns across adjacent pixels.", "access": "readonly", "value": "2" }, { "name": "NOISE", "type": "number", "description": "Applies a random pattern but without diffusing the pattern across adjacent pixels; prevents the appearance of seams.", "access": "readonly", "value": "4" }, { "name": "NONE", "type": "number", "description": "No dither is used.", "access": "readonly", "value": "1" }, { "name": "PATTERN", "type": "number", "description": "Applies a halftone-like square pattern.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "DocPositionStyle", "kind": "Enumeration", "description": "Position of document when printing.", "properties": [ { "name": "PRINTCENTERED", "type": "number", "description": "Print image centered on page.", "access": "readonly", "value": "1" }, { "name": "SIZETOFIT", "type": "number", "description": "Resize image to fit on page when printing.", "access": "readonly", "value": "2" }, { "name": "USERDEFINED", "type": "number", "description": "Print using user defined spacing.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "Document", "kind": "Object", "description": "The active containment object for the layers and all other objects in the script; the basic canvas for the file.", "properties": [ { "name": "activeChannels", "type": "Channel[]", "description": "The selected channels.", "access": "read/write" }, { "name": "activeHistoryBrushSource", "type": "HistoryState", "description": "The history state to use with the history brush.", "access": "read/write" }, { "name": "activeHistoryState", "type": "HistoryState", "description": "The current history state for this document.", "access": "read/write" }, { "name": "activeLayer", "type": "Layer", "description": "The selected layer.", "access": "read/write" }, { "name": "artLayers", "type": "ArtLayers", "description": "The art layers collection in the document.", "access": "readonly" }, { "name": "backgroundLayer", "type": "ArtLayer", "description": "The background layer for the document.", "access": "readonly" }, { "name": "bitsPerChannel", "type": "BitsPerChannelType", "description": "The number of bits per channel.", "access": "read/write" }, { "name": "channels", "type": "Channels", "description": "The channels collection in this document.", "access": "readonly" }, { "name": "colorProfileName", "type": "string", "description": "The name of the color profile. Valid only when no value is specified for color profile kind (to indicate a custom color profile).", "access": "read/write" }, { "name": "colorProfileType", "type": "ColorProfileType", "description": "The type of color model that defines the working space of the document.", "access": "read/write" }, { "name": "colorSamplers", "type": "ColorSamplers", "description": "The current color samplers associated with the document.", "access": "readonly" }, { "name": "componentChannels", "type": "Channel[]", "description": "The color component channels for this document.", "access": "readonly" }, { "name": "countItems", "type": "CountItems", "description": "The current count items in the document.", "access": "readonly" }, { "name": "fullName", "type": "File", "description": "The full path name of the document.", "access": "readonly" }, { "name": "guides", "type": "Guides", "description": "The guides in this document.", "access": "readonly" }, { "name": "height", "type": "UnitValue", "description": "The height of the document.", "access": "readonly" }, { "name": "histogram", "type": "number[]", "description": "A histogram showing the number of pixels at each color intensity level for the composite channel.", "access": "readonly" }, { "name": "historyStates", "type": "HistoryStates", "description": "The history states collection in this document.", "access": "readonly" }, { "name": "id", "type": "number", "description": "The unique ID of this document.", "access": "readonly" }, { "name": "info", "type": "DocumentInfo", "description": "Metadata about the document.", "access": "readonly" }, { "name": "layerComps", "type": "LayerComps", "description": "The layer comps collection in this document.", "access": "readonly" }, { "name": "layerSets", "type": "LayerSets", "description": "The layer sets collection in the document.", "access": "readonly" }, { "name": "layers", "type": "Layers", "description": "The layers collection in the document.", "access": "readonly" }, { "name": "managed", "type": "boolean", "description": "If true, the document is a workgroup document.", "access": "readonly" }, { "name": "measurementScale", "type": "MeasurementScale", "description": "The measurement scale of the document.", "access": "readonly" }, { "name": "mode", "type": "DocumentMode", "description": "The color profile.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The document name.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "path", "type": "File", "description": "The path to the document.", "access": "readonly" }, { "name": "pathItems", "type": "PathItems", "description": "The path items collection in this document.", "access": "readonly" }, { "name": "pixelAspectRatio", "type": "number", "description": "The (custom) pixel aspect ratio of the document. Range: 0.100 to 10.000.", "access": "read/write" }, { "name": "printSettings", "type": "DocumentPrintSettings", "description": "Document print settings.", "access": "readonly" }, { "name": "quickMaskMode", "type": "boolean", "description": "If true, the document is in Quick Mask mode.", "access": "read/write" }, { "name": "resolution", "type": "number", "description": "The resolution of the document (in pixels per inch)", "access": "readonly" }, { "name": "saved", "type": "boolean", "description": "If true, the document been saved since the last change.", "access": "readonly" }, { "name": "selection", "type": "Selection", "description": "The selected area of the document.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "width", "type": "UnitValue", "description": "The width of the document.", "access": "readonly" }, { "name": "xmpMetadata", "type": "XMPMetadata", "description": "The XMP properties of the document. The Camera RAW settings are stored here.", "access": "readonly" } ], "events": [], "methods": [ { "name": "autoCount", "returns": "void", "description": "Counts the objects in the document.", "parameters": [ { "name": "channel", "type": "Channel", "description": "The channel to use for counting." }, { "name": "threshold", "type": "number", "description": "Threshold to use for counting. Range: 0 to 255.", "range": { "min": "0", "max": "255" } } ] }, { "name": "changeMode", "returns": "void", "description": "Changes the mode of the document.", "parameters": [ { "name": "destinationMode", "type": "ChangeMode", "description": "The mode to change to." }, { "name": "options", "type": "DocumentConversionOptions", "description": "Options for changing the mode.", "optional": true } ] }, { "name": "close", "returns": "void", "description": "Closes the document.", "parameters": [ { "name": "saving", "type": "SaveOptionsType", "description": "Specifies whether changes should be saved before closing.", "optional": true } ] }, { "name": "convertProfile", "returns": "void", "description": "Converts the document from using one color profile to using another.", "parameters": [ { "name": "destinationProfile", "type": "string", "description": "The color profile to convert to. Either a string specifying a color profile, one of the working color spaces, or Lab color." }, { "name": "intent", "type": "Intent", "description": "The conversion intent." }, { "name": "blackPointCompensation", "type": "boolean", "description": "If true, black point compensation is used.", "optional": true }, { "name": "dither", "type": "boolean", "description": "If true, dither is used.", "optional": true } ] }, { "name": "crop", "returns": "void", "description": "Crops the document.", "parameters": [ { "name": "bounds", "type": "number[]", "description": "The area to crop." }, { "name": "angle", "type": "number", "description": "The angle of cropping bounds.", "optional": true }, { "name": "width", "type": "UnitValue", "description": "The width of the resulting document.", "optional": true }, { "name": "height", "type": "UnitValue", "description": "The height of the resulting document.", "optional": true } ] }, { "name": "duplicate", "returns": "Document", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "duplicate", "returns": "Document", "description": "Creates a duplicate of the document object.", "parameters": [ { "name": "name", "type": "string", "description": "The name of the new document.", "optional": true }, { "name": "mergeLayersOnly", "type": "boolean", "description": "If ture, duplicates merged layers only.", "optional": true } ] }, { "name": "exportDocument", "returns": "void", "description": "Exports the document.", "parameters": [ { "name": "exportIn", "type": "File", "description": "The file to export to." }, { "name": "exportAs", "type": "ExportType", "description": "The type of export.", "optional": true }, { "name": "options", "type": "ExportOptions", "description": "Options for the specified export type.", "optional": true } ] }, { "name": "flatten", "returns": "void", "description": "Flattens all layers.", "parameters": [] }, { "name": "flipCanvas", "returns": "void", "description": "Flips the canvas horizontally or vertically.", "parameters": [ { "name": "direction", "type": "Direction", "description": "The direction in which to flip the canvas." } ] }, { "name": "importAnnotations", "returns": "void", "description": "Imports annotations into the document.", "parameters": [ { "name": "file", "type": "File", "description": "The document to import annotations from." } ] }, { "name": "mergeVisibleLayers", "returns": "void", "description": "Flattens all visible layers in the document.", "parameters": [] }, { "name": "paste", "returns": "ArtLayer", "description": "Pastes contents of the clipboard into the document.", "parameters": [ { "name": "intoSelection", "type": "boolean", "description": "If true, contents are pasted into the current selection.", "optional": true } ] }, { "name": "print", "returns": "void", "description": "Prints the document.", "parameters": [ { "name": "sourceSpace", "type": "SourceSpaceType", "description": "The color space for the source.", "optional": true }, { "name": "printSpace", "type": "string", "description": "The color space for the printer. Can be \"nothing\" (meaning same as source); one of the working spaces or Lab color; or a string specifying a color space. Default: nothing.", "optional": true }, { "name": "intent", "type": "Intent", "description": "The color conversion intent.", "optional": true }, { "name": "blackPointCompensation", "type": "boolean", "description": "If true, black point compensation is used.", "optional": true } ] }, { "name": "printOneCopy", "returns": "void", "description": "Print one copy of the document.", "parameters": [] }, { "name": "rasterizeAllLayers", "returns": "void", "description": "Rasterizes all layers.", "parameters": [] }, { "name": "recordMeasurements", "returns": "void", "description": "Records the measurements of document.", "parameters": [ { "name": "source", "type": "MeasurementSource", "description": "The source of the measurements to record.", "optional": true }, { "name": "dataPoints", "type": "string[]", "description": "An array of identifiers of data points to record. Any data points not appropriate for the specified source are ignored.", "optional": true } ] }, { "name": "resizeCanvas", "returns": "void", "description": "Changes the size of the canvas.", "parameters": [ { "name": "width", "type": "UnitValue", "description": "The desired width of the canvas.", "optional": true }, { "name": "height", "type": "UnitValue", "description": "The desired height of the canvas.", "optional": true }, { "name": "anchor", "type": "AnchorPosition", "description": "The anchor point to resize around.", "optional": true } ] }, { "name": "resizeImage", "returns": "void", "description": "Changes the size of the image.", "parameters": [ { "name": "width", "type": "UnitValue", "description": "The desired width of the image.", "optional": true }, { "name": "height", "type": "UnitValue", "description": "The desired height of the image.", "optional": true }, { "name": "resolution", "type": "number", "description": "The resolution (in pixels per inch)", "optional": true }, { "name": "resampleMethod", "type": "ResampleMethod", "description": "The downsample method.", "optional": true }, { "name": "amount", "type": "number", "description": "Amount of noise value when using preserve details (range: 0 - 100)", "range": { "min": "0", "max": "100" }, "optional": true } ] }, { "name": "revealAll", "returns": "void", "description": "Expands the document to show clipped sections.", "parameters": [] }, { "name": "rotateCanvas", "returns": "void", "description": "Rotates the canvas.", "parameters": [ { "name": "angle", "type": "number", "description": "The number of degrees to rotate. A positive angle rotates the canvas clockwise; a negative value rotates the canvas counter-clockwise." } ] }, { "name": "save", "returns": "void", "description": "Saves the document.", "parameters": [] }, { "name": "saveAs", "returns": "void", "description": "Saves the document with the specified save options.", "parameters": [ { "name": "saveIn", "type": "File", "description": "The file to save to, specified as a string containing the full file path or an alias. If not specified, the document is saved to its existing file." }, { "name": "options", "type": "any", "description": "Options for the specified file type.", "optional": true }, { "name": "asCopy", "type": "boolean", "description": "Saves the document as a copy, leaving the original open.", "optional": true }, { "name": "extensionType", "type": "MacExtensionType", "description": "Appends the specified extension to the file name.", "optional": true } ] }, { "name": "splitChannels", "returns": "Document[]", "description": "Splits the channels of the document.", "parameters": [] }, { "name": "suspendHistory", "returns": "void", "description": "Provides a single history state for the entire script. Allows a single undo for all actions taken in the script.", "parameters": [ { "name": "historyString", "type": "string", "description": "The string to use for the history state." }, { "name": "javaScriptString", "type": "string", "description": "A string of JavaScript code to execute during the suspension of history." } ] }, { "name": "trap", "returns": "void", "description": "Applies trapping to a CMYK document. Valid only when 'mode' = CMYK.", "parameters": [ { "name": "width", "type": "number", "description": "The trap width in pixels." } ] }, { "name": "trim", "returns": "void", "description": "Trims the transparent area around the image on the specified sides of the canvas.", "parameters": [ { "name": "type", "type": "TrimType", "description": "The color or type of pixels to base the trim on.", "optional": true }, { "name": "top", "type": "boolean", "description": "If true, trims away the top of the document.", "optional": true }, { "name": "left", "type": "boolean", "description": "If true, trims away the left of the document.", "optional": true }, { "name": "bottom", "type": "boolean", "description": "If true, trims away the bottom of the document.", "optional": true }, { "name": "right", "type": "boolean", "description": "If true, trims away the right of the document.", "optional": true } ] } ] }, { "name": "DocumentConversionOptions", "kind": "Object", "description": "Options for converting documents.", "properties": [], "events": [], "methods": [] }, { "name": "DocumentFill", "kind": "Enumeration", "description": "The document window fill type.", "properties": [ { "name": "BACKGROUNDCOLOR", "type": "number", "description": "The background color as displayed in the toolbox.", "access": "readonly", "value": "2" }, { "name": "TRANSPARENT", "type": "number", "description": "Transparent.", "access": "readonly", "value": "3" }, { "name": "WHITE", "type": "number", "description": "White.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "DocumentInfo", "kind": "Object", "description": "Metadata about a document object. These values can be set by selecting File > File Info in the Adobe Photoshop application.", "properties": [ { "name": "author", "type": "string", "description": "The author.", "access": "read/write" }, { "name": "authorPosition", "type": "string", "description": "The author's position.", "access": "read/write" }, { "name": "caption", "type": "string", "description": "The caption.", "access": "read/write" }, { "name": "captionWriter", "type": "string", "description": "The caption author.", "access": "read/write" }, { "name": "category", "type": "string", "description": "The document category.", "access": "read/write" }, { "name": "city", "type": "string", "description": "The city.", "access": "read/write" }, { "name": "copyrightNotice", "type": "string", "description": "The copyright notice.", "access": "read/write" }, { "name": "copyrighted", "type": "CopyrightedType", "description": "The copyright status.", "access": "read/write" }, { "name": "country", "type": "string", "description": "The country.", "access": "read/write" }, { "name": "creationDate", "type": "string", "description": "The creation date.", "access": "read/write" }, { "name": "credit", "type": "string", "description": "The author credit.", "access": "read/write" }, { "name": "exif", "type": "any[]", "description": "For JPEG images, information stored with digital photographs including camera type, date and time of photo, and file size.", "access": "readonly" }, { "name": "headline", "type": "string", "description": "The headline.", "access": "read/write" }, { "name": "instructions", "type": "string", "description": "Instructions for using or processing the image.", "access": "read/write" }, { "name": "jobName", "type": "string", "description": "The job name.", "access": "read/write" }, { "name": "keywords", "type": "string[]", "description": "A list of keywords.", "access": "read/write" }, { "name": "ownerUrl", "type": "string", "description": "The url of the copyright info.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "provinceState", "type": "string", "description": "The state or province.", "access": "read/write" }, { "name": "source", "type": "string", "description": "The source.", "access": "read/write" }, { "name": "supplementalCategories", "type": "string[]", "description": "Other categories.", "access": "read/write" }, { "name": "title", "type": "string", "description": "The document title.", "access": "read/write" }, { "name": "transmissionReference", "type": "string", "description": "The transmission reference.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "urgency", "type": "Urgency", "description": "The document urgency.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "DocumentMode", "kind": "Enumeration", "description": "The document's color mode.", "properties": [ { "name": "BITMAP", "type": "number", "description": "Bitmap, which uses one of two color values (black or white) to represent the pixels in an image.", "access": "readonly", "value": "5" }, { "name": "CMYK", "type": "number", "description": "CMYK.", "access": "readonly", "value": "3" }, { "name": "DUOTONE", "type": "number", "description": "Duotone mode, which creates monotone, duotone (two-color), tritone (three-color), and quadtone (four-color) grayscale images using one to four custom inks.", "access": "readonly", "value": "8" }, { "name": "GRAYSCALE", "type": "number", "description": "Grayscale.", "access": "readonly", "value": "1" }, { "name": "INDEXEDCOLOR", "type": "number", "description": "Indexed color, in which the number of colors in the image is at most 256, the standard number of colors supported by the GIF and PNG-8 formats and many multimedia applications.", "access": "readonly", "value": "6" }, { "name": "LAB", "type": "number", "description": "Lab.", "access": "readonly", "value": "4" }, { "name": "MULTICHANNEL", "type": "number", "description": "Image with multiple color channels.", "access": "readonly", "value": "7" }, { "name": "RGB", "type": "number", "description": "RGB.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "DocumentPrintSettings", "kind": "Object", "description": "Print settings for a document.", "properties": [ { "name": "activePrinter", "type": "string", "description": "Currently selected printer.", "access": "read/write" }, { "name": "backgroundColor", "type": "SolidColor", "description": "Background color of page.", "access": "read/write" }, { "name": "bleedWidth", "type": "UnitValue", "description": "Bleed width.", "access": "read/write" }, { "name": "caption", "type": "boolean", "description": "Description field from File Info.", "access": "read/write" }, { "name": "centerCropMarks", "type": "boolean", "description": "Print center crop marks.", "access": "read/write" }, { "name": "colorBars", "type": "boolean", "description": "Print color calibration bars.", "access": "read/write" }, { "name": "colorHandling", "type": "PrintColorHandling", "description": "Color handling.", "access": "read/write" }, { "name": "copies", "type": "number", "description": "Number of copies.", "access": "read/write" }, { "name": "cornerCropMarks", "type": "boolean", "description": "Print corner crop marks.", "access": "read/write" }, { "name": "docPosition", "type": "DocPositionStyle", "description": "Position of image when printing.", "access": "readonly" }, { "name": "flip", "type": "boolean", "description": "Flip the image horizontally.", "access": "read/write" }, { "name": "hardProof", "type": "boolean", "description": "Print a hard proof.", "access": "read/write" }, { "name": "interpolate", "type": "boolean", "description": "", "access": "read/write" }, { "name": "labels", "type": "boolean", "description": "Prints the document title.", "access": "read/write" }, { "name": "mapBlack", "type": "boolean", "description": "Map blacks.", "access": "read/write" }, { "name": "negative", "type": "boolean", "description": "Invert the image colors.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "posX", "type": "UnitValue", "description": "X position of image on page.", "access": "readonly" }, { "name": "posY", "type": "UnitValue", "description": "Y position of image on page.", "access": "readonly" }, { "name": "printBorder", "type": "UnitValue", "description": "Width of the print border.", "access": "read/write" }, { "name": "printSpace", "type": "string", "description": "Color space for printer. Can be nothing (meaning same as source) or a string specifying a specific color profile.", "access": "read/write" }, { "name": "printerName", "type": "string", "description": "Name of printer.", "access": "read/write" }, { "name": "printers", "type": "string[]", "description": "List of available printers.", "access": "readonly" }, { "name": "registrationMarks", "type": "boolean", "description": "Print registration marks.", "access": "read/write" }, { "name": "renderIntent", "type": "Intent", "description": "Color conversion intent when print space is different from the source space.", "access": "read/write" }, { "name": "scale", "type": "number", "description": "Scale of image on page.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "vectorData", "type": "boolean", "description": "Include vector data.", "access": "read/write" } ], "events": [], "methods": [ { "name": "setPagePosition", "returns": "void", "description": "Set the position of the image on the page.", "parameters": [ { "name": "docPosition", "type": "DocPositionStyle", "description": "Position of the image on page when printing. Can be centered, scale to fit, or user defined." }, { "name": "posX", "type": "UnitValue", "description": "X position of image on page.", "optional": true }, { "name": "posY", "type": "UnitValue", "description": "Y position of image on page.", "optional": true }, { "name": "scale", "type": "number", "description": "Position of the image on page when printing. Can be centered, scale to fit, or user defined.", "optional": true } ] } ] }, { "name": "Documents", "kind": "Collection", "description": "A collection of documents.", "elementType": "Document", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "Document", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "Document", "description": "A document.", "parameters": [ { "name": "width", "type": "UnitValue", "description": "The width of the document.", "optional": true }, { "name": "height", "type": "UnitValue", "description": "The height of the document.", "optional": true }, { "name": "resolution", "type": "number", "description": "The resolution of the document (in pixels per inch)", "optional": true }, { "name": "name", "type": "string", "description": "The name of the document.", "optional": true }, { "name": "mode", "type": "NewDocumentMode", "description": "The document mode.", "optional": true }, { "name": "initialFill", "type": "DocumentFill", "description": "The initial fill of the document.", "optional": true }, { "name": "pixelAspectRatio", "type": "number", "description": "The initial pixel aspect ratio of the document.", "optional": true }, { "name": "bitsPerChannel", "type": "BitsPerChannelType", "description": "The number of bits per channel.", "optional": true }, { "name": "colorProfileName", "type": "string", "description": "The name of color profile for document.", "optional": true } ] }, { "name": "getByName", "returns": "Document", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "EPSSaveOptions", "kind": "Object", "description": "Options for saving a document in EPS format.", "extends": "SaveOptions", "properties": [ { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "encoding", "type": "SaveEncoding", "description": "The type of encoding to use for the document.", "access": "read/write", "static": true, "value": "SaveEncoding.BINARY" }, { "name": "halftoneScreen", "type": "boolean", "description": "If true, includes the halftone screen.", "access": "read/write", "static": true, "value": "false" }, { "name": "interpolation", "type": "boolean", "description": "If true, uses image interpolation.", "access": "read/write", "static": true, "value": "false" }, { "name": "preview", "type": "MacPreviewType", "description": "The type of preview.", "access": "read/write", "static": true, "value": "MacPreviewType.MONOCHROMETIFF" }, { "name": "psColorManagement", "type": "boolean", "description": "If true, uses PostScript color management.", "access": "read/write", "static": true, "value": "false" }, { "name": "transferFunction", "type": "boolean", "description": "If true, includes the transfer functions in the document to compensate for dot gain between the image and film.", "access": "read/write", "static": true, "value": "false" }, { "name": "transparentWhites", "type": "boolean", "description": "If true, displays white areas as transparent. Valid only for documents in BitMap mode.", "access": "read/write", "static": true }, { "name": "vectorData", "type": "boolean", "description": "If true, includes vector data. Valid only when the document contains vector data (un-rasterized text).", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "EditLogItemsType", "kind": "Enumeration", "description": "The history log edit options.", "properties": [ { "name": "CONCISE", "type": "number", "description": "Save a concise history log.", "access": "readonly", "value": "2" }, { "name": "DETAILED", "type": "number", "description": "Save a detailed history log.", "access": "readonly", "value": "3" }, { "name": "SESSIONONLY", "type": "number", "description": "Save a history for only for the session.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ElementPlacement", "kind": "Enumeration", "description": "Controls where Photoshop places an element.", "properties": [ { "name": "PLACEAFTER", "type": "number", "description": "Place after an element.", "access": "readonly", "value": "1" }, { "name": "PLACEATEND", "type": "number", "description": "Place an element at the end.", "access": "readonly", "value": "3" }, { "name": "PLACEBEFORE", "type": "number", "description": "Place before an element.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "EliminateFields", "kind": "Enumeration", "description": "The type of fields to eliminate.", "properties": [ { "name": "EVENFIELDS", "type": "number", "description": "Eliminate even interlaced lines in a video image.", "access": "readonly", "value": "2" }, { "name": "ODDFIELDS", "type": "number", "description": "Eliminate odd interlaced lines in a video image.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ExportOptions", "kind": "Object", "description": "Options for exporting an object.", "properties": [], "events": [], "methods": [] }, { "name": "ExportOptionsIllustrator", "kind": "Object", "description": "Options for exporting Illustrator paths.", "extends": "ExportOptions", "properties": [ { "name": "path", "type": "IllustratorPathType", "description": "The path to export.", "access": "read/write", "static": true, "value": "IllustratorPathType.DOCUMENTBOUNDS" }, { "name": "pathName", "type": "string", "description": "The name of the path to export. Valid only for named paths.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "ExportOptionsSaveForWeb", "kind": "Object", "description": "Options for exporting Save For Web files.", "extends": "ExportOptions", "properties": [ { "name": "PNG8", "type": "boolean", "description": "If true, uses 8 bits. If false, uses 24 bits. Valid only when 'format' = PNG.", "access": "read/write", "static": true, "value": "true" }, { "name": "blur", "type": "number", "description": "The amount of blur to apply to the image to reduce artifacts.", "access": "read/write", "static": true, "value": "0" }, { "name": "colorReduction", "type": "ColorReductionType", "description": "The color reduction algorithm.", "access": "read/write", "static": true, "value": "ColorReductionType.SELECTIVE" }, { "name": "colors", "type": "number", "description": "The number of colors in the palette.", "access": "read/write", "static": true, "value": "256" }, { "name": "dither", "type": "DitherType", "description": "The type of dither.", "access": "read/write", "static": true, "value": "DitherType.DIFFUSION" }, { "name": "ditherAmount", "type": "number", "description": "The amount of dither. Valid only when 'dither' = diffusion.", "access": "read/write", "static": true, "value": "100" }, { "name": "format", "type": "SaveDocumentType", "description": "The file format to use. Save For Web supports only Compuserve GIF, JPEG, PNG-8, PNG-24, and BMP formats.", "access": "read/write", "static": true, "value": "SaveDocumentType.COMPUSERVEGIF" }, { "name": "includeProfile", "type": "boolean", "description": "If true, includes the document's embedded profile.", "access": "read/write", "static": true, "value": "false" }, { "name": "interlaced", "type": "boolean", "description": "If true, the image downloads in multiple passes, progressive.", "access": "read/write", "static": true, "value": "false" }, { "name": "lossy", "type": "number", "description": "The amount of lossiness allowed.", "access": "read/write", "static": true, "value": "0" }, { "name": "matteColor", "type": "RGBColor", "description": "The colors to blend transparent pixels against.", "access": "read/write", "static": true }, { "name": "optimized", "type": "boolean", "description": "If true, creates smaller but less compatible files.", "access": "read/write", "static": true, "value": "true" }, { "name": "quality", "type": "number", "description": "The quality of the produced image (as a percentage). Range: 0 to 100.", "access": "read/write", "static": true, "value": "60", "range": { "min": "0", "max": "100" } }, { "name": "transparency", "type": "boolean", "description": "If true, transparent areas of the image are included in the saved image.", "access": "read/write", "static": true, "value": "true" }, { "name": "transparencyAmount", "type": "number", "description": "The amount of transparency dither. Valid only when 'transparency' = true.", "access": "read/write", "static": true, "value": "100" }, { "name": "transparencyDither", "type": "DitherType", "description": "The transparency dither algorithm.", "access": "read/write", "static": true, "value": "DitherType.NONE" }, { "name": "webSnap", "type": "number", "description": "The tolerance amount within which to snap close colors to web palette colors.", "access": "read/write", "static": true, "value": "0" } ], "events": [], "methods": [] }, { "name": "ExportType", "kind": "Enumeration", "description": "The export options to use.", "properties": [ { "name": "ILLUSTRATORPATHS", "type": "number", "description": "Exports Photoshop paths as Adobe Illustrator files.", "access": "readonly", "value": "1" }, { "name": "SAVEFORWEB", "type": "number", "description": "Uses the save for web export options.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "FileNamingType", "kind": "Enumeration", "description": "File naming options for the batch command.", "properties": [ { "name": "DDMM", "type": "number", "description": "Uses the date formatted as ddmm.", "access": "readonly", "value": "16" }, { "name": "DDMMYY", "type": "number", "description": "Uses the date formatted as ddmmyy.", "access": "readonly", "value": "15" }, { "name": "DOCUMENTNAMELOWER", "type": "number", "description": "Use the document name in lower case.", "access": "readonly", "value": "2" }, { "name": "DOCUMENTNAMEMIXED", "type": "number", "description": "Use the document name in mixed case.", "access": "readonly", "value": "1" }, { "name": "DOCUMENTNAMEUPPER", "type": "number", "description": "Use the document name in UPPER case.", "access": "readonly", "value": "3" }, { "name": "EXTENSIONLOWER", "type": "number", "description": "Use the extension of the file in lower case.", "access": "readonly", "value": "17" }, { "name": "EXTENSIONUPPER", "type": "number", "description": "Use the extension of the file in UPPER case.", "access": "readonly", "value": "18" }, { "name": "MMDD", "type": "number", "description": "Uses the date formatted as mmdd.", "access": "readonly", "value": "11" }, { "name": "MMDDYY", "type": "number", "description": "Uses the date formatted as mmddyy.", "access": "readonly", "value": "10" }, { "name": "SERIALLETTERLOWER", "type": "number", "description": "Use letter serial number lower case (a, b, c, ...)", "access": "readonly", "value": "8" }, { "name": "SERIALLETTERUPPER", "type": "number", "description": "Use letter serial number UPPER case (A, B, C, ...)", "access": "readonly", "value": "9" }, { "name": "SERIALNUMBER1", "type": "number", "description": "Use a 1-digit serial number.", "access": "readonly", "value": "4" }, { "name": "SERIALNUMBER2", "type": "number", "description": "Use a 2-digit serial number.", "access": "readonly", "value": "5" }, { "name": "SERIALNUMBER3", "type": "number", "description": "Use a 3-digit serial number.", "access": "readonly", "value": "6" }, { "name": "SERIALNUMBER4", "type": "number", "description": "Use a 4-digit serial number.", "access": "readonly", "value": "7" }, { "name": "YYDDMM", "type": "number", "description": "Uses the date formatted as yyddmm.", "access": "readonly", "value": "14" }, { "name": "YYMMDD", "type": "number", "description": "Uses the date formatted as yymmdd.", "access": "readonly", "value": "13" }, { "name": "YYYYMMDD", "type": "number", "description": "Uses the date formatted as yyyymmdd.", "access": "readonly", "value": "12" } ], "events": [], "methods": [] }, { "name": "FontPreviewType", "kind": "Enumeration", "description": "The type size to use for font previews in the Type tool font menus.", "properties": [ { "name": "EXTRALARGE", "type": "number", "description": "Extra large preview.", "access": "readonly", "value": "4" }, { "name": "HUGE", "type": "number", "description": "Huge preview.", "access": "readonly", "value": "5" }, { "name": "LARGE", "type": "number", "description": "Large type.", "access": "readonly", "value": "3" }, { "name": "MEDIUM", "type": "number", "description": "Medium type.", "access": "readonly", "value": "2" }, { "name": "NONE", "type": "number", "description": "No preview.", "access": "readonly", "value": "0" }, { "name": "SMALL", "type": "number", "description": "Small type.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "FontSize", "kind": "Enumeration", "description": "Font size in panels and dialogs.", "properties": [ { "name": "LARGE", "type": "number", "description": "Large size.", "access": "readonly", "value": "3" }, { "name": "MEDIUM", "type": "number", "description": "Medium size.", "access": "readonly", "value": "2" }, { "name": "SMALL", "type": "number", "description": "Small size.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ForcedColors", "kind": "Enumeration", "description": "The colors whose inclusion to force in the color table.", "properties": [ { "name": "BLACKWHITE", "type": "number", "description": "Forces pure black and white.", "access": "readonly", "value": "2" }, { "name": "NONE", "type": "number", "description": "No forced colors.", "access": "readonly", "value": "1" }, { "name": "PRIMARIES", "type": "number", "description": "Forces red, green, blue, cyan, magenta, yellow, black, and white.", "access": "readonly", "value": "3" }, { "name": "WEB", "type": "number", "description": "Forces the 216 web-safe colors.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "FormatOptionsType", "kind": "Enumeration", "description": "The options for saving a JPEG file.", "properties": [ { "name": "OPTIMIZEDBASELINE", "type": "number", "description": "Baseline (Optimized). Optimized color and a slightly reduced file size.", "access": "readonly", "value": "2" }, { "name": "PROGRESSIVE", "type": "number", "description": "Displays a series of increasingly detailed scans as the image downloads.", "access": "readonly", "value": "3" }, { "name": "STANDARDBASELINE", "type": "number", "description": "Baseline (Standard). Recognized by most web browsers.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "GIFSaveOptions", "kind": "Object", "description": "Options for saving a document in GIF format.", "extends": "SaveOptions", "properties": [ { "name": "colors", "type": "number", "description": "The number of colors in palette. Not valid for all palette types.", "access": "read/write", "static": true }, { "name": "dither", "type": "DitherType", "description": "The type of dither.", "access": "read/write", "static": true }, { "name": "ditherAmount", "type": "number", "description": "The amount of dither. Valid only when 'dither type' is diffusion. Range: 1 to 100.", "access": "read/write", "static": true, "value": "75", "range": { "min": "1", "max": "100" } }, { "name": "forced", "type": "ForcedColors", "description": "The type of colors to force into the color palette.", "access": "read/write", "static": true }, { "name": "interlaced", "type": "boolean", "description": "If true, rows are interlaced.", "access": "read/write", "static": true, "value": "false" }, { "name": "matte", "type": "MatteType", "description": "The color to use to fill anti-aliased edges adjacent to transparent areas of the image. Default: white.", "access": "read/write", "static": true }, { "name": "palette", "type": "PaletteType", "description": "The type of palette to use.", "access": "read/write", "static": true, "value": "PaletteType.LOCALSELECTIVE" }, { "name": "preserveExactColors", "type": "boolean", "description": "If true, protects colors in the image that contain entries in the color table from being dithered. Valid only when 'dither' = diffusion.", "access": "read/write", "static": true }, { "name": "transparency", "type": "boolean", "description": "If true, preserves transparent ares of the image during GIF conversion.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "GalleryBannerOptions", "kind": "Object", "description": "Deprecated, the make photo gallery method has moved to Bridge.", "properties": [ { "name": "contactInfo", "type": "string", "description": "Web photo gallery contact info.", "access": "read/write", "static": true }, { "name": "date", "type": "string", "description": "Web photo gallery date.", "access": "read/write", "static": true }, { "name": "font", "type": "GalleryFontType", "description": "The font setting for the banner text.", "access": "read/write", "static": true, "value": "GalleryFontType.ARIAL" }, { "name": "fontSize", "type": "number", "description": "The size of the font for the banner text.", "access": "read/write", "static": true, "value": "3", "range": { "min": "1", "max": "7" } }, { "name": "photographer", "type": "string", "description": "Web photo gallery photographer.", "access": "read/write", "static": true }, { "name": "siteName", "type": "string", "description": "Web photo gallery site name.", "access": "read/write", "static": true, "value": "Adobe Web Photo Gallery" } ], "events": [], "methods": [] }, { "name": "GalleryConstrainType", "kind": "Enumeration", "description": "DEPRECATED. Constrain values for images.", "properties": [ { "name": "CONSTRAINBOTH", "type": "number", "description": "Constrain both the height and the width of the image.", "access": "readonly", "value": "3" }, { "name": "CONSTRAINHEIGHT", "type": "number", "description": "Constrain the height of the image.", "access": "readonly", "value": "2" }, { "name": "CONSTRAINWIDTH", "type": "number", "description": "Constrain width.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "GalleryCustomColorOptions", "kind": "Object", "description": "Deprecated, the make photo gallery method has moved to Bridge.", "properties": [ { "name": "activeLinkColor", "type": "RGBColor", "description": "Active link color.", "access": "read/write", "static": true }, { "name": "backgroundColor", "type": "RGBColor", "description": "Background color.", "access": "read/write", "static": true }, { "name": "bannerColor", "type": "RGBColor", "description": "Banner color.", "access": "read/write", "static": true }, { "name": "linkColor", "type": "RGBColor", "description": "Link color.", "access": "read/write", "static": true }, { "name": "textColor", "type": "RGBColor", "description": "Text color.", "access": "read/write", "static": true }, { "name": "visitedLinkColor", "type": "RGBColor", "description": "Visited link color.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "GalleryFontType", "kind": "Enumeration", "description": "Fonts for web photo gallery text.", "properties": [ { "name": "ARIAL", "type": "number", "description": "Arial font.", "access": "readonly", "value": "1" }, { "name": "COURIERNEW", "type": "number", "description": "Courier New font.", "access": "readonly", "value": "2" }, { "name": "HELVETICA", "type": "number", "description": "Helvetica font.", "access": "readonly", "value": "3" }, { "name": "TIMESNEWROMAN", "type": "number", "description": "Times New Roman font.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "GalleryImagesOptions", "kind": "Object", "description": "Deprecated, the make photo gallery method has moved to Bridge.", "properties": [ { "name": "border", "type": "number", "description": "The amount of border pixels you want between your images.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "99" } }, { "name": "caption", "type": "boolean", "description": "Generate a caption for the images.", "access": "read/write", "static": true, "value": "false" }, { "name": "dimension", "type": "number", "description": "Resized image dimensions in pixels.", "access": "read/write", "static": true, "value": "350" }, { "name": "font", "type": "GalleryFontType", "description": "Font for the gallery images text.", "access": "read/write", "static": true, "value": "GalleryFontType.ARIAL" }, { "name": "fontSize", "type": "number", "description": "Font size for the gallery images text.", "access": "read/write", "static": true, "value": "3", "range": { "min": "1", "max": "7" } }, { "name": "imageQuality", "type": "number", "description": "The quality setting for the JPEG image.", "access": "read/write", "static": true, "value": "5", "range": { "min": "0", "max": "12" } }, { "name": "includeCopyright", "type": "boolean", "description": "Include the copyright in the text for the gallery images.", "access": "read/write", "static": true, "value": "false" }, { "name": "includeCredits", "type": "boolean", "description": "Include the credits in the text for the gallery images.", "access": "read/write", "static": true, "value": "false" }, { "name": "includeFilename", "type": "boolean", "description": "Include the file name in the text for the gallery images.", "access": "read/write", "static": true, "value": "true" }, { "name": "includeTitle", "type": "boolean", "description": "Include the title in the text for the gallery images.", "access": "read/write", "static": true, "value": "false" }, { "name": "numericLinks", "type": "boolean", "description": "Add numeric links.", "access": "read/write", "static": true, "value": "true" }, { "name": "resizeConstraint", "type": "GalleryConstrainType", "description": "How should the image be constrained.", "access": "read/write", "static": true, "value": "GalleryConstrainType.CONSTRAINBOTH" }, { "name": "resizeImages", "type": "boolean", "description": "Resize images data.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "GalleryOptions", "kind": "Object", "description": "Deprecated, the make photo gallery method has moved to Bridge.", "properties": [ { "name": "addSizeAttributes", "type": "boolean", "description": "Add width and height attributes for images.", "access": "read/write", "static": true, "value": "true" }, { "name": "bannerOptions", "type": "GalleryBannerOptions", "description": "Options related to banner settings.", "access": "read/write", "static": true }, { "name": "customColorOptions", "type": "GalleryCustomColorOptions", "description": "Options related to custom color settings.", "access": "read/write", "static": true }, { "name": "emailAddress", "type": "string", "description": "The email address to show on the web page.", "access": "read/write", "static": true }, { "name": "imagesOptions", "type": "GalleryImagesOptions", "description": "Options related to images settings.", "access": "read/write", "static": true }, { "name": "includeSubFolders", "type": "boolean", "description": "Include all files found in sub folders of the input folder.", "access": "read/write", "static": true, "value": "true" }, { "name": "layoutStyle", "type": "string", "description": "The style to use for laying out the web page.", "access": "read/write", "static": true, "value": "Centered Frame 1 - Basic" }, { "name": "preserveAllMetadata", "type": "boolean", "description": "Save all of the metadata in the JPEG files.", "access": "read/write", "static": true, "value": "false" }, { "name": "securityOptions", "type": "GallerySecurityOptions", "description": "Options related to security settings.", "access": "read/write", "static": true }, { "name": "thumbnailOptions", "type": "GalleryThumbnailOptions", "description": "Options related to thumbnail settings.", "access": "read/write", "static": true }, { "name": "useShortExtension", "type": "boolean", "description": "Short web page extension .htm or long web page extension .html.", "access": "read/write", "static": true, "value": "true" }, { "name": "useUTF8Encoding", "type": "boolean", "description": "Web page should use UTF-8 encoding.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "GallerySecurityOptions", "kind": "Object", "description": "Deprecated, the make photo gallery method has moved to Bridge.", "properties": [ { "name": "content", "type": "GallerySecurityType", "description": "Web photo gallery security content.", "access": "read/write", "static": true, "value": "GallerySecurityType.NONE" }, { "name": "font", "type": "GalleryFontType", "description": "Web photo gallery security font.", "access": "read/write", "static": true, "value": "GalleryFontType.ARIAL" }, { "name": "fontSize", "type": "number", "description": "Web photo gallery security font size.", "access": "read/write", "static": true, "value": "36", "range": { "min": "1", "max": "" } }, { "name": "opacity", "type": "number", "description": "Web page security opacity as a percent.", "access": "read/write", "static": true, "value": "100" }, { "name": "text", "type": "string", "description": "Web photo gallery security custom text.", "access": "read/write", "static": true }, { "name": "textColor", "type": "RGBColor", "description": "Web page security text color.", "access": "read/write", "static": true }, { "name": "textPosition", "type": "GallerySecurityTextPositionType", "description": "Web photo gallery security text position.", "access": "read/write", "static": true, "value": "GallerySecurityTextPositionType.CENTERED" }, { "name": "textRotate", "type": "GallerySecurityTextRotateType", "description": "Web photo gallery security text rotate.", "access": "read/write", "static": true, "value": "GallerySecurityTextRotateType.ZERO" } ], "events": [], "methods": [] }, { "name": "GallerySecurityTextColorType", "kind": "Enumeration", "description": "The color to use for text displayed over gallery images as an antitheft deterrent.", "properties": [ { "name": "BLACK", "type": "number", "description": "Black text.", "access": "readonly", "value": "1" }, { "name": "CUSTOM", "type": "number", "description": "Custom color.", "access": "readonly", "value": "3" }, { "name": "WHITE", "type": "number", "description": "White text.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "GallerySecurityTextPositionType", "kind": "Enumeration", "description": "The position of the text displayed over gallery images as an antitheft deterrent.", "properties": [ { "name": "CENTERED", "type": "number", "description": "Text is centered on each image.", "access": "readonly", "value": "1" }, { "name": "LOWERLEFT", "type": "number", "description": "Ltext is in the lower left corner of each image.", "access": "readonly", "value": "3" }, { "name": "LOWERRIGHT", "type": "number", "description": "Text is in the lower right corner of each image.", "access": "readonly", "value": "5" }, { "name": "UPPERLEFT", "type": "number", "description": "Text is in the upper left corner of each image.", "access": "readonly", "value": "2" }, { "name": "UPPERRIGHT", "type": "number", "description": "Text is in the upper right corner of each image.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "GallerySecurityTextRotateType", "kind": "Enumeration", "description": "DEPRECATED. web photo gallery security text rotation types.", "properties": [ { "name": "CLOCKWISE45", "type": "number", "description": "Rotate 45 degrees clock wise.", "access": "readonly", "value": "2" }, { "name": "CLOCKWISE90", "type": "number", "description": "Rotate 90 degrees clock wise.", "access": "readonly", "value": "3" }, { "name": "COUNTERCLOCKWISE45", "type": "number", "description": "Rotate 45 degrees counter clock wise.", "access": "readonly", "value": "4" }, { "name": "COUNTERCLOCKWISE90", "type": "number", "description": "Rotate 90 degrees counter clock wise.", "access": "readonly", "value": "5" }, { "name": "ZERO", "type": "number", "description": "No rotate.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "GallerySecurityType", "kind": "Enumeration", "description": "DEPRECATED. Web photo gallery security types.", "properties": [ { "name": "CAPTION", "type": "number", "description": "Caption security.", "access": "readonly", "value": "5" }, { "name": "COPYRIGHT", "type": "number", "description": "Copyright security.", "access": "readonly", "value": "4" }, { "name": "CREDIT", "type": "number", "description": "Credit security.", "access": "readonly", "value": "6" }, { "name": "CUSTOMTEXT", "type": "number", "description": "Custom text security.", "access": "readonly", "value": "2" }, { "name": "FILENAME", "type": "number", "description": "Filename security.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "No security.", "access": "readonly", "value": "1" }, { "name": "TITLE", "type": "number", "description": "Title security.", "access": "readonly", "value": "7" } ], "events": [], "methods": [] }, { "name": "GalleryThumbSizeType", "kind": "Enumeration", "description": "DEPRECATED. Web photo gallery thumb size types.", "properties": [ { "name": "CUSTOM", "type": "number", "description": "Custom thumbnail.", "access": "readonly", "value": "4" }, { "name": "LARGE", "type": "number", "description": "Large thumbnail.", "access": "readonly", "value": "3" }, { "name": "MEDIUM", "type": "number", "description": "Medium thumbnail.", "access": "readonly", "value": "2" }, { "name": "SMALL", "type": "number", "description": "Small thumbnail.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "GalleryThumbnailOptions", "kind": "Object", "description": "Deprecated, the make photo gallery method has moved to Bridge.", "properties": [ { "name": "border", "type": "number", "description": "The amount of border pixels you want around your thumbnail images.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "99" } }, { "name": "caption", "type": "boolean", "description": "With caption.", "access": "read/write", "static": true, "value": "false" }, { "name": "columnCount", "type": "number", "description": "Web photo gallery thumbnail columns.", "access": "read/write", "static": true, "value": "5" }, { "name": "dimension", "type": "number", "description": "Web photo gallery thumbnail dimension in pixels.", "access": "read/write", "static": true, "value": "75" }, { "name": "font", "type": "GalleryFontType", "description": "Web photo gallery font.", "access": "read/write", "static": true, "value": "GalleryFontType.ARIAL" }, { "name": "fontSize", "type": "number", "description": "The size of the font for the thumbnail images text.", "access": "read/write", "static": true, "value": "3", "range": { "min": "1", "max": "7" } }, { "name": "includeCopyright", "type": "boolean", "description": "Include copyright for thumbnail.", "access": "read/write", "static": true, "value": "false" }, { "name": "includeCredits", "type": "boolean", "description": "Include credits for thumbnail.", "access": "read/write", "static": true, "value": "false" }, { "name": "includeFilename", "type": "boolean", "description": "Include file name for thumbnail.", "access": "read/write", "static": true, "value": "false" }, { "name": "includeTitle", "type": "boolean", "description": "Include title for thumbnail.", "access": "read/write", "static": true, "value": "false" }, { "name": "rowCount", "type": "number", "description": "Web photo gallery thumbnail rows.", "access": "read/write", "static": true, "value": "3" }, { "name": "size", "type": "GalleryThumbSizeType", "description": "The size of the thumbnail images.", "access": "read/write", "static": true, "value": "GalleryThumbSizeType.MEDIUM" } ], "events": [], "methods": [] }, { "name": "GenericEPSOpenOptions", "kind": "Object", "description": "Options that can be specified when opening a generic EPS document.", "extends": "OpenOptions", "properties": [ { "name": "antiAlias", "type": "boolean", "description": "If true, anti-aliasing is used.", "access": "read/write", "static": true }, { "name": "constrainProportions", "type": "boolean", "description": "If true, the image proportions are constrained.", "access": "read/write", "static": true }, { "name": "height", "type": "UnitValue", "description": "The image height.", "access": "read/write", "static": true }, { "name": "mode", "type": "OpenDocumentMode", "description": "The document mode.", "access": "read/write", "static": true }, { "name": "resolution", "type": "number", "description": "The resolution of the document (in pixels per inch)", "access": "read/write", "static": true }, { "name": "width", "type": "UnitValue", "description": "The image width.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "GenericPDFOpenOptions", "kind": "Object", "description": "Options that can be specified when opening a generic PDF document.", "extends": "OpenOptions", "properties": [ { "name": "antiAlias", "type": "boolean", "description": "If true, anti-aliasing is used.", "access": "read/write", "static": true }, { "name": "bitsPerChannel", "type": "BitsPerChannelType", "description": "The number of bits per channel.", "access": "read/write", "static": true }, { "name": "constrainProportions", "type": "boolean", "description": "DEPRECATED.", "access": "read/write", "static": true }, { "name": "cropPage", "type": "CropToType", "description": "The cropping method to use.", "access": "read/write", "static": true }, { "name": "height", "type": "UnitValue", "description": "DEPRECATED.", "access": "read/write", "static": true }, { "name": "mode", "type": "OpenDocumentMode", "description": "The document mode.", "access": "read/write", "static": true }, { "name": "name", "type": "string", "description": "The name of the document.", "access": "read/write", "static": true }, { "name": "object", "type": "number", "description": "The number of the 3d object to open.", "access": "read/write", "static": true }, { "name": "page", "type": "number", "description": "The number of the page or image to open.", "access": "read/write", "static": true }, { "name": "resolution", "type": "number", "description": "The resolution of the document (in pixels per inch)", "access": "read/write", "static": true }, { "name": "suppressWarnings", "type": "boolean", "description": "If true, suppresses any warnings that may occur during opening.", "access": "read/write", "static": true }, { "name": "use3DObjectNumber", "type": "boolean", "description": "If true, the value specified in the page property refers to a page number. If false, the value specifies an image number.", "access": "read/write", "static": true }, { "name": "usePageNumber", "type": "boolean", "description": "If true, the value specified in the page property refers to a page number. If false, the value specifies an image number.", "access": "read/write", "static": true }, { "name": "width", "type": "UnitValue", "description": "DEPRECATED.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "Geometry", "kind": "Enumeration", "description": "Geometric options for shapes, such as the iris shape in the Lens Blur Filter.", "properties": [ { "name": "HEPTAGON", "type": "number", "description": "Heptagon.", "access": "readonly", "value": "4" }, { "name": "HEXAGON", "type": "number", "description": "Hexagon.", "access": "readonly", "value": "2" }, { "name": "OCTAGON", "type": "number", "description": "Octagon.", "access": "readonly", "value": "5" }, { "name": "PENTAGON", "type": "number", "description": "Pentagon.", "access": "readonly", "value": "1" }, { "name": "SQUARE", "type": "number", "description": "Square.", "access": "readonly", "value": "3" }, { "name": "TRIANGLE", "type": "number", "description": "Triangle.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "GrayColor", "kind": "Object", "description": "Options for defining a gray color.", "extends": "Color", "properties": [ { "name": "gray", "type": "number", "description": "The gray value. Range: 0.0 to 100.0.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "100" } }, { "name": "gray", "type": "number", "description": "The gray value. Range: 0.0 to 100.0.", "access": "read/write", "value": "0", "range": { "min": "0", "max": "100" } } ], "events": [], "methods": [] }, { "name": "GridLineStyle", "kind": "Enumeration", "description": "The line style for nonprinting grids displayed over images.", "properties": [ { "name": "DASHED", "type": "number", "description": "Dashed.", "access": "readonly", "value": "2" }, { "name": "DOTTED", "type": "number", "description": "Dotted.", "access": "readonly", "value": "3" }, { "name": "SOLID", "type": "number", "description": "Solid.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "GridSize", "kind": "Enumeration", "description": "The size of grid squares.", "properties": [ { "name": "LARGE", "type": "number", "description": "Large grid squares.", "access": "readonly", "value": "4" }, { "name": "MEDIUM", "type": "number", "description": "Medium grid squares.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "No grid is displayed.", "access": "readonly", "value": "1" }, { "name": "SMALL", "type": "number", "description": "Small grid squares.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Guide", "kind": "Object", "description": "A guide in the document.", "properties": [ { "name": "coordinate", "type": "UnitValue", "description": "Location of the guide from origin of image.", "access": "read/write" }, { "name": "direction", "type": "Direction", "description": "Indicates whether the guide is vertical or horizontal.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GuideLineStyle", "kind": "Enumeration", "description": "The line style for nonprinting guides displayed over images.", "properties": [ { "name": "DASHED", "type": "number", "description": "Dashed.", "access": "readonly", "value": "2" }, { "name": "SOLID", "type": "number", "description": "Solid.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Guides", "kind": "Collection", "description": "Guides associated with the document.", "elementType": "Guide", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Guide", "description": "A guide.", "parameters": [ { "name": "direction", "type": "Direction", "description": "Indicates whether the guide is vertical or horizontal." }, { "name": "coordinate", "type": "UnitValue", "description": "Location of the guide from origin of image." } ] }, { "name": "getByName", "returns": "Guide", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "HSBColor", "kind": "Object", "description": "An HSB color specification.", "extends": "Color", "properties": [ { "name": "brightness", "type": "number", "description": "The brightness value. Range: 0.0 to 100.0.", "access": "read/write", "static": true }, { "name": "brightness", "type": "number", "description": "The brightness value. Range: 0.0 to 100.0.", "access": "read/write" }, { "name": "hue", "type": "number", "description": "The hue value. Range: 0.0 to 360.0.", "access": "read/write", "static": true }, { "name": "hue", "type": "number", "description": "The hue value. Range: 0.0 to 360.0.", "access": "read/write" }, { "name": "saturation", "type": "number", "description": "The saturation value. Range: 0.0 to 100.0.", "access": "read/write", "static": true }, { "name": "saturation", "type": "number", "description": "The saturation value. Range: 0.0 to 100.0.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "HistoryState", "kind": "Object", "description": "A version of the document stored automatically (and added to the history states collection, which preserves the document state each time the document is changed).", "properties": [ { "name": "name", "type": "string", "description": "The history state name.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "snapshot", "type": "boolean", "description": "If true, the history state is a snapshot.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "HistoryStates", "kind": "Collection", "description": "The history state objects associated with the document.", "elementType": "HistoryState", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "HistoryState", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "getByName", "returns": "HistoryState", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "IllustratorPathType", "kind": "Enumeration", "description": "The paths to export.", "properties": [ { "name": "ALLPATHS", "type": "number", "description": "Exports all paths.", "access": "readonly", "value": "2" }, { "name": "DOCUMENTBOUNDS", "type": "number", "description": "Exports the document bounds.", "access": "readonly", "value": "1" }, { "name": "NAMEDPATH", "type": "number", "description": "Exports the specified path. To specify the path, see the path name property of the illustrator export options object.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "IndexedConversionOptions", "kind": "Object", "description": "Options for converting an RGB image to an indexed color model.", "extends": "DocumentConversionOptions", "properties": [ { "name": "colors", "type": "number", "description": "The number of colors in the palette. Not valid for all palette types.", "access": "read/write", "static": true }, { "name": "dither", "type": "DitherType", "description": "The type of dither.", "access": "read/write", "static": true }, { "name": "ditherAmount", "type": "number", "description": "The amount of dither. Valid only when 'dither' = diffusion.", "access": "read/write", "static": true, "range": { "min": "1", "max": "100" } }, { "name": "forced", "type": "ForcedColors", "description": "The type of colors to force into the color palette.", "access": "read/write", "static": true }, { "name": "matte", "type": "MatteType", "description": "The color to use to fill anti-aliased edges adjacent to transparent areas of the image. When transparency = false, the matte color is applied to transparent areas.", "access": "read/write", "static": true }, { "name": "palette", "type": "PaletteType", "description": "The type of palette.", "access": "read/write", "static": true, "value": "PaletteType.EXACT" }, { "name": "preserveExactColors", "type": "boolean", "description": "If true, protects colors in the image that contain entries in the color table from being dithered. Valid only when 'dither' = diffusion.", "access": "read/write", "static": true }, { "name": "transparency", "type": "boolean", "description": "If true, preserves transparent areas of the image during conversion to GIF format.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "Intent", "kind": "Enumeration", "description": "The color conversion intent.", "properties": [ { "name": "ABSOLUTECOLORIMETRIC", "type": "number", "description": "Aims to maintain color accuracy at the expense of preserving relationships between colors and is suitable for proofing to simulate the output of a particular device. This intent is particularly useful for previewing how paper color affects printed colors.", "access": "readonly", "value": "4" }, { "name": "PERCEPTUAL", "type": "number", "description": "Gives priority to colors for which the human eye has greater sensitivity.", "access": "readonly", "value": "1" }, { "name": "RELATIVECOLORIMETRIC", "type": "number", "description": "Compares the extreme highlight of the source color space to that of the destination color space and shifts all colors accordingly. Out of gamut colors are shifted to the closest reproducible color in the destination color space.", "access": "readonly", "value": "3" }, { "name": "SATURATION", "type": "number", "description": "Tries to produce vivid colors in an image at the expense of color accuracy.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "JPEGSaveOptions", "kind": "Object", "description": "Options for saving a document in JPEG format.", "extends": "SaveOptions", "properties": [ { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "formatOptions", "type": "FormatOptionsType", "description": "The download format to use.", "access": "read/write", "static": true, "value": "FormatOptionsType.STANDARDBASELINE" }, { "name": "matte", "type": "MatteType", "description": "The color to use to fill anti-aliased edges adjacent to transparent areas of the image. Default: white.", "access": "read/write", "static": true }, { "name": "quality", "type": "number", "description": "The quality of the produced image.", "access": "read/write", "static": true, "value": "3", "range": { "min": "0", "max": "12" } }, { "name": "scans", "type": "number", "description": "The number of scans. Valid only for progressive type JPEG files.", "access": "read/write", "static": true, "range": { "min": "3", "max": "5" } } ], "events": [], "methods": [] }, { "name": "JavaScriptExecutionMode", "kind": "Enumeration", "description": "When should a JavaScript debugger be shown.", "properties": [ { "name": "BEFORERUNNING", "type": "number", "description": "Show the JavaScript debugger when the first line of the JavaScript executes.", "access": "readonly", "value": "3" }, { "name": "NEVER", "type": "number", "description": "Never show the JavaScript debugger. Treat runtime errors by throwing a JavaScript exceptions.", "access": "readonly", "value": "1" }, { "name": "ONRUNTIMEERROR", "type": "number", "description": "Show the JavaScript debugger if a runtime error occurs.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Justification", "kind": "Enumeration", "description": "The placement of paragraph text within the bounding box.", "properties": [ { "name": "CENTER", "type": "number", "description": "Text is centered on each line.", "access": "readonly", "value": "2" }, { "name": "CENTERJUSTIFIED", "type": "number", "description": "Justifies all lines except the last, which is center-aligned.", "access": "readonly", "value": "5" }, { "name": "FULLYJUSTIFIED", "type": "number", "description": "Justifies all lines including the last, which is force-justified.", "access": "readonly", "value": "7" }, { "name": "LEFT", "type": "number", "description": "Aligns the left edges, leaving the right edge ragged.", "access": "readonly", "value": "1" }, { "name": "LEFTJUSTIFIED", "type": "number", "description": "Justifies all lines except the last, which is left-aligned.", "access": "readonly", "value": "4" }, { "name": "RIGHT", "type": "number", "description": "Aligns the right edges, leaving the left edge ragged.", "access": "readonly", "value": "3" }, { "name": "RIGHTJUSTIFIED", "type": "number", "description": "Justifies all lines except the last, which is right-aligned.", "access": "readonly", "value": "6" } ], "events": [], "methods": [] }, { "name": "LabColor", "kind": "Object", "description": "A Lab color specification.", "extends": "Color", "properties": [ { "name": "A", "type": "number", "description": "The a-value. Range: -128.0 and 127.0.", "access": "read/write", "static": true }, { "name": "A", "type": "number", "description": "The a-value. Range: -128.0 and 127.0.", "access": "read/write" }, { "name": "B", "type": "number", "description": "The b-value. Range: -128.0 and 127.0.", "access": "read/write", "static": true }, { "name": "B", "type": "number", "description": "The b-value. Range: -128.0 and 127.0.", "access": "read/write" }, { "name": "L", "type": "number", "description": "The L-value. Range: 0.0 to 100.0.", "access": "read/write", "static": true }, { "name": "L", "type": "number", "description": "The L-value. Range: 0.0 to 100.0.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "Language", "kind": "Enumeration", "description": "The language to use.", "properties": [ { "name": "BRAZILLIANPORTUGUESE", "type": "number", "description": "Brazillian Portuguese.", "access": "readonly", "value": "13" }, { "name": "CANADIANFRENCH", "type": "number", "description": "Canadian French.", "access": "readonly", "value": "4" }, { "name": "DANISH", "type": "number", "description": "Danish.", "access": "readonly", "value": "17" }, { "name": "DUTCH", "type": "number", "description": "Dutch.", "access": "readonly", "value": "16" }, { "name": "ENGLISHUK", "type": "number", "description": "British English.", "access": "readonly", "value": "2" }, { "name": "ENGLISHUSA", "type": "number", "description": "American English.", "access": "readonly", "value": "1" }, { "name": "FINNISH", "type": "number", "description": "Finnish.", "access": "readonly", "value": "5" }, { "name": "FRENCH", "type": "number", "description": "French.", "access": "readonly", "value": "3" }, { "name": "GERMAN", "type": "number", "description": "German.", "access": "readonly", "value": "6" }, { "name": "ITALIAN", "type": "number", "description": "Italian.", "access": "readonly", "value": "9" }, { "name": "NORWEGIAN", "type": "number", "description": "Norwegian.", "access": "readonly", "value": "10" }, { "name": "NYNORSKNORWEGIAN", "type": "number", "description": "Nynorsk Norwegian.", "access": "readonly", "value": "11" }, { "name": "OLDGERMAN", "type": "number", "description": "Old German.", "access": "readonly", "value": "7" }, { "name": "PORTUGUESE", "type": "number", "description": "Portuguese.", "access": "readonly", "value": "12" }, { "name": "SPANISH", "type": "number", "description": "Spanish.", "access": "readonly", "value": "14" }, { "name": "SWEDISH", "type": "number", "description": "Swedish.", "access": "readonly", "value": "15" }, { "name": "SWISSGERMAN", "type": "number", "description": "Swiss German.", "access": "readonly", "value": "8" } ], "events": [], "methods": [] }, { "name": "Layer", "kind": "Object", "description": "A layer object.", "properties": [ { "name": "allLocked", "type": "boolean", "description": "If true, the layer's contents and settings are locked.", "access": "read/write" }, { "name": "blendMode", "type": "BlendMode", "description": "The mode to use when compositing an object.", "access": "read/write" }, { "name": "bounds", "type": "number[]", "description": "If the Layer is a layer set, this property returns a reference to the corresponding layer set object.", "access": "readonly" }, { "name": "boundsNoEffects", "type": "number[]", "description": "Bounding rectangle of the Layer not including effects.", "access": "readonly" }, { "name": "id", "type": "number", "description": "The unique ID of this layer.", "access": "readonly" }, { "name": "itemIndex", "type": "number", "description": "The layer index sans layer groups, how Photoshop would index them.", "access": "readonly" }, { "name": "linkedLayers", "type": "Layer[]", "description": "The layers linked to this layer.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The name of the layer.", "access": "read/write" }, { "name": "opacity", "type": "number", "description": "The layer's master opacity (as a percentage). Range: 0.0 to 100.0.", "access": "read/write", "range": { "min": "0", "max": "100" } }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "visible", "type": "boolean", "description": "If true, the layer is visible.", "access": "read/write" }, { "name": "xmpMetadata", "type": "XMPMetadata", "description": "XMP metadata associated with the Layer.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "Layer", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "link", "returns": "void", "description": "Links the layer with the specified layer.", "parameters": [ { "name": "with", "type": "Layer", "description": "The layer to link to." } ] }, { "name": "move", "returns": "Layer", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "moveToEnd", "returns": "void", "description": "...", "parameters": [ { "name": "layerSet", "type": "LayerSet", "description": "", "optional": true } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "resize", "returns": "void", "description": "Scales the object.", "parameters": [ { "name": "horizontal", "type": "number", "description": "The amount to scale the object horizontally (as a percentage).", "optional": true }, { "name": "vertical", "type": "number", "description": "The amount to scale the object vertically (as a percentage).", "optional": true }, { "name": "anchor", "type": "AnchorPosition", "description": "The point to resize about.", "optional": true } ] }, { "name": "rotate", "returns": "void", "description": "Rotates the object.", "parameters": [ { "name": "angle", "type": "number", "description": "The number of degrees to rotate the object." }, { "name": "anchor", "type": "AnchorPosition", "description": "The point to rotate about.", "optional": true } ] }, { "name": "translate", "returns": "void", "description": "Moves the object relative to its current position.", "parameters": [ { "name": "deltaX", "type": "UnitValue", "description": "The amount to move the object horizontally.", "optional": true }, { "name": "deltaY", "type": "UnitValue", "description": "The amount to move the object vertically.", "optional": true } ] }, { "name": "unlink", "returns": "void", "description": "Unlinks the layer.", "parameters": [] } ] }, { "name": "LayerComp", "kind": "Object", "description": "A snapshot of a state of the layers in a document (can be used to view different page layouts or compostions).", "properties": [ { "name": "appearance", "type": "boolean", "description": "If true, uses layer appearance (layer styles) settings.", "access": "read/write" }, { "name": "comment", "type": "any", "description": "The description of the layer comp.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The name of the layer comp.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "position", "type": "boolean", "description": "If true, uses layer position.", "access": "read/write" }, { "name": "selected", "type": "boolean", "description": "If true, the layer comp is currently selected.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "visibility", "type": "boolean", "description": "If true, the layer comp is visible.", "access": "read/write" } ], "events": [], "methods": [ { "name": "add", "returns": "LayerComp", "description": "Adds an element.", "parameters": [] }, { "name": "apply", "returns": "void", "description": "Applies the layer comp to the document.", "parameters": [] }, { "name": "recapture", "returns": "void", "description": "Recaptures the current layer state(s) for this layer comp.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "resetFromComp", "returns": "void", "description": "Resets the layer comp state to the document state.", "parameters": [] } ] }, { "name": "LayerCompressionType", "kind": "Enumeration", "description": "The layer compression type.", "properties": [ { "name": "RLE", "type": "number", "description": "Run Length Encoding, which is lossless.", "access": "readonly", "value": "1" }, { "name": "ZIP", "type": "number", "description": "Zip compression, which is lossless and most effective for images that contain large areas of single color.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "LayerComps", "kind": "Collection", "description": "The layer comp objects associated with the document.", "elementType": "LayerComp", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "LayerComp", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "LayerComp", "description": "Adds a layer comp.", "parameters": [ { "name": "name", "type": "string", "description": "The name of the layer comp." }, { "name": "comment", "type": "string", "description": "The description of the layer comp.", "optional": true }, { "name": "appearance", "type": "boolean", "description": "If true, uses the layer appearance or style for this layer comp.", "optional": true }, { "name": "position", "type": "boolean", "description": "If true, uses the layer position for this layer comp.", "optional": true }, { "name": "visibility", "type": "boolean", "description": "If true, uses the layer visibility for this layer comp.", "optional": true } ] }, { "name": "getByName", "returns": "LayerComp", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "LayerKind", "kind": "Enumeration", "description": "The types of art layers.", "properties": [ { "name": "BLACKANDWHITE", "type": "number", "description": "Black and white layer.", "access": "readonly", "value": "22" }, { "name": "BRIGHTNESSCONTRAST", "type": "number", "description": "Brightness contrast adjustment layer.", "access": "readonly", "value": "9" }, { "name": "CHANNELMIXER", "type": "number", "description": "Channel mixer adjustment layer.", "access": "readonly", "value": "12" }, { "name": "COLORBALANCE", "type": "number", "description": "Color balance adjustment layer.", "access": "readonly", "value": "8" }, { "name": "COLORLOOKUP", "type": "number", "description": "Color lookup layer.", "access": "readonly", "value": "24" }, { "name": "CURVES", "type": "number", "description": "Curves adjustment layer.", "access": "readonly", "value": "7" }, { "name": "EXPOSURE", "type": "number", "description": "Exposure layer.", "access": "readonly", "value": "19" }, { "name": "GRADIENTFILL", "type": "number", "description": "Gradient fill.", "access": "readonly", "value": "4" }, { "name": "GRADIENTMAP", "type": "number", "description": "Gradient map adjustment laye.", "access": "readonly", "value": "13" }, { "name": "HUESATURATION", "type": "number", "description": "Hue saturation adjustment laye.", "access": "readonly", "value": "10" }, { "name": "INVERSION", "type": "number", "description": "Invert adjustment layer.", "access": "readonly", "value": "14" }, { "name": "LAYER3D", "type": "number", "description": "3D layer.", "access": "readonly", "value": "20" }, { "name": "LEVELS", "type": "number", "description": "Levels adjustment layer.", "access": "readonly", "value": "6" }, { "name": "NORMAL", "type": "number", "description": "Normal.", "access": "readonly", "value": "1" }, { "name": "PATTERNFILL", "type": "number", "description": "Pattern fill.", "access": "readonly", "value": "5" }, { "name": "PHOTOFILTER", "type": "number", "description": "Photo filter layer.", "access": "readonly", "value": "18" }, { "name": "POSTERIZE", "type": "number", "description": "Posterize adjustment layer.", "access": "readonly", "value": "16" }, { "name": "SELECTIVECOLOR", "type": "number", "description": "Selective color adjustment layer.", "access": "readonly", "value": "11" }, { "name": "SMARTOBJECT", "type": "number", "description": "Smart object layer.", "access": "readonly", "value": "17" }, { "name": "SOLIDFILL", "type": "number", "description": "Solid color.", "access": "readonly", "value": "3" }, { "name": "TEXT", "type": "number", "description": "Text.", "access": "readonly", "value": "2" }, { "name": "THRESHOLD", "type": "number", "description": "Threshold adjustment layer.", "access": "readonly", "value": "15" }, { "name": "VIBRANCE", "type": "number", "description": "Vibrance layer.", "access": "readonly", "value": "23" }, { "name": "VIDEO", "type": "number", "description": "Video layer.", "access": "readonly", "value": "21" } ], "events": [], "methods": [] }, { "name": "LayerSet", "kind": "Object", "description": "A group of layer objects, which can include art layer objects and other (nested) layer set objects. A single command or set of commands manipulates all layers in a layer set object.", "extends": "Layer", "properties": [ { "name": "artLayers", "type": "ArtLayers", "description": "The art layers contained in this layer set.", "access": "readonly" }, { "name": "enabledChannels", "type": "Channel[]", "description": "The channels that are enabled for the layer set. Must be a list of component channels.", "access": "read/write" }, { "name": "layerSets", "type": "LayerSets", "description": "The layer sets contained within the layer set.", "access": "readonly" }, { "name": "layers", "type": "Layers", "description": "The layers in this layer set.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "LayerSet", "description": "Adds an element.", "parameters": [] }, { "name": "merge", "returns": "ArtLayer", "description": "Merges the layer set.", "parameters": [] } ] }, { "name": "LayerSets", "kind": "Collection", "description": "The collection of layer set objects in the document.", "elementType": "LayerSet", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "LayerSet", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "LayerSet", "description": "Adds an element.", "parameters": [] }, { "name": "getByName", "returns": "LayerSet", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Layers", "kind": "Collection", "description": "The collection of layer objects, including art layer and layer set objects, in the document.", "elementType": "Layer", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "Layer", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "getByName", "returns": "Layer", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "LensType", "kind": "Enumeration", "description": "The type of lens.", "properties": [ { "name": "MOVIEPRIME", "type": "number", "description": "Movie Prime.", "access": "readonly", "value": "5" }, { "name": "PRIME105", "type": "number", "description": "105mm Prime.", "access": "readonly", "value": "3" }, { "name": "PRIME35", "type": "number", "description": "35mm Prime.", "access": "readonly", "value": "2" }, { "name": "ZOOMLENS", "type": "number", "description": "50-300mm Zoom.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "MacExtensionType", "kind": "Enumeration", "description": "The formatting for the filename extension.", "properties": [ { "name": "LOWERCASE", "type": "number", "description": "The extension is in lowercase letters.", "access": "readonly", "value": "2" }, { "name": "NONE", "type": "number", "description": "Does not use an extension.", "access": "readonly", "value": "1" }, { "name": "UPPERCASE", "type": "number", "description": "The extension is in uppercase letters.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "MacPreviewType", "kind": "Enumeration", "description": "The type of image to use as a low-resolution preview in the destination application.", "properties": [ { "name": "EIGHTBITTIFF", "type": "number", "description": "8-bit TIFF.", "access": "readonly", "value": "3" }, { "name": "MACOSEIGHTBIT", "type": "number", "description": "8-bit.", "access": "readonly", "value": "5" }, { "name": "MACOSJPEG", "type": "number", "description": "JPEG.", "access": "readonly", "value": "6" }, { "name": "MACOSMONOCHROME", "type": "number", "description": "Monochrome.", "access": "readonly", "value": "4" }, { "name": "MONOCHROMETIFF", "type": "number", "description": "Monochrome TIFF.", "access": "readonly", "value": "2" }, { "name": "NONE", "type": "number", "description": "Does not use a preview.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "MagnificationType", "kind": "Enumeration", "description": "The PDF magnification type.", "properties": [ { "name": "ACTUALSIZE", "type": "number", "description": "Displays the image at actual size.", "access": "readonly", "value": "0" }, { "name": "FITPAGE", "type": "number", "description": "Fits the image to the page.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "MatteType", "kind": "Enumeration", "description": "The color to use for matting.", "properties": [ { "name": "BACKGROUND", "type": "number", "description": "The current background color.", "access": "readonly", "value": "3" }, { "name": "BLACK", "type": "number", "description": "Black.", "access": "readonly", "value": "5" }, { "name": "FOREGROUND", "type": "number", "description": "The current foreground color.", "access": "readonly", "value": "2" }, { "name": "NETSCAPE", "type": "number", "description": "Gray.", "access": "readonly", "value": "7" }, { "name": "NONE", "type": "number", "description": "None.", "access": "readonly", "value": "1" }, { "name": "SEMIGRAY", "type": "number", "description": "50% gray.", "access": "readonly", "value": "6" }, { "name": "WHITE", "type": "number", "description": "White.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "MeasurementLog", "kind": "Object", "description": "The log of measurements taken.", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "deleteMeasurements", "returns": "void", "description": "Deletes the specified measurements.", "parameters": [ { "name": "range", "type": "MeasurementRange", "description": "The measurements to delete. Default: selected.", "optional": true } ] }, { "name": "exportMeasurements", "returns": "void", "description": "Exports the specified measurements.", "parameters": [ { "name": "file", "type": "File", "description": "The file to export to. If not specified, a 'file save' dialog is displayed.", "optional": true }, { "name": "range", "type": "MeasurementRange", "description": "The measurements to export. Default: selected.", "optional": true }, { "name": "dataPoints", "type": "string[]", "description": "An array of identifiers of data points to export. The order of the data points is respected in the exported file. Defaults to data points visible in Measurement Log palette.", "optional": true } ] } ] }, { "name": "MeasurementRange", "kind": "Enumeration", "description": "The measurement upon which to take action.", "properties": [ { "name": "ACTIVEMEASUREMENTS", "type": "number", "description": "Only active measurements.", "access": "readonly", "value": "2" }, { "name": "ALLMEASUREMENTS", "type": "number", "description": "All measurements.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "MeasurementScale", "kind": "Object", "description": "The measurement scale for the document.", "properties": [ { "name": "logicalLength", "type": "number", "description": "The logical length this scale equates to.", "access": "read/write" }, { "name": "logicalUnits", "type": "string", "description": "The logical units for this scale.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The name of the scale.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pixelLength", "type": "number", "description": "The length (in pixels) to which this scale equates.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "MeasurementSource", "kind": "Enumeration", "description": "The source for recording measurements.", "properties": [ { "name": "MEASURECOUNTTOOL", "type": "number", "description": "The measure count tool.", "access": "readonly", "value": "2" }, { "name": "MEASURERULERTOOL", "type": "number", "description": "The measure ruler tool.", "access": "readonly", "value": "3" }, { "name": "MEASURESELECTION", "type": "number", "description": "The measure selection.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "NewDocumentMode", "kind": "Enumeration", "description": "The color profile to use.", "properties": [ { "name": "BITMAP", "type": "number", "description": "Bitmap.", "access": "readonly", "value": "5" }, { "name": "CMYK", "type": "number", "description": "CMYK.", "access": "readonly", "value": "3" }, { "name": "GRAYSCALE", "type": "number", "description": "Grayscale.", "access": "readonly", "value": "1" }, { "name": "LAB", "type": "number", "description": "Lab.", "access": "readonly", "value": "4" }, { "name": "RGB", "type": "number", "description": "RGB.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "NoColor", "kind": "Object", "description": "Represents a missing color.", "extends": "Color", "properties": [], "events": [], "methods": [] }, { "name": "NoiseDistribution", "kind": "Enumeration", "description": "The distribution method to use when applying an Add Noise filter.", "properties": [ { "name": "GAUSSIAN", "type": "number", "description": "Distributes color values of noise along a bell-shaped curve, creating a speckled effect.", "access": "readonly", "value": "2" }, { "name": "UNIFORM", "type": "number", "description": "Distributes color values of noise using random numbers between 0 and plus or minus the specified value, creating a subtle effect.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Notifier", "kind": "Object", "description": "An event-handler object that tells the script to execute specified code when a specified event occurs. For notifiers to work, they must be enabled. See the 'notifiers enabled' property of the Application object. Events that occur within scripts do not generally trigger notifiers, because they occur inside of a \"play script\" event.", "properties": [ { "name": "event", "type": "string", "description": "The event ID in four characters or a unique string that the notifier is associated with.", "access": "readonly" }, { "name": "eventClass", "type": "string", "description": "The class ID associated with the event for the Notifier object, four characters or a unique string.", "access": "readonly" }, { "name": "eventFile", "type": "File", "description": "The path to the file to execute when the event occurs/activates the notifier.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Notifiers", "kind": "Collection", "description": "A collection of notifier objects in the document.", "elementType": "Notifier", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "Notifier", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "Notifier", "description": "Creates a notifier.", "parameters": [ { "name": "event", "type": "string", "description": "The class id of the event, four characters or a unique string." }, { "name": "eventFile", "type": "File", "description": "The script file to execute when the event occurs." }, { "name": "eventClass", "type": "string", "description": "The class of the object the event is applied to, four characters or a unique string. When an event applies to multiple types of objects, you use the event class parameter to distinguish which object this Notifier applies to. For example, the Make event (“Mk“) applies to documents (“Dcmn”), channels (“Chnl”) and other objects.", "optional": true } ] }, { "name": "getByName", "returns": "Notifier", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "OffsetUndefinedAreas", "kind": "Enumeration", "description": "The method to use to fill the empty space left by offsetting a an image or selection.", "properties": [ { "name": "REPEATEDGEPIXELS", "type": "number", "description": "Extends the colors of pixels along the edge of the image in the direction specified. Banding may result if the edge pixels are different colors.", "access": "readonly", "value": "3" }, { "name": "SETTOBACKGROUND", "type": "number", "description": "For background layers, sets pixels to the background layer color. For nonbackground layers, sets the pixels to transparent.", "access": "readonly", "value": "1" }, { "name": "WRAPAROUND", "type": "number", "description": "Fills the undefined space with content from the opposite edge of the image.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "OpenDocumentMode", "kind": "Enumeration", "description": "The color profile to use.", "properties": [ { "name": "CMYK", "type": "number", "description": "CMYK.", "access": "readonly", "value": "3" }, { "name": "GRAYSCALE", "type": "number", "description": "Grayscale.", "access": "readonly", "value": "1" }, { "name": "LAB", "type": "number", "description": "Lab.", "access": "readonly", "value": "4" }, { "name": "RGB", "type": "number", "description": "RGB.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "OpenDocumentType", "kind": "Enumeration", "description": "Document formats that Photoshop can open.", "properties": [ { "name": "ALIASPIX", "type": "number", "description": "Alias PIX format.", "access": "readonly", "value": "25" }, { "name": "BMP", "type": "number", "description": "BMP format.", "access": "readonly", "value": "2" }, { "name": "CAMERARAW", "type": "number", "description": "Camera RAW format.", "access": "readonly", "value": "32" }, { "name": "COMPUSERVEGIF", "type": "number", "description": "CompuServe GIF format.", "access": "readonly", "value": "3" }, { "name": "DICOM", "type": "number", "description": "DICOM format.", "access": "readonly", "value": "33" }, { "name": "ELECTRICIMAGE", "type": "number", "description": "Electric format.", "access": "readonly", "value": "26" }, { "name": "EPS", "type": "number", "description": "Generic EPS format.", "access": "readonly", "value": "22" }, { "name": "EPSPICTPREVIEW", "type": "number", "description": "EPS format with embedded PICT Preview.", "access": "readonly", "value": "23" }, { "name": "EPSTIFFPREVIEW", "type": "number", "description": "EPS format with embedded TIFF Preview.", "access": "readonly", "value": "24" }, { "name": "FILMSTRIP", "type": "number", "description": "Filmstrip format.", "access": "readonly", "value": "5" }, { "name": "JPEG", "type": "number", "description": "JPEG format.", "access": "readonly", "value": "6" }, { "name": "PCX", "type": "number", "description": "PCX format.", "access": "readonly", "value": "7" }, { "name": "PDF", "type": "number", "description": "Generic PDF format.", "access": "readonly", "value": "21" }, { "name": "PHOTOCD", "type": "number", "description": "Photo CD format.", "access": "readonly", "value": "9" }, { "name": "PHOTOSHOP", "type": "number", "description": "Photoshop format.", "access": "readonly", "value": "1" }, { "name": "PHOTOSHOPDCS_1", "type": "number", "description": "Photoshop DCS 1.0 format.", "access": "readonly", "value": "18" }, { "name": "PHOTOSHOPDCS_2", "type": "number", "description": "Photoshop DCS 2.0 format.", "access": "readonly", "value": "19" }, { "name": "PHOTOSHOPEPS", "type": "number", "description": "EPS document produced by Photoshop.", "access": "readonly", "value": "4" }, { "name": "PHOTOSHOPPDF", "type": "number", "description": "PDF document produced by Photoshop.", "access": "readonly", "value": "8" }, { "name": "PICTFILEFORMAT", "type": "number", "description": "PICT file format.", "access": "readonly", "value": "10" }, { "name": "PICTRESOURCEFORMAT", "type": "number", "description": "PICT resource format.", "access": "readonly", "value": "11" }, { "name": "PIXAR", "type": "number", "description": "Pixar format.", "access": "readonly", "value": "12" }, { "name": "PNG", "type": "number", "description": "PNG format.", "access": "readonly", "value": "13" }, { "name": "PORTABLEBITMAP", "type": "number", "description": "Portable Bitmap format.", "access": "readonly", "value": "27" }, { "name": "RAW", "type": "number", "description": "Raw format.", "access": "readonly", "value": "14" }, { "name": "SCITEXCT", "type": "number", "description": "Scitex CT format.", "access": "readonly", "value": "15" }, { "name": "SGIRGB", "type": "number", "description": "SGI RGB format.", "access": "readonly", "value": "29" }, { "name": "SOFTIMAGE", "type": "number", "description": "SoftImage format.", "access": "readonly", "value": "30" }, { "name": "TARGA", "type": "number", "description": "Targa format.", "access": "readonly", "value": "16" }, { "name": "TIFF", "type": "number", "description": "TIFF format.", "access": "readonly", "value": "17" }, { "name": "WAVEFRONTRLA", "type": "number", "description": "Wavefront RLA format.", "access": "readonly", "value": "28" }, { "name": "WIRELESSBITMAP", "type": "number", "description": "Wireless Bitmap format (WBMP)", "access": "readonly", "value": "31" } ], "events": [], "methods": [] }, { "name": "OpenOptions", "kind": "Object", "description": "Options that can be specified when opening a document.", "properties": [], "events": [], "methods": [] }, { "name": "OperatingSystem", "kind": "Enumeration", "description": "The operating system.", "properties": [ { "name": "OS2", "type": "number", "description": "Mac OS/2 operating system.", "access": "readonly", "value": "1" }, { "name": "WINDOWS", "type": "number", "description": "Windows operating system.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Orientation", "kind": "Enumeration", "description": "The image orientation on the media.", "properties": [ { "name": "LANDSCAPE", "type": "number", "description": "Landscape.", "access": "readonly", "value": "1" }, { "name": "PORTRAIT", "type": "number", "description": "Portrait.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "OtherPaintingCursors", "kind": "Enumeration", "description": "The pointer for the following tools: Eraser, Pencil, Paintbrush, Healing Brush, Rubber Stamp, Pattern Stamp, Smudge, Blur, Sharpen, Dodge, Burn, Sponge.", "properties": [ { "name": "PRECISEOTHER", "type": "number", "description": "Displays pointers as cross hairs.", "access": "readonly", "value": "2" }, { "name": "STANDARDOTHER", "type": "number", "description": "Displays pointers as tool icons.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PDFCompatibilityType", "kind": "Enumeration", "description": "The PDF version with which to make the document compatible.", "properties": [ { "name": "PDF13", "type": "number", "description": "PDF 1.3 (Acrobat 4 or higher).", "access": "readonly", "value": "1" }, { "name": "PDF14", "type": "number", "description": "PDF 1.4 (Acrobat 5 or higher).", "access": "readonly", "value": "2" }, { "name": "PDF15", "type": "number", "description": "PDF 1.5 (Acrobat 6 or higher).", "access": "readonly", "value": "3" }, { "name": "PDF16", "type": "number", "description": "PDF 1.6 (Acrobat 7 or higher)", "access": "readonly", "value": "4" }, { "name": "PDF17", "type": "number", "description": "PDF 1.7 (Acrobat 9 or higher)", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "PDFEncodingType", "kind": "Enumeration", "description": "The type of compression to use when saving a document in PDF format.", "properties": [ { "name": "JPEG", "type": "number", "description": "JPEG compression.", "access": "readonly", "value": "2" }, { "name": "JPEG2000HIGH", "type": "number", "description": "JPEG2000 compression with high image quality.", "access": "readonly", "value": "9" }, { "name": "JPEG2000LOSSLESS", "type": "number", "description": "JPEG2000 lossless compression.", "access": "readonly", "value": "14" }, { "name": "JPEG2000LOW", "type": "number", "description": "JPEG2000 compression with low image quality.", "access": "readonly", "value": "13" }, { "name": "JPEG2000MED", "type": "number", "description": "JPEG2000 compression with medium image quality.", "access": "readonly", "value": "11" }, { "name": "JPEG2000MEDHIGH", "type": "number", "description": "JPEG2000 compression with medium high image quality.", "access": "readonly", "value": "10" }, { "name": "JPEG2000MEDLOW", "type": "number", "description": "JPEG2000 compression with medium low image quality.", "access": "readonly", "value": "12" }, { "name": "JPEGHIGH", "type": "number", "description": "JPEG compression with high image quality.", "access": "readonly", "value": "4" }, { "name": "JPEGLOW", "type": "number", "description": "JPEG compression with low image quality.", "access": "readonly", "value": "8" }, { "name": "JPEGMED", "type": "number", "description": "JPEG compression with medium image quality.", "access": "readonly", "value": "6" }, { "name": "JPEGMEDHIGH", "type": "number", "description": "JPEG compression with medium high image quality.", "access": "readonly", "value": "5" }, { "name": "JPEGMEDLOW", "type": "number", "description": "JPEG compression with medium low image quality.", "access": "readonly", "value": "7" }, { "name": "NONE", "type": "number", "description": "No encoding.", "access": "readonly", "value": "0" }, { "name": "PDFZIP", "type": "number", "description": "Zip compression.", "access": "readonly", "value": "1" }, { "name": "PDFZIP4BIT", "type": "number", "description": "Zip compression with 4-bit image quality.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "PDFResampleType", "kind": "Enumeration", "description": "Downsampling options when saving as PDF.", "properties": [ { "name": "NONE", "type": "number", "description": "Does not downsample.", "access": "readonly", "value": "0" }, { "name": "PDFAVERAGE", "type": "number", "description": "Averages the pixels in a sample area and replaces the entire area with the average pixel color at the specified resolution.", "access": "readonly", "value": "1" }, { "name": "PDFBICUBIC", "type": "number", "description": "Uses a weighted average to determine pixel color, which usually yields better results than the simple averaging method of downsampling. The slowest but most precise method, resulting in the smoothest gradations.", "access": "readonly", "value": "3" }, { "name": "PDFSUBSAMPLE", "type": "number", "description": "Chooses a pixel in the center of the sample area and replaces the entire area with that pixel color; significantly reduces conversion time but results in images that are less smooth and continuous.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PDFSaveOptions", "kind": "Object", "description": "Options for saving a document in PDF format.", "extends": "SaveOptions", "properties": [ { "name": "PDFCompatibility", "type": "PDFCompatibilityType", "description": "The PDF version to make the document compatible with.", "access": "read/write", "static": true }, { "name": "PDFStandard", "type": "PDFStandardType", "description": "The PDF standard to make the document compatible with.", "access": "read/write", "static": true }, { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "annotations", "type": "boolean", "description": "If true, the annotations are saved.", "access": "read/write", "static": true }, { "name": "colorConversion", "type": "boolean", "description": "If true, converts the color profile to the destination profile.", "access": "read/write", "static": true }, { "name": "convertToEightBit", "type": "boolean", "description": "If true, converts a 16-bit image to 8-bit for better compatibility with other applications.", "access": "read/write", "static": true }, { "name": "description", "type": "string", "description": "Description of the save options in use.", "access": "read/write", "static": true }, { "name": "destinationProfile", "type": "string", "description": "Describes the final RGB or CMYK output device, such as a monitor or press standard.", "access": "read/write", "static": true }, { "name": "downSample", "type": "PDFResampleType", "description": "The downsample method to use.", "access": "read/write", "static": true }, { "name": "downSampleSize", "type": "number", "description": "The size (in pixels per inch) to downsample images to if they exceed the value specified for 'down sample size limit'.", "access": "read/write", "static": true }, { "name": "downSampleSizeLimit", "type": "number", "description": "Limits downsampling or subsampling to images that exceed this value (in pixels per inch).", "access": "read/write", "static": true }, { "name": "downgradeColorProfile", "type": "boolean", "description": "DEPRECATED, ( should the embedded color profile be downgraded to version 2 )", "access": "read/write", "static": true }, { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "embedFonts", "type": "boolean", "description": "DEPRECATED. ( embed fonts? Only valid if a text layer is included )", "access": "read/write", "static": true }, { "name": "embedThumbnail", "type": "boolean", "description": "If true, includes a small preview image in Acrobat.", "access": "read/write", "static": true }, { "name": "encoding", "type": "PDFEncodingType", "description": "The encoding method to use.", "access": "read/write", "static": true }, { "name": "interpolation", "type": "boolean", "description": "DEPRECATED. ( use image interpolation? )", "access": "read/write", "static": true }, { "name": "jpegQuality", "type": "number", "description": "The quality of the produced image. Valid only for JPEG-encoded PDF documents. Range: 0 to 12.", "access": "read/write", "static": true, "range": { "min": "0", "max": "12" } }, { "name": "layers", "type": "boolean", "description": "If true, the layers are saved.", "access": "read/write", "static": true }, { "name": "optimizeForWeb", "type": "boolean", "description": "If true, improves performance of PDFs on Web servers.", "access": "read/write", "static": true }, { "name": "outputCondition", "type": "string", "description": "An optional comment field for inserting descriptions of the output condition. The text is stored in the PDF/X file.", "access": "read/write", "static": true }, { "name": "outputConditionID", "type": "string", "description": "The identifier for the output condition.", "access": "read/write", "static": true }, { "name": "preserveEditing", "type": "boolean", "description": "If true, allows users to reopen the PDF in Photoshop with native Photoshop data intact.", "access": "read/write", "static": true }, { "name": "presetFile", "type": "string", "description": "The preset file to use for settings; overrides other settings.", "access": "read/write", "static": true }, { "name": "profileInclusionPolicy", "type": "boolean", "description": "If true, shows which profiles to include.", "access": "read/write", "static": true }, { "name": "registryName", "type": "string", "description": "The URL where the output condition is registered.", "access": "read/write", "static": true }, { "name": "spotColors", "type": "boolean", "description": "If true, the spot colors are saved.", "access": "read/write", "static": true }, { "name": "tileSize", "type": "number", "description": "The compression option. Valid only when encoding is JPEG2000.", "access": "read/write", "static": true }, { "name": "transparency", "type": "boolean", "description": "DEPRECATED.", "access": "read/write", "static": true }, { "name": "useOutlines", "type": "boolean", "description": "DEPRECATED. ( use outlines for text? Only valid if vector data is included )", "access": "read/write", "static": true }, { "name": "vectorData", "type": "boolean", "description": "DEPRECATED. ( include vector data )", "access": "read/write", "static": true }, { "name": "view", "type": "boolean", "description": "If true, opens the saved PDF in Acrobat.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PDFStandardType", "kind": "Enumeration", "description": "The PDF/X standard with which the document complies.", "properties": [ { "name": "NONE", "type": "number", "description": "The document does not use the PDF/X standard.", "access": "readonly", "value": "0" }, { "name": "PDFX1A2001", "type": "number", "description": "PDF/X-1a standard, which requires all fonts to be embedded, the appropriate PDF bounding boxes to be specified, and color to appear as CMYK, spot colors, or both; can be opened in Acrobat 4.0 and Acrobat Reader 4.0 and later.", "access": "readonly", "value": "1" }, { "name": "PDFX1A2003", "type": "number", "description": "PDF/X-1a standard, which requires all fonts to be embedded, the appropriate PDF bounding boxes to be specified, and color to appear as CMYK, spot colors, or both; can be opened in Acrobat 4.0 and Acrobat Reader 4.0 and later.", "access": "readonly", "value": "2" }, { "name": "PDFX32002", "type": "number", "description": "PDF/X-3 standard, which requires all fonts to be embedded and the appropriate PDF bounding boxes to be specified, and for color allows either the use of color management and device-independent color (CIE L*a*b, ICC-based color spaces, CalRGB, and CalGray) or CMYK, spot colors, or both; can be opened in Acrobat 4.0 and Acrobat Reader 4.0 and later.", "access": "readonly", "value": "3" }, { "name": "PDFX32003", "type": "number", "description": "PDF/X-3 standard, which requires all fonts to be embedded and the appropriate PDF bounding boxes to be specified, and for color allows either the use of color management and device-independent color (CIE L*a*b, ICC-based color spaces, CalRGB, and CalGray) or CMYK, spot colors, or both; can be opened in Acrobat 4.0 and Acrobat Reader 4.0 and later.", "access": "readonly", "value": "4" }, { "name": "PDFX42008", "type": "number", "description": "PDF/X-4 standard, which requires all fonts to be embedded and the appropriate PDF bounding boxes to be specified, and for color allows either the use of color management and device-independent color (CIE L*a*b, ICC-based color spaces, CalRGB, and CalGray) or CMYK, spot colors, or both; can be opened in Acrobat 8.0 and Acrobat Reader 8.0 and later.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "PICTBitsPerPixels", "kind": "Enumeration", "description": "The number of bits per pixel to use when compressing a PICT file.", "properties": [ { "name": "EIGHT", "type": "number", "description": "8 bits per pixel.", "access": "readonly", "value": "8" }, { "name": "FOUR", "type": "number", "description": "4 bits per pixel.", "access": "readonly", "value": "4" }, { "name": "SIXTEEN", "type": "number", "description": "16 bits per pixel.", "access": "readonly", "value": "16" }, { "name": "THIRTYTWO", "type": "number", "description": "32 bits per pixel.", "access": "readonly", "value": "32" }, { "name": "TWO", "type": "number", "description": "2 bits per pixel.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PICTCompression", "kind": "Enumeration", "description": "The compression type to use whan saving as PICT.", "properties": [ { "name": "JPEGHIGHPICT", "type": "number", "description": "High quality JPEG encoding.", "access": "readonly", "value": "5" }, { "name": "JPEGLOWPICT", "type": "number", "description": "Low quality JPEG encoding (high amount of compression).", "access": "readonly", "value": "2" }, { "name": "JPEGMAXIMUMPICT", "type": "number", "description": "Maximum quality JPEG encoding (very little compression).", "access": "readonly", "value": "6" }, { "name": "JPEGMEDIUMPICT", "type": "number", "description": "Medium quality JPEG encoding (medium amount of compression).", "access": "readonly", "value": "4" }, { "name": "NONE", "type": "number", "description": "No compression.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PICTFileSaveOptions", "kind": "Object", "description": "Options for saving a document in PICT format.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "compression", "type": "PICTCompression", "description": "The compression method.", "access": "read/write", "static": true, "value": "PICTCompression.NONE" }, { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "resolution", "type": "PICTBitsPerPixels", "description": "The number of bits per pixel.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PICTResourceSaveOptions", "kind": "Object", "description": "Options for saving a document as a PICT resource file.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "compression", "type": "PICTCompression", "description": "The compression type.", "access": "read/write", "static": true, "value": "PICTCompression.NONE" }, { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "name", "type": "string", "description": "The name of PICT resource.", "access": "read/write", "static": true, "value": "\"\"" }, { "name": "resolution", "type": "PICTBitsPerPixels", "description": "The number of bits per pixel.", "access": "read/write", "static": true }, { "name": "resourceID", "type": "number", "description": "The ID of the PICT resource.", "access": "read/write", "static": true, "value": "128" } ], "events": [], "methods": [] }, { "name": "PNGSaveOptions", "kind": "Object", "description": "Options for saving a document in PNG format.", "extends": "SaveOptions", "properties": [ { "name": "compression", "type": "number", "description": "Compression used on the image.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "9" } }, { "name": "interlaced", "type": "boolean", "description": "If true, rows are interlaced.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "PaintingCursors", "kind": "Enumeration", "description": "The pointer for the following tools: Marquee, Lasso, Polygonal Lasso, Magic Wand, Crop, Slice, Patch Eyedropper, Pen, Gradient, Line, Paint Bucket, Magnetic Lasso, Magnetic Pen, Freeform Pen, Measure, and Color Sampler.", "properties": [ { "name": "BRUSHSIZE", "type": "number", "description": "Displays cursors as brush shapes representing the size of the current brush. Valid only for painting cursors.", "access": "readonly", "value": "3" }, { "name": "PRECISE", "type": "number", "description": "Displays pointers as cross hairs.", "access": "readonly", "value": "2" }, { "name": "STANDARD", "type": "number", "description": "Displays pointers as tool icons.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PaletteType", "kind": "Enumeration", "description": "The palette type for converting an image to indexed color.", "properties": [ { "name": "EXACT", "type": "number", "description": "The palette uses the exact colors appearing in the RGB image; available only if the image uses 256 or fewer colors.", "access": "readonly", "value": "1" }, { "name": "LOCALADAPTIVE", "type": "number", "description": "Creates a palette by sampling the colors from the spectrum appearing most commonly in the image.", "access": "readonly", "value": "8" }, { "name": "LOCALPERCEPTUAL", "type": "number", "description": "Creates a custom palette by giving priority to colors for in the image which the human eye has greater sensitivity.", "access": "readonly", "value": "6" }, { "name": "LOCALSELECTIVE", "type": "number", "description": "Creates a color table similar to the Perceptual color table, but favoring broad areas of color in the image and the preservation of web colors.", "access": "readonly", "value": "7" }, { "name": "MACOSPALETTE", "type": "number", "description": "The Mac OS default 8-bit palette, whch is based on a uniform sampling of RGB colors.", "access": "readonly", "value": "2" }, { "name": "MASTERADAPTIVE", "type": "number", "description": "Creates a palette by sampling the colors from the spectrum appearing most commonly in a group of open images that share the same color palette.", "access": "readonly", "value": "11" }, { "name": "MASTERPERCEPTUAL", "type": "number", "description": "Creates a custom palette by giving priority to colors in a group of open images with the same color palette for which the human eye has greater sensitivity.", "access": "readonly", "value": "9" }, { "name": "MASTERSELECTIVE", "type": "number", "description": "Creates a color table similar to the Master Perceptual color table, but favoring broad areas of color and the preservation of web colors.", "access": "readonly", "value": "10" }, { "name": "PREVIOUSPALETTE", "type": "number", "description": "Uses the custom palette from the previous conversion, making it easy to convert several images with the same custom palette.", "access": "readonly", "value": "12" }, { "name": "UNIFORM", "type": "number", "description": "Creates a palette by uniformly sampling colors from the RGB color cube.", "access": "readonly", "value": "5" }, { "name": "WEBPALETTE", "type": "number", "description": "The 216-color palette that web browsers, regardless of platform, use to display images on a monitor limited to 256 colors.", "access": "readonly", "value": "4" }, { "name": "WINDOWSPALETTE", "type": "number", "description": "The Windows system's default 8-bit palette, whch is based on a uniform sampling of RGB colors.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "PathItem", "kind": "Object", "description": "A path or drawing object, such as the outline of a shape or a straight or curved line, which contains sub paths that comprise its geometry.", "properties": [ { "name": "kind", "type": "PathKind", "description": "The type of path.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The name of the path item.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "subPathItems", "type": "SubPathItems", "description": "The sub path objects for this path item.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "PathItem", "description": "Adds an element.", "parameters": [] }, { "name": "deselect", "returns": "void", "description": "Unselects the selection, no path items are selected.", "parameters": [] }, { "name": "duplicate", "returns": "PathItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "duplicate", "returns": "PathItem", "description": "Duplicates this path item.", "parameters": [ { "name": "name", "type": "string", "description": "The name for the new path.", "optional": true } ] }, { "name": "fillPath", "returns": "void", "description": "Fills the area enclosed by the path.", "parameters": [ { "name": "fillColor", "type": "any", "description": "The color of the fill for this path.", "optional": true }, { "name": "mode", "type": "ColorBlendMode", "description": "The blending mode of the fill for this path.", "optional": true }, { "name": "opacity", "type": "number", "description": "The opacity of the fill for this path (as a percentage). Range: 0.0 to 100.0.", "optional": true }, { "name": "preserveTransparency", "type": "boolean", "description": "If true, transparency is preserved.", "optional": true }, { "name": "feather", "type": "number", "description": "The feather amount in pixels. Range: 0.0 to 250.0.", "optional": true }, { "name": "antiAlias", "type": "boolean", "description": "If true, uses anti-aliasing for the selection.", "optional": true }, { "name": "wholePath", "type": "boolean", "description": "If true, uses all subpaths when doing the fill.", "optional": true } ] }, { "name": "makeClippingPath", "returns": "void", "description": "Makes this path item the clipping path for this document.", "parameters": [ { "name": "flatness", "type": "number", "description": "Flatness in device pixels; tells the PostScript printer how to approximate curves. Range: 0.2 to 100).", "optional": true } ] }, { "name": "makeSelection", "returns": "void", "description": "Makes a selection object, whose border is the path, from this path item object.", "parameters": [ { "name": "feather", "type": "number", "description": "The feather amount in pixels. Range: 0.0 to 250.0.", "optional": true }, { "name": "antiAlias", "type": "boolean", "description": "If true, the selection uses anti-aliasing.", "optional": true }, { "name": "operation", "type": "SelectionType", "description": "The selection behavior relative to the existing selection (when a selection already exists).", "optional": true } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "select", "returns": "void", "description": "Makes this path item the active or selected path item.", "parameters": [] }, { "name": "strokePath", "returns": "void", "description": "Strokes the path.", "parameters": [ { "name": "tool", "type": "ToolType", "description": "The tool to use when stroking the path.", "optional": true }, { "name": "simulatePressure", "type": "boolean", "description": "If true, simulates the pressure when using the tool.", "optional": true } ] } ] }, { "name": "PathItems", "kind": "Collection", "description": "The collection of path item objects in the document.", "elementType": "PathItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "PathItem", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "add", "returns": "PathItem", "description": "Creates a new path item.", "parameters": [ { "name": "name", "type": "string", "description": "The name for the new path." }, { "name": "entirePath", "type": "SubPathInfo[]", "description": "The item's sub paths." } ] }, { "name": "getByName", "returns": "PathItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "PathKind", "kind": "Enumeration", "description": "The type of path.", "properties": [ { "name": "CLIPPINGPATH", "type": "number", "description": "Clipping path.", "access": "readonly", "value": "2" }, { "name": "NORMALPATH", "type": "number", "description": "Normal path.", "access": "readonly", "value": "1" }, { "name": "TEXTMASK", "type": "number", "description": "Text mask path.", "access": "readonly", "value": "5" }, { "name": "VECTORMASK", "type": "number", "description": "Vector mask path.", "access": "readonly", "value": "4" }, { "name": "WORKPATH", "type": "number", "description": "Workpath.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "PathPoint", "kind": "Object", "description": "Information about an array of path point info objects. You do not use the path point object to create points that make up a path. Rather, you use the path point object to retrieve information about the points that describe path segments. To create path points, use the path point info object.", "properties": [ { "name": "anchor", "type": "Point", "description": "The position (coordinates) of the anchor point.", "access": "readonly" }, { "name": "kind", "type": "PointKind", "description": "The type of point.", "access": "readonly" }, { "name": "leftDirection", "type": "Point", "description": "The location of the left direction point (the \"in\" position).", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "rightDirection", "type": "Point", "description": "The location of the right direction point (the \"out\" position).", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "PathPointInfo", "kind": "Object", "description": "A point on a path, expressed as an array of three coordinate arrays: the anchor point, left direction point, and right direction point. For paths that are straight segments (not curved), the coordinates of all three points are the same. For curved segements, the coordinates are different. The difference between the anchor point and the left or right direction points determines the arc of the curve. You use the left direction point to bend the curve \"outward\" or make it convex; you use the right direction point to bend the curve \"inward\" or make it concave.", "properties": [ { "name": "anchor", "type": "Point[]", "description": "The x and y coordinates of one end point of the path segment.", "access": "read/write", "static": true }, { "name": "anchor", "type": "Point[]", "description": "The x and y coordinates of one end point of the path segment.", "access": "read/write" }, { "name": "kind", "type": "PointKind", "description": "The point type.", "access": "read/write", "static": true }, { "name": "kind", "type": "PointKind", "description": "The point type.", "access": "read/write" }, { "name": "leftDirection", "type": "Point[]", "description": "The location of the left direction point (\"in\" position).", "access": "read/write", "static": true }, { "name": "leftDirection", "type": "Point[]", "description": "The location of the left direction point (\"in\" position).", "access": "read/write" }, { "name": "rightDirection", "type": "Point[]", "description": "The location of the right direction point (\"out\" position).", "access": "read/write", "static": true }, { "name": "rightDirection", "type": "Point[]", "description": "The location of the right direction point (\"out\" position).", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "PathPoints", "kind": "Collection", "description": "A collection of path point objects that comprises the path points property of the sub path item object.", "elementType": "PathPoint", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "PathPoint", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "getByName", "returns": "PathPoint", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "PhotoCDColorSpace", "kind": "Enumeration", "description": "Deprecated.", "properties": [ { "name": "LAB16", "type": "number", "description": "Lab with 16 bits per channel.", "access": "readonly", "value": "4" }, { "name": "LAB8", "type": "number", "description": "Lab with 8 bits per channel.", "access": "readonly", "value": "3" }, { "name": "RGB16", "type": "number", "description": "RGB with 16 bits per channel.", "access": "readonly", "value": "2" }, { "name": "RGB8", "type": "number", "description": "RGB with 8 bits per channel.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PhotoCDOpenOptions", "kind": "Object", "description": "DEPRECATED.", "extends": "OpenOptions", "properties": [ { "name": "colorProfileName", "type": "string", "description": "The profile to use when reading the image.", "access": "read/write", "static": true }, { "name": "colorSpace", "type": "PhotoCDColorSpace", "description": "The color space for the image.", "access": "read/write", "static": true }, { "name": "orientation", "type": "Orientation", "description": "The image orientation.", "access": "read/write", "static": true }, { "name": "pixelSize", "type": "PhotoCDSize", "description": "The dimensions of the image.", "access": "read/write", "static": true }, { "name": "resolution", "type": "number", "description": "The resolution of the image (in pixels per inch)", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PhotoCDSize", "kind": "Enumeration", "description": "The pixel dimensions of the image.", "properties": [ { "name": "EXTRALARGE", "type": "number", "description": "1024x1536 image.", "access": "readonly", "value": "5" }, { "name": "LARGE", "type": "number", "description": "512x768 image.", "access": "readonly", "value": "4" }, { "name": "MAXIMUM", "type": "number", "description": "2048x3072 image.", "access": "readonly", "value": "6" }, { "name": "MEDIUM", "type": "number", "description": "256x384 image.", "access": "readonly", "value": "3" }, { "name": "MINIMUM", "type": "number", "description": "64x96 image.", "access": "readonly", "value": "1" }, { "name": "SMALL", "type": "number", "description": "128x192 image.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PhotoshopSaveOptions", "kind": "Object", "description": "Options for saving a Photoshop document.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "annotations", "type": "boolean", "description": "If true, the annotations are saved.", "access": "read/write", "static": true }, { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "layers", "type": "boolean", "description": "If true, the layers are saved.", "access": "read/write", "static": true }, { "name": "spotColors", "type": "boolean", "description": "If true, spot colors are saved.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PicturePackageOptions", "kind": "Object", "description": "Options that can be specified for a Picture Package.", "properties": [ { "name": "content", "type": "PicturePackageTextType", "description": "The content information.", "access": "read/write", "static": true, "value": "PicturePackageTextType.NONE" }, { "name": "flatten", "type": "boolean", "description": "If true, flattens all layers in the final document.", "access": "read/write", "static": true, "value": "true" }, { "name": "font", "type": "GalleryFontType", "description": "The font used for security text.", "access": "read/write", "static": true, "value": "GalleryFontType.ARIAL" }, { "name": "fontSize", "type": "number", "description": "The font size.", "access": "read/write", "static": true, "value": "12" }, { "name": "layout", "type": "string", "description": "The layout to use to generate the picture package.", "access": "read/write", "static": true, "value": "(2)5x7" }, { "name": "mode", "type": "NewDocumentMode", "description": "The document color mode.", "access": "read/write", "static": true, "value": "NewDocumentMode.RGB" }, { "name": "opacity", "type": "number", "description": "The web page security text opacity (as a percentage) Range: 0 to 100.", "access": "read/write", "static": true, "value": "100", "range": { "min": "0", "max": "100" } }, { "name": "resolution", "type": "number", "description": "The resolution of the document (in pixels per inch)", "access": "read/write", "static": true, "value": "72.0" }, { "name": "text", "type": "string", "description": "The picture package custom text.", "access": "read/write", "static": true }, { "name": "textColor", "type": "RGBColor", "description": "The color of the security text.", "access": "read/write", "static": true }, { "name": "textPosition", "type": "GallerySecurityTextPositionType", "description": "The position of the security text.", "access": "read/write", "static": true, "value": "GallerySecurityTextPositionType.CENTERED" }, { "name": "textRotate", "type": "GallerySecurityTextRotateType", "description": "The orientation of the security text.", "access": "read/write", "static": true, "value": "GallerySecurityTextRotateType.ZERO" } ], "events": [], "methods": [] }, { "name": "PicturePackageTextType", "kind": "Enumeration", "description": "The function or meaning of text in a Picture Package.", "properties": [ { "name": "CAPTION", "type": "number", "description": "The text is a caption.", "access": "readonly", "value": "5" }, { "name": "COPYRIGHT", "type": "number", "description": "The text is the copyright.", "access": "readonly", "value": "4" }, { "name": "CREDIT", "type": "number", "description": "The text is the credit.", "access": "readonly", "value": "6" }, { "name": "FILENAME", "type": "number", "description": "The text is the filename.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "No text.", "access": "readonly", "value": "1" }, { "name": "ORIGIN", "type": "number", "description": "The text is the origin.", "access": "readonly", "value": "7" }, { "name": "USER", "type": "number", "description": "The text is user defined.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PixarSaveOptions", "kind": "Object", "description": "Options for saving a document in Pixar format.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "Point", "kind": "Collection", "description": "Describes a point. This class is also a two-element collection.", "properties": [ { "name": "left", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "length", "type": "number", "description": "The array length.", "access": "readonly", "value": "2" }, { "name": "top", "type": "number", "description": "The top coordinate.", "access": "read/write" }, { "name": "x", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "y", "type": "number", "description": "The top coordinate.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "PointKind", "kind": "Enumeration", "description": "The path point kind.", "properties": [ { "name": "CORNERPOINT", "type": "number", "description": "The point must be a corner.", "access": "readonly", "value": "2" }, { "name": "SMOOTHPOINT", "type": "number", "description": "The point can be a curve.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PointType", "kind": "Enumeration", "description": "The point type.", "properties": [ { "name": "POSTSCRIPT", "type": "number", "description": "72 points per inch.", "access": "readonly", "value": "1" }, { "name": "TRADITIONAL", "type": "number", "description": "72.27 points per inch.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PolarConversionType", "kind": "Enumeration", "description": "The method of polar distortion to use.", "properties": [ { "name": "POLARTORECTANGULAR", "type": "number", "description": "The selection is converted from its polar to rectangular coordinates.", "access": "readonly", "value": "2" }, { "name": "RECTANGULARTOPOLAR", "type": "number", "description": "The selection is converted from its rectangular to polar coordinates.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Preferences", "kind": "Object", "description": "Options to define for the preferences property of the application object, basically equivalent to selecting Edit > Preferences (Windows) or Photoshop > Preferences in the Adobe Photoshop application.", "properties": [ { "name": "additionalPluginFolder", "type": "File", "description": "The path to the additional plug-in folder. Valid only when 'use additional plugin folder' = true.", "access": "read/write" }, { "name": "appendExtension", "type": "SaveBehavior", "description": "Save files with extensions on Windows.", "access": "read/write" }, { "name": "askBeforeSavingLayeredTIFF", "type": "boolean", "description": "If true, asks the user to verify layer preservation options when saving a file in TIFF format.", "access": "read/write" }, { "name": "autoUpdateOpenDocuments", "type": "boolean", "description": "If true, automatically updates open documents.", "access": "read/write" }, { "name": "beepWhenDone", "type": "boolean", "description": "If true, alerts the user when a process finishes.", "access": "read/write" }, { "name": "colorChannelsInColor", "type": "boolean", "description": "If true, displays component channels in the Channels palette in color.", "access": "read/write" }, { "name": "colorPicker", "type": "ColorPicker", "description": "The color picker to use.", "access": "read/write" }, { "name": "columnGutter", "type": "number", "description": "The gutter of columns (in points)", "access": "read/write" }, { "name": "columnWidth", "type": "number", "description": "The width of columns (in points)", "access": "read/write" }, { "name": "createFirstSnapshot", "type": "boolean", "description": "If true, automatically makes the first snapshot when a new document is created.", "access": "read/write" }, { "name": "dynamicColorSliders", "type": "boolean", "description": "If true, dynamic color sliders appear in the Color palette.", "access": "read/write" }, { "name": "editLogItems", "type": "EditLogItemsType", "description": "Options for edit log items.", "access": "read/write" }, { "name": "exportClipboard", "type": "boolean", "description": "If true, retains Adobe Photoshop contents on the clipboard after you exit the application.", "access": "read/write" }, { "name": "fontPreviewSize", "type": "FontPreviewType", "description": "Show font previews in the type tool font menus.", "access": "read/write" }, { "name": "fullSizePreview", "type": "boolean", "description": "If true, shows the image preview as a full size image.", "access": "read/write" }, { "name": "gamutWarningOpacity", "type": "number", "description": "The opacity (as a percentage) of the warning color for out-of-gamut colors. Range: 0 to 100.", "access": "read/write", "range": { "min": "0", "max": "100" } }, { "name": "gridSize", "type": "GridSize", "description": "The size of grid squares.", "access": "read/write" }, { "name": "gridStyle", "type": "GridLineStyle", "description": "The formatting style for non-printing grid lines.", "access": "read/write" }, { "name": "gridSubDivisions", "type": "number", "description": "The value by which to subdivide the grid.", "access": "read/write" }, { "name": "guideStyle", "type": "GuideLineStyle", "description": "The formatting style for non-printing guide lines.", "access": "read/write" }, { "name": "iconPreview", "type": "boolean", "description": "If true, shows the image preview as a thumbnail.", "access": "read/write" }, { "name": "imageCacheForHistograms", "type": "boolean", "description": "If true, shows the current image cache used to create the histogram.", "access": "read/write" }, { "name": "imageCacheLevels", "type": "number", "description": "The number of images to hold in the cache. Range: 1 to 8.", "access": "read/write", "range": { "min": "1", "max": "8" } }, { "name": "imagePreviews", "type": "SaveBehavior", "description": "The behavior mode to use when saving files.", "access": "read/write" }, { "name": "interpolation", "type": "ResampleMethod", "description": "The method to use to assign color values to any new pixels created when an image is resampled or resized.", "access": "read/write" }, { "name": "keyboardZoomResizesWindows", "type": "boolean", "description": "If true, automatically resizes the window when zooming in or out using keyboard shortcuts.", "access": "read/write" }, { "name": "macOSThumbnail", "type": "boolean", "description": "If true, creates a thumbnail when saving the image in Mac OS.", "access": "read/write" }, { "name": "maxRAMuse", "type": "number", "description": "Maximum percentage of available RAM used by Photoshop.", "access": "read/write", "range": { "min": "5", "max": "100" } }, { "name": "maximizeCompatibility", "type": "QueryStateType", "description": "The behavior to use to check whether to maximize compatibility when opening Adobe Photoshop (PSD) files.", "access": "read/write" }, { "name": "nonLinearHistory", "type": "boolean", "description": "If true, allows non-linear history.", "access": "read/write" }, { "name": "numberOfHistoryStates", "type": "number", "description": "The number of history states to preserve. Range: 1 to 100.", "access": "read/write", "range": { "min": "1", "max": "100" } }, { "name": "otherCursors", "type": "OtherPaintingCursors", "description": "The type of pointer to use.", "access": "read/write" }, { "name": "paintingCursors", "type": "PaintingCursors", "description": "The type of pointer to use.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pixelDoubling", "type": "boolean", "description": "If true, halves the resolution or (doubles the size of pixels) to make previews display more quickly.", "access": "read/write" }, { "name": "pointSize", "type": "PointType", "description": "The point/pica size.", "access": "read/write" }, { "name": "recentFileListLength", "type": "number", "description": "The number of items in the recent file list. Range: 0 to 30.", "access": "read/write", "range": { "min": "0", "max": "30" } }, { "name": "rulerUnits", "type": "number[]", "description": "The unit that the scripting system uses when receiving and returning values.", "access": "read/write" }, { "name": "saveLogItems", "type": "SaveLogItemsType", "description": "Options for saving the history items.", "access": "read/write" }, { "name": "saveLogItemsFile", "type": "File", "description": "File to save the history log.", "access": "read/write" }, { "name": "savePaletteLocations", "type": "boolean", "description": "If true, makes new palette locations the default location.", "access": "read/write" }, { "name": "showAsianTextOptions", "type": "boolean", "description": "If true, Asian text options are displayed in the Paragraph palette.", "access": "read/write" }, { "name": "showEnglishFontNames", "type": "boolean", "description": "If true, Asian font names are listed in English.", "access": "read/write" }, { "name": "showSliceNumber", "type": "boolean", "description": "If true, displays slice numbers in the document window when using the Slice tool.", "access": "read/write" }, { "name": "showToolTips", "type": "boolean", "description": "If true, pop-up definitions are displayed on mouseover.", "access": "read/write" }, { "name": "smartQuotes", "type": "boolean", "description": "If true, curly quote marks are used.", "access": "read/write" }, { "name": "textFontSize", "type": "FontSize", "description": "Size of the small font used in panels and dialogs.", "access": "read/write" }, { "name": "typeUnits", "type": "TypeUnits", "description": "The unit type-size that the numeric inputs are assumed to represent.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "useAdditionalPluginFolder", "type": "boolean", "description": "If true, uses an additional folder for compatible plug-ins stored with a different application.", "access": "read/write" }, { "name": "useDiffusionDither", "type": "boolean", "description": "If true, uses diffusion dither.", "access": "read/write" }, { "name": "useHistoryLog", "type": "boolean", "description": "Turn on and off the history logging.", "access": "read/write" }, { "name": "useLowerCaseExtension", "type": "boolean", "description": "If true, the file extension is lowercase.", "access": "read/write" }, { "name": "useShiftKeyForToolSwitch", "type": "boolean", "description": "If true, enables cycling through a set of hidden tools.", "access": "read/write" }, { "name": "useVideoAlpha", "type": "boolean", "description": "If true, enables Adobe Photoshop to send transparency information to your computer’s video board. (Requires hardware support.)", "access": "read/write" }, { "name": "windowsThumbnail", "type": "boolean", "description": "If true, creates a thumbnail when saving the image in Windows. (Requires hardware support.)", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "PresentationOptions", "kind": "Object", "description": "Options for the PDF presentation command.", "properties": [ { "name": "PDFFileOptions", "type": "PDFSaveOptions", "description": "Options for creating the PDF file.", "access": "read/write", "static": true }, { "name": "autoAdvance", "type": "boolean", "description": "If true, the presentation auto advances.", "access": "read/write", "static": true, "value": "true" }, { "name": "includeFilename", "type": "boolean", "description": "If true, includes the file name for the image.", "access": "read/write", "static": true, "value": "false" }, { "name": "interval", "type": "number", "description": "The amount of time (in seconds) before auto advancing the view. Valid only when 'auto advance' is true. Range: 1 to 60.", "access": "read/write", "static": true, "value": "5", "range": { "min": "1", "max": "60" } }, { "name": "loop", "type": "boolean", "description": "If true, the presentation loops after the last page.", "access": "read/write", "static": true, "value": "false" }, { "name": "magnification", "type": "MagnificationType", "description": "The magnification type when viewing the image.", "access": "read/write", "static": true, "value": "MagnificationType.ACTUALSIZE" }, { "name": "presentation", "type": "boolean", "description": "If true, the file type is presentation. If false, the file type is Multi-Page document.", "access": "read/write", "static": true, "value": "false" }, { "name": "transition", "type": "TransitionType", "description": "The image transition type.", "access": "read/write", "static": true, "value": "TransitionType.NONE" } ], "events": [], "methods": [] }, { "name": "PrintColorHandling", "kind": "Enumeration", "description": "Color conversion type when printing.", "properties": [ { "name": "PHOTOSHOPMANAGED", "type": "number", "description": "Photoshop manages color conversions.", "access": "readonly", "value": "2" }, { "name": "PRINTERMANAGED", "type": "number", "description": "Printer manages color conversions.", "access": "readonly", "value": "1" }, { "name": "SEPARATIONS", "type": "number", "description": "Print each channel separately without color conversions.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "PurgeTarget", "kind": "Enumeration", "description": "The cache to be targeted in a purge operation.", "properties": [ { "name": "ALLCACHES", "type": "number", "description": "Clears all caches.", "access": "readonly", "value": "4" }, { "name": "CLIPBOARDCACHE", "type": "number", "description": "Clears the clipboard.", "access": "readonly", "value": "3" }, { "name": "HISTORYCACHES", "type": "number", "description": "Deletes all history states from the History palette.", "access": "readonly", "value": "2" }, { "name": "UNDOCACHES", "type": "number", "description": "Clears the undo cache.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "QueryStateType", "kind": "Enumeration", "description": "The permission state for queries.", "properties": [ { "name": "ALWAYS", "type": "number", "description": "Always maximize compatibility.", "access": "readonly", "value": "1" }, { "name": "ASK", "type": "number", "description": "Always ask about maximize compatibility.", "access": "readonly", "value": "2" }, { "name": "NEVER", "type": "number", "description": "Never ask about maximize compatibility.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "RGBColor", "kind": "Object", "description": "The definition of an RGB color mode.", "extends": "Color", "properties": [ { "name": "blue", "type": "number", "description": "The blue color value. Range: 0.0 to 255.0.", "access": "read/write", "static": true, "value": "255", "range": { "min": "0", "max": "255" } }, { "name": "blue", "type": "number", "description": "The blue color value. Range: 0.0 to 255.0.", "access": "read/write", "value": "255", "range": { "min": "0", "max": "255" } }, { "name": "green", "type": "number", "description": "The green color value. Range: 0.0 to 255.0.", "access": "read/write", "static": true, "value": "255", "range": { "min": "0", "max": "255" } }, { "name": "green", "type": "number", "description": "The green color value. Range: 0.0 to 255.0.", "access": "read/write", "value": "255", "range": { "min": "0", "max": "255" } }, { "name": "hexValue", "type": "string", "description": "The hex representation of this color.", "access": "read/write", "static": true }, { "name": "hexValue", "type": "string", "description": "The hex representation of this color.", "access": "read/write" }, { "name": "red", "type": "number", "description": "The red color value. Range: 0.0 to 255.0.", "access": "read/write", "static": true, "value": "255", "range": { "min": "0", "max": "255" } }, { "name": "red", "type": "number", "description": "The red color value. Range: 0.0 to 255.0.", "access": "read/write", "value": "255", "range": { "min": "0", "max": "255" } } ], "events": [], "methods": [] }, { "name": "RadialBlurMethod", "kind": "Enumeration", "description": "The blur method to use.", "properties": [ { "name": "SPIN", "type": "number", "description": "Blurs along concentric circular lines at the specified degree of rotation.", "access": "readonly", "value": "1" }, { "name": "ZOOM", "type": "number", "description": "Blurs along radial lines, as if zooming into or out of the image.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "RadialBlurQuality", "kind": "Enumeration", "description": "The radial blur quality.", "properties": [ { "name": "BEST", "type": "number", "description": "Produces best results.", "access": "readonly", "value": "3" }, { "name": "DRAFT", "type": "number", "description": "Produces fast but grainy results.", "access": "readonly", "value": "1" }, { "name": "GOOD", "type": "number", "description": "Produces good results.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "RasterizeType", "kind": "Enumeration", "description": "The type of the layer content to rasterize.", "properties": [ { "name": "ENTIRELAYER", "type": "number", "description": "Rasterizes all vector data on the layer.", "access": "readonly", "value": "5" }, { "name": "FILLCONTENT", "type": "number", "description": "Rasterizes the fill of a shape layer, leaving the vector mask.", "access": "readonly", "value": "3" }, { "name": "LAYERCLIPPINGPATH", "type": "number", "description": "Rasterizes the vector mask of a shape layer, turning it into a layer mask.", "access": "readonly", "value": "4" }, { "name": "LINKEDLAYERS", "type": "number", "description": "Rasterizes the selected layers.", "access": "readonly", "value": "6" }, { "name": "SHAPE", "type": "number", "description": "Rasterizes a shape layer.", "access": "readonly", "value": "2" }, { "name": "TEXTCONTENTS", "type": "number", "description": "Rasterizes the type on a type layer. Doesn't rasterize any other vector data on the layer.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "RawFormatOpenOptions", "kind": "Object", "description": "Options that can be specified when opening a document in RAW format.", "extends": "OpenOptions", "properties": [ { "name": "bitsPerChannel", "type": "number", "description": "The number of bits for each channel. Valid values: 8 or 16.", "access": "read/write", "static": true }, { "name": "byteOrder", "type": "ByteOrderType", "description": "The order in which bytes will be read. Valid only when 'bits per channel' = 16.", "access": "read/write", "static": true }, { "name": "channelNumber", "type": "number", "description": "The number of channels in the image. Valid only when 'bits per channel' = 16. Range: 1 to 56.", "access": "read/write", "static": true, "range": { "min": "1", "max": "56" } }, { "name": "headerSize", "type": "number", "description": "The number of bytes of information that will appear in the file before actual image information begins; that is, the number of zeroes inserted at the beginning of the file as placeholders. Range: 0 to 1919999.", "access": "read/write", "static": true, "range": { "min": "0", "max": "1919999" } }, { "name": "height", "type": "number", "description": "The image height (in pixels)", "access": "read/write", "static": true }, { "name": "interleaveChannels", "type": "boolean", "description": "If true, color values are stored sequentially.", "access": "read/write", "static": true }, { "name": "retainHeader", "type": "boolean", "description": "If true, the header is retained when saving.", "access": "read/write", "static": true }, { "name": "width", "type": "number", "description": "The image width (in pixels)", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "RawSaveOptions", "kind": "Object", "description": "Options for saving a document in RAW format.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "spotColors", "type": "boolean", "description": "If true, spot colors are saved.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "Rectangle", "kind": "Collection", "description": "Describes a rectangle. This class is also a four-element collection.", "properties": [ { "name": "bottom", "type": "number", "description": "The bottom coordinate.", "access": "read/write" }, { "name": "height", "type": "number", "description": "The height.", "access": "read/write" }, { "name": "left", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "length", "type": "number", "description": "The array length.", "access": "readonly", "value": "4" }, { "name": "right", "type": "number", "description": "The right coordinate.", "access": "read/write" }, { "name": "top", "type": "number", "description": "The top coordinate.", "access": "read/write" }, { "name": "width", "type": "number", "description": "The width.", "access": "read/write" }, { "name": "x", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "y", "type": "number", "description": "The top coordinate.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "ReferenceFormType", "kind": "Enumeration", "description": "The type of action reference object.", "properties": [ { "name": "CLASSTYPE", "type": "number", "description": "Class.", "access": "readonly", "value": "7" }, { "name": "ENUMERATED", "type": "number", "description": "Enumerated.", "access": "readonly", "value": "5" }, { "name": "IDENTIFIER", "type": "number", "description": "Identifier.", "access": "readonly", "value": "3" }, { "name": "INDEX", "type": "number", "description": "Index.", "access": "readonly", "value": "2" }, { "name": "NAME", "type": "number", "description": "Name.", "access": "readonly", "value": "1" }, { "name": "OFFSET", "type": "number", "description": "Offset.", "access": "readonly", "value": "4" }, { "name": "PROPERTY", "type": "number", "description": "Property.", "access": "readonly", "value": "6" } ], "events": [], "methods": [] }, { "name": "ResampleMethod", "kind": "Enumeration", "description": "The method to use to resample the image.", "properties": [ { "name": "AUTOMATIC", "type": "number", "description": "", "access": "readonly", "value": "8" }, { "name": "BICUBIC", "type": "number", "description": "Uses a weighted average to determine pixel color, which usually yields better results than the simple averageing method of downsampling.", "access": "readonly", "value": "4" }, { "name": "BICUBICAUTOMATIC", "type": "number", "description": "", "access": "readonly", "value": "7" }, { "name": "BICUBICSHARPER", "type": "number", "description": "A good method for reducing the size of an image based on Bicubic interpolation with enhanced sharpening. Maintains the detail in a resampled image.", "access": "readonly", "value": "5" }, { "name": "BICUBICSMOOTHER", "type": "number", "description": "A good method for enlarging images based on Bicubic interpolation but designed to produce smoother results.", "access": "readonly", "value": "6" }, { "name": "BILINEAR", "type": "number", "description": "Averages the pixels in a sample area and replaces the entire area with the average pixel color at the specified resolution. Same as average downsampling.", "access": "readonly", "value": "3" }, { "name": "NEARESTNEIGHBOR", "type": "number", "description": "Chooses a pixel in the center of the sample area and replaces the entire area with that pixel color. Same as subsampling.", "access": "readonly", "value": "2" }, { "name": "NONE", "type": "number", "description": "Does not resample.", "access": "readonly", "value": "1" }, { "name": "PRESERVEDETAILS", "type": "number", "description": "", "access": "readonly", "value": "9" } ], "events": [], "methods": [] }, { "name": "ResetTarget", "kind": "Enumeration", "description": "The type of object(s) to reset to default settings.", "properties": [ { "name": "ALLTOOLS", "type": "number", "description": "Tools.", "access": "readonly", "value": "2" }, { "name": "ALLWARNINGS", "type": "number", "description": "Warning dialogs.", "access": "readonly", "value": "1" }, { "name": "EVERYTHING", "type": "number", "description": "All targets.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "RippleSize", "kind": "Enumeration", "description": "The size of undulations.", "properties": [ { "name": "LARGE", "type": "number", "description": "Large.", "access": "readonly", "value": "3" }, { "name": "MEDIUM", "type": "number", "description": "Medium.", "access": "readonly", "value": "2" }, { "name": "SMALL", "type": "number", "description": "Small.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "SGIRGBSaveOptions", "kind": "Object", "description": "Options for saving a document in SGI RGB format.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "spotColors", "type": "boolean", "description": "If true, the spot colors are saved.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "SaveBehavior", "kind": "Enumeration", "description": "The application's behavior regarding image previews and file extensions when a save method is called.", "properties": [ { "name": "ALWAYSSAVE", "type": "number", "description": "Always save the item with the file.", "access": "readonly", "value": "2" }, { "name": "ASKWHENSAVING", "type": "number", "description": "Prompt the user whether to save the item with the file.", "access": "readonly", "value": "3" }, { "name": "NEVERSAVE", "type": "number", "description": "Never save the item with the file.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "SaveDocumentType", "kind": "Enumeration", "description": "Document formats that Photoshop can save to.", "properties": [ { "name": "ALIASPIX", "type": "number", "description": "Alias PIX format.", "access": "readonly", "value": "25" }, { "name": "BMP", "type": "number", "description": "BMP format.", "access": "readonly", "value": "2" }, { "name": "COMPUSERVEGIF", "type": "number", "description": "CompuServe GIF format.", "access": "readonly", "value": "3" }, { "name": "ELECTRICIMAGE", "type": "number", "description": "Electric format.", "access": "readonly", "value": "26" }, { "name": "JPEG", "type": "number", "description": "JPEG format.", "access": "readonly", "value": "6" }, { "name": "PCX", "type": "number", "description": "PCX format.", "access": "readonly", "value": "7" }, { "name": "PHOTOSHOP", "type": "number", "description": "Photoshop format.", "access": "readonly", "value": "1" }, { "name": "PHOTOSHOPDCS_1", "type": "number", "description": "Photoshop DCS 1.0 format.", "access": "readonly", "value": "18" }, { "name": "PHOTOSHOPDCS_2", "type": "number", "description": "Photoshop DCS 2.0 format.", "access": "readonly", "value": "19" }, { "name": "PHOTOSHOPEPS", "type": "number", "description": "EPS document produced by Photoshop.", "access": "readonly", "value": "4" }, { "name": "PHOTOSHOPPDF", "type": "number", "description": "PDF document produced by Photoshop.", "access": "readonly", "value": "8" }, { "name": "PICTFileFORMAT", "type": "number", "description": "PICT file format.", "access": "readonly", "value": "10" }, { "name": "PICTRESOURCEFORMAT", "type": "number", "description": "PICT resource format.", "access": "readonly", "value": "11" }, { "name": "PIXAR", "type": "number", "description": "Pixar format.", "access": "readonly", "value": "12" }, { "name": "PNG", "type": "number", "description": "PNG format.", "access": "readonly", "value": "13" }, { "name": "PORTABLEBITMAP", "type": "number", "description": "Portable Bitmap format.", "access": "readonly", "value": "27" }, { "name": "RAW", "type": "number", "description": "Raw format.", "access": "readonly", "value": "14" }, { "name": "SCITEXCT", "type": "number", "description": "Scitex CT format.", "access": "readonly", "value": "15" }, { "name": "SGIRGB", "type": "number", "description": "SGI RGB format.", "access": "readonly", "value": "29" }, { "name": "SOFTIMAGE", "type": "number", "description": "SoftImage format.", "access": "readonly", "value": "30" }, { "name": "TARGA", "type": "number", "description": "Targa format.", "access": "readonly", "value": "16" }, { "name": "TIFF", "type": "number", "description": "TIFF format.", "access": "readonly", "value": "17" }, { "name": "WAVEFRONTRLA", "type": "number", "description": "Wavefront RLA format.", "access": "readonly", "value": "28" }, { "name": "WIRELESSBITMAP", "type": "number", "description": "Wireless Bitmap format (WBMP)", "access": "readonly", "value": "31" } ], "events": [], "methods": [] }, { "name": "SaveEncoding", "kind": "Enumeration", "description": "The encoding to use when saving documents.", "properties": [ { "name": "ASCII", "type": "number", "description": "ASCII.", "access": "readonly", "value": "3" }, { "name": "BINARY", "type": "number", "description": "Binary.", "access": "readonly", "value": "1" }, { "name": "JPEGHIGH", "type": "number", "description": "High quality JPEG encoding.", "access": "readonly", "value": "5" }, { "name": "JPEGLOW", "type": "number", "description": "Low quality JPEG encoding (high amount of compression).", "access": "readonly", "value": "2" }, { "name": "JPEGMAXIMUM", "type": "number", "description": "Maximum quality JPEG encoding (very little compression).", "access": "readonly", "value": "6" }, { "name": "JPEGMEDIUM", "type": "number", "description": "Medium quality JPEG encoding (medium compression).", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "SaveLogItemsType", "kind": "Enumeration", "description": "The location of history log data.", "properties": [ { "name": "LOGFILE", "type": "number", "description": "Save history log in a text file.", "access": "readonly", "value": "2" }, { "name": "LOGFILEANDMETADATA", "type": "number", "description": "Save history log in file metadata and a text file.", "access": "readonly", "value": "3" }, { "name": "METADATA", "type": "number", "description": "Save history log in file metadata.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "SaveOptions", "kind": "Enumeration", "description": "Options for saving a file.", "properties": [ { "name": "DONOTSAVECHANGES", "type": "number", "description": "Do not save changes.", "access": "readonly", "value": "2" }, { "name": "PROMPTTOSAVECHANGES", "type": "number", "description": "Ask the user whether to save.", "access": "readonly", "value": "3" }, { "name": "SAVECHANGES", "type": "number", "description": "Save changes.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "SaveOptionsType", "kind": "Enumeration", "description": "The save options for closing a file.", "properties": [ { "name": "DONOTSAVECHANGES", "type": "number", "description": "Do not save changes.", "access": "readonly", "value": "2" }, { "name": "PROMPTTOSAVECHANGES", "type": "number", "description": "Ask the user whether to save.", "access": "readonly", "value": "3" }, { "name": "SAVECHANGES", "type": "number", "description": "Save changes.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Selection", "kind": "Object", "description": "The selected area of the document or layer.", "properties": [ { "name": "bounds", "type": "number[]", "description": "The bounding rectangle of the entire selection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "solid", "type": "boolean", "description": "If true, the bounding rectangle a solid rectangle.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "clear", "returns": "void", "description": "Clears the selection and does not copy it to the clipboard.", "parameters": [] }, { "name": "contract", "returns": "void", "description": "Contracts the selection.", "parameters": [ { "name": "by", "type": "UnitValue", "description": "The amount to contract the selection." } ] }, { "name": "copy", "returns": "void", "description": "Copies the selection to the clipboard.", "parameters": [ { "name": "merge", "type": "boolean", "description": "If true the copy includes all visible layers. If false, copies only from the current layer.", "optional": true } ] }, { "name": "cut", "returns": "void", "description": "Cuts the current selection to the clipboard.", "parameters": [] }, { "name": "deselect", "returns": "void", "description": "Deselects the current selection.", "parameters": [] }, { "name": "expand", "returns": "void", "description": "Expands the selection.", "parameters": [ { "name": "by", "type": "UnitValue", "description": "The amount to expand the selection." } ] }, { "name": "feather", "returns": "void", "description": "Feathers the edges of the selection.", "parameters": [ { "name": "by", "type": "UnitValue", "description": "The amount to feather the edge." } ] }, { "name": "fill", "returns": "void", "description": "Fills the selection.", "parameters": [ { "name": "fillType", "type": "any", "description": "The color or history state with which to fill the object." }, { "name": "mode", "type": "ColorBlendMode", "description": "The color blend mode.", "optional": true }, { "name": "opacity", "type": "number", "description": "The opacity as a percentage. Range: 1 to 100.", "range": { "min": "1", "max": "100" }, "optional": true }, { "name": "preserveTransparency", "type": "boolean", "description": "If true, perserves transparencies.", "optional": true } ] }, { "name": "grow", "returns": "void", "description": "Grows the selection to include all adjacent pixels falling within the specified tolerance range.", "parameters": [ { "name": "tolerance", "type": "number", "description": "The tolerance range. Range: 0 to 255.", "range": { "min": "0", "max": "255" } }, { "name": "antiAlias", "type": "boolean", "description": "If true, anti-aliasing is used." } ] }, { "name": "invert", "returns": "void", "description": "Inverts the selection.", "parameters": [] }, { "name": "load", "returns": "void", "description": "Loads the selection from the specified channel.", "parameters": [ { "name": "from", "type": "Channel", "description": "The channel to load the selection from." }, { "name": "combination", "type": "SelectionType", "description": "How to combine the channel contents with the existing selection.", "optional": true }, { "name": "inverting", "type": "boolean", "description": "If true, selects the inverse of the channel contents.", "optional": true } ] }, { "name": "makeWorkPath", "returns": "void", "description": "Makes this selection item the workpath for this document.", "parameters": [ { "name": "tolerance", "type": "number", "description": "The tolerance in pixels.", "optional": true } ] }, { "name": "resize", "returns": "void", "description": "Resizes the selected area to the specified dimensions and anchor position.", "parameters": [ { "name": "horizontal", "type": "number", "description": "The amount to scale the selection horizontally (as a percentage).", "optional": true }, { "name": "vertical", "type": "number", "description": "The amount to scale the selection vertically (as a percentage).", "optional": true }, { "name": "anchor", "type": "AnchorPosition", "description": "The point to scale around.", "optional": true } ] }, { "name": "resizeBoundary", "returns": "void", "description": "Scales the boundary of the selection.", "parameters": [ { "name": "horizontal", "type": "number", "description": "The amount to scale the object horizontally (as a percentage).", "optional": true }, { "name": "vertical", "type": "number", "description": "The amount to scale the object vertically (as a percentage).", "optional": true }, { "name": "anchor", "type": "AnchorPosition", "description": "The point to scale around.", "optional": true } ] }, { "name": "rotate", "returns": "void", "description": "Rotates the object.", "parameters": [ { "name": "angle", "type": "number", "description": "The number of degrees to rotate the object." }, { "name": "anchor", "type": "AnchorPosition", "description": "The point to rotate about.", "optional": true } ] }, { "name": "rotateBoundary", "returns": "void", "description": "Rotates the boundary of the selection.", "parameters": [ { "name": "angle", "type": "number", "description": "The rotation angle (in degrees)" }, { "name": "anchor", "type": "AnchorPosition", "description": "The point to rotate about.", "optional": true } ] }, { "name": "select", "returns": "void", "description": "Selects the specified region.", "parameters": [ { "name": "region", "type": "any[]", "description": "Array of x and y coordinates that describe the corners of the selection, in the format [[x1, y1], [x2,y2],[x3, y3], [x4,y4]]" }, { "name": "type", "type": "SelectionType", "description": "The method for combining the new selection with the existing selection.", "optional": true }, { "name": "feather", "type": "number", "description": "The feather amount.", "optional": true }, { "name": "antiAlias", "type": "boolean", "description": "If true, anti-aliasing is used.", "optional": true } ] }, { "name": "selectAll", "returns": "void", "description": "Selects the entire layer.", "parameters": [] }, { "name": "selectBorder", "returns": "void", "description": "Selects the selection border only (in the specified width); subsequent actions do not affect the selected area within the borders.", "parameters": [ { "name": "width", "type": "UnitValue", "description": "The width of the border selection." } ] }, { "name": "similar", "returns": "void", "description": "Grows the selection to include pixels throughout the image falling within the tolerance range.", "parameters": [ { "name": "tolerance", "type": "number", "description": "The tolerance range. Range: 0 to 255.", "range": { "min": "0", "max": "255" } }, { "name": "antiAlias", "type": "boolean", "description": "If true, anti-aliasing is used." } ] }, { "name": "smooth", "returns": "void", "description": "Cleans up stray pixels left inside or outside a color-based selection (within the radius specified in pixels).", "parameters": [ { "name": "radius", "type": "number", "description": "The sample radius in pixels. Range: 0 to 100.", "range": { "min": "0", "max": "100" } } ] }, { "name": "store", "returns": "void", "description": "Saves the selection as a channel.", "parameters": [ { "name": "into", "type": "Channel", "description": "The channel to save the selection to." }, { "name": "combination", "type": "SelectionType", "description": "How to add the selection to the existing contents of the channel.", "optional": true } ] }, { "name": "stroke", "returns": "void", "description": "Strokes the selection.", "parameters": [ { "name": "strokeColor", "type": "any", "description": "The color to stroke the selection with." }, { "name": "width", "type": "number", "description": "The stroke width." }, { "name": "location", "type": "StrokeLocation", "description": "The stroke location.", "optional": true }, { "name": "mode", "type": "ColorBlendMode", "description": "The color blend mode.", "optional": true }, { "name": "opacity", "type": "number", "description": "The opacity of the stroke color as a percentage. Range: 1 to 100.", "range": { "min": "1", "max": "100" }, "optional": true }, { "name": "preserveTransparency", "type": "boolean", "description": "If true, preserves transparency.", "optional": true } ] }, { "name": "translate", "returns": "void", "description": "Moves the object relative to its current position.", "parameters": [ { "name": "deltaX", "type": "UnitValue", "description": "The amount to move the object horizontally.", "optional": true }, { "name": "deltaY", "type": "UnitValue", "description": "The amount to move the object vertically.", "optional": true } ] }, { "name": "translateBoundary", "returns": "void", "description": "Moves the boundary of selection relative to its current position.", "parameters": [ { "name": "deltaX", "type": "UnitValue", "description": "The amount to move the object horizontally.", "optional": true }, { "name": "deltaY", "type": "UnitValue", "description": "The amount to move the object vertically.", "optional": true } ] } ] }, { "name": "SelectionType", "kind": "Enumeration", "description": "The selection behavior when a selection already exists.", "properties": [ { "name": "DIMINISH", "type": "number", "description": "Remove the selection from the already selected area.", "access": "readonly", "value": "3" }, { "name": "EXTEND", "type": "number", "description": "Add the selection to an already selected area.", "access": "readonly", "value": "2" }, { "name": "INTERSECT", "type": "number", "description": "Make the selection only the area where the new selection intersects the already selected area.", "access": "readonly", "value": "4" }, { "name": "REPLACE", "type": "number", "description": "Replace the selected area.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ShapeOperation", "kind": "Enumeration", "description": "Specifies how to combine the shapes if the destination image already has a selection.", "properties": [ { "name": "SHAPEADD", "type": "number", "description": "Adds the shapes.", "access": "readonly", "value": "1" }, { "name": "SHAPEINTERSECT", "type": "number", "description": "The resulting shape is the area of intersection between the two shapes.", "access": "readonly", "value": "3" }, { "name": "SHAPESUBTRACT", "type": "number", "description": "Subtracts the loaded shape from the selection is the destination image.", "access": "readonly", "value": "4" }, { "name": "SHAPEXOR", "type": "number", "description": "Replaces the shape in the destination image with the loaded selection.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "SmartBlurMode", "kind": "Enumeration", "description": "The method to use for smart blurring.", "properties": [ { "name": "EDGEONLY", "type": "number", "description": "Blur is applied only to edges of color transitions.", "access": "readonly", "value": "2" }, { "name": "NORMAL", "type": "number", "description": "Blur is applied to entire image.", "access": "readonly", "value": "1" }, { "name": "OVERLAYEDGE", "type": "number", "description": "Blur is applied only to edges of color transitions.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "SmartBlurQuality", "kind": "Enumeration", "description": "The smart blur quality.", "properties": [ { "name": "HIGH", "type": "number", "description": "High quality.", "access": "readonly", "value": "3" }, { "name": "LOW", "type": "number", "description": "Low quality.", "access": "readonly", "value": "1" }, { "name": "MEDIUM", "type": "number", "description": "Medium quality.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "SolidColor", "kind": "Object", "description": "A color definition used in the document.", "properties": [ { "name": "cmyk", "type": "CMYKColor", "description": "The CMYK color model.", "access": "read/write", "static": true }, { "name": "cmyk", "type": "CMYKColor", "description": "The CMYK color model.", "access": "read/write" }, { "name": "gray", "type": "GrayColor", "description": "The grayscale color model.", "access": "read/write", "static": true }, { "name": "gray", "type": "GrayColor", "description": "The grayscale color model.", "access": "read/write" }, { "name": "hsb", "type": "HSBColor", "description": "The HSB color model.", "access": "read/write", "static": true }, { "name": "hsb", "type": "HSBColor", "description": "The HSB color model.", "access": "read/write" }, { "name": "lab", "type": "LabColor", "description": "The lab color model.", "access": "read/write", "static": true }, { "name": "lab", "type": "LabColor", "description": "The lab color model.", "access": "read/write" }, { "name": "model", "type": "ColorModel", "description": "The color model.", "access": "read/write", "static": true }, { "name": "model", "type": "ColorModel", "description": "The color model.", "access": "read/write" }, { "name": "nearestWebColor", "type": "RGBColor", "description": "The nearest web color to the current color.", "access": "readonly", "static": true }, { "name": "nearestWebColor", "type": "RGBColor", "description": "The nearest web color to the current color.", "access": "readonly" }, { "name": "rgb", "type": "RGBColor", "description": "The RGB color model.", "access": "read/write", "static": true }, { "name": "rgb", "type": "RGBColor", "description": "The RGB color model.", "access": "read/write" } ], "events": [], "methods": [ { "name": "isEqual", "returns": "boolean", "description": "Compares two colors.", "parameters": [ { "name": "color", "type": "SolidColor", "description": "Another color to compare with." } ] } ] }, { "name": "SourceSpaceType", "kind": "Enumeration", "description": "The color space for the source when printing.", "properties": [ { "name": "DOCUMENT", "type": "number", "description": "The document color space.", "access": "readonly", "value": "1" }, { "name": "PROOF", "type": "number", "description": "The proof color space.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "SpherizeMode", "kind": "Enumeration", "description": "The curve (or stretch shape) to use for the distortion.", "properties": [ { "name": "HORIZONTAL", "type": "number", "description": "Distorts the image as if it is wrapped around a horizontal cylinder.", "access": "readonly", "value": "2" }, { "name": "NORMAL", "type": "number", "description": "Distorts the image as if it is wrapped around a sphere.", "access": "readonly", "value": "1" }, { "name": "VERTICAL", "type": "number", "description": "Distorts the image as if it is wrapped around a vertical cylinder.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "StrikeThruType", "kind": "Enumeration", "description": "The strikethrough style.", "properties": [ { "name": "STRIKEBOX", "type": "number", "description": "(For vertical type) The strikethrough is through the em box.", "access": "readonly", "value": "3" }, { "name": "STRIKEHEIGHT", "type": "number", "description": "(For vertical type) The strikethrough is through the height of the text.", "access": "readonly", "value": "2" }, { "name": "STRIKEOFF", "type": "number", "description": "No strikethrough.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "StrokeLocation", "kind": "Enumeration", "description": "The placement of path or selection boundary strokes.", "properties": [ { "name": "CENTER", "type": "number", "description": "The border is placed in the center of the the selection or layer boundaries.", "access": "readonly", "value": "2" }, { "name": "INSIDE", "type": "number", "description": "The border is placed inside the selection or layer boundaries.", "access": "readonly", "value": "1" }, { "name": "OUTSIDE", "type": "number", "description": "The border is placed outside the selection or layer boundaries.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "SubPathInfo", "kind": "Object", "description": "An array of path point info objects that describes a straight or curved segment of a path.", "properties": [ { "name": "closed", "type": "boolean", "description": "If true, the path is closed.", "access": "read/write", "static": true }, { "name": "entireSubPath", "type": "PathPointInfo[]", "description": "All of the sub path item's path points.", "access": "read/write", "static": true }, { "name": "operation", "type": "ShapeOperation", "description": "The sub path operation on other sub paths.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "SubPathItem", "kind": "Object", "description": "Information about a path. You do not use the sub path item object to create a path. Rather, you create path segments using the sub path info object. Use the sub path item object to retrieve information about a path. All properties are read-only.", "properties": [ { "name": "closed", "type": "boolean", "description": "If true, the path is closed.", "access": "readonly" }, { "name": "operation", "type": "ShapeOperation", "description": "The sub path operation on other sub paths.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathPoints", "type": "PathPoints", "description": "The path points collection in the sub path.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "SubPathItems", "kind": "Collection", "description": "An array of path point info objects that describes a straight or curved segment of a path. You do not use the sub path item object to create a sub path. Rather, you use the sub path item object to retrieve information about a sub path. To create sub paths, see sub path info.", "elementType": "SubPathItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "SubPathItem", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "getByName", "returns": "SubPathItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "TargaBitsPerPixels", "kind": "Enumeration", "description": "The resolution to use when saving an image in Targa format.", "properties": [ { "name": "SIXTEEN", "type": "number", "description": "16 bits per pixel.", "access": "readonly", "value": "16" }, { "name": "THIRTYTWO", "type": "number", "description": "32 bits per pixel.", "access": "readonly", "value": "32" }, { "name": "TWENTYFOUR", "type": "number", "description": "24 bits per pixel.", "access": "readonly", "value": "24" } ], "events": [], "methods": [] }, { "name": "TargaSaveOptions", "kind": "Object", "description": "Options for saving a document in TGA (Targa) format.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "resolution", "type": "TargaBitsPerPixels", "description": "The number of bits per pixel.", "access": "read/write", "static": true, "value": "TargaBitsPerPixels.TWENTYFOUR" }, { "name": "rleCompression", "type": "boolean", "description": "If true, RLE compression is used.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "TextComposer", "kind": "Enumeration", "description": "The text composer.", "properties": [ { "name": "ADOBEEVERYLINE", "type": "number", "description": "Considers a network of break points for a range of lines and thus optimizes earlier lines in the paragraph to eliminate especially unattractive breaks later on. Results in more even spacing and fewer hyphens.", "access": "readonly", "value": "2" }, { "name": "ADOBESINGLELINE", "type": "number", "description": "Offers a traditional approach to composing type one line at a time. Useful if you prefer to have manual control over how lines break.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "TextFont", "kind": "Object", "description": "An installed font.", "properties": [ { "name": "family", "type": "string", "description": "The font family.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The font name.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "postScriptName", "type": "string", "description": "The PostScript name of the font.", "access": "readonly" }, { "name": "style", "type": "string", "description": "The font style.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "TextFonts", "kind": "Collection", "description": "A collection of fonts available on your computer.", "elementType": "TextFont", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "[]", "returns": "TextFont", "description": "Get an element in the collection with the provided index.", "parameters": [ { "name": "index", "type": "number", "description": "" } ] }, { "name": "getByName", "returns": "TextFont", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "TextItem", "kind": "Object", "description": "The text object contained in an art layer.", "properties": [ { "name": "alternateLigatures", "type": "boolean", "description": "If true, alternate ligatures are used.", "access": "read/write" }, { "name": "antiAliasMethod", "type": "AntiAlias", "description": "The method of anti-aliasing to use.", "access": "read/write" }, { "name": "autoKerning", "type": "AutoKernType", "description": "Options for auto kerning.", "access": "read/write" }, { "name": "autoLeadingAmount", "type": "number", "description": "The percentage to use for auto leading. Range: 0.01 to 5000.00.", "access": "read/write" }, { "name": "baselineShift", "type": "UnitValue", "description": "The amount of baseline offset of text.", "access": "read/write" }, { "name": "capitalization", "type": "Case", "description": "The case of the text.", "access": "read/write" }, { "name": "color", "type": "SolidColor", "description": "The text color.", "access": "read/write" }, { "name": "contents", "type": "string", "description": "The actual text in the layer.", "access": "read/write" }, { "name": "desiredGlyphScaling", "type": "number", "description": "The desired amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.", "access": "read/write" }, { "name": "desiredLetterScaling", "type": "number", "description": "The amount of space (as a percentage) between letters. Range: 100 - 500; at 0, no space is added between letters. Valid only for justified text.", "access": "read/write" }, { "name": "desiredWordScaling", "type": "number", "description": "The amount (as a percentage) of space between words. Range: 0 -1000; at 100, no additional space is added between words. Valid only for justified text.", "access": "read/write" }, { "name": "direction", "type": "Direction", "description": "The text orientation.", "access": "read/write" }, { "name": "fauxBold", "type": "boolean", "description": "If true, faux bold is used.", "access": "read/write" }, { "name": "fauxItalic", "type": "boolean", "description": "If true, faux italic is used.", "access": "read/write" }, { "name": "firstLineIndent", "type": "UnitValue", "description": "The amount to indent the first line of paragraphs. Range: -1296 to 1296.", "access": "read/write" }, { "name": "font", "type": "string", "description": "The text face of the character.", "access": "read/write" }, { "name": "hangingPuntuation", "type": "boolean", "description": "If true, uses Roman hanging punctuation.", "access": "read/write" }, { "name": "height", "type": "UnitValue", "description": "The height of the bounding box for paragraph text.", "access": "read/write" }, { "name": "horizontalScale", "type": "number", "description": "Character scaling (horizontal) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.", "access": "read/write" }, { "name": "hyphenLimit", "type": "number", "description": "The maximum number of consecutive lines that can end with a hyphenated word.", "access": "read/write" }, { "name": "hyphenateAfterFirst", "type": "number", "description": "The number of letters after which hyphenation in word wrap is allowed. Range: 1 to 15.", "access": "read/write", "range": { "min": "1", "max": "15" } }, { "name": "hyphenateBeforeLast", "type": "number", "description": "The number of letters before which hyphenation in word wrap is allowed. Range: 1 to 15.", "access": "read/write", "range": { "min": "1", "max": "15" } }, { "name": "hyphenateCapitalWords", "type": "boolean", "description": "If true, capitalized words can be hyphenated.", "access": "read/write" }, { "name": "hyphenateWordsLongerThan", "type": "number", "description": "The minimum number of letters a word must have in order for hyphenation in word wrap to be allowed. Range: 2 to 25.", "access": "read/write", "range": { "min": "0", "max": "25" } }, { "name": "hyphenation", "type": "boolean", "description": "If true, hyphenation is used.", "access": "read/write" }, { "name": "hyphenationZone", "type": "UnitValue", "description": "The distance at the end of a line that will cause a word to break in unjustified type. Range: 0 - 720 picas.", "access": "read/write" }, { "name": "justification", "type": "Justification", "description": "The paragraph justification.", "access": "read/write" }, { "name": "kind", "type": "TextType", "description": "The type of text.", "access": "read/write" }, { "name": "language", "type": "Language", "description": "The language.", "access": "read/write" }, { "name": "leading", "type": "UnitValue", "description": "The leading amount.", "access": "read/write" }, { "name": "leftIndent", "type": "UnitValue", "description": "The amount to indent text from the left. Range: -1296 to 1296.", "access": "read/write" }, { "name": "ligatures", "type": "boolean", "description": "If true, ligatures are used.", "access": "read/write" }, { "name": "maximumGlyphScaling", "type": "number", "description": "The maximum amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.", "access": "read/write" }, { "name": "maximumLetterScaling", "type": "number", "description": "The maximum amount (as a percentage) of space between letters. Range: 100 - 500; at 0, no space is added between letters. Valid only for justified text.", "access": "read/write" }, { "name": "maximumWordScaling", "type": "number", "description": "The maximum amount (as a percentage) of space between words (0 -1000; at 100, no additional space is added between words). Valid only for justified text.", "access": "read/write" }, { "name": "minimumGlyphScaling", "type": "number", "description": "The minimum amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.", "access": "read/write" }, { "name": "minimumLetterScaling", "type": "number", "description": "The minimum amount of space (as a percentage) between letters. Range: 100 to 500; at 0, no space is added between letters. Valid only for justified text.", "access": "read/write", "range": { "min": "100", "max": "500" } }, { "name": "minimumWordScaling", "type": "number", "description": "The minimum amount (as a percentage) of space between words. Range: 0 -1000; at 100, no additional space is added between words. Valid only for justified text.", "access": "read/write" }, { "name": "noBreak", "type": "boolean", "description": "If true, words are not allowed to break at the end of a line. When enacted on large amounts of consecutive characters, can prevent word wrap and thus may prevent some text from appearing on the screen.", "access": "read/write" }, { "name": "oldStyle", "type": "boolean", "description": "If true, old style is used.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "position", "type": "number[]", "description": "The position of the origin for the text. The array must contain two values. Setting this property is basically equivalent to clicking the text tool at a point in the document to create the point of origin for text.", "access": "read/write" }, { "name": "rightIndent", "type": "UnitValue", "description": "The amount to indent text from the right. Range: -1296 to 1296.", "access": "read/write" }, { "name": "size", "type": "UnitValue", "description": "The font size in points.", "access": "read/write" }, { "name": "spaceAfter", "type": "UnitValue", "description": "The amount of space after each paragraph. Range: -1296 to 1296.", "access": "read/write" }, { "name": "spaceBefore", "type": "UnitValue", "description": "The amount of space before each paragraph. Range: -1296 to 1296.", "access": "read/write" }, { "name": "strikeThru", "type": "StrikeThruType", "description": "The strike through option to use.", "access": "read/write" }, { "name": "textComposer", "type": "TextComposer", "description": "The text composing engine to use.", "access": "read/write" }, { "name": "tracking", "type": "number", "description": "The amount of uniform spacing between multiple characters. Range: -1000 to 10000.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "underline", "type": "UnderlineType", "description": "Options for underlining the text.", "access": "read/write" }, { "name": "useAutoLeading", "type": "boolean", "description": "If true, uses the font's built-in leading information.", "access": "read/write" }, { "name": "verticalScale", "type": "number", "description": "Character scaling (vertical) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.", "access": "read/write" }, { "name": "warpBend", "type": "number", "description": "The warp bend percentage. Range: -100 to 100.", "access": "read/write" }, { "name": "warpDirection", "type": "Direction", "description": "The warp direction.", "access": "read/write" }, { "name": "warpHorizontalDistortion", "type": "number", "description": "The warp horizontal distortion percentage. Range: -100 to 100.", "access": "read/write" }, { "name": "warpStyle", "type": "WarpStyle", "description": "The style of warp.", "access": "read/write" }, { "name": "warpVerticalDistortion", "type": "number", "description": "The warp vertical distortion percentage. Range: -100 to 100.", "access": "read/write" }, { "name": "width", "type": "UnitValue", "description": "The width of the bounding box for paragraph text.", "access": "read/write" } ], "events": [], "methods": [ { "name": "convertToShape", "returns": "void", "description": "Converts the text object and its containing layer to a fill layer with the text changed to a clipping path.", "parameters": [] }, { "name": "createPath", "returns": "void", "description": "Creates a clipping path from the outlines of the actual text items (such as letters or words).", "parameters": [] } ] }, { "name": "TextType", "kind": "Enumeration", "description": "The type of text.", "properties": [ { "name": "PARAGRAPHTEXT", "type": "number", "description": "Text that wraps within a bounding box.", "access": "readonly", "value": "2" }, { "name": "POINTTEXT", "type": "number", "description": "Text that does not wrap.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "TextureType", "kind": "Enumeration", "description": "The type of texture or glass surface image to load for a texturizer or glass filter.", "properties": [ { "name": "BLOCKS", "type": "number", "description": "The image appears as if viewed through glass blocks.", "access": "readonly", "value": "1" }, { "name": "CANVAS", "type": "number", "description": "The image appears as if painted on canvas.", "access": "readonly", "value": "2" }, { "name": "FILE", "type": "number", "description": "Texture from an existing document.", "access": "readonly", "value": "5" }, { "name": "FROSTED", "type": "number", "description": "The image appears as if frosted.", "access": "readonly", "value": "3" }, { "name": "TINYLENS", "type": "number", "description": "The image appears as if viewed through an array of tiny lenses.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "TiffEncodingType", "kind": "Enumeration", "description": "The encoding to use when saving to TIFF format.", "properties": [ { "name": "JPEG", "type": "number", "description": "JPEG compression, which is lossy and recommended for continuous-tone images, such as photographs.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "No compression.", "access": "readonly", "value": "1" }, { "name": "TIFFLZW", "type": "number", "description": "LZW compression, which is lossless and most useful for images with large areas of single color.", "access": "readonly", "value": "2" }, { "name": "TIFFZIP", "type": "number", "description": "Zip compression, which is lossless and most effective for images that contain large areas of single color.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "TiffSaveOptions", "kind": "Object", "description": "Options for saving a document in TIFF format.", "extends": "SaveOptions", "properties": [ { "name": "alphaChannels", "type": "boolean", "description": "If true, the alpha channels are saved.", "access": "read/write", "static": true }, { "name": "annotations", "type": "boolean", "description": "If true, the annotations are saved.", "access": "read/write", "static": true }, { "name": "byteOrder", "type": "ByteOrderType", "description": "The order in which the bytes will be read. Default: Mac OS when running in Mac OS, and IBM PC when running in Windows.", "access": "read/write", "static": true }, { "name": "embedColorProfile", "type": "boolean", "description": "If true, the color profile is embedded in the document.", "access": "read/write", "static": true }, { "name": "imageCompression", "type": "TiffEncodingType", "description": "The compression type.", "access": "read/write", "static": true, "value": "TiffEncodingType.NONE" }, { "name": "interleaveChannels", "type": "boolean", "description": "If true, the channels in the image are interleaved.", "access": "read/write", "static": true, "value": "true" }, { "name": "jpegQuality", "type": "number", "description": "The quality of the produced image, which is inversely proportionate to the amount of JPEG compression. Valid only for JPEG compressed TIFF documents. Range: 0 to 12.", "access": "read/write", "static": true, "range": { "min": "0", "max": "12" } }, { "name": "layerCompression", "type": "LayerCompressionType", "description": "The method of compression to use when saving layers (as opposed to saving composite data). Valid only when 'layers' = true.", "access": "read/write", "static": true }, { "name": "layers", "type": "boolean", "description": "If true, the layers are saved.", "access": "read/write", "static": true }, { "name": "saveImagePyramid", "type": "boolean", "description": "If true, preserves multi-resolution information.", "access": "read/write", "static": true, "value": "false" }, { "name": "spotColors", "type": "boolean", "description": "If true, spot colors are saved.", "access": "read/write", "static": true }, { "name": "transparency", "type": "boolean", "description": "If true, saves the transparency as an additional alpha channel when the file is opened in another application.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "ToolType", "kind": "Enumeration", "description": "Tools for the stroke path command.", "properties": [ { "name": "ARTHISTORYBRUSH", "type": "number", "description": "Art history brush.", "access": "readonly", "value": "9" }, { "name": "BACKGROUNDERASER", "type": "number", "description": "Background eraser.", "access": "readonly", "value": "4" }, { "name": "BLUR", "type": "number", "description": "Blur.", "access": "readonly", "value": "11" }, { "name": "BRUSH", "type": "number", "description": "Brush.", "access": "readonly", "value": "2" }, { "name": "BURN", "type": "number", "description": "Burn.", "access": "readonly", "value": "14" }, { "name": "CLONESTAMP", "type": "number", "description": "Clone stamp.", "access": "readonly", "value": "5" }, { "name": "COLORREPLACEMENTTOOL", "type": "number", "description": "Color replacement tool.", "access": "readonly", "value": "16" }, { "name": "DODGE", "type": "number", "description": "Dodge.", "access": "readonly", "value": "13" }, { "name": "ERASER", "type": "number", "description": "Eraser.", "access": "readonly", "value": "3" }, { "name": "HEALINGBRUSH", "type": "number", "description": "Healing brush.", "access": "readonly", "value": "7" }, { "name": "HISTORYBRUSH", "type": "number", "description": "History brush.", "access": "readonly", "value": "8" }, { "name": "PATTERNSTAMP", "type": "number", "description": "Pattern stamp.", "access": "readonly", "value": "6" }, { "name": "PENCIL", "type": "number", "description": "Pencil.", "access": "readonly", "value": "1" }, { "name": "SHARPEN", "type": "number", "description": "Sharpen.", "access": "readonly", "value": "12" }, { "name": "SMUDGE", "type": "number", "description": "Smudge.", "access": "readonly", "value": "10" }, { "name": "SPONGE", "type": "number", "description": "Sponge.", "access": "readonly", "value": "15" } ], "events": [], "methods": [] }, { "name": "TransitionType", "kind": "Enumeration", "description": "PDF presentation transition types.", "properties": [ { "name": "BLINDSHORIZONTAL", "type": "number", "description": "Images transition in horizontal stripes like Venetian blinds.", "access": "readonly", "value": "1" }, { "name": "BLINDSVERTICAL", "type": "number", "description": "Images transition in vertical stripes.", "access": "readonly", "value": "2" }, { "name": "BOXIN", "type": "number", "description": "Images transition using a shrinking box shape.", "access": "readonly", "value": "4" }, { "name": "BOXOUT", "type": "number", "description": "Images transition using an expanding box shape.", "access": "readonly", "value": "5" }, { "name": "DISSOLVE", "type": "number", "description": "One image dissolves into the next.", "access": "readonly", "value": "3" }, { "name": "GLITTERDOWN", "type": "number", "description": "Images dissolve top to bottom.", "access": "readonly", "value": "6" }, { "name": "GLITTERRIGHT", "type": "number", "description": "Images dissolve left to right.", "access": "readonly", "value": "7" }, { "name": "GLITTERRIGHTDOWN", "type": "number", "description": "Images dissolve top-left to bottom-right.", "access": "readonly", "value": "8" }, { "name": "NONE", "type": "number", "description": "Images change with no visible transition.", "access": "readonly", "value": "9" }, { "name": "RANDOM", "type": "number", "description": "Images transition using random effects.", "access": "readonly", "value": "10" }, { "name": "SPLITHORIZONTALIN", "type": "number", "description": "The new images roll in from the top and bottom of the screen.", "access": "readonly", "value": "11" }, { "name": "SPLITHORIZONTALOUT", "type": "number", "description": "The new image spreads from the middle of the screen to the top and bottom of the screen.", "access": "readonly", "value": "12" }, { "name": "SPLITVERTICALIN", "type": "number", "description": "The new image rolls in from the left and right edges of the screen.", "access": "readonly", "value": "13" }, { "name": "SPLITVERTICALOUT", "type": "number", "description": "The new image rolls out from the middle of the screen to the left and right edges of the screen.", "access": "readonly", "value": "14" }, { "name": "WIPEDOWN", "type": "number", "description": "The new image rolls in from the top of the screen.", "access": "readonly", "value": "15" }, { "name": "WIPELEFT", "type": "number", "description": "The new image rolls in from the right side of the screen.", "access": "readonly", "value": "16" }, { "name": "WIPERIGHT", "type": "number", "description": "The new image rolls in from the left side of the screen.", "access": "readonly", "value": "17" }, { "name": "WIPEUP", "type": "number", "description": "The new image rolls in from the bottom of the screen.", "access": "readonly", "value": "18" } ], "events": [], "methods": [] }, { "name": "TrimType", "kind": "Enumeration", "description": "The type of pixels to trim around an image.", "properties": [ { "name": "BOTTOMRIGHT", "type": "number", "description": "Removes from the image an area the color of the lower right pixel.", "access": "readonly", "value": "9" }, { "name": "TOPLEFT", "type": "number", "description": "Removes from the image an area the color of the upper left pixel.", "access": "readonly", "value": "1" }, { "name": "TRANSPARENT", "type": "number", "description": "Trims away transparency at the edges of the image, leaving the smallest image containing nontransparent pixels.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "TypeUnits", "kind": "Enumeration", "description": "The measurement unit for type.", "properties": [ { "name": "MM", "type": "number", "description": "Millimeters.", "access": "readonly", "value": "4" }, { "name": "PIXELS", "type": "number", "description": "Pixels.", "access": "readonly", "value": "1" }, { "name": "POINTS", "type": "number", "description": "Points.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "UndefinedAreas", "kind": "Enumeration", "description": "The method to use to treat undistorted areas or areas left blank in an image to which a filter in the Distort category has been applied.", "properties": [ { "name": "REPEATEDGEPIXELS", "type": "number", "description": "Extends the colors of pixels along the edge of the image in the direction specified. Banding may result if the edge pixels are different colors.", "access": "readonly", "value": "2" }, { "name": "WRAPAROUND", "type": "number", "description": "Fills the undefined space with content from the opposite edge of the image.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "UnderlineType", "kind": "Enumeration", "description": "The type of underline.", "properties": [ { "name": "UNDERLINELEFT", "type": "number", "description": "(For vertical type) The underline is to the left of the text.", "access": "readonly", "value": "3" }, { "name": "UNDERLINEOFF", "type": "number", "description": "No underline.", "access": "readonly", "value": "1" }, { "name": "UNDERLINERIGHT", "type": "number", "description": "(For vertical type) The underline is to the right of the text.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Units", "kind": "Enumeration", "description": "The measurement unit for ruler increments.", "properties": [ { "name": "CM", "type": "number", "description": "Centimeters.", "access": "readonly", "value": "3" }, { "name": "INCHES", "type": "number", "description": "Inches.", "access": "readonly", "value": "2" }, { "name": "MM", "type": "number", "description": "Millimeters.", "access": "readonly", "value": "4" }, { "name": "PERCENT", "type": "number", "description": "Percent.", "access": "readonly", "value": "7" }, { "name": "PICAS", "type": "number", "description": "Picas.", "access": "readonly", "value": "6" }, { "name": "PIXELS", "type": "number", "description": "Pixels.", "access": "readonly", "value": "1" }, { "name": "POINTS", "type": "number", "description": "Points.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "Urgency", "kind": "Enumeration", "description": "The editorial urgency status of the artwork.", "properties": [ { "name": "FOUR", "type": "number", "description": "Level 4 (fourth highest)", "access": "readonly", "value": "4" }, { "name": "HIGH", "type": "number", "description": "Highest level of urgency.", "access": "readonly", "value": "8" }, { "name": "LOW", "type": "number", "description": "Low.", "access": "readonly", "value": "1" }, { "name": "NONE", "type": "number", "description": "No urgency.", "access": "readonly", "value": "0" }, { "name": "NORMAL", "type": "number", "description": "Medium urgency.", "access": "readonly", "value": "5" }, { "name": "SEVEN", "type": "number", "description": "Level 7 (second lowest)", "access": "readonly", "value": "7" }, { "name": "SIX", "type": "number", "description": "Level 6 (third lowest)", "access": "readonly", "value": "6" }, { "name": "THREE", "type": "number", "description": "Level 3 (third highest)", "access": "readonly", "value": "3" }, { "name": "TWO", "type": "number", "description": "Level 2 (second highest)", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "WarpStyle", "kind": "Enumeration", "description": "The warp style for text.", "properties": [ { "name": "ARC", "type": "number", "description": "The type is warped in the shape of an arc.", "access": "readonly", "value": "2" }, { "name": "ARCH", "type": "number", "description": "Text is warped in the form of an arch.", "access": "readonly", "value": "5" }, { "name": "ARCLOWER", "type": "number", "description": "Warp is heavier on the lower or left edge of the text than on the upper or right edge.", "access": "readonly", "value": "3" }, { "name": "ARCUPPER", "type": "number", "description": "Warp is heavier on the upper or right edge of the text than on the lower or left edge.", "access": "readonly", "value": "4" }, { "name": "BULGE", "type": "number", "description": "Text is warped outward on both the upper and lower or right and left edges.", "access": "readonly", "value": "6" }, { "name": "FISH", "type": "number", "description": "Text is warped in the shape of a fish.", "access": "readonly", "value": "11" }, { "name": "FISHEYE", "type": "number", "description": "Text bulges in the middle and is squeezed on the edges as if viewed through a fisheye lens.", "access": "readonly", "value": "13" }, { "name": "FLAG", "type": "number", "description": "Text is warped in the shape of a waving flag.", "access": "readonly", "value": "9" }, { "name": "INFLATE", "type": "number", "description": "Text is inflated.", "access": "readonly", "value": "14" }, { "name": "NONE", "type": "number", "description": "No warp.", "access": "readonly", "value": "1" }, { "name": "RISE", "type": "number", "description": "Text is warped in an undulating, rising pattern.", "access": "readonly", "value": "12" }, { "name": "SHELLLOWER", "type": "number", "description": "Text is warped downward or to the right in the shape of a fan-like seashell.", "access": "readonly", "value": "7" }, { "name": "SHELLUPPER", "type": "number", "description": "Text is warped upward or to the left in the shape of a fan-like seashell.", "access": "readonly", "value": "8" }, { "name": "SQUEEZE", "type": "number", "description": "Text is squeezed.", "access": "readonly", "value": "15" }, { "name": "TWIST", "type": "number", "description": "Text is twisted.", "access": "readonly", "value": "16" }, { "name": "WAVE", "type": "number", "description": "Text is warped in the shape of a wave.", "access": "readonly", "value": "10" } ], "events": [], "methods": [] }, { "name": "WaveType", "kind": "Enumeration", "description": "The type of wave.", "properties": [ { "name": "SINE", "type": "number", "description": "Rolling.", "access": "readonly", "value": "1" }, { "name": "SQUARE", "type": "number", "description": "Square.", "access": "readonly", "value": "3" }, { "name": "TRIANGULAR", "type": "number", "description": "Triangular.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "WhiteBalanceType", "kind": "Enumeration", "description": "The lighting conditions (affects color balance).", "properties": [ { "name": "ASSHOT", "type": "number", "description": "Use the settings of the camera as shot.", "access": "readonly", "value": "0" }, { "name": "AUTO", "type": "number", "description": "Automatically use the white balance settings.", "access": "readonly", "value": "1" }, { "name": "CLOUDY", "type": "number", "description": "Use the settings as shot on a cloudy day.", "access": "readonly", "value": "3" }, { "name": "CUSTOM", "type": "number", "description": "Use the custom settings for the shot parameters.", "access": "readonly", "value": "8" }, { "name": "DAYLIGHT", "type": "number", "description": "Use the settings as shot in daylight.", "access": "readonly", "value": "2" }, { "name": "FLASH", "type": "number", "description": "Use the settings as shot with a flash.", "access": "readonly", "value": "7" }, { "name": "FLUORESCENT", "type": "number", "description": "Use the settings as shot with fluorescent lighting.", "access": "readonly", "value": "6" }, { "name": "SHADE", "type": "number", "description": "Use the settings as shot in the shade.", "access": "readonly", "value": "4" }, { "name": "TUNGSTEN", "type": "number", "description": "Use the settings as shot with tungsten lighting.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "XMPMetadata", "kind": "Object", "description": "Camera raw image file settings stored in an XMP file in the same folder as the raw file with the same base name and an XMP extension.", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "rawData", "type": "string", "description": "The raw XML form of file information.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "ZigZagType", "kind": "Enumeration", "description": "The method of zigzagging.", "properties": [ { "name": "AROUNDCENTER", "type": "number", "description": "Pixels are rotated around the center of the selection.", "access": "readonly", "value": "1" }, { "name": "OUTFROMCENTER", "type": "number", "description": "Pixels are displaced toward or away from the center of the selection.", "access": "readonly", "value": "2" }, { "name": "PONDRIPPLES", "type": "number", "description": "Pixels are displaced to the upper left or lower right.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] } ] }