Document

Document from Adobe Illustrator API

Creative CloudDesignIllustratorVector Graphics

Properties

Name	Type	Description
id	string	Unique identifier of the document.
name	string	Name of the document.
fullName	string	Full file path of the document.
saved	boolean	Whether the document has been saved.
documentColorSpace	string	The document color mode.
width	number	Document width in points.
height	number	Document height in points.
rulerUnits	string	Ruler units used in the document.
rulerOrigin	array	The ruler origin point [x, y].
layerCount	integer	Number of layers in the document.
artboardCount	integer	Number of artboards in the document.
activeLayer	string	Name of the currently active layer.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-illustrator/refs/heads/main/json-schema/adobe-illustrator-scripting-document-schema.json",
  "title": "Document",
  "description": "Document from Adobe Illustrator API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the document.",
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "Name of the document.",
      "examples": [
        "Untitled-1"
      ],
      "example": "Example Artboard"
    },
    "fullName": {
      "type": "string",
      "description": "Full file path of the document.",
      "example": "Example Artboard"
    },
    "saved": {
      "type": "boolean",
      "description": "Whether the document has been saved.",
      "example": true
    },
    "documentColorSpace": {
      "type": "string",
      "description": "The document color mode.",
      "enum": [
        "CMYK",
        "RGB"
      ],
      "example": "CMYK"
    },
    "width": {
      "type": "number",
      "description": "Document width in points.",
      "example": 72.0
    },
    "height": {
      "type": "number",
      "description": "Document height in points.",
      "example": 72.0
    },
    "rulerUnits": {
      "type": "string",
      "description": "Ruler units used in the document.",
      "enum": [
        "Points",
        "Picas",
        "Inches",
        "Millimeters",
        "Centimeters",
        "Pixels"
      ],
      "example": "Points"
    },
    "rulerOrigin": {
      "type": "array",
      "description": "The ruler origin point [x, y].",
      "items": {
        "type": "number"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "layerCount": {
      "type": "integer",
      "description": "Number of layers in the document.",
      "example": 1024
    },
    "artboardCount": {
      "type": "integer",
      "description": "Number of artboards in the document.",
      "example": 1024
    },
    "activeLayer": {
      "type": "string",
      "description": "Name of the currently active layer.",
      "example": "example_value"
    }
  }
}