Object

Document

A document.

Properties

Type	Access	Description
String	read/write	The XMP packet string associated with the document.
DataSet	read/write	The active data set.
Layer	read/write	The active layer.
View	readonly	The document's current view.
Artboards<Artboard>	readonly	All artboards in the document.
Assets<Asset>	readonly	All assets in the document.
Brushes<Brush>	readonly	The brushes defined in this document.
CharacterStyles<CharacterStyle>	readonly	The list of character styles in this document.
String	readonly	Path specification for the cloud document.
String	readonly	The name of the color profile of the document.
CompoundPathItems<CompoundPathItem>	readonly	The compound path artwork in this collection.
Rect	read/write
CropOptions	read/write
DataSets<DataSet>	readonly	The data sets defined in this document.
Color	read/write	Default fill color.
Boolean	read/write	Will art beneath a filled object be overprinted by default?
Boolean	read/write	Should a new path be filled?
StrokeCap	read/write	Default type of line capping.
Color	read/write	Default stroke color.
Number	read/write	The default distance into the dash pattern at which the pattern should be started.
Number[]	read/write	Default dash lengths (set to {} for a solid line)
StrokeJoin	read/write	Default type of joints.
Number	read/write	Specifies whether a join is mitered (pointed) or beveled (squared-off) by default.
Boolean	read/write	Will art beneath a stroked object be overprinted by default?
Number	read/write	Default width of stroke.
Boolean	read/write	Should a new path be stroked?
DocumentColorSpace	readonly	The color space used for the document.
EmbeddedItems<EmbedItem>	readonly	The embedded art items in this layer.
File	readonly	The file associated with the document.
Rect	readonly	The bounds of the illustration excluding stroke width.
Gradients<Gradient>	readonly	The gradients available in this document.
GraphItems<GraphItem>	readonly	The graph art items in this document.
ArtStyles<ArtStyle>	readonly	The graphic styles defined in this document.
GridRepeatItems<GridRepeatItem>	readonly	The grid repeat items in this document.
GroupItems<GroupItem>	readonly	The group items in this document.
Number	readonly
Ink[]	readonly	The list of inks in this document.
Boolean	readonly	Is the document saved on cloud.
String[]	readonly	The Kinsoku set.
Layers<Layer>	readonly	The layers in this document.
LegacyTextItems<LegacyTextItem>	readonly	The text frame items in this story.
MeshItems<MeshItem>	readonly	The mesh art items in this document.
String[]	readonly	The Mojikumi set.
String	readonly	The document's name.
NonNativeItems<NonNativeItem>	readonly	The non-native art items in this document.
Number	readonly
PageItems<PageItem>	readonly	All the artwork in this document.
Point	read/write
ParagraphStyles<ParagraphStyle>	readonly	The list of paragraph styles in this document.
The	readonly	The object's container.
File	readonly	Path specification for the document.
PathItems<PathItem>	readonly	The path artwork in this document.
Patterns<Pattern>	readonly	The patterns available in this document.
PlacedItems<PlacedItem>	readonly	The placed art items in this document.
PluginItems<PluginItem>	readonly	The plugin art items in this document.
Boolean	readonly
RadialRepeatItems<RadialRepeatItem>	readonly	The radial repeat items in this document.
RasterEffectOptions	read/write	The document raster effects settings.
RasterItems<RasterItem>	readonly	The raster art items in this document.
Point	read/write
RulerUnits	readonly
Boolean	read/write	Has the document been saved?
Number	readonly	The scale factor of the document.
Varies	read/write	The selection within the document.
Boolean	readonly
Boolean	readonly
Spots<Spot>	readonly	The custom spot colors available in this document.
Boolean	readonly	Is the file a stationery file?
Stories<Story>	readonly	The story items in this document.
SwatchGroups<SwatchGroup>	readonly	The Swatch Groups in this document.
Swatches<Swatch>	readonly	The swatches in this document.
SymbolItems<SymbolItem>	readonly	The symbol items in this document.
Symbols<Symbol>	readonly	The symbols defined in this document.
SymmetryRepeatItems<SymmetryRepeatItem>	readonly	The symmetry repeat items in this document.
Tags<Tag>	readonly	The tags in this document.
TextFrameItems<TextFrameItem>	readonly	The text frame items in this document.
Boolean	readonly
String	readonly	The class name of the object.
Boolean	readonly
Variables<Variable>	readonly	The variables defined in this document.
Boolean	read/write	The locked variables.
Views<View>	readonly	The views in this document.
Rect	readonly	The visible bounds of the illustration including stroke width.
Number	readonly

Methods

→ void

Activate the first window associated with the document.

→ void

Close the specified document(s)

saving? SaveOptions Specifies whether changes should be saved before closing.

→ Point

Converts the coordinate system of a single point from one coordinate system to another.

coordinate Point The Coordinate to convert.

source CoordinateSystem The source coordinate system.

destination CoordinateSystem The destination coordinate system.

→ void

Convert the document to Large Canvas Document.

→ void

