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> </script>

Adobe Photoshop CS.app terminology

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

AdobeScriptAutomation

Adobe Photoshop script execution menu

Commands

application.Scripts(...) -- Photoshop scripting support plug-in
- [AEType('#ImR')]
- javascript_file=Text -- The JavaScript file to execute
- javascript_text=Text -- The JavaScript text to execute
- debugging=Boolean -- should the javascript be executed in debug mode?
- Result: None

Core Suite

Suite that applies to all applications

Commands

reference.count(...) -- Return the number of elements of a particular class within an object
- each=Type -- the class of the elements to be counted.
- Result: SInt32 -- the number of elements
reference.delete() -- Remove an element from an object
- Result: None
reference.duplicate(...) -- Duplicate one or more object(s)
- [to=InsertionLoc] -- the new location for the object(s)
- [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
- Result: Boolean -- true if it exists, false if not
application.make(...) -- Make a new element
- new=Type -- the class of the new element.
- 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
- to=InsertionLoc -- the new location for the object(s)
- Result: ObjectSpecifier -- to the object(s) after they have been moved
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
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
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
application.quit() -- quit the application
- Result: None
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

Classes

application -- The Adobe Photoshop application
- 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
  - properties AERecord -- all of this object's properties returned in a single record
  - background_color k.color_value
  - color_settings Anything -- name of selected color settings' set
  - current_document k.document -- the frontmost document
  - display_dialogs k.always | k.error_dialogs | k.never -- controls whether or not Photoshop displays dialogs
  - foreground_color k.color_value
  - 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
- 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 AERecord -- all of this object's properties returned in a single record
  - background_layer (r/o) k.art_layer -- background layer for the document. Only valid for documents that have a background layer
  - bits_per_channel k.eight | k.one | k.sixteen -- number of bits per channel
  - color_profile_kind k.custom | k.none | k.working -- type of color profile management for document
  - color_profile_name UnicodeText -- name of color profile for document. Only valid for documents that have been assigned a color profile
  - component_channels (r/o) list of k.channel -- all color component channels for this document
  - current_channels list of k.channel -- selected channels for document
  - current_history_brush_source k.history_state -- the current history state to use with the history brush for this document
  - current_history_state k.history_state -- the current history state for this document
  - current_layer k.layer -- selected layer for document
  - 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 LongFloat -- the pixel aspect ration of the document
  - quick_mask_mode Boolean -- is the document in the quick mask mode?
  - 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
- Elements:
  - art_layers -- name | index | range | relative | test
  - 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

Photoshop Suite

Scripting commands and classes for Adobe Photoshop

Commands

application.apply(...) -- apply the layer comp to the document
- k.layer_comp -- the layer comp object or objects to be operated upon
- Result: None
application.apply_layer_style(...)
- k.art_layer -- the art layer object or objects to be operated upon
- using=UnicodeText -- name of the layer style to apply
- Result: None
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
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
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
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
- Result: None
application.create_PDF_presentation(...) -- create a PDF presentation file
- from_files=list of Alias -- list of input files to include in the output
- 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
- from_folder=Alias -- folder of files to process
- 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
- Result: None
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
application.deselect(...)
- k.document -- the document object or objects to be operated upon
- Result: None
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
application.export(...)
- k.document -- the document object or objects to be operated upon
- in_=FSS -- the file to export to
- [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
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
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]
- Result: None
application.flatten(...) -- flatten all layers in the document
- k.document -- the document object or objects to be operated upon
- Result: None
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
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
- Result: None
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
application.invert(...) -- invert the selection
- k.selection_object -- the selection-object object or objects to be operated upon
- Result: None
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
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
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
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
- Result: None
application.merge_visible_layers(...) -- flatten all visible layers in the document
- k.document -- the document object or objects to be operated upon
- Result: None
application.purge(...) -- purges one or more caches
- k.all_caches | k.clipboard_cache | k.history_caches | k.undo_caches -- what to purge
- Result: None
application.rasterize(...)
- k.art_layer -- the art layer object or objects to be operated upon
- affecting=k.all_linked_layers | k.entire_layer | k.fill_content | k.layer_clipping_path | k.shape | k.text_contents -- what to rasterize
- Result: None
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
- Result: None
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
- Result: None
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
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
application.reveal_all(...) -- expand document to show clipped sections
- k.document -- the document object or objects to be operated upon
- Result: None
application.rotate(...)
- k.layer -- the layer object or objects to be operated upon
- angle=LongFloat
- [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
application.rotate_boundary(...) -- rotates the boundary of selection
- k.selection_object -- the selection-object object or objects to be operated upon
- angle=LongFloat
- [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
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
application.scale(...)
- k.layer -- the layer 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 rotate about ( default: middle center )
- Result: None
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
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
application.select_all(...) -- select the entire image
- k.document -- the document object or objects to be operated upon
- Result: None
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
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
- antialiasing=Boolean
- Result: None
application.smooth(...)
- k.selection_object -- the selection-object object or objects to be operated upon
- radius=SInt32 -- sample radius in pixels ( 0 - 100 )
- Result: None
application.split_channels(...) -- split channels of the document
- k.document -- the document object or objects to be operated upon
- Result: list of k.document -- split channels of the document
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
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]
- Result: None
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
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
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
application.trim(...)
- k.document -- the document object or objects to be operated upon
- [basing_trim_on=k.bottom_right_pixel | k.top_left_pixel | k.transparent_pixels] -- color or type of pixels to base trim on ( default: top left pixel )
- [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
application.unlink(...) -- unlink the layer
- k.layer -- the layer object or objects to be operated upon
- Result: None

Classes

art_layer -- any layer that can contain data
- Parent:
  - layer
- Properties:
  - properties AERecord -- all of this object's properties returned in a single record
  - background_layer Boolean -- is the layer a background layer?
  - fill_opacity LongFloat -- the interior opacity of the layer (between 0.0 and 100.0)
  - grouped Boolean -- is the layer grouped with the layer below?. Photoshop CS changed the menu name to Create/Release Clipping Mask
  - kind 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 -- to create a text layer set this property to 'text layer' on an empty art layer of type 'normal'
  - pixels_locked Boolean
  - position_locked Boolean
  - 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 Boolean
Bitmap_mode_options -- Settings related to changing the document mode to Bitmap
- Parent:
  - change_mode_options
- Properties:
  - angle LongFloat -- only valid for 'halftone screen' conversions
  - conversion_method k.custom_pattern | k.diffusion_dither | k.halftone_screen_conversion | k.middle_threshold | k.pattern_dither -- ( default: diffusion dither )
  - frequency LongFloat -- only valid for 'halftone screen' conversions
  - pattern_name UnicodeText -- only valid for 'custom pattern' conversions
  - resolution LongFloat -- output resolution (in pixels per inch)
  - screen_shape k.halftone_cross | k.halftone_diamond | k.halftone_ellipse | k.halftone_line | k.halftone_round | k.halftone_square -- only valid for 'halftone screen' conversions
change_mode_options -- used with options on the 'change mode' command
- Children:
  - indexed_mode_options
  - Bitmap_mode_options
channel -- A channel in a document. Can be either a component channel representing a color of the document color model or an alpha channel
- 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 AERecord -- all of this object's properties returned in a single record
  - channel_color k.color_value -- color of the channel (not valid for component channels)
  - container (r/o) ObjectSpecifier -- the object's container
  - histogram (r/o) list of SInt32 -- a histogram of values for the channel
  - kind k.component_channel | k.masked_area_channel | k.selected_area_channel | k.spot_color_channel -- type of the channel
  - name UnicodeText -- the channel's name
  - opacity LongFloat -- opacity of alpha channels (called solidity for spot channels)
  - visible Boolean
font -- An installed font
- 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 AERecord -- all of this object's properties returned in a single record
  - 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
gallery_banner_options -- options for the web photo gallery banner options
- Properties:
  - contact_info UnicodeText -- web photo gallery contact info ( default: )
  - date UnicodeText -- web photo gallery date ( default: )
  - font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- the font setting for the banner text ( default: Arial )
  - font_size SInt32 -- the size of the font for the banner text ( 1 - 7; default: 3 )
  - photographer UnicodeText -- web photo gallery photographer ( default: )
  - site_name UnicodeText -- web photo gallery site name ( default: Adobe Web Photo Gallery )
gallery_color_options -- options for the web photo gallery colors
- Properties:
  - active_link_color k.RGB_color -- active link color
  - background_color k.RGB_color -- background color
  - banner_color k.RGB_color -- banner color
  - link_color k.RGB_color -- link color
  - text_color k.RGB_color -- text color
  - visited_link_color k.RGB_color -- visited link color
gallery_images_options -- options for the web photo gallery images
- Properties:
  - border SInt32 -- the amount of border pixels you want between your images ( 0 - 99; default: 0 )
  - caption Boolean -- generate a caption for the images ( default: false )
  - dimension SInt32 -- resized image dimensions in pixels ( default: 350 )
  - font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- font for the gallery images text ( default: Arial )
  - font_size SInt32 -- font size for the gallery images text ( 1 - 7; default: 3 )
  - image_quality SInt32 -- the quality setting for the JPEG image ( 0 - 12; default: 5 )
  - include_copyright Boolean -- include the copyright in the text for the gallery images ( default: false )
  - include_credits Boolean -- include the credits in the text for the gallery images ( default: false )
  - include_file_name Boolean -- include the file name in the text for the gallery images ( default: true )
  - include_title Boolean -- include the title in the text for the gallery images ( default: false )
  - numeric_links Boolean -- add numeric links ( default: true )
  - resize_constraint k.constrain_both | k.constrain_height | k.constrain_width -- how should the image be constrained ( default: constrain both )
  - resize_images Boolean -- resize images data ( default: true )
gallery_options -- options for the web photo gallery command
- Properties:
  - banner_options k.gallery_banner_options -- options related to banner settings
  - custom_color_options k.gallery_color_options -- options related to custom color settings
  - email_address UnicodeText -- the email address to show on the web page ( default: )
  - images_options k.gallery_images_options -- options related to images settings
  - layout_style UnicodeText -- the style to use for laying out the web page ( default: Centered Frame 1 - Basic )
  - preserve_all_metadata Boolean -- save all of the metadata in the JPEG files ( default: false )
  - security_options k.gallery_security_options -- options related to security settings
  - short_extension Boolean -- short web page extension .htm or long web page extension .html ( default: true )
  - size_attributes Boolean -- add width and height attributes for images ( default: true )
  - sub_folders Boolean -- include all files found in sub folders of the input folder ( default: true )
  - thumbnail_options k.gallery_thumbnail_options -- options related to thumbnail settings
  - UTF8_encoding Boolean -- web page should use UTF-8 encoding ( default: false )
gallery_security_options -- options for the web photo gallery security
- Properties:
  - content k.gallery_caption | k.gallery_copyright | k.gallery_credit | k.gallery_custom_text | k.gallery_filename | k.gallery_none | k.gallery_title -- web photo gallery security content ( default: gallery none )
  - custom_text UnicodeText -- web photo gallery security custom text ( default: )
  - font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- web photo gallery security font ( default: Arial )
  - font_size SInt32 -- web photo gallery security font size ( minimum 1; default: 36 )
  - opacity SInt32 -- web page security opacity as a percent ( default: 100 )
  - text_color k.RGB_color -- web page security text color
  - text_position k.gallery_centered | k.gallery_lower_left | k.gallery_lower_right | k.gallery_upper_left | k.gallery_upper_right -- web photo gallery security text position ( default: gallery centered )
  - text_rotate k.clock_wise_45 | k.clock_wise_90 | k.counter_clock_wise_45 | k.counter_clock_wise_90 | k.zero -- web photo gallery security text rotate ( default: zero )
gallery_thumbnail_options -- options for the web photo gallery thumbnail creation
- Properties:
  - border SInt32 -- the amount of border pixels you want around your thumbnail images ( 0 - 99; default: 0 )
  - caption Boolean -- with caption ( default: false )
  - column_count SInt32 -- web photo gallery thumbnail columns ( default: 5 )
  - dimension SInt32 -- web photo gallery thumbnail dimension in pixels ( default: 75 )
  - font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- web photo gallery font ( default: Arial )
  - font_size SInt32 -- the size of the font for the thumbnail images text ( 1 - 7; default: 3 )
  - include_copyright Boolean -- include copyright for thumbnail ( default: false )
  - include_credits Boolean -- include credits for thumbnail ( default: false )
  - include_file_name Boolean -- include file name for thumbnail ( default: false )
  - include_title Boolean -- include title for thumbnail ( default: false )
  - row_count SInt32 -- web photo gallery thumbnail rows ( default: 3 )
  - size k.gallery_custom | k.gallery_large | k.gallery_medium | k.gallery_small -- the size of the thumbnail images ( default: gallery medium )
history_state -- A history state for the document
- 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 AERecord -- all of this object's properties returned in a single record
  - 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?
Illustrator_paths_export_options -- Settings related to exporting Illustrator paths
- Properties:
  - path_name UnicodeText -- name of path to export. Only valid if you are exporting a named path
  - target_path k.all_paths | k.document_bounds | k.named_path -- which path to export ( default: document bounds )
indexed_mode_options -- Settings related to changing the document mode to Indexed
- Parent:
  - change_mode_options
- Properties:
  - colors_in_palette SInt32 -- number of colors in palette (only settable for some palette types)
  - dither k.diffusion | k.noise | k.none | k.pattern -- type of dither
  - dither_amount SInt32 -- amount of dither. Only valid for diffusion ( 1 - 100 )
  - forced_colors k.black_and_white | k.none | k.primaries | k.web
  - matte k.background_color_matte | k.black_matte | k.foreground_color_matte | k.Netscape_gray | k.none | k.semi_gray | k.white_matte
  - palette 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 -- Type of palette ( default: exact )
  - preserve_exact_colors Boolean
  - transparency Boolean
info_object -- Document information
- 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
  - properties AERecord -- all of this object's properties returned in a single record
  - author UnicodeText
  - author_position UnicodeText
  - caption UnicodeText
  - caption_writer UnicodeText
  - category UnicodeText
  - city UnicodeText
  - container (r/o) ObjectSpecifier -- the object's container
  - copyright_notice UnicodeText
  - copyrighted k.copyrighted_work | k.public_domain | k.unmarked
  - country UnicodeText
  - creation_date UnicodeText
  - credit UnicodeText
  - EXIF (r/o) list of Anything
  - headline UnicodeText
  - instructions UnicodeText
  - job_name UnicodeText
  - keywords list of UnicodeText -- list of keywords
  - owner_url UnicodeText
  - province_or_state UnicodeText
  - source UnicodeText
  - supplemental_categories list of UnicodeText
  - title UnicodeText
  - transmission_reference UnicodeText
  - urgency k.four | k.high | k.low | k.none | k.normal | k.seven | k.six | k.three | k.two
layer -- A layer object
- Children:
  - layer_set
  - 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 AERecord -- all of this object's properties returned in a single record
  - all_locked Boolean
  - blend_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.pass_through | k.pin_light | k.saturation_blend | k.screen | k.soft_light | k.vivid_light
  - 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
  - name UnicodeText -- the name of the layer
  - opacity LongFloat -- master opacity of layer ( 0.0 - 100.0 )
  - visible Boolean
layer_comp -- A layer composition in a document
- 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 AERecord -- all of this object's properties returned in a single record
  - appearance Boolean -- use layer appearance
  - comment Anything -- the description of the layer comp
  - container (r/o) ObjectSpecifier -- the object's container
  - name UnicodeText -- the name of the layer comp
  - position Boolean -- use layer position
  - selected (r/o) Boolean -- the layer comp is currently selected
  - visibility Boolean -- use layer visibility
layer_set -- Layer set
- Parent:
  - layer
- Properties:
  - properties AERecord -- all of this object's properties returned in a single record
  - enabled_channels list of k.channel -- channels that are enabled for the layer set. Must be a list of component channels
- Elements:
  - art_layers -- name | index | range | relative | test
  - layers -- name | index | range | relative | test
  - layer_sets -- name | index | range | relative | test
presentation_options -- options for the PDF presentation command
- Properties:
  - auto_advance Boolean -- auto advance when viewing ( default: true )
  - downgrade_color_profile Boolean -- should the embedded color profile be downgraded to version 2 ( default: false )
  - embed_fonts Boolean -- embed fonts? Only valid if a text layer is included ( default: false )
  - encoding k.JPEG | k.ZIP -- ( default: ZIP )
  - image_interpolation Boolean -- use image interpolation? ( default: false )
  - interval SInt32 -- time in seconds before auto advancing the view ( default: 5 )
  - JPEG_quality SInt32 -- quality of produced image. Only valid for JPEG encoded PDF documents ( 0 - 12; default: 10 )
  - loop Boolean -- loop after last page ( default: false )
  - presentation Boolean -- true if the file type is presentation false for Multi-Page document ( default: false )
  - transition 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 -- transition type when switching to the next document ( default: none )
  - transparency Boolean -- ( default: true )
  - vector_data Boolean -- include vector data ( default: false )
  - view Boolean -- view the document after saving ( default: false )
selection_object -- The selection of the document
- 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
  - properties AERecord -- all of this object's properties returned in a single record
  - container (r/o) ObjectSpecifier -- the object's container
settings_object -- Preferences for Photoshop
- 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
  - properties AERecord -- all of this object's properties returned in a single record
  - additional_plugin_folder Alias
  - append_extension k.ask | k.no | k.yes
  - ask_before_saving_layered_TIFF Boolean
  - auto_update_open_documents Boolean
  - beep_when_done Boolean
  - cache_levels SInt32
  - color_picker k.Adobe_color_picker | k.Apple_color_picker | k.plug_in_color_picker | k.Windows_color_picker
  - column_gutter LongFloat -- gutter of columns (in points)
  - column_width LongFloat -- width of columns (in points)
  - create_first_snapshot Boolean -- automatically make first snapshot when a new document is created?
  - display_color_channels_in_color Boolean
  - dynamic_color_sliders Boolean
  - edit_log_items k.concise | k.detailed | k.sessiononly -- options for edit log items
  - export_clipboard Boolean
  - full_size_preview Boolean
  - gamut_warning_opacity LongFloat
  - grid_size k.large | k.medium | k.none | k.small
  - grid_style k.dashed_line | k.dotted_line | k.solid_line
  - grid_subdivisions SInt32
  - guide_style k.dashed_line | k.solid_line
  - icon_preview Boolean
  - image_previews k.ask | k.no | k.yes
  - interpolation_method k.bicubic | k.bicubic_sharper | k.bicubic_smoother | k.bilinear | k.closest_neighbor | k.none
  - keyboard_zoom_resizes_windows Boolean
  - Mac_OS_thumbnail Boolean
  - maximize_compatibility k.always | k.ask | k.never -- maximize compatibility for Photoshop (PSD) files
  - maximum_RAM_use SInt32 -- Maximum percentage of available RAM used by Photoshop ( 5 - 100 )
  - nonlinear_history Boolean -- allow non-linear history?
  - number_of_history_states SInt32 -- number of history states to remember (between 1 and 100)
  - other_cursors k.precise | k.standard
  - painting_cursors k.brush_size | k.precise | k.standard
  - pixel_doubling Boolean
  - point_size k.postscript_size | k.traditional_size -- size of point/pica
  - recent_file_list_length SInt32 -- number of items in the recent file list (between 0 and 30)
  - ruler_units k.cm_units | k.inch_units | k.mm_units | k.percent_units | k.pica_units | k.pixel_units | k.point_units -- Note: this is the unit that the scripting system will use when receiving and returning values
  - save_log_items k.both | k.log_file | k.metadata -- options for saving the history items
  - save_log_items_file Alias -- file to save the history log
  - save_palette_locations Boolean
  - show_Asian_text_options Boolean
  - show_English_font_names Boolean
  - show_slice_numbers Boolean
  - show_tool_tips Boolean
  - smart_quotes Boolean
  - type_units k.mm_units | k.pixel_units | k.point_units
  - use_additional_plugin_folder Boolean
  - use_cache_for_histograms Boolean
  - use_diffusion_dither Boolean
  - use_history_log Boolean -- Turn on and off the history logging
  - use_lowercase_extension Boolean -- should the file extension be lowercase
  - use_Shift_key_for_tool_switch Boolean
  - use_video_alpha Boolean -- this option requires hardware support
  - Windows_thumbnail Boolean
text_object -- Text item contained in an 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
  - properties AERecord -- all of this object's properties returned in a single record
  - alternate_ligatures Boolean -- use alternate ligatures?
  - antialias_method k.crisp | k.none | k.sharp | k.smoothing | k.strong
  - auto_kerning k.manual | k.metrics | k.optical -- options for auto kerning
  - auto_leading Boolean -- whether to use a font's built-in leading information
  - auto_leading_amount LongFloat -- percentage to use for auto leading
  - baseline_shift LongFloat -- baseline offset of text (unit value)
  - capitalization k.all_caps | k.normal | k.small_caps -- the case of the text
  - container (r/o) ObjectSpecifier -- the object's container
  - contents UnicodeText -- the text in the layer
  - desired_glyph_scaling LongFloat
  - desired_letter_scaling LongFloat
  - desired_word_scaling LongFloat
  - faux_bold Boolean -- use faux bold?
  - faux_italic Boolean -- use faux italic?
  - first_line_indent LongFloat -- (unit value)
  - font UnicodeText -- text face of the character
  - height LongFloat -- the height of paragraph text (unit value)
  - horizontal_scale SInt32 -- horizontal scaling of characters (in percent)
  - horizontal_warp_distortion LongFloat -- percentage from -100 to 100
  - hyphen_limit SInt32 -- maximum number of consecutive hyphens
  - hyphenate_after_first SInt32 -- hyphenate after this many letters
  - hyphenate_before_last SInt32 -- hyphenate before this many letters
  - hyphenate_capitalized_words Boolean -- wheter to hyphenate capitalized words
  - hyphenate_words_longer_than SInt32 -- hyphenate words that have more than this number of letters ( minimum 0 )
  - hyphenation Boolean -- use hyphenation?
  - hyphenation_zone LongFloat -- the hyphenation zone (unit value)
  - justification k.center | k.center_justified | k.fully_justified | k.left | k.left_justified | k.right | k.right_justified -- paragraph justification
  - kind k.paragraph_text | k.point_text -- the type of the text
  - language 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
  - leading LongFloat -- leading (unit value)
  - left_indent LongFloat -- (unit value)
  - ligatures Boolean -- use ligatures?
  - maximum_glyph_scaling LongFloat
  - maximum_letter_scaling LongFloat
  - maximum_word_scaling LongFloat
  - minimum_glyph_scaling LongFloat
  - minimum_letter_scaling LongFloat
  - minimum_word_scaling LongFloat
  - no_break Boolean
  - old_style Boolean -- use old style?
  - position AEList -- position of origin (unit value)
  - right_indent LongFloat -- (unit value)
  - Roman_hanging_punctuation Boolean -- use Roman Hanging Punctuation?
  - size LongFloat -- font size in points
  - space_after LongFloat -- (unit value)
  - space_before LongFloat -- (unit value)
  - strike_thru k.off | k.strike_box | k.strike_height -- options for strik thru of the text
  - stroke_color k.color_value -- color of text
  - text_composer k.Adobe_every_line | k.Adobe_single_line -- type of text composing engine to use
  - text_direction k.horizontal | k.vertical -- text orientation
  - tracking LongFloat -- controls uniform spacing between multiple characters
  - underline k.left | k.off | k.right -- options for underlining of the text
  - vertical_scale SInt32 -- vertical scaling of characters (in percent)
  - vertical_warp_distortion LongFloat -- percentage from -100 to 100
  - warp_bend LongFloat -- percentage from -100 to 100
  - warp_direction k.horizontal | k.vertical
  - warp_style 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
  - width LongFloat -- the width of paragraph text (unit value)
XMP_metadata
- 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
  - properties AERecord -- all of this object's properties returned in a single record
  - container (r/o) ObjectSpecifier -- the object's container
  - raw_data UnicodeText -- raw XML form of file information

Open Formats Suite

Classes for specifying options when opening document

Classes

EPS_open_options -- Settings related to opening a generic EPS document
- Parent:
  - open_options
- Properties:
  - constrain_proportions Boolean -- constrain proportions of image
  - height LongFloat -- height of image (unit value)
  - mode k.CMYK | k.grayscale | k.Lab | k.RGB -- the document mode
  - resolution LongFloat -- the resolution of the document (in pixels per inch)
  - use_antialias Boolean -- use antialias?
  - width LongFloat -- width of image (unit value)
open_options -- used with options on the open command
- Children:
  - Photo_CD_open_options
  - PDF_open_options
  - raw_format_open_options
  - EPS_open_options
PDF_open_options -- Settings related to opening a generic PDF document
- Parent:
  - open_options
- Properties:
  - constrain_proportions Boolean -- constrain proportions of image
  - height LongFloat -- height of image (unit value)
  - mode k.CMYK | k.grayscale | k.Lab | k.RGB -- the document mode
  - page SInt32 -- number of page to open
  - resolution LongFloat -- the resolution of the document (in pixels per inch)
  - use_antialias Boolean -- use antialias?
  - width LongFloat -- width of image (unit value)
Photo_CD_open_options -- Settings related to opening a PhotoCD document
- Parent:
  - open_options
- Properties:
  - color_profile_name UnicodeText -- profile to use when reading the image
  - color_space k.Lab_16 | k.Lab_8 | k.RGB_16 | k.RGB_8 -- colorspace for image
  - orientation k.landscape | k.portrait
  - pixel_size k.extra_large | k.large | k.maximum | k.medium | k.minimum | k.small -- dimensions of image
  - resolution LongFloat -- the resolution of the image (in pixels per inch)
raw_format_open_options -- Settings related to opening a raw format document
- Parent:
  - open_options
- Properties:
  - bits_per_channel SInt32 -- number of bits for each channel (8 or 16)
  - byte_order k.IBM_PC | k.Mac_OS -- only relevant for images with 16 bits per channel
  - header_size SInt32
  - height SInt32 -- height of image (in pixels)
  - interleave_channels Boolean -- are the channels in the image interleaved?
  - number_of_channels SInt32 -- number of channels in image
  - retain_header Boolean -- retain header when saving?
  - width SInt32 -- width of image (in pixels)

Save Formats Suite

Classes for specifying options when saving documents

Classes

BMP_save_options -- Settings related to saving a BMP document
- Parent:
  - save_options
- Properties:
  - bits_per_sample 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 -- number of bits per sample ( default: twenty four )
  - flipped_row_order Boolean
  - RLE_compression Boolean -- should RLE compression be used?
  - save_alpha_channels Boolean -- save alpha channels
  - target_operating_system k.OS2 | k.Windows -- target OS. Windows or OS/2 ( default: Windows )
EPS_save_options -- Settings related to saving an EPS document
- Parent:
  - save_options
- Properties:
  - embed_color_profile Boolean -- embed color profile in document
  - encoding k.ASCII | k.binary | k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG -- type of encoding to use for document ( default: binary )
  - halftone_screen Boolean -- include halftone screen ( default: false )
  - image_interpolation Boolean -- use image interpolation ( default: false )
  - PostScript_color_management Boolean -- use Postscript color management ( default: false )
  - preview_type k.eight_bit_Mac_OS | k.eight_bit_TIFF | k.JPEG_Mac_OS | k.monochrome_Mac_OS | k.monochrome_TIFF | k.none -- type of preview ( default: monochrome TIFF )
  - transfer_function Boolean -- include transfer functions in document ( default: false )
  - transparent_whites Boolean -- only valid when saving BitMap documents
  - vector_data Boolean -- include vector data
GIF_save_options -- Settings related to saving a GIF document
- Parent:
  - save_options
- Properties:
  - colors_in_palette SInt32 -- number of colors in palette (only settable for some palette types)
  - dither k.diffusion | k.noise | k.none | k.pattern -- type of dither
  - dither_amount SInt32 -- amount of dither. Only valid for diffusion ( 1 - 100; default: 75 )
  - forced_colors k.black_and_white | k.none | k.primaries | k.web
  - interlaced Boolean -- should rows be interlaced? ( default: false )
  - matte k.background_color_matte | k.black_matte | k.foreground_color_matte | k.Netscape_gray | k.none | k.semi_gray | k.white_matte
  - palette 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 -- ( default: local selective )
  - preserve_exact_colors Boolean
  - transparency Boolean
JPEG_save_options -- Settings related to saving a JPEG document
- Parent:
  - save_options
- Properties:
  - embed_color_profile Boolean -- embed color profile in document
  - format_options k.optimized | k.progressive | k.standard -- ( default: standard )
  - matte k.background_color_matte | k.black_matte | k.foreground_color_matte | k.Netscape_gray | k.none | k.semi_gray | k.white_matte
  - quality SInt32 -- quality of produced image ( 0 - 12; default: 3 )
  - scans SInt32 -- number of scans. Only valid for progressive type JPEG files ( 3 - 5 )
PDF_save_options -- Settings related to saving a pdf document
- Parent:
  - save_options
- Properties:
  - downgrade_color_profile Boolean -- should the embedded color profile be downgraded to version 2
  - embed_color_profile Boolean -- embed color profile in document
  - embed_fonts Boolean -- embed fonts? Only valid if a text layer is included
  - encoding k.JPEG | k.ZIP -- ( default: ZIP )
  - image_interpolation Boolean -- use image interpolation?
  - JPEG_quality SInt32 -- quality of produced image. Only valid for JPEG encoded PDF documents ( 0 - 12 )
  - save_alpha_channels Boolean -- save alpha channels
  - save_annotations Boolean -- save annotations
  - save_layers Boolean -- save layers
  - save_spot_colors Boolean -- save spot colors
  - transparency Boolean
  - use_outlines_for_text Boolean -- use outlines for text? Only valid if vector data is included
  - vector_data Boolean -- include vector data
Photoshop_DCS_10x2E0_save_options -- Settings related to saving a Photoshop DCS 1.0 document
- Parent:
  - save_options
- Properties:
  - DCS k.color_composite | k.grayscale_composite | k.no_composite_PostScript -- ( default: color composite )
  - embed_color_profile Boolean -- embed color profile in document
  - encoding k.ASCII | k.binary | k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG -- type of encoding to use for document ( default: binary )
  - halftone_screen Boolean -- include halftone screen ( default: false )
  - image_interpolation Boolean -- use image interpolation ( default: false )
  - preview_type k.eight_bit_Mac_OS | k.eight_bit_TIFF | k.JPEG_Mac_OS | k.monochrome_Mac_OS | k.monochrome_TIFF | k.none -- type of preview ( default: eight bit Mac OS )
  - transfer_function Boolean -- include transfer functions in document ( default: false )
  - vector_data Boolean -- include vector data
Photoshop_DCS_20x2E0_save_options -- Settings related to saving a Photoshop DCS 2.0 document
- Parent:
  - save_options
- Properties:
  - DCS k.color_composite | k.grayscale_composite | k.no_composite_PostScript -- ( default: no composite PostScript )
  - embed_color_profile Boolean -- embed color profile in document
  - encoding k.ASCII | k.binary | k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG -- type of encoding to use for document ( default: binary )
  - halftone_screen Boolean -- include halftone screen ( default: false )
  - image_interpolation Boolean -- use image interpolation ( default: false )
  - multifile_DCS Boolean -- ( default: false )
  - preview_type k.eight_bit_Mac_OS | k.eight_bit_TIFF | k.JPEG_Mac_OS | k.monochrome_Mac_OS | k.monochrome_TIFF | k.none -- type of preview ( default: eight bit Mac OS )
  - save_spot_colors Boolean -- save spot colors
  - transfer_function Boolean -- include transfer functions in document ( default: false )
  - vector_data Boolean -- include vector data
Photoshop_save_options -- Settings related to saving a Photoshop document
- Parent:
  - save_options
- Properties:
  - embed_color_profile Boolean -- embed color profile in document
  - save_alpha_channels Boolean -- save alpha channels
  - save_annotations Boolean -- save annotations
  - save_layers Boolean -- save layers
  - save_spot_colors Boolean -- save spot colors
PICT_file_save_options -- Settings related to saving a PICT document
- Parent:
  - save_options
- Properties:
  - compression k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG | k.none -- ( default: none )
  - embed_color_profile Boolean -- embed color profile in document
  - resolution k.eight | k.four | k.sixteen | k.thirty_two | k.two -- number of bits per pixel
  - save_alpha_channels Boolean -- save alpha channels
PICT_resource_save_options -- Settings related to saving a PICT resource file
- Parent:
  - save_options
- Properties:
  - compression k.high_quality_JPEG | k.low_quality_JPEG | k.maximum_quality_JPEG | k.medium_quality_JPEG | k.none -- ( default: none )
  - embed_color_profile Boolean -- embed color profile in document
  - name UnicodeText -- name of PICT resource ( default: "" )
  - resolution k.eight | k.four | k.sixteen | k.thirty_two | k.two -- number of bits per pixel
  - resource_id SInt32 -- ID of PICT resource ( default: 128 )
  - save_alpha_channels Boolean -- save alpha channels
Pixar_save_options -- Settings related to saving a Pixar document
- Parent:
  - save_options
- Properties:
  - save_alpha_channels Boolean -- save alpha channels
PNG_save_options -- Settings related to saving a PNG document
- Parent:
  - save_options
- Properties:
  - interlaced Boolean -- should rows be interlaced? ( default: false )
raw_save_options -- Settings related to saving a document in raw format
- Parent:
  - save_options
- Properties:
  - save_alpha_channels Boolean -- save alpha channels
  - save_spot_colors Boolean -- save spot colors
save_options -- used with options on the save command
- Children:
  - raw_save_options
  - 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
SGI_RGB_save_options -- Settings related to saving a document in the SGI RGB format
- Parent:
  - save_options
- Properties:
  - save_alpha_channels Boolean -- save alpha channels
  - save_spot_colors Boolean -- save spot colors
Targa_save_options -- Settings related to saving a Target document
- Parent:
  - save_options
- Properties:
  - resolution k.sixteen | k.thirty_two | k.twenty_four -- number of bits per pixel ( default: twenty four )
  - RLE_compression Boolean -- should RLE compression be used? ( default: true )
  - save_alpha_channels Boolean -- save alpha channels
TIFF_save_options -- Settings related to saving a TIFF document
- Parent:
  - save_options
- Properties:
  - byte_order k.IBM_PC | k.Mac_OS -- Default value is 'Mac OS' when running on MacOS, and 'IBM PC' when running on a PC
  - embed_color_profile Boolean -- embed color profile in document
  - image_compression k.JPEG | k.LZW | k.none | k.ZIP -- compression type ( default: none )
  - JPEG_quality SInt32 -- quality of produced image. Only valid for JPEG compressed TIFF documents ( 0 - 12 )
  - layer_compression k.RLE | k.ZIP -- should only be used when you are saving layers
  - save_alpha_channels Boolean -- save alpha channels
  - save_annotations Boolean -- save annotations
  - save_image_pyramid Boolean -- ( default: false )
  - save_layers Boolean -- save layers
  - save_spot_colors Boolean -- save spot colors
  - transparency Boolean

Filter Suite

Scripting commands for applying filters to documents

Commands

application.filter(...) -- apply a filter to one or more art layers
- k.art_layer -- the art layer object or objects to be operated upon
- using=Anything -- name of options class that the method should be invoked with. Must be a name of a class that inherits from filter options
- [with_options=k.filter_options] -- options for method
- Result: None

Classes

add_noise -- apply the add noise filter
- Parent:
  - filter_options
- Properties:
  - amount LongFloat
  - distribution k.Gaussian | k.uniform
  - monochromatic Boolean
blur -- apply the blur filter
- Parent:
  - filter_options
blur_more -- apply the blur more filter
- Parent:
  - filter_options
clouds -- apply the clouds filter
- Parent:
  - filter_options
custom_filter -- apply the custom filter
- Parent:
  - filter_options
- Properties:
  - characteristics list of SInt32 -- filter characteristics (array of 25 values - Correspons to a left to right, top to bottom traversal of array presented in the Ui)
  - scaling SInt32
  - offset SInt32
deinterlace -- apply the De-Interlace filter
- Parent:
  - filter_options
- Properties:
  - eliminate k.even_fields | k.odd_fields
  - create_new_fields_by k.duplication | k.interpolation
despeckle -- apply the despeckle filter
- Parent:
  - filter_options
difference_clouds -- apply the difference clouds filter
- Parent:
  - filter_options
diffuse_glow -- apply the diffuse glow filter
- Parent:
  - filter_options
- Properties:
  - graininess SInt32 -- (range: 0 - 10)
  - glow_amount SInt32 -- (range: 0 - 20)
  - clear_amount SInt32 -- (range: 0 - 20)
displace_filter -- apply the displace filter
- Parent:
  - filter_options
- Properties:
  - horizontal_scale SInt32
  - vertical_scale SInt32
  - kind k.stretch_to_fit | k.tile
  - undefined_areas k.repeat_edge_pixels | k.wrap_around
  - displacement_map_definition Alias
dust_and_scratches -- apply the dust and scratches filter
- Parent:
  - filter_options
- Properties:
  - radius SInt32 -- in pixels
  - threshold SInt32
filter_options -- options used with the filter method
- Children:
  - Gaussian_blur
  - 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
Gaussian_blur -- apply the Gaussian blur filter
- Parent:
  - filter_options
- Properties:
  - radius LongFloat -- in pixels
glass_filter -- apply the glass filter
- Parent:
  - filter_options
- Properties:
  - distortion SInt32 -- (range: 0 - 20)
  - smoothness SInt32 -- (range: 1 - 15)
  - scaling SInt32 -- (range: 50 - 200)
  - invert_texture Boolean -- ( default: false ) ( default: false )
  - texture_kind k.blocks | k.canvas | k.frosted | k.texture_document | k.tiny_lens
  - texture_definition Alias
high_pass -- apply the high pass filter
- Parent:
  - filter_options
- Properties:
  - radius LongFloat -- in pixels
lens_flare -- apply the lens flare filter
- Parent:
  - filter_options
- Properties:
  - brightness SInt32 -- (range: 10 - 300)
  - flare_center AEList -- position (unit value)
  - lens_type k.Movie_Prime | k.Prime_105 | k.Prime_35 | k.zoom
maximum_filter -- apply the maximum filter
- Parent:
  - filter_options
- Properties:
  - radius LongFloat -- in pixels
median_noise -- apply the median noise filter
- Parent:
  - filter_options
- Properties:
  - radius LongFloat -- in pixels
minimum_filter -- apply the minimum filter
- Parent:
  - filter_options
- Properties:
  - radius LongFloat -- in pixels
motion_blur -- apply the motion blur filter
- Parent:
  - filter_options
- Properties:
  - angle SInt32
  - radius LongFloat -- in pixels
NTSC_colors -- apply the NTSC colors filter
- Parent:
  - filter_options
ocean_ripple -- apply the ocean ripple filter
- Parent:
  - filter_options
- Properties:
  - ripple_size SInt32 -- (range: 1 - 15)
  - ripple_magnitude SInt32 -- (range: 0 - 20)
offset_filter -- apply the offset filter
- Parent:
  - filter_options
- Properties:
  - horizontal_offset LongFloat -- (unit value)
  - vertical_offset LongFloat -- (unit value)
  - undefined_areas k.repeat_edge_pixels | k.set_to_layer_fill | k.wrap_around
pinch -- apply the pinch filter
- Parent:
  - filter_options
- Properties:
  - amount SInt32 -- (range: -100 - 100)
polar_coordinates -- apply the polar coordinates filter
- Parent:
  - filter_options
- Properties:
  - kind k.polar_to_rectangular | k.rectangular_to_polar
radial_blur -- apply the radial blur filter
- Parent:
  - filter_options
- Properties:
  - amount SInt32 -- from 0 to 100
  - blur_method k.spin | k.zoom
  - quality k.best | k.draft | k.good
ripple -- apply the ripple filter
- Parent:
  - filter_options
- Properties:
  - amount SInt32 -- (range: -999 - 999)
  - ripple_size k.large | k.medium | k.small
sharpen -- apply the sharpen filter
- Parent:
  - filter_options
sharpen_edges -- apply the sharpen edges filter
- Parent:
  - filter_options
sharpen_more -- apply the sharpen more filter
- Parent:
  - filter_options
shear -- apply the shear filter
- Parent:
  - filter_options
- Properties:
  - curve list of Anything -- specification of shear curve. List of curve points
  - undefined_areas k.repeat_edge_pixels | k.wrap_around
smart_blur -- apply the smart blur filter
- Parent:
  - filter_options
- Properties:
  - radius LongFloat -- radius (range: 0 - 1000)
  - threshold LongFloat -- threshold (range: 0 - 1000)
  - quality k.high | k.low | k.medium
  - mode k.edge_only | k.normal | k.overlay_edge
spherize -- apply the spherize filter
- Parent:
  - filter_options
- Properties:
  - amount SInt32 -- (range: -100 - 100)
  - mode k.horizontal | k.normal | k.vertical
texture_fill -- apply the texture fill filter
- Parent:
  - filter_options
- Properties:
  - file_path Alias -- texture file. Must be a grayscale Photoshop file
twirl -- apply the twirl filter
- Parent:
  - filter_options
- Properties:
  - angle SInt32 -- (range: -999 - 999)
unsharp_mask -- apply the unsharp mask filter
- Parent:
  - filter_options
- Properties:
  - amount LongFloat
  - radius LongFloat -- in pixels
  - threshold SInt32 -- threshold
wave_filter -- apply the wave filter
- Parent:
  - filter_options
- Properties:
  - number_of_generators SInt32 -- number of generators
  - minimum_wavelength SInt32
  - maximum_wavelength SInt32
  - minimum_amplitude SInt32
  - maximum_amplitude SInt32
  - horizontal_scale SInt32
  - vertical_scale SInt32
  - wave_type k.sine | k.square | k.triangular
  - undefined_areas k.repeat_edge_pixels | k.wrap_around
  - random_seed SInt32
zigzag -- apply the zigzag filter
- Parent:
  - filter_options
- Properties:
  - amount SInt32 -- (range: -100 - 100)
  - ridges SInt32
  - style k.around_center | k.out_from_center | k.pond_ripples

Adjustment Suite

Scripting commands for applying adjustments to documents

Commands

application.adjust(...) -- apply an adjustment to one or more art layers
- k.art_layer -- the art layer object or objects to be operated upon
- using=Anything -- name of options class that the method should be invoked with. Must be a name of a class that inherits from adjustment options
- [with_options=k.adjustment_options] -- options for method
- Result: None

Classes

adjustment_options -- options used with the adjust method
- Children:
  - inversion
  - posterize
  - threshold_adjustment
  - equalize
  - mix_channels
  - levels_adjustment
  - selective_color
  - color_balance
  - brightness_and_contrast
  - curves
  - automatic_contrast
  - desaturate
  - automatic_levels
automatic_contrast -- adjust contrast of the selected channels automatically
- Parent:
  - adjustment_options
automatic_levels -- adjust levels of the selected channels using auto levels option
- Parent:
  - adjustment_options
brightness_and_contrast -- adjust brightness and constrast
- Parent:
  - adjustment_options
- Properties:
  - brightness_level SInt32
  - contrast_level SInt32
color_balance
- Parent:
  - adjustment_options
- Properties:
  - shadows list of SInt32 -- list of adjustments for shadows. There must be 3 values in the list
  - midtones list of SInt32 -- list of adjustments for midtones. There must be 3 values in the list
  - highlights list of SInt32 -- list of adjustments for highlights. There must be 3 values in the list
  - preserve_luminosity Boolean
curves -- adjust curves of the selected channels
- Parent:
  - adjustment_options
- Properties:
  - curve_points list of AEList -- list of curve points (number of points must be between 2 and 11)
desaturate
- Parent:
  - adjustment_options
equalize -- equalize the levels
- Parent:
  - adjustment_options
inversion -- inverts the currently selected layer or channels
- Parent:
  - adjustment_options
levels_adjustment -- adjust levels of the selected channels
- Parent:
  - adjustment_options
- Properties:
  - input_range_start SInt32
  - input_range_end SInt32
  - input_range_gamma LongFloat
  - output_range_start SInt32
  - output_range_end SInt32
mix_channels -- only valid for RGB or CMYK documents
- Parent:
  - adjustment_options
- Properties:
  - output_channels list of Anything -- 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
  - monochrome_mixing Boolean -- use monochrome mixing? If this is true you can only specify one channel value ( default: false ) ( default: false )
posterize
- Parent:
  - adjustment_options
- Properties:
  - levels SInt32
selective_color
- Parent:
  - adjustment_options
- Properties:
  - selection_method k.absolute | k.relative
  - reds list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - yellows list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - greens list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - cyans list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - blues list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - magentas list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - whites list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - neutrals list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
  - blacks list of LongFloat -- Array of 4 values: cyan, magenta, yellow, black
threshold_adjustment
- Parent:
  - adjustment_options
- Properties:
  - level SInt32

Color Suite

Color classes for Adobe Photoshop

Commands

application.convert_color(...) -- convert a object from one color model to another
- k.color_value -- color to convert
- to=k.CMYK | k.grayscale | k.HSB | k.Lab | k.RGB | k.RGB_Hex -- color model to convert to
- Result: k.color_value -- convert a object from one color model to another
application.equal_colors(...) -- are the colors visually equal?
- k.color_value -- the cPsBaseColor object to be operated upon
- with=k.color_value
- Result: Boolean -- are the colors visually equal?
application.web_safe_color(...) -- find the closest web safe color for a color
- for_=k.color_value
- Result: k.RGB_color -- find the closest web safe color for a color

Classes

CMYK_color -- A CMYK color specification
- Parent:
  - color_value
- Properties:
  - cyan LongFloat -- the cyan color value (between 0.0 and 100.0)
  - magenta LongFloat -- the magenta color value (between 0.0 and 100.0)
  - yellow LongFloat -- the yellow color value (between 0.0 and 100.0)
  - black LongFloat -- the black color value (between 0.0 and 100.0)
color_value -- A color value
- Children:
  - CMYK_color
  - gray_color
  - RGB_color
  - RGB_hex_color
  - no_color
  - HSB_color
  - Lab_color
gray_color -- A gray color specification
- Parent:
  - color_value
- Properties:
  - gray_value LongFloat -- the gray value ( 0.0 - 100.0; default: 0.0 )
HSB_color -- An HSB color specification
- Parent:
  - color_value
- Properties:
  - hue LongFloat -- the hue value (between 0.0 and 360.0)
  - saturation LongFloat -- the saturation value (between 0.0 and 100.0)
  - brightness LongFloat -- the brightness value (between 0.0 and 100.0)
Lab_color -- An Lab color specification
- Parent:
  - color_value
- Properties:
  - value_L LongFloat -- the L-value (between 0.0 and 100.0)
  - value_a LongFloat -- the a-value (between -128.0 and 127.0)
  - value_b LongFloat -- the b-value (between -128.0 and 127.0)
no_color -- represents a missing color
- Parent:
  - color_value
RGB_color -- An RGB color specification
- Parent:
  - color_value
- Properties:
  - red LongFloat -- the red color value ( 0.0 - 255.0; default: 255.0 )
  - green LongFloat -- the green color value ( 0.0 - 255.0; default: 255.0 )
  - blue LongFloat -- the blue color value ( 0.0 - 255.0; default: 255.0 )
RGB_hex_color -- A hexadecimal specification of an RGB color
- Parent:
  - color_value
- Properties:
  - hex_value UnicodeText -- the hex representation of the color. (Example '10FF4B')

Path Suite

Classes for working with art path items

Commands

application.create_selection(...) -- make a selection from this path
- k.path_item -- the path item object or objects to be operated upon
- [feather_amount=LongFloat] -- the feather amount in pixels
- [antialiasing=Boolean] -- use anti aliasing for the selection
- [operation=k.diminished | k.extended | k.intersected | k.replaced] -- the operation mode for the selection
- Result: None
application.deselect(...) -- unselect this path item, no paths items are selected
- k.path_item -- the path item object or objects to be operated upon
- Result: None
application.fill_path(...) -- fill the path with the following information
- k.path_item -- the path item object or objects to be operated upon
- [with_contents=Anything] -- color of the fill for this path
- [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] -- blending mode of the fill for this path
- [opacity=LongFloat] -- opacity of the fill for this path
- [preserving_transparency=Boolean] -- preserve the transparency of the file for this path
- [feather_amount=LongFloat] -- the feather amount in pixels
- [antialiasing=Boolean] -- use anti aliasing for the selection
- [antialiasing=Boolean] -- use all subpaths when doing fill
- Result: None
application.make_clipping_path(...) -- make this path item the clipping path for this document
- k.path_item -- the path item object or objects to be operated upon
- [flatness=LongFloat] -- flatness in device pixels
- Result: None
application.select(...) -- make this path item the active or selected path item
- k.path_item -- the path item object or objects to be operated upon
- Result: None
application.stroke_path(...) -- stroke the path with the following information
- k.path_item -- the path item object or objects to be operated upon
- [tool=k.art_history_brush_tool | k.background_eraser_tool | k.blur_tool | k.brush_tool | k.burn_tool | k.clone_stamp_tool | k.color_replacement_tool | k.dodge_tool | k.eraser_tool | k.healing_brush_tool | k.history_brush_tool | k.pattern_stamp_tool | k.pencil_tool | k.sharpen_tool | k.smudge_tool | k.sponge_tool] -- tool to use when stroking the path
- [simulate_pressure=Boolean] -- simulate the pressure when using the tool
- Result: None

Classes

path_item -- An artwork path item
- 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 AERecord -- all of this object's properties returned in a single record
  - container (r/o) ObjectSpecifier -- the object's container
  - entire_path (r/o) list of k.sub_path_info -- all the path item's sub paths
  - kind k.clipping | k.normal | k.text_mask | k.vector_mask | k.work
  - name UnicodeText -- the name of the path item
- Elements:
  - sub_path_items -- index | range | relative | test
path_point -- A point on a path
- 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 AERecord -- all of this object's properties returned in a single record
  - anchor (r/o) AEList -- the position (coordinates) of the anchor point
  - container (r/o) ObjectSpecifier -- the object's container
  - kind (r/o) k.corner_point | k.smooth_point -- the type of point: smooth/corner
  - left_direction (r/o) AEList -- location of the left direction point (in position)
  - right_direction (r/o) AEList -- location of the right direction point (out position)
path_point_info -- Path point information (returned by entire path dataClassProperty of path item class)
- Properties:
  - anchor AEList -- the position of the anchor (in coordinates)
  - kind k.corner_point | k.smooth_point -- the point type, smooth/corner
  - left_direction AEList -- location of the left direction point (in position)
  - right_direction AEList -- location of the left direction point (out position)
sub_path_info -- Sub path information (returned by entire path dataClassProperty of path item class)
- Properties:
  - closed Boolean -- is this path closed?
  - entire_sub_path list of k.path_point_info -- all the sub path item's path points
  - operation k.shape_add | k.shape_intersect | k.shape_subtract | k.shape_xor -- sub path operation on other sub paths
sub_path_item -- An artwork sub path item
- 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 AERecord -- all of this object's properties returned in a single record
  - closed (r/o) Boolean -- is this path closed?
  - container (r/o) ObjectSpecifier -- the object's container
  - entire_sub_path (r/o) list of k.path_point_info -- all the sub path item's path points
  - operation (r/o) k.shape_add | k.shape_intersect | k.shape_subtract | k.shape_xor -- sub path operation on other sub paths
- Elements:
  - path_points -- index | range | relative | test

Miscellaneous Standards Suite

Miscellaneous standard commands and classes

Commands

application.clear() -- clear current selection
- Result: None
application.copy() -- copy current selection to the clipboard
- Result: None
application.copy_merged() -- copy current selection to the clipboard. Include data in all visible layers.
- Result: None
application.cut() -- cut current selection to the clipboard
- Result: None
application.do_action(...) -- play an action from the Actions Palette
- UnicodeText -- the name of the action to play (note that the case of letters in the Action name is important and must match the case of the name in the Actions palette)
- from_=UnicodeText -- the name of the action set containing the action being played (note that the case of letters in the Action Set name is important and must match the case of the name in the Actions palette)
- Result: None
application.do_javascript(...) -- execute a JavaScript
- Anything -- JavaScript code or file to execute
- [with_arguments=list of Anything] -- arguments to pass to the JavaScript routine
- [show_debugger=k.before_running | k.never | k.on_runtime_error] -- when should a debugger be shown? ( default: never )
- Result: UnicodeText -- execute a JavaScript
application.paste(...) -- paste clipboard into the current document
- [clipping_to_selection=Boolean] -- should contents be clipped to the current selection? ( default: false )
- Result: None

NodeBox research

Adobe Photoshop CS.app terminology

AdobeScriptAutomation

Commands

Core Suite

Commands

Classes

Photoshop Suite

Commands

Classes

Open Formats Suite

Classes

Save Formats Suite

Classes

Filter Suite

Commands

Classes

Adjustment Suite

Commands

Classes

Color Suite

Commands

Classes

Path Suite

Commands

Classes

Miscellaneous Standards Suite

Commands

Suites

Commands

Classes