adobe-illustrator-scripting

# Adobe Illustrator Scripting Expert guidance for automating Adobe Illustrator through ExtendScript (JavaScript/JSX). This skill covers the Illustrator scripting object model, all major API objects, code patterns, and best practices for writing production-quality `.jsx` scripts. ## Bundled Assets - [`references/object-model-quick-reference.md`](references/object-model-quick-reference.md): Use this as a quick lookup for the Illustrator scripting object model, common document and page item types, and related DOM concepts while writing or debugging scripts. - `scripts/`: Contains example Illustrator automation scripts you can use as starting points or implementation patterns for common tasks such as document manipulation, exports, batch processing, and DOM usage. Review and adapt these examples when you need working JSX patterns or want to compare behavior while debugging. ## When to Use This Skill - Writing new Illustrator automation scripts (`.jsx` or `.js` files) - Debugging or fixing existing Illustrator ExtendScript code - Manipulating documents, layers, page items, paths, text, or colors programmatically - Batch-processing Illustrator files or generating artwork from data - Exporting documents to various formats (PDF, SVG, PNG, EPS, etc.) - Working with the Illustrator DOM (Application, Document, Layer, PathItem, TextFrame, etc.) - Creating data-driven graphics using variables and datasets - Automating print workflows with scripted print options ## Prerequisites - Adobe Illustrator CC or later installed - Basic JavaScript knowledge (ExtendScript is ES3-based with Adobe extensions) - Scripts are executed via File > Scripts > Other Scripts, the Scripts menu, or placed in the Startup Scripts folder - The ExtendScript Toolkit (ESTK) or any text editor can be used to write `.jsx` files ## Scripting Environment ### Language and File Extensions | Language | Extension | Platform | |---|---|---| | ExtendScript/JavaScript | `.jsx`, `.js` | Windows, macOS | | AppleScript | `.scpt` | macOS only | | VBScript | `.vbs` | Windows only | **This skill focuses on ExtendScript/JavaScript** as the cross-platform, most widely used option. ### Executing Scripts - **Scripts menu**: File > Scripts lists scripts from the application scripts folder - **Other Scripts**: File > Scripts > Other Scripts to browse and run any `.jsx` file - **Startup Scripts**: Place scripts in the Startup Scripts folder to run automatically on launch - **Target directive**: Begin scripts with `#target illustrator` when running from ESTK or external tools - **`#targetengine` directive**: Use `#targetengine "session"` to persist variables across script executions - **External invocation**: Scripts are frequently launched from outside Illustrator — by shell scripts, task runners, CI jobs, ExtendScript Toolkit (`ExtendScript Toolkit.exe -run script.jsx`), or `BridgeTalk` messages from other Adobe apps. See [External Invocation & Argument Passing](#external-invocation--argument-passing). ### Naming Conventions (JavaScript) - Objects and properties use **camelCase**: `activeDocument`, `pathItems`, `textFrames` - The `app` global references the `Application` object - Collection indices are **zero-based**: `documents[0]` is the frontmost document - Use `typename` property to identify object types at runtime ## Object Model Overview The Illustrator DOM follows a strict containment hierarchy: ``` Application (app) ├── activeDocument / documents[] │ ├── layers[] │ │ ├── pageItems[] (all artwork) │ │ ├── pathItems[] │ │ ├── compoundPathItems[] │ │ ├── textFrames[] │ │ ├── placedItems[] │ │ ├── rasterItems[] │ │ ├── meshItems[] │ │ ├── pluginItems[] │ │ ├── graphItems[] │ │ ├── symbolItems[] │ │ ├── nonNativeItems[] │ │ ├── legacyTextItems[] │ │ └── groupItems[] │ ├── artboards[] │ ├── views[] │ ├── selection (array of selected items) │ ├── swatches[], spots[], gradients[], patterns[] │ ├── graphicStyles[], brushes[], symbols[] │ ├── textFonts[] (via app.textFonts) │ ├── stories[], characterStyles[], paragraphStyles[] │ ├── variables[], datasets[] │ └── inkList[], printOptions ├── preferences ├── printerList[] └── textFonts[] ``` ### Top-Level Objects - **Application** (`app`): The root object. Provides access to documents, preferences, fonts, and printers. Key properties: `activeDocument`, `documents`, `textFonts`, `printerList`, `userInteractionLevel`, `version`. - **Document**: Represents an open `.ai` file. Key properties: `layers`, `pageItems`, `selection`, `activeLayer`, `width`, `height`, `rulerOrigin`, `documentColorSpace`. Key methods: `saveAs()`, `exportFile()`, `close()`, `print()`. - **Layer**: A drawing layer. Key properties: `pageItems`, `pathItems`, `textFrames`, `visible`, `locked`, `opacity`, `name`, `zOrderPosition`, `color`. ## Measurement Units and Coordinates ### Units All scripting API values use **points** (72 points = 1 inch). Convert other units: | Unit | Conversion | |---|---| | Inches | multiply by 72 | | Centimeters | multiply by 28.346 | | Millimeters | multiply by 2.834645 | | Picas | multiply by 12 | Kerning, tracking, and `aki` properties use **em units** (thousandths of an em, proportional to font size). ### Coordinate System - For **scripted documents**, the origin `(0,0)` is at the **bottom-left** of the artboard - X increases left to right; Y increases bottom to top - The `position` property of a page item is the **top-left corner** of its bounding box as `[x, y]` - Maximum page item width/height: 16348 points ### Art Item Bounds Every page item has three bounding rectangles: - `geometricBounds`: Excludes stroke width `[left, top, right, bottom]` - `visibleBounds`: Includes stroke width - `controlBounds`: Includes control/direction points ## Working with Documents ### Creating and Opening ```javascript // Create a new document var doc = app.documents.add(); // Create with a preset var preset = new DocumentPreset(); preset.width = 612; // 8.5 inches preset.height = 792; // 11 inches preset.colorMode = DocumentColorSpace.CMYK; var doc = app.documents.addDocument("Print", preset); // Open an existing file var fileRef = new File("/path/to/file.ai"); var doc = app.open(fileRef); ``` ### Saving and Exporting ```javascript // Save as Illustrator format var saveOpts = new IllustratorSaveOptions(); saveOpts.compatibility = Compatibility.ILLUSTRATOR17; // CC doc.saveAs(new File("/path/to/output.ai"), saveOpts); // Export as PDF var pdfOpts = new PDFSaveOptions(); pdfOpts.compatibility = PDFCompatibility.ACROBAT7; pdfOpts.preserveEditability = false; doc.saveAs(new File("/path/to/output.pdf"), pdfOpts); // Export as PNG var pngOpts = new ExportOptionsPNG24(); pngOpts.horizontalScale = 300; pngOpts.verticalScale = 300; pngOpts.transparency = true; doc.exportFile(new File("/path/to/output.png"), ExportType.PNG24, pngOpts); // Export as SVG var svgOpts = new ExportOptionsSVG(); svgOpts.fontType = SVGFontType.OUTLINEFONT; doc.exportFile(new File("/path/to/output.svg"), ExportType.SVG, svgOpts); ``` ## Working with Paths and Shapes ### Built-in Shape Methods The `pathItems` collection provides convenience methods for common shapes: ```javascript var doc = app.activeDocument; var layer = doc.activeLayer; // Rectangle: rectangle(top, left, width, height) var rect = layer.pathItems.rectangle(500, 100, 200, 150); // Rounded rectangle: roundedRectangle(top, left, width, height, hRadius, vRadius) var rrect = layer.pathItems.roundedRectangle(500, 100, 200, 150, 20, 20); // Ellipse: ellipse(top, left, width, height) var oval = layer.pathItems.ellipse(400, 200, 100, 100); // Polygon: polygon(centerX, centerY, radius, sides) var hex = layer.pathItems.polygon(300, 300, 50, 6); // Star: star(centerX, centerY, radius, innerRadius, points) var star = layer.pathItems.star(300, 300, 50, 25, 5); ``` ### Freeform Paths Using Coordinate Arrays ```javascript var doc = app.activeDocument; var path = doc.pathItems.add(); path.setEntirePath([[100, 100], [200, 200], [300, 100]]); path.closed = false; path.stroked = true; path.strokeWidth = 2; ``` ### Freeform Paths Using PathPoint Objects ```javascript var doc = app.activeDocument; var path = doc.pathItems.add(); var point1 = path.pathPoints.add(); point1.anchor = [100, 100]; point1.leftDirection = [100, 100]; point1.rightDirection = [150, 150]; point1.pointType = PointType.SMOOTH; var point2 = path.pathPoints.add(); point2.anchor = [300, 100]; point2.leftDirection = [250, 150]; point2.rightDirection = [300, 100]; point2.pointType = PointType.SMOOTH; path.closed = false; ``` ### Path Properties ```javascript var item = doc.pathItems[0]; item.filled = true; item.stroked = true; item.strokeWidth = 1.5; item.strokeCap = StrokeCap.ROUNDENDCAP; item.strokeJoin = StrokeJoin.ROUNDENDJOIN; item.opacity = 80; item.closed = true; ``` ## Working with Colors ### Color Objects ```javascript // RGB Color (values 0-255) var red = new RGBColor(); red.red = 255; red.green = 0; red.blue = 0; // CMYK Color (values 0-100) var cyan = new CMYKColor(); cyan.cyan = 100; cyan.magenta = 0; cyan.yellow = 0; cyan.black = 0; // Grayscale (0-100, 0 = black) var gray = new GrayColor(); gray.gray = 50; // Lab Color var lab = new LabColor(); lab.l = 50; lab.a = 20; lab.b = -30; // No color (transparent) var none = new NoColor(); ``` ### Applying Colors ```javascript var item = doc.pathItems[0]; item.fillColor = red; item.strokeColor = cyan; // Gradient fill var gradient = doc.gradients.add(); gradient.type = GradientType.LINEAR; gradient.gradientStops[0].color = red; gradient.gradientStops[1].color = cyan; var gradColor = new GradientColor(); gradColor.gradient = gradient; item.fillColor = gradColor; ``` ### Spot Colors and Swatches ```javascript // Create a spot color var spot = doc.spots.add(); spot.name = "My Spot Color"; spot.color = red; // Base color definition var spotColor = new SpotColor(); spotColor.spot = spot; spotColor.tint = 100; item.fillColor = spotColor; // Access a swatch by name var swatch = doc.swatches.getByName("PANTONE 185 C"); item.fillColor = swatch.color; ``` ## Working with Text ### Text Frame Types ```javascript var doc = app.activeDocument; // Point text var pointText = doc.textFrames.add(); pointText.contents = "Hello World!"; pointText.position = [100, 500]; // Area text (text inside a path) var rectPath = doc.pathItems.rectangle(500, 100, 200, 100); var areaText = doc.textFrames.areaText(rectPath); areaText.contents = "Text inside a rectangle shape."; // Path text (text along a path) var curvePath = doc.pathItems.add(); curvePath.setEntirePath([[50, 300], [150, 400], [250, 300]]); var pathText = doc.textFrames.pathText(curvePath); pathText.contents = "Text on a path"; ``` ### Character and Paragraph Formatting ```javascript var tf = doc.textFrames[0]; var textRange = tf.textRange; // Character attributes var charAttr = textRange.characterAttributes; charAttr.size = 24; // Font size in points charAttr.textFont = app.textFonts.getByName("ArialMT"); charAttr.fillColor = red; charAttr.tracking = 50; // Em units charAttr.horizontalScale = 100; charAttr.verticalScale = 100; charAttr.baselineShift = 0; // Paragraph attributes var paraAttr = textRange.paragraphAttributes; paraAttr.justification = Justification.CENTER; paraAttr.firstLineIndent = 0; paraAttr.leftIndent = 0; paraAttr.spaceBefore = 0; paraAttr.spaceAfter = 0; ``` ### Accessing Text Content ```javascript var tf = doc.textFrames[0]; // Access sub-ranges var firstChar = tf.characters[0]; var firstWord = tf.words[0]; var firstPara = tf.paragraphs[0]; var firstLine = tf.lines[0]; // Modify specific ranges tf.words[0].characterAttributes.size = 36; tf.paragraphs[0].paragraphAttributes.justification = Justification.LEFT; ``` ### Threading Text Frames ```javascript var frame1 = doc.textFrames.areaText(path1); var frame2 = doc.textFrames.areaText(path2); // Link frames so text flows from frame1 to frame2 frame1.nextFrame = frame2; // Stories represent the full text across threaded frames var storyCount = doc.stories.length; var fullText = doc.stories[0].textRange.contents; ``` ## Working with Layers ```javascript var doc = app.activeDocument; // Create a layer var newLayer = doc.layers.add(); newLayer.name = "Background"; newLayer.visible = true; newLayer.locked = false; newLayer.opacity = 100; // Access existing layers var topLayer = doc.layers[0]; var layerByName = doc.layers.getByName("Background"); // Move items between layers var item = doc.pathItems[0]; item.move(newLayer, ElementPlacement.PLACEATBEGINNING); // Reorder layers