Export the specified document(s)

exportFile File The file to export the document to.

exportFormat ExportType The file type to export the document as.

options? Varies Options for the file type specified.

→ void

Export the specified document/asset(s)/artboard(s)

exportFolder File The folder where the exported documents/assets/artboards are saved.

exportFormat ExportForScreensType The file type in which the document is exported.

options? Varies Options for the file type specified.

itemToExport? ExportForScreensItemToExport What to export.

fileNamePrefix? String String prepended to each file name.

→ void

Save all PDF presets to a file.

file File File to export to.

→ void

Saves all perspective grid presets to a file.

file File File to export to.

→ void

Export the current print setting to the preset file.

file File File to export to.

→ void

Export the selection as Ai file.

exportFile File The file to export the selection to.

→ void

Export the selection as PNG file.

exportFile File The file to export the selection to.

options? Varies Options for the PNG24 export.

→ void

Save datasets into an XML library. The datasets contain variables and their associated dynamic data.

file File File spec to export to.

→ Boolean

Change the artboard to selected art bounds.

index? Int32 The index of the artboard to update.

→ PageItem

Retrieves the pageitem using Uuid.

uuid String Uuid of pageitem.

→ PerspectiveGridPlaneType

Gets the active plane of the active perspective grid of the document.

→ Boolean

Hides the current active perspective grid for the document, if there is visible perspective grid.

→ void

Capture the artwork content inside the clip bound as raster image, and write out the captured image data into the target image file.

imageFile File The file to which the captured image should be written.

clipBounds? Rect The rectangular region of the artwork for image capture. If the parameter is omitted, the entire artwork bound is captured.

options? ImageCaptureOptions Describes the image capture options.

→ void

Load the character styles from the Illustrator file.

fileSpec File File spec to import from.

→ void

Import the file into current Ai document.

importFile File The file to import in the current document.

isLinked Boolean Is AssetLiveLinked.

libraryName? String For Internal Use.

itemName? String For Internal Use.

elementRef? String For Internal Use.

modifiedTime? Number For Internal Use.

creationTime? Number For Internal Use.

adobeStockId? String For Internal Use.

adobeStockLicense? String For Internal Use.

shouldLoadToPlaceGun? Boolean Whether or not to load the imported file to placegun.

→ void

Load all PDF presets from a file.

fileSpec File File to import from.

replacingPreset? Boolean Should existing editable presets be replaced?

→ void

Load the paragraph styles from the Illustrator file.

fileSpec File File spec to import from.

→ void

Loads mentioned perspective grid preset, if preset name is specified, else loads all(if no preset name is specified) presets, from the specified file.

fileSpec File File to import from.

perspectivePreset? String Name of perspective grid preset.

→ void

Apply the named print preset from the file to the current print setting.

printPreset String The name of a print preset to import.

fileSpec File File to import from.

→ void

Import a library containing datasets, variables and their associated dynamic data. Importing variables will overwrite existing variables and datasets.

fileSpec File File spec to import from.

→ void

Print the document.

options? PrintOptions Print options.

→ void

Process a gesture based on input points.

gesturePointsFile String File Path containing points constituting the gesture.

→ PageItem

Rasterize the source art(s) within the specified clip bounds. The source art(s) are disposed as a result of the rasterization.

sourceArt Varies The page item(s) to be rasterized.

clipBounds? Rect The rectangular region of the artwork for the rasterization. If the parameter is omitted, the bounds of the source art(s) is used instead.

options? RasterizeOptions Describes the rasterization options.

→ Boolean

Rearrange Artboards in the document.

artboardLayout? DocumentArtboardLayout Layout of artboards for rearrangement.

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.

artboardSpacing? Number Spacing between artboards.

artboardMoveArtwork? Boolean Whether to move artwork with artboards.

→ void

Save the document.

→ void

Save the document with specific save options.

saveIn File The file to save the document in.

options? Varies Options for the file type specified.

→ void

Save the document to cloud at the specified path.

cloudPath String Path of the document to be saved on cloud.

→ Boolean

Select art objects in active artboard.

→ Boolean

Selects a predefined preset to define grid for the current document.

perspectivePreset String Name of perspective grid preset.

→ Boolean

Sets the active perspective plane for the active grid of the document.

perspectiveGridPlane PerspectiveGridPlaneType Type of perspective grid plane.

→ Boolean

Shows the current active perspective grid for the document, if no active perspective grid then shows the default perspective grid for the document.

→ void

Capture the current document window to the target TIFF image file.

imageFile File The TIFF file to which the captured image should be written.

windowSize Point The size to make the window before capture.

→ void

Write the document to a file as a library of specified type.

file File The file to write the library in.

libraryType LibraryType Type of library to write as.

Object of 1

Properties elsewhere that hold a Document.

Application.activeDocument

Return 7

Methods that return a Document.

Application.open()Application.openCloudDocument()Application.openCloudLibraryAssetForEditing()Documents.add()Documents.addDocument()Documents.addDocumentWithDialogOption()Documents.getByName()