Application
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| PDFPresetsList | Array of string | readonly | The list of PDF preset names currently available for use. |
| PPDFileList | Array of PPDFile | readonly | The list of PPD files currently available for use. For performance reasons, the PPDFile entry only contains the model name and file spec of each PPD file. |
| activeDocument | Document | r/w | The active document. |
| browserAvailable | bool | readonly | Is a web browser available? |
| buildNumber | string | readonly | The build number of the Adobe Illustrator application. |
| colorSettingsList | Array of File | readonly | The list of color settings files currently available for use. |
| defaultColorSettings | File | readonly | The default color settings file for the current application locale. |
| documents | Documents | readonly | The open documents. |
| flattenerPresetsList | Array of string | readonly | The list of flattener style names currently available for use. |
| freeMemory | int | readonly | The amount of unused memory within the Adobe Illustrator partition. |
| locale | string | readonly | The Locale of the Adobe Illustrator application. |
| name | string | readonly | The application's name. |
| parent | Object | readonly | The object's container. |
| path | File | readonly | Path specification for the application. |
| preferences | Preferences | readonly | Preferences for Illustrator. |
| printPresetsList | Array of string | readonly | The list of print preset names currently available for use. |
| printerList | Array of Printer | readonly | The list of installed printers. |
| scriptingVersion | string | readonly | The version of the Scripting plugin. |
| selection | any | r/w | The selection visible to the user. |
| startupPresetsList | Array of string | readonly | The list of presets available for creating a new document. |
| textFonts | TextFonts | readonly | Installed fonts. |
| tracingPresetsList | Array of string | readonly | The list of tracing preset names currently available for use. |
| typename | string | readonly | The class name of the object. |
| userInteractionLevel | UserInteractionLevel: UserInteractionLevel.DONTDISPLAYALERTS UserInteractionLevel.DISPLAYALERTS |
r/w | What level of interaction with the user should be allowed when handling script commands. |
| version | string | readonly | The version of the Adobe Illustrator application. |
| visible | bool | readonly | Is the application visible. |
Methods
Instances
string aATAddItem (sessionIndex:
int, destinationSequenceID:
int, destinationIndex:
int, srcItemIDData:
string, type:
string)
Add the specified to the sequencer.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to add. |
| destinationSequenceID | int | The UID for the owning sequence. |
| destinationIndex | int | The item UID where to insert. |
| srcItemIDData | string | The item ID of the item to construct. |
| type | string | The source of the item to construct. |
string aATClear ()
Clear the sequencer.
string aATDuplicateItem (sessionIndex:
int, item:
string)
Duplicates the specified item(s) from the sequencer.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to add. |
| item | string | The item UID(s) |
string aATEditItem (sessionIndex:
int, item:
string)
Opens the specified item from the sequencer in the item editor.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to add. |
| item | string | The item UID. |
bool aATErrorsExist ()
Retrieves a boolean indicating the presence of errors in the last script to execute.
void aATExecuteSession ()
Executes the active session in the sequencer.
void aATExecuteSessionFromFile (file:
File)
Executes the active session in the sequencer.
| Parameter | Type | Description |
|---|---|---|
| file | File | Execute a session file. |
string aATFileRelativeChanged (path:
string, relative:
string, newRelative:
string)
Switches a files relative token and path.
| Parameter | Type | Description |
|---|---|---|
| path | string | The path relative to the folder specified by Relative. |
| relative | string | The current relative path token. |
| newRelative | string | The new relative path token. |
string aATFileSaveDialog (path:
string, relative:
string, type:
string)
Prompts the user to save a file or choose a file or directory and returns a relative path string to the file.
| Parameter | Type | Description |
|---|---|---|
| path | string | The path relative to the folder specified by Relative. |
| relative | string | The current relative path token. |
| type | string | The type of dialog to show in string format. |
File aATGetEditorDialogFile ()
Retrieves a file path to the AAT editor swf.
File aATGetErrorDialogFile ()
Retrieves a file path to the AAT error dialog swf.
string aATGetListOfRelativePaths ()
Gets an XML string listing the relative paths and the UI strings to display them.
string aATGetSession ()
Get the active session for the sequncer.
string aATLoadLibExtension ()
Loads a session file as an extension to the editor.
string aATLoadModel ()
Loads the aat model to the editor.
string aATLoadSessionFile ()
Loads a session into the sequencer.
string aATLoadUIExtension ()
Loads a UI description as an extension to the editor.
string aATMoveItem (sessionIndex:
int, moveThisID:
string, newSessionIndex:
int, destinationSequenceID:
string, destinationIndex:
int)
Moves the specified in the sequencer.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to move. |
| moveThisID | string | The UID of the item to replace. |
| newSessionIndex | int | The index in the session of the destination top-most sequence. |
| destinationSequenceID | string | The UID for the owning sequence. |
| destinationIndex | int | The index where to insert. |
string aATRemoveItem (sessionIndex:
int, item:
string)
Removes the specified item from the sequencer.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to add. |
| item | string | The item UID. |
string aATReplaceItem (sessionIndex:
int, replaceThisID:
int, srcItemIDData:
string, type:
string)
Replaces the specified to the sequencer.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to add. |
| replaceThisID | int | The UID of the item to replace. |
| srcItemIDData | string | The item ID of the item to construct. |
| type | string | The source of the item to construct. |
string aATSaveAsSession ()
Saves the active session in the sequencer to a new file.
string aATSaveSession ()
Saves the active session in the sequencer to a file.
string applyDataToItem (sessionIndex:
int, item:
string, data:
string)
Applies the data used in the item editor to the item.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to edit. |
| item | string | The item UID. |
| data | string | The data to apply in XML format. |
bool applySingleDataPointToItem (sessionIndex:
int, item:
string, dataID:
string, data:
string)
Applies data to the specified item from the sequencer in the item editor.
| Parameter | Type | Description |
|---|---|---|
| sessionIndex | int | The index in the session of the top-most sequence for the item to add. |
| item | string | The item UID. |
| dataID | string | The data to apply in XML format. |
| data | string | The data to apply in XML format. |
Matrix concatenateMatrix (matrix:
Matrix, secondMatrix:
Matrix)
Concatenate two transformation matrices.
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The matrix that is to be added to. |
| secondMatrix | Matrix | Second transformation matrix. |
Matrix concatenateRotationMatrix (matrix:
Matrix, angle:
number)
Concatenate a rotation matrix to a transformation matrix.
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The matrix that is to be added to. |
| angle | number | Angle of rotation (in degrees) |
Matrix concatenateScaleMatrix (matrix:
Matrix[, scaleX:
number=100.0][, scaleY:
number=100.0])
Concatenate a scale matrix to a transformation matrix.
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The matrix that is to be added to. |
| scaleX | number | Horizontal scaling factor expressed as a percentage (100 = 100%) (default: 100.0) (Optional) |
| scaleY | number | Vertical scaling factor expressed as a percentage (100 = 100%) (default: 100.0) (Optional) |
Matrix concatenateTranslationMatrix (matrix:
Matrix[, deltaX:
number=0.0][, deltaY:
number=0.0])
Concatenate a translation to a transformation matrix.
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The matrix that is to be added to. |
| deltaX | number | Horizontal transformation. (default: 0.0) (Optional) |
| deltaY | number | Vertical transformation. (default: 0.0) (Optional) |
Array
of number convertSampleColor (sourceColorSpace:
ImageColorSpace, sourceColor:
Array
of number, destColorSpace:
ImageColorSpace, colorConvertPurpose:
ColorConvertPurpose[, sourceHasAlpha:
bool=false][, destHasAlpha:
bool=false])
Converts a sample-component color from one color space to another.
| Parameter | Type | Description |
|---|---|---|
| sourceColorSpace | ImageColorSpace: ImageColorSpace.GrayScale ImageColorSpace.RGB ImageColorSpace.CMYK ImageColorSpace.LAB ImageColorSpace.Separation ImageColorSpace.DeviceN ImageColorSpace.Indexed | The source color space. |
| sourceColor | Array of number | The color to convert, an array of color components. First location of the array should contain alpha if source-has-alpha is true. |
| destColorSpace | ImageColorSpace: ImageColorSpace.GrayScale ImageColorSpace.RGB ImageColorSpace.CMYK ImageColorSpace.LAB ImageColorSpace.Separation ImageColorSpace.DeviceN ImageColorSpace.Indexed | The destination color space. |
| colorConvertPurpose | ColorConvertPurpose: ColorConvertPurpose.defaultpurpose ColorConvertPurpose.previewpurpose ColorConvertPurpose.exportpurpose ColorConvertPurpose.dummypurpose | The parameter which passes the purpose of conversion. |
| sourceHasAlpha | bool | True if alpha channel is present in source color. (default: false) (Optional) |
| destHasAlpha | bool | True if alpha channel is present in destination color. (default: false) (Optional) |
void copy ()
Copy current selection to the clipboard.
void cut ()
Cut current selection to the clipboard.
string getExecutionOutput ()
Retrieves a string containing the results of the last script to execute.
Matrix getIdentityMatrix ()
Returns an identity matrix.
PPDFileInfo getPPDFileInfo (name:
string)
Get detailed info from the specified PPD file.
| Parameter | Type | Description |
|---|---|---|
| name | string | The model name of the PPD file. |
File getPresetFileOfType (presetType:
DocumentPresetType)
Given a preset type, returns the full path to the application's default document profile for the type.
| Parameter | Type | Description |
|---|---|---|
| presetType | DocumentPresetType: DocumentPresetType.Print DocumentPresetType.Web DocumentPresetType.Mobile DocumentPresetType.Video DocumentPresetType.BasicCMYK DocumentPresetType.BasicRGB | The preset type. |
DocumentPreset getPresetSettings (preset:
string)
Given a preset name, tries and retrieves the settings from the preset template.
| Parameter | Type | Description |
|---|---|---|
| preset | string | The name of the preset. |
Matrix getRotationMatrix ([angle:
number=0.0])
Returns a rotation transformation matrix.
| Parameter | Type | Description |
|---|---|---|
| angle | number | Angle of rotation (in degrees) (default: 0.0) (Optional) |
Matrix getScaleMatrix ([scaleX:
number=100.0][, scaleY:
number=100.0])
Returns a scale transformation matrix.
| Parameter | Type | Description |
|---|---|---|
| scaleX | number | Horizontal scaling factor expressed as a percentage (100 = 100%) (default: 100.0) (Optional) |
| scaleY | number | Vertical scaling factor expressed as a percentage (100 = 100%) (default: 100.0) (Optional) |
any getScriptableHelpGroup ()
Get the scriptable help group object that represents the search widget in the app bar.
Matrix getTranslationMatrix ([deltaX:
number=0.0][, deltaY:
number=0.0])
Returns a translation matrix.
| Parameter | Type | Description |
|---|---|---|
| deltaX | number | Horizontal transformation. (default: 0.0) (Optional) |
| deltaY | number | Vertical transformation. (default: 0.0) (Optional) |
string getVersionString ()
Retrieves a string representing the AAT version.
Matrix invertMatrix (matrix:
Matrix)
Invert a matrix.
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The matrix to invert. |
bool isEqualMatrix (matrix:
Matrix, secondMatrix:
Matrix)
Compares two matrices for equality.
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | First transformation matrix to compare. |
| secondMatrix | Matrix | Second transformation matrix. |
bool isSingularMatrix (matrix:
Matrix)
Tests if a matrix is singular (cannot be inverted)
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The matrix to check. |
void loadColorSettings (fileSpec:
File)
Load the color settings from the file. If the file is an empty file spec, the color management will be turned off.
| Parameter | Type | Description |
|---|---|---|
| fileSpec | File | File spec for the color settings. |
Document open (file:
File[, documentColorSpace:
DocumentColorSpace][, options:
any])
Open the specified document file.
| Parameter | Type | Description |
|---|---|---|
| file | File | The file to be opened. |
| documentColorSpace | DocumentColorSpace: DocumentColorSpace.RGB DocumentColorSpace.CMYK | Choose color space only for documents saved with multiple color models (pre-Illustrator 9) (Optional) |
| options | any | Options for opening a particular type of file. (Optional) |
void paste ()
Paste clipboard into the current document.
void quit ()
Quit the application.
void redo ()
Redo the last transaction.
void redraw ()
Force Illustrator to redraw its window(s)
Array
of string showPresets (fileSpec:
File)
Get presets from the file.
| Parameter | Type | Description |
|---|---|---|
| fileSpec | File | File spec to import from. |
string translatePlaceholderText (text:
string)
Translate the placeholder text to regular text. A method to enter unicode points in hex values.
| Parameter | Type | Description |
|---|---|---|
| text | string | The placeholder text to be translated. |
string translateString (key:
string, source:
string)
Returns a string translated from the key and source data passed in.
| Parameter | Type | Description |
|---|---|---|
| key | string | The string to translate. |
| source | string | The plugin name from the source of the key. |
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |