Photoshop_Scripting_Reference.md

layout
page

h1 {padding-bottom:2px; border-bottom:solid 2px black; margin:0;}
h1+p {font-weight:bold; font-size:0.8em; margin-top:1px;}
h2 {margin-top:0;}
#content {padding-right:8px;}
#content ul li {margin-bottom:1em;}
#content ul li ul li {margin-bottom:0;}
#sidebar h2 {font-size:1em;}
#sidebar ul {padding-left:0; margin-left:1.2em;}
#sidebar li {font-size:0.8em; white-space:nowrap;}
#sidebar .box {padding-left:8px; border-left:dashed 1px black;}
li {list-style-type:none;}
a {color:#000; text-decoration:none;}

</style> <style type="text/css" media="screen"> a {border-bottom:dotted 1px black;} a:hover {border-bottom:solid 1px black;} h2 span, h3 span {font-family:Courier; font-size:12px;} </style> <style type="text/css" media="print"> body {font-size:10pt;} h1 {font-size:24pt;} h2 {font-size:18pt;} h3 {font-size:14pt;} #sidebar {display:none;} </style> </script>

Adobe Photoshop CS.app terminology

/Applications/Adobe Photoshop CS/Adobe Photoshop CS.app

<a name="suite_AdobeScriptAutomation" id="suite_AdobeScriptAutomation"></a> <h2>AdobeScriptAutomation</h2> <p>Adobe Photoshop script execution menu</p> <h3>Commands</h3> <ul> <li> <a name="command_Scripts"></a> <strong>application.Scripts(...)</strong> -- Photoshop scripting support plug-in <ul> <li> [<em>AEType('#ImR')</em>] </li> <li> <strong>javascript_file=</strong><em>Text</em> -- The JavaScript file to execute </li> javascript_text=Text -- The JavaScript text to execute debugging=Boolean -- should the javascript be executed in debug mode? Result: None </li> </ul> </li> </ul> <a name="suite_Core_Suite" id="suite_Core_Suite"></a> <h2>Core Suite</h2> <p>Suite that applies to all applications</p> <h3>Commands</h3> <ul> <li> <a name="command_count"></a> <strong>reference.count(...)</strong> -- Return the number of elements of a particular class within an object <ul> <li> <strong>each=</strong><em>Type</em> -- the class of the elements to be counted. </li> <li> Result: <em>SInt32</em> -- the number of elements </li> </ul> </li> reference.delete() -- Remove an element from an object <li> Result: <em>None</em> </li> </ul> </li> reference.duplicate(...) -- Duplicate one or more object(s) <li> [<strong>to=</strong><em>InsertionLoc</em>] -- the new location for the object(s) </li> [with_properties=AERecord] -- new values for the properties of the duplicated element Result: ObjectSpecifier -- to the duplicated object(s) reference.exists() -- Verify if an object exists <li> Result: <em>Boolean</em> -- true if it exists, false if not </li> </ul> </li> application.make(...) -- Make a new element <li> <strong>new=</strong><em>Type</em> -- the class of the new element. </li> at=InsertionLoc -- the location at which to insert the element [with_data=Anything] -- the initial data for the element [with_properties=AERecord] -- the initial values for the properties of the element Result: ObjectSpecifier -- to the new object(s) reference.move(...) -- Move object(s) to a new location <li> <strong>to=</strong><em>InsertionLoc</em> -- the new location for the object(s) </li> <li> Result: <em>ObjectSpecifier</em> -- to the object(s) after they have been moved </li> </ul> </li> application.close(...) -- close the document k.document -- the document object or objects to be operated upon [saving=k.ask | k.no | k.yes] -- specifies whether changes should be saved before closing ( default: ask ) Result: None </li> </ul> </li> application.open(...) -- open the specified document file(s) Anything -- the file(s) to be opened [as=k.Acrobat_TouchUp_Image | k.Alias_PIX | k.BMP | k.CompuServe_GIF | k.Electric_Image | k.EPS | k.EPS_PICT_preview | k.EPS_TIFF_Preview | k.Filmstrip | k.JPEG | k.PCX | k.PDF | k.Photo_CD | k.Photoshop_DCS_10x2E0 | k.Photoshop_DCS_20x2E0 | k.Photoshop_EPS | k.Photoshop_format | k.Photoshop_PDF | k.PICT_file | k.PICT_resource | k.Pixar | k.PNG | k.Portable_Bitmap | k.raw | k.Scitex_CT | k.SGI_RGB | k.SoftImage | k.Targa | k.TIFF | k.Wavefront_RLA | k.Wireless_Bitmap] -- open document as the specified type [with_options=k.open_options] -- options for the file type specified [showing_dialogs=k.always | k.error_dialogs | k.never] -- should a dialog be displayed when a file is opened Result: None </li> </ul> </li> application.print_(...) -- print the specified object(s) Anything -- the file(s) or document(s) to be printed [postscript_encoding=k.ASCII | k.binary | k.JPEG] -- encoding type ( default: binary ) [source_space=k.document_space | k.proof_space] -- color space for source ( default: document space ) [print_space=UnicodeText] -- color space for printer. Can be nothing (meaning same as source); 'Working RGB', 'Working CMYK', 'Working Gray', 'Lab Color' (meaning one of the working spaces or Lab color); or a string specifying a specific colorspace (default is same as source) [intent=k.absolute_colorimetric | k.perceptual | k.relative_colorimetric | k.saturation_intent] -- if the print space is different from the source space, this argument will be used as the color conversion intent ( default: relative colorimetric ) [blackpoint_compensation=Boolean] -- if the print space is different from the source space, this argument indicates if the color conversion should use black point compensation ( default: true ) Result: None </li> </ul> </li> application.quit() -- quit the application <li> Result: <em>None</em> </li> </ul> </li> application.save(...) -- save the specified document k.document -- the document object or objects to be operated upon [in_=FSS] -- the file to save the document in [as=k.Alias_PIX | k.BMP | k.CompuServe_GIF | k.Electric_Image | k.JPEG | k.PCX | k.Photoshop_DCS_10x2E0 | k.Photoshop_DCS_20x2E0 | k.Photoshop_EPS | k.Photoshop_format | k.Photoshop_PDF | k.PICT_file | k.PICT_resource | k.Pixar | k.PNG | k.Portable_Bitmap | k.raw | k.Scitex_CT | k.SGI_RGB | k.SoftImage | k.Targa | k.TIFF | k.Wavefront_RLA | k.Wireless_Bitmap] -- the file type to save the document as [copying=Boolean] -- save as copy leaving original open. Unsaved files cannot be saved as copy [appending=k.lowercase_extension | k.no_extension | k.uppercase_extension] -- append an extension to the document name [with_options=k.save_options] -- options for the file type specified Result: k.document -- save the specified document <h3>Classes</h3> <ul> <li> <a name="class_application"></a> <strong>application</strong> -- The Adobe Photoshop application <ul> <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> background_color <em><a href="#class_color_value">k.color_value</a></em> </li> color_settings <em>Anything</em> -- name of selected color settings' set </li> current_document <em><a href="#class_document">k.document</a></em> -- the frontmost document </li> display_dialogs <em>k.always | k.error_dialogs | k.never</em> -- controls whether or not Photoshop displays dialogs </li> foreground_color <em><a href="#class_color_value">k.color_value</a></em> </li> free_memory (r/o) LongFloat -- the amount of unused memory available to Adobe Photoshop frontmost (r/o) Boolean -- is Photoshop the frontmost application? name (r/o) UnicodeText -- the application's name scripting_version (r/o) UnicodeText -- the version of the Scripting interface settings (r/o) k.settings_object -- preference settings version (r/o) UnicodeText -- the version of Adobe Photoshop application Elements: documents -- name | index | range | relative | test fonts -- name | index | range | relative | test document -- A document <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value index (r/o) SInt32 -- the index of this instance of the object properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> background_layer (r/o) k.art_layer -- background layer for the document. Only valid for documents that have a background layer bits_per_channel <em>k.eight | k.one | k.sixteen</em> -- number of bits per channel </li> color_profile_kind <em>k.custom | k.none | k.working</em> -- type of color profile management for document </li> color_profile_name <em>UnicodeText</em> -- name of color profile for document. Only valid for documents that have been assigned a color profile </li> component_channels (r/o) list of k.channel -- all color component channels for this document current_channels <em><a href="#class_channel">list of k.channel</a></em> -- selected channels for document </li> current_history_brush_source <em><a href="#class_history_state">k.history_state</a></em> -- the current history state to use with the history brush for this document </li> current_history_state <em><a href="#class_history_state">k.history_state</a></em> -- the current history state for this document </li> current_layer <em><a href="#class_layer">k.layer</a></em> -- selected layer for document </li> file_path (r/o) Alias -- full path name of document height (r/o) LongFloat -- height of document (unit value) histogram (r/o) list of SInt32 -- a histogram of values for the composite document (only for RGB, CMYK and 'Indexed colors' documents) info (r/o) k.info_object -- document information initial_fill (r/o) k.transparent | k.use_background_color | k.white -- initial fill of the document. Only valid when used as an option with the 'make new document' command managed (r/o) Boolean -- is the document a workgroup document? mode (r/o) k.bitmap | k.CMYK | k.duotone | k.grayscale | k.indexed_color | k.Lab | k.multichannel | k.RGB -- document mode modified (r/o) Boolean -- has the document been modified since last save? name (r/o) UnicodeText -- the document's name pixel_aspect_ratio <em>LongFloat</em> -- the pixel aspect ration of the document </li> quick_mask_mode <em>Boolean</em> -- is the document in the quick mask mode? </li> resolution (r/o) LongFloat -- the resolution of the document (in pixels per inch) selection (r/o) k.selection_object -- the document's selection width (r/o) LongFloat -- width of document (unit value) XMP_metadata (r/o) k.XMP_metadata </li> </ul> </li> <li>Elements: <ul> <li> <strong><a href="#class_art_layer">art_layers</a></strong> -- <em>name | index | range | relative | test</em> </li> channels -- name | index | range | relative | test history_states -- name | index | range | relative | test layer_comps -- name | index | range | relative | test layers -- name | index | range | relative | test layer_sets -- name | index | range | relative | test path_items -- name | index | range | relative | test <a name="suite_Photoshop_Suite" id="suite_Photoshop_Suite"></a> <h2>Photoshop Suite</h2> <p>Scripting commands and classes for Adobe Photoshop</p> <h3>Commands</h3> <ul> <li> <a name="command_apply"></a> <strong>application.apply(...)</strong> -- apply the layer comp to the document <ul> <li> <em>k.layer_comp</em> -- the layer comp object or objects to be operated upon </li> <li> Result: <em>None</em> </li> </ul> </li> application.apply_layer_style(...) <ul> <li> <em>k.art_layer</em> -- the art layer object or objects to be operated upon </li> <li> <strong>using=</strong><em>UnicodeText</em> -- name of the layer style to apply </li> <li> Result: <em>None</em> </li> </ul> </li> application.change_mode(...) -- change the mode of the document k.document -- the document object or objects to be operated upon to=k.bitmap | k.CMYK | k.grayscale | k.indexed_color | k.Lab | k.multichannel | k.RGB -- name of mode to change to [with_options=k.change_mode_options] -- options for changing the mode Result: None </li> </ul> </li> application.contract(...) -- contracts the selection k.selection_object -- the selection-object object or objects to be operated upon by=LongFloat -- distance to contract the selection by (unit value) Result: None </li> </ul> </li> application.convert(...) -- convert the document from using one color profile to using an other k.document -- the document object or objects to be operated upon to_profile=UnicodeText -- name of color profile to convert to. Either a string specifying a specific color profile or 'Working RGB', 'Working CMYK', 'Working Gray', 'Lab Color' meaning one of the working color spaces or Lab color intent=k.absolute_colorimetric | k.perceptual | k.relative_colorimetric | k.saturation_intent -- conversion intent [blackpoint_compensation=Boolean] -- use black point compensation? [dithering=Boolean] -- use dither? ( default: true ) Result: None </li> </ul> </li> application.convert_to_shape(...) -- converts the text item and its containing layer to a fill layer with the text changed to a clipping path k.text_object -- the text-object object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.create_PDF_presentation(...) -- create a PDF presentation file <li> <strong>from_files=</strong><em>list of Alias</em> -- list of input files to include in the output </li> to_file=FSS -- location of the output file [with_options=k.presentation_options] -- options for the PDF presentation Result: UnicodeText -- create a PDF presentation file application.create_photo_gallery(...) -- create a web photo gallery <li> <strong>from_folder=</strong><em>Alias</em> -- folder of files to process </li> to_folder=Alias -- location for output files [with_options=k.gallery_options] -- options for the web photo gallery Result: UnicodeText -- create a web photo gallery application.create_work_path(...) -- creates a work path based on the text object k.text_object -- the text-object object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.crop(...) -- crop the document k.document -- the document object or objects to be operated upon bounds=AEList -- area to crop (unit value) [angle=LongFloat] -- angle of cropping bounds ( default: 0.0 ) [width=LongFloat] -- width of resulting document (unit value) [height=LongFloat] -- height of resulting document (unit value) Result: None </li> </ul> </li> application.deselect(...) <ul> <li> <em>k.document</em> -- the document object or objects to be operated upon </li> <li> Result: <em>None</em> </li> </ul> </li> application.expand(...) -- expand selection k.selection_object -- the selection-object object or objects to be operated upon by=LongFloat -- distance to expand the selection by (unit value) Result: None </li> </ul> </li> application.export(...) <ul> <li> <em>k.document</em> -- the document object or objects to be operated upon </li> <li> <strong>in_=</strong><em>FSS</em> -- the file to export to </li> [as=k.Illustrator_paths] -- the type of export ( default: Illustrator paths ) [with_options=k.Illustrator_paths_export_options] -- options for the export type specified Result: None </li> </ul> </li> application.feather(...) -- feather edges of selection k.selection_object -- the selection-object object or objects to be operated upon by=LongFloat -- amount to feather the edge by (unit value) Result: None </li> </ul> </li> application.fill(...) -- fills the selection k.selection_object -- the selection-object object or objects to be operated upon with_contents=Anything -- a color or a history state [blend_mode=k.behind_mode | k.clear_mode | k.color_blend | k.color_burn | k.color_dodge | k.darken | k.difference | k.dissolve | k.exclusion | k.hard_light | k.hue_blend | k.lighten | k.linear_burn | k.linear_dodge | k.linear_light | k.luminosity | k.multiply | k.normal | k.overlay | k.pin_light | k.saturation_blend | k.screen | k.soft_light | k.vivid_light] -- ( default: normal ) [opacity=SInt32] -- ( default: 100 ) [preserving_transparency=Boolean] </li> <li> Result: <em>None</em> </li> </ul> </li> application.flatten(...) -- flatten all layers in the document k.document -- the document object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.flip_canvas(...) -- flip the canvas horizontally or vertically k.document -- the document object or objects to be operated upon direction=k.horizontal | k.vertical -- which way to flip the canvas Result: None </li> </ul> </li> application.grow(...) -- grow selection to include all adjacent pixels falling within the specified tolerance range k.selection_object -- the selection-object object or objects to be operated upon tolerance=SInt32 -- ( 0 - 255 ) antialiasing=Boolean </li> <li> Result: <em>None</em> </li> </ul> </li> application.import_annotations(...) -- import annotations into the document k.document -- the document object or objects to be operated upon from_=Alias -- document to import annotations from Result: None </li> </ul> </li> application.invert(...) -- invert the selection k.selection_object -- the selection-object object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.link(...) -- link the layer with another layer k.layer -- the layer object or objects to be operated upon with=k.layer -- layer to link to Result: None </li> </ul> </li> application.load(...) -- load the selection from a channel k.selection_object -- the selection-object object or objects to be operated upon from_=k.channel -- the channel to load the selection from [combination_type=k.diminished | k.extended | k.intersected | k.replaced] -- how to combine the channel contents with the existing selection ( default: replaced ) [inverting=Boolean] -- select the inverse of the channel contents? ( default: false ) Result: None </li> </ul> </li> application.make_work_path(...) -- make this selection item the work path for this document k.selection_object -- the selection-object object or objects to be operated upon [tolerance=LongFloat] -- tolerance in pixels Result: None </li> </ul> </li> application.merge(...) -- merge an art layer, layer set or a spot channel. Merging a layer returns a reference to the resulting layer. Merging a channel does not return any value k.channel -- the channel object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.merge_visible_layers(...) -- flatten all visible layers in the document k.document -- the document object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.purge(...) -- purges one or more caches k.all_caches | k.clipboard_cache | k.history_caches | k.undo_caches -- what to purge <li> Result: <em>None</em> </li> </ul> </li> application.rasterize(...) <ul> <li> <em>k.art_layer</em> -- the art layer object or objects to be operated upon </li> <li> <strong>affecting=</strong><em>k.all_linked_layers | k.entire_layer | k.fill_content | k.layer_clipping_path | k.shape | k.text_contents</em> -- what to rasterize </li> <li> Result: <em>None</em> </li> </ul> </li> application.recapture(...) -- recapture the current layer state(s) for this layer comp k.layer_comp -- the layer comp object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.reset_from_comp(...) -- reset the layer comp state to the document state k.layer_comp -- the layer comp object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.resize_canvas(...) -- change the size of the canvas k.document -- the document object or objects to be operated upon [width=LongFloat] -- desired width of canvas (unit value) [height=LongFloat] -- desired height of canvas (unit value) [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- anchor to resize around ( default: middle center ) Result: None </li> </ul> </li> application.resize_image(...) -- change the size of the image k.document -- the document object or objects to be operated upon [width=LongFloat] -- desired width of image (unit value) [height=LongFloat] -- desired height of image (unit value) [resolution=LongFloat] -- (in pixels per inch) [resample_method=k.bicubic | k.bicubic_sharper | k.bicubic_smoother | k.bilinear | k.closest_neighbor | k.none] -- what method should be used for resampling pixels ( default: bicubic ) Result: None </li> </ul> </li> application.reveal_all(...) -- expand document to show clipped sections k.document -- the document object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.rotate(...) <ul> <li> <em>k.layer</em> -- the layer object or objects to be operated upon </li> <li> <strong>angle=</strong><em>LongFloat</em> </li> [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to rotate about ( default: middle center ) Result: None </li> </ul> </li> application.rotate_boundary(...) -- rotates the boundary of selection k.selection_object -- the selection-object object or objects to be operated upon angle=LongFloat </li> [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to rotate about ( default: middle center ) Result: None </li> </ul> </li> application.rotate_canvas(...) -- rotate canvas of document k.document -- the document object or objects to be operated upon angle=LongFloat -- number of degrees to rotate. A positive angle will rotate the canvas clockwise; a negative value will rotate the canvas counter-clockwise Result: None </li> </ul> </li> application.scale(...) <ul> <li> <em>k.layer</em> -- the layer object or objects to be operated upon </li> <li> [<strong>horizontal_scale=</strong><em>LongFloat</em>] -- percentage ( default: 100.0 ) </li> [vertical_scale=LongFloat] -- percentage ( default: 100.0 ) [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to rotate about ( default: middle center ) Result: None </li> </ul> </li> application.scale_boundary(...) -- scale the boundary of selection k.selection_object -- the selection-object object or objects to be operated upon [horizontal_scale=LongFloat] -- percentage ( default: 100.0 ) [vertical_scale=LongFloat] -- percentage ( default: 100.0 ) [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to scale about ( default: middle center ) Result: None </li> </ul> </li> application.select(...) -- change the selection k.document -- the document object or objects to be operated upon region=list of Anything -- list of corners of the selection (in pixels) [combination_type=k.diminished | k.extended | k.intersected | k.replaced] -- how to combine the new selection with the existing selection ( default: replaced ) [feather_amount=LongFloat] -- feather amount ( default: 0.0 ) [antialiasing=Boolean] -- whether to use antialiasing ( default: true ) Result: None </li> </ul> </li> application.select_all(...) -- select the entire image k.document -- the document object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> application.select_border(...) -- select the border of the selection k.selection_object -- the selection-object object or objects to be operated upon width=LongFloat -- width of border selection (unit value) Result: None </li> </ul> </li> application.similar(...) -- grow selection to include pixels throughout the image falling within the tolerance range k.selection_object -- the selection-object object or objects to be operated upon tolerance=SInt32 </li> antialiasing=Boolean </li> <li> Result: <em>None</em> </li> </ul> </li> application.smooth(...) <ul> <li> <em>k.selection_object</em> -- the selection-object object or objects to be operated upon </li> <li> <strong>radius=</strong><em>SInt32</em> -- sample radius in pixels ( 0 - 100 ) </li> <li> Result: <em>None</em> </li> </ul> </li> application.split_channels(...) -- split channels of the document k.document -- the document object or objects to be operated upon <li> Result: <em>list of k.document</em> -- split channels of the document </li> </ul> </li> application.store(...) -- save the selection as a channel k.selection_object -- the selection-object object or objects to be operated upon into=k.channel -- the channel to save the selection to [combination_type=k.diminished | k.extended | k.intersected | k.replaced] -- how to add the selection to the existing contents of the channel ( default: replaced ) Result: None </li> </ul> </li> application.stroke(...) -- strokes the selection k.selection_object -- the selection-object object or objects to be operated upon using_color=Anything -- color to stroke selection with width=SInt32 -- width of stroke (in pixels) [location=k.center | k.inside | k.outside] -- ( default: center ) [blend_mode=k.behind_mode | k.clear_mode | k.color_blend | k.color_burn | k.color_dodge | k.darken | k.difference | k.dissolve | k.exclusion | k.hard_light | k.hue_blend | k.lighten | k.linear_burn | k.linear_dodge | k.linear_light | k.luminosity | k.multiply | k.normal | k.overlay | k.pin_light | k.saturation_blend | k.screen | k.soft_light | k.vivid_light] -- ( default: normal ) [opacity=SInt32] -- ( default: 100 ) [preserving_transparency=Boolean] </li> <li> Result: <em>None</em> </li> </ul> </li> application.translate(...) -- moves the position relative to its current position k.layer -- the layer object or objects to be operated upon [delta_x=LongFloat] -- horizontal transformation (unit value) [delta_y=LongFloat] -- vertical transformation (unit value) Result: None </li> </ul> </li> application.translate_boundary(...) -- moves the boundary of selection relative to its current position k.selection_object -- the selection-object object or objects to be operated upon [delta_x=LongFloat] -- horizontal transformation (unit value) [delta_y=LongFloat] -- vertical transformation (unit value) Result: None </li> </ul> </li> application.trap(...) -- apply trap to a CMYK document k.document -- the document object or objects to be operated upon width=SInt32 -- trap width in pixels Result: None </li> </ul> </li> application.trim(...) <ul> <li> <em>k.document</em> -- the document object or objects to be operated upon </li> <li> [<strong>basing_trim_on=</strong><em>k.bottom_right_pixel | k.top_left_pixel | k.transparent_pixels</em>] -- color or type of pixels to base trim on ( default: top left pixel ) </li> [top_trim=Boolean] -- trim away top of document ( default: true ) [left_trim=Boolean] -- trim away left of document ( default: true ) [bottom_trim=Boolean] -- trim away bottom of document ( default: true ) [right_trim=Boolean] -- trim away right of document ( default: true ) Result: None </li> </ul> </li> application.unlink(...) -- unlink the layer k.layer -- the layer object or objects to be operated upon <li> Result: <em>None</em> </li> </ul> </li> </ul> <h3>Classes</h3> <ul> <li> <a name="class_art_layer"></a> <strong>art_layer</strong> -- any layer that can contain data <ul> <li>Parent: <ul> <li><em><a href="#class_layer">layer</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>properties</strong> <em>AERecord</em> -- all of this object's properties returned in a single record </li> background_layer <em>Boolean</em> -- is the layer a background layer? </li> fill_opacity <em>LongFloat</em> -- the interior opacity of the layer (between 0.0 and 100.0) </li> grouped <em>Boolean</em> -- is the layer grouped with the layer below?. Photoshop CS changed the menu name to Create/Release Clipping Mask </li> kind <em>k.brightness_contrast_layer | k.channel_mixer_layer | k.color_balance_layer | k.curves_layer | k.gradient_fill_layer | k.gradient_map_layer | k.hue_saturation_layer | k.inversion_layer | k.levels_layer | k.normal | k.pattern_fill_layer | k.posterize_layer | k.selective_color_layer | k.solid_fill_layer | k.text_layer | k.threshold_layer</em> -- to create a text layer set this property to 'text layer' on an empty art layer of type 'normal' </li> pixels_locked <em>Boolean</em> </li> position_locked <em>Boolean</em> </li> text_object (r/o) k.text_object -- the text item that is associated with the art layer. Only valid for art layers whose 'has text' is true transparent_pixels_locked <em>Boolean</em> </li> </ul> </li> </ul> </li> Bitmap_mode_options -- Settings related to changing the document mode to Bitmap Parent: change_mode_options <li>Properties: <ul> <li> <strong>angle</strong> <em>LongFloat</em> -- only valid for 'halftone screen' conversions </li> conversion_method <em>k.custom_pattern | k.diffusion_dither | k.halftone_screen_conversion | k.middle_threshold | k.pattern_dither</em> -- ( default: diffusion dither ) </li> frequency <em>LongFloat</em> -- only valid for 'halftone screen' conversions </li> pattern_name <em>UnicodeText</em> -- only valid for 'custom pattern' conversions </li> resolution <em>LongFloat</em> -- output resolution (in pixels per inch) </li> screen_shape <em>k.halftone_cross | k.halftone_diamond | k.halftone_ellipse | k.halftone_line | k.halftone_round | k.halftone_square</em> -- only valid for 'halftone screen' conversions </li> </ul> </li> </ul> </li> change_mode_options -- used with options on the 'change mode' command <li>Children: <ul> <li><em><a href="#class_indexed_mode_options">indexed_mode_options</a></em></li> Bitmap_mode_options </ul> </li> channel -- A channel in a document. Can be either a component channel representing a color of the document color model or an alpha channel <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value index (r/o) SInt32 -- the index of this instance of the object properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> channel_color <em><a href="#class_color_value">k.color_value</a></em> -- color of the channel (not valid for component channels) </li> container (r/o) ObjectSpecifier -- the object's container histogram (r/o) list of SInt32 -- a histogram of values for the channel kind <em>k.component_channel | k.masked_area_channel | k.selected_area_channel | k.spot_color_channel</em> -- type of the channel </li> name <em>UnicodeText</em> -- the channel's name </li> opacity <em>LongFloat</em> -- opacity of alpha channels (called solidity for spot channels) </li> visible <em>Boolean</em> </li> </ul> </li> </ul> </li> font -- An installed font <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value index (r/o) SInt32 -- the index of this instance of the object properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> family (r/o) UnicodeText -- the font's family name (r/o) UnicodeText -- The font's text face name PostScript_name (r/o) UnicodeText -- the font's PostScript name style (r/o) UnicodeText -- the font's style name </ul> </li> gallery_banner_options -- options for the web photo gallery banner options <li>Properties: <ul> <li> <strong>contact_info</strong> <em>UnicodeText</em> -- web photo gallery contact info ( default: ) </li> date <em>UnicodeText</em> -- web photo gallery date ( default: ) </li> font <em>k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman</em> -- the font setting for the banner text ( default: Arial ) </li> font_size <em>SInt32</em> -- the size of the font for the banner text ( 1 - 7; default: 3 ) </li> photographer <em>UnicodeText</em> -- web photo gallery photographer ( default: ) </li> site_name <em>UnicodeText</em> -- web photo gallery site name ( default: Adobe Web Photo Gallery ) </li> </ul> </li> </ul> </li> gallery_color_options -- options for the web photo gallery colors <li>Properties: <ul> <li> <strong>active_link_color</strong> <em><a href="#class_RGB_color">k.RGB_color</a></em> -- active link color </li> background_color <em><a href="#class_RGB_color">k.RGB_color</a></em> -- background color </li> banner_color <em><a href="#class_RGB_color">k.RGB_color</a></em> -- banner color </li> link_color <em><a href="#class_RGB_color">k.RGB_color</a></em> -- link color </li> text_color <em><a href="#class_RGB_color">k.RGB_color</a></em> -- text color </li> visited_link_color <em><a href="#class_RGB_color">k.RGB_color</a></em> -- visited link color </li> </ul> </li> </ul> </li> gallery_images_options -- options for the web photo gallery images <li>Properties: <ul> <li> <strong>border</strong> <em>SInt32</em> -- the amount of border pixels you want between your images ( 0 - 99; default: 0 ) </li> caption <em>Boolean</em> -- generate a caption for the images ( default: false ) </li> dimension <em>SInt32</em> -- resized image dimensions in pixels ( default: 350 ) </li> font <em>k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman</em> -- font for the gallery images text ( default: Arial ) </li> font_size <em>SInt32</em> -- font size for the gallery images text ( 1 - 7; default: 3 ) </li> image_quality <em>SInt32</em> -- the quality setting for the JPEG image ( 0 - 12; default: 5 ) </li> include_copyright <em>Boolean</em> -- include the copyright in the text for the gallery images ( default: false ) </li> include_credits <em>Boolean</em> -- include the credits in the text for the gallery images ( default: false ) </li> include_file_name <em>Boolean</em> -- include the file name in the text for the gallery images ( default: true ) </li> include_title <em>Boolean</em> -- include the title in the text for the gallery images ( default: false ) </li> numeric_links <em>Boolean</em> -- add numeric links ( default: true ) </li> resize_constraint <em>k.constrain_both | k.constrain_height | k.constrain_width</em> -- how should the image be constrained ( default: constrain both ) </li> resize_images <em>Boolean</em> -- resize images data ( default: true ) </li> </ul> </li> </ul> </li> gallery_options -- options for the web photo gallery command <li>Properties: <ul> <li> <strong>banner_options</strong> <em><a href="#class_gallery_banner_options">k.gallery_banner_options</a></em> -- options related to banner settings </li> custom_color_options <em><a href="#class_gallery_color_options">k.gallery_color_options</a></em> -- options related to custom color settings </li> email_address <em>UnicodeText</em> -- the email address to show on the web page ( default: ) </li> images_options <em><a href="#class_gallery_images_options">k.gallery_images_options</a></em> -- options related to images settings </li> layout_style <em>UnicodeText</em> -- the style to use for laying out the web page ( default: Centered Frame 1 - Basic ) </li> preserve_all_metadata <em>Boolean</em> -- save all of the metadata in the JPEG files ( default: false ) </li> security_options <em><a href="#class_gallery_security_options">k.gallery_security_options</a></em> -- options related to security settings </li> short_extension <em>Boolean</em> -- short web page extension .htm or long web page extension .html ( default: true ) </li> size_attributes <em>Boolean</em> -- add width and height attributes for images ( default: true ) </li> sub_folders <em>Boolean</em> -- include all files found in sub folders of the input folder ( default: true ) </li> thumbnail_options <em><a href="#class_gallery_thumbnail_options">k.gallery_thumbnail_options</a></em> -- options related to thumbnail settings </li> UTF8_encoding <em>Boolean</em> -- web page should use UTF-8 encoding ( default: false ) </li> </ul> </li> </ul> </li> gallery_security_options -- options for the web photo gallery security <li>Properties: <ul> <li> <strong>content</strong> <em>k.gallery_caption | k.gallery_copyright | k.gallery_credit | k.gallery_custom_text | k.gallery_filename | k.gallery_none | k.gallery_title</em> -- web photo gallery security content ( default: gallery none ) </li> custom_text <em>UnicodeText</em> -- web photo gallery security custom text ( default: ) </li> font <em>k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman</em> -- web photo gallery security font ( default: Arial ) </li> font_size <em>SInt32</em> -- web photo gallery security font size ( minimum 1; default: 36 ) </li> opacity <em>SInt32</em> -- web page security opacity as a percent ( default: 100 ) </li> text_color <em><a href="#class_RGB_color">k.RGB_color</a></em> -- web page security text color </li> text_position <em>k.gallery_centered | k.gallery_lower_left | k.gallery_lower_right | k.gallery_upper_left | k.gallery_upper_right</em> -- web photo gallery security text position ( default: gallery centered ) </li> text_rotate <em>k.clock_wise_45 | k.clock_wise_90 | k.counter_clock_wise_45 | k.counter_clock_wise_90 | k.zero</em> -- web photo gallery security text rotate ( default: zero ) </li> </ul> </li> </ul> </li> gallery_thumbnail_options -- options for the web photo gallery thumbnail creation <li>Properties: <ul> <li> <strong>border</strong> <em>SInt32</em> -- the amount of border pixels you want around your thumbnail images ( 0 - 99; default: 0 ) </li> caption <em>Boolean</em> -- with caption ( default: false ) </li> column_count <em>SInt32</em> -- web photo gallery thumbnail columns ( default: 5 ) </li> dimension <em>SInt32</em> -- web photo gallery thumbnail dimension in pixels ( default: 75 ) </li> font <em>k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman</em> -- web photo gallery font ( default: Arial ) </li> font_size <em>SInt32</em> -- the size of the font for the thumbnail images text ( 1 - 7; default: 3 ) </li> include_copyright <em>Boolean</em> -- include copyright for thumbnail ( default: false ) </li> include_credits <em>Boolean</em> -- include credits for thumbnail ( default: false ) </li> include_file_name <em>Boolean</em> -- include file name for thumbnail ( default: false ) </li> include_title <em>Boolean</em> -- include title for thumbnail ( default: false ) </li> row_count <em>SInt32</em> -- web photo gallery thumbnail rows ( default: 3 ) </li> size <em>k.gallery_custom | k.gallery_large | k.gallery_medium | k.gallery_small</em> -- the size of the thumbnail images ( default: gallery medium ) </li> </ul> </li> </ul> </li> history_state -- A history state for the document <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value index (r/o) SInt32 -- the index of this instance of the object properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> container (r/o) ObjectSpecifier -- the object's container name (r/o) UnicodeText -- the history state's name snapshot (r/o) Boolean -- is the history state a snapshot? </ul> </li> Illustrator_paths_export_options -- Settings related to exporting Illustrator paths <li>Properties: <ul> <li> <strong>path_name</strong> <em>UnicodeText</em> -- name of path to export. Only valid if you are exporting a named path </li> target_path <em>k.all_paths | k.document_bounds | k.named_path</em> -- which path to export ( default: document bounds ) </li> </ul> </li> </ul> </li> indexed_mode_options -- Settings related to changing the document mode to Indexed Parent: change_mode_options <li>Properties: <ul> <li> <strong>colors_in_palette</strong> <em>SInt32</em> -- number of colors in palette (only settable for some palette types) </li> dither <em>k.diffusion | k.noise | k.none | k.pattern</em> -- type of dither </li> dither_amount <em>SInt32</em> -- amount of dither. Only valid for diffusion ( 1 - 100 ) </li> forced_colors <em>k.black_and_white | k.none | k.primaries | k.web</em> </li> matte <em>k.background_color_matte | k.black_matte | k.foreground_color_matte | k.Netscape_gray | k.none | k.semi_gray | k.white_matte</em> </li> palette <em>k.exact | k.local_adaptive | k.local_perceptual | k.local_selective | k.Mac_OS_system | k.master_adaptive | k.master_perceptual | k.master_selective | k.previous_ | k.uniform | k.web | k.Windows_system</em> -- Type of palette ( default: exact ) </li> preserve_exact_colors <em>Boolean</em> </li> transparency <em>Boolean</em> </li> </ul> </li> </ul> </li> info_object -- Document information <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> author <em>UnicodeText</em> </li> author_position <em>UnicodeText</em> </li> caption <em>UnicodeText</em> </li> caption_writer <em>UnicodeText</em> </li> category <em>UnicodeText</em> </li> city <em>UnicodeText</em> </li> container (r/o) ObjectSpecifier -- the object's container copyright_notice <em>UnicodeText</em> </li> copyrighted <em>k.copyrighted_work | k.public_domain | k.unmarked</em> </li> country <em>UnicodeText</em> </li> creation_date <em>UnicodeText</em> </li> credit <em>UnicodeText</em> </li> EXIF (r/o) list of Anything </li> headline <em>UnicodeText</em> </li> instructions <em>UnicodeText</em> </li> job_name <em>UnicodeText</em> </li> keywords <em>list of UnicodeText</em> -- list of keywords </li> owner_url <em>UnicodeText</em> </li> province_or_state <em>UnicodeText</em> </li> source <em>UnicodeText</em> </li> supplemental_categories <em>list of UnicodeText</em> </li> title <em>UnicodeText</em> </li> transmission_reference <em>UnicodeText</em> </li> urgency <em>k.four | k.high | k.low | k.none | k.normal | k.seven | k.six | k.three | k.two</em> </li> </ul> </li> </ul> </li> layer -- A layer object <li>Children: <ul> <li><em><a href="#class_layer_set">layer_set</a></em></li> art_layer Properties: best_type (r/o) Type -- the best type for the object's value class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value index (r/o) SInt32 -- the index of this instance of the object properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> all_locked <em>Boolean</em> </li> blend_mode <em>k.color_blend | k.color_burn | k.color_dodge | k.darken | k.difference | k.dissolve | k.exclusion | k.hard_light | k.hue_blend | k.lighten | k.linear_burn | k.linear_dodge | k.linear_light | k.luminosity | k.multiply | k.normal | k.overlay | k.pass_through | k.pin_light | k.saturation_blend | k.screen | k.soft_light | k.vivid_light</em> </li> bounds (r/o) AEList -- Bounding rectangle of the Layer container (r/o) ObjectSpecifier -- the object's container linked_layers (r/o) list of k.layer </li> name <em>UnicodeText</em> -- the name of the layer </li> opacity <em>LongFloat</em> -- master opacity of layer ( 0.0 - 100.0 ) </li> visible <em>Boolean</em> </li> </ul> </li> </ul> </li> layer_comp -- A layer composition in a document <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value index (r/o) SInt32 -- the index of this instance of the object properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> appearance <em>Boolean</em> -- use layer appearance </li> comment <em>Anything</em> -- the description of the layer comp </li> container (r/o) ObjectSpecifier -- the object's container name <em>UnicodeText</em> -- the name of the layer comp </li> position <em>Boolean</em> -- use layer position </li> selected (r/o) Boolean -- the layer comp is currently selected visibility <em>Boolean</em> -- use layer visibility </li> </ul> </li> </ul> </li> layer_set -- Layer set Parent: layer <li>Properties: <ul> <li> <strong>properties</strong> <em>AERecord</em> -- all of this object's properties returned in a single record </li> enabled_channels <em><a href="#class_channel">list of k.channel</a></em> -- channels that are enabled for the layer set. Must be a list of component channels </li> </ul> </li> <li>Elements: <ul> <li> <strong><a href="#class_art_layer">art_layers</a></strong> -- <em>name | index | range | relative | test</em> </li> layers -- name | index | range | relative | test layer_sets -- name | index | range | relative | test presentation_options -- options for the PDF presentation command <li>Properties: <ul> <li> <strong>auto_advance</strong> <em>Boolean</em> -- auto advance when viewing ( default: true ) </li> downgrade_color_profile <em>Boolean</em> -- should the embedded color profile be downgraded to version 2 ( default: false ) </li> embed_fonts <em>Boolean</em> -- embed fonts? Only valid if a text layer is included ( default: false ) </li> encoding <em>k.JPEG | k.ZIP</em> -- ( default: ZIP ) </li> image_interpolation <em>Boolean</em> -- use image interpolation? ( default: false ) </li> interval <em>SInt32</em> -- time in seconds before auto advancing the view ( default: 5 ) </li> JPEG_quality <em>SInt32</em> -- quality of produced image. Only valid for JPEG encoded PDF documents ( 0 - 12; default: 10 ) </li> loop <em>Boolean</em> -- loop after last page ( default: false ) </li> presentation <em>Boolean</em> -- true if the file type is presentation false for Multi-Page document ( default: false ) </li> transition <em>k.blinds_horizontal | k.blinds_vertical | k.box_in | k.box_out | k.dissolve | k.glitter_down | k.glitter_right | k.glitter_right_down | k.none | k.random | k.split_horizontal_in | k.split_horizontal_out | k.split_vertical_in | k.split_vertical_out | k.wipe_down | k.wipe_left | k.wipe_right | k.wipe_up</em> -- transition type when switching to the next document ( default: none ) </li> transparency <em>Boolean</em> -- ( default: true ) </li> vector_data <em>Boolean</em> -- include vector data ( default: false ) </li> view <em>Boolean</em> -- view the document after saving ( default: false ) </li> </ul> </li> </ul> </li> selection_object -- The selection of the document <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> container (r/o) ObjectSpecifier -- the object's container </ul> </li> settings_object -- Preferences for Photoshop <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> additional_plugin_folder <em>Alias</em> </li> append_extension <em>k.ask | k.no | k.yes</em> </li> ask_before_saving_layered_TIFF <em>Boolean</em> </li> auto_update_open_documents <em>Boolean</em> </li> beep_when_done <em>Boolean</em> </li> cache_levels <em>SInt32</em> </li> color_picker <em>k.Adobe_color_picker | k.Apple_color_picker | k.plug_in_color_picker | k.Windows_color_picker</em> </li> column_gutter <em>LongFloat</em> -- gutter of columns (in points) </li> column_width <em>LongFloat</em> -- width of columns (in points) </li> create_first_snapshot <em>Boolean</em> -- automatically make first snapshot when a new document is created? </li> display_color_channels_in_color <em>Boolean</em> </li> dynamic_color_sliders <em>Boolean</em> </li> edit_log_items <em>k.concise | k.detailed | k.sessiononly</em> -- options for edit log items </li> export_clipboard <em>Boolean</em> </li> full_size_preview <em>Boolean</em> </li> gamut_warning_opacity <em>LongFloat</em> </li> grid_size <em>k.large | k.medium | k.none | k.small</em> </li> grid_style <em>k.dashed_line | k.dotted_line | k.solid_line</em> </li> grid_subdivisions <em>SInt32</em> </li> guide_style <em>k.dashed_line | k.solid_line</em> </li> icon_preview <em>Boolean</em> </li> image_previews <em>k.ask | k.no | k.yes</em> </li> interpolation_method <em>k.bicubic | k.bicubic_sharper | k.bicubic_smoother | k.bilinear | k.closest_neighbor | k.none</em> </li> keyboard_zoom_resizes_windows <em>Boolean</em> </li> Mac_OS_thumbnail <em>Boolean</em> </li> maximize_compatibility <em>k.always | k.ask | k.never</em> -- maximize compatibility for Photoshop (PSD) files </li> maximum_RAM_use <em>SInt32</em> -- Maximum percentage of available RAM used by Photoshop ( 5 - 100 ) </li> nonlinear_history <em>Boolean</em> -- allow non-linear history? </li> number_of_history_states <em>SInt32</em> -- number of history states to remember (between 1 and 100) </li> other_cursors <em>k.precise | k.standard</em> </li> painting_cursors <em>k.brush_size | k.precise | k.standard</em> </li> pixel_doubling <em>Boolean</em> </li> point_size <em>k.postscript_size | k.traditional_size</em> -- size of point/pica </li> recent_file_list_length <em>SInt32</em> -- number of items in the recent file list (between 0 and 30) </li> ruler_units <em>k.cm_units | k.inch_units | k.mm_units | k.percent_units | k.pica_units | k.pixel_units | k.point_units</em> -- Note: this is the unit that the scripting system will use when receiving and returning values </li> save_log_items <em>k.both | k.log_file | k.metadata</em> -- options for saving the history items </li> save_log_items_file <em>Alias</em> -- file to save the history log </li> save_palette_locations <em>Boolean</em> </li> show_Asian_text_options <em>Boolean</em> </li> show_English_font_names <em>Boolean</em> </li> show_slice_numbers <em>Boolean</em> </li> show_tool_tips <em>Boolean</em> </li> smart_quotes <em>Boolean</em> </li> type_units <em>k.mm_units | k.pixel_units | k.point_units</em> </li> use_additional_plugin_folder <em>Boolean</em> </li> use_cache_for_histograms <em>Boolean</em> </li> use_diffusion_dither <em>Boolean</em> </li> use_history_log <em>Boolean</em> -- Turn on and off the history logging </li> use_lowercase_extension <em>Boolean</em> -- should the file extension be lowercase </li> use_Shift_key_for_tool_switch <em>Boolean</em> </li> use_video_alpha <em>Boolean</em> -- this option requires hardware support </li> Windows_thumbnail <em>Boolean</em> </li> </ul> </li> </ul> </li> text_object -- Text item contained in an art layer <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> alternate_ligatures <em>Boolean</em> -- use alternate ligatures? </li> antialias_method <em>k.crisp | k.none | k.sharp | k.smoothing | k.strong</em> </li> auto_kerning <em>k.manual | k.metrics | k.optical</em> -- options for auto kerning </li> auto_leading <em>Boolean</em> -- whether to use a font's built-in leading information </li> auto_leading_amount <em>LongFloat</em> -- percentage to use for auto leading </li> baseline_shift <em>LongFloat</em> -- baseline offset of text (unit value) </li> capitalization <em>k.all_caps | k.normal | k.small_caps</em> -- the case of the text </li> container (r/o) ObjectSpecifier -- the object's container contents <em>UnicodeText</em> -- the text in the layer </li> desired_glyph_scaling <em>LongFloat</em> </li> desired_letter_scaling <em>LongFloat</em> </li> desired_word_scaling <em>LongFloat</em> </li> faux_bold <em>Boolean</em> -- use faux bold? </li> faux_italic <em>Boolean</em> -- use faux italic? </li> first_line_indent <em>LongFloat</em> -- (unit value) </li> font <em>UnicodeText</em> -- text face of the character </li> height <em>LongFloat</em> -- the height of paragraph text (unit value) </li> horizontal_scale <em>SInt32</em> -- horizontal scaling of characters (in percent) </li> horizontal_warp_distortion <em>LongFloat</em> -- percentage from -100 to 100 </li> hyphen_limit <em>SInt32</em> -- maximum number of consecutive hyphens </li> hyphenate_after_first <em>SInt32</em> -- hyphenate after this many letters </li> hyphenate_before_last <em>SInt32</em> -- hyphenate before this many letters </li> hyphenate_capitalized_words <em>Boolean</em> -- wheter to hyphenate capitalized words </li> hyphenate_words_longer_than <em>SInt32</em> -- hyphenate words that have more than this number of letters ( minimum 0 ) </li> hyphenation <em>Boolean</em> -- use hyphenation? </li> hyphenation_zone <em>LongFloat</em> -- the hyphenation zone (unit value) </li> justification <em>k.center | k.center_justified | k.fully_justified | k.left | k.left_justified | k.right | k.right_justified</em> -- paragraph justification </li> kind <em>k.paragraph_text | k.point_text</em> -- the type of the text </li> language <em>k.Brazilian_Portuguese | k.Canadian_French | k.Danish | k.Dutch | k.English_UK | k.English_USA | k.Finnish | k.French | k.German | k.Italian | k.Norwegian | k.Nynorsk_Norwegian | k.Old_German | k.Portuguese | k.Spanish | k.Swedish | k.Swiss_German</em> </li> leading <em>LongFloat</em> -- leading (unit value) </li> left_indent <em>LongFloat</em> -- (unit value) </li> ligatures <em>Boolean</em> -- use ligatures? </li> maximum_glyph_scaling <em>LongFloat</em> </li> maximum_letter_scaling <em>LongFloat</em> </li> maximum_word_scaling <em>LongFloat</em> </li> minimum_glyph_scaling <em>LongFloat</em> </li> minimum_letter_scaling <em>LongFloat</em> </li> minimum_word_scaling <em>LongFloat</em> </li> no_break <em>Boolean</em> </li> old_style <em>Boolean</em> -- use old style? </li> position <em>AEList</em> -- position of origin (unit value) </li> right_indent <em>LongFloat</em> -- (unit value) </li> Roman_hanging_punctuation <em>Boolean</em> -- use Roman Hanging Punctuation? </li> size <em>LongFloat</em> -- font size in points </li> space_after <em>LongFloat</em> -- (unit value) </li> space_before <em>LongFloat</em> -- (unit value) </li> strike_thru <em>k.off | k.strike_box | k.strike_height</em> -- options for strik thru of the text </li> stroke_color <em><a href="#class_color_value">k.color_value</a></em> -- color of text </li> text_composer <em>k.Adobe_every_line | k.Adobe_single_line</em> -- type of text composing engine to use </li> text_direction <em>k.horizontal | k.vertical</em> -- text orientation </li> tracking <em>LongFloat</em> -- controls uniform spacing between multiple characters </li> underline <em>k.left | k.off | k.right</em> -- options for underlining of the text </li> vertical_scale <em>SInt32</em> -- vertical scaling of characters (in percent) </li> vertical_warp_distortion <em>LongFloat</em> -- percentage from -100 to 100 </li> warp_bend <em>LongFloat</em> -- percentage from -100 to 100 </li> warp_direction <em>k.horizontal | k.vertical</em> </li> warp_style <em>k.arc | k.arc_lower | k.arc_upper | k.arch | k.bulge | k.fish | k.fish_eye | k.flag | k.inflate | k.none | k.rise | k.shell_lower | k.shell_upper | k.squeeze | k.twist | k.wave</em> </li> width <em>LongFloat</em> -- the width of paragraph text (unit value) </li> </ul> </li> </ul> </li> XMP_metadata <ul> <li>Properties: <ul> <li> <strong>best_type</strong> (r/o) <em>Type</em> -- the best type for the object's value </li> class_ (r/o) Type -- the object's class default_type (r/o) Type -- the default type for the object's value properties <em>AERecord</em> -- all of this object's properties returned in a single record </li> container (r/o) ObjectSpecifier -- the object's container raw_data <em>UnicodeText</em> -- raw XML form of file information </li> </ul> </li> </ul> </li> </ul> <a name="suite_Open_Formats_Suite" id="suite_Open_Formats_Suite"></a> <h2>Open Formats Suite</h2> <p>Classes for specifying options when opening document</p> <h3>Classes</h3> <ul> <li> <a name="class_EPS_open_options"></a> <strong>EPS_open_options</strong> -- Settings related to opening a generic EPS document <ul> <li>Parent: <ul> <li><em><a href="#class_open_options">open_options</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>constrain_proportions</strong> <em>Boolean</em> -- constrain proportions of image </li> height <em>LongFloat</em> -- height of image (unit value) </li> mode <em>k.CMYK | k.grayscale | k.Lab | k.RGB</em> -- the document mode </li> resolution <em>LongFloat</em> -- the resolution of the document (in pixels per inch) </li> use_antialias <em>Boolean</em> -- use antialias? </li> width <em>LongFloat</em> -- width of image (unit value) </li> </ul> </li> </ul> </li> open_options -- used with options on the open command <li>Children: <ul> <li><em><a href="#class_Photo_CD_open_options">Photo_CD_open_options</a></em></li> PDF_open_options raw_format_open_options EPS_open_options </ul> </li> PDF_open_options -- Settings related to opening a generic PDF document Parent: open_options <li>Properties: <ul> <li> <strong>constrain_proportions</strong> <em>Boolean</em> -- constrain proportions of image </li> height <em>LongFloat</em> -- height of image (unit value) </li> mode <em>k.CMYK | k.grayscale | k.Lab | k.RGB</em> -- the document mode </li> page <em>SInt32</em> -- number of page to open </li> resolution <em>LongFloat</em> -- the resolution of the document (in pixels per inch) </li> use_antialias <em>Boolean</em> -- use antialias? </li> width <em>LongFloat</em> -- width of image (unit value) </li> </ul> </li> </ul> </li> Photo_CD_open_options -- Settings related to opening a PhotoCD document Parent: open_options <li>Properties: <ul> <li> <strong>color_profile_name</strong> <em>UnicodeText</em> -- profile to use when reading the image </li> color_space <em>k.Lab_16 | k.Lab_8 | k.RGB_16 | k.RGB_8</em> -- colorspace for image </li> orientation <em>k.landscape | k.portrait</em> </li> pixel_size <em>k.extra_large | k.large | k.maximum | k.medium | k.minimum | k.small</em> -- dimensions of image </li> resolution <em>LongFloat</em> -- the resolution of the image (in pixels per inch) </li> </ul> </li> </ul> </li> raw_format_open_options -- Settings related to opening a raw format document Parent: open_options <li>Properties: <ul> <li> <strong>bits_per_channel</strong> <em>SInt32</em> -- number of bits for each channel (8 or 16) </li> byte_order <em>k.IBM_PC | k.Mac_OS</em> -- only relevant for images with 16 bits per channel </li> header_size <em>SInt32</em> </li> height <em>SInt32</em> -- height of image (in pixels) </li> interleave_channels <em>Boolean</em> -- are the channels in the image interleaved? </li> number_of_channels <em>SInt32</em> -- number of channels in image </li> retain_header <em>Boolean</em> -- retain header when saving? </li> width <em>SInt32</em> -- width of image (in pixels) </li> </ul> </li> </ul> </li> </ul> <a name="suite_Save_Formats_Suite" id="suite_Save_Formats_Suite"></a> <h2>Save Formats Suite</h2> <p>Classes for specifying options when saving documents</p> <h3>Classes</h3> <ul> <li> <a name="class_BMP_save_options"></a> <strong>BMP_save_options</strong> -- Settings related to saving a BMP document <ul> <li>Parent: <ul> <li><em><a href="#class_save_options">save_options</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>bits_per_sample</strong> <em>k.A1R5G5B5 | k.A4R4G4B4 | k.A8R8G8B8 | k.eight | k.four | k.one | k.R5G6B5 | k.R8G8B8 | k.sixteen | k.thirty_two | k.twenty_four | k.X1R5G5B5 | k.X4R4G4B4 | k.X8R8G8B8</em> -- number of bits per sample ( default: twenty four ) </li> flipped_row_order <em>Boolean</em> </li> RLE_compression <em>Boolean</em> -- should RLE compression be used? </li> save_alpha_channels <em>Boolean</em> -- save alpha channels </li> target_operating_system <em>k.OS2 | k.Windows</em> -- target OS. Windows or OS/2 ( default: Windows ) </li> </ul> </li> </ul> </li> EPS_save_options -- Settings related to saving an EPS document Parent: save_options <li>Properties: <ul> <li> <strong>embed_color_profile</strong> <em>Boolean</em> -- embed color profile in document </li> encoding <em>k.ASCII | k.binary | k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG</em> -- type of encoding to use for document ( default: binary ) </li> halftone_screen <em>Boolean</em> -- include halftone screen ( default: false ) </li> image_interpolation <em>Boolean</em> -- use image interpolation ( default: false ) </li> PostScript_color_management <em>Boolean</em> -- use Postscript color management ( default: false ) </li> preview_type <em>k.eight_bit_Mac_OS | k.eight_bit_TIFF | k.JPEG_Mac_OS | k.monochrome_Mac_OS | k.monochrome_TIFF | k.none</em> -- type of preview ( default: monochrome TIFF ) </li> transfer_function <em>Boolean</em> -- include transfer functions in document ( default: false ) </li> transparent_whites <em>Boolean</em> -- only valid when saving BitMap documents </li> vector_data <em>Boolean</em> -- include vector data </li> </ul> </li> </ul> </li> GIF_save_options -- Settings related to saving a GIF document Parent: save_options <li>Properties: <ul> <li> <strong>colors_in_palette</strong> <em>SInt32</em> -- number of colors in palette (only settable for some palette types) </li> dither <em>k.diffusion | k.noise | k.none | k.pattern</em> -- type of dither </li> dither_amount <em>SInt32</em> -- amount of dither. Only valid for diffusion ( 1 - 100; default: 75 ) </li> forced_colors <em>k.black_and_white | k.none | k.primaries | k.web</em> </li> interlaced <em>Boolean</em> -- should rows be interlaced? ( default: false ) </li> matte <em>k.background_color_matte | k.black_matte | k.foreground_color_matte | k.Netscape_gray | k.none | k.semi_gray | k.white_matte</em> </li> palette <em>k.exact | k.local_adaptive | k.local_perceptual | k.local_selective | k.Mac_OS_system | k.master_adaptive | k.master_perceptual | k.master_selective | k.previous_ | k.uniform | k.web | k.Windows_system</em> -- ( default: local selective ) </li> preserve_exact_colors <em>Boolean</em> </li> transparency <em>Boolean</em> </li> </ul> </li> </ul> </li> JPEG_save_options -- Settings related to saving a JPEG document Parent: save_options <li>Properties: <ul> <li> <strong>embed_color_profile</strong> <em>Boolean</em> -- embed color profile in document </li> format_options <em>k.optimized | k.progressive | k.standard</em> -- ( default: standard ) </li> matte <em>k.background_color_matte | k.black_matte | k.foreground_color_matte | k.Netscape_gray | k.none | k.semi_gray | k.white_matte</em> </li> quality <em>SInt32</em> -- quality of produced image ( 0 - 12; default: 3 ) </li> scans <em>SInt32</em> -- number of scans. Only valid for progressive type JPEG files ( 3 - 5 ) </li> </ul> </li> </ul> </li> PDF_save_options -- Settings related to saving a pdf document Parent: save_options <li>Properties: <ul> <li> <strong>downgrade_color_profile</strong> <em>Boolean</em> -- should the embedded color profile be downgraded to version 2 </li> embed_color_profile <em>Boolean</em> -- embed color profile in document </li> embed_fonts <em>Boolean</em> -- embed fonts? Only valid if a text layer is included </li> encoding <em>k.JPEG | k.ZIP</em> -- ( default: ZIP ) </li> image_interpolation <em>Boolean</em> -- use image interpolation? </li> JPEG_quality <em>SInt32</em> -- quality of produced image. Only valid for JPEG encoded PDF documents ( 0 - 12 ) </li> save_alpha_channels <em>Boolean</em> -- save alpha channels </li> save_annotations <em>Boolean</em> -- save annotations </li> save_layers <em>Boolean</em> -- save layers </li> save_spot_colors <em>Boolean</em> -- save spot colors </li> transparency <em>Boolean</em> </li> use_outlines_for_text <em>Boolean</em> -- use outlines for text? Only valid if vector data is included </li> vector_data <em>Boolean</em> -- include vector data </li> </ul> </li> </ul> </li> Photoshop_DCS_10x2E0_save_options -- Settings related to saving a Photoshop DCS 1.0 document Parent: save_options <li>Properties: <ul> <li> <strong>DCS</strong> <em>k.color_composite | k.grayscale_composite | k.no_composite_PostScript</em> -- ( default: color composite ) </li> embed_color_profile <em>Boolean</em> -- embed color profile in document </li> encoding <em>k.ASCII | k.binary | k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG</em> -- type of encoding to use for document ( default: binary ) </li> halftone_screen <em>Boolean</em> -- include halftone screen ( default: false ) </li> image_interpolation <em>Boolean</em> -- use image interpolation ( default: false ) </li> preview_type <em>k.eight_bit_Mac_OS | k.eight_bit_TIFF | k.JPEG_Mac_OS | k.monochrome_Mac_OS | k.monochrome_TIFF | k.none</em> -- type of preview ( default: eight bit Mac OS ) </li> transfer_function <em>Boolean</em> -- include transfer functions in document ( default: false ) </li> vector_data <em>Boolean</em> -- include vector data </li> </ul> </li> </ul> </li> Photoshop_DCS_20x2E0_save_options -- Settings related to saving a Photoshop DCS 2.0 document Parent: save_options <li>Properties: <ul> <li> <strong>DCS</strong> <em>k.color_composite | k.grayscale_composite | k.no_composite_PostScript</em> -- ( default: no composite PostScript ) </li> embed_color_profile <em>Boolean</em> -- embed color profile in document </li> encoding <em>k.ASCII | k.binary | k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG</em> -- type of encoding to use for document ( default: binary ) </li> halftone_screen <em>Boolean</em> -- include halftone screen ( default: false ) </li> image_interpolation <em>Boolean</em> -- use image interpolation ( default: false ) </li> multifile_DCS <em>Boolean</em> -- ( default: false ) </li> preview_type <em>k.eight_bit_Mac_OS | k.eight_bit_TIFF | k.JPEG_Mac_OS | k.monochrome_Mac_OS | k.monochrome_TIFF | k.none</em> -- type of preview ( default: eight bit Mac OS ) </li> save_spot_colors <em>Boolean</em> -- save spot colors </li> transfer_function <em>Boolean</em> -- include transfer functions in document ( default: false ) </li> vector_data <em>Boolean</em> -- include vector data </li> </ul> </li> </ul> </li> Photoshop_save_options -- Settings related to saving a Photoshop document Parent: save_options <li>Properties: <ul> <li> <strong>embed_color_profile</strong> <em>Boolean</em> -- embed color profile in document </li> save_alpha_channels <em>Boolean</em> -- save alpha channels </li> save_annotations <em>Boolean</em> -- save annotations </li> save_layers <em>Boolean</em> -- save layers </li> save_spot_colors <em>Boolean</em> -- save spot colors </li> </ul> </li> </ul> </li> PICT_file_save_options -- Settings related to saving a PICT document Parent: save_options <li>Properties: <ul> <li> <strong>compression</strong> <em>k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG | k.none</em> -- ( default: none ) </li> embed_color_profile <em>Boolean</em> -- embed color profile in document </li> resolution <em>k.eight | k.four | k.sixteen | k.thirty_two | k.two</em> -- number of bits per pixel </li> save_alpha_channels <em>Boolean</em> -- save alpha channels </li> </ul> </li> </ul> </li> PICT_resource_save_options -- Settings related to saving a PICT resource file Parent: save_options <li>Properties: <ul> <li> <strong>compression</strong> <em>k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG | k.none</em> -- ( default: none ) </li> embed_color_profile <em>Boolean</em> -- embed color profile in document </li> name <em>UnicodeText</em> -- name of PICT resource ( default: &quot;&quot; ) </li> resolution <em>k.eight | k.four | k.sixteen | k.thirty_two | k.two</em> -- number of bits per pixel </li> resource_id <em>SInt32</em> -- ID of PICT resource ( default: 128 ) </li> save_alpha_channels <em>Boolean</em> -- save alpha channels </li> </ul> </li> </ul> </li> Pixar_save_options -- Settings related to saving a Pixar document Parent: save_options <li>Properties: <ul> <li> <strong>save_alpha_channels</strong> <em>Boolean</em> -- save alpha channels </li> </ul> </li> </ul> </li> PNG_save_options -- Settings related to saving a PNG document Parent: save_options <li>Properties: <ul> <li> <strong>interlaced</strong> <em>Boolean</em> -- should rows be interlaced? ( default: false ) </li> </ul> </li> </ul> </li> raw_save_options -- Settings related to saving a document in raw format Parent: save_options <li>Properties: <ul> <li> <strong>save_alpha_channels</strong> <em>Boolean</em> -- save alpha channels </li> save_spot_colors <em>Boolean</em> -- save spot colors </li> </ul> </li> </ul> </li> save_options -- used with options on the save command <li>Children: <ul> <li><em><a href="#class_raw_save_options">raw_save_options</a></em></li> BMP_save_options JPEG_save_options PICT_file_save_options PICT_resource_save_options Pixar_save_options PNG_save_options EPS_save_options PDF_save_options Photoshop_save_options SGI_RGB_save_options GIF_save_options Photoshop_DCS_20x2E0_save_options Photoshop_DCS_10x2E0_save_options TIFF_save_options Targa_save_options </ul> </li> SGI_RGB_save_options -- Settings related to saving a document in the SGI RGB format Parent: save_options <li>Properties: <ul> <li> <strong>save_alpha_channels</strong> <em>Boolean</em> -- save alpha channels </li> save_spot_colors <em>Boolean</em> -- save spot colors </li> </ul> </li> </ul> </li> Targa_save_options -- Settings related to saving a Target document Parent: save_options <li>Properties: <ul> <li> <strong>resolution</strong> <em>k.sixteen | k.thirty_two | k.twenty_four</em> -- number of bits per pixel ( default: twenty four ) </li> RLE_compression <em>Boolean</em> -- should RLE compression be used? ( default: true ) </li> save_alpha_channels <em>Boolean</em> -- save alpha channels </li> </ul> </li> </ul> </li> TIFF_save_options -- Settings related to saving a TIFF document Parent: save_options <li>Properties: <ul> <li> <strong>byte_order</strong> <em>k.IBM_PC | k.Mac_OS</em> -- Default value is 'Mac OS' when running on MacOS, and 'IBM PC' when running on a PC </li> embed_color_profile <em>Boolean</em> -- embed color profile in document </li> image_compression <em>k.JPEG | k.LZW | k.none | k.ZIP</em> -- compression type ( default: none ) </li> JPEG_quality <em>SInt32</em> -- quality of produced image. Only valid for JPEG compressed TIFF documents ( 0 - 12 ) </li> layer_compression <em>k.RLE | k.ZIP</em> -- should only be used when you are saving layers </li> save_alpha_channels <em>Boolean</em> -- save alpha channels </li> save_annotations <em>Boolean</em> -- save annotations </li> save_image_pyramid <em>Boolean</em> -- ( default: false ) </li> save_layers <em>Boolean</em> -- save layers </li> save_spot_colors <em>Boolean</em> -- save spot colors </li> transparency <em>Boolean</em> </li> </ul> </li> </ul> </li> </ul> <a name="suite_Filter_Suite" id="suite_Filter_Suite"></a> <h2>Filter Suite</h2> <p>Scripting commands for applying filters to documents</p> <h3>Commands</h3> <ul> <li> <a name="command_filter"></a> <strong>application.filter(...)</strong> -- apply a filter to one or more art layers <ul> <li> <em>k.art_layer</em> -- the art layer object or objects to be operated upon </li> <li> <strong>using=</strong><em>Anything</em> -- name of options class that the method should be invoked with. Must be a name of a class that inherits from filter options </li> [with_options=k.filter_options] -- options for method Result: None </li> </ul> </li> </ul> <h3>Classes</h3> <ul> <li> <a name="class_add_noise"></a> <strong>add_noise</strong> -- apply the add noise filter <ul> <li>Parent: <ul> <li><em><a href="#class_filter_options">filter_options</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>amount</strong> <em>LongFloat</em> </li> distribution <em>k.Gaussian | k.uniform</em> </li> monochromatic <em>Boolean</em> </li> </ul> </li> </ul> </li> blur -- apply the blur filter Parent: filter_options </ul> </li> blur_more -- apply the blur more filter Parent: filter_options </ul> </li> clouds -- apply the clouds filter Parent: filter_options </ul> </li> custom_filter -- apply the custom filter Parent: filter_options <li>Properties: <ul> <li> <strong>characteristics</strong> <em>list of SInt32</em> -- filter characteristics (array of 25 values - Correspons to a left to right, top to bottom traversal of array presented in the Ui) </li> scaling <em>SInt32</em> </li> offset <em>SInt32</em> </li> </ul> </li> </ul> </li> deinterlace -- apply the De-Interlace filter Parent: filter_options <li>Properties: <ul> <li> <strong>eliminate</strong> <em>k.even_fields | k.odd_fields</em> </li> create_new_fields_by <em>k.duplication | k.interpolation</em> </li> </ul> </li> </ul> </li> despeckle -- apply the despeckle filter Parent: filter_options </ul> </li> difference_clouds -- apply the difference clouds filter Parent: filter_options </ul> </li> diffuse_glow -- apply the diffuse glow filter Parent: filter_options <li>Properties: <ul> <li> <strong>graininess</strong> <em>SInt32</em> -- (range: 0 - 10) </li> glow_amount <em>SInt32</em> -- (range: 0 - 20) </li> clear_amount <em>SInt32</em> -- (range: 0 - 20) </li> </ul> </li> </ul> </li> displace_filter -- apply the displace filter Parent: filter_options <li>Properties: <ul> <li> <strong>horizontal_scale</strong> <em>SInt32</em> </li> vertical_scale <em>SInt32</em> </li> kind <em>k.stretch_to_fit | k.tile</em> </li> undefined_areas <em>k.repeat_edge_pixels | k.wrap_around</em> </li> displacement_map_definition <em>Alias</em> </li> </ul> </li> </ul> </li> dust_and_scratches -- apply the dust and scratches filter Parent: filter_options <li>Properties: <ul> <li> <strong>radius</strong> <em>SInt32</em> -- in pixels </li> threshold <em>SInt32</em> </li> </ul> </li> </ul> </li> filter_options -- options used with the filter method <li>Children: <ul> <li><em><a href="#class_Gaussian_blur">Gaussian_blur</a></em></li> NTSC_colors minimum_filter offset_filter dust_and_scratches median_noise sharpen_edges unsharp_mask custom_filter maximum_filter lens_flare difference_clouds clouds high_pass deinterlace texture_fill sharpen sharpen_more diffuse_glow glass_filter radial_blur smart_blur blur_more motion_blur blur ocean_ripple pinch ripple polar_coordinates spherize shear displace_filter twirl zigzag wave_filter despeckle add_noise </ul> </li> Gaussian_blur -- apply the Gaussian blur filter Parent: filter_options <li>Properties: <ul> <li> <strong>radius</strong> <em>LongFloat</em> -- in pixels </li> </ul> </li> </ul> </li> glass_filter -- apply the glass filter Parent: filter_options <li>Properties: <ul> <li> <strong>distortion</strong> <em>SInt32</em> -- (range: 0 - 20) </li> smoothness <em>SInt32</em> -- (range: 1 - 15) </li> scaling <em>SInt32</em> -- (range: 50 - 200) </li> invert_texture <em>Boolean</em> -- ( default: false ) ( default: false ) </li> texture_kind <em>k.blocks | k.canvas | k.frosted | k.texture_document | k.tiny_lens</em> </li> texture_definition <em>Alias</em> </li> </ul> </li> </ul> </li> high_pass -- apply the high pass filter Parent: filter_options <li>Properties: <ul> <li> <strong>radius</strong> <em>LongFloat</em> -- in pixels </li> </ul> </li> </ul> </li> lens_flare -- apply the lens flare filter Parent: filter_options <li>Properties: <ul> <li> <strong>brightness</strong> <em>SInt32</em> -- (range: 10 - 300) </li> flare_center <em>AEList</em> -- position (unit value) </li> lens_type <em>k.Movie_Prime | k.Prime_105 | k.Prime_35 | k.zoom</em> </li> </ul> </li> </ul> </li> maximum_filter -- apply the maximum filter Parent: filter_options <li>Properties: <ul> <li> <strong>radius</strong> <em>LongFloat</em> -- in pixels </li> </ul> </li> </ul> </li> median_noise -- apply the median noise filter Parent: filter_options <li>Properties: <ul> <li> <strong>radius</strong> <em>LongFloat</em> -- in pixels </li> </ul> </li> </ul> </li> minimum_filter -- apply the minimum filter Parent: filter_options <li>Properties: <ul> <li> <strong>radius</strong> <em>LongFloat</em> -- in pixels </li> </ul> </li> </ul> </li> motion_blur -- apply the motion blur filter Parent: filter_options <li>Properties: <ul> <li> <strong>angle</strong> <em>SInt32</em> </li> radius <em>LongFloat</em> -- in pixels </li> </ul> </li> </ul> </li> NTSC_colors -- apply the NTSC colors filter Parent: filter_options </ul> </li> ocean_ripple -- apply the ocean ripple filter Parent: filter_options <li>Properties: <ul> <li> <strong>ripple_size</strong> <em>SInt32</em> -- (range: 1 - 15) </li> ripple_magnitude <em>SInt32</em> -- (range: 0 - 20) </li> </ul> </li> </ul> </li> offset_filter -- apply the offset filter Parent: filter_options <li>Properties: <ul> <li> <strong>horizontal_offset</strong> <em>LongFloat</em> -- (unit value) </li> vertical_offset <em>LongFloat</em> -- (unit value) </li> undefined_areas <em>k.repeat_edge_pixels | k.set_to_layer_fill | k.wrap_around</em> </li> </ul> </li> </ul> </li> pinch -- apply the pinch filter Parent: filter_options <li>Properties: <ul> <li> <strong>amount</strong> <em>SInt32</em> -- (range: -100 - 100) </li> </ul> </li> </ul> </li> polar_coordinates -- apply the polar coordinates filter Parent: filter_options <li>Properties: <ul> <li> <strong>kind</strong> <em>k.polar_to_rectangular | k.rectangular_to_polar</em> </li> </ul> </li> </ul> </li> radial_blur -- apply the radial blur filter Parent: filter_options <li>Properties: <ul> <li> <strong>amount</strong> <em>SInt32</em> -- from 0 to 100 </li> blur_method <em>k.spin | k.zoom</em> </li> quality <em>k.best | k.draft | k.good</em> </li> </ul> </li> </ul> </li> ripple -- apply the ripple filter Parent: filter_options <li>Properties: <ul> <li> <strong>amount</strong> <em>SInt32</em> -- (range: -999 - 999) </li> ripple_size <em>k.large | k.medium | k.small</em> </li> </ul> </li> </ul> </li> sharpen -- apply the sharpen filter Parent: filter_options </ul> </li> sharpen_edges -- apply the sharpen edges filter Parent: filter_options </ul> </li> sharpen_more -- apply the sharpen more filter Parent: filter_options </ul> </li> shear -- apply the shear filter Parent: filter_options <li>Properties: <ul> <li> <strong>curve</strong> <em>list of Anything</em> -- specification of shear curve. List of curve points </li> undefined_areas <em>k.repeat_edge_pixels | k.wrap_around</em> </li> </ul> </li> </ul> </li> smart_blur -- apply the smart blur filter Parent: filter_options <li>Properties: <ul> <li> <strong>radius</strong> <em>LongFloat</em> -- radius (range: 0 - 1000) </li> threshold <em>LongFloat</em> -- threshold (range: 0 - 1000) </li> quality <em>k.high | k.low | k.medium</em> </li> mode <em>k.edge_only | k.normal | k.overlay_edge</em> </li> </ul> </li> </ul> </li> spherize -- apply the spherize filter Parent: filter_options <li>Properties: <ul> <li> <strong>amount</strong> <em>SInt32</em> -- (range: -100 - 100) </li> mode <em>k.horizontal | k.normal | k.vertical</em> </li> </ul> </li> </ul> </li> texture_fill -- apply the texture fill filter Parent: filter_options <li>Properties: <ul> <li> <strong>file_path</strong> <em>Alias</em> -- texture file. Must be a grayscale Photoshop file </li> </ul> </li> </ul> </li> twirl -- apply the twirl filter Parent: filter_options <li>Properties: <ul> <li> <strong>angle</strong> <em>SInt32</em> -- (range: -999 - 999) </li> </ul> </li> </ul> </li> unsharp_mask -- apply the unsharp mask filter Parent: filter_options <li>Properties: <ul> <li> <strong>amount</strong> <em>LongFloat</em> </li> radius <em>LongFloat</em> -- in pixels </li> threshold <em>SInt32</em> -- threshold </li> </ul> </li> </ul> </li> wave_filter -- apply the wave filter Parent: filter_options <li>Properties: <ul> <li> <strong>number_of_generators</strong> <em>SInt32</em> -- number of generators </li> minimum_wavelength <em>SInt32</em> </li> maximum_wavelength <em>SInt32</em> </li> minimum_amplitude <em>SInt32</em> </li> maximum_amplitude <em>SInt32</em> </li> horizontal_scale <em>SInt32</em> </li> vertical_scale <em>SInt32</em> </li> wave_type <em>k.sine | k.square | k.triangular</em> </li> undefined_areas <em>k.repeat_edge_pixels | k.wrap_around</em> </li> random_seed <em>SInt32</em> </li> </ul> </li> </ul> </li> zigzag -- apply the zigzag filter Parent: filter_options <li>Properties: <ul> <li> <strong>amount</strong> <em>SInt32</em> -- (range: -100 - 100) </li> ridges <em>SInt32</em> </li> style <em>k.around_center | k.out_from_center | k.pond_ripples</em> </li> </ul> </li> </ul> </li> </ul> <a name="suite_Adjustment_Suite" id="suite_Adjustment_Suite"></a> <h2>Adjustment Suite</h2> <p>Scripting commands for applying adjustments to documents</p> <h3>Commands</h3> <ul> <li> <a name="command_adjust"></a> <strong>application.adjust(...)</strong> -- apply an adjustment to one or more art layers <ul> <li> <em>k.art_layer</em> -- the art layer object or objects to be operated upon </li> <li> <strong>using=</strong><em>Anything</em> -- name of options class that the method should be invoked with. Must be a name of a class that inherits from adjustment options </li> [with_options=k.adjustment_options] -- options for method Result: None </li> </ul> </li> </ul> <h3>Classes</h3> <ul> <li> <a name="class_adjustment_options"></a> <strong>adjustment_options</strong> -- options used with the adjust method <ul> <li>Children: <ul> <li><em><a href="#class_inversion">inversion</a></em></li> posterize threshold_adjustment equalize mix_channels levels_adjustment selective_color color_balance brightness_and_contrast curves automatic_contrast desaturate automatic_levels </ul> </li> automatic_contrast -- adjust contrast of the selected channels automatically Parent: adjustment_options </ul> </li> automatic_levels -- adjust levels of the selected channels using auto levels option Parent: adjustment_options </ul> </li> brightness_and_contrast -- adjust brightness and constrast Parent: adjustment_options <li>Properties: <ul> <li> <strong>brightness_level</strong> <em>SInt32</em> </li> contrast_level <em>SInt32</em> </li> </ul> </li> </ul> </li> color_balance <ul> <li>Parent: <ul> <li><em><a href="#class_adjustment_options">adjustment_options</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>shadows</strong> <em>list of SInt32</em> -- list of adjustments for shadows. There must be 3 values in the list </li> midtones <em>list of SInt32</em> -- list of adjustments for midtones. There must be 3 values in the list </li> highlights <em>list of SInt32</em> -- list of adjustments for highlights. There must be 3 values in the list </li> preserve_luminosity <em>Boolean</em> </li> </ul> </li> </ul> </li> curves -- adjust curves of the selected channels Parent: adjustment_options <li>Properties: <ul> <li> <strong>curve_points</strong> <em>list of AEList</em> -- list of curve points (number of points must be between 2 and 11) </li> </ul> </li> </ul> </li> desaturate <ul> <li>Parent: <ul> <li><em><a href="#class_adjustment_options">adjustment_options</a></em></li> </ul> </li> </ul> </li> equalize -- equalize the levels Parent: adjustment_options </ul> </li> inversion -- inverts the currently selected layer or channels Parent: adjustment_options </ul> </li> levels_adjustment -- adjust levels of the selected channels Parent: adjustment_options <li>Properties: <ul> <li> <strong>input_range_start</strong> <em>SInt32</em> </li> input_range_end <em>SInt32</em> </li> input_range_gamma <em>LongFloat</em> </li> output_range_start <em>SInt32</em> </li> output_range_end <em>SInt32</em> </li> </ul> </li> </ul> </li> mix_channels -- only valid for RGB or CMYK documents Parent: adjustment_options <li>Properties: <ul> <li> <strong>output_channels</strong> <em>list of Anything</em> -- 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 </li> monochrome_mixing <em>Boolean</em> -- use monochrome mixing? If this is true you can only specify one channel value ( default: false ) ( default: false ) </li> </ul> </li> </ul> </li> posterize <ul> <li>Parent: <ul> <li><em><a href="#class_adjustment_options">adjustment_options</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>levels</strong> <em>SInt32</em> </li> </ul> </li> </ul> </li> selective_color <ul> <li>Parent: <ul> <li><em><a href="#class_adjustment_options">adjustment_options</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>selection_method</strong> <em>k.absolute | k.relative</em> </li> reds <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> yellows <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> greens <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> cyans <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> blues <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> magentas <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> whites <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> neutrals <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> blacks <em>list of LongFloat</em> -- Array of 4 values: cyan, magenta, yellow, black </li> </ul> </li> </ul> </li> threshold_adjustment <ul> <li>Parent: <ul> <li><em><a href="#class_adjustment_options">adjustment_options</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>level</strong> <em>SInt32</em> </li> </ul> </li> </ul> </li> </ul> <a name="suite_Color_Suite" id="suite_Color_Suite"></a> <h2>Color Suite</h2> <p>Color classes for Adobe Photoshop</p> <h3>Commands</h3> <ul> <li> <a name="command_convert_color"></a> <strong>application.convert_color(...)</strong> -- convert a object from one color model to another <ul> <li> <em>k.color_value</em> -- color to convert </li> <li> <strong>to=</strong><em>k.CMYK | k.grayscale | k.HSB | k.Lab | k.RGB | k.RGB_Hex</em> -- color model to convert to </li> <li> Result: <em>k.color_value</em> -- convert a object from one color model to another </li> </ul> </li> application.equal_colors(...) -- are the colors visually equal? k.color_value -- the cPsBaseColor object to be operated upon with=k.color_value </li> <li> Result: <em>Boolean</em> -- are the colors visually equal? </li> </ul> </li> application.web_safe_color(...) -- find the closest web safe color for a color <li> <strong>for_=</strong><em>k.color_value</em> </li> <li> Result: <em>k.RGB_color</em> -- find the closest web safe color for a color </li> </ul> </li> </ul> <h3>Classes</h3> <ul> <li> <a name="class_CMYK_color"></a> <strong>CMYK_color</strong> -- A CMYK color specification <ul> <li>Parent: <ul> <li><em><a href="#class_color_value">color_value</a></em></li> </ul> </li> <li>Properties: <ul> <li> <strong>cyan</strong> <em>LongFloat</em> -- the cyan color value (between 0.0 and 100.0) </li> magenta <em>LongFloat</em> -- the magenta color value (between 0.0 and 100.0) </li> yellow <em>LongFloat</em> -- the yellow color value (between 0.0 and 100.0) </li> black <em>LongFloat</em> -- the black color value (between 0.0 and 100.0) </li> </ul> </li> </ul> </li> color_value -- A color value <li>Children: <ul> <li><em><a href="#class_CMYK_color">CMYK_color</a></em></li> gray_color RGB_color RGB_hex_color no_color HSB_color Lab_color </ul> </li> gray_color -- A gray color specification Parent: color_value <li>Properties: <ul> <li> <strong>gray_value</strong> <em>LongFloat</em> -- the gray value ( 0.0 - 100.0; default: 0.0 ) </li> </ul> </li> </ul> </li> HSB_color -- An HSB color specification Parent: color_value <li>Properties: <ul> <li> <strong>hue</strong> <em>LongFloat</em> -- the hue value (between 0.0 and 360.0) </li> saturation <em>LongFloat</em> -- the saturation value (between 0.0 and 100.0) </li> brightness <em>LongFloat</em> -- the brightness value (between 0.0 and 100.0) </li> </ul> </li> </ul> </li> Lab_color -- An Lab color specification Parent: color_value <li>Properties: <ul> <li> <strong>value_L</strong> <em>LongFloat</em> -- the L-value (between 0.0 and 100.0) </li> value_a <em>LongFloat</em> -- the a-value (between -128.0 and 127.0) </li> value_b <em>LongFloat</em> -- the b-value (between -128.0 and 127.0) </li> </ul> </li> </ul> </li> no_color -- represents a missing color Parent: color_value </ul> </li> RGB_color -- An RGB color specification Parent: