PhotoshopCC2018 Docs Reference Appscript

Adobe Photoshop CC 2018.
app terminology
Adobe Photoshop CC 2018.app terminology

/Applications/Adobe Photoshop CC 2018/Adobe Photoshop CC 2018.app
Suites
AdobeScriptAutomation AdobeScriptAutomation
Core Suite
Adobe Photoshop script execution menu Photoshop Suite
Open Formats Suite
Save Formats Suite
Commands Export Formats Suite
Filter Suite

_0x240x240x24_AETE_Scripts0x3DScripts_
-- Photoshop Adjustment Suite
scripting support plug-in Color Suite
[AEType("#ImR")] Path Suite
_0x240x240x24_JavaScript_Name0x3DName_ string
-- The Notifier Suite
JavaScript name to execute Miscellaneous Standards Suite
_0x240x240x24_JavaScript_File0x3DFile_ string
-- The
Commands
JavaScript file to execute
_0x240x240x24_JavaScript_Text0x3DText_ string
-- The _0x240x240x24_AETE_Scripts0x3DScripts_
JavaScript text to execute adjust
_0x240x240x24_JavaScript_Debugging0x3DDebugging_ apply
boolean
-- should the javascript be executed in debug mode? apply_layer_style
_0x240x240x24_JavaScript_Message0x3DMessage_ string
-- auto_count
the JavaScript parameters batch
change_mode
clear
close
Core Suite contract
convert
convert_color
Suite that applies to all applications
convert_to_shape
copy
Commands copy_merged
count

count
-- Return the number of elements of a particular class within create_contact_sheet
an object create_PDF_presentation
create_photo_gallery
reference
-- the object whose elements are to be counted create_photo_merge
each type_class
-- the class of the elements to be counted. create_picture_package
Result: integer
-- the number of elements create_selection
create_work_path

delete
-- Remove an element from an object crop
reference
-- the element to delete cut
delete

duplicate
-- Duplicate one or more object(s) deselect
reference
-- the object(s) to duplicate deselect
[to location_reference]
-- the new location for the object(s) do_action
do_javascript
[with_properties record]
-- new values for the properties of doc_duplicate
the duplicated element duplicate
Result: reference
-- to the duplicated object(s) duplicate
equal_colors

exists
-- Verify if an object exists exists
reference
-- the object in question expand
Result: boolean
-- true if it exists, false if not export
feather
Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]


make
-- Make a new element feature_enabled
new type_class
-- the class of the new element. fill
fill_path
at location_reference
-- the location at which to insert the filter
element flatten
[with_data anything]
-- the initial data for the element flip_canvas
[with_properties record]
-- the initial values for the properties grow
of the element import_annotations
Result: reference
-- to the new object(s) invert
link

move
-- Move object(s) to a new location load
reference
-- the object(s) to move make
make_clipping_path
to location_reference
-- the new location for the object(s) make_work_path
Result: reference
-- to the object(s) after they have been moved merge
merge_visible_layers

close
-- close the document move
document
-- the document object or objects to be operated upon open_
[saving k.ask / k.no / k.yes]
-- specifies whether changes should paste
be saved before closing ( default: ask ) Photoshop_open_dialog
print__

duplicate
-- duplicate this document without parameters purge
document
-- the document object or objects to be operated upon quit_
rasterize
Result: document
-- duplicate this document without recapture
parameters record_measurements
refresh

open_
-- open the specified document file(s) reset_from_comp
anything
-- the file(s) to be opened resize_canvas
[as_ k.Alias_PIX / k.BMP / k.Camera_RAW / resize_image
k.CompuServe_GIF / k.DICOM / k.Electric_Image / k.EPS / reveal_all
k.EPS_PICT_preview / k.EPS_TIFF_Preview / k.Filmstrip / rotate
k.JPEG / k.PCX / k.PDF / k.Photo_CD / rotate_boundary
rotate_canvas
k.Photoshop_DCS_10x2E0 / k.Photoshop_DCS_20x2E0 / save
k.Photoshop_EPS / k.Photoshop_format / k.Photoshop_PDF / scale
k.PICT_file / k.PICT_resource / k.Pixar / k.PNG / scale_boundary
k.Portable_Bitmap / k.raw / k.Scitex_CT / k.SGI_RGB / select
k.SoftImage / k.Targa / k.TIFF / k.Wavefront_RLA / select
k.Wireless_Bitmap]
-- open document as the specified type select_all
[with_options open_options]
-- options for the file type select_border
specified similar
smooth
[showing_dialogs k.always / k.error_dialogs / k.never]
-- split_channels
should a dialog be displayed when a file is opened store
[smart_object boolean]
-- create a smart object around the stroke
document being opened ( default: false ) stroke_path
translate

print__
-- print the specified object(s) translate_boundary
anything
-- the file(s) or document(s) to be printed trap
[source_space k.document_space / k.proof_space]
-- color trim
space for source ( default: document space ) unlink
web_safe_color
[print_space unicode_text]
-- color space for printer. Can be
nothing (meaning same as source) or a string specifying a Classes
specific color profile
[intent k.absolute_colorimetric / k.perceptual / add_noise
k.relative_colorimetric / k.saturation_intent]
-- if the print adjustment_options
space is different from the source space, this argument will be application
used as the color conversion intent ( default: relative art_layer

colorimetric ) automatic_contrast
[blackpoint_compensation boolean]
-- if the print space is automatic_levels
average
different from the source space, this argument indicates if the batch_options
color conversion should use black point compensation ( Bitmap_mode_options
default: true ) blur
blur_more

quit_
-- quit the application BMP_save_options
brightness_and_contrast

save
-- save the specified document Camera_RAW_open_options
document
-- the document object or objects to be operated upon change_mode_options
[in_ file_specification]
-- the file to save the document in channel
[as_ k.Alias_PIX / k.BMP / k.CompuServe_GIF / clouds
CMYK_color
k.Electric_Image / k.JPEG / k.PCX / color_balance
k.Photoshop_DCS_10x2E0 / k.Photoshop_DCS_20x2E0 / color_sampler
k.Photoshop_EPS / k.Photoshop_format / k.Photoshop_PDF / color_value
k.PICT_file / k.PICT_resource / k.Pixar / k.PNG / contact_sheet_options
k.Portable_Bitmap / k.raw / k.Scitex_CT / k.SGI_RGB / count_item
k.SoftImage / k.Targa / k.TIFF / k.Wavefront_RLA / curves
k.Wireless_Bitmap]
-- The file type to save the document as. custom_filter
Note: Wireless Bitmap format not supported, for that format, deinterlace
desaturate
use export and save for web. despeckle
[copying boolean]
-- save as copy leaving original open. DICOM_open_options
Unsaved files cannot be saved as copy difference_clouds
[appending k.lowercase_extension / k.no_extension / diffuse_glow
k.uppercase_extension]
-- append an extension to the document displace_filter
name document
[with_options save_options]
-- options for the file type dust_and_scratches
specified EPS_open_options
EPS_save_options
Result: document
-- save the specified document equalize
export_options
Classes filter_options
font

application
-- The Adobe Photoshop application gallery_banner_options
gallery_color_options
Properties:
gallery_images_options
best_type
(r/o)
type_class
-- the best type for the object's gallery_options
value gallery_security_options
class_
(r/o)
type_class
-- the object's class gallery_thumbnail_options
default_type
(r/o)
type_class
-- the default type for the gaussian_blur
object's value GIF_save_options
properties
record
-- all of this object's properties glass_filter
returned in a single record gray_color
high_pass
background_color
color_value
history_state
build
(r/o)
unicode_text
-- the build number of Adobe HSB_color
Photoshop application Illustrator_paths_export_options
color_settings
anything
-- name of selected color indexed_mode_options
settings' set info_object
current_document
document
-- the frontmost document inversion
current_tool
unicode_text
-- name of the current tool JPEG_save_options
display_dialogs
k.always / k.error_dialogs / k.never
-- Lab_color
layer
controls whether or not Photoshop displays dialogs
layer_comp
foreground_color
color_value layer_set
free_memory
(r/o)
float
-- the amount of unused lens_blur
memory available to Adobe Photoshop lens_flare

frontmost
(r/o)
boolean
-- is Photoshop the frontmost levels_adjustment
application? maximum_filter
locale
(r/o)
unicode_text
-- language locale of application measurement_scale
macintosh_file_types
(r/o)
list of unicode_text
-- list of median_noise
minimum_filter
file image types Photoshop can open
mix_channels
name
(r/o)
unicode_text
-- the application's name motion_blur
notifiers_enabled
boolean
-- enable or disable all no_color
notifiers notifier
preferences_folder
(r/o)
alias
-- full path to the NTSC_colors
preferences folder ocean_ripple
recent_files
(r/o)
list of file_specification
-- files in the offset_filter
recent file list open_options
path_item
scripting_build_date
(r/o)
unicode_text
-- the build date
path_point
of the scripting interface path_point_info
scripting_version
(r/o)
unicode_text
-- the version of the PDF_open_options
Scripting interface PDF_save_options
settings
(r/o)
settings_object
-- preference settings Photo_CD_open_options
system_information
(r/o)
unicode_text
-- system photo_filter
information of the host application and machine Photoshop_DCS_10x2E0_save_options
version
(r/o)
unicode_text
-- the version of Adobe Photoshop_DCS_20x2E0_save_options
Photoshop_save_options
Photoshop application
PICT_file_save_options
windows_file_types
(r/o)
-- list of PICT_resource_save_options
file image extensions Photoshop can open picture_package_options
Elements: pinch
documents -- by
name, index, range, relative, id, test Pixar_save_options
fonts -- by
name, index, range, relative, test PNG_save_options
notifiers -- by
index, range, relative, test polar_coordinates
posterize

document
-- A document presentation_options
radial_blur
Plural name:
raw_format_open_options
documents raw_save_options
Properties: RGB_color_
best_type
(r/o)
type_class
-- the best type for the object's RGB_hex_color
value ripple
class_
(r/o)
type_class
-- the object's class save_for_web_export_options
default_type
(r/o)
type_class
-- the default type for the save_options
object's value selection_object
selective_color
index
(r/o)
integer
-- the index of this instance of the
settings_object
object SGI_RGB_save_options
properties
record
-- all of this object's properties shadow_highlight
returned in a single record sharpen
background_layer
(r/o)
art_layer
-- The background sharpen_edges
layer for the document. Only valid for documents that sharpen_more
have a background layer shear
bits_per_channel
k.eight / k.one / k.sixteen / k.thirty_two smart_blur
spherize
-- number of bits per channel
sub_path_info
color_profile_kind
k.custom / k.none / k.working
-- sub_path_item
Type of color profile management for document. Note: If Targa_save_options
you want to set a custom color profile, do not set a value text_object
for color profile kind; rather, set the appropriate color texture_fill
profile name. threshold_adjustment
color_profile_name
unicode_text
-- Name of color TIFF_save_options
profile for document. Valid when no value is specified twirl
unsharp_mask
for color profile kind (to indicate a custom color profile).

wave_filter
component_channels
(r/o)
list of channel
-- all color XMP_metadata
component channels for this document zigzag
current_channels
list of channel
-- selected channels for
document
current_history_brush_source
history_state
-- the
current history state to use with the history brush for this
document
current_history_state
history_state
-- the current
history state for this document
current_layer
layer
-- selected layer for document
file_path
(r/o)
alias
-- full path name of document
height
(r/o)
float
-- height of document (unit value)
histogram
(r/o)
list of integer
-- a histogram of values
for the composite document (only for RGB, CMYK and
'Indexed colors' documents)
id
(r/o)
integer
-- the unique ID of this document
info
(r/o)
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?
measurement_scale
(r/o)
measurement_scale
-- The
measurement scale of the 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)
unicode_text
-- the document's name
pixel_aspect_ratio
float
-- the pixel aspect ration of the
document
quick_mask_mode
boolean
-- is the document in the
quick mask mode?
resolution
(r/o)
float
-- the resolution of the document
(in pixels per inch)
selection
(r/o)
selection_object
-- the document's
selection
width
(r/o)
float
-- width of document (unit value)
XMP_metadata
(r/o)
XMP_metadata
-- XMP metadata
associated with the document
Elements:
art_layers -- by
name, index, range, relative, id, test
channels -- by
name, index, range, relative, test
color_samplers -- by
index, range, relative, test
count_items -- by
history_states -- by
layer_comps -- by
layers -- by
layer_sets -- by
path_items -- by

Photoshop Suite
Scripting commands and classes for Adobe Photoshop
Commands

Photoshop_open_dialog
-- use the Photoshop open dialog to select
files
Result: list of file_specification
-- use the Photoshop open
dialog to select files

apply
-- apply the layer comp to the document
layer_comp
-- the layer comp object or objects to be operated
upon

apply_layer_style
art_layer
-- the art layer object or objects to be operated upon
using unicode_text
-- name of the layer style to apply

auto_count
-- automatically counts the objects in an image
document
-- the document object or objects to be operated upon
from_ channel
-- channel to use for counting
threshold integer
-- threshold to use for counting (range: 0-
255) ( 0 - 255 )

batch
-- run the batch automation routine
unicode_text
-- 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_files list of alias
-- list of input files to operate on
from_ unicode_text
-- 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)
[with_options batch_options]
-- options for Batch
Result: unicode_text
-- run the batch automation routine

change_mode
-- change the mode of the document
document
to k.bitmap / k.CMYK / k.grayscale / k.indexed_color / k.Lab /
k.multichannel / k.RGB
-- name of mode to change to
[with_options change_mode_options]
-- options for changing
the mode

contract
-- contracts the selection
selection_object
-- the selection-object object or objects to be
operated upon
by float
-- distance to contract the selection by (unit value)

convert
-- convert the document from using one color profile to
using an other
document
to_profile unicode_text
-- 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 )

convert_to_shape
-- converts the text object and its containing layer
to a fill layer with the text changed to a clipping path
text_object
-- the text-object object or objects to be operated
upon

create_PDF_presentation
-- create a PDF presentation file
-- list of input files to include in the
output
to_file file_specification
-- location of the output file
[with_options presentation_options]
-- options for the PDF
presentation
-- create a PDF presentation file

create_contact_sheet
-- create a contact sheet from multiple files
-- list of input files to include
[with_options contact_sheet_options]
-- options for Contact
Sheet
-- create a contact sheet from multiple
files

create_photo_gallery
-- Creates a web photo gallery
from_folder anything
-- folder to process or an array of files to
process
to_folder alias
-- location for output files
[with_options gallery_options]
-- options for the web photo
gallery
-- Creates a web photo gallery

create_photo_merge
-- DEPRECATED. Merges multiple files into
one, user interaction required.
-- DEPRECATED. Merges multiple files
into one, user interaction required.

create_picture_package
-- create a picture package from multiple
files
[with_options picture_package_options]
-- options for Picture
Package
-- create a picture package from multiple
files

create_work_path
-- creates a work path based on the text object
text_object
-- the text-object object or objects to be operated

upon

crop
-- crop the document
document
bounds list
-- area to crop (unit value)
[angle float]
-- angle of cropping bounds ( default: 0.0 )
[width float]
-- width of resulting document (unit value)
[height float]
-- height of resulting document (unit value)

deselect
document

doc_duplicate
-- duplicate this document with parameters
document
[name unicode_text]
-- name for the new document
[merge_layers_only boolean]
-- duplicate merged layers only
Result: document
-- duplicate this document with parameters

expand
-- expand selection
selection_object
operated upon
by float
-- distance to expand the selection by (unit value)

export
document
in_ file_specification
-- the file to export to
[as_ k.Illustrator_paths / k.save_for_web]
-- the type of export
( default: Illustrator paths )
[with_options export_options]
-- options for the export type
specified

feather
-- feather edges of selection
selection_object
operated upon
by float
-- amount to feather the edge by (unit value)

feature_enabled
-- is the feature with the given name enabled?
name unicode_text
-- name of the feature
Result: boolean
-- is the feature with the given name enabled?

fill
-- fills the selection
selection_object
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.darker_color /
k.difference / k.dissolve / k.divide / k.exclusion / k.hard_light /
k.hard_mix / k.hue_blend / k.lighten / k.lighter_color /
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.subtract /
k.vivid_light]
-- ( default: normal )
[opacity integer]
-- ( default: 100 )
[preserving_transparency boolean]


flatten
-- Flattens all visible layers in the document.
document

flip_canvas
-- flip the canvas horizontally or vertically
document
direction k.horizontal / k.vertical
-- which way to flip the
canvas

grow
-- grow selection to include all adjacent pixels falling within
the specified tolerance range
selection_object
operated upon
tolerance integer
-- ( 0 - 255 )
antialiasing boolean

import_annotations
-- import annotations into the document
document
from_ alias
-- document to import annotations from

invert
-- invert the selection
selection_object
operated upon

link
-- link the layer with another layer
layer
-- the layer object or objects to be operated upon
with_ layer
-- layer to link to

load
-- load the selection from a channel
selection_object
operated upon
from_ 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 )

make_work_path
-- make this selection item the work path for this
document
selection_object
operated upon
[tolerance float]
-- tolerance in pixels

merge
-- Merges an art layer or layer set into the layer below, or
merges a spot channel into the component channels. Merging a layer
or layer set returns a reference to the resulting layer. Merging a
channel does not return any value.
channel
-- the channel object or objects to be operated upon

merge_visible_layers
-- flatten all visible layers in the document
document

purge
-- purges one or more caches
k.all_caches / k.clipboard_cache / k.history_caches /
k.undo_caches
-- what to purge


rasterize
art_layer
affecting k.all_linked_layers / k.entire_layer / k.fill_content /
k.layer_clipping_path / k.shape / k.text_contents
-- what to
rasterize

recapture
-- recapture the current layer state(s) for this layer comp
layer_comp
upon

record_measurements
-- record measurements of document
document
[source k.measure_count_tool / k.measure_ruler_tool /
k.measure_selection]
-- source of the measurements to record
[data_points list of unicode_text]
-- array of identifiers of data
points to record. Any data points not appropriate for the
specified source will be ignored

refresh
-- pause the script until the application refreshes

reset_from_comp
-- reset the layer comp state to the document state
layer_comp
upon

resize_canvas
-- change the size of the canvas
document
[width float]
-- desired width of canvas (unit value)
[height float]
-- 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 )

resize_image
-- change the size of the image
document
[width float]
-- desired width of image (unit value)
[height float]
-- desired height of image (unit value)
[resolution float]
-- (in pixels per inch)
[resample_method k.automatic / k.bicubic /
k.bicubic_automatic / k.bicubic_sharper / k.bicubic_smoother /
k.bilinear / k.closest_neighbor / k.none / k.preserve_details]
--
what method should be used for resampling pixels ( default:
bicubic )
[amount integer]
-- amount of noise value when using preserve
details (range: 0 - 100) ( 0 - 100; default: 0 )

reveal_all
-- expand document to show clipped sections
document

rotate
layer
angle float


-- point
to rotate about ( default: middle center )

rotate_boundary
-- rotates the boundary of selection
selection_object
operated upon
angle float
-- point

rotate_canvas
-- rotate canvas of document
document
angle float
-- number of degrees to rotate. A positive angle will
rotate the canvas clockwise; a negative value will rotate the
canvas counter-clockwise

scale
layer
[horizontal_scale float]
-- percentage ( default: 100.0 )
[vertical_scale float]
-- point

scale_boundary
-- scale the boundary of selection
selection_object
operated upon
[horizontal_scale float]
[vertical_scale float]
-- point
to scale about ( default: middle center )

select
-- change the selection
document
region list of anything
-- list of corners of the selection (in
pixels)
k.replaced]
-- how to combine the new selection with the
existing selection ( default: replaced )
[feather_amount float]
-- feather amount ( default: 0.0 )
[antialiasing boolean]
-- whether to use antialiasing ( default:
true )

select_all
-- select the entire image
document

select_border
-- select the border of the selection
selection_object
operated upon

width float
-- width of border selection (unit value)

similar
-- grow selection to include pixels throughout the image
falling within the tolerance range
selection_object
operated upon
tolerance integer
antialiasing boolean

smooth
selection_object
operated upon
radius integer
-- sample radius in pixels ( 0 - 100 )

split_channels
-- split channels of the document
document
Result: list of document
-- split channels of the document

store
-- save the selection as a channel
selection_object
operated upon
into channel
-- the channel to save the selection to
k.replaced]
-- how to add the selection to the existing contents
of the channel ( default: replaced )

stroke
-- strokes the selection
selection_object
operated upon
using_color anything
-- color to stroke selection with
width integer
-- width of stroke (in pixels)
[location k.center / k.inside / k.outside]
-- ( default: center )
k.vivid_light]
-- ( default: normal )
[opacity integer]
-- ( default: 100 )

translate
-- moves the position relative to its current position
layer
[delta_x float]
-- horizontal transformation (unit value)
[delta_y float]
-- vertical transformation (unit value)

translate_boundary
-- moves the boundary of selection relative to
its current position
selection_object
operated upon
[delta_x float]
-- horizontal transformation (unit value)
[delta_y float]
-- vertical transformation (unit value)


trap
-- apply trap to a CMYK document
document
width integer
-- trap width in pixels

trim
document
[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 )

unlink
-- unlink the layer
layer
Classes

art_layer
-- any layer that can contain data
Plural name:
art_layers
Inherits from:
layer
Properties:
background_layer
boolean
-- is the layer a background
layer?
fill_opacity
float
-- 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.black_and_white_layer /
k.brightness_contrast_layer / k.channel_mixer_layer /
k.color_balance_layer / k.color_lookup / k.curves_layer /
k.exposure_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.photo_filter_layer /
k.posterize_layer / k.selective_color_layer /
k.smart_object_layer / k.solid_fill_layer / k.text_layer /
k.threeD_layer / k.threshold_layer / k.vibrance_layer /
k.video_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)
text_object
-- the text that is associated
with the art layer. Only valid for art layers whose 'kind' is
a text layer
transparent_pixels_locked
boolean


batch_options
-- options for the Batch command
Properties:
destination
k.folder / k.none / k.save_and_close
-- final
destination of processed files ( default: none )
destination_folder
alias
-- folder location when using
destination to a folder
error_file
alias
-- file to log errors encountered, leave
this blank to stop for errors
file_naming
list of k.ddmm / k.ddmmyy /
k.document_name_3 / k.document_name_lower /
k.document_name_mixed / k.extension_lower /
k.extension_upper / k.mmdd / k.mmddyy /
k.serial_letter_lower / k.serial_letter_upper /
k.serial_number_four / k.serial_number_one /
k.serial_number_three / k.serial_number_two /
k.yyddmm / k.yymmdd / k.yyyymmdd
-- list of file naming
options 6 max.
macintosh_compatible
boolean
-- make final file name
Macintosh compatible ( default: true )
override_open
boolean
-- override action open
commands ( default: false )
override_save
boolean
-- override save as action steps
with destination specified here ( default: false )
startingserial
integer
-- starting serial number to use (
default: 1 )
suppress_open
boolean
-- suppress file open options
dialogs ( default: false )
suppressprofile
boolean
-- suppress color profile
warnings ( default: false )
unix_compatible
boolean
-- make final file name Unix
compatible ( default: true )
windows_compatible
boolean
-- make final file name
Windows compatible ( default: true )

Bitmap_mode_options
-- Settings related to changing the document
mode to Bitmap
Inherits from:
change_mode_options
Properties:
angle
float
-- 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
float
-- only valid for 'halftone screen'
conversions
pattern_name
unicode_text
-- only valid for 'custom
pattern' conversions
resolution
float
-- output resolution (in pixels per inch) (
default: 72.0 )
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
Inherited by:
Bitmap_mode_options
indexed_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
Plural name:
channels
Properties:
best_type
(r/o)
type_class
-- the best type for the object's
value
class_
(r/o)
type_class
-- the object's class
default_type
(r/o)
type_class
-- the default type for the
object's value
index
(r/o)
integer
object
properties
record
-- all of this object's properties
returned in a single record
channel_color
color_value
-- color of the channel (not
valid for component channels)
container
(r/o)
reference
-- the object's container
histogram
(r/o)
list of integer
-- 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
unicode_text
-- the channel's name
opacity
float
-- opacity of alpha channels (called solidity
for spot channels)
visible
boolean

color_sampler
-- A color sampler in a document. See the color
sampler tool.
Plural name:
color_samplers
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
color_sampler_color
(r/o)
color_value
-- color of the
color sampler
container
(r/o)
reference
position
(r/o)
list
-- position of the color sampler (unit

value)

contact_sheet_options
-- Options for the Contact Sheet command
Properties:
across_first
boolean
-- place the images horizontally
first ( default: true )
auto_spacing
boolean
-- auto space the images in the
contact sheet ( default: true )
best_fit
boolean
-- rotate images for best fit ( default:
false )
caption
boolean
-- use the filename as a caption for the
image ( default: true )
column_count
integer
-- contact sheet columns ( default:
5)
flatten_final
boolean
-- flatten all layers in the final
document ( default: true )
font
k.Arial / k.Courier_New / k.Helvetica /
k.Times_New_Roman
-- font used for the caption (
default: Arial )
font_size
integer
-- font size used for the caption (
default: 12 )
height
integer
-- height of the resulting document in
pixels ( default: 720 )
horizontal_offset
integer
-- horizontal spacing between
images in pixels ( default: 1 )
mode
k.bitmap / k.CMYK / k.grayscale / k.Lab / k.RGB
--
document mode (Grayscale, RGB, CMYK or Lab) (
default: RGB )
resolution
float
-- the resolution of the document (in
pixels per inch) ( default: 72.0 )
row_count
integer
-- contact sheet rows ( default: 6 )
vertical_offset
integer
-- vertical spacing between
images in pixels ( default: 1 )
width
integer
-- width of the resulting document in
pixels ( default: 576 )

count_item
-- A counted item in a document. See the counting tool.
Plural name:
count_items
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
container
(r/o)
reference
position
(r/o)
list
-- position of count item (unit value)

font
-- An installed font
Plural name:

fonts
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
family
(r/o)
unicode_text
-- the font's family
name
(r/o)
unicode_text
-- The font's text face name
PostScript_name
(r/o)
unicode_text
-- the font's
PostScript name
style
(r/o)
unicode_text
-- the font's style name

gallery_banner_options
-- Options for the web photo gallery banner
options
Properties:
contact_info
unicode_text
-- web photo gallery contact
info ( default: )
date_
unicode_text
-- web photo gallery date ( default: )
font
k.Times_New_Roman
-- the font setting for the banner
text ( default: Arial )
font_size
integer
-- the size of the font for the banner
text ( 1 - 7; default: 3 )
photographer
unicode_text
-- web photo gallery
photographer ( default: )
site_name
unicode_text
-- web photo gallery site name (
default: Adobe Web Photo Gallery )

-- Options for the web photo gallery colors
Properties:
active_link_color
RGB_color_
-- active link color
background_color
RGB_color_
-- background color
banner_color
RGB_color_
-- banner color
link_color
RGB_color_
-- link color
text_color
RGB_color_
-- text color
visited_link_color
RGB_color_
-- visited link color

-- Options for the web photo gallery images
Properties:
border
integer
-- 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
integer
-- resized image dimensions in pixels
( default: 350 )
font
k.Times_New_Roman
-- font for the gallery images text (
default: Arial )
font_size
integer
-- font size for the gallery images text (

1 - 7; default: 3 )
image_quality
integer
-- 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
gallery_banner_options
-- options
related to banner settings
custom_color_options
-- options
related to custom color settings
email_address
unicode_text
-- the email address to show
on the web page ( default: )
images_options
-- options
related to images settings
layout_style
unicode_text
-- 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
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
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
unicode_text
-- web photo gallery security
custom text ( default: )
font
k.Times_New_Roman
-- web photo gallery security font (
default: Arial )
font_size
integer
-- web photo gallery security font size (
minimum 1; default: 36 )
opacity
integer
-- web page security opacity as a percent
( default: 100 )
text_color
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
integer
-- the amount of border pixels you want
around your thumbnail images ( 0 - 99; default: 0 )
caption
boolean
-- with caption ( default: false )
column_count
integer
-- web photo gallery thumbnail
columns ( default: 5 )
dimension
integer
-- web photo gallery thumbnail
dimension in pixels ( default: 75 )
font
k.Times_New_Roman
-- web photo gallery font ( default:
Arial )
font_size
integer
-- 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
integer
-- 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
Plural name:
history_states
Properties:
best_type
(r/o)
type_class
value

class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
container
(r/o)
reference
name
(r/o)
unicode_text
-- the history state's name
snapshot
(r/o)
boolean
-- is the history state a snapshot?

indexed_mode_options
-- Settings related to changing the document
mode to Indexed
Inherits from:
change_mode_options
Properties:
colors_in_palette
integer
-- 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
integer
-- 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_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
properties
record
author
unicode_text
author_position
unicode_text
caption
unicode_text
caption_writer
unicode_text
category
unicode_text
city
unicode_text
container
(r/o)
reference
copyright_notice
unicode_text
copyrighted
k.copyrighted_work / k.public_domain /
k.unmarked

country
unicode_text
creation_date
unicode_text
credit
unicode_text
EXIF
(r/o)
list of anything
headline
unicode_text
instructions
unicode_text
job_name
unicode_text
keywords
-- list of keywords
owner_url
unicode_text
province_or_state
unicode_text
source
unicode_text
supplemental_categories
title
unicode_text
transmission_reference
unicode_text
urgency
k.four / k.high / k.low / k.none / k.normal /
k.seven / k.six / k.three / k.two

layer
-- A layer object
Plural name:
layers
Inherited by:
art_layer
layer_set
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
all_locked
boolean
blend_mode
k.color_blend / k.color_burn /
k.color_dodge / k.darken / k.darker_color / k.difference /
k.dissolve / k.divide / k.exclusion / k.hard_light /
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.subtract / k.vivid_light
bounds
(r/o)
list
-- Bounding rectangle of the Layer
container
(r/o)
reference
id
(r/o)
integer
-- the unique ID of this layer
itemindex
(r/o)
integer
-- the layer index sans layer
groups, how Photoshop would index them
linked_layers
(r/o)
list of layer
name
unicode_text
-- the name of the layer
opacity
float
-- master opacity of layer ( 0.0 - 100.0 )
visible
boolean

layer_comp
-- A layer composition in a document
Plural name:

layer_comps
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index (r/o)
integer
object
properties
record
appearance
boolean
-- use layer appearance
comment
anything
-- the description of the layer comp
container
(r/o)
reference
name
unicode_text
-- 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
Plural name:
layer_sets
Inherits from:
layer
Properties:
enabled_channels
list of channel
-- channels that are
enabled for the layer set. Must be a list of component
channels
Elements:
art_layers -- by
layers -- by
layer_sets -- by

measurement_scale
-- Document Measurement Scale
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
properties
record
container
(r/o)
reference
logical_length
float
-- the logical length this scale
equates to
logical_units
unicode_text
-- the logical units for this
scale
name
unicode_text
-- the name of this scale
pixel_length
integer
-- the length in pixels this scale
equates to

picture_package_options
-- options for the Picture Package
command

Properties:
content
k.caption_text / k.copyright_text / k.credit_text /
k.filename_text / k.no_text / k.origin_text / k.user_text
--
content information ( default: no text )
custom_text
unicode_text
-- picture package custom text
( default: )
flatten_final
boolean
-- flatten all layers in the final
document ( default: true )
font
k.Times_New_Roman
-- font used for the text ( default:
Arial )
font_size
integer
-- font size used for the caption (
default: 12 )
layout
unicode_text
-- layout to use to generate the
picture package ( default: (2)5x7 )
mode
k.bitmap / k.CMYK / k.grayscale / k.Lab / k.RGB
--
document mode (Grayscale, RGB, CMYK or Lab) (
default: RGB )
opacity
integer
-- web page security opacity as a percent
( default: 100 )
resolution
float
pixels per inch) ( default: 72.0 )
text_color
RGB_color_
-- text color
text_position
k.gallery_centered / k.gallery_lower_left /
k.gallery_lower_right / k.gallery_upper_left /
k.gallery_upper_right
-- 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
-- text rotate ( default: zero )

presentation_options
-- options for the PDF presentation command
Properties:
auto_advance
boolean
-- auto advance when viewing (
default: true )
include_file_name
boolean
-- include file name for
image ( default: false )
interval
integer
-- time in seconds before auto advancing
the view ( default: 5 )
loop
boolean
-- loop after last page ( default: false )
magnification
k.actual_size / k.fit_page
-- magnification
type when viewing the image ( default: actual size )
PDF_options
PDF_save_options
-- Options used when
creating the PDF file
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 )


selection_object
-- The selection of the document
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
properties
record
bounds
(r/o)
list
-- bounding rectangle of the entire
selection
container
(r/o)
reference
solid
(r/o)
boolean
-- is the bounding rectangle a solid
rectangle

settings_object
-- Preferences for Photoshop
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
properties
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
integer
color_picker
k.Adobe_color_picker /
k.Apple_color_picker / k.plug_in_color_picker /
k.Windows_color_picker
column_gutter
float
-- gutter of columns (in points)
column_width
float
-- 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
font_preview_size
k.extra_large / k.none /
k.preview_huge / k.preview_large / k.preview_medium /
k.preview_small
-- show font previews in the type tool
font menus
full_size_preview
boolean
gamut_warning_opacity
float
grid_size
k.large / k.medium / k.none / k.small
grid_style
k.dashed_line / k.dotted_line / k.solid_line
grid_subdivisions
integer
guide_style
k.dashed_line / k.solid_line
icon_preview
boolean

image_previews
k.ask / k.no / k.yes
interpolation_method
k.automatic / k.bicubic /
k.bicubic_automatic / k.bicubic_sharper /
k.bicubic_smoother / k.bilinear / k.closest_neighbor /
k.none / k.preserve_details
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
integer
-- Maximum percentage
of available RAM used by Photoshop ( 5 - 100 )
nonlinear_history
boolean
-- allow non-linear history?
number_of_history_states
integer
-- 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
integer
-- 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 object contained in an art layer
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value

properties
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
float
-- percentage to use for auto
leading
baseline_shift
float
-- baseline offset of text (unit value)
capitalization
k.all_caps / k.normal / k.small_caps
-- the
case of the text
container
(r/o)
reference
contents
unicode_text
-- the text in the layer
desired_glyph_scaling
float
desired_letter_scaling
float
desired_word_scaling
float
faux_bold
boolean
-- use faux bold?
faux_italic
boolean
-- use faux italic?
first_line_indent
float
-- (unit value)
font
unicode_text
-- text face of the character
height
float
-- the height of paragraph text (unit value)
horizontal_scale
integer
-- horizontal scaling of
characters (in percent)
horizontal_warp_distortion
float
-- percentage from
-100 to 100
hyphen_limit
integer
-- maximum number of
consecutive hyphens
hyphenate_after_first
integer
-- hyphenate after this
many letters
hyphenate_before_last
integer
-- hyphenate before this
many letters
hyphenate_capitalized_words
boolean
-- wheter to
hyphenate capitalized words
hyphenate_words_longer_than
integer
-- hyphenate
words that have more than this number of letters (
minimum 0 )
hyphenation
boolean
-- use hyphenation?
hyphenation_zone
float
-- 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
float
-- leading (unit value)
left_indent
float
-- (unit value)

ligatures
boolean
-- use ligatures?
maximum_glyph_scaling
float
maximum_letter_scaling
float
maximum_word_scaling
float
minimum_glyph_scaling
float
minimum_letter_scaling
float
minimum_word_scaling
float
no_break
boolean
old_style
boolean
-- use old style?
position
list
-- position of origin (unit value)
right_indent
float
-- (unit value)
Roman_hanging_punctuation
boolean
-- use Roman
Hanging Punctuation?
size
float
-- font size in points
space_after
float
-- (unit value)
space_before
float
-- (unit value)
strike_thru
k.off / k.strike_box / k.strike_height
--
options for strik thru of the text
stroke_color
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
float
-- controls uniform spacing between
multiple characters
underline
k.left / k.off / k.right
-- options for underlining
of the text
vertical_scale
integer
-- vertical scaling of characters (in
percent)
vertical_warp_distortion
float
-- percentage from -100
to 100
warp_bend
float
-- 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
float
-- the width of paragraph text (unit value)

XMP_metadata
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
properties
record
container
(r/o)
reference
raw_data
unicode_text
-- raw XML form of file
information

Open Formats Suite

Classes for specifying options when opening document
Classes

Camera_RAW_open_options
-- Settings related to opening a
camera RAW document
Inherits from:
open_options
Properties:
bits_per_channel
k.eight / k.one / k.sixteen / k.thirty_two
blue_hue
integer
-- the blue hue of the shot
blue_saturation
integer
-- the blue saturation of the shot
brightness
integer
-- the brightness of the shot
chromatic_aberration_by
integer
-- the chromatic
aberration B/Y of the shot
chromatic_aberration_rc
integer
-- the chromatic
aberration R/C of the shot
color_noise_reduction
integer
-- the color noise
reduction of the shot
color_space
k.Adobe_RGB / k.color_match_RGB /
k.ProPhoto_RGB / k.sRGB
-- colorspace for image
contrast
integer
-- the constrast of the shot
exposure
float
-- the exposure of the shot
green_hue
integer
-- the green hue of the shot
green_saturation
integer
-- the green saturation of the
shot
luminance_smoothing
integer
-- the luminance
smoothing of the shot
red_hue
integer
-- the red hue of the shot
red_saturation
integer
-- the red saturation of the shot
resolution
float
pixels per inch)
saturation
integer
-- the saturation of the shot
settings
k.camera_default / k.custom_settings /
k.selected_image
-- global settings for all Camera RAW
options ( default: camera default )
shadow_tint
integer
-- the shadow tint of the shot
shadows
integer
-- the shadows of the shot
sharpness
integer
-- the sharpness of the shot
size
k.extra_large / k.large / k.maximum / k.medium /
k.minimum / k.small
-- size of the new document
temperature
integer
-- the temperature of the shot
tint
integer
-- the tint of the shot
vignetting_amount
integer
-- the vignetting amount of
the shot
vignetting_midpoint
integer
-- the vignetting mid point
of the shot
white_balance
k.as_shot / k.auto / k.cloudy /
k.custom_camera_settings / k.daylight / k.flash /
k.fluorescent / k.shade / k.tungsten
-- white balance

options for the image

DICOM_open_options
-- Settings related to opening a DICOM
document
Inherits from:
open_options
Properties:
anonymize
boolean
-- Anonymize the patient
information
columns
integer
-- The number of columns in n-up
configuration
reverse
boolean
-- Reverse(Invert) the image
rows
integer
-- The number of rows in n-up
configuration
show_overlays
boolean
-- Show Overlays (if present)
windowlevel
integer
-- Window Level
windowwidth
integer
-- Window Width

EPS_open_options
-- Settings related to opening a generic EPS
document
Inherits from:
open_options
Properties:
constrain_proportions
boolean
-- constrain proportions
of image
height
float
-- height of image (unit value)
mode
k.CMYK / k.grayscale / k.Lab / k.RGB
-- the
document mode
resolution
float
pixels per inch)
use_antialias
boolean
-- use antialias?
width
float
-- width of image (unit value)

open_options
-- used with options on the open command
Inherited by:
Camera_RAW_open_options
DICOM_open_options
EPS_open_options
PDF_open_options
Photo_CD_open_options

PDF_open_options
-- Settings related to opening a generic PDF
document
Inherits from:
open_options
Properties:
bits_per_channel
k.eight / k.one / k.sixteen / k.thirty_two
constrain_proportions
boolean
-- DEPRECATED, no
longer used in CS2 ( constrain proportions of image )
crop_page
k.art_box / k.bleed_box / k.bounding_box /
k.crop_box / k.media_box / k.trim_box
-- crop the page
height
float
-- DEPRECATED, no longer used in CS2 (

height of image (unit value) )

mode
k.CMYK / k.grayscale / k.Lab / k.RGB
-- the
document mode
name
unicode_text
-- name of the new document
object
integer
-- number of 3d object to open
page
integer
-- number of page or image to open
resolution
float
pixels per inch)
suppress_warnings
boolean
-- supress any warnings
that may occur during opening
use_3d_object_number
boolean
-- 3d property refers to
using 3d object, if false then UsePageNumber is used
use_antialias
boolean
-- use antialias?
use_page_number
boolean
-- page property refers to
page number, if false page property refers to image
number
width
float
-- DEPRECATED, no longer used in CS2 (
width of image (unit value) )

Photo_CD_open_options
-- Settings related to opening a PhotoCD
document
Inherits from:
open_options
Properties:
color_profile_name
unicode_text
-- 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
float
-- the resolution of the image (in pixels
per inch)

-- Settings related to opening a raw
format document
Inherits from:
open_options
Properties:
bits_per_channel
integer
-- 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
integer
height
integer
-- height of image (in pixels)
interleave_channels
boolean
-- are the channels in the
image interleaved?
number_of_channels
integer
-- number of channels in
image
retain_header
boolean
-- retain header when saving?
width
integer
-- 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
Inherits from:
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
Inherits from:
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
Inherits from:
save_options
Properties:
colors_in_palette
integer
-- number of colors in palette

(only settable for some palette types)

dither
-- type of
dither
dither_amount
integer
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
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
Inherits from:
save_options
Properties:
embed_color_profile
boolean
document
format_options
k.optimized / k.progressive / k.standard
-- ( default: standard )
matte
quality
integer
-- quality of produced image ( 0 - 12;
default: 3 )
scans
integer
-- number of scans. Only valid for
progressive type JPEG files ( 3 - 5 )

PDF_save_options
-- Settings related to saving a pdf document
Inherits from:
save_options
Properties:
color_conversion
boolean
-- convert the color profile to
a destination profile
description
unicode_text
-- description of the save
options in use
destination_profile
unicode_text
-- describes the final
RGB or CMYK output device, such as your monitor or a
certain press standard
down_sample
k.none / k.PDF_average / k.PDF_bicubic
/ k.PDF_subsample
-- down sample method to use
down_sample_limit
float
-- limits
downsampleing/subsampling to images that exceed this
value (in pixels per inch)
down_sample_size
float
-- down sample images to this
size if they exceed limit (in pixels per inch)

downgrade_color_profile
boolean
-- DEPRECATED,
no longer used in CS2 ( should the embedded color
profile be downgraded to version 2 )
eight_convert
boolean
-- converts a 16-bit image to 8-bit
for better compatibility with other applications
embed_color_profile
boolean
document
embed_fonts
boolean
-- DEPRECATED, no longer used
in CS2 ( embed fonts? Only valid if a text layer is
included )
embed_thumbnail
boolean
-- Includes a small preview
image in Acrobat
encoding
k.JPEG / k.JPEG_2000_high /
k.JPEG_2000_lossless / k.JPEG_2000_low /
k.JPEG_2000_med / k.JPEG_2000_med_high /
k.JPEG_2000_med_low / k.JPEG_high / k.JPEG_low /
k.JPEG_med / k.JPEG_med_high / k.JPEG_med_low /
k.none / k.ZIP / k.ZIP_4
-- ZIP, JPEG and JPEG2000
encoding and compression options
image_interpolation
boolean
-- DEPRECATED, no
longer used in CS2 ( use image interpolation? )
JPEG_quality
integer
-- Only valid for JPEG encoding.
Use encoding options instead of this property. Quality of
produced image. Only valid for JPEG encoded PDF
documents ( 0 - 12 )
output_condition
unicode_text
-- an optional comment
field for inserting descriptions of the output condition.
The text is stored in the PDF/X file.
output_condition_id
unicode_text
-- identifier for the
output condition
PDF_compatibility
k.PDF_13 / k.PDF_14 / k.PDF_15 /
k.PDF_16 / k.PDF_17
-- PDF version to be compatible
with
PDF_standard
k.none / k.PDFX1a2001_standard /
k.PDFX1a2003_standard / k.PDFX32002_standard /
k.PDFX32003_standard / k.PDFX42008_standard
--
PDF Standard to be compatible with
preserve_editing
boolean
-- Lets you reopen the PDF in
Photoshop with native Photoshop data intact
presetfile
unicode_text
-- preset file to use for settings,
may override 'save as' dialog settings
profile_inclusion_policy
boolean
-- shows which
profiles to include
registry_name
unicode_text
-- URL where the output
condition is registered
save_alpha_channels
boolean
save_annotations
boolean
-- save annotations
save_layers
boolean
-- save layers
save_spot_colors
boolean
-- save spot colors
tile_size
integer
-- compression option supported only
with JPEG2000 compression
transparency
boolean
-- DEPRECATED, no longer
used in CS2
use_outlines_for_text
boolean
-- DEPRECATED, no

longer used in CS2 ( use outlines for text? Only valid if

vector data is included )
vector_data
boolean
-- DEPRECATED, no longer used
in CS2 ( include vector data )
view
boolean
-- Opens the saved PDF in Acrobat
web_optimize
boolean
-- Improves performance of
PDFs on Web servers

Photoshop_DCS_10x2E0_save_options
-- Settings related to
saving a Photoshop DCS 1.0 document
Inherits from:
save_options
Properties:
DCS
k.color_composite / k.grayscale_composite /
k.no_composite_PostScript
-- ( default: color composite )
embed_color_profile
boolean
document
encoding
halftone_screen
boolean
default: false )
image_interpolation
boolean
( default: false )
preview_type
default: eight bit Mac OS )
transfer_function
boolean
vector_data
boolean

-- Settings related to
saving a Photoshop DCS 2.0 document
Inherits from:
save_options
Properties:
DCS
k.color_composite / k.grayscale_composite /
k.no_composite_PostScript
-- ( default: no composite
PostScript )
embed_color_profile
boolean
document
encoding
halftone_screen
boolean
default: false )
image_interpolation
boolean
( default: false )
multifile_DCS
boolean
-- ( default: false )
preview_type

default: eight bit Mac OS )
save_spot_colors
boolean
-- save spot colors
transfer_function
boolean
vector_data
boolean

-- Settings related to saving a Photoshop
document
Inherits from:
save_options
Properties:
embed_color_profile
boolean
document
save_alpha_channels
boolean
save_annotations
boolean
-- save annotations
save_layers
boolean
-- save layers
save_spot_colors
boolean
-- save spot colors

-- Settings related to saving a PICT
document
Inherits from:
save_options
Properties:
compression
k.high_quality_JPEG /
k.medium_quality_JPEG / k.none
-- ( default: none )
embed_color_profile
boolean
document
resolution
k.eight / k.four / k.sixteen / k.thirty_two /
k.two
-- number of bits per pixel
save_alpha_channels
boolean

PICT_resource_save_options
-- Settings related to saving a PICT
resource file
Inherits from:
save_options
Properties:
compression
k.high_quality_JPEG /
k.medium_quality_JPEG / k.none
-- ( default: none )
embed_color_profile
boolean
document
name
unicode_text
-- name of PICT resource ( default:
"" )
resolution
k.eight / k.four / k.sixteen / k.thirty_two /
k.two
-- number of bits per pixel
resource_id
integer
-- ID of PICT resource ( default:
128 )
save_alpha_channels
boolean

Pixar_save_options
-- Settings related to saving a Pixar document
Inherits from:
save_options

Properties:
save_alpha_channels
boolean

PNG_save_options
-- Settings related to saving a PNG document
Inherits from:
save_options
Properties:
compression
integer
-- compression used on the image. (
0 - 9; default: 0 )
interlaced
boolean
-- should rows be interlaced? (
default: false )

raw_save_options
-- Settings related to saving a document in raw
format
Inherits from:
save_options
Properties:
save_alpha_channels
boolean
save_spot_colors
boolean
-- save spot colors

save_options
-- used with options on the save command
Inherited by:
BMP_save_options
EPS_save_options
GIF_save_options
JPEG_save_options
PDF_save_options
PICT_resource_save_options
Pixar_save_options
PNG_save_options
raw_save_options
SGI_RGB_save_options
Targa_save_options
TIFF_save_options

SGI_RGB_save_options
-- Settings related to saving a document in
the SGI RGB format
Inherits from:
save_options
Properties:
save_alpha_channels
boolean
save_spot_colors
boolean
-- save spot colors

Targa_save_options
-- Settings related to saving a Target document
Inherits from:
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

TIFF_save_options
-- Settings related to saving a TIFF document
Inherits from:
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
document
image_compression
k.JPEG / k.LZW / k.none / k.ZIP
--
compression type ( default: none )
interleave_channels
boolean
-- are the channels in the
image interleaved? ( default: true )
JPEG_quality
integer
-- 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_annotations
boolean
-- save annotations
save_image_pyramid
boolean
-- ( default: false )
save_layers
boolean
-- save layers
save_spot_colors
boolean
-- save spot colors
transparency
boolean
Export Formats Suite

Classes for specifying options when exporting documents
Classes

export_options
-- used with options on the export command
Inherited by:
Illustrator_paths_export_options
save_for_web_export_options

Illustrator_paths_export_options
-- Settings related to exporting
Illustrator paths
Inherits from:
export_options
Properties:
path_name
unicode_text
-- 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 )

save_for_web_export_options
-- Settings related to exporting Save
For Web files

Inherits from:
export_options
Properties:
blur
float
-- apply blur to image to reduce artifacts (
default: 0.0 )
color_reduction
k.adaptive / k.black_white /
k.custom_reduction / k.grayscale / k.macintosh_colors /
k.perceptual_reduction / k.restrictive / k.selective /
k.windows_colors
-- color reduction algorithm ( default:
selective )
colors_in_palette
integer
-- number of colors in palette (
default: 256 )
dither
-- type of
dither ( default: diffusion )
dither_amount
integer
for diffusion ( default: 100 )
interlaced
boolean
-- download in multiple passes,
progressive ( default: false )
lossy
integer
-- controls amount of lossiness allowed (
default: 0 )
matte
RGB_color_
-- defines colors to blend transparent
pixels against
optimized_size
boolean
-- creates smaller but less
compatible files ( default: true )
png_eight
boolean
-- if the format is PNG how many
bits, true = 8, false = 24 ( default: true )
quality
integer
-- quality of produced image ( default: 60
)
transparency
boolean
-- ( default: true )
transparency_amount
integer
-- amount of
transparency dither ( default: 100 )
transparency_dither
k.diffusion / k.noise / k.none /
k.pattern
-- transparency dither algorithm ( default: none
)
web_format
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
-- File
format to use. Note: Save For Web only supports
Compuserve GIF, JPEG, PNG-8, PNG-24, and BMP
formats. ( default: CompuServe GIF )
web_snap
integer
-- snaps close colors to web palette
based on tolerance ( default: 0 )
with_profile
boolean
-- include an ICC profile based on
Photoshop color compensation ( default: false )
Filter Suite

Scripting commands for applying filters to documents
Commands

filter
-- apply a filter to one or more art layers
art_layer
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 filter_options]
-- options for method
Classes

add_noise
-- apply the add noise filter
Inherits from:
filter_options
Properties:
amount
float
distribution
k.Gaussian / k.uniform
monochromatic
boolean

average
-- apply the average filter
Inherits from:
filter_options

blur
-- apply the blur filter
Inherits from:
filter_options

blur_more
-- apply the blur more filter
Inherits from:
filter_options

clouds
-- apply the clouds filter
Inherits from:
filter_options

custom_filter
-- apply the custom filter
Inherits from:
filter_options
Properties:
characteristics
list of integer
-- filter characteristics
(array of 25 values - Correspons to a left to right, top to
bottom traversal of array presented in the Ui)
scaling
integer
offset
integer

deinterlace
-- apply the de-interlace filter
Inherits from:
filter_options
Properties:
eliminate
k.even_fields / k.odd_fields
create_new_fields_by
k.duplication / k.interpolation


despeckle
-- apply the despeckle filter
Inherits from:
filter_options

difference_clouds
-- apply the difference clouds filter
Inherits from:
filter_options

diffuse_glow
-- apply the diffuse glow filter
Inherits from:
filter_options
Properties:
graininess
integer
-- (range: 0 - 10)
glow_amount
integer
-- (range: 0 - 20)
clear_amount
integer
-- (range: 0 - 20)

displace_filter
-- apply the displace filter
Inherits from:
filter_options
Properties:
horizontal_scale
integer
vertical_scale
integer
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
Inherits from:
filter_options
Properties:
radius
integer
-- in pixels
threshold
integer

filter_options
-- options used with the filter method
Inherited by:
add_noise
average
blur
blur_more
clouds
custom_filter
deinterlace
despeckle
difference_clouds
diffuse_glow
displace_filter
dust_and_scratches
gaussian_blur
glass_filter
high_pass
lens_blur
lens_flare
maximum_filter
median_noise

minimum_filter
motion_blur
NTSC_colors
ocean_ripple
offset_filter
pinch
polar_coordinates
radial_blur
ripple
sharpen
sharpen_edges
sharpen_more
shear
smart_blur
spherize
texture_fill
twirl
unsharp_mask
wave_filter
zigzag

gaussian_blur
-- apply the gaussian blur filter
Inherits from:
filter_options
Properties:
radius
float
-- in pixels

glass_filter
-- apply the glass filter
Inherits from:
filter_options
Properties:
distortion
integer
-- (range: 0 - 20)
smoothness
integer
-- (range: 1 - 15)
scaling
integer
-- (range: 50 - 200)
invert_texture
boolean
-- (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
Inherits from:
filter_options
Properties:
radius
float
-- in pixels

lens_blur
-- apply the lens blur filter
Inherits from:
filter_options
Properties:
source
k.image_highlight / k.layer_mask / k.none /
k.transparency_channel
-- source for the depth map
(default: none )
focal_distance
integer
-- blur focal distance for the depth
map (default: 0 )

invert_depth_map
boolean
-- invert the depth map
(default: false )
iris_shape
k.heptagon / k.hexagon / k.octagon /
k.pentagon / k.square / k.triangle
-- shape of the iris
(default: hexagon )
radius
integer
-- radius of the iris (default: 15 )
blade_curvature
integer
-- blade curvature of the iris
(default: 0 )
rotation_
integer
-- rotation of the iris (default: 0 )
brightness
integer
-- brightness for the specular
highlights (default: 0 )
threshold
integer
-- threshold for the specular highlights
(default: 0 )
amount
integer
-- amount of noise (default: 0 )
distribution
k.Gaussian / k.uniform
-- distribution value
for the noise (default: uniform )
monochromatic
boolean
-- is the noise monochromatic
(default: false )

lens_flare
-- apply the lens flare filter
Inherits from:
filter_options
Properties:
brightness
integer
-- (range: 10 - 300)
flare_center
list
-- position (unit value)
lens_type
k.Movie_Prime / k.Prime_105 / k.Prime_35 /
k.zoom

maximum_filter
-- apply the maximum filter
Inherits from:
filter_options
Properties:
radius
float
-- in pixels

median_noise
-- apply the median noise filter
Inherits from:
filter_options
Properties:
radius
float
-- in pixels

minimum_filter
-- apply the minimum filter
Inherits from:
filter_options
Properties:
radius
float
-- in pixels

motion_blur
-- apply the motion blur filter
Inherits from:
filter_options
Properties:
angle
integer
radius
float
-- in pixels

NTSC_colors
-- apply the NTSC colors filter

Inherits from:
filter_options

ocean_ripple
-- apply the ocean ripple filter
Inherits from:
filter_options
Properties:
ripple_size
integer
-- (range: 1 - 15)
ripple_magnitude
integer
-- (range: 0 - 20)

offset_filter
-- apply the offset filter
Inherits from:
filter_options
Properties:
horizontal_offset
float
-- (unit value)
vertical_offset
float
-- (unit value)
undefined_areas
k.repeat_edge_pixels /
k.set_to_layer_fill / k.wrap_around

pinch
-- apply the pinch filter
Inherits from:
filter_options
Properties:
amount
integer
-- (range: -100 - 100)

polar_coordinates
-- apply the polar coordinates filter
Inherits from:
filter_options
Properties:
kind
k.polar_to_rectangular / k.rectangular_to_polar

radial_blur
-- apply the radial blur filter
Inherits from:
filter_options
Properties:
amount
integer
-- from 0 to 100
blur_method
k.spin / k.zoom
quality
k.best_ / k.draft / k.good
blur_center
list
-- position (unit value)

ripple
-- apply the ripple filter
Inherits from:
filter_options
Properties:
amount
integer
-- (range: -999 - 999)
ripple_size
k.large / k.medium / k.small

sharpen
-- apply the sharpen filter
Inherits from:
filter_options

sharpen_edges
-- apply the sharpen edges filter
Inherits from:
filter_options


sharpen_more
-- apply the sharpen more filter
Inherits from:
filter_options

shear
-- apply the shear filter
Inherits from:
filter_options
Properties:
curve
list of anything
-- specification of shear curve. List
of curve points
undefined_areas

smart_blur
-- apply the smart blur filter
Inherits from:
filter_options
Properties:
radius
float
-- radius (range: 0 - 1000)
threshold
float
-- 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
Inherits from:
filter_options
Properties:
amount
integer
-- (range: -100 - 100)
mode
k.horizontal / k.normal / k.vertical

texture_fill
-- apply the texture fill filter
Inherits from:
filter_options
Properties:
file_path
alias
-- texture file. Must be a grayscale
Photoshop file

twirl
-- apply the twirl filter
Inherits from:
filter_options
Properties:
angle
integer
-- (range: -999 - 999)

unsharp_mask
-- apply the unsharp mask filter
Inherits from:
filter_options
Properties:
amount
float
radius
float
-- in pixels
threshold
integer
-- threshold

wave_filter
-- apply the wave filter
Inherits from:
filter_options
Properties:
number_of_generators
integer
-- number of generators

minimum_wavelength
integer
maximum_wavelength
integer
minimum_amplitude
integer
maximum_amplitude
integer
horizontal_scale
integer
vertical_scale
integer
wave_type
k.sine / k.square / k.triangular
undefined_areas
random_seed
integer

zigzag
-- apply the zigzag filter
Inherits from:
filter_options
Properties:
amount
integer
-- (range: -100 - 100)
ridges
integer
style
k.around_center / k.out_from_center /
k.pond_ripples
Adjustment Suite
Scripting commands for applying adjustments to documents
Commands

adjust
-- apply an adjustment to one or more art layers
art_layer
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 adjustment_options]
-- options for method
Classes

adjustment_options
-- options used with the adjust method
Inherited by:
automatic_contrast
automatic_levels
color_balance
curves
desaturate
equalize
inversion
levels_adjustment
mix_channels
photo_filter
posterize
selective_color
shadow_highlight
threshold_adjustment


automatic_contrast
-- adjust contrast of the selected channels
automatically
Inherits from:
adjustment_options

automatic_levels
-- adjust levels of the selected channels using auto
levels option
Inherits from:
adjustment_options

-- adjust brightness and constrast
Inherits from:
adjustment_options
Properties:
brightness_level
integer
contrast_level
integer

color_balance
Inherits from:
adjustment_options
Properties:
shadows
list of integer
-- list of adjustments for shadows.
There must be 3 values in the list
midtones
list of integer
-- list of adjustments for
midtones. There must be 3 values in the list
highlights
list of integer
-- list of adjustments for
highlights. There must be 3 values in the list
preserve_luminosity
boolean

curves
-- adjust curves of the selected channels
Inherits from:
adjustment_options
Properties:
curve_points
list of list
-- list of curve points (number of
points must be between 2 and 14)

desaturate
Inherits from:
adjustment_options

equalize
-- equalize the levels
Inherits from:
adjustment_options

inversion
-- inverts the currently selected layer or channels
Inherits from:
adjustment_options

levels_adjustment
-- adjust levels of the selected channels
Inherits from:
adjustment_options
Properties:
input_range_start
integer
input_range_end
integer
input_range_gamma
float

output_range_start
integer
output_range_end
integer

mix_channels
-- only valid for RGB or CMYK documents
Inherits from:
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 )

photo_filter
Inherits from:
adjustment_options
Properties:
with_contents
color_value
-- a color to use for the fill
density
integer
-- density of the filter effect as a percent
(default: 25 )
preserve_luminosity
boolean
-- (default: true )

posterize
Inherits from:
adjustment_options
Properties:
levels
integer

selective_color
Inherits from:
adjustment_options
Properties:
selection_method
k.absolute / k.relative
reds
list of float
-- Array of 4 values: cyan, magenta,
yellow, black
yellows
list of float
yellow, black
greens
list of float
yellow, black
cyans
list of float
yellow, black
blues
list of float
yellow, black
magentas
list of float
-- Array of 4 values: cyan,
magenta, yellow, black
whites
list of float
yellow, black
neutrals
list of float
yellow, black
blacks
list of float
yellow, black


shadow_highlight
Inherits from:
adjustment_options
Properties:
shadow_amount
integer
-- percentage from 0 to 100
(default: 50 )
shadow_width
integer
-- percentage from 0 to 100 for
tonal width (0 = narrow), (100 = broad) (default: 50 )
shadow_radius
integer
-- pixel amount from 0 to 2500
(default: 30 )
highlight_amount
integer
-- percentage from 0 to 100
(default: 0 )
highlight_width
integer
-- percentage from 0 to 100 for
tonal width (0 = narrow), (100 = broad) (default: 50 )
highlight_radius
integer
-- pixel amount from 0 to 2500
(default: 30 )
color_correction
integer
-- adjust the colors in the
changed portion of the image (-100 to 100) (default: 20 )
midtone_contrast
integer
-- amount for the midtone
contrast (-100 to 100) (default: 0 )
black_clip
float
-- fractions of whites to be clipped
(default: 0.01 )
white_clip
float
-- fractions of blacks to be clipped
(default: 0.01 )

threshold_adjustment
Inherits from:
adjustment_options
Properties:
level
integer
Color Suite
Color classes for Adobe Photoshop
Commands

convert_color
-- convert a object from one color model to another
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: color_value
-- convert a object from one color model to
another

equal_colors
-- are the colors visually equal?
color_value
-- The original color with which to compare.
with_ color_value
-- The color to which to compare the
original color.
Result: boolean
-- are the colors visually equal?

web_safe_color
-- find the closest web safe color for a color
for_ color_value
-- Color for which to find the closest web safe

color.
Result: RGB_color_
-- find the closest web safe color for a
color
Classes

CMYK_color
-- A CMYK color specification
Inherits from:
color_value
Properties:
cyan
float
-- the cyan color value (between 0.0 and
100.0)
magenta
float
-- the magenta color value (between 0.0
and 100.0)
yellow
float
-- the yellow color value (between 0.0 and
100.0)
black
float
-- the black color value (between 0.0 and
100.0)

color_value
-- A color value
Inherited by:
CMYK_color
gray_color
HSB_color
Lab_color
no_color
RGB_color_
RGB_hex_color

gray_color
-- A gray color specification
Inherits from:
color_value
Properties:
gray_value
float
-- the gray value ( 0.0 - 100.0; default:
0.0 )

HSB_color
-- An HSB color specification
Inherits from:
color_value
Properties:
hue
float
-- the hue value (between 0.0 and 360.0)
saturation
float
-- the saturation value (between 0.0 and
100.0)
brightness
float
-- the brightness value (between 0.0 and
100.0)

Lab_color
-- An Lab color specification
Inherits from:
color_value
Properties:
value_L
float
-- the L-value (between 0.0 and 100.0)
value_a
float
-- the a-value (between -128.0 and 127.0)
value_b
float
-- the b-value (between -128.0 and 127.0)


no_color
-- represents a missing color
Inherits from:
color_value

RGB_color_
-- An RGB color specification
Inherits from:
color_value
Properties:
red
float
-- the red color value ( 0.0 - 255.0; default:
255.0 )
green
float
-- the green color value ( 0.0 - 255.0; default:
255.0 )
blue
float
-- the blue color value ( 0.0 - 255.0; default:
255.0 )

RGB_hex_color
-- A hexadecimal specification of an RGB color
Inherits from:
color_value
Properties:
hex_value
unicode_text
-- the hex representation of the
color. (Example '10FF4B')
Path Suite
Classes for working with art path items
Commands

create_selection
-- make a selection from this path
path_item
-- the path item object or objects to be operated upon
-- the feather amount in pixels
-- use anti aliasing for the selection
[operation k.diminished / k.extended / k.intersected /
k.replaced]
-- the operation mode for the selection

deselect
-- unselect this path item, no paths items are selected
path_item

fill_path
-- fill the path with the following information
path_item
[with_contents anything]
-- color of the fill for this path
k.vivid_light]
-- blending mode of the fill for this path
[opacity float]
-- opacity of the fill for this path
-- preserve the
transparency of the file for this path

-- the feather amount in pixels
-- use anti aliasing for the selection
[whole_path boolean]
-- use all subpaths when doing fill

make_clipping_path -- make this path item the clipping path for
this document
path_item
[flatness float]
-- Flatness in device pixels. Tells the PostScript
printer how to approximate curves. (0.2 - 100).

select
-- make this path item the active or selected path item
path_item

stroke_path
-- stroke the path with the following information
path_item
[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
Classes

path_item
-- An artwork path item
Plural name:
path_items
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
container
(r/o)
reference
entire_path
(r/o)
list of sub_path_info
-- all the path
item's sub paths
kind
k.clipping / k.normal / k.text_mask / k.vector_mask /
k.work
name
unicode_text
-- the name of the path item
Elements:
sub_path_items -- by

path_point
-- A point on a path
Plural name:
path_points
Properties:
best_type
(r/o)
type_class

value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
anchor
(r/o)
list
-- the position (coordinates) of the
anchor point
container
(r/o)
reference
kind
(r/o)
k.corner_point / k.smooth_point
-- the type of
point: smooth/corner
left_direction
(r/o)
list
-- location of the left direction
point (in position)
right_direction
(r/o)
list
-- 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
list
-- the position of the anchor (in coordinates)
kind
k.corner_point / k.smooth_point
-- the point type,
smooth/corner
left_direction
list
-- location of the left direction point
(in position)
right_direction
list
-- location of the right 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 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
Plural name:
sub_path_items
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
closed
(r/o)
boolean
-- is this path closed?
container
(r/o)
reference

entire_sub_path
(r/o)
list of 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 -- by
Notifier Suite
Classes for working with notifiers
Classes

notifier
-- The parameters of the notifie
Plural name:
notifiers
Properties:
best_type
(r/o)
type_class
value
class_
(r/o)
type_class
default_type
(r/o)
type_class
object's value
index
(r/o)
integer
object
properties
record
event
(r/o)
unicode_text
-- The id of the event, four
characters or a unique string
event_class
(r/o)
unicode_text
-- The class id the event
applies to, four characters or a unique string. Allows you
to distinguish between the same event applied to
different classes.
event_file
(r/o)
alias
-- The file to execute when the
event occurs
Miscellaneous Standards Suite

Miscellaneous standard commands and classes
Commands

clear
-- clear current selection

copy
-- copy current selection to the clipboard

copy_merged
-- copy current selection to the clipboard. Include data
in all visible layers.

cut
-- cut current selection to the clipboard


do_action
-- play an action from the Actions Palette
unicode_text
-- 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_ unicode_text
-- 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)

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 )
-- execute a JavaScript

paste
-- paste clipboard into the current document
[clipping_to_selection boolean]
-- should contents be clipped
to the current selection? ( default: false )

PhotoshopCC2018 Docs Reference Appscript

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PhotoshopCC2018 Docs Reference Appscript

Uploaded by

Copyright:

Available Formats

Adobe Photoshop CC 2018.

Adobe Photoshop CC 2018.app terminology

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Either a string specifying a specific color profile or 'Working

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

k.middle_right / k.top_center / k.top_left / k.top_right]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Open Formats Suite

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

options for the image

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

height of image (unit value) )

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Save Formats Suite

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

(only settable for some palette types)

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

longer used in CS2 ( use outlines for text? Only valid if

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

be used? ( default: true )

Export Formats Suite

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Scripting commands for applying filters to documents

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]

Photoshop CC 2018_docs_apppscript.html[16/08/18, 4:52:02 PM]