Instancesvoid activate ()
Activate the first window associated with the document.
void close ([saving:
SaveOptions])
Close the specified document(s)
| Parameter | Type | Description |
|---|
| saving | SaveOptions:
SaveOptions.SAVECHANGES
SaveOptions.DONOTSAVECHANGES
SaveOptions.PROMPTTOSAVECHANGES | Specifies whether changes should be saved before closing. (Optional) |
Point convertCoordinate (coordinate:
Point, source:
CoordinateSystem, destination:
CoordinateSystem)
Converts the coordinate system of a single point from one coordinate system to another.
| Parameter | Type | Description |
|---|
| coordinate | Point | The Coordinate to convert. |
| source | CoordinateSystem:
CoordinateSystem.DOCUMENTCOORDINATESYSTEM
CoordinateSystem.ARTBOARDCOORDINATESYSTEM | The source coordinate system. |
| destination | CoordinateSystem:
CoordinateSystem.DOCUMENTCOORDINATESYSTEM
CoordinateSystem.ARTBOARDCOORDINATESYSTEM | The destination coordinate system. |
void exportFile (exportFile:
File, exportFormat:
ExportType[, options:
any])
Export the specified document(s)
| Parameter | Type | Description |
|---|
| exportFile | File | The file to export the document to. |
| exportFormat | ExportType:
ExportType.JPEG
ExportType.PHOTOSHOP
ExportType.SVG
ExportType.PNG8
ExportType.PNG24
ExportType.GIF
ExportType.FLASH
ExportType.AUTOCAD
ExportType.TIFF | The file type to export the document as. |
| options |
any
| Options for the file type specified. (Optional) |
void exportPDFPreset (file:
File)
Save all PDF presets to a file.
| Parameter | Type | Description |
|---|
| file | File | File to export to. |
void exportPerspectiveGridPreset (file:
File)
Saves all perspective grid presets to a file.
| Parameter | Type | Description |
|---|
| file | File | File to export to. |
void exportPrintPreset (file:
File)
Export the current print setting to the preset file.
| Parameter | Type | Description |
|---|
| file | File | File to export to. |
void exportVariables (file:
File)
Save datasets into an XML library. The datasets contain variables and their associated dynamic data.
| Parameter | Type | Description |
|---|
| file | File | File spec to export to. |
bool fitArtboardToSelectedArt ([index:
Int32])
Change the artboard to selected art bounds.
| Parameter | Type | Description |
|---|
| index | Int32 | The index of the artboard to update. (Optional) |
PerspectiveGridPlaneType getPerspectiveActivePlane ()
Gets the active plane of the active perspective grid of the document.
bool hidePerspectiveGrid ()
Hides the current active perspective grid for the document, if there is visible perspective grid.
void imageCapture (imageFile:
File[, clipBounds:
Rectangle][, options:
ImageCaptureOptions])
Capture the artwork content inside the clip bound as raster image, and write out the captured image data into the target image file.
| Parameter | Type | Description |
|---|
| imageFile | File | The file to which the captured image should be written. |
| clipBounds | Rectangle | The rectangular region of the artwork for image capture. If the parameter is omitted, the entire artwork bound is captured. (Optional) |
| options | ImageCaptureOptions | Describes the image capture options. (Optional) |
void importCharacterStyles (fileSpec:
File)
Load the character styles from the Illustrator file.
| Parameter | Type | Description |
|---|
| fileSpec | File | File spec to import from. |
void importPDFPreset (fileSpec:
File[, replacingPreset:
bool=false])
Load all PDF presets from a file.
| Parameter | Type | Description |
|---|
| fileSpec | File | File to import from. |
| replacingPreset | bool | Should existing editable presets be replaced? (default: false) (Optional) |
void importParagraphStyles (fileSpec:
File)
Load the paragraph styles from the Illustrator file.
| Parameter | Type | Description |
|---|
| fileSpec | File | File spec to import from. |
void importPerspectiveGridPreset (fileSpec:
File[, perspectivePreset:
string])
Loads mentioned perspective grid preset, if preset name is specified, else loads all(if no preset name is specified) presets, from the specified file.
| Parameter | Type | Description |
|---|
| fileSpec | File | File to import from. |
| perspectivePreset | string | Name of perspective grid preset. (Optional) |
void importPrintPreset (printPreset:
string, fileSpec:
File)
Apply the named print preset from the file to the current print setting.
| Parameter | Type | Description |
|---|
| printPreset | string | The name of a print preset to import. |
| fileSpec | File | File to import from. |
void importVariables (fileSpec:
File)
Import a library containing datasets, variables and their associated dynamic data. Importing variables will overwrite existing variables and datasets.
| Parameter | Type | Description |
|---|
| fileSpec | File | File spec to import from. |
void print ([options:
PrintOptions])
Print the document.
| Parameter | Type | Description |
|---|
| options | PrintOptions | Print options. (Optional) |
PageItem rasterize (sourceArt:
any[, clipBounds:
Rectangle][, options:
RasterizeOptions])
Rasterize the source art(s) within the specified clip bounds. The source art(s) are disposed as a result of the rasterization.
| Parameter | Type | Description |
|---|
| sourceArt |
any
| The page item(s) to be rasterized. |
| clipBounds | Rectangle | The rectangular region of the artwork for the rasterization. If the parameter is omitted, the bounds of the source art(s) is used instead. (Optional) |
| options | RasterizeOptions | Describes the rasterization options. (Optional) |
bool rearrangeArtboards ([artboardLayout:
DocumentArtboardLayout=DocumentArtboardLayout.GridByRow][, artboardRowsOrCols:
Int32=1][, artboardSpacing:
number=20.0][, artboardMoveArtwork:
bool=true])
Rearrange Artboards in the document.
| Parameter | Type | Description |
|---|
| artboardLayout | DocumentArtboardLayout:
DocumentArtboardLayout.GridByRow
DocumentArtboardLayout.GridByCol
DocumentArtboardLayout.Row
DocumentArtboardLayout.Column
DocumentArtboardLayout.RLGridByRow
DocumentArtboardLayout.RLGridByCol
DocumentArtboardLayout.RLRow | Layout of artboards for rearrangement. (default: DocumentArtboardLayout.GridByRow) (Optional) |
| artboardRowsOrCols | Int32 | Number of rows (for rows layout) OR column(for column layouts)of artboards.Range is 1 to (docNumArtboards - 1) or 1 for single row or column layouts. (default: 1) (Optional) |
| artboardSpacing | number | Spacing between artboards. (default: 20.0) (Optional) |
| artboardMoveArtwork | bool | Whether to move artwork with artboards. (default: true) (Optional) |
void save ()
Save the document.
void saveAs (saveIn:
File[, options:
any])
Save the document with specific save options.
| Parameter | Type | Description |
|---|
| saveIn | File | The file to save the document in. |
| options |
any
| Options for the file type specified. (Optional) |
bool selectObjectsOnActiveArtboard ()
Select art objects in active artboard.
bool selectPerspectivePreset (perspectivePreset:
string)
Selects a predefined preset to define grid for the current document.
| Parameter | Type | Description |
|---|
| perspectivePreset | string | Name of perspective grid preset. |
bool setPerspectiveActivePlane (perspectiveGridPlane:
PerspectiveGridPlaneType)
Sets the active perspective plane for the active grid of the document.
| Parameter | Type | Description |
|---|
| perspectiveGridPlane | PerspectiveGridPlaneType:
PerspectiveGridPlaneType.NOPLANE
PerspectiveGridPlaneType.LEFTPLANE
PerspectiveGridPlaneType.RIGHTPLANE
PerspectiveGridPlaneType.FLOORPLANE | Type of perspective grid plane. |
bool showPerspectiveGrid ()
Shows the current active perspective grid for the document, if no active perspective grid then shows the default perspective grid for the document.
void windowCapture (imageFile:
File, windowSize:
Point)
Capture the current document window to the target TIFF image file.
| Parameter | Type | Description |
|---|
| imageFile | File | The TIFF file to which the captured image should be written. |
| windowSize | Point | The size to make the window before capture. |
|