{ "product": "Illustrator", "slug": "illustrator", "version": "Adobe Illustrator 29 Type Library", "generated": "2026-09-16", "counts": { "objects": 292, "properties": 1847, "events": 0, "methods": 428 }, "objects": [ { "name": "AlternateGlyphsForm", "kind": "Enumeration", "description": "The alternate glyphs form of text.", "properties": [ { "name": "DEFAULTFORM", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "EXPERT", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "FULLWIDTH", "type": "number", "description": "", "access": "readonly", "value": "8" }, { "name": "HALFWIDTH", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "JIS04FORM", "type": "number", "description": "", "access": "readonly", "value": "11" }, { "name": "JIS78FORM", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "JIS83FORM", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "JIS90FORM", "type": "number", "description": "", "access": "readonly", "value": "10" }, { "name": "PROPORTIONALWIDTH", "type": "number", "description": "", "access": "readonly", "value": "9" }, { "name": "QUARTERWIDTH", "type": "number", "description": "", "access": "readonly", "value": "7" }, { "name": "THIRDWIDTH", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "TRADITIONAL", "type": "number", "description": "", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "AntiAliasingMethod", "kind": "Enumeration", "description": "Controls the type of antialiasing method used in the rasterization.", "properties": [ { "name": "ARTOPTIMIZED", "type": "number", "description": "Optimize for the art object.", "access": "readonly", "value": "1" }, { "name": "None", "type": "number", "description": "No anti-aliasing allowed.", "access": "readonly", "value": "0" }, { "name": "TYPEOPTIMIZED", "type": "number", "description": "Optimize for the type object.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Application", "kind": "Object", "description": "The Adobe Illustrator application.", "properties": [ { "name": "PDFPresetsList", "type": "string[]", "description": "The list of PDF preset names currently available for use.", "access": "readonly" }, { "name": "PPDFileList", "type": "PPDFile[]", "description": "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.", "access": "readonly" }, { "name": "activeDocument", "type": "Document", "description": "The active document.", "access": "read/write" }, { "name": "browserAvailable", "type": "boolean", "description": "Is a web browser available?", "access": "readonly" }, { "name": "buildNumber", "type": "string", "description": "The build number of the Adobe Illustrator application.", "access": "readonly" }, { "name": "colorSettingsList", "type": "File[]", "description": "The list of color settings files currently available for use.", "access": "readonly" }, { "name": "coordinateSystem", "type": "CoordinateSystem", "description": "Coordinate System used by script.", "access": "read/write" }, { "name": "defaultColorSettings", "type": "File", "description": "The default color settings file for the current application locale.", "access": "readonly" }, { "name": "documents", "type": "Documents", "description": "The open documents.", "access": "readonly" }, { "name": "flattenerPresetsList", "type": "string[]", "description": "The list of flattener style names currently available for use.", "access": "readonly" }, { "name": "freeMemory", "type": "number", "description": "The amount of unused memory within the Adobe Illustrator partition.", "access": "readonly" }, { "name": "homeScreenVisible", "type": "boolean", "description": "True if home Screen is Visible.", "access": "readonly" }, { "name": "locale", "type": "string", "description": "The Locale of the Adobe Illustrator application.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The application's name.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pasteRemembersLayers", "type": "boolean", "description": "Does paste operation remember layers structure?", "access": "read/write" }, { "name": "path", "type": "File", "description": "Path specification for the application.", "access": "readonly" }, { "name": "preferences", "type": "Preferences", "description": "Preferences for Illustrator.", "access": "readonly" }, { "name": "printPresetsList", "type": "string[]", "description": "The list of print preset names currently available for use.", "access": "readonly" }, { "name": "printerList", "type": "Printer[]", "description": "The list of installed printers.", "access": "readonly" }, { "name": "scriptingVersion", "type": "string", "description": "The version of the Scripting plugin.", "access": "readonly" }, { "name": "selection", "type": "any", "description": "The selection visible to the user.", "access": "read/write" }, { "name": "startupPresetsList", "type": "string[]", "description": "The list of presets available for creating a new document.", "access": "readonly" }, { "name": "textFonts", "type": "TextFonts", "description": "Installed fonts.", "access": "readonly" }, { "name": "tracingPresetsList", "type": "string[]", "description": "The list of tracing preset names currently available for use.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "userAdobeID", "type": "string", "description": "The current users adobe id.", "access": "readonly" }, { "name": "userGUID", "type": "string", "description": "The current user's GUID.", "access": "readonly" }, { "name": "userInteractionLevel", "type": "UserInteractionLevel", "description": "What level of interaction with the user should be allowed when handling script commands.", "access": "read/write" }, { "name": "version", "type": "string", "description": "The version of the Adobe Illustrator application.", "access": "readonly" }, { "name": "visible", "type": "boolean", "description": "Is the application visible.", "access": "readonly" } ], "events": [], "methods": [ { "name": "aATAddItem", "returns": "string", "description": "Add the specified to the sequencer.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to add." }, { "name": "destinationSequenceID", "type": "number", "description": "The UID for the owning sequence." }, { "name": "destinationIndex", "type": "number", "description": "The item UID where to insert." }, { "name": "srcItemIDData", "type": "string", "description": "The item ID of the item to construct." }, { "name": "type", "type": "string", "description": "The source of the item to construct." } ] }, { "name": "aATClear", "returns": "string", "description": "Clear the sequencer.", "parameters": [] }, { "name": "aATDuplicateItem", "returns": "string", "description": "Duplicates the specified item(s) from the sequencer.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to add." }, { "name": "item", "type": "string", "description": "The item UID(s)" } ] }, { "name": "aATEditItem", "returns": "string", "description": "Opens the specified item from the sequencer in the item editor.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to add." }, { "name": "item", "type": "string", "description": "The item UID." } ] }, { "name": "aATErrorsExist", "returns": "boolean", "description": "Retrieves a boolean indicating the presence of errors in the last script to execute.", "parameters": [] }, { "name": "aATExecuteSession", "returns": "void", "description": "Executes the active session in the sequencer.", "parameters": [] }, { "name": "aATExecuteSessionFromFile", "returns": "void", "description": "Executes the active session in the sequencer.", "parameters": [ { "name": "file", "type": "File", "description": "Execute a session file." } ] }, { "name": "aATFileRelativeChanged", "returns": "string", "description": "Switches a files relative token and path.", "parameters": [ { "name": "path", "type": "string", "description": "The path relative to the folder specified by Relative." }, { "name": "relative", "type": "string", "description": "The current relative path token." }, { "name": "newRelative", "type": "string", "description": "The new relative path token." } ] }, { "name": "aATFileSaveDialog", "returns": "string", "description": "Prompts the user to save a file or choose a file or directory and returns a relative path string to the file.", "parameters": [ { "name": "path", "type": "string", "description": "The path relative to the folder specified by Relative." }, { "name": "relative", "type": "string", "description": "The current relative path token." }, { "name": "type", "type": "string", "description": "The type of dialog to show in string format." } ] }, { "name": "aATGetEditorDialogFile", "returns": "File", "description": "Retrieves a file path to the AAT editor swf.", "parameters": [] }, { "name": "aATGetErrorDialogFile", "returns": "File", "description": "Retrieves a file path to the AAT error dialog swf.", "parameters": [] }, { "name": "aATGetListOfRelativePaths", "returns": "string", "description": "Gets an XML string listing the relative paths and the UI strings to display them.", "parameters": [] }, { "name": "aATGetSession", "returns": "string", "description": "Get the active session for the sequncer.", "parameters": [] }, { "name": "aATLoadLibExtension", "returns": "string", "description": "Loads a session file as an extension to the editor.", "parameters": [] }, { "name": "aATLoadModel", "returns": "string", "description": "Loads the aat model to the editor.", "parameters": [] }, { "name": "aATLoadSessionFile", "returns": "string", "description": "Loads a session into the sequencer.", "parameters": [] }, { "name": "aATLoadUIExtension", "returns": "string", "description": "Loads a UI description as an extension to the editor.", "parameters": [] }, { "name": "aATMoveItem", "returns": "string", "description": "Moves the specified in the sequencer.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to move." }, { "name": "moveThisID", "type": "string", "description": "The UID of the item to replace." }, { "name": "newSessionIndex", "type": "number", "description": "The index in the session of the destination top-most sequence." }, { "name": "destinationSequenceID", "type": "string", "description": "The UID for the owning sequence." }, { "name": "destinationIndex", "type": "number", "description": "The index where to insert." } ] }, { "name": "aATRemoveItem", "returns": "string", "description": "Removes the specified item from the sequencer.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to add." }, { "name": "item", "type": "string", "description": "The item UID." } ] }, { "name": "aATReplaceItem", "returns": "string", "description": "Replaces the specified to the sequencer.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to add." }, { "name": "replaceThisID", "type": "number", "description": "The UID of the item to replace." }, { "name": "srcItemIDData", "type": "string", "description": "The item ID of the item to construct." }, { "name": "type", "type": "string", "description": "The source of the item to construct." } ] }, { "name": "aATSaveAsSession", "returns": "string", "description": "Saves the active session in the sequencer to a new file.", "parameters": [] }, { "name": "aATSaveSession", "returns": "string", "description": "Saves the active session in the sequencer to a file.", "parameters": [] }, { "name": "applyDataToItem", "returns": "string", "description": "Applies the data used in the item editor to the item.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to edit." }, { "name": "item", "type": "string", "description": "The item UID." }, { "name": "data", "type": "string", "description": "The data to apply in XML format." } ] }, { "name": "applySingleDataPointToItem", "returns": "boolean", "description": "Applies data to the specified item from the sequencer in the item editor.", "parameters": [ { "name": "sessionIndex", "type": "number", "description": "The index in the session of the top-most sequence for the item to add." }, { "name": "item", "type": "string", "description": "The item UID." }, { "name": "dataID", "type": "string", "description": "The data to apply in XML format." }, { "name": "data", "type": "string", "description": "The data to apply in XML format." } ] }, { "name": "beep", "returns": "void", "description": "", "parameters": [] }, { "name": "beginSyncSettingsAutomationTest", "returns": "boolean", "description": "Starts the automation tests for the Sync Settings feature.", "parameters": [] }, { "name": "beginTypekitFontAutomationTest", "returns": "boolean", "description": "Starts the automation tests for the Typekit Font feature.", "parameters": [] }, { "name": "concatenateMatrix", "returns": "Matrix", "description": "Concatenate two transformation matrices.", "parameters": [ { "name": "matrix", "type": "Matrix", "description": "The matrix that is to be added to." }, { "name": "secondMatrix", "type": "Matrix", "description": "Second transformation matrix." } ] }, { "name": "concatenateRotationMatrix", "returns": "Matrix", "description": "Concatenate a rotation matrix to a transformation matrix.", "parameters": [ { "name": "matrix", "type": "Matrix", "description": "The matrix that is to be added to." }, { "name": "angle", "type": "number", "description": "Angle of rotation (in degrees)" } ] }, { "name": "concatenateScaleMatrix", "returns": "Matrix", "description": "Concatenate a scale matrix to a transformation matrix.", "parameters": [ { "name": "matrix", "type": "Matrix", "description": "The matrix that is to be added to." }, { "name": "scaleX", "type": "number", "description": "Horizontal scaling factor expressed as a percentage (100 = 100%)", "optional": true }, { "name": "scaleY", "type": "number", "description": "Vertical scaling factor expressed as a percentage (100 = 100%)", "optional": true } ] }, { "name": "concatenateTranslationMatrix", "returns": "Matrix", "description": "Concatenate a translation to a transformation matrix.", "parameters": [ { "name": "matrix", "type": "Matrix", "description": "The matrix that is to be added to." }, { "name": "deltaX", "type": "number", "description": "Horizontal transformation.", "optional": true }, { "name": "deltaY", "type": "number", "description": "Vertical transformation.", "optional": true } ] }, { "name": "convertSampleColor", "returns": "number[]", "description": "Converts a sample-component color from one color space to another.", "parameters": [ { "name": "sourceColorSpace", "type": "ImageColorSpace", "description": "The source color space." }, { "name": "sourceColor", "type": "number[]", "description": "The color to convert, an array of color components. First location of the array should contain alpha if source-has-alpha is true." }, { "name": "destColorSpace", "type": "ImageColorSpace", "description": "The destination color space." }, { "name": "colorConvertPurpose", "type": "ColorConvertPurpose", "description": "The parameter which passes the purpose of conversion." }, { "name": "sourceHasAlpha", "type": "boolean", "description": "True if alpha channel is present in source color.", "optional": true }, { "name": "destHasAlpha", "type": "boolean", "description": "True if alpha channel is present in destination color.", "optional": true } ] }, { "name": "copy", "returns": "void", "description": "Copy current selection to the clipboard.", "parameters": [] }, { "name": "cut", "returns": "void", "description": "Cut current selection to the clipboard.", "parameters": [] }, { "name": "deleteWorkspace", "returns": "boolean", "description": "Deletes an existing workspace.", "parameters": [ { "name": "workspaceName", "type": "string", "description": "Workspace Name." } ] }, { "name": "doScript", "returns": "void", "description": "Play an action from the Actions Palette.", "parameters": [ { "name": "action", "type": "string", "description": "The name of the action to play (note that the case of letters in the Action name is important and must match the case of the name in the Actions palette)" }, { "name": "from", "type": "string", "description": "The name of the action set containing the action being played (note that the case of letters in the Action Set name is important and must match the case of the name in the Actions palette)" }, { "name": "dialogs", "type": "boolean", "description": "Are dialog boxes associated with the action to be presented?", "optional": true } ] }, { "name": "dumpPGFFile", "returns": "boolean", "description": "Dump the PGF portion of ai file to txt file.", "parameters": [ { "name": "file", "type": "File", "description": "The AI file to be opened." }, { "name": "documentColorSpace", "type": "DocumentColorSpace", "description": "Choose color space only for documents saved with multiple color models (pre-Illustrator 9)", "optional": true }, { "name": "pGFFile", "type": "File", "description": "Folder to save the output PGF file." } ] }, { "name": "executeMenuCommand", "returns": "void", "description": "Executes a menu command using the menu shortcut string.", "parameters": [ { "name": "menuCommandString", "type": "string", "description": "Menu command shortcut." } ] }, { "name": "getCCXUserJSONData", "returns": "string", "description": "Returns the JSON Data required by CCX Welcome.", "parameters": [ { "name": "mode", "type": "string", "description": "Mode for which the data is to be provided.", "optional": true } ] }, { "name": "getExecutionOutput", "returns": "string", "description": "Retrieves a string containing the results of the last script to execute.", "parameters": [] }, { "name": "getHelloJSONData", "returns": "string", "description": "Returns the JSON Data required by Hello.", "parameters": [] }, { "name": "getIdentityMatrix", "returns": "Matrix", "description": "Returns an identity matrix.", "parameters": [] }, { "name": "getIsFileOpen", "returns": "boolean", "description": "Returns if the specified filePath is open.", "parameters": [ { "name": "filePath", "type": "string", "description": "The filePath to be checked." } ] }, { "name": "getPPDFileInfo", "returns": "PPDFileInfo", "description": "Get detailed info from the specified PPD file.", "parameters": [ { "name": "name", "type": "string", "description": "The model name of the PPD file." } ] }, { "name": "getPresetFileOfType", "returns": "File", "description": "Given a preset type, returns the full path to the application's default document profile for the type.", "parameters": [ { "name": "presetType", "type": "DocumentPresetType", "description": "The preset type." } ] }, { "name": "getPresetSettings", "returns": "DocumentPreset", "description": "Given a preset name, tries and retrieves the settings from the preset template.", "parameters": [ { "name": "preset", "type": "string", "description": "The name of the preset." } ] }, { "name": "getRotationMatrix", "returns": "Matrix", "description": "Returns a rotation transformation matrix.", "parameters": [ { "name": "angle", "type": "number", "description": "Angle of rotation (in degrees)", "optional": true } ] }, { "name": "getScaleMatrix", "returns": "Matrix", "description": "Returns a scale transformation matrix.", "parameters": [ { "name": "scaleX", "type": "number", "description": "Horizontal scaling factor expressed as a percentage (100 = 100%)", "optional": true }, { "name": "scaleY", "type": "number", "description": "Vertical scaling factor expressed as a percentage (100 = 100%)", "optional": true } ] }, { "name": "getScriptableHelpGroup", "returns": "any", "description": "Get the scriptable help group object that represents the search widget in the app bar.", "parameters": [] }, { "name": "getTranslationMatrix", "returns": "Matrix", "description": "Returns a translation matrix.", "parameters": [ { "name": "deltaX", "type": "number", "description": "Horizontal transformation.", "optional": true }, { "name": "deltaY", "type": "number", "description": "Vertical transformation.", "optional": true } ] }, { "name": "getVersionString", "returns": "string", "description": "Retrieves a string representing the AAT version.", "parameters": [] }, { "name": "invertMatrix", "returns": "Matrix", "description": "Invert a matrix.", "parameters": [ { "name": "matrix", "type": "Matrix", "description": "The matrix to invert." } ] }, { "name": "isEqualMatrix", "returns": "boolean", "description": "Compares two matrices for equality.", "parameters": [ { "name": "matrix", "type": "Matrix", "description": "First transformation matrix to compare." }, { "name": "secondMatrix", "type": "Matrix", "description": "Second transformation matrix." } ] }, { "name": "isFillActive", "returns": "boolean", "description": "Checks if fill is active or not.", "parameters": [] }, { "name": "isSingularMatrix", "returns": "boolean", "description": "Tests if a matrix is singular (cannot be inverted)", "parameters": [ { "name": "matrix", "type": "Matrix", "description": "The matrix to check." } ] }, { "name": "isStrokeActive", "returns": "boolean", "description": "Checks if stroke is active or not.", "parameters": [] }, { "name": "isTouchWorkspace", "returns": "boolean", "description": "Is In Touch Workspace.", "parameters": [] }, { "name": "isUserSharingAppUsageData", "returns": "boolean", "description": "Is user sharing the application usage data.", "parameters": [] }, { "name": "launchExtension", "returns": "number", "description": "Launch cep Extension given its ID.", "parameters": [ { "name": "extensionID", "type": "string", "description": "Arguments for Launching Extension - ID of extension in manifest.xml of corresponding extension." } ] }, { "name": "loadAction", "returns": "void", "description": "Load an action into action palette.", "parameters": [ { "name": "actionFilePath", "type": "File", "description": "The path on the system of the action file to be loaded." } ] }, { "name": "loadColorSettings", "returns": "void", "description": "Load the color settings from the file. If the file is an empty file spec, the color management will be turned off.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File spec for the color settings." } ] }, { "name": "open", "returns": "Document", "description": "Open the specified document file.", "parameters": [ { "name": "file", "type": "File", "description": "The file to be opened." }, { "name": "documentColorSpace", "type": "DocumentColorSpace", "description": "Choose color space only for documents saved with multiple color models (pre-Illustrator 9)", "optional": true }, { "name": "options", "type": "any", "description": "Options for opening a particular type of file.", "optional": true } ] }, { "name": "openCloudDocument", "returns": "Document", "description": "Open the specified cloud document.", "parameters": [ { "name": "cloudPath", "type": "string", "description": "Path of the document to be opened from cloud." } ] }, { "name": "openCloudLibraryAssetForEditing", "returns": "Document", "description": "For Internal Use.", "parameters": [ { "name": "assetURL", "type": "File", "description": "For Internal use." }, { "name": "thumbnailURL", "type": "File", "description": "For Internal use." }, { "name": "assetType", "type": "string", "description": "For internal use." }, { "name": "options", "type": "any", "description": "For internal use.", "optional": true } ] }, { "name": "paste", "returns": "void", "description": "Paste clipboard into the current document.", "parameters": [] }, { "name": "quit", "returns": "void", "description": "Quit the application.", "parameters": [] }, { "name": "redo", "returns": "void", "description": "Redo the last transaction.", "parameters": [] }, { "name": "redraw", "returns": "void", "description": "Force Illustrator to redraw its window(s)", "parameters": [] }, { "name": "reflectCSAW", "returns": "void", "description": "Generate Creative Suite ActionScript Wrappers in specified directory.", "parameters": [ { "name": "outputFolder", "type": "File", "description": "Location for the output files." } ] }, { "name": "resetWorkspace", "returns": "boolean", "description": "Resets the current workspace.", "parameters": [] }, { "name": "runAPITest", "returns": "void", "description": "Runs API Tests from the TestAPI Plug-in.", "parameters": [ { "name": "testName", "type": "string", "description": "Arguments for Running Tests - eg. Name of Test/Suite." } ] }, { "name": "saveWorkspace", "returns": "boolean", "description": "Saves a new workspace.", "parameters": [ { "name": "workspaceName", "type": "string", "description": "Workspace Name." } ] }, { "name": "selectTool", "returns": "boolean", "description": "Select tool using toolname.", "parameters": [ { "name": "toolName", "type": "string", "description": "Tool Name." } ] }, { "name": "sendScriptMessage", "returns": "string", "description": "Sends the script message to the required plugin.", "parameters": [ { "name": "pluginName", "type": "string", "description": "Plugin to which message needs to be sent." }, { "name": "messageSelector", "type": "string", "description": "Functionality that is to be executed." }, { "name": "inputString", "type": "string", "description": "Pass any data encoded in a string." } ] }, { "name": "setThumbnailOptionsForCloudLibrary", "returns": "void", "description": "For Internal Use.", "parameters": [ { "name": "options", "type": "any", "description": "Options for the PNG24 export." } ] }, { "name": "showColorPicker", "returns": "Color", "description": "Invokes application's color picker.", "parameters": [ { "name": "color", "type": "Color", "description": "The color to load in the color picker initially." } ] }, { "name": "showLearnPanelWithContent", "returns": "boolean", "description": "Display learn panel with specific content.", "parameters": [ { "name": "manifest", "type": "string", "description": "Path of the manifest." }, { "name": "hTMLPage", "type": "string", "description": "Url of the html file to be displayed on learn panel." } ] }, { "name": "showPresets", "returns": "string[]", "description": "Get presets from the file.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File spec to import from." } ] }, { "name": "switchWorkspace", "returns": "boolean", "description": "Switches between workspaces.", "parameters": [ { "name": "workspaceName", "type": "string", "description": "Workspace Name." } ] }, { "name": "translatePlaceholderText", "returns": "string", "description": "Translate the placeholder text to regular text. A method to enter unicode points in hex values.", "parameters": [ { "name": "text", "type": "string", "description": "The placeholder text to be translated." } ] }, { "name": "translateString", "returns": "string", "description": "Returns a string translated from the key and source data passed in.", "parameters": [ { "name": "key", "type": "string", "description": "The string to translate." }, { "name": "source", "type": "string", "description": "The plugin name from the source of the key." } ] }, { "name": "undo", "returns": "void", "description": "Undo the last transaction.", "parameters": [] }, { "name": "unloadAction", "returns": "void", "description": "Unloads an action into action palette.", "parameters": [ { "name": "setName", "type": "string", "description": "Name of the set to be unloaded." }, { "name": "actionName", "type": "string", "description": "Name of the action to be unloaded." } ] } ] }, { "name": "ArtStyle", "kind": "Object", "description": "An art style.", "properties": [ { "name": "name", "type": "string", "description": "The art style's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "applyTo", "returns": "void", "description": "Apply a brush or art style to object(s)", "parameters": [ { "name": "artItem", "type": "any", "description": "The page item(s) to apply to." } ] }, { "name": "mergeTo", "returns": "void", "description": "Merge an art style to object(s) current style(s)", "parameters": [ { "name": "artItem", "type": "any", "description": "The page item(s) to merge to." } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "ArtStyles", "kind": "Collection", "description": "A collection of art styles.", "elementType": "ArtStyle", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "ArtStyle", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Artboard", "kind": "Object", "description": "An artboard object.", "properties": [ { "name": "artboardRect", "type": "number[]", "description": "Size and position of artboard.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The name of the artboard.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "rulerOrigin", "type": "Point", "description": "Ruler origin of artboard.It is relative to left-bottom corner of the Artboard.", "access": "read/write" }, { "name": "rulerPAR", "type": "number", "description": "Pixel aspect ratio, used in ruler visualization if the units are pixels.", "access": "read/write", "range": { "min": "0.1", "max": "10.0" } }, { "name": "showCenter", "type": "boolean", "description": "Show center mark.", "access": "read/write" }, { "name": "showCrossHairs", "type": "boolean", "description": "Show cross hairs.", "access": "read/write" }, { "name": "showSafeAreas", "type": "boolean", "description": "Show title and action safe areas (for video)", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Artboards", "kind": "Collection", "description": "A collection of artboards.", "elementType": "Artboard", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Artboard", "description": "Add artboard object.", "parameters": [ { "name": "artboardRect", "type": "number[]", "description": "Size and position of artboard." } ] }, { "name": "getActiveArtboardIndex", "returns": "number", "description": "Retrieves the index position of the active artboard in the document's list.", "parameters": [] }, { "name": "getByName", "returns": "Artboard", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "getByName", "returns": "Artboard", "description": "Get the first Artboard with specified name.", "parameters": [ { "name": "artboardName", "type": "string", "description": "The name of the artboard." } ] }, { "name": "insert", "returns": "void", "description": "Insert an Artboard at specified location.", "parameters": [ { "name": "artboardRect", "type": "number[]", "description": "Size and position of artboard." }, { "name": "index", "type": "number", "description": "Index position where artboard should be inserted." } ] }, { "name": "remove", "returns": "void", "description": "Delete artboard object.", "parameters": [ { "name": "index", "type": "number", "description": "Index of the crop area to be deleted." } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "setActiveArtboardIndex", "returns": "void", "description": "Makes a specific artboard active, and makes it current in the iteration order.", "parameters": [ { "name": "index", "type": "number", "description": "The 0-based index position of the artboard in the document list." } ] } ] }, { "name": "Asset", "kind": "Object", "description": "An (exportable) asset.", "properties": [ { "name": "assetID", "type": "number", "description": "The UID for the asset which is unique within a document.", "access": "readonly" }, { "name": "assetName", "type": "string", "description": "Name of the asset.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getNormalizedName", "returns": "string", "description": "Gets the normalized name without special characters, such that it can be used as a file name.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Assets", "kind": "Collection", "description": "A collection of assets.", "elementType": "Asset", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Asset", "description": "Creates an asset from the given art(s)", "parameters": [ { "name": "sourceArt", "type": "any", "description": "The page item(s) to apply to." } ] }, { "name": "addFromSelection", "returns": "Asset", "description": "Creates an asset from the selected arts.", "parameters": [] }, { "name": "getByID", "returns": "Asset", "description": "Gets the asset with the specified AssetID.", "parameters": [ { "name": "assetID", "type": "number", "description": "The UID of the asset." } ] }, { "name": "getByName", "returns": "Asset", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "getByName", "returns": "Asset", "description": "Gets the first asset with specified name.", "parameters": [ { "name": "assetName", "type": "string", "description": "Name of the asset." } ] }, { "name": "remove", "returns": "void", "description": "Deletes the asset with specified id.", "parameters": [ { "name": "assetID", "type": "number", "description": "UID of the asset to be deleted." } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "AutoCADColors", "kind": "Enumeration", "description": "", "properties": [ { "name": "Max16Colors", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "Max256Colors", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "Max8Colors", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "TrueColors", "type": "number", "description": "", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "AutoCADCompatibility", "kind": "Enumeration", "description": "", "properties": [ { "name": "AutoCADRelease13", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "AutoCADRelease14", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "AutoCADRelease15", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "AutoCADRelease18", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "AutoCADRelease21", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "AutoCADRelease24", "type": "number", "description": "", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "AutoCADExportFileFormat", "kind": "Enumeration", "description": "", "properties": [ { "name": "DWG", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "DXF", "type": "number", "description": "", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "AutoCADExportOption", "kind": "Enumeration", "description": "", "properties": [ { "name": "MaximumEditability", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "PreserveAppearance", "type": "number", "description": "", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "AutoCADGlobalScaleOption", "kind": "Enumeration", "description": "", "properties": [ { "name": "FitArtboard", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "OriginalSize", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "ScaleByValue", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "AutoCADRasterFormat", "kind": "Enumeration", "description": "", "properties": [ { "name": "JPEG", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "PNG", "type": "number", "description": "", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "AutoCADUnit", "kind": "Enumeration", "description": "", "properties": [ { "name": "Centimeters", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "Inches", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "Millimeters", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "Picas", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "Pixels", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "Points", "type": "number", "description": "", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "AutoKernType", "kind": "Enumeration", "description": "The auto kern type.", "properties": [ { "name": "AUTO", "type": "number", "description": "Auto kerning.", "access": "readonly", "value": "1" }, { "name": "METRICSROMANONLY", "type": "number", "description": "Metrics roman only.", "access": "readonly", "value": "3" }, { "name": "NOAUTOKERN", "type": "number", "description": "No auto kerning.", "access": "readonly", "value": "0" }, { "name": "OPTICAL", "type": "number", "description": "Optical kerning.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "AutoLeadingType", "kind": "Enumeration", "description": "The auto leading type.", "properties": [ { "name": "BOTTOMTOBOTTOM", "type": "number", "description": "Roman leading type.", "access": "readonly", "value": "0" }, { "name": "TOPTOTOP", "type": "number", "description": "Japanese leading type.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "BaselineDirectionType", "kind": "Enumeration", "description": "The baseline direction type.", "properties": [ { "name": "Standard", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "TateChuYoko", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "VerticalRotated", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "BlendModes", "kind": "Enumeration", "description": "Blend modes used when compositing an object.", "properties": [ { "name": "COLORBLEND", "type": "number", "description": "", "access": "readonly", "value": "14" }, { "name": "COLORBURN", "type": "number", "description": "", "access": "readonly", "value": "7" }, { "name": "COLORDODGE", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "DARKEN", "type": "number", "description": "", "access": "readonly", "value": "8" }, { "name": "DIFFERENCE", "type": "number", "description": "", "access": "readonly", "value": "10" }, { "name": "EXCLUSION", "type": "number", "description": "", "access": "readonly", "value": "11" }, { "name": "HARDLIGHT", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "HUE", "type": "number", "description": "", "access": "readonly", "value": "12" }, { "name": "LIGHTEN", "type": "number", "description": "", "access": "readonly", "value": "9" }, { "name": "LUMINOSITY", "type": "number", "description": "", "access": "readonly", "value": "15" }, { "name": "MULTIPLY", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "NORMAL", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "OVERLAY", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "SATURATIONBLEND", "type": "number", "description": "", "access": "readonly", "value": "13" }, { "name": "SCREEN", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "SOFTLIGHT", "type": "number", "description": "", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "BlendsExpandPolicy", "kind": "Enumeration", "description": "Blends Expand policy used by FXG file format.", "properties": [ { "name": "AUTOMATICALLYCONVERTBLENDS", "type": "number", "description": "Automatically Convert Blends.", "access": "readonly", "value": "1" }, { "name": "RASTERIZEBLENDS", "type": "number", "description": "Expand Blends by Rasterizing.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Brush", "kind": "Object", "description": "A brush.", "properties": [ { "name": "name", "type": "string", "description": "The brush's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "applyTo", "returns": "void", "description": "Apply a brush or art style to object(s)", "parameters": [ { "name": "artItem", "type": "any", "description": "The page item(s) to apply to." } ] } ] }, { "name": "Brushes", "kind": "Collection", "description": "A collection of brushes.", "elementType": "Brush", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Brush", "description": "Create a brush.", "parameters": [ { "name": "brushDefinition", "type": "File", "description": "The brush definition from which the brush would be created." }, { "name": "brushName", "type": "string", "description": "The name of the brush.", "optional": true } ] }, { "name": "addAndLoad", "returns": "Brush", "description": "Create a brush, select the brush tool and load the created brush in the brush tool.", "parameters": [ { "name": "brushDefinition", "type": "File", "description": "The brush definition from which the brush would be created." } ] }, { "name": "getByName", "returns": "Brush", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "BurasagariTypeEnum", "kind": "Enumeration", "description": "The Burasagari type.", "properties": [ { "name": "Forced", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "None", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "Standard", "type": "number", "description": "", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "CMYKColor", "kind": "Object", "description": "A CMYK color specification.", "extends": "Color", "properties": [ { "name": "black", "type": "number", "description": "The black color value (between 0.0 and 100.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "100.0" } }, { "name": "cyan", "type": "number", "description": "The cyan color value (between 0.0 and 100.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "100.0" } }, { "name": "magenta", "type": "number", "description": "The magenta color value (between 0.0 and 100.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "100.0" } }, { "name": "yellow", "type": "number", "description": "The yellow color value (between 0.0 and 100.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "100.0" } } ], "events": [], "methods": [] }, { "name": "CaseChangeType", "kind": "Enumeration", "description": "The case change type.", "properties": [ { "name": "LOWERCASE", "type": "number", "description": "Change to lower case.", "access": "readonly", "value": "1" }, { "name": "SENTENCECASE", "type": "number", "description": "Change to sentence case.", "access": "readonly", "value": "3" }, { "name": "TITLECASE", "type": "number", "description": "Change to title case.", "access": "readonly", "value": "2" }, { "name": "UPPERCASE", "type": "number", "description": "Change to upper case.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "CharacterAttributes", "kind": "Object", "description": "Properties of a character.", "properties": [ { "name": "Tsume", "type": "number", "description": "The percentage of space reduction around a Japanese character (100 = 100%)", "access": "read/write" }, { "name": "akiLeft", "type": "number", "description": "The em amount of left aki.", "access": "read/write" }, { "name": "akiRight", "type": "number", "description": "The em amount of right aki amount.", "access": "read/write" }, { "name": "alignment", "type": "StyleRunAlignmentType", "description": "The character alignment type.", "access": "read/write" }, { "name": "alternateGlyphs", "type": "AlternateGlyphsForm", "description": "The alternate glyphs form.", "access": "read/write" }, { "name": "autoLeading", "type": "boolean", "description": "Whether to use automatic leading.", "access": "read/write" }, { "name": "baselineDirection", "type": "BaselineDirectionType", "description": "The Japanese text baseline direction.", "access": "read/write" }, { "name": "baselinePosition", "type": "FontBaselineOption", "description": "The baseline position of text.", "access": "read/write" }, { "name": "baselineShift", "type": "number", "description": "The amount of shift (in points) of the text baseline.", "access": "read/write" }, { "name": "capitalization", "type": "FontCapsOption", "description": "The case of text.", "access": "read/write" }, { "name": "connectionForms", "type": "boolean", "description": "Whether the OpenType connection forms should be used.", "access": "read/write" }, { "name": "contextualLigature", "type": "boolean", "description": "Whether the contextual ligature should be used.", "access": "read/write" }, { "name": "diacVPos", "type": "DiacVPosType", "description": "Diacritics positioning attribute.", "access": "read/write" }, { "name": "diacXOffset", "type": "number", "description": "Diacritics x offset attribute.", "access": "read/write" }, { "name": "diacYOffset", "type": "number", "description": "Diacritics y offset attribute.", "access": "read/write" }, { "name": "digitSet", "type": "DigitSetType", "description": "Digit set attribute.", "access": "read/write" }, { "name": "dirOverride", "type": "DirOverrideType", "description": "Direction override attribute.", "access": "read/write" }, { "name": "discretionaryLigature", "type": "boolean", "description": "Whether the discretionary ligature should be used.", "access": "read/write" }, { "name": "figureStyle", "type": "FigureStyleType", "description": "Which figure style to use in OpenType font.", "access": "read/write" }, { "name": "fillColor", "type": "Color", "description": "The color of the text fill.", "access": "read/write" }, { "name": "fractions", "type": "boolean", "description": "Whether the OpenType fractions should be used.", "access": "read/write" }, { "name": "horizontalScale", "type": "number", "description": "Character horizontal scaling factor expressed as a percentage (100 = 100%)", "access": "read/write" }, { "name": "italics", "type": "boolean", "description": "Does the Japanese OpenType support italics?", "access": "read/write" }, { "name": "justificationAlternates", "type": "boolean", "description": "Justification alternates attribute.", "access": "read/write" }, { "name": "kana", "type": "boolean", "description": "Does the Japanese OpenType support kana?", "access": "read/write" }, { "name": "kashidas", "type": "KashidasType", "description": "Kashidas attribute.", "access": "read/write" }, { "name": "kerningMethod", "type": "AutoKernType", "description": "The automatic kerning method to use.", "access": "read/write" }, { "name": "language", "type": "LanguageType", "description": "The language of text.", "access": "read/write" }, { "name": "leading", "type": "number", "description": "The amount of space between two lines of text (in points)", "access": "read/write" }, { "name": "ligature", "type": "boolean", "description": "Whether the ligature should be used.", "access": "read/write" }, { "name": "noBreak", "type": "boolean", "description": "Whether line breaks are allowed.", "access": "read/write" }, { "name": "openTypePosition", "type": "FontOpenTypePositionOption", "description": "The OpenType baseline position.", "access": "read/write" }, { "name": "ordinals", "type": "boolean", "description": "Whether the OpenType ordinals should be used.", "access": "read/write" }, { "name": "ornaments", "type": "boolean", "description": "Whether the OpenType ornaments should be used.", "access": "read/write" }, { "name": "overprintFill", "type": "boolean", "description": "Whether to overprint the fill of the text.", "access": "read/write" }, { "name": "overprintStroke", "type": "boolean", "description": "Whether to overprint the stroke of the text.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "proportionalMetrics", "type": "boolean", "description": "Does the Japanese OpenType support proportional font?", "access": "read/write" }, { "name": "rotation", "type": "number", "description": "The character rotation angle (in degrees)", "access": "read/write" }, { "name": "size", "type": "number", "description": "Font size in points.", "access": "read/write" }, { "name": "strikeThrough", "type": "boolean", "description": "Whether to draw a strike through line over the text.", "access": "read/write" }, { "name": "strokeColor", "type": "Color", "description": "The color of the text stroke.", "access": "read/write" }, { "name": "strokeWeight", "type": "number", "description": "Line width of stroke.", "access": "read/write" }, { "name": "stylisticAlternates", "type": "boolean", "description": "Whether the OpenType stylistic alternates should be used.", "access": "read/write" }, { "name": "stylisticSets", "type": "number", "description": "Stylistic sets attribute.", "access": "read/write" }, { "name": "swash", "type": "boolean", "description": "Whether the OpenType swash should be used.", "access": "read/write" }, { "name": "tateChuYokoHorizontal", "type": "number", "description": "The Tate-Chu-Yoko horizontal adjustment in points.", "access": "read/write" }, { "name": "tateChuYokoVertical", "type": "number", "description": "The Tate-Chu-Yoko vertical adjustment in points.", "access": "read/write" }, { "name": "textFont", "type": "TextFont", "description": "The text font.", "access": "read/write" }, { "name": "titling", "type": "boolean", "description": "Whether the OpenType titling alternates should be used.", "access": "read/write" }, { "name": "tracking", "type": "number", "description": "The tracking or range kerning amount in thousands of an em.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "underline", "type": "boolean", "description": "Whether to underline the text.", "access": "read/write" }, { "name": "verticalScale", "type": "number", "description": "Character vertical scaling factor expressed as a percentage (100 = 100%)", "access": "read/write" }, { "name": "wariChuCharactersAfterBreak", "type": "number", "description": "", "access": "read/write" }, { "name": "wariChuCharactersBeforeBreak", "type": "number", "description": "", "access": "read/write" }, { "name": "wariChuEnabled", "type": "boolean", "description": "Whether WariChu is enabled.", "access": "read/write" }, { "name": "wariChuJustification", "type": "WariChuJustificationType", "description": "", "access": "read/write" }, { "name": "wariChuLineGap", "type": "number", "description": "The Wari-Chu line gap.", "access": "read/write" }, { "name": "wariChuLines", "type": "number", "description": "The number of Wari-Chu (multiple text lines fit into a space meant for one) lines.", "access": "read/write" }, { "name": "wariChuScale", "type": "number", "description": "The Wari-Chu scale.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "CharacterStyle", "kind": "Object", "description": "A named style that remembers character attributes.", "properties": [ { "name": "characterAttributes", "type": "CharacterAttributes", "description": "The character properties for the text range.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The character style's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "CharacterStyle", "description": "Adds an element.", "parameters": [] }, { "name": "applyTo", "returns": "void", "description": "Apply the character style to text object(s)", "parameters": [ { "name": "textItem", "type": "any", "description": "The text object(s) to apply the style to." }, { "name": "clearingOverrides", "type": "boolean", "description": "Whether to clear any text attributes before apply the style.", "optional": true } ] }, { "name": "clear", "returns": "void", "description": "Remove all the attributes from this character style.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "CharacterStyles", "kind": "Collection", "description": "A collection of character styles.", "elementType": "CharacterStyle", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "CharacterStyle", "description": "Create a named character style.", "parameters": [ { "name": "name", "type": "string", "description": "The character style name." } ] }, { "name": "getByName", "returns": "CharacterStyle", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Characters", "kind": "Collection", "description": "A collection of characters.", "elementType": "TextRange", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "TextRange", "description": "Create a character.", "parameters": [ { "name": "contents", "type": "string", "description": "The text string." } ] }, { "name": "addBefore", "returns": "TextRange", "description": "", "parameters": [ { "name": "contents", "type": "string", "description": "The text string." } ] }, { "name": "getByName", "returns": "TextRange", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Color", "kind": "Object", "description": "The parent class for all color values used in Illustrator. See the specific color classes for more information.", "properties": [], "events": [], "methods": [] }, { "name": "ColorConversion", "kind": "Enumeration", "description": "PDF color conversion policy.", "properties": [ { "name": "COLORCONVERSIONREPURPOSE", "type": "number", "description": "Preserves color numbers for untagged content in the same color space as the destination profile. Not available with CMS off.", "access": "readonly", "value": "2" }, { "name": "COLORCONVERSIONTODEST", "type": "number", "description": "Converts all colors to the profile selected for Destination.", "access": "readonly", "value": "1" }, { "name": "None", "type": "number", "description": "Preserves color data as is.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "ColorConvertPurpose", "kind": "Enumeration", "description": "Denotes the purpose of color conversion using ConvertSmapleColor method.", "properties": [ { "name": "defaultpurpose", "type": "number", "description": "Do standard conversion, without black preservation.", "access": "readonly", "value": "0" }, { "name": "dummypurpose", "type": "number", "description": "Dummy option.", "access": "readonly", "value": "4" }, { "name": "exportpurpose", "type": "number", "description": "Conversion options appropriate to creating an image for print or export.", "access": "readonly", "value": "2" }, { "name": "previewpurpose", "type": "number", "description": "Conversion options appropriate to creating an image for screen display.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ColorDestination", "kind": "Enumeration", "description": "PDF destination profile.", "properties": [ { "name": "COLORDESTINATIONDOCCMYK", "type": "number", "description": "Converts all colors to the profile selected for Destination.", "access": "readonly", "value": "1" }, { "name": "COLORDESTINATIONDOCRGB", "type": "number", "description": "Preserves color numbers for untagged content in the same color space as the destination profile. Not available with CMS off.", "access": "readonly", "value": "3" }, { "name": "COLORDESTINATIONPROFILE", "type": "number", "description": "Preserves color numbers for untagged content in the same color space as the destination profile. Not available with CMS off.", "access": "readonly", "value": "5" }, { "name": "COLORDESTINATIONWORKINGCMYK", "type": "number", "description": "Preserves color numbers for untagged content in the same color space as the destination profile. Not available with CMS off.", "access": "readonly", "value": "2" }, { "name": "COLORDESTINATIONWORKINGRGB", "type": "number", "description": "Preserves color numbers for untagged content in the same color space as the destination profile. Not available with CMS off.", "access": "readonly", "value": "4" }, { "name": "None", "type": "number", "description": "N/A.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "ColorDitherMethod", "kind": "Enumeration", "description": "Method used to dither colors for PNG8 and GIF export formats.", "properties": [ { "name": "DIFFUSION", "type": "number", "description": "", "access": "readonly", "value": "0x4466736E" }, { "name": "NOISE", "type": "number", "description": "", "access": "readonly", "value": "0x424E6F69" }, { "name": "NOREDUCTION", "type": "number", "description": "No dithering.", "access": "readonly", "value": "0x4E6F6E65" }, { "name": "PATTERNDITHER", "type": "number", "description": "", "access": "readonly", "value": "0x5074726E" } ], "events": [], "methods": [] }, { "name": "ColorModel", "kind": "Enumeration", "description": "Color model of the custom color.", "properties": [ { "name": "PROCESS", "type": "number", "description": "Process color (mixed ink)", "access": "readonly", "value": "1" }, { "name": "REGISTRATION", "type": "number", "description": "Registration color (prints on in all separations)", "access": "readonly", "value": "0" }, { "name": "SPOT", "type": "number", "description": "Spot color (separate ink)", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "ColorProfile", "kind": "Enumeration", "description": "PDF ICC profile inclusion.", "properties": [ { "name": "INCLUDEALLPROFILE", "type": "number", "description": "Everything gets tagged (embedProfile == true)", "access": "readonly", "value": "1" }, { "name": "INCLUDEDESTPROFILE", "type": "number", "description": "Everything ends up tagged with the destination profile.", "access": "readonly", "value": "4" }, { "name": "INCLUDERGBPROFILE", "type": "number", "description": "Tag all RGB, leave CMYK unchanged.", "access": "readonly", "value": "3" }, { "name": "LEAVEPROFILEUNCHANGED", "type": "number", "description": "Leave tagged items tagged, untagged items untagged.", "access": "readonly", "value": "2" }, { "name": "None", "type": "number", "description": "All profiles removed (embedProfile == false)", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "ColorReductionMethod", "kind": "Enumeration", "description": "Method used to reduce color for PNG8 and GIF export formats.", "properties": [ { "name": "ADAPTIVE", "type": "number", "description": "", "access": "readonly", "value": "0x41647074" }, { "name": "PERCEPTUAL", "type": "number", "description": "", "access": "readonly", "value": "0x50726370" }, { "name": "SELECTIVE", "type": "number", "description": "", "access": "readonly", "value": "0x536C7476" }, { "name": "WEB", "type": "number", "description": "", "access": "readonly", "value": "0x57656220" } ], "events": [], "methods": [] }, { "name": "ColorType", "kind": "Enumeration", "description": "The color model.", "properties": [ { "name": "CMYK", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "GRADIENT", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "GRAY", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "None", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "PATTERN", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "RGB", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "SPOT", "type": "number", "description": "", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "Compatibility", "kind": "Enumeration", "description": "The compatibility type.", "properties": [ { "name": "ILLUSTRATOR10", "type": "number", "description": "", "access": "readonly", "value": "10" }, { "name": "ILLUSTRATOR11", "type": "number", "description": "", "access": "readonly", "value": "11" }, { "name": "ILLUSTRATOR12", "type": "number", "description": "", "access": "readonly", "value": "12" }, { "name": "ILLUSTRATOR13", "type": "number", "description": "", "access": "readonly", "value": "13" }, { "name": "ILLUSTRATOR14", "type": "number", "description": "", "access": "readonly", "value": "14" }, { "name": "ILLUSTRATOR15", "type": "number", "description": "", "access": "readonly", "value": "15" }, { "name": "ILLUSTRATOR16", "type": "number", "description": "", "access": "readonly", "value": "16" }, { "name": "ILLUSTRATOR17", "type": "number", "description": "", "access": "readonly", "value": "17" }, { "name": "ILLUSTRATOR24", "type": "number", "description": "", "access": "readonly", "value": "24" }, { "name": "ILLUSTRATOR3", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "ILLUSTRATOR8", "type": "number", "description": "", "access": "readonly", "value": "8" }, { "name": "ILLUSTRATOR9", "type": "number", "description": "", "access": "readonly", "value": "9" }, { "name": "JAPANESEVERSION3", "type": "number", "description": "", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "ComposerEngineType", "kind": "Enumeration", "description": "The composer type constants.", "properties": [ { "name": "adornment", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "latinCJKComposer", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "optycaComposer", "type": "number", "description": "", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "CompoundPathItem", "kind": "Object", "description": "Compound path artwork item.", "extends": "PageItem", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathItems", "type": "PathItems", "description": "The path artwork in this compound path.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "CompoundPathItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "CompoundPathItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "CompoundPathItems", "kind": "Collection", "description": "A collection of compound path items.", "elementType": "CompoundPathItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "CompoundPathItem", "description": "Create a compound path item.", "parameters": [] }, { "name": "getByName", "returns": "CompoundPathItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "CompressionQuality", "kind": "Enumeration", "description": "The compression type.", "properties": [ { "name": "AUTOMATICJPEG2000HIGH", "type": "number", "description": "Automatic JPEG2000 compression high.", "access": "readonly", "value": "18" }, { "name": "AUTOMATICJPEG2000LOSSLESS", "type": "number", "description": "Automatic JPEG2000 compression lossless.", "access": "readonly", "value": "20" }, { "name": "AUTOMATICJPEG2000LOW", "type": "number", "description": "Automatic JPEG2000 compression low.", "access": "readonly", "value": "16" }, { "name": "AUTOMATICJPEG2000MAXIMUM", "type": "number", "description": "Automatic JPEG2000 compression maximum.", "access": "readonly", "value": "19" }, { "name": "AUTOMATICJPEG2000MEDIUM", "type": "number", "description": "Automatic JPEG2000 compression medium.", "access": "readonly", "value": "17" }, { "name": "AUTOMATICJPEG2000MINIMUM", "type": "number", "description": "Automatic JPEG2000 compression minimum.", "access": "readonly", "value": "15" }, { "name": "AUTOMATICJPEGHIGH", "type": "number", "description": "Automatic JPEG compression high.", "access": "readonly", "value": "13" }, { "name": "AUTOMATICJPEGLOW", "type": "number", "description": "Automatic JPEG compression low.", "access": "readonly", "value": "11" }, { "name": "AUTOMATICJPEGMAXIMUM", "type": "number", "description": "Automatic JPEG compression maximum.", "access": "readonly", "value": "14" }, { "name": "AUTOMATICJPEGMEDIUM", "type": "number", "description": "Automatic JPEG compression medium.", "access": "readonly", "value": "12" }, { "name": "AUTOMATICJPEGMINIMUM", "type": "number", "description": "Automatically choose between JPEG and ZIP performing minimum compression depending on images.", "access": "readonly", "value": "10" }, { "name": "JPEG2000HIGH", "type": "number", "description": "", "access": "readonly", "value": "24" }, { "name": "JPEG2000LOSSLESS", "type": "number", "description": "", "access": "readonly", "value": "26" }, { "name": "JPEG2000LOW", "type": "number", "description": "", "access": "readonly", "value": "22" }, { "name": "JPEG2000MAXIMUM", "type": "number", "description": "", "access": "readonly", "value": "25" }, { "name": "JPEG2000MEDIUM", "type": "number", "description": "", "access": "readonly", "value": "23" }, { "name": "JPEG2000MINIMUM", "type": "number", "description": "", "access": "readonly", "value": "21" }, { "name": "JPEGHIGH", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "JPEGLOW", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "JPEGMAXIMUM", "type": "number", "description": "", "access": "readonly", "value": "7" }, { "name": "JPEGMEDIUM", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "JPEGMINIMUM", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "None", "type": "number", "description": "Automatic compression.", "access": "readonly", "value": "1" }, { "name": "ZIP4BIT", "type": "number", "description": "", "access": "readonly", "value": "8" }, { "name": "ZIP8BIT", "type": "number", "description": "", "access": "readonly", "value": "9" } ], "events": [], "methods": [] }, { "name": "CoordinateSystem", "kind": "Enumeration", "description": "Coordinate system used by Illustrator.", "properties": [ { "name": "ARTBOARDCOORDINATESYSTEM", "type": "number", "description": "Artboard coordinate system.", "access": "readonly", "value": "1" }, { "name": "DOCUMENTCOORDINATESYSTEM", "type": "number", "description": "Document coordinate system.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "CropOptions", "kind": "Enumeration", "description": "The crop style.", "properties": [ { "name": "Japanese", "type": "number", "description": "Japanese crop style.", "access": "readonly", "value": "2" }, { "name": "Standard", "type": "number", "description": "Standard crop style.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "DataSet", "kind": "Object", "description": "A set of variables and their associated dynamic data which will be used for dynamic publishing.", "properties": [ { "name": "name", "type": "string", "description": "The name of this dataset.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "display", "returns": "void", "description": "Displays the dynamic data that has been captured in the dataset.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "update", "returns": "void", "description": "Re-apply the dynamic data of the active dataset to the artboard.", "parameters": [] } ] }, { "name": "DataSets", "kind": "Collection", "description": "A collection of datasets.", "elementType": "DataSet", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "DataSet", "description": "Create a data set.", "parameters": [] }, { "name": "getByName", "returns": "DataSet", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "DiacVPosType", "kind": "Enumeration", "description": "Diacritic vertical position type constants.", "properties": [ { "name": "DEFAULT_POSITION", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "LOOSE_POSITION", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "MEDIUM_POSITION", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "OPENTYPE_POSITION", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "TIGHT_POSITION", "type": "number", "description": "", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "DigitSetType", "kind": "Enumeration", "description": "Digit set type constants.", "properties": [ { "name": "ARABIC_DIGITS", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "DEFAULT_DIGITS", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "FARSI_DIGITS", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "HINDI_DIGITS", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Dimensions", "kind": "Object", "description": "Dimensions (height and width)", "properties": [ { "name": "height", "type": "number", "description": "The Height parameter.", "access": "read/write", "static": true, "range": { "min": "0.0", "max": "" } }, { "name": "width", "type": "number", "description": "The Width parameter.", "access": "read/write", "static": true, "range": { "min": "0.0", "max": "" } } ], "events": [], "methods": [] }, { "name": "DirOverrideType", "kind": "Enumeration", "description": "Direction override type constants.", "properties": [ { "name": "DEFAULT_DIRECTION", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "LEFT_TO_RIGHT_DIRECTION", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "RIGHT_TO_LEFT_DIRECTION", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Document", "kind": "Object", "description": "A document.", "properties": [ { "name": "XMPString", "type": "string", "description": "The XMP packet string associated with the document.", "access": "read/write" }, { "name": "activeDataSet", "type": "DataSet", "description": "The active data set.", "access": "read/write" }, { "name": "activeLayer", "type": "Layer", "description": "The active layer.", "access": "read/write" }, { "name": "activeView", "type": "View", "description": "The document's current view.", "access": "readonly" }, { "name": "artboards", "type": "Artboards", "description": "All artboards in the document.", "access": "readonly" }, { "name": "assets", "type": "Assets", "description": "All assets in the document.", "access": "readonly" }, { "name": "brushes", "type": "Brushes", "description": "The brushes defined in this document.", "access": "readonly" }, { "name": "characterStyles", "type": "CharacterStyles", "description": "The list of character styles in this document.", "access": "readonly" }, { "name": "cloudPath", "type": "string", "description": "Path specification for the cloud document.", "access": "readonly" }, { "name": "colorProfileName", "type": "string", "description": "The name of the color profile of the document.", "access": "readonly" }, { "name": "compoundPathItems", "type": "CompoundPathItems", "description": "The compound path artwork in this collection.", "access": "readonly" }, { "name": "cropBox", "type": "number[]", "description": "", "access": "read/write" }, { "name": "cropStyle", "type": "CropOptions", "description": "", "access": "read/write" }, { "name": "dataSets", "type": "DataSets", "description": "The data sets defined in this document.", "access": "readonly" }, { "name": "defaultFillColor", "type": "Color", "description": "Default fill color.", "access": "read/write" }, { "name": "defaultFillOverprint", "type": "boolean", "description": "Will art beneath a filled object be overprinted by default?", "access": "read/write" }, { "name": "defaultFilled", "type": "boolean", "description": "Should a new path be filled?", "access": "read/write" }, { "name": "defaultStrokeCap", "type": "StrokeCap", "description": "Default type of line capping.", "access": "read/write" }, { "name": "defaultStrokeColor", "type": "Color", "description": "Default stroke color.", "access": "read/write" }, { "name": "defaultStrokeDashOffset", "type": "number", "description": "The default distance into the dash pattern at which the pattern should be started.", "access": "read/write" }, { "name": "defaultStrokeDashes", "type": "number[]", "description": "Default dash lengths (set to {} for a solid line)", "access": "read/write" }, { "name": "defaultStrokeJoin", "type": "StrokeJoin", "description": "Default type of joints.", "access": "read/write" }, { "name": "defaultStrokeMiterLimit", "type": "number", "description": "Specifies whether a join is mitered (pointed) or beveled (squared-off) by default.", "access": "read/write" }, { "name": "defaultStrokeOverprint", "type": "boolean", "description": "Will art beneath a stroked object be overprinted by default?", "access": "read/write" }, { "name": "defaultStrokeWidth", "type": "number", "description": "Default width of stroke.", "access": "read/write" }, { "name": "defaultStroked", "type": "boolean", "description": "Should a new path be stroked?", "access": "read/write" }, { "name": "documentColorSpace", "type": "DocumentColorSpace", "description": "The color space used for the document.", "access": "readonly" }, { "name": "embeddedItems", "type": "EmbeddedItems", "description": "The embedded art items in this layer.", "access": "readonly" }, { "name": "fullName", "type": "File", "description": "The file associated with the document.", "access": "readonly" }, { "name": "geometricBounds", "type": "number[]", "description": "The bounds of the illustration excluding stroke width.", "access": "readonly" }, { "name": "gradients", "type": "Gradients", "description": "The gradients available in this document.", "access": "readonly" }, { "name": "graphItems", "type": "GraphItems", "description": "The graph art items in this document.", "access": "readonly" }, { "name": "graphicStyles", "type": "ArtStyles", "description": "The graphic styles defined in this document.", "access": "readonly" }, { "name": "gridRepeatItems", "type": "GridRepeatItems", "description": "The grid repeat items in this document.", "access": "readonly" }, { "name": "groupItems", "type": "GroupItems", "description": "The group items in this document.", "access": "readonly" }, { "name": "height", "type": "number", "description": "", "access": "readonly" }, { "name": "inkList", "type": "Ink[]", "description": "The list of inks in this document.", "access": "readonly" }, { "name": "isCloudDocument", "type": "boolean", "description": "Is the document saved on cloud.", "access": "readonly" }, { "name": "kinsokuSet", "type": "string[]", "description": "The Kinsoku set.", "access": "readonly" }, { "name": "layers", "type": "Layers", "description": "The layers in this document.", "access": "readonly" }, { "name": "legacyTextItems", "type": "LegacyTextItems", "description": "The text frame items in this story.", "access": "readonly" }, { "name": "meshItems", "type": "MeshItems", "description": "The mesh art items in this document.", "access": "readonly" }, { "name": "mojikumiSet", "type": "string[]", "description": "The Mojikumi set.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The document's name.", "access": "readonly" }, { "name": "nonNativeItems", "type": "NonNativeItems", "description": "The non-native art items in this document.", "access": "readonly" }, { "name": "outputResolution", "type": "number", "description": "", "access": "readonly" }, { "name": "pageItems", "type": "PageItems", "description": "All the artwork in this document.", "access": "readonly" }, { "name": "pageOrigin", "type": "Point", "description": "", "access": "read/write" }, { "name": "paragraphStyles", "type": "ParagraphStyles", "description": "The list of paragraph styles in this document.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "path", "type": "File", "description": "Path specification for the document.", "access": "readonly" }, { "name": "pathItems", "type": "PathItems", "description": "The path artwork in this document.", "access": "readonly" }, { "name": "patterns", "type": "Patterns", "description": "The patterns available in this document.", "access": "readonly" }, { "name": "placedItems", "type": "PlacedItems", "description": "The placed art items in this document.", "access": "readonly" }, { "name": "pluginItems", "type": "PluginItems", "description": "The plugin art items in this document.", "access": "readonly" }, { "name": "printTiles", "type": "boolean", "description": "", "access": "readonly" }, { "name": "radialRepeatItems", "type": "RadialRepeatItems", "description": "The radial repeat items in this document.", "access": "readonly" }, { "name": "rasterEffectSettings", "type": "RasterEffectOptions", "description": "The document raster effects settings.", "access": "read/write" }, { "name": "rasterItems", "type": "RasterItems", "description": "The raster art items in this document.", "access": "readonly" }, { "name": "rulerOrigin", "type": "Point", "description": "", "access": "read/write" }, { "name": "rulerUnits", "type": "RulerUnits", "description": "", "access": "readonly" }, { "name": "saved", "type": "boolean", "description": "Has the document been saved?", "access": "read/write" }, { "name": "scaleFactor", "type": "number", "description": "The scale factor of the document.", "access": "readonly" }, { "name": "selection", "type": "any", "description": "The selection within the document.", "access": "read/write" }, { "name": "showPlacedImages", "type": "boolean", "description": "", "access": "readonly" }, { "name": "splitLongPaths", "type": "boolean", "description": "", "access": "readonly" }, { "name": "spots", "type": "Spots", "description": "The custom spot colors available in this document.", "access": "readonly" }, { "name": "stationery", "type": "boolean", "description": "Is the file a stationery file?", "access": "readonly" }, { "name": "stories", "type": "Stories", "description": "The story items in this document.", "access": "readonly" }, { "name": "swatchGroups", "type": "SwatchGroups", "description": "The Swatch Groups in this document.", "access": "readonly" }, { "name": "swatches", "type": "Swatches", "description": "The swatches in this document.", "access": "readonly" }, { "name": "symbolItems", "type": "SymbolItems", "description": "The symbol items in this document.", "access": "readonly" }, { "name": "symbols", "type": "Symbols", "description": "The symbols defined in this document.", "access": "readonly" }, { "name": "symmetryRepeatItems", "type": "SymmetryRepeatItems", "description": "The symmetry repeat items in this document.", "access": "readonly" }, { "name": "tags", "type": "Tags", "description": "The tags in this document.", "access": "readonly" }, { "name": "textFrames", "type": "TextFrameItems", "description": "The text frame items in this document.", "access": "readonly" }, { "name": "tileFullPages", "type": "boolean", "description": "", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "useDefaultScreen", "type": "boolean", "description": "", "access": "readonly" }, { "name": "variables", "type": "Variables", "description": "The variables defined in this document.", "access": "readonly" }, { "name": "variablesLocked", "type": "boolean", "description": "The locked variables.", "access": "read/write" }, { "name": "views", "type": "Views", "description": "The views in this document.", "access": "readonly" }, { "name": "visibleBounds", "type": "number[]", "description": "The visible bounds of the illustration including stroke width.", "access": "readonly" }, { "name": "width", "type": "number", "description": "", "access": "readonly" } ], "events": [], "methods": [ { "name": "activate", "returns": "void", "description": "Activate the first window associated with the document.", "parameters": [] }, { "name": "close", "returns": "void", "description": "Close the specified document(s)", "parameters": [ { "name": "saving", "type": "SaveOptions", "description": "Specifies whether changes should be saved before closing.", "optional": true } ] }, { "name": "convertCoordinate", "returns": "Point", "description": "Converts the coordinate system of a single point from one coordinate system to another.", "parameters": [ { "name": "coordinate", "type": "Point", "description": "The Coordinate to convert." }, { "name": "source", "type": "CoordinateSystem", "description": "The source coordinate system." }, { "name": "destination", "type": "CoordinateSystem", "description": "The destination coordinate system." } ] }, { "name": "convertToLargeCanvas", "returns": "void", "description": "Convert the document to Large Canvas Document.", "parameters": [] }, { "name": "exportFile", "returns": "void", "description": "Export the specified document(s)", "parameters": [ { "name": "exportFile", "type": "File", "description": "The file to export the document to." }, { "name": "exportFormat", "type": "ExportType", "description": "The file type to export the document as." }, { "name": "options", "type": "any", "description": "Options for the file type specified.", "optional": true } ] }, { "name": "exportForScreens", "returns": "void", "description": "Export the specified document/asset(s)/artboard(s)", "parameters": [ { "name": "exportFolder", "type": "File", "description": "The folder where the exported documents/assets/artboards are saved." }, { "name": "exportFormat", "type": "ExportForScreensType", "description": "The file type in which the document is exported." }, { "name": "options", "type": "any", "description": "Options for the file type specified.", "optional": true }, { "name": "itemToExport", "type": "ExportForScreensItemToExport", "description": "What to export.", "optional": true }, { "name": "fileNamePrefix", "type": "string", "description": "String prepended to each file name.", "optional": true } ] }, { "name": "exportPDFPreset", "returns": "void", "description": "Save all PDF presets to a file.", "parameters": [ { "name": "file", "type": "File", "description": "File to export to." } ] }, { "name": "exportPerspectiveGridPreset", "returns": "void", "description": "Saves all perspective grid presets to a file.", "parameters": [ { "name": "file", "type": "File", "description": "File to export to." } ] }, { "name": "exportPrintPreset", "returns": "void", "description": "Export the current print setting to the preset file.", "parameters": [ { "name": "file", "type": "File", "description": "File to export to." } ] }, { "name": "exportSelectionAsAi", "returns": "void", "description": "Export the selection as Ai file.", "parameters": [ { "name": "exportFile", "type": "File", "description": "The file to export the selection to." } ] }, { "name": "exportSelectionAsPNG", "returns": "void", "description": "Export the selection as PNG file.", "parameters": [ { "name": "exportFile", "type": "File", "description": "The file to export the selection to." }, { "name": "options", "type": "any", "description": "Options for the PNG24 export.", "optional": true } ] }, { "name": "exportVariables", "returns": "void", "description": "Save datasets into an XML library. The datasets contain variables and their associated dynamic data.", "parameters": [ { "name": "file", "type": "File", "description": "File spec to export to." } ] }, { "name": "fitArtboardToSelectedArt", "returns": "boolean", "description": "Change the artboard to selected art bounds.", "parameters": [ { "name": "index", "type": "number", "description": "The index of the artboard to update.", "optional": true } ] }, { "name": "getPageItemFromUuid", "returns": "PageItem", "description": "Retrieves the pageitem using Uuid.", "parameters": [ { "name": "uuid", "type": "string", "description": "Uuid of pageitem." } ] }, { "name": "getPerspectiveActivePlane", "returns": "PerspectiveGridPlaneType", "description": "Gets the active plane of the active perspective grid of the document.", "parameters": [] }, { "name": "hidePerspectiveGrid", "returns": "boolean", "description": "Hides the current active perspective grid for the document, if there is visible perspective grid.", "parameters": [] }, { "name": "imageCapture", "returns": "void", "description": "Capture the artwork content inside the clip bound as raster image, and write out the captured image data into the target image file.", "parameters": [ { "name": "imageFile", "type": "File", "description": "The file to which the captured image should be written." }, { "name": "clipBounds", "type": "number[]", "description": "The rectangular region of the artwork for image capture. If the parameter is omitted, the entire artwork bound is captured.", "optional": true }, { "name": "options", "type": "ImageCaptureOptions", "description": "Describes the image capture options.", "optional": true } ] }, { "name": "importCharacterStyles", "returns": "void", "description": "Load the character styles from the Illustrator file.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File spec to import from." } ] }, { "name": "importFile", "returns": "void", "description": "Import the file into current Ai document.", "parameters": [ { "name": "importFile", "type": "File", "description": "The file to import in the current document." }, { "name": "isLinked", "type": "boolean", "description": "Is AssetLiveLinked." }, { "name": "libraryName", "type": "string", "description": "For Internal Use.", "optional": true }, { "name": "itemName", "type": "string", "description": "For Internal Use.", "optional": true }, { "name": "elementRef", "type": "string", "description": "For Internal Use.", "optional": true }, { "name": "modifiedTime", "type": "number", "description": "For Internal Use.", "optional": true }, { "name": "creationTime", "type": "number", "description": "For Internal Use.", "optional": true }, { "name": "adobeStockId", "type": "string", "description": "For Internal Use.", "optional": true }, { "name": "adobeStockLicense", "type": "string", "description": "For Internal Use.", "optional": true }, { "name": "shouldLoadToPlaceGun", "type": "boolean", "description": "Whether or not to load the imported file to placegun.", "optional": true } ] }, { "name": "importPDFPreset", "returns": "void", "description": "Load all PDF presets from a file.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File to import from." }, { "name": "replacingPreset", "type": "boolean", "description": "Should existing editable presets be replaced?", "optional": true } ] }, { "name": "importParagraphStyles", "returns": "void", "description": "Load the paragraph styles from the Illustrator file.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File spec to import from." } ] }, { "name": "importPerspectiveGridPreset", "returns": "void", "description": "Loads mentioned perspective grid preset, if preset name is specified, else loads all(if no preset name is specified) presets, from the specified file.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File to import from." }, { "name": "perspectivePreset", "type": "string", "description": "Name of perspective grid preset.", "optional": true } ] }, { "name": "importPrintPreset", "returns": "void", "description": "Apply the named print preset from the file to the current print setting.", "parameters": [ { "name": "printPreset", "type": "string", "description": "The name of a print preset to import." }, { "name": "fileSpec", "type": "File", "description": "File to import from." } ] }, { "name": "importVariables", "returns": "void", "description": "Import a library containing datasets, variables and their associated dynamic data. Importing variables will overwrite existing variables and datasets.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File spec to import from." } ] }, { "name": "print", "returns": "void", "description": "Print the document.", "parameters": [ { "name": "options", "type": "PrintOptions", "description": "Print options.", "optional": true } ] }, { "name": "processGesture", "returns": "void", "description": "Process a gesture based on input points.", "parameters": [ { "name": "gesturePointsFile", "type": "string", "description": "File Path containing points constituting the gesture." } ] }, { "name": "rasterize", "returns": "PageItem", "description": "Rasterize the source art(s) within the specified clip bounds. The source art(s) are disposed as a result of the rasterization.", "parameters": [ { "name": "sourceArt", "type": "any", "description": "The page item(s) to be rasterized." }, { "name": "clipBounds", "type": "number[]", "description": "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": true }, { "name": "options", "type": "RasterizeOptions", "description": "Describes the rasterization options.", "optional": true } ] }, { "name": "rearrangeArtboards", "returns": "boolean", "description": "Rearrange Artboards in the document.", "parameters": [ { "name": "artboardLayout", "type": "DocumentArtboardLayout", "description": "Layout of artboards for rearrangement.", "optional": true }, { "name": "artboardRowsOrCols", "type": "number", "description": "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.", "optional": true }, { "name": "artboardSpacing", "type": "number", "description": "Spacing between artboards.", "optional": true }, { "name": "artboardMoveArtwork", "type": "boolean", "description": "Whether to move artwork with artboards.", "optional": true } ] }, { "name": "save", "returns": "void", "description": "Save the document.", "parameters": [] }, { "name": "saveAs", "returns": "void", "description": "Save the document with specific save options.", "parameters": [ { "name": "saveIn", "type": "File", "description": "The file to save the document in." }, { "name": "options", "type": "any", "description": "Options for the file type specified.", "optional": true } ] }, { "name": "saveToCloud", "returns": "void", "description": "Save the document to cloud at the specified path.", "parameters": [ { "name": "cloudPath", "type": "string", "description": "Path of the document to be saved on cloud." } ] }, { "name": "selectObjectsOnActiveArtboard", "returns": "boolean", "description": "Select art objects in active artboard.", "parameters": [] }, { "name": "selectPerspectivePreset", "returns": "boolean", "description": "Selects a predefined preset to define grid for the current document.", "parameters": [ { "name": "perspectivePreset", "type": "string", "description": "Name of perspective grid preset." } ] }, { "name": "setPerspectiveActivePlane", "returns": "boolean", "description": "Sets the active perspective plane for the active grid of the document.", "parameters": [ { "name": "perspectiveGridPlane", "type": "PerspectiveGridPlaneType", "description": "Type of perspective grid plane." } ] }, { "name": "showPerspectiveGrid", "returns": "boolean", "description": "Shows the current active perspective grid for the document, if no active perspective grid then shows the default perspective grid for the document.", "parameters": [] }, { "name": "windowCapture", "returns": "void", "description": "Capture the current document window to the target TIFF image file.", "parameters": [ { "name": "imageFile", "type": "File", "description": "The TIFF file to which the captured image should be written." }, { "name": "windowSize", "type": "Point", "description": "The size to make the window before capture." } ] }, { "name": "writeAsLibrary", "returns": "void", "description": "Write the document to a file as a library of specified type.", "parameters": [ { "name": "file", "type": "File", "description": "The file to write the library in." }, { "name": "libraryType", "type": "LibraryType", "description": "Type of library to write as." } ] } ] }, { "name": "DocumentArtboardLayout", "kind": "Enumeration", "description": "The layout of artboards in document.", "properties": [ { "name": "Column", "type": "number", "description": "Arrange artboards in a single column.", "access": "readonly", "value": "4" }, { "name": "GridByCol", "type": "number", "description": "Arrange artboards in Grid by Column pattern.", "access": "readonly", "value": "2" }, { "name": "GridByRow", "type": "number", "description": "Arrange artboards in Grid by Row pattern.", "access": "readonly", "value": "1" }, { "name": "RLGridByCol", "type": "number", "description": "Arrange artboards in Grid by Column pattern from right-to-left.", "access": "readonly", "value": "6" }, { "name": "RLGridByRow", "type": "number", "description": "Arrange artboards in Grid by Row pattern from right-to-left.", "access": "readonly", "value": "5" }, { "name": "RLRow", "type": "number", "description": "Arrange artboards in a single row from right-to-left.", "access": "readonly", "value": "7" }, { "name": "Row", "type": "number", "description": "Arrange artboards in a single row.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "DocumentColorSpace", "kind": "Enumeration", "description": "The color spaces available for documents.", "properties": [ { "name": "CMYK", "type": "number", "description": "CMYK document color space.", "access": "readonly", "value": "2" }, { "name": "RGB", "type": "number", "description": "RGB document color space.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "DocumentLayoutStyle", "kind": "Enumeration", "description": "Document layout style types.", "properties": [ { "name": "CASCADE", "type": "number", "description": "Arranges document in cascaded style.", "access": "readonly", "value": "0" }, { "name": "CONSOLIDATEALL", "type": "number", "description": "Consolidates all documents.", "access": "readonly", "value": "4" }, { "name": "FLOATALL", "type": "number", "description": "Arranges all documents floating layout.", "access": "readonly", "value": "3" }, { "name": "HORIZONTALTILE", "type": "number", "description": "Arranges documents as horizontal tiles.", "access": "readonly", "value": "1" }, { "name": "VERTICALTILE", "type": "number", "description": "Arranges documents as vertical tiles.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "DocumentPreset", "kind": "Object", "description": "The new document preset to use for creating a new document.", "properties": [ { "name": "artboardLayout", "type": "DocumentArtboardLayout", "description": "Layout for artboards.", "access": "read/write", "static": true, "value": "DocumentArtboardLayout.GridByRow" }, { "name": "artboardRowsOrCols", "type": "number", "description": "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.", "access": "read/write", "static": true, "value": "1" }, { "name": "artboardSpacing", "type": "number", "description": "Spacing between artboards.", "access": "read/write", "static": true, "value": "20.0" }, { "name": "colorMode", "type": "DocumentColorSpace", "description": "The color mode for the new document.", "access": "read/write", "static": true, "value": "DocumentColorSpace.CMYK" }, { "name": "documentBleedLink", "type": "boolean", "description": "Document link for bleed values.", "access": "read/write", "static": true, "value": "true" }, { "name": "documentBleedOffset", "type": "number[]", "description": "Document bleed offset rect.", "access": "read/write", "static": true }, { "name": "height", "type": "number", "description": "The height for the new document.", "access": "read/write", "static": true, "value": "792.0" }, { "name": "numArtboards", "type": "number", "description": "Number of artboards for new document.Range (1:100).", "access": "read/write", "static": true, "value": "1" }, { "name": "previewMode", "type": "DocumentPreviewMode", "description": "The preview mode for the new document.", "access": "read/write", "static": true, "value": "DocumentPreviewMode.DefaultPreview" }, { "name": "rasterResolution", "type": "DocumentRasterResolution", "description": "The raster resolution for the new document.", "access": "read/write", "static": true, "value": "DocumentRasterResolution.ScreenResolution" }, { "name": "title", "type": "string", "description": "The title for the new document.", "access": "read/write", "static": true, "value": "Untitled" }, { "name": "transparencyGrid", "type": "DocumentTransparencyGrid", "description": "The transparency grid for the new document.", "access": "read/write", "static": true, "value": "DocumentTransparencyGrid.TransparencyGridNone" }, { "name": "units", "type": "RulerUnits", "description": "The units for the new document.", "access": "read/write", "static": true, "value": "RulerUnits.Points" }, { "name": "width", "type": "number", "description": "The width for the new document.", "access": "read/write", "static": true, "value": "612.0" } ], "events": [], "methods": [] }, { "name": "DocumentPresetType", "kind": "Enumeration", "description": "The preset types available for new documents.", "properties": [ { "name": "BasicCMYK", "type": "number", "description": "The default CMYK document preset.", "access": "readonly", "value": "5" }, { "name": "BasicRGB", "type": "number", "description": "The default RGB document preset.", "access": "readonly", "value": "6" }, { "name": "Mobile", "type": "number", "description": "The default Mobile document preset.", "access": "readonly", "value": "3" }, { "name": "Print", "type": "number", "description": "The default Print document preset.", "access": "readonly", "value": "1" }, { "name": "Video", "type": "number", "description": "The default Video and Film document preset.", "access": "readonly", "value": "4" }, { "name": "Web", "type": "number", "description": "The default Web document preset.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "DocumentPreviewMode", "kind": "Enumeration", "description": "The preview modes available when creating a new document.", "properties": [ { "name": "DefaultPreview", "type": "number", "description": "Default Preview mode.", "access": "readonly", "value": "1" }, { "name": "OverprintPreview", "type": "number", "description": "Overprint Preview Mode.", "access": "readonly", "value": "3" }, { "name": "PixelPreview", "type": "number", "description": "Pixel Preview mode.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "DocumentRasterResolution", "kind": "Enumeration", "description": "The raster resolutions available when creating a new document.", "properties": [ { "name": "HighResolution", "type": "number", "description": "High raster resolution, 300 PPI.", "access": "readonly", "value": "3" }, { "name": "MediumResolution", "type": "number", "description": "Medium raster resolution, 150 PPI.", "access": "readonly", "value": "2" }, { "name": "ScreenResolution", "type": "number", "description": "Low raster resolution, 72 PPI.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "DocumentTransparencyGrid", "kind": "Enumeration", "description": "The transparency grid for the new document, in video presets.", "properties": [ { "name": "TransparencyGridBlue", "type": "number", "description": "Blue grids.", "access": "readonly", "value": "7" }, { "name": "TransparencyGridDark", "type": "number", "description": "Dark color grids.", "access": "readonly", "value": "3" }, { "name": "TransparencyGridGreen", "type": "number", "description": "Green grids.", "access": "readonly", "value": "6" }, { "name": "TransparencyGridLight", "type": "number", "description": "Light grid colors.", "access": "readonly", "value": "1" }, { "name": "TransparencyGridMedium", "type": "number", "description": "Medium grid colors.", "access": "readonly", "value": "2" }, { "name": "TransparencyGridNone", "type": "number", "description": "No grids.", "access": "readonly", "value": "0" }, { "name": "TransparencyGridOrange", "type": "number", "description": "Orange grids.", "access": "readonly", "value": "5" }, { "name": "TransparencyGridPurple", "type": "number", "description": "Purple grids.", "access": "readonly", "value": "8" }, { "name": "TransparencyGridRed", "type": "number", "description": "Red grids.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "DocumentType", "kind": "Enumeration", "description": "Savable document types.", "properties": [ { "name": "EPS", "type": "number", "description": "EPS file format.", "access": "readonly", "value": "2" }, { "name": "FXG", "type": "number", "description": "FXG file format.", "access": "readonly", "value": "4" }, { "name": "ILLUSTRATOR", "type": "number", "description": "Illustrator file format.", "access": "readonly", "value": "1" }, { "name": "PDF", "type": "number", "description": "Acrobat PDF file format.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "Documents", "kind": "Collection", "description": "A collection of documents.", "elementType": "Document", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Document", "description": "A document.", "parameters": [ { "name": "documentColorSpace", "type": "DocumentColorSpace", "description": "The color model used for the document.", "optional": true }, { "name": "width", "type": "number", "description": "Width of the artboard.", "optional": true }, { "name": "height", "type": "number", "description": "Height of the artboard.", "optional": true }, { "name": "numArtboards", "type": "number", "description": "Number of artboards for new document.Range (1:100).", "optional": true }, { "name": "artboardLayout", "type": "DocumentArtboardLayout", "description": "Layout of artboards for new document.", "optional": true }, { "name": "artboardSpacing", "type": "number", "description": "Spacing between artboards for new document.", "optional": true }, { "name": "artboardRowsOrCols", "type": "number", "description": "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.", "optional": true } ] }, { "name": "addDocument", "returns": "Document", "description": "Create a new document from a preset.", "parameters": [ { "name": "startupPreset", "type": "string", "description": "The name of a startup document preset." }, { "name": "presetSettings", "type": "DocumentPreset", "description": "Custom settings to apply to the preset.", "optional": true }, { "name": "showOptionsDialog", "type": "boolean", "description": "If false, do not show Options dialog.", "optional": true } ] }, { "name": "addDocumentWithDialogOption", "returns": "Document", "description": "Create a document from the preset with option to throw dialog to customize present settings.", "parameters": [ { "name": "startupPreset", "type": "string", "description": "The name of startup document preset." }, { "name": "showOptionsDialog", "type": "boolean", "description": "Argument controls if options Dialog is shown or not.", "optional": true } ] }, { "name": "arrange", "returns": "boolean", "description": "Arranges the documents in the specified style.", "parameters": [ { "name": "layoutStyle", "type": "DocumentLayoutStyle", "description": "The document layout style." } ] }, { "name": "getByName", "returns": "Document", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "DownsampleMethod", "kind": "Enumeration", "description": "The resample type.", "properties": [ { "name": "AVERAGEDOWNSAMPLE", "type": "number", "description": "Average Downsampling.", "access": "readonly", "value": "1" }, { "name": "BICUBICDOWNSAMPLE", "type": "number", "description": "Bicubic Downsampling.", "access": "readonly", "value": "3" }, { "name": "NODOWNSAMPLE", "type": "number", "description": "Downsampling.", "access": "readonly", "value": "0" }, { "name": "SUBSAMPLE", "type": "number", "description": "Subsampling.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "EPSPostScriptLevelEnum", "kind": "Enumeration", "description": "The PostScript levels available when saving EPS files.", "properties": [ { "name": "LEVEL2", "type": "number", "description": "PostScript Level 2.", "access": "readonly", "value": "2" }, { "name": "LEVEL3", "type": "number", "description": "PostScript Level 3.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "EPSPreview", "kind": "Enumeration", "description": "The preview type.", "properties": [ { "name": "BWMACINTOSH", "type": "number", "description": "Black and white Macintosh preview.", "access": "readonly", "value": "2" }, { "name": "BWTIFF", "type": "number", "description": "Black and white PC preview.", "access": "readonly", "value": "4" }, { "name": "COLORMACINTOSH", "type": "number", "description": "Color Macintosh preview.", "access": "readonly", "value": "3" }, { "name": "COLORTIFF", "type": "number", "description": "Color PC preview.", "access": "readonly", "value": "6" }, { "name": "None", "type": "number", "description": "No preview.", "access": "readonly", "value": "1" }, { "name": "TRANSPARENTCOLORTIFF", "type": "number", "description": "Transparent color PC preview (8 or later)", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "EPSSaveOptions", "kind": "Object", "description": "Options which may be supplied when saving a document as an Illustrator EPS file.", "properties": [ { "name": "artboardRange", "type": "string", "description": "If SaveMultipleArtboards is true,this will be considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "cmykPostScript", "type": "boolean", "description": "Use CMYK PostScript.", "access": "read/write", "static": true, "value": "true" }, { "name": "compatibility", "type": "Compatibility", "description": "What Illustrator file format version to create.", "access": "read/write", "static": true, "value": "Compatibility.ILLUSTRATOR24" }, { "name": "compatibleGradientPrinting", "type": "boolean", "description": "Create a raster item of the gradient or gradient mesh so that PostScript Level 2 printers can print the object.", "access": "read/write", "static": true, "value": "false" }, { "name": "embedAllFonts", "type": "boolean", "description": "Embed all fonts used by the document in the saved file (version 7 or later)", "access": "read/write", "static": true, "value": "false" }, { "name": "embedLinkedFiles", "type": "boolean", "description": "Are linked image files to be included in the saved document.", "access": "read/write", "static": true, "value": "false" }, { "name": "flattenOutput", "type": "OutputFlattening", "description": "How should transparency be flattened for older file format versions (pre-version 9)", "access": "read/write", "static": true, "value": "OutputFlattening.PRESERVEAPPEARANCE" }, { "name": "includeDocumentThumbnails", "type": "boolean", "description": "Include thumbnail image of the EPS artwork.", "access": "read/write", "static": true, "value": "true" }, { "name": "overprint", "type": "PDFOverprint", "description": "", "access": "read/write", "static": true, "value": "PDFOverprint.PRESERVEPDFOVERPRINT" }, { "name": "postScript", "type": "EPSPostScriptLevelEnum", "description": "PostScript level to use (level 1 valid for file format version 8 or older)", "access": "read/write", "static": true, "value": "EPSPostScriptLevelEnum.LEVEL2" }, { "name": "preview", "type": "EPSPreview", "description": "EPS preview format.", "access": "read/write", "static": true }, { "name": "saveMultipleArtboards", "type": "boolean", "description": "All the artboards or range of the artboards will be saved.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "EmbedItem", "kind": "Object", "description": "Embedded artwork item.", "extends": "PageItem", "properties": [ { "name": "file", "type": "File", "description": "The file containing the placed artwork.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "EmbedItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "EmbedItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "EmbeddedItems", "kind": "Collection", "description": "EmbeddedItems Collection.", "elementType": "EmbedItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "EmbedItem", "description": "Create an embedded item.", "parameters": [] }, { "name": "getByName", "returns": "EmbedItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "ExportForScreensItemToExport", "kind": "Object", "description": "An item that needs to be exported; for example, a document, artboard, or asset.", "properties": [ { "name": "artboards", "type": "string", "description": "Range of artboards to export [possible values: '', 'all'(default), range]", "access": "read/write", "static": true, "value": "all" }, { "name": "assets", "type": "number[]", "description": "Array of asset id to export (default:empty)", "access": "read/write", "static": true }, { "name": "document", "type": "boolean", "description": "Whether to export the document or not.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "ExportForScreensOptionsJPEG", "kind": "Object", "description": "Options which may be provided when exporting a document as a JPEG100 file.", "properties": [ { "name": "antiAliasing", "type": "AntiAliasingMethod", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "AntiAliasingMethod.ARTOPTIMIZED" }, { "name": "compressionMethod", "type": "JPEGCompressionMethodType", "description": "Should the image be compressed.", "access": "read/write", "static": true, "value": "JPEGCompressionMethodType.BASELINESTANDARD" }, { "name": "embedICCProfile", "type": "boolean", "description": "Embed an ICC profile when exporting.", "access": "read/write", "static": true, "value": "false" }, { "name": "progressiveScan", "type": "number", "description": "Specify the number of detailed scans when downloading a JPEG file using the Progressive option as the CompressionMethod.", "access": "read/write", "static": true, "value": "3", "range": { "min": "3", "max": "5" } }, { "name": "scaleType", "type": "ExportForScreensScaleType", "description": "How should the resulting image be scaled.", "access": "read/write", "static": true, "value": "ExportForScreensScaleType.SCALEBYFACTOR" }, { "name": "scaleTypeValue", "type": "number", "description": "The value by which the resulting image should be scaled.", "access": "read/write", "static": true, "value": "1" } ], "events": [], "methods": [] }, { "name": "ExportForScreensOptionsPNG24", "kind": "Object", "description": "Options which may be provided when exporting a document as an 24 bit PNG file.", "properties": [ { "name": "antiAliasing", "type": "AntiAliasingMethod", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "AntiAliasingMethod.ARTOPTIMIZED" }, { "name": "backgroundBlack", "type": "boolean", "description": "Should the resulting image rasterize against a black background (with value true) or white background(with value false) if it doesn't use transparency.", "access": "read/write", "static": true, "value": "false" }, { "name": "interlaced", "type": "boolean", "description": "Should the resulting image be interlaced.", "access": "read/write", "static": true, "value": "false" }, { "name": "scaleType", "type": "ExportForScreensScaleType", "description": "How should the resulting image be scaled.", "access": "read/write", "static": true, "value": "ExportForScreensScaleType.SCALEBYFACTOR" }, { "name": "scaleTypeValue", "type": "number", "description": "The value by which the resulting image should be scaled.", "access": "read/write", "static": true, "value": "1" }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "ExportForScreensOptionsPNG8", "kind": "Object", "description": "Options which may be provided when exporting a document as an 8 bit PNG file.", "properties": [ { "name": "antiAliasing", "type": "AntiAliasingMethod", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "AntiAliasingMethod.ARTOPTIMIZED" }, { "name": "colorCount", "type": "number", "description": "Number of colors in exported color table.", "access": "read/write", "static": true, "value": "128", "range": { "min": "2", "max": "256" } }, { "name": "interlaced", "type": "boolean", "description": "Should the resulting image be interlaced.", "access": "read/write", "static": true, "value": "false" }, { "name": "matte", "type": "boolean", "description": "Should the artboard be matted with a color.", "access": "read/write", "static": true, "value": "true" }, { "name": "matteColor", "type": "RGBColor", "description": "The color to use when matting the artboard (default: white)", "access": "read/write", "static": true }, { "name": "scaleType", "type": "ExportForScreensScaleType", "description": "How should the resulting image be scaled.", "access": "read/write", "static": true, "value": "ExportForScreensScaleType.SCALEBYFACTOR" }, { "name": "scaleTypeValue", "type": "number", "description": "The value by which the resulting image should be scaled.", "access": "read/write", "static": true, "value": "1" }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "ExportForScreensOptionsWebOptimizedSVG", "kind": "Object", "description": "Options which may be provided when exporting a document as a web optimized SVG file.", "properties": [ { "name": "coordinatePrecision", "type": "number", "description": "Decimal precision for element coordinate values.", "access": "read/write", "static": true, "value": "3", "range": { "min": "1", "max": "7" } }, { "name": "cssProperties", "type": "SVGCSSPropertyLocation", "description": "How should the CSS properties of the document be included in the document.", "access": "read/write", "static": true, "value": "SVGCSSPropertyLocation.STYLEATTRIBUTES" }, { "name": "fontType", "type": "SVGFontType", "description": "The type of font that should be included in the exported file.", "access": "read/write", "static": true, "value": "SVGFontType.SVGFONT" }, { "name": "rasterImageLocation", "type": "RasterImageLocation", "description": "Should the raster images in the exported file be included.", "access": "read/write", "static": true, "value": "RasterImageLocation.PRESERVE" }, { "name": "svgId", "type": "SVGIdType", "description": "How object names (IDs) are generated in exported SVG.", "access": "read/write", "static": true, "value": "SVGIdType.SVGIDREGULAR" }, { "name": "svgMinify", "type": "boolean", "description": "Reduces the size of the svg.", "access": "read/write", "static": true, "value": "false" }, { "name": "svgResponsive", "type": "boolean", "description": "Makes the SVG Responsive.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "ExportForScreensPDFOptions", "kind": "Object", "description": "Options which may be provided when exporting a document as a PDF file.", "properties": [ { "name": "pdfPreset", "type": "string", "description": "The max string length is 255 bytes. Name of PDF preset to use.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "ExportForScreensScaleType", "kind": "Enumeration", "description": "Export for screens scale type.", "properties": [ { "name": "SCALEBYFACTOR", "type": "number", "description": "Scale artwork by factors like 1x, 2x, 3x and so on, where 1x means 72 ppi.", "access": "readonly", "value": "0" }, { "name": "SCALEBYHEIGHT", "type": "number", "description": "Scale artwork by specifying artwork height in pixels like 100px, 124px etc. Width of the artwork is adjusted automatically to maintain the aspect ratio.", "access": "readonly", "value": "2" }, { "name": "SCALEBYRESOLUTION", "type": "number", "description": "Scale artwork by specifying resolution in ppi like 72 ppi, 100 ppi, 144 ppi etc.", "access": "readonly", "value": "3" }, { "name": "SCALEBYWIDTH", "type": "number", "description": "Scale artwork by specifying artwork width in pixels like 100px, 124px etc. Height of the artwork is adjusted automatically to maintain the aspect ratio.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ExportForScreensType", "kind": "Enumeration", "description": "Export for screens type.", "properties": [ { "name": "SE_JPEG100", "type": "number", "description": "Export file in JPEG (100% quality) format.", "access": "readonly", "value": "1" }, { "name": "SE_JPEG20", "type": "number", "description": "Export file in JPEG (20% quality) format.", "access": "readonly", "value": "4" }, { "name": "SE_JPEG50", "type": "number", "description": "Export file in JPEG (50% quality) format.", "access": "readonly", "value": "3" }, { "name": "SE_JPEG80", "type": "number", "description": "Export file in JPEG (80% quality) format.", "access": "readonly", "value": "2" }, { "name": "SE_PDF", "type": "number", "description": "Export file in Acrobat PDF format.", "access": "readonly", "value": "8" }, { "name": "SE_PNG24", "type": "number", "description": "Export file in PNG 24-bit format.", "access": "readonly", "value": "7" }, { "name": "SE_PNG8", "type": "number", "description": "Export file in PNG 8-bit format.", "access": "readonly", "value": "6" }, { "name": "SE_SVG", "type": "number", "description": "Export file in SVG format.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "ExportOptionsAutoCAD", "kind": "Object", "description": "Options which may be supplied when exporting a document to AutoCAD formats (.dwg or .dxf)", "properties": [ { "name": "alterPathsForAppearance", "type": "boolean", "description": "Alter paths for appearance.", "access": "read/write", "static": true, "value": "false" }, { "name": "colors", "type": "AutoCADColors", "description": "Number of colors to export into the AutoCAD file.", "access": "read/write", "static": true, "value": "AutoCADColors.TrueColors" }, { "name": "convertTextToOutlines", "type": "boolean", "description": "Whether to convert text to outlines.", "access": "read/write", "static": true, "value": "false" }, { "name": "exportFileFormat", "type": "AutoCADExportFileFormat", "description": "Which format to export the file as.", "access": "read/write", "static": true, "value": "AutoCADExportFileFormat.DWG" }, { "name": "exportOption", "type": "AutoCADExportOption", "description": "Whether to preserve appearance or editability during export.", "access": "read/write", "static": true, "value": "AutoCADExportOption.MaximumEditability" }, { "name": "exportSelectedArtOnly", "type": "boolean", "description": "Export selected art only.", "access": "read/write", "static": true, "value": "false" }, { "name": "rasterFormat", "type": "AutoCADRasterFormat", "description": "Raster format in which to export raster art.", "access": "read/write", "static": true, "value": "AutoCADRasterFormat.PNG" }, { "name": "scaleLineweights", "type": "boolean", "description": "Whether to scale lineweights by the same amount as rest of the drawing.", "access": "read/write", "static": true, "value": "false" }, { "name": "unit", "type": "AutoCADUnit", "description": "Units from which to map.", "access": "read/write", "static": true, "value": "AutoCADUnit.Millimeters" }, { "name": "unitScaleRatio", "type": "number", "description": "Ratio by which to scale the output.", "access": "read/write", "static": true, "value": "1.0" }, { "name": "version", "type": "AutoCADCompatibility", "description": "Release of AutoCAD to export to.", "access": "read/write", "static": true, "value": "AutoCADCompatibility.AutoCADRelease24" } ], "events": [], "methods": [] }, { "name": "ExportOptionsGIF", "kind": "Object", "description": "Options which may be supplied when exporting a document as a GIF file.", "properties": [ { "name": "antiAliasing", "type": "boolean", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "true" }, { "name": "artBoardClipping", "type": "boolean", "description": "Should the resulting image be clipped to the artboard.", "access": "read/write", "static": true, "value": "false" }, { "name": "colorCount", "type": "number", "description": "Number of colors in exported color table.", "access": "read/write", "static": true, "value": "128", "range": { "min": "2", "max": "256" } }, { "name": "colorDither", "type": "ColorDitherMethod", "description": "Method used to dither colors.", "access": "read/write", "static": true, "value": "ColorDitherMethod.DIFFUSION" }, { "name": "colorReduction", "type": "ColorReductionMethod", "description": "Method used to reduce the number of colors.", "access": "read/write", "static": true, "value": "ColorReductionMethod.SELECTIVE" }, { "name": "ditherPercent", "type": "number", "description": "How much should the colors be dithered.", "access": "read/write", "static": true, "value": "88", "range": { "min": "0", "max": "100" } }, { "name": "horizontalScale", "type": "number", "description": "Horizontal scaling factor.", "access": "read/write", "static": true, "value": "100" }, { "name": "infoLossPercent", "type": "number", "description": "Level of information loss during compression.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "100" } }, { "name": "interlaced", "type": "boolean", "description": "Should the resulting image be interlaced.", "access": "read/write", "static": true, "value": "false" }, { "name": "matte", "type": "boolean", "description": "Should the artboard be matted with a color.", "access": "read/write", "static": true, "value": "true" }, { "name": "matteColor", "type": "RGBColor", "description": "The color to use when matting the artboard (default: white)", "access": "read/write", "static": true }, { "name": "saveAsHTML", "type": "boolean", "description": "Should the resulting image be saved as HTML.", "access": "read/write", "static": true, "value": "false" }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "true" }, { "name": "verticalScale", "type": "number", "description": "Vertical scaling factor.", "access": "read/write", "static": true, "value": "100" }, { "name": "webSnap", "type": "number", "description": "How much should the color table be changed to match the web pallet.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "100" } } ], "events": [], "methods": [] }, { "name": "ExportOptionsJPEG", "kind": "Object", "description": "Options which may be supplied when exporting a document as a JPEG file.", "properties": [ { "name": "antiAliasing", "type": "boolean", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "true" }, { "name": "artBoardClipping", "type": "boolean", "description": "Should the resulting image be clipped to the artboard.", "access": "read/write", "static": true, "value": "false" }, { "name": "blurAmount", "type": "number", "description": "Blur the resulting image this much.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0.0", "max": "2.0" } }, { "name": "horizontalScale", "type": "number", "description": "Horizontal scaling factor.", "access": "read/write", "static": true, "value": "100", "range": { "min": "0.0", "max": "776.19" } }, { "name": "matte", "type": "boolean", "description": "Should the artboard be matted with a color.", "access": "read/write", "static": true, "value": "true" }, { "name": "matteColor", "type": "RGBColor", "description": "The color to use when matting the artboard (default: white)", "access": "read/write", "static": true }, { "name": "optimization", "type": "boolean", "description": "Should the image be optimized for web viewing.", "access": "read/write", "static": true, "value": "true" }, { "name": "qualitySetting", "type": "number", "description": "Quality of resulting image.", "access": "read/write", "static": true, "value": "30", "range": { "min": "0.0", "max": "100.0" } }, { "name": "saveAsHTML", "type": "boolean", "description": "Should the resulting image be saved as HTML.", "access": "read/write", "static": true, "value": "false" }, { "name": "verticalScale", "type": "number", "description": "Vertical scaling factor.", "access": "read/write", "static": true, "value": "100", "range": { "min": "0.0", "max": "776.19" } } ], "events": [], "methods": [] }, { "name": "ExportOptionsPNG24", "kind": "Object", "description": "Options which may be supplied when exporting a document as an 24 bit PNG file.", "properties": [ { "name": "antiAliasing", "type": "boolean", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "true" }, { "name": "artBoardClipping", "type": "boolean", "description": "Should the resulting image be clipped to the artboard.", "access": "read/write", "static": true, "value": "false" }, { "name": "dimensions", "type": "Dimensions", "description": "Dimensions in which to contain the resulting raster.", "access": "read/write", "static": true }, { "name": "horizontalScale", "type": "number", "description": "Horizontal scaling factor.", "access": "read/write", "static": true, "value": "100" }, { "name": "matte", "type": "boolean", "description": "Should the artboard be matted with a color.", "access": "read/write", "static": true, "value": "true" }, { "name": "matteColor", "type": "RGBColor", "description": "The color to use when matting the artboard (default: white)", "access": "read/write", "static": true }, { "name": "saveAsHTML", "type": "boolean", "description": "Should the resulting image be saved as HTML.", "access": "read/write", "static": true, "value": "false" }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "true" }, { "name": "verticalScale", "type": "number", "description": "Vertical scaling factor.", "access": "read/write", "static": true, "value": "100" } ], "events": [], "methods": [] }, { "name": "ExportOptionsPNG8", "kind": "Object", "description": "Options which may be supplied when exporting a document as an 8 bit PNG file.", "properties": [ { "name": "antiAliasing", "type": "boolean", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "true" }, { "name": "artBoardClipping", "type": "boolean", "description": "Should the resulting image be clipped to the artboard.", "access": "read/write", "static": true, "value": "false" }, { "name": "colorCount", "type": "number", "description": "Number of colors in exported color table.", "access": "read/write", "static": true, "value": "128", "range": { "min": "2", "max": "256" } }, { "name": "colorDither", "type": "ColorDitherMethod", "description": "Method used to dither colors.", "access": "read/write", "static": true, "value": "ColorDitherMethod.DIFFUSION" }, { "name": "colorReduction", "type": "ColorReductionMethod", "description": "Method used to reduce the number of colors.", "access": "read/write", "static": true, "value": "ColorReductionMethod.SELECTIVE" }, { "name": "ditherPercent", "type": "number", "description": "How much should the colors be dithered.", "access": "read/write", "static": true, "value": "88", "range": { "min": "0", "max": "100" } }, { "name": "horizontalScale", "type": "number", "description": "Horizontal scaling factor.", "access": "read/write", "static": true, "value": "100" }, { "name": "interlaced", "type": "boolean", "description": "Should the resulting image be interlaced.", "access": "read/write", "static": true, "value": "false" }, { "name": "matte", "type": "boolean", "description": "Should the artboard be matted with a color.", "access": "read/write", "static": true, "value": "true" }, { "name": "matteColor", "type": "RGBColor", "description": "The color to use when matting the artboard (default: white)", "access": "read/write", "static": true }, { "name": "saveAsHTML", "type": "boolean", "description": "Should the resulting image be saved as HTML.", "access": "read/write", "static": true, "value": "false" }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "true" }, { "name": "verticalScale", "type": "number", "description": "Vertical scaling factor.", "access": "read/write", "static": true, "value": "100" }, { "name": "webSnap", "type": "number", "description": "How much should the color table be changed to match the web palette.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "100" } } ], "events": [], "methods": [] }, { "name": "ExportOptionsPhotoshop", "kind": "Object", "description": "Options which may be supplied when exporting a document as a Photoshop file.", "properties": [ { "name": "antiAliasing", "type": "boolean", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "true" }, { "name": "artboardRange", "type": "string", "description": "If SaveMultipleArtboards is true,this will be considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "editableText", "type": "boolean", "description": "Export text objects as editable text layers.", "access": "read/write", "static": true, "value": "true" }, { "name": "embedICCProfile", "type": "boolean", "description": "Embed an ICC profile when exporting.", "access": "read/write", "static": true, "value": "false" }, { "name": "imageColorSpace", "type": "ImageColorSpace", "description": "The color space of the exported file.", "access": "read/write", "static": true, "value": "ImageColorSpace.RGB" }, { "name": "maximumEditability", "type": "boolean", "description": "Preserve as much of the original document's structure as possible when exporting.", "access": "read/write", "static": true, "value": "true" }, { "name": "resolution", "type": "number", "description": "The resolution of the exported file.", "access": "read/write", "static": true, "value": "150", "range": { "min": "72.0", "max": "2400.0" } }, { "name": "saveMultipleArtboards", "type": "boolean", "description": "All the artboards or range of the artboards will be exported.", "access": "read/write", "static": true, "value": "false" }, { "name": "warnings", "type": "boolean", "description": "Should a warning dialog be displayed because of conflicts in the export settings.", "access": "read/write", "static": true, "value": "true" }, { "name": "writeLayers", "type": "boolean", "description": "Preserve document layers when exporting.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "ExportOptionsSVG", "kind": "Object", "description": "Options which may be supplied when exporting a document as an SVG file.", "properties": [ { "name": "DTD", "type": "SVGDTDVersion", "description": "The version of DTD that the exported file should be conforming to.", "access": "read/write", "static": true, "value": "SVGDTDVersion.SVG1_1" }, { "name": "artboardRange", "type": "string", "description": "If SaveMultipleArtboards is true,this will be considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "compressed", "type": "boolean", "description": "Should the exported file be compressed.", "access": "read/write", "static": true, "value": "false" }, { "name": "coordinatePrecision", "type": "number", "description": "Decimal precision for element coordinate values.", "access": "read/write", "static": true, "value": "3", "range": { "min": "1", "max": "7" } }, { "name": "cssProperties", "type": "SVGCSSPropertyLocation", "description": "How should the CSS properties of the document be included in the document.", "access": "read/write", "static": true, "value": "SVGCSSPropertyLocation.STYLEATTRIBUTES" }, { "name": "documentEncoding", "type": "SVGDocumentEncoding", "description": "How should the text in the document be encoded.", "access": "read/write", "static": true, "value": "SVGDocumentEncoding.ASCII" }, { "name": "embedRasterImages", "type": "boolean", "description": "Should the raster images in the exported file be included.", "access": "read/write", "static": true, "value": "false" }, { "name": "fontSubsetting", "type": "SVGFontSubsetting", "description": "What font glyphs should be included in the exported file.", "access": "read/write", "static": true, "value": "SVGFontSubsetting.ALLGLYPHS" }, { "name": "fontType", "type": "SVGFontType", "description": "The type of font that should be included in the exported file.", "access": "read/write", "static": true, "value": "SVGFontType.SVGFONT" }, { "name": "includeFileInfo", "type": "boolean", "description": "", "access": "read/write", "static": true, "value": "false" }, { "name": "includeUnusedStyles", "type": "boolean", "description": "", "access": "read/write", "static": true, "value": "false" }, { "name": "includeVariablesAndDatasets", "type": "boolean", "description": "", "access": "read/write", "static": true, "value": "false" }, { "name": "optimizeForSVGViewer", "type": "boolean", "description": "", "access": "read/write", "static": true, "value": "false" }, { "name": "preserveEditability", "type": "boolean", "description": "Preserve Illustrator editing capabilities when exporting the document.", "access": "read/write", "static": true, "value": "false" }, { "name": "sVGAutoKerning", "type": "boolean", "description": "Is SVG auto kerning allowed?", "access": "read/write", "static": true, "value": "false" }, { "name": "sVGTextOnPath", "type": "boolean", "description": "Is SVG text-on-path construct allowed?", "access": "read/write", "static": true, "value": "false" }, { "name": "saveMultipleArtboards", "type": "boolean", "description": "All the artboards or range of the artboards will be saved.", "access": "read/write", "static": true, "value": "false" }, { "name": "slices", "type": "boolean", "description": "Preserve slice data in exported document.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "ExportOptionsTIFF", "kind": "Object", "description": "Options which may be supplied when exporting a document as a TIFF file.", "properties": [ { "name": "antiAliasing", "type": "AntiAliasingMethod", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "AntiAliasingMethod.ARTOPTIMIZED" }, { "name": "artboardRange", "type": "string", "description": "If SaveMultipleArtboards is true,this will be considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "byteOrder", "type": "TIFFByteOrder", "description": "Mac or PC byte order when exporting.", "access": "read/write", "static": true, "value": "TIFFByteOrder.IBMPC" }, { "name": "embedICCProfile", "type": "boolean", "description": "Embed an ICC profile when exporting.", "access": "read/write", "static": true, "value": "false" }, { "name": "imageColorSpace", "type": "ImageColorSpace", "description": "The color space of the exported file.", "access": "read/write", "static": true, "value": "ImageColorSpace.RGB" }, { "name": "lZWCompression", "type": "boolean", "description": "Compress TIFF file with LZW Compression when exporting.", "access": "read/write", "static": true, "value": "false" }, { "name": "resolution", "type": "number", "description": "The resolution of the exported file.", "access": "read/write", "static": true, "value": "150", "range": { "min": "72.0", "max": "2400.0" } }, { "name": "saveMultipleArtboards", "type": "boolean", "description": "All the artboards or range of the artboards will be exported.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "ExportOptionsWebOptimizedSVG", "kind": "Object", "description": "Options which may be supplied when exporting a document as a Web optimized SVG file.", "properties": [ { "name": "artboardRange", "type": "string", "description": "If SaveMultipleArtboards is true,this will be considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "coordinatePrecision", "type": "number", "description": "Decimal precision for element coordinate values.", "access": "read/write", "static": true, "value": "3", "range": { "min": "1", "max": "7" } }, { "name": "cssProperties", "type": "SVGCSSPropertyLocation", "description": "How should the CSS properties of the document be included in the document.", "access": "read/write", "static": true, "value": "SVGCSSPropertyLocation.STYLEATTRIBUTES" }, { "name": "fontType", "type": "SVGFontType", "description": "The type of font that should be included in the exported file.", "access": "read/write", "static": true, "value": "SVGFontType.SVGFONT" }, { "name": "rasterImageLocation", "type": "RasterImageLocation", "description": "Should the raster images in the exported file be included.", "access": "read/write", "static": true, "value": "RasterImageLocation.PRESERVE" }, { "name": "saveMultipleArtboards", "type": "boolean", "description": "All the artboards or range of the artboards will be saved.", "access": "read/write", "static": true, "value": "false" }, { "name": "svgId", "type": "SVGIdType", "description": "How object names (IDs) are generated in exported SVG.", "access": "read/write", "static": true, "value": "SVGIdType.SVGIDREGULAR" }, { "name": "svgMinify", "type": "boolean", "description": "Reduces the size of the svg.", "access": "read/write", "static": true, "value": "false" }, { "name": "svgResponsive", "type": "boolean", "description": "Makes the SVG Responsive.", "access": "read/write", "static": true, "value": "true" } ], "events": [], "methods": [] }, { "name": "ExportType", "kind": "Enumeration", "description": "Export file types.", "properties": [ { "name": "AUTOCAD", "type": "number", "description": "AutoCAD export file format.", "access": "readonly", "value": "8" }, { "name": "GIF", "type": "number", "description": "GIF export file format.", "access": "readonly", "value": "6" }, { "name": "JPEG", "type": "number", "description": "JPEG export file format.", "access": "readonly", "value": "1" }, { "name": "PHOTOSHOP", "type": "number", "description": "Photoshop export file format.", "access": "readonly", "value": "2" }, { "name": "PNG24", "type": "number", "description": "PNG 24-bit export file format.", "access": "readonly", "value": "5" }, { "name": "PNG8", "type": "number", "description": "PNG 8-bit export file format.", "access": "readonly", "value": "4" }, { "name": "SVG", "type": "number", "description": "SVG export file format.", "access": "readonly", "value": "3" }, { "name": "TIFF", "type": "number", "description": "TIFF export file format.", "access": "readonly", "value": "9" }, { "name": "WOSVG", "type": "number", "description": "Web Optimized SVG export file format.", "access": "readonly", "value": "10" } ], "events": [], "methods": [] }, { "name": "FXGSaveOptions", "kind": "Object", "description": "Options which may be supplied when saving a document as an FXG file.", "properties": [ { "name": "artboardRange", "type": "string", "description": "If SaveMultipleArtboards is true,this will be considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "blendsPolicy", "type": "BlendsExpandPolicy", "description": "The policy used by FXG to expand blends.", "access": "read/write", "static": true, "value": "BlendsExpandPolicy.AUTOMATICALLYCONVERTBLENDS" }, { "name": "downsampleLinkedImages", "type": "boolean", "description": "Choose to downsample the linked images(72ppi)", "access": "read/write", "static": true, "value": "false" }, { "name": "filtersPolicy", "type": "FiltersPreservePolicy", "description": "The policy used by FXG to preserve filters.", "access": "read/write", "static": true, "value": "FiltersPreservePolicy.KEEPFILTERSEDITABLE" }, { "name": "gradientsPolicy", "type": "GradientsPreservePolicy", "description": "The policy used by FXG to preserve gradients.", "access": "read/write", "static": true, "value": "GradientsPreservePolicy.AUTOMATICALLYCONVERTGRADIENTS" }, { "name": "includeMetadata", "type": "boolean", "description": "Choose to include metadata (XMP)", "access": "read/write", "static": true, "value": "false" }, { "name": "includeUnusedSymbols", "type": "boolean", "description": "Choose to include unused symbols.", "access": "read/write", "static": true, "value": "false" }, { "name": "preserveEditingCapabilities", "type": "boolean", "description": "Choose to preserve the editing capabilities of FXG.", "access": "read/write", "static": true, "value": "true" }, { "name": "saveMultipleArtboards", "type": "boolean", "description": "All the artboards or range of the artboards will be saved.", "access": "read/write", "static": true, "value": "false" }, { "name": "textPolicy", "type": "TextPreservePolicy", "description": "The policy used by FXG to preserve text.", "access": "read/write", "static": true, "value": "TextPreservePolicy.AUTOMATICALLYCONVERTTEXT" }, { "name": "version", "type": "FXGVersion", "description": "The version of the FXG file format to create.", "access": "read/write", "static": true, "value": "FXGVersion.VERSION2PT0" } ], "events": [], "methods": [] }, { "name": "FXGVersion", "kind": "Enumeration", "description": "The FXG file format version.", "properties": [ { "name": "VERSION1PT0", "type": "number", "description": "FXG version 1.0.", "access": "readonly", "value": "1" }, { "name": "VERSION2PT0", "type": "number", "description": "FXG version 2.0.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "FigureStyleType", "kind": "Enumeration", "description": "The figure style type.", "properties": [ { "name": "DEFAULTFIGURESTYLE", "type": "number", "description": "Default figure style.", "access": "readonly", "value": "0" }, { "name": "PROPORTIONAL", "type": "number", "description": "Proportional lining style.", "access": "readonly", "value": "3" }, { "name": "PROPORTIONALOLDSTYLE", "type": "number", "description": "Proportional oldstyle.", "access": "readonly", "value": "2" }, { "name": "TABULAR", "type": "number", "description": "Tabular lining style.", "access": "readonly", "value": "1" }, { "name": "TABULAROLDSTYLE", "type": "number", "description": "Tabular oldstyle.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "FiltersPreservePolicy", "kind": "Enumeration", "description": "Filters preserve policy used by FXG file format.", "properties": [ { "name": "EXPANDFILTERS", "type": "number", "description": "Preserve the appearance of filters by expanding it.", "access": "readonly", "value": "1" }, { "name": "KEEPFILTERSEDITABLE", "type": "number", "description": "Preserve the editability of filters.", "access": "readonly", "value": "3" }, { "name": "RASTERIZEFILTERS", "type": "number", "description": "Preserve the appearance of filters by rasterizing it.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "FirstBaselineType", "kind": "Enumeration", "description": "Text Item First baseline types.", "properties": [ { "name": "BASELINEASCENT", "type": "number", "description": "First Baseline Ascent Type.", "access": "readonly", "value": "0" }, { "name": "BASELINECAPHEIGHT", "type": "number", "description": "First baseline Cap Height Type.", "access": "readonly", "value": "1" }, { "name": "BASELINEEMBOXHEIGHT", "type": "number", "description": "First Baseline Em Box Height Type.", "access": "readonly", "value": "4" }, { "name": "BASELINEFIXED", "type": "number", "description": "First Baseline Fixed Type.", "access": "readonly", "value": "5" }, { "name": "BASELINELEADING", "type": "number", "description": "First Baseline Leading Type.", "access": "readonly", "value": "2" }, { "name": "BASELINELEGACY", "type": "number", "description": "First Baseline Legacy Type.", "access": "readonly", "value": "6" }, { "name": "BASELINEXHEIGHT", "type": "number", "description": "First Baseline x Height Type.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "FontBaselineOption", "kind": "Enumeration", "description": "The font baseline option.", "properties": [ { "name": "NORMALBASELINE", "type": "number", "description": "Normal baseline.", "access": "readonly", "value": "0" }, { "name": "SUBSCRIPT", "type": "number", "description": "Fauxed subscript baseline.", "access": "readonly", "value": "2" }, { "name": "SUPERSCRIPT", "type": "number", "description": "Fauxed superscript baseline.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "FontCapsOption", "kind": "Enumeration", "description": "The font capitalization option.", "properties": [ { "name": "ALLCAPS", "type": "number", "description": "All caps.", "access": "readonly", "value": "2" }, { "name": "ALLSMALLCAPS", "type": "number", "description": "All small caps.", "access": "readonly", "value": "3" }, { "name": "NORMALCAPS", "type": "number", "description": "Normal caps.", "access": "readonly", "value": "0" }, { "name": "SMALLCAPS", "type": "number", "description": "Small caps.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "FontOpenTypePositionOption", "kind": "Enumeration", "description": "The OpenType font position option.", "properties": [ { "name": "DENOMINATOR", "type": "number", "description": "OpenType denominator position.", "access": "readonly", "value": "4" }, { "name": "NUMERATOR", "type": "number", "description": "OpenType numerator position.", "access": "readonly", "value": "3" }, { "name": "OPENTYPEDEFAULT", "type": "number", "description": "Default position.", "access": "readonly", "value": "0" }, { "name": "OPENTYPESUBSCRIPT", "type": "number", "description": "OpenType subscript position.", "access": "readonly", "value": "2" }, { "name": "OPENTYPESUPERSCRIPT", "type": "number", "description": "OpenType superscript position.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "FontSubstitutionPolicy", "kind": "Enumeration", "description": "The font substitution policy.", "properties": [ { "name": "SUBSTITUTEDEVICE", "type": "number", "description": "Substitute device font.", "access": "readonly", "value": "2" }, { "name": "SUBSTITUTEOBLIQUE", "type": "number", "description": "Substitute oblique font.", "access": "readonly", "value": "0" }, { "name": "SUBSTITUTETINT", "type": "number", "description": "Substitute tint font.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Gradient", "kind": "Object", "description": "A gradient.", "properties": [ { "name": "gradientStops", "type": "GradientStops", "description": "The stops in this gradient.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The gradient's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "type", "type": "GradientType", "description": "The gradient type.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GradientColor", "kind": "Object", "description": "A Gradient color specification.", "extends": "Color", "properties": [ { "name": "angle", "type": "number", "description": "The gradient vector angle.", "access": "read/write", "static": true, "value": "0" }, { "name": "gradient", "type": "Gradient", "description": "Reference to the object defining the gradient.", "access": "read/write", "static": true }, { "name": "hiliteAngle", "type": "number", "description": "The gradient hilite vector angle.", "access": "read/write", "static": true, "value": "0" }, { "name": "hiliteLength", "type": "number", "description": "The gradient hilite vector length.", "access": "read/write", "static": true, "value": "0" }, { "name": "length", "type": "number", "description": "The gradient vector length.", "access": "read/write", "static": true, "value": "0" }, { "name": "matrix", "type": "Matrix", "description": "Additional transformation arising from manipulating the path.", "access": "read/write", "static": true }, { "name": "origin", "type": "Point", "description": "The gradient vector origin.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "GradientStop", "kind": "Object", "description": "A gradient stop.", "properties": [ { "name": "color", "type": "Color", "description": "The color linked to this gradient stop.", "access": "read/write" }, { "name": "midPoint", "type": "number", "description": "Midpoint key value in percent.", "access": "read/write", "range": { "min": "13", "max": "87" } }, { "name": "opacity", "type": "number", "description": "The opacity (between 0.0 and 100.0) value for the gradient stop.", "access": "read/write", "range": { "min": "0", "max": "100" } }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "rampPoint", "type": "number", "description": "Location of color in the blend (in percent)", "access": "read/write", "range": { "min": "0", "max": "100" } }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GradientStops", "kind": "Collection", "description": "A collection of gradient stops.", "elementType": "GradientStop", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "GradientStop", "description": "Create a gradient stop.", "parameters": [] }, { "name": "getByName", "returns": "GradientStop", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GradientType", "kind": "Enumeration", "description": "The gradient type.", "properties": [ { "name": "LINEAR", "type": "number", "description": "Linear gradient.", "access": "readonly", "value": "1" }, { "name": "RADIAL", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Gradients", "kind": "Collection", "description": "A collection of gradients.", "elementType": "Gradient", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Gradient", "description": "Create a gradient.", "parameters": [] }, { "name": "getByName", "returns": "Gradient", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GradientsPreservePolicy", "kind": "Enumeration", "description": "Gradients preserve policy used by FXG file format.", "properties": [ { "name": "AUTOMATICALLYCONVERTGRADIENTS", "type": "number", "description": "Automatically Convert Gradients.", "access": "readonly", "value": "4" }, { "name": "KEEPGRADIENTSEDITABLE", "type": "number", "description": "Preserve the editability of gradients.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "GraphItem", "kind": "Object", "description": "Graph artwork item.", "extends": "PageItem", "properties": [ { "name": "contentVariable", "type": "any", "description": "The content variable bound to this graph.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "GraphItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "GraphItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GraphItems", "kind": "Collection", "description": "", "elementType": "GraphItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "GraphItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GrayColor", "kind": "Object", "description": "A gray color specification.", "extends": "Color", "properties": [ { "name": "gray", "type": "number", "description": "The gray value (between 0.0 and 100.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "100.0" } } ], "events": [], "methods": [] }, { "name": "GridRepeatConfig", "kind": "Object", "description": "Options for grid repaat art configuration.", "properties": [ { "name": "columnFlipType", "type": "RepeatGridShiftFlipType", "description": "Column flip type of grid repeat art.", "access": "read/write", "static": true, "value": "RepeatGridShiftFlipType.NOSF" }, { "name": "horizontalSpacing", "type": "number", "description": "Spacing between each rows.", "access": "read/write", "static": true, "value": "10" }, { "name": "patternType", "type": "RepeatGridShiftFlipType", "description": "Shift type of grid repeat art.", "access": "read/write", "static": true, "value": "RepeatGridShiftFlipType.NOSF" }, { "name": "rowFlipType", "type": "RepeatGridShiftFlipType", "description": "Row flip type of grid repeat art.", "access": "read/write", "static": true, "value": "RepeatGridShiftFlipType.NOSF" }, { "name": "verticalSpacing", "type": "number", "description": "Spacing between each columns.", "access": "read/write", "static": true, "value": "10" } ], "events": [], "methods": [] }, { "name": "GridRepeatItem", "kind": "Object", "description": "A grid repeat item.", "extends": "PageItem", "properties": [ { "name": "gridConfig", "type": "GridRepeatConfig", "description": "Grid repeat config for repeat art.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "GridRepeatItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "GridRepeatItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "setGridConfiguration", "returns": "void", "description": "Update the grid repeat art.", "parameters": [ { "name": "config", "type": "GridRepeatConfig", "description": "Updated grid repeat configuration." }, { "name": "state", "type": "GridRepeatUpdate", "description": "Specify which properties of grid repeat gets updated." } ] } ] }, { "name": "GridRepeatItems", "kind": "Collection", "description": "A collection of grid repeat items.", "elementType": "GridRepeatItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "GridRepeatItem", "description": "Creates a grid repeat art.", "parameters": [ { "name": "sourceArt", "type": "any", "description": "The page item(s) to apply to." }, { "name": "config", "type": "GridRepeatConfig", "description": "The grid repeat configuration." } ] }, { "name": "getByName", "returns": "GridRepeatItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GridRepeatUpdate", "kind": "Enumeration", "description": "Each flag represent which property of grid repeat gets updated.", "properties": [ { "name": "GRIDALL", "type": "number", "description": "Update all the properties of grid repeat art.", "access": "readonly", "value": "63" }, { "name": "HORIZONTALSPACING", "type": "number", "description": "Update spacing between rows of grid repeat art.", "access": "readonly", "value": "4" }, { "name": "VERTICALSPACING", "type": "number", "description": "Update spacing between columns of grid repeat art.", "access": "readonly", "value": "8" } ], "events": [], "methods": [] }, { "name": "GroupItem", "kind": "Object", "description": "An artwork group item.", "extends": "PageItem", "properties": [ { "name": "clipped", "type": "boolean", "description": "Are the group elements clipped to the clipping path?", "access": "read/write" }, { "name": "compoundPathItems", "type": "CompoundPathItems", "description": "The compound path artwork in this group.", "access": "readonly" }, { "name": "graphItems", "type": "GraphItems", "description": "The graph art items in this group.", "access": "readonly" }, { "name": "gridRepeatItems", "type": "GridRepeatItems", "description": "The grid repeat items in this document.", "access": "readonly" }, { "name": "groupItems", "type": "GroupItems", "description": "The group items in this group.", "access": "readonly" }, { "name": "legacyTextItems", "type": "LegacyTextItems", "description": "The text frame items in this story.", "access": "readonly" }, { "name": "meshItems", "type": "MeshItems", "description": "The mesh art items in this group.", "access": "readonly" }, { "name": "nonNativeItems", "type": "NonNativeItems", "description": "The non-native art items in this group.", "access": "readonly" }, { "name": "pageItems", "type": "PageItems", "description": "All the artwork in this group.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathItems", "type": "PathItems", "description": "The path artwork in this group.", "access": "readonly" }, { "name": "placedItems", "type": "PlacedItems", "description": "The placed art items in this group.", "access": "readonly" }, { "name": "pluginItems", "type": "PluginItems", "description": "The plugin art items in this group.", "access": "readonly" }, { "name": "radialRepeatItems", "type": "RadialRepeatItems", "description": "The radial repeat items in this document.", "access": "readonly" }, { "name": "rasterItems", "type": "RasterItems", "description": "The raster art items in this group.", "access": "readonly" }, { "name": "symbolItems", "type": "SymbolItems", "description": "The symbol items in this group.", "access": "readonly" }, { "name": "symmetryRepeatItems", "type": "SymmetryRepeatItems", "description": "The symmetry repeat items in this document.", "access": "readonly" }, { "name": "textFrames", "type": "TextFrameItems", "description": "The text frame items in this group.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "GroupItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "GroupItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "GroupItems", "kind": "Collection", "description": "A collection of group items.", "elementType": "GroupItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "GroupItem", "description": "Create a group item.", "parameters": [] }, { "name": "createFromFile", "returns": "GroupItem", "description": "Create a group item from a vector graphics file.", "parameters": [ { "name": "imageFile", "type": "File", "description": "The vector graphics file to be embedded." } ] }, { "name": "getByName", "returns": "GroupItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "IllustratorSaveOptions", "kind": "Object", "description": "Options which may be supplied when saving a document as an Illustrator file.", "properties": [ { "name": "artboardRange", "type": "string", "description": "If SaveMultipleArtboards is true ,this will be considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "compatibility", "type": "Compatibility", "description": "What Illustrator file format version to create.", "access": "read/write", "static": true, "value": "Compatibility.ILLUSTRATOR24" }, { "name": "compressed", "type": "boolean", "description": "Should the saved file be compressed (version 10 or later)", "access": "read/write", "static": true, "value": "true" }, { "name": "embedICCProfile", "type": "boolean", "description": "Embed the document's ICC profile in the saved file (version 9 or later)", "access": "read/write", "static": true, "value": "false" }, { "name": "embedLinkedFiles", "type": "boolean", "description": "Are linked image files to be included in the saved document (versions 7 or later)", "access": "read/write", "static": true, "value": "false" }, { "name": "flattenOutput", "type": "OutputFlattening", "description": "How should transparency be flattened for older file format versions (pre-version 9)", "access": "read/write", "static": true, "value": "OutputFlattening.PRESERVEAPPEARANCE" }, { "name": "fontSubsetThreshold", "type": "number", "description": "Include a subset of fonts when less than this percentage of characters are used (version 9 or later)", "access": "read/write", "static": true, "value": "100", "range": { "min": "0", "max": "100" } }, { "name": "pdfCompatible", "type": "boolean", "description": "Save as a PDF compatible file (version 10 or later)", "access": "read/write", "static": true, "value": "true" }, { "name": "saveMultipleArtboards", "type": "boolean", "description": "All the artboards or range of the artboards will be saved.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "ImageCaptureOptions", "kind": "Object", "description": "Options which may be supplied when capturing a portion of the artwork as an 24 bit PNG file.", "properties": [ { "name": "antiAliasing", "type": "boolean", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "false" }, { "name": "matte", "type": "boolean", "description": "Should the artboard be matted with a color.", "access": "read/write", "static": true, "value": "false" }, { "name": "matteColor", "type": "RGBColor", "description": "The color to use when matting the artboard (default: white)", "access": "read/write", "static": true }, { "name": "resolution", "type": "number", "description": "The resolution of the captured image file.", "access": "read/write", "static": true, "value": "150", "range": { "min": "72.0", "max": "2400.0" } }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "ImageColorSpace", "kind": "Enumeration", "description": "The color space.", "properties": [ { "name": "CMYK", "type": "number", "description": "CMYK color space.", "access": "readonly", "value": "3" }, { "name": "DeviceN", "type": "number", "description": "DeviceN color space.", "access": "readonly", "value": "6" }, { "name": "GrayScale", "type": "number", "description": "Gray color space.", "access": "readonly", "value": "1" }, { "name": "Indexed", "type": "number", "description": "Indexed color space.", "access": "readonly", "value": "7" }, { "name": "LAB", "type": "number", "description": "LAB color space.", "access": "readonly", "value": "4" }, { "name": "RGB", "type": "number", "description": "RGB color space.", "access": "readonly", "value": "2" }, { "name": "Separation", "type": "number", "description": "Separation color space.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "Ink", "kind": "Object", "description": "Printer's ink.", "properties": [ { "name": "inkInfo", "type": "InkInfo", "description": "The ink information.", "access": "read/write", "static": true }, { "name": "name", "type": "string", "description": "The ink's name.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "InkInfo", "kind": "Object", "description": "Ink information.", "properties": [ { "name": "angle", "type": "number", "description": "The ink's screen angle (in degrees)", "access": "read/write", "static": true }, { "name": "customColor", "type": "Color", "description": "The color of the custom ink.", "access": "read/write", "static": true }, { "name": "density", "type": "number", "description": "The neutral density.", "access": "read/write", "static": true, "range": { "min": "0", "max": "" } }, { "name": "dotShape", "type": "string", "description": "The dot shape name.", "access": "read/write", "static": true }, { "name": "frequency", "type": "number", "description": "The ink's frequency.", "access": "read/write", "static": true, "range": { "min": "0", "max": "" } }, { "name": "kind", "type": "InkType", "description": "The ink type.", "access": "read/write", "static": true }, { "name": "printingStatus", "type": "InkPrintStatus", "description": "The ink printing status.", "access": "read/write", "static": true }, { "name": "trapping", "type": "TrappingType", "description": "The trapping type.", "access": "read/write", "static": true }, { "name": "trappingOrder", "type": "number", "description": "The order of trapping for the ink.", "access": "read/write", "static": true, "range": { "min": "1", "max": "" } } ], "events": [], "methods": [] }, { "name": "InkPrintStatus", "kind": "Enumeration", "description": "The ink printing status.", "properties": [ { "name": "CONVERTINK", "type": "number", "description": "Convert to process color during print.", "access": "readonly", "value": "2" }, { "name": "DISABLEINK", "type": "number", "description": "Disable the ink during print.", "access": "readonly", "value": "0" }, { "name": "ENABLEINK", "type": "number", "description": "Enable the ink during print.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "InkType", "kind": "Enumeration", "description": "The ink type.", "properties": [ { "name": "BLACKINK", "type": "number", "description": "Black color ink.", "access": "readonly", "value": "3" }, { "name": "CUSTOMINK", "type": "number", "description": "Custom color ink.", "access": "readonly", "value": "4" }, { "name": "CYANINK", "type": "number", "description": "Cyan color ink.", "access": "readonly", "value": "0" }, { "name": "MAGENTAINK", "type": "number", "description": "Magenta color ink.", "access": "readonly", "value": "1" }, { "name": "YELLOWINK", "type": "number", "description": "Yellow color ink.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "InsertionPoint", "kind": "Object", "description": "A location between characters, used to insert new text objects.", "properties": [ { "name": "characters", "type": "Characters", "description": "All the characters in this text range.", "access": "readonly" }, { "name": "lines", "type": "Lines", "description": "All the lines in this text range.", "access": "readonly" }, { "name": "paragraphs", "type": "Paragraphs", "description": "All the paragraphs in this text range.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "story", "type": "Story", "description": "The story of the text range.", "access": "readonly" }, { "name": "textRanges", "type": "TextRanges", "description": "All the text in this text range.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "words", "type": "Words", "description": "All the words in this text range.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "InsertionPoints", "kind": "Collection", "description": "A collection of insertion points.", "elementType": "InsertionPoint", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "InsertionPoint", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "JPEGCompressionMethodType", "kind": "Enumeration", "description": "JPEG Compression Method type.", "properties": [ { "name": "BASELINEOPTIMIZED", "type": "number", "description": "Select Baseline Optimized for optimized color and a slightly smaller file size. Not supported by all web browsers.", "access": "readonly", "value": "1" }, { "name": "BASELINESTANDARD", "type": "number", "description": "Select Baseline (Standard) to use a format recognized by most web browsers.", "access": "readonly", "value": "0" }, { "name": "PROGRESSIVE", "type": "number", "description": "Select Progressive to display a series of increasingly detailed scans (you specify how many in ProgressiveScan) as the image downloads. Not supported by all web browsers.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "JavaScriptExecutionMode", "kind": "Enumeration", "description": "When should a JavaScript debugger be shown.", "properties": [ { "name": "BeforeRunning", "type": "number", "description": "Show the JavaScript debugger at the first line of the JavaScript.", "access": "readonly", "value": "3" }, { "name": "OnRuntimeError", "type": "number", "description": "Show the JavaScript debugger is a runtime error occurs.", "access": "readonly", "value": "2" }, { "name": "never", "type": "number", "description": "Never show the JavaScript debugger. Treat runtime errors by throwing a JavaScript exceptions.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Justification", "kind": "Enumeration", "description": "The paragraph alignment.", "properties": [ { "name": "CENTER", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "FULLJUSTIFY", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "FULLJUSTIFYLASTLINECENTER", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "FULLJUSTIFYLASTLINELEFT", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "FULLJUSTIFYLASTLINERIGHT", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "LEFT", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "RIGHT", "type": "number", "description": "", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "KashidaWidthType", "kind": "Enumeration", "description": "The kashida width type constants.", "properties": [ { "name": "kashidaLong", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "kashidaMedium", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "kashidaNone", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "kashidaSmall", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "kashidaStylistic", "type": "number", "description": "", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "KashidasType", "kind": "Enumeration", "description": "The kashida type constants.", "properties": [ { "name": "DEFAULT_KASHIDAS", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "KASHIDAS_OFF", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "KASHIDAS_ON", "type": "number", "description": "", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "KinsokuOrderEnum", "kind": "Enumeration", "description": "The preferred Kinsoku order.", "properties": [ { "name": "PUSHIN", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "PUSHOUTFIRST", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "PUSHOUTONLY", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "KnockoutState", "kind": "Enumeration", "description": "Knockout state of a page item.", "properties": [ { "name": "DISABLED", "type": "number", "description": "Knockout off.", "access": "readonly", "value": "0" }, { "name": "ENABLED", "type": "number", "description": "Knockout off.", "access": "readonly", "value": "1" }, { "name": "INHERITED", "type": "number", "description": "Knockout state inherited from group?", "access": "readonly", "value": "2" }, { "name": "Unknown", "type": "number", "description": "Unknown/uninitialized knockout state.", "access": "readonly", "value": "-1" } ], "events": [], "methods": [] }, { "name": "LabColor", "kind": "Object", "description": "An Lab color specification.", "extends": "Color", "properties": [ { "name": "a", "type": "number", "description": "The a color value (between -128.0 and 127.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "-128.0", "max": "127.0" } }, { "name": "b", "type": "number", "description": "The b color value (between -128.0 and 127.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "-128.0", "max": "127.0" } }, { "name": "l", "type": "number", "description": "The L color value (between 0.0 and 100.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "100.0" } } ], "events": [], "methods": [] }, { "name": "LanguageType", "kind": "Enumeration", "description": "The language of text.", "properties": [ { "name": "ARABIC", "type": "number", "description": "", "access": "readonly", "value": "39" }, { "name": "BENGALIINDIA", "type": "number", "description": "", "access": "readonly", "value": "51" }, { "name": "BOKMALNORWEGIAN", "type": "number", "description": "", "access": "readonly", "value": "8" }, { "name": "BRAZILLIANPORTUGUESE", "type": "number", "description": "", "access": "readonly", "value": "11" }, { "name": "BULGARIAN", "type": "number", "description": "", "access": "readonly", "value": "20" }, { "name": "CANADIANFRENCH", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "CATALAN", "type": "number", "description": "", "access": "readonly", "value": "17" }, { "name": "CHINESE", "type": "number", "description": "", "access": "readonly", "value": "29" }, { "name": "CZECH", "type": "number", "description": "", "access": "readonly", "value": "22" }, { "name": "DANISH", "type": "number", "description": "", "access": "readonly", "value": "16" }, { "name": "DUTCH", "type": "number", "description": "", "access": "readonly", "value": "15" }, { "name": "DUTCH2005REFORM", "type": "number", "description": "", "access": "readonly", "value": "43" }, { "name": "ENGLISH", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "FARSI", "type": "number", "description": "", "access": "readonly", "value": "41" }, { "name": "FINNISH", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "GERMAN2006REFORM", "type": "number", "description": "", "access": "readonly", "value": "42" }, { "name": "GREEK", "type": "number", "description": "", "access": "readonly", "value": "25" }, { "name": "GUJARATI", "type": "number", "description": "", "access": "readonly", "value": "53" }, { "name": "HINDI", "type": "number", "description": "", "access": "readonly", "value": "49" }, { "name": "HUNGARIAN", "type": "number", "description": "", "access": "readonly", "value": "28" }, { "name": "ICELANDIC", "type": "number", "description": "", "access": "readonly", "value": "27" }, { "name": "ITALIAN", "type": "number", "description": "", "access": "readonly", "value": "7" }, { "name": "JAPANESE", "type": "number", "description": "", "access": "readonly", "value": "30" }, { "name": "KANNADA", "type": "number", "description": "", "access": "readonly", "value": "57" }, { "name": "MALAYALAM", "type": "number", "description": "", "access": "readonly", "value": "58" }, { "name": "MARATHI", "type": "number", "description": "", "access": "readonly", "value": "50" }, { "name": "NYNORSKNORWEGIAN", "type": "number", "description": "Nynorsk Norwegian.", "access": "readonly", "value": "9" }, { "name": "OLDGERMAN", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "ORIYA", "type": "number", "description": "", "access": "readonly", "value": "54" }, { "name": "POLISH", "type": "number", "description": "", "access": "readonly", "value": "23" }, { "name": "PUNJABI", "type": "number", "description": "", "access": "readonly", "value": "52" }, { "name": "RUMANIAN", "type": "number", "description": "", "access": "readonly", "value": "24" }, { "name": "RUSSIAN", "type": "number", "description": "", "access": "readonly", "value": "18" }, { "name": "SERBIAN", "type": "number", "description": "", "access": "readonly", "value": "21" }, { "name": "SPANISH", "type": "number", "description": "", "access": "readonly", "value": "12" }, { "name": "STANDARDFRENCH", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "STANDARDGERMAN", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "STANDARDPORTUGUESE", "type": "number", "description": "", "access": "readonly", "value": "10" }, { "name": "SWEDISH", "type": "number", "description": "", "access": "readonly", "value": "13" }, { "name": "SWISSGERMAN", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "SWISSGERMAN2006REFORM", "type": "number", "description": "", "access": "readonly", "value": "44" }, { "name": "TAMIL", "type": "number", "description": "", "access": "readonly", "value": "55" }, { "name": "TELUGU", "type": "number", "description": "", "access": "readonly", "value": "56" }, { "name": "TURKISH", "type": "number", "description": "", "access": "readonly", "value": "26" }, { "name": "UKENGLISH", "type": "number", "description": "", "access": "readonly", "value": "14" }, { "name": "UKRANIAN", "type": "number", "description": "", "access": "readonly", "value": "19" } ], "events": [], "methods": [] }, { "name": "Layer", "kind": "Object", "description": "A layer.", "properties": [ { "name": "absoluteZOrderPosition", "type": "number", "description": "The absolute drawing order of the layer.", "access": "readonly" }, { "name": "artworkKnockout", "type": "KnockoutState", "description": "Is the artwork used to create a knockout.", "access": "read/write" }, { "name": "blendingMode", "type": "BlendModes", "description": "The mode used when compositing an object.", "access": "read/write" }, { "name": "color", "type": "RGBColor", "description": "Color used when outlining artwork in this layer.", "access": "read/write" }, { "name": "compoundPathItems", "type": "CompoundPathItems", "description": "The compound path artwork in this layer.", "access": "readonly" }, { "name": "dimPlacedImages", "type": "boolean", "description": "Is rendered as dimmed in this layer?", "access": "read/write" }, { "name": "graphItems", "type": "GraphItems", "description": "The graph art items in this layer.", "access": "readonly" }, { "name": "gridRepeatItems", "type": "GridRepeatItems", "description": "The grid repeat items in this layer.", "access": "readonly" }, { "name": "groupItems", "type": "GroupItems", "description": "The group items in this layer.", "access": "readonly" }, { "name": "hasSelectedArtwork", "type": "boolean", "description": "Is any artwork in this layer selected? Setting this property to false deselects all artwork in the layer.", "access": "read/write" }, { "name": "isIsolated", "type": "boolean", "description": "Is the artwork isolated.", "access": "read/write" }, { "name": "layers", "type": "Layers", "description": "Nested layers.", "access": "readonly" }, { "name": "legacyTextItems", "type": "LegacyTextItems", "description": "The text frame items in this story.", "access": "readonly" }, { "name": "locked", "type": "boolean", "description": "Is the layer editable?", "access": "read/write" }, { "name": "meshItems", "type": "MeshItems", "description": "The mesh art items in this layer.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The layer's name.", "access": "read/write" }, { "name": "nonNativeItems", "type": "NonNativeItems", "description": "The non-native art items in this layer.", "access": "readonly" }, { "name": "opacity", "type": "number", "description": "The layer's opacity (between 0.0 and 100.0)", "access": "read/write" }, { "name": "pageItems", "type": "PageItems", "description": "All the artwork in this layer.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathItems", "type": "PathItems", "description": "The path artwork in this layer.", "access": "readonly" }, { "name": "placedItems", "type": "PlacedItems", "description": "The placed art items in this layer.", "access": "readonly" }, { "name": "pluginItems", "type": "PluginItems", "description": "The plugin art items in this layer.", "access": "readonly" }, { "name": "preview", "type": "boolean", "description": "Is the layer rendered in preview mode?", "access": "read/write" }, { "name": "printable", "type": "boolean", "description": "Is the layer printable?", "access": "read/write" }, { "name": "radialRepeatItems", "type": "RadialRepeatItems", "description": "The radial repeat items in this layer.", "access": "readonly" }, { "name": "rasterItems", "type": "RasterItems", "description": "The raster art items in this layer.", "access": "readonly" }, { "name": "sliced", "type": "boolean", "description": "Is the layer sliced (default: false)", "access": "read/write" }, { "name": "symbolItems", "type": "SymbolItems", "description": "The symbol items in this layer.", "access": "readonly" }, { "name": "symmetryRepeatItems", "type": "SymmetryRepeatItems", "description": "The symmetry repeat items in this layer.", "access": "readonly" }, { "name": "textFrames", "type": "TextFrameItems", "description": "The text frame items in this layer.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "visible", "type": "boolean", "description": "Is the layer visible?", "access": "read/write" }, { "name": "zOrderPosition", "type": "number", "description": "The drawing order of the layer.", "access": "readonly" } ], "events": [], "methods": [ { "name": "move", "returns": "Layer", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "zOrder", "returns": "void", "description": "Arranges the layer relative to other layers.", "parameters": [ { "name": "zOrderCmd", "type": "ZOrderMethod", "description": "How to arrange the layer." } ] } ] }, { "name": "Layers", "kind": "Collection", "description": "A collection of layers.", "elementType": "Layer", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Layer", "description": "Create a layer.", "parameters": [] }, { "name": "getByName", "returns": "Layer", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "LegacyTextItem", "kind": "Object", "description": "Unconverted legacy text items from documents in pre-version 11 formats.", "extends": "PageItem", "properties": [ { "name": "converted", "type": "boolean", "description": "Has the legacy text item been updated to a native text frame item?", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "convertToNative", "returns": "GroupItem", "description": "Create a native text frame from a legacy text item. The original legacy text item is deleted.", "parameters": [] }, { "name": "move", "returns": "LegacyTextItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "LegacyTextItems", "kind": "Collection", "description": "A collection of legacy text items.", "elementType": "LegacyTextItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "convertToNative", "returns": "boolean", "description": "Create text frames from all legacy text items. The original legacy text items will be deleted.", "parameters": [] }, { "name": "getByName", "returns": "LegacyTextItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "LibraryType", "kind": "Enumeration", "description": "Illustrator library types.", "properties": [ { "name": "BRUSHES", "type": "number", "description": "Illustrator brushes library.", "access": "readonly", "value": "3" }, { "name": "GRAPHICSTYLES", "type": "number", "description": "Illustrator graphic styles library.", "access": "readonly", "value": "4" }, { "name": "ILLUSTRATORARTWORK", "type": "number", "description": "Illustrator artwork.", "access": "readonly", "value": "1" }, { "name": "SWATCHES", "type": "number", "description": "Illustrator swatches library.", "access": "readonly", "value": "2" }, { "name": "SYMBOLS", "type": "number", "description": "Illustrator symbols library.", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "Lines", "kind": "Collection", "description": "A collection of lines.", "elementType": "TextRange", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "TextRange", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "Matrix", "kind": "Object", "description": "", "properties": [ { "name": "mValueA", "type": "number", "description": "", "access": "read/write", "static": true }, { "name": "mValueB", "type": "number", "description": "", "access": "read/write", "static": true }, { "name": "mValueC", "type": "number", "description": "", "access": "read/write", "static": true }, { "name": "mValueD", "type": "number", "description": "", "access": "read/write", "static": true }, { "name": "mValueTX", "type": "number", "description": "", "access": "read/write", "static": true }, { "name": "mValueTY", "type": "number", "description": "", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "MeshItem", "kind": "Object", "description": "Mesh artwork item.", "extends": "PageItem", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "MeshItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "MeshItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "MeshItems", "kind": "Collection", "description": "", "elementType": "MeshItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "MeshItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "MonochromeCompression", "kind": "Enumeration", "description": "The monochrome compression type.", "properties": [ { "name": "CCIT3", "type": "number", "description": "CCITT Group 3 compression.", "access": "readonly", "value": "1" }, { "name": "CCIT4", "type": "number", "description": "CCITT Group 4 compression.", "access": "readonly", "value": "2" }, { "name": "MONOZIP", "type": "number", "description": "ZIP compression.", "access": "readonly", "value": "3" }, { "name": "None", "type": "number", "description": "Automatic compression.", "access": "readonly", "value": "0" }, { "name": "RUNLENGTH", "type": "number", "description": "RLE compression.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "NoColor", "kind": "Object", "description": "Represents the 'none' color.", "extends": "Color", "properties": [], "events": [], "methods": [] }, { "name": "NonNativeItem", "kind": "Object", "description": "Non-native artwork item.", "extends": "PageItem", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "NonNativeItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "NonNativeItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "NonNativeItems", "kind": "Collection", "description": "", "elementType": "NonNativeItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "NonNativeItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "OpenOptions", "kind": "Object", "description": "Options which may be supplied when opening a file.", "properties": [ { "name": "addToRecentFiles", "type": "boolean", "description": "Add this file to the list of recently opened files.", "access": "read/write", "static": true, "value": "true" }, { "name": "convertCropAreaToArtboard", "type": "boolean", "description": "Convert crop area to Artboard when opening legacy document (pre-Illustrator CS4) in CS4 or later. If false then crop areas are discarded.", "access": "read/write", "static": true, "value": "true" }, { "name": "convertTilesToArtboard", "type": "boolean", "description": "Convert print tiles to Artboard when opening legacy document (pre-Illustrator CS4) in CS4 or later.", "access": "read/write", "static": true, "value": "false" }, { "name": "createArtboardWithArtworkBoundingBox", "type": "boolean", "description": "Create Artboard with dimentions of artwork bounding box when opening legacy document (pre-Illustrator CS4) in CS4 or later.", "access": "read/write", "static": true, "value": "false" }, { "name": "openAs", "type": "LibraryType", "description": "Open the file as library.", "access": "read/write", "static": true, "value": "LibraryType.ILLUSTRATORARTWORK" }, { "name": "preserveLegacyArtboard", "type": "boolean", "description": "Preserve Legacy Artboard (pre-Illustrator CS4) when opening in CS4 or later.", "access": "read/write", "static": true, "value": "true" }, { "name": "updateLegacyGradientMesh", "type": "boolean", "description": "Choose to preserve the spot colors in the gradient mesh objects for legacy documents (pre-Illustrator CS3)", "access": "read/write", "static": true, "value": "true" }, { "name": "updateLegacyText", "type": "boolean", "description": "Choose to update all text objects for documents saved with legacy texts (pre-Illustrator 11)", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "OpenOptionsAutoCAD", "kind": "Object", "description": "Options which may be supplied when opening a AutoCAD file.", "properties": [ { "name": "centerArtwork", "type": "boolean", "description": "To center the created artwork on the artboard (default: true)", "access": "read/write" }, { "name": "globalScaleOption", "type": "AutoCADGlobalScaleOption", "description": "How to scale the AutoCAD drawing on import (default: Fit Artboard)", "access": "read/write" }, { "name": "globalScalePercent", "type": "number", "description": "Percentage scaling to apply globally on the AutoCAD drawing (default: 1.0)", "access": "read/write" }, { "name": "mergeLayers", "type": "boolean", "description": "To merge the layers of the artwork (default: false)", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "scaleLineweights", "type": "boolean", "description": "To scale lineweights by the same amount as rest of the drawing (default: false)", "access": "read/write" }, { "name": "selectedLayoutName", "type": "string", "description": "Name of layout in the AutoCAD drawing to import.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "unit", "type": "AutoCADUnit", "description": "Units to which to map (default: Millimeters)", "access": "read/write" }, { "name": "unitScaleRatio", "type": "number", "description": "Ratio by which to scale while mapping the units (default: 1.0)", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "OpenOptionsPDF", "kind": "Object", "description": "Options which may be supplied when opening a PDF file.", "properties": [ { "name": "pDFCropToBox", "type": "PDFBoxType", "description": "What box should be used when placing a multipage document (default: PDF media box)", "access": "read/write" }, { "name": "pageRangeToOpen", "type": "string", "description": "Range of pages when opening a multipage document [possible values: 'all', range(for example: '1,2,3-5,8')]", "access": "read/write" }, { "name": "pageToOpen", "type": "number", "description": "What page should be used when opening a multipage document (default: 1)", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "placeAsLinks", "type": "boolean", "description": "Import PDF pages as links for optimal performance (default: true for PageRangeToOpen=all; false otherwise)", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "OpenOptionsPhotoshop", "kind": "Object", "description": "Options which are applied when opening or placing a Photoshop file.", "properties": [ { "name": "layerComp", "type": "string", "description": "Should use the specified LayerComp.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "preserveHiddenLayers", "type": "boolean", "description": "Should hidden layers be preserved when the document is converted (default: false)", "access": "read/write" }, { "name": "preserveImageMaps", "type": "boolean", "description": "Should image maps be preserved when the document is converted (default: true)", "access": "read/write" }, { "name": "preserveLayers", "type": "boolean", "description": "Should layers be Preserve when the document is converted (default: true)", "access": "read/write" }, { "name": "preserveSlices", "type": "boolean", "description": "Should slices be preserved when the document is converted (default: true)", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "OutputFlattening", "kind": "Enumeration", "description": "How should transparency be flattened for pre-AI9 file formats.", "properties": [ { "name": "PRESERVEAPPEARANCE", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "PRESERVEPATHS", "type": "number", "description": "Discard transparency.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "PDFBoxType", "kind": "Enumeration", "description": "Crop box.", "properties": [ { "name": "PDFARTBOX", "type": "number", "description": "Crop to ArtBox. The art box defines the extent of the page's meaningful content (including potential white space) as intended by the page's creator.", "access": "readonly", "value": "0" }, { "name": "PDFBLEEDBOX", "type": "number", "description": "Crop to BleedBox. The bleed box defines the region to which the contents of the page should be clipped when output in a production environment.", "access": "readonly", "value": "3" }, { "name": "PDFBOUNDINGBOX", "type": "number", "description": "Crop to Bounding Box. The bounding box is the rectangle that encloses all text, graphics, and images on the page.", "access": "readonly", "value": "5" }, { "name": "PDFCROPBOX", "type": "number", "description": "Crop to CropBox. The crop box is the region of the page to display and to print.", "access": "readonly", "value": "1" }, { "name": "PDFMEDIABOX", "type": "number", "description": "Crop to MediaBox. The media box is a natural size of the page. For example, the dimensions of A4 sheet of paper.", "access": "readonly", "value": "4" }, { "name": "PDFTRIMBOX", "type": "number", "description": "Crop to TrimBox. The trim box specifies the positioning of the page's content within the imposition.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PDFChangesAllowedEnum", "kind": "Enumeration", "description": "Options available for making changes to a pdf document.", "properties": [ { "name": "CHANGE128ANYCHANGES", "type": "number", "description": "Any changes allowed except extracting of pages- 128bit.", "access": "readonly", "value": "5" }, { "name": "CHANGE128COMMENTING", "type": "number", "description": "Comment allowed - 128bit.", "access": "readonly", "value": "4" }, { "name": "CHANGE128EDITPAGE", "type": "number", "description": "Editing page allowed - 128bit.", "access": "readonly", "value": "2" }, { "name": "CHANGE128FILLFORM", "type": "number", "description": "Filling in of form field and signing allowed - 128bit.", "access": "readonly", "value": "3" }, { "name": "CHANGE128NONE", "type": "number", "description": "No changes allowed - 128bit.", "access": "readonly", "value": "1" }, { "name": "CHANGE40ANYCHANGES", "type": "number", "description": "Any changes allowed except extracting of pages- 40bit.", "access": "readonly", "value": "9" }, { "name": "CHANGE40COMMENTING", "type": "number", "description": "Comment allowed - 40bit.", "access": "readonly", "value": "7" }, { "name": "CHANGE40NONE", "type": "number", "description": "No changes allowed - 40bit.", "access": "readonly", "value": "6" }, { "name": "CHANGE40PAGELAYOUT", "type": "number", "description": "Page layout allowed - 40bit.", "access": "readonly", "value": "8" } ], "events": [], "methods": [] }, { "name": "PDFCompatibility", "kind": "Enumeration", "description": "The PDF compatibility type.", "properties": [ { "name": "ACROBAT4", "type": "number", "description": "Acrobat version 4.", "access": "readonly", "value": "4" }, { "name": "ACROBAT5", "type": "number", "description": "Acrobat version 5.", "access": "readonly", "value": "5" }, { "name": "ACROBAT6", "type": "number", "description": "Acrobat version 6.", "access": "readonly", "value": "6" }, { "name": "ACROBAT7", "type": "number", "description": "Acrobat version 7.", "access": "readonly", "value": "7" }, { "name": "ACROBAT8", "type": "number", "description": "Acrobat version 8.", "access": "readonly", "value": "8" } ], "events": [], "methods": [] }, { "name": "PDFOverprint", "kind": "Enumeration", "description": "Pdf overprint options.", "properties": [ { "name": "DISCARDPDFOVERPRINT", "type": "number", "description": "Discard overprint.", "access": "readonly", "value": "2" }, { "name": "PRESERVEPDFOVERPRINT", "type": "number", "description": "Preserve overprint.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PDFPrintAllowedEnum", "kind": "Enumeration", "description": "Pdf print permissions.", "properties": [ { "name": "PRINT128HIGHRESOLUTION", "type": "number", "description": "Print high resolution allowed - 128bit.", "access": "readonly", "value": "3" }, { "name": "PRINT128LOWRESOLUTION", "type": "number", "description": "Print allowed only in low resolution - 128bit.", "access": "readonly", "value": "2" }, { "name": "PRINT128NONE", "type": "number", "description": "Printing allowed none - 128bit.", "access": "readonly", "value": "1" }, { "name": "PRINT40HIGHRESOLUTION", "type": "number", "description": "Print high resolution allowed - 40bit.", "access": "readonly", "value": "5" }, { "name": "PRINT40NONE", "type": "number", "description": "Printing allowed none - 40bit.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "PDFSaveOptions", "kind": "Object", "description": "Options which may be supplied when saving a document as a PDF file.", "properties": [ { "name": "acrobatLayers", "type": "boolean", "description": "Create acrobat layers from top-level layers - acrobat 6 only option.", "access": "read/write", "static": true, "value": "false" }, { "name": "artboardRange", "type": "string", "description": "Considered for multi-asset extraction which specifies artboard range.Empty string will extracts all the artboards.Default is empty string.", "access": "read/write", "static": true }, { "name": "bleedLink", "type": "boolean", "description": "Link 4 bleed values.", "access": "read/write", "static": true, "value": "true" }, { "name": "bleedOffsetRect", "type": "number[]", "description": "The bleed offset rect.", "access": "read/write", "static": true }, { "name": "colorBars", "type": "boolean", "description": "Draw color bars.", "access": "read/write", "static": true, "value": "false" }, { "name": "colorCompression", "type": "CompressionQuality", "description": "How should color bitmap images be compressed.", "access": "read/write", "static": true, "value": "CompressionQuality.None" }, { "name": "colorConversionID", "type": "ColorConversion", "description": "PDF color conversion policy. Three choices are available: (1)No Color Conversion (2) Repurpose (3) Convert to Destination.", "access": "read/write", "static": true, "value": "ColorConversion.None" }, { "name": "colorDestinationID", "type": "ColorDestination", "description": "When NoColorConversion is specified for Color Conversion, NoColorDestination is set.", "access": "read/write", "static": true, "value": "ColorDestination.None" }, { "name": "colorDownsampling", "type": "number", "description": "If zero, no downsampling, otherwise, the resolution to downsample color bitmap images to.", "access": "read/write", "static": true, "value": "150" }, { "name": "colorDownsamplingImageThreshold", "type": "number", "description": "Downsample if the image's resolution is above this value.", "access": "read/write", "static": true, "value": "225" }, { "name": "colorDownsamplingMethod", "type": "DownsampleMethod", "description": "How should color bitmap images be resampled.", "access": "read/write", "static": true, "value": "DownsampleMethod.NODOWNSAMPLE" }, { "name": "colorProfileID", "type": "ColorProfile", "description": "If CMS is off, Don't Include Profiles is set.", "access": "read/write", "static": true, "value": "ColorProfile.None" }, { "name": "colorTileSize", "type": "number", "description": "Tile size when compressing with JPEG2000.", "access": "read/write", "static": true, "value": "256" }, { "name": "compatibility", "type": "PDFCompatibility", "description": "The version of the Acrobat file format to create.", "access": "read/write", "static": true, "value": "PDFCompatibility.ACROBAT5" }, { "name": "compressArt", "type": "boolean", "description": "Should line art and text be compressed?", "access": "read/write", "static": true, "value": "true" }, { "name": "documentPassword", "type": "string", "description": "A password string to open the document.", "access": "read/write", "static": true }, { "name": "enableAccess", "type": "boolean", "description": "Enable accessing 128-bit.", "access": "read/write", "static": true, "value": "true" }, { "name": "enableCopy", "type": "boolean", "description": "Enable copying of text 128-bit.", "access": "read/write", "static": true, "value": "true" }, { "name": "enableCopyAccess", "type": "boolean", "description": "Enable copying and accessing 40-bit.", "access": "read/write", "static": true, "value": "true" }, { "name": "enablePlainText", "type": "boolean", "description": "Enable plaintext metadata 128-bit - available only for acrobat 6.", "access": "read/write", "static": true, "value": "false" }, { "name": "flattenerOptions", "type": "PrintFlattenerOptions", "description": "The printing flattener options.", "access": "read/write", "static": true }, { "name": "flattenerPreset", "type": "string", "description": "The transparency flattener preset name.", "access": "read/write", "static": true }, { "name": "fontSubsetThreshold", "type": "number", "description": "Include a subset of fonts when less than this percentage of characters are used.", "access": "read/write", "static": true, "value": "100", "range": { "min": "0", "max": "100" } }, { "name": "generateThumbnails", "type": "boolean", "description": "Generate thumbnails for the saved document.", "access": "read/write", "static": true, "value": "true" }, { "name": "grayscaleCompression", "type": "CompressionQuality", "description": "How should grayscale bitmap images be compressed.", "access": "read/write", "static": true, "value": "CompressionQuality.None" }, { "name": "grayscaleDownsampling", "type": "number", "description": "If zero, no downsampling, otherwise, the resolution to downsample grayscale images to.", "access": "read/write", "static": true, "value": "150" }, { "name": "grayscaleDownsamplingImageThreshold", "type": "number", "description": "Downsample if the image's resolution is above this value.", "access": "read/write", "static": true, "value": "225" }, { "name": "grayscaleDownsamplingMethod", "type": "DownsampleMethod", "description": "How should grayscale bitmap images be resampled.", "access": "read/write", "static": true, "value": "DownsampleMethod.NODOWNSAMPLE" }, { "name": "grayscaleTileSize", "type": "number", "description": "Tile size when compressing with JPEG2000.", "access": "read/write", "static": true, "value": "256" }, { "name": "monochromeCompression", "type": "MonochromeCompression", "description": "How should monochrome bitmap images be compressed.", "access": "read/write", "static": true, "value": "MonochromeCompression.None" }, { "name": "monochromeDownsampling", "type": "number", "description": "If zero, no downsampling, otherwise, the resolution to downsample images to.", "access": "read/write", "static": true, "value": "300" }, { "name": "monochromeDownsamplingImageThreshold", "type": "number", "description": "Downsample if the image's resolution is above this value.", "access": "read/write", "static": true, "value": "450" }, { "name": "monochromeDownsamplingMethod", "type": "DownsampleMethod", "description": "How should monochrome bitmap images be resampled.", "access": "read/write", "static": true, "value": "DownsampleMethod.NODOWNSAMPLE" }, { "name": "offset", "type": "number", "description": "Custom offset (in points) for using the custom paper.", "access": "read/write", "static": true, "value": "0" }, { "name": "optimization", "type": "boolean", "description": "Should the PDF document be optimized for fast web viewing.", "access": "read/write", "static": true, "value": "false" }, { "name": "outputCondition", "type": "string", "description": "This is an optional comment which, if present, is added to the PDF file and describes the intended printing condition.", "access": "read/write", "static": true }, { "name": "outputConditionID", "type": "string", "description": "If selected for Output Intent Profile Name, you can set the name of a registered printing condition.", "access": "read/write", "static": true }, { "name": "outputIntentProfile", "type": "string", "description": "When CMS is on, the output intent profile is the same profile selected for Destination in the Color group box.", "access": "read/write", "static": true }, { "name": "pDFAllowPrinting", "type": "PDFPrintAllowedEnum", "description": "PDF security printing permission.", "access": "read/write", "static": true, "value": "PDFPrintAllowedEnum.PRINT128HIGHRESOLUTION" }, { "name": "pDFChangesAllowed", "type": "PDFChangesAllowedEnum", "description": "PDF security changes allowed.", "access": "read/write", "static": true, "value": "PDFChangesAllowedEnum.CHANGE128ANYCHANGES" }, { "name": "pDFPreset", "type": "string", "description": "The max string length is 255 bytes. Name of PDF preset to use.", "access": "read/write", "static": true }, { "name": "pDFXStandard", "type": "PDFXStandard", "description": "This control includes the None option for when the user is not complying with any PDF standard.", "access": "read/write", "static": true, "value": "PDFXStandard.PDFXNONE" }, { "name": "pDFXStandardDescription", "type": "string", "description": "This displays the description from the selected preset.", "access": "read/write", "static": true }, { "name": "pageInformation", "type": "boolean", "description": "Draw page information.", "access": "read/write", "static": true, "value": "false" }, { "name": "pageMarksType", "type": "PageMarksTypes", "description": "The page marks style.", "access": "read/write", "static": true, "value": "PageMarksTypes.Roman" }, { "name": "permissionPassword", "type": "string", "description": "A password string to restrict editing security settings.", "access": "read/write", "static": true }, { "name": "preserveEditability", "type": "boolean", "description": "Preserve Illustrator editing capabilities when saving the document.", "access": "read/write", "static": true, "value": "true" }, { "name": "printerResolution", "type": "number", "description": "Flattening printer resolution.", "access": "read/write", "static": true, "value": "800" }, { "name": "registrationMarks", "type": "boolean", "description": "Draw registration marks.", "access": "read/write", "static": true, "value": "false" }, { "name": "registryName", "type": "string", "description": "URL to the site where the specified output condition is registered. No validation is performed on the URL.", "access": "read/write", "static": true }, { "name": "requireDocumentPassword", "type": "boolean", "description": "Require a password to open the document.", "access": "read/write", "static": true, "value": "false" }, { "name": "requirePermissionPassword", "type": "boolean", "description": "Use a password to restrict editing security settings.", "access": "read/write", "static": true, "value": "false" }, { "name": "trapped", "type": "boolean", "description": "This indicates if manual trapping has been prepared in the document.", "access": "read/write", "static": true, "value": "false" }, { "name": "trimMarkWeight", "type": "PDFTrimMarkWeight", "description": "Trim mark weight.", "access": "read/write", "static": true, "value": "PDFTrimMarkWeight.TRIMMARKWEIGHT0125" }, { "name": "trimMarks", "type": "boolean", "description": "Draw trim marks.", "access": "read/write", "static": true, "value": "false" }, { "name": "viewAfterSaving", "type": "boolean", "description": "View PDF after saving.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "PDFTrimMarkWeight", "kind": "Enumeration", "description": "Pdf trim mark weight options.", "properties": [ { "name": "TRIMMARKWEIGHT0125", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "TRIMMARKWEIGHT025", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "TRIMMARKWEIGHT05", "type": "number", "description": "", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "PDFXStandard", "kind": "Enumeration", "description": "This provides a means for matching the color characteristics of a PDF document.", "properties": [ { "name": "PDFX1A2001", "type": "number", "description": "Supports only a CMYK and spot color workflow, targeted to a specific output device.", "access": "readonly", "value": "2" }, { "name": "PDFX1A2003", "type": "number", "description": "Supports only a CMYK and spot color workflow, targeted to a specific output device.", "access": "readonly", "value": "3" }, { "name": "PDFX32001", "type": "number", "description": "Supports a color-managed workflow, allowing the use of device-independent color in addition to CMYK and spot colors.", "access": "readonly", "value": "4" }, { "name": "PDFX32002", "type": "number", "description": "Supports a color-managed workflow, allowing the use of device-independent color in addition to CMYK and spot colors.", "access": "readonly", "value": "4" }, { "name": "PDFX32003", "type": "number", "description": "Supports a color-managed workflow, allowing the use of device-independent color in addition to CMYK and spot colors.", "access": "readonly", "value": "5" }, { "name": "PDFX42007", "type": "number", "description": "Supports a color-managed workflow, allowing the use of device-independent color in addition to CMYK and spot colors.", "access": "readonly", "value": "6" }, { "name": "PDFXNONE", "type": "number", "description": "The user isn't complying with any PDF standard.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PPDFile", "kind": "Object", "description": "A PPD file.", "properties": [ { "name": "PPDInfo", "type": "PPDFileInfo", "description": "The PPD file information.", "access": "read/write", "static": true }, { "name": "name", "type": "string", "description": "The PPD model name.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PPDFileInfo", "kind": "Object", "description": "PPD file information.", "properties": [ { "name": "PPDFilePath", "type": "File", "description": "Path specification for the PPD file.", "access": "read/write", "static": true }, { "name": "languageLevel", "type": "string", "description": "The PostScript language level.", "access": "read/write", "static": true }, { "name": "screenList", "type": "Screen[]", "description": "List of color separation screens.", "access": "read/write", "static": true }, { "name": "screenSpotFunctionList", "type": "ScreenSpotFunction[]", "description": "List of color separation screen spot functions.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PageItem", "kind": "Object", "description": "A page item object.", "properties": [ { "name": "URL", "type": "string", "description": "The value of the Adobe URL tag assigned to this artwork item.", "access": "read/write" }, { "name": "absoluteZOrderPosition", "type": "number", "description": "The absolute drawing order of the layer.", "access": "readonly" }, { "name": "artworkKnockout", "type": "KnockoutState", "description": "Is the artwork used to create a knockout.", "access": "read/write" }, { "name": "blendingMode", "type": "BlendModes", "description": "The mode used when compositing an object.", "access": "read/write" }, { "name": "controlBounds", "type": "number[]", "description": "The bounds of the artwork including stroke width and controls.", "access": "readonly" }, { "name": "editable", "type": "boolean", "description": "Can the art item be modified.", "access": "readonly" }, { "name": "geometricBounds", "type": "number[]", "description": "The bounds of the artwork excluding stroke width.", "access": "readonly" }, { "name": "height", "type": "number", "description": "The height of the art item.", "access": "read/write", "range": { "min": "0.0", "max": "16348.0" } }, { "name": "hidden", "type": "boolean", "description": "Is this artwork item hidden?", "access": "read/write" }, { "name": "isIsolated", "type": "boolean", "description": "Is the artwork isolated.", "access": "read/write" }, { "name": "layer", "type": "Layer", "description": "The layer to which this artwork belongs.", "access": "readonly" }, { "name": "left", "type": "number", "description": "The left position of the art item.", "access": "read/write" }, { "name": "locked", "type": "boolean", "description": "Is this artwork item locked?", "access": "read/write" }, { "name": "name", "type": "string", "description": "The item's name.", "access": "read/write" }, { "name": "note", "type": "string", "description": "The note assigned to this artwork item.", "access": "read/write" }, { "name": "opacity", "type": "number", "description": "The object's opacity (between 0.0 and 100.0)", "access": "read/write", "range": { "min": "0.0", "max": "100.0" } }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pixelAligned", "type": "boolean", "description": "Is this artwork item aligned to Pixel Grid?", "access": "read/write" }, { "name": "position", "type": "Point", "description": "The position of the top left corner of the art item.", "access": "read/write" }, { "name": "selected", "type": "boolean", "description": "Is this artwork item selected?", "access": "read/write" }, { "name": "sliced", "type": "boolean", "description": "Is the art item sliced (default: false)", "access": "read/write" }, { "name": "tags", "type": "Tags", "description": "The collection of tags associated with this page item.", "access": "readonly" }, { "name": "top", "type": "number", "description": "The top position of the art item.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "uuid", "type": "string", "description": "The item's unique identifier.", "access": "readonly" }, { "name": "visibilityVariable", "type": "any", "description": "The visibility variable bound to this page item.", "access": "read/write" }, { "name": "visibleBounds", "type": "number[]", "description": "The visible bounds of the artwork including stroke width.", "access": "readonly" }, { "name": "width", "type": "number", "description": "The width of the art item.", "access": "read/write", "range": { "min": "0.0", "max": "16348.0" } }, { "name": "wrapInside", "type": "boolean", "description": "Should the text frame object be wrapped inside this object?", "access": "read/write" }, { "name": "wrapOffset", "type": "number", "description": "Use this offset when wrapping text around this object.", "access": "read/write" }, { "name": "wrapped", "type": "boolean", "description": "Wrap text frame objects around this object (text frame must be above the object)", "access": "read/write" }, { "name": "zOrderPosition", "type": "number", "description": "The drawing order of the art within it's group or layer.", "access": "readonly" } ], "events": [], "methods": [ { "name": "applyEffect", "returns": "void", "description": "Apply effect to selected artItem.", "parameters": [ { "name": "liveEffectXML", "type": "string", "description": "" } ] }, { "name": "bringInPerspective", "returns": "void", "description": "Place art object(s)in perspective grid at spedified perspective plane and coordinate.", "parameters": [ { "name": "positionX", "type": "number", "description": "Position towards X direction of specified or active perspective grid plane." }, { "name": "positionY", "type": "number", "description": "Position towards Y direction of specified or active perspective grid plane." }, { "name": "perspectiveGridPlane", "type": "PerspectiveGridPlaneType", "description": "Type of perspective grid plane." } ] }, { "name": "duplicate", "returns": "PageItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "PageItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "resize", "returns": "void", "description": "Scale art object(s)", "parameters": [ { "name": "scaleX", "type": "number", "description": "Horizontal scaling factor expressed as a percentage (100 = 100%)" }, { "name": "scaleY", "type": "number", "description": "Vertical scaling factor expressed as a percentage (100 = 100%)" }, { "name": "changePositions", "type": "boolean", "description": "Are art object positions and orientations effected?", "optional": true }, { "name": "changeFillPatterns", "type": "boolean", "description": "Are the fill patterns assigned to paths to be transformed?", "optional": true }, { "name": "changeFillGradients", "type": "boolean", "description": "Are the fill gradients assigned to paths to be transformed?", "optional": true }, { "name": "changeStrokePattern", "type": "boolean", "description": "Are the stroke patterns assigned to paths to be transformed?", "optional": true }, { "name": "changeLineWidths", "type": "number", "description": "The amount line widths are to be scaled (expressed as a percentage)", "optional": true }, { "name": "scaleAbout", "type": "Transformation", "description": "The point on the art item's bounding box to which the scale is applied.", "optional": true } ] }, { "name": "rotate", "returns": "void", "description": "Rotate art object(s)", "parameters": [ { "name": "angle", "type": "number", "description": "Angle of rotation (in degrees). Rotation is performed counter-clock wise." }, { "name": "changePositions", "type": "boolean", "description": "Are art object positions and orientations effected?", "optional": true }, { "name": "changeFillPatterns", "type": "boolean", "description": "Are the fill patterns assigned to paths to be transformed?", "optional": true }, { "name": "changeFillGradients", "type": "boolean", "description": "Are the fill gradients assigned to paths to be transformed?", "optional": true }, { "name": "changeStrokePattern", "type": "boolean", "description": "Are the stroke patterns assigned to paths to be transformed?", "optional": true }, { "name": "rotateAbout", "type": "Transformation", "description": "The point on the art item's bounding box to which the rotation is applied.", "optional": true } ] }, { "name": "sendScriptMessage", "returns": "string", "description": "Sends the script message to the required plugin.", "parameters": [ { "name": "pluginName", "type": "string", "description": "Plugin to which message needs to be sent." }, { "name": "messageSelector", "type": "string", "description": "Functionality that is to be executed." }, { "name": "inputString", "type": "string", "description": "Pass any data encoded in a string." } ] }, { "name": "transform", "returns": "void", "description": "Transform art object(s) using a transformation matrix.", "parameters": [ { "name": "transformationMatrix", "type": "Matrix", "description": "The transformation matrix to be applied to the objects." }, { "name": "changePositions", "type": "boolean", "description": "Are art object positions and orientations effected?", "optional": true }, { "name": "changeFillPatterns", "type": "boolean", "description": "Are the fill patterns assigned to paths to be transformed?", "optional": true }, { "name": "changeFillGradients", "type": "boolean", "description": "Are the fill gradients assigned to paths to be transformed?", "optional": true }, { "name": "changeStrokePattern", "type": "boolean", "description": "Are the stroke patterns assigned to paths to be transformed?", "optional": true }, { "name": "changeLineWidths", "type": "number", "description": "The amount line widths are to be scaled (expressed as a percentage)", "optional": true }, { "name": "transformAbout", "type": "Transformation", "description": "The point on the art item's bounding box to which scale and rotation operations apply.", "optional": true } ] }, { "name": "translate", "returns": "void", "description": "Reposition art object(s)", "parameters": [ { "name": "deltaX", "type": "number", "description": "Horizontal transformation.", "optional": true }, { "name": "deltaY", "type": "number", "description": "Vertical transformation.", "optional": true }, { "name": "transformObjects", "type": "boolean", "description": "Are art object positions and orientations affected?", "optional": true }, { "name": "transformFillPatterns", "type": "boolean", "description": "Are the fill patterns assigned to paths to be transformed?", "optional": true }, { "name": "transformFillGradients", "type": "boolean", "description": "Are the fill gradients assigned to paths to be transformed?", "optional": true }, { "name": "transformStrokePattern", "type": "boolean", "description": "Are the stroke patterns assigned to paths to be transformed?", "optional": true } ] }, { "name": "zOrder", "returns": "void", "description": "Arranges the art relative to other art in the group or layer.", "parameters": [ { "name": "zOrderCmd", "type": "ZOrderMethod", "description": "How to arrange the art." } ] } ] }, { "name": "PageItems", "kind": "Collection", "description": "A collection of page items.", "elementType": "PageItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "PageItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "PageMarksTypes", "kind": "Enumeration", "description": "The page marks style type.", "properties": [ { "name": "Japanese", "type": "number", "description": "Japanese page marks style.", "access": "readonly", "value": "1" }, { "name": "Roman", "type": "number", "description": "Roman page marks style.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "Paper", "kind": "Object", "description": "Paper size.", "properties": [ { "name": "name", "type": "string", "description": "The paper name.", "access": "read/write", "static": true }, { "name": "paperInfo", "type": "PaperInfo", "description": "The paper information.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PaperInfo", "kind": "Object", "description": "Paper information.", "properties": [ { "name": "customPaper", "type": "boolean", "description": "Is it a custom paper?", "access": "read/write", "static": true }, { "name": "height", "type": "number", "description": "The paper's height (in points)", "access": "read/write", "static": true }, { "name": "imageableArea", "type": "number[]", "description": "The imageable area.", "access": "read/write", "static": true }, { "name": "width", "type": "number", "description": "The paper's width (in points)", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "ParagraphAttributes", "kind": "Object", "description": "Properties of a paragraph.", "properties": [ { "name": "autoLeadingAmount", "type": "number", "description": "Auto leading amount (in percentage)", "access": "read/write" }, { "name": "bunriKinshi", "type": "boolean", "description": "Is BunriKinshi enabled?", "access": "read/write" }, { "name": "burasagariType", "type": "BurasagariTypeEnum", "description": "The Burasagari type.", "access": "read/write" }, { "name": "composerEngine", "type": "ComposerEngineType", "description": "Composer engine attribute.", "access": "read/write" }, { "name": "desiredGlyphScaling", "type": "number", "description": "Desired glyph scaling expressed as a percentage.", "access": "read/write" }, { "name": "desiredLetterSpacing", "type": "number", "description": "Desired letter spacing expressed as a percentage.", "access": "read/write" }, { "name": "desiredWordSpacing", "type": "number", "description": "Desired word spacing expressed as a percentage.", "access": "read/write" }, { "name": "everyLineComposer", "type": "boolean", "description": "Whether to enable every line composer (as opposed to single line composer)?", "access": "read/write" }, { "name": "firstLineIndent", "type": "number", "description": "First line left indent expressed in points.", "access": "read/write" }, { "name": "hyphenateCapitalizedWords", "type": "boolean", "description": "Is hyphenation enabled for the capitalized words?", "access": "read/write" }, { "name": "hyphenation", "type": "boolean", "description": "Is hyphenation enabled for the paragraph?", "access": "read/write" }, { "name": "hyphenationPreference", "type": "number", "description": "Hyphenation preference scale for better spacing (0) or fewer hyphens (1)", "access": "read/write", "range": { "min": "0", "max": "1" } }, { "name": "hyphenationZone", "type": "number", "description": "Size of the hyphenation zone.", "access": "read/write" }, { "name": "justification", "type": "Justification", "description": "Paragraph justification.", "access": "read/write" }, { "name": "kashidaWidth", "type": "KashidaWidthType", "description": "The Kashida Width attribute.", "access": "read/write" }, { "name": "kinsoku", "type": "string", "description": "The Kinsoku Shori name.", "access": "read/write" }, { "name": "kinsokuOrder", "type": "KinsokuOrderEnum", "description": "The preferred Kinsoku order.", "access": "read/write" }, { "name": "kurikaeshiMojiShori", "type": "boolean", "description": "Is KurikaeshiMojiShori enabled?", "access": "read/write" }, { "name": "leadingType", "type": "AutoLeadingType", "description": "Auto leading type.", "access": "read/write" }, { "name": "leftIndent", "type": "number", "description": "Left indent of margin expressed in points.", "access": "read/write" }, { "name": "maximumConsecutiveHyphens", "type": "number", "description": "Maximum number of consecutive hypenated lines.", "access": "read/write" }, { "name": "maximumGlyphScaling", "type": "number", "description": "Maximum glyph scaling expressed as a percentage.", "access": "read/write" }, { "name": "maximumLetterSpacing", "type": "number", "description": "Maximum letter spacing expressed as a percentage.", "access": "read/write" }, { "name": "maximumWordSpacing", "type": "number", "description": "Maximum word spacing expressed as a percentage.", "access": "read/write" }, { "name": "minimumAfterHyphen", "type": "number", "description": "Minimum number of characters after a hyphen.", "access": "read/write" }, { "name": "minimumBeforeHyphen", "type": "number", "description": "Minimum number of characters before a hyphen.", "access": "read/write" }, { "name": "minimumGlyphScaling", "type": "number", "description": "Minimum glyph scaling expressed as a percentage.", "access": "read/write" }, { "name": "minimumHyphenatedWordSize", "type": "number", "description": "Minimum hyphenated word size.", "access": "read/write" }, { "name": "minimumLetterSpacing", "type": "number", "description": "Minimum letter spacing expressed as a percentage.", "access": "read/write" }, { "name": "minimumWordSpacing", "type": "number", "description": "Minimum word spacing expressed as a percentage.", "access": "read/write" }, { "name": "mojikumi", "type": "string", "description": "The Mojikumi name.", "access": "read/write" }, { "name": "paragraphDirection", "type": "ParagraphDirectionType", "description": "Main writing direction attribute.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "rightIndent", "type": "number", "description": "Right indent of margin expressed in points.", "access": "read/write" }, { "name": "romanHanging", "type": "boolean", "description": "Is Roman hanging punctuation enabled?", "access": "read/write" }, { "name": "singleWordJustification", "type": "Justification", "description": "Single word justification.", "access": "read/write" }, { "name": "spaceAfter", "type": "number", "description": "Spacing after paragraph in points.", "access": "read/write" }, { "name": "spaceBefore", "type": "number", "description": "Spacing before paragraph in points.", "access": "read/write" }, { "name": "tabStops", "type": "TabStopInfo[]", "description": "Tab stop settings.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "ParagraphDirectionType", "kind": "Enumeration", "description": "The composer type constants.", "properties": [ { "name": "LEFT_TO_RIGHT_DIRECTION", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "RIGHT_TO_LEFT_DIRECTION", "type": "number", "description": "", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ParagraphStyle", "kind": "Object", "description": "A named style that remembers paragraph attributes.", "properties": [ { "name": "characterAttributes", "type": "CharacterAttributes", "description": "The character properties for the text range.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The paragraph style's name.", "access": "read/write" }, { "name": "paragraphAttributes", "type": "ParagraphAttributes", "description": "The paragraph properties for the text range.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "ParagraphStyle", "description": "Adds an element.", "parameters": [] }, { "name": "applyTo", "returns": "void", "description": "Apply the paragraph style to text object(s)", "parameters": [ { "name": "textItem", "type": "any", "description": "The text object(s) to apply the style to." }, { "name": "clearingOverrides", "type": "boolean", "description": "Whether to clear any text attributes before apply the style.", "optional": true } ] }, { "name": "clear", "returns": "void", "description": "Remove all the attributes from this paragraph style.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "ParagraphStyles", "kind": "Collection", "description": "A collection of paragraph styles.", "elementType": "ParagraphStyle", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "ParagraphStyle", "description": "Create a named paragraph style.", "parameters": [ { "name": "name", "type": "string", "description": "The paragraph style name." } ] }, { "name": "getByName", "returns": "ParagraphStyle", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Paragraphs", "kind": "Collection", "description": "A collection of Paragraphs.", "elementType": "TextRange", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "TextRange", "description": "Create a text art item.", "parameters": [ { "name": "contents", "type": "string", "description": "The text string." } ] }, { "name": "addBefore", "returns": "TextRange", "description": "", "parameters": [ { "name": "contents", "type": "string", "description": "The text string." } ] }, { "name": "getByName", "returns": "TextRange", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "PathItem", "kind": "Collection", "description": "An artwork path item.", "extends": "PageItem", "properties": [ { "name": "area", "type": "number", "description": "The area of this path in square points.", "access": "readonly" }, { "name": "clipping", "type": "boolean", "description": "Should this be used as a clipping path?", "access": "read/write" }, { "name": "closed", "type": "boolean", "description": "Is this path closed?", "access": "read/write" }, { "name": "evenodd", "type": "boolean", "description": "Should the even-odd rule be used to determine insideness?", "access": "read/write" }, { "name": "fillColor", "type": "Color", "description": "Fill color.", "access": "read/write" }, { "name": "fillOverprint", "type": "boolean", "description": "Will art beneath a filled object be overprinted?", "access": "read/write" }, { "name": "filled", "type": "boolean", "description": "Should the path be filled?", "access": "read/write" }, { "name": "guides", "type": "boolean", "description": "Is this path a guide object?", "access": "read/write" }, { "name": "length", "type": "number", "description": "The length of this path in points.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathPoints", "type": "PathPoints", "description": "", "access": "readonly" }, { "name": "polarity", "type": "PolarityValues", "description": "The polarity the path.", "access": "read/write" }, { "name": "resolution", "type": "number", "description": "The resolution of the path.", "access": "read/write" }, { "name": "selectedPathPoints", "type": "ObjectArray", "description": "All the selected points in the path.", "access": "readonly" }, { "name": "strokeCap", "type": "StrokeCap", "description": "Type of line capping.", "access": "read/write" }, { "name": "strokeColor", "type": "Color", "description": "Stroke color.", "access": "read/write" }, { "name": "strokeDashOffset", "type": "number", "description": "The default distance into the dash pattern at which the pattern should be started.", "access": "read/write" }, { "name": "strokeDashes", "type": "number[]", "description": "Dash lengths (set to {} for a solid line)", "access": "read/write" }, { "name": "strokeJoin", "type": "StrokeJoin", "description": "Type of joints.", "access": "read/write" }, { "name": "strokeMiterLimit", "type": "number", "description": "Whether a join is mitered (pointed) or beveled (squared-off)", "access": "read/write" }, { "name": "strokeOverprint", "type": "boolean", "description": "Will art beneath a stroked object be overprinted?", "access": "read/write" }, { "name": "strokeWidth", "type": "number", "description": "Width of stroke.", "access": "read/write" }, { "name": "stroked", "type": "boolean", "description": "Should the path be stroked?", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "PathItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "PathItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "setEntirePath", "returns": "void", "description": "Set the path using the provided array of path point (x, y) coordinate pairs.", "parameters": [ { "name": "pathPoints", "type": "any[]", "description": "Array of (x, y) coordinate pairs for the path points." } ] } ] }, { "name": "PathItems", "kind": "Collection", "description": "A collection of path items.", "elementType": "PathItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "PathItem", "description": "Create a path.", "parameters": [] }, { "name": "ellipse", "returns": "PathItem", "description": "Create an elliptical path item.", "parameters": [ { "name": "top", "type": "number", "description": "The ellipse's bounds.", "optional": true }, { "name": "left", "type": "number", "description": "The ellipse's bounds.", "optional": true }, { "name": "width", "type": "number", "description": "The ellipse's bounds.", "optional": true }, { "name": "height", "type": "number", "description": "The height of the ellipse.", "optional": true }, { "name": "reversed", "type": "boolean", "description": "Is the ellipse path reversed?", "optional": true }, { "name": "inscribed", "type": "boolean", "description": "Is the ellipse path inscribed?", "optional": true } ] }, { "name": "getByName", "returns": "PathItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "polygon", "returns": "PathItem", "description": "Used to create a regular polygon path item. Not for path item access.", "parameters": [ { "name": "centerX", "type": "number", "description": "", "optional": true }, { "name": "centerY", "type": "number", "description": "", "optional": true }, { "name": "radius", "type": "number", "description": "The radius of the polygon points.", "optional": true }, { "name": "sides", "type": "number", "description": "The number of sides on the polygon.", "optional": true }, { "name": "reversed", "type": "boolean", "description": "Is the polygon path reversed?", "optional": true } ] }, { "name": "rectangle", "returns": "PathItem", "description": "Used to create a rectangular path item. Not for path item access.", "parameters": [ { "name": "top", "type": "number", "description": "The top coordinate of the rectangle's bounds." }, { "name": "left", "type": "number", "description": "The left coordinate of the rectangle's bounds." }, { "name": "width", "type": "number", "description": "The width of the rectangle." }, { "name": "height", "type": "number", "description": "The height of the rectangle." }, { "name": "reversed", "type": "boolean", "description": "Is the rectangle path reversed?", "optional": true } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "roundedRectangle", "returns": "PathItem", "description": "Used to create a rounded-corner rectangular path item. Not for path item access.", "parameters": [ { "name": "top", "type": "number", "description": "" }, { "name": "left", "type": "number", "description": "" }, { "name": "width", "type": "number", "description": "" }, { "name": "height", "type": "number", "description": "" }, { "name": "horizontalRadius", "type": "number", "description": "Horizontal corner radius.", "optional": true }, { "name": "verticalRadius", "type": "number", "description": "Vertical corner radius.", "optional": true }, { "name": "reversed", "type": "boolean", "description": "Is the rectangle path reversed?", "optional": true } ] }, { "name": "star", "returns": "PathItem", "description": "Used to create a star-shaped path item. Not for path item access.", "parameters": [ { "name": "centerX", "type": "number", "description": "", "optional": true }, { "name": "centerY", "type": "number", "description": "", "optional": true }, { "name": "radius", "type": "number", "description": "The outside radius of the star points.", "optional": true }, { "name": "innerRadius", "type": "number", "description": "The inside radius of the star points.", "optional": true }, { "name": "points", "type": "number", "description": "The number of points on the star.", "optional": true }, { "name": "reversed", "type": "boolean", "description": "Is the star path reversed?", "optional": true } ] } ] }, { "name": "PathPoint", "kind": "Object", "description": "A point on a path.", "properties": [ { "name": "anchor", "type": "Point", "description": "The position (coordinates) of the anchor point.", "access": "read/write" }, { "name": "leftDirection", "type": "Point", "description": "Location of the left direction point (in position)", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pointType", "type": "PointType", "description": "The type of point: smooth/corner.", "access": "read/write" }, { "name": "rightDirection", "type": "Point", "description": "Location of the right direction point (out position)", "access": "read/write" }, { "name": "selected", "type": "PathPointSelection", "description": "The path point selected state.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "PathPointSelection", "kind": "Enumeration", "description": "The path point selection state.", "properties": [ { "name": "ANCHORPOINT", "type": "number", "description": "Anchor point selected.", "access": "readonly", "value": "2" }, { "name": "LEFTDIRECTION", "type": "number", "description": "Left direction point selected.", "access": "readonly", "value": "3" }, { "name": "LEFTRIGHTPOINT", "type": "number", "description": "Left and right direction points selected.", "access": "readonly", "value": "5" }, { "name": "NOSELECTION", "type": "number", "description": "Path point not selected.", "access": "readonly", "value": "1" }, { "name": "RIGHTDIRECTION", "type": "number", "description": "Right direction point selected.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "PathPoints", "kind": "Collection", "description": "A collection of path points.", "elementType": "PathPoint", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "PathPoint", "description": "Create a path point.", "parameters": [] }, { "name": "getByName", "returns": "PathPoint", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Pattern", "kind": "Object", "description": "A pattern.", "properties": [ { "name": "name", "type": "string", "description": "The pattern's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "PatternColor", "kind": "Object", "description": "A Pattern color specification.", "extends": "Color", "properties": [ { "name": "matrix", "type": "Matrix", "description": "Additional transformation arising from manipulating the path.", "access": "read/write", "static": true }, { "name": "pattern", "type": "Pattern", "description": "", "access": "read/write", "static": true }, { "name": "reflect", "type": "boolean", "description": "Whether or not the prototype is reflected before filling.", "access": "read/write", "static": true, "value": "false" }, { "name": "reflectAngle", "type": "number", "description": "The axis around which to reflect.", "access": "read/write", "static": true, "value": "0" }, { "name": "rotation", "type": "number", "description": "The angle to rotate the before filling.", "access": "read/write", "static": true, "value": "0" }, { "name": "scaleFactor", "type": "Point", "description": "The fraction to scale the prototype before filling.", "access": "read/write", "static": true }, { "name": "shearAngle", "type": "number", "description": "The angle to slant the shear by.", "access": "read/write", "static": true, "value": "0" }, { "name": "shearAxis", "type": "number", "description": "The axis to shear with respect to.", "access": "read/write", "static": true, "value": "0" }, { "name": "shiftAngle", "type": "number", "description": "The angle to translate the (unscaled) prototype before filling.", "access": "read/write", "static": true, "value": "0" }, { "name": "shiftDistance", "type": "number", "description": "The distance to translate the (unscaled) prototype before filling.", "access": "read/write", "static": true, "value": "0" } ], "events": [], "methods": [] }, { "name": "Patterns", "kind": "Collection", "description": "A collection of patterns.", "elementType": "Pattern", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Pattern", "description": "Create a pattern.", "parameters": [] }, { "name": "getByName", "returns": "Pattern", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "PerspectiveGridPlaneType", "kind": "Enumeration", "description": "Perspective grid plane types.", "properties": [ { "name": "FLOORPLANE", "type": "number", "description": "Perspective Grid Floor Plane Type.", "access": "readonly", "value": "3" }, { "name": "LEFTPLANE", "type": "number", "description": "Perspective Grid Left Plane Type.", "access": "readonly", "value": "1" }, { "name": "NOPLANE", "type": "number", "description": "Invalid Perspective Grid Plane Type.", "access": "readonly", "value": "0" }, { "name": "RIGHTPLANE", "type": "number", "description": "Perspective Grid Right Plane Type.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PhotoshopCompatibility", "kind": "Enumeration", "description": "The Photoshop compatibility type.", "properties": [ { "name": "PHOTOSHOP6", "type": "number", "description": "Photoshop version 6.", "access": "readonly", "value": "2" }, { "name": "PHOTOSHOP8", "type": "number", "description": "Photoshop version 8.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PlacedItem", "kind": "Object", "description": "Placed artwork item.", "extends": "PageItem", "properties": [ { "name": "boundingBox", "type": "number[]", "description": "Dimensions of placed art object, regardless of transformations.", "access": "readonly" }, { "name": "contentVariable", "type": "any", "description": "The content variable bound to this placed art object.", "access": "read/write" }, { "name": "file", "type": "File", "description": "The file containing the placed artwork.", "access": "read/write" }, { "name": "matrix", "type": "Matrix", "description": "The transformation matrix of the placed art object.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "PlacedItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "embed", "returns": "void", "description": "Embed the placed art within the illustration.", "parameters": [] }, { "name": "move", "returns": "PlacedItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "relink", "returns": "void", "description": "Relink the placed art with supplied art from file.", "parameters": [ { "name": "fileSpec", "type": "File", "description": "File spec to relink from." } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "trace", "returns": "PluginItem", "description": "Trace this raster object using default options. Reorders this placed to the source art.", "parameters": [] } ] }, { "name": "PlacedItems", "kind": "Collection", "description": "", "elementType": "PlacedItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "PlacedItem", "description": "Create a placed item.", "parameters": [] }, { "name": "getByName", "returns": "PlacedItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "PluginItem", "kind": "Object", "description": "Plugin artwork item.", "extends": "PageItem", "properties": [ { "name": "isTracing", "type": "boolean", "description": "Is the plugin group a tracing?", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "tracing", "type": "TracingObject", "description": "The tracing object associated with this plugin item.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "PluginItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "PluginItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "PluginItems", "kind": "Collection", "description": "", "elementType": "PluginItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "PluginItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Point", "kind": "Collection", "description": "Describes a point. This class is also a two-element collection.", "properties": [ { "name": "left", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "length", "type": "number", "description": "The array length.", "access": "readonly", "value": "2" }, { "name": "top", "type": "number", "description": "The top coordinate.", "access": "read/write" }, { "name": "x", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "y", "type": "number", "description": "The top coordinate.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "PointType", "kind": "Enumeration", "description": "The path point type: smooth/corner.", "properties": [ { "name": "CORNER", "type": "number", "description": "Corner point.", "access": "readonly", "value": "2" }, { "name": "SMOOTH", "type": "number", "description": "Smooth path point.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PolarityValues", "kind": "Enumeration", "description": "", "properties": [ { "name": "NEGATIVE", "type": "number", "description": "", "access": "readonly", "value": "-1" }, { "name": "POSITIVE", "type": "number", "description": "", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PostScriptImageCompressionType", "kind": "Enumeration", "description": "The PostScript image compression type.", "properties": [ { "name": "IMAGECOMPRESSIONNONE", "type": "number", "description": "No image compression.", "access": "readonly", "value": "0" }, { "name": "JPEG", "type": "number", "description": "JPEG image compression.", "access": "readonly", "value": "2" }, { "name": "RLE", "type": "number", "description": "RLE image compression.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Preferences", "kind": "Object", "description": "Preferences for Illustrator.", "properties": [ { "name": "AutoCADFileOptions", "type": "OpenOptionsAutoCAD", "description": "Options to use when opening or placing a AutoCAD file.", "access": "readonly" }, { "name": "PDFFileOptions", "type": "OpenOptionsPDF", "description": "Options to use when opening or placing a PDF file.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "photoshopFileOptions", "type": "OpenOptionsPhotoshop", "description": "Options to use when opening or placing a Photoshop file.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getBooleanPreference", "returns": "boolean", "description": "Retrieve the value of the application preference key as boolean.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." } ] }, { "name": "getIntegerPreference", "returns": "number", "description": "Retrieve the value of the application preference key as integer.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." } ] }, { "name": "getRealPreference", "returns": "number", "description": "Retrieve the value of the application preference key as real number.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." } ] }, { "name": "getStringPreference", "returns": "string", "description": "Retrieve the value of the application preference key as string type.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." } ] }, { "name": "preferenceExists", "returns": "boolean", "description": "Checks whether the application preference key exists.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." } ] }, { "name": "removePreference", "returns": "void", "description": "Delete the application preference key.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." } ] }, { "name": "setBooleanPreference", "returns": "void", "description": "Set the value of the application preference key as boolean.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." }, { "name": "value", "type": "boolean", "description": "The boolean value of the preference key." } ] }, { "name": "setIntegerPreference", "returns": "void", "description": "Set the value of the application preference key as integer.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." }, { "name": "value", "type": "number", "description": "The boolean value of the preference key." } ] }, { "name": "setRealPreference", "returns": "void", "description": "Set the value of the application preference key as real number.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." }, { "name": "value", "type": "number", "description": "The real value of the preference key." } ] }, { "name": "setStringPreference", "returns": "void", "description": "Set the value of the application preference key as string type.", "parameters": [ { "name": "key", "type": "string", "description": "The preference key." }, { "name": "value", "type": "string", "description": "The string value of the preference key." } ] } ] }, { "name": "PrintArtworkDesignation", "kind": "Enumeration", "description": "The artwork layers/objects to be printed.", "properties": [ { "name": "ALLLAYERS", "type": "number", "description": "Print all layers.", "access": "readonly", "value": "2" }, { "name": "VISIBLELAYERS", "type": "number", "description": "Print visible layers.", "access": "readonly", "value": "1" }, { "name": "VISIBLEPRINTABLELAYERS", "type": "number", "description": "Print visible printable layers.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "PrintColorIntent", "kind": "Enumeration", "description": "The color intent type.", "properties": [ { "name": "ABSOLUTECOLORIMETRIC", "type": "number", "description": "Absolute colorimetric.", "access": "readonly", "value": "3" }, { "name": "PERCEPTUALINTENT", "type": "number", "description": "Perceptual color intent.", "access": "readonly", "value": "0" }, { "name": "RELATIVECOLORIMETRIC", "type": "number", "description": "Relative colorimetric.", "access": "readonly", "value": "2" }, { "name": "SATURATIONINTENT", "type": "number", "description": "Saturation color intent.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PrintColorManagementOptions", "kind": "Object", "description": "The color management options.", "properties": [ { "name": "colorProfileMode", "type": "PrintColorProfile", "description": "The color management profile mode.", "access": "read/write", "static": true, "value": "PrintColorProfile.SOURCEPROFILE" }, { "name": "intent", "type": "PrintColorIntent", "description": "The color management intent type.", "access": "read/write", "static": true, "value": "PrintColorIntent.RELATIVECOLORIMETRIC" }, { "name": "name", "type": "string", "description": "The color management profile name.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PrintColorProfile", "kind": "Enumeration", "description": "The color profile type.", "properties": [ { "name": "CUSTOMPROFILE", "type": "number", "description": "Use custom color profile.", "access": "readonly", "value": "3" }, { "name": "OLDSTYLEPROFILE", "type": "number", "description": "Use old style AI color profile.", "access": "readonly", "value": "0" }, { "name": "PRINTERPROFILE", "type": "number", "description": "Same as printer color profile.", "access": "readonly", "value": "2" }, { "name": "SOURCEPROFILE", "type": "number", "description": "Same as source color profile.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PrintColorSeparationMode", "kind": "Enumeration", "description": "The color separation mode.", "properties": [ { "name": "COMPOSITE", "type": "number", "description": "The composite mode.", "access": "readonly", "value": "0" }, { "name": "HOSTBASEDSEPARATION", "type": "number", "description": "The host based color separation mode.", "access": "readonly", "value": "1" }, { "name": "INRIPSEPARATION", "type": "number", "description": "The InRIP color separation mode.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PrintColorSeparationOptions", "kind": "Object", "description": "Print color separation options.", "properties": [ { "name": "colorSeparationMode", "type": "PrintColorSeparationMode", "description": "The color separation type.", "access": "read/write", "static": true, "value": "PrintColorSeparationMode.COMPOSITE" }, { "name": "convertSpotColors", "type": "boolean", "description": "Whether to convert all spot colors to process colors.", "access": "read/write", "static": true, "value": "false" }, { "name": "inkList", "type": "Ink[]", "description": "The list of inks for color separation.", "access": "read/write", "static": true }, { "name": "overPrintBlack", "type": "boolean", "description": "Whether to overprint in black.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "PrintCoordinateOptions", "kind": "Object", "description": "The print coordinate options.", "properties": [ { "name": "emulsion", "type": "boolean", "description": "Whether to flip artwork horizontally.", "access": "read/write", "static": true, "value": "false" }, { "name": "fitToPage", "type": "boolean", "description": "Whether to proportionally scale the artwork to fit on the page.", "access": "read/write", "static": true, "value": "false" }, { "name": "horizontalScale", "type": "number", "description": "The horizontal scaling factor expressed as a percentage (100 = 100%)", "access": "read/write", "static": true, "value": "100", "range": { "min": "1", "max": "10000" } }, { "name": "orientation", "type": "PrintOrientation", "description": "The artwork orientation.", "access": "read/write", "static": true, "value": "PrintOrientation.PORTRAIT" }, { "name": "position", "type": "PrintPosition", "description": "The artwork position on media.", "access": "read/write", "static": true, "value": "PrintPosition.TRANSLATECENTER" }, { "name": "tiling", "type": "PrintTiling", "description": "The page tiling mode.", "access": "read/write", "static": true, "value": "PrintTiling.TILESINGLEFULLPAGE" }, { "name": "verticalScale", "type": "number", "description": "The vertical scaling factor expressed as a percentage (100 = 100%)", "access": "read/write", "static": true, "value": "100", "range": { "min": "1", "max": "10000" } } ], "events": [], "methods": [] }, { "name": "PrintFlattenerOptions", "kind": "Object", "description": "The transparency flattening options.", "properties": [ { "name": "clipComplexRegions", "type": "boolean", "description": "Whether to clip complex regions.", "access": "read/write", "static": true, "value": "false" }, { "name": "convertStrokesToOutlines", "type": "boolean", "description": "Whether to convert all strokes to outlines.", "access": "read/write", "static": true, "value": "false" }, { "name": "convertTextToOutlines", "type": "boolean", "description": "Whether to convert all text to outlines.", "access": "read/write", "static": true, "value": "false" }, { "name": "flatteningBalance", "type": "number", "description": "The flattening balance.", "access": "read/write", "static": true, "value": "100", "range": { "min": "0", "max": "100" } }, { "name": "gradientResolution", "type": "number", "description": "The gradient resolution.", "access": "read/write", "static": true, "value": "300", "range": { "min": "1", "max": "9600" } }, { "name": "overprint", "type": "PDFOverprint", "description": "Overprint.", "access": "read/write", "static": true, "value": "PDFOverprint.PRESERVEPDFOVERPRINT" }, { "name": "rasterizationResolution", "type": "number", "description": "The rasterization resolution.", "access": "read/write", "static": true, "value": "300", "range": { "min": "1", "max": "9600" } } ], "events": [], "methods": [] }, { "name": "PrintFontDownloadMode", "kind": "Enumeration", "description": "The printer font download mode.", "properties": [ { "name": "DOWNLOADCOMPLETE", "type": "number", "description": "Download complete.", "access": "readonly", "value": "2" }, { "name": "DOWNLOADNONE", "type": "number", "description": "Download none.", "access": "readonly", "value": "0" }, { "name": "DOWNLOADSUBSET", "type": "number", "description": "Download subset.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PrintFontOptions", "kind": "Object", "description": "The font options for printing.", "properties": [ { "name": "downloadFonts", "type": "PrintFontDownloadMode", "description": "The font download mode.", "access": "read/write", "static": true, "value": "PrintFontDownloadMode.DOWNLOADSUBSET" }, { "name": "fontSubstitution", "type": "FontSubstitutionPolicy", "description": "The font substitution policy.", "access": "read/write", "static": true, "value": "FontSubstitutionPolicy.SUBSTITUTEOBLIQUE" } ], "events": [], "methods": [] }, { "name": "PrintJobOptions", "kind": "Object", "description": "The print job options.", "properties": [ { "name": "artboardRange", "type": "string", "description": "Artboard Range to be printed if PrintAllArtboards is false.", "access": "read/write", "static": true, "value": "1-" }, { "name": "bitmapResolution", "type": "number", "description": "The bitmap resolution.", "access": "read/write", "static": true, "value": "0", "range": { "min": "0", "max": "" } }, { "name": "collate", "type": "boolean", "description": "Whether to collate print pages.", "access": "read/write", "static": true, "value": "false" }, { "name": "copies", "type": "number", "description": "The number of copies to print.", "access": "read/write", "static": true, "value": "1", "range": { "min": "1", "max": "" } }, { "name": "designation", "type": "PrintArtworkDesignation", "description": "The layers/objects to be printed.", "access": "read/write", "static": true, "value": "PrintArtworkDesignation.VISIBLEPRINTABLELAYERS" }, { "name": "file", "type": "File", "description": "The file to be printed to.", "access": "read/write", "static": true }, { "name": "name", "type": "string", "description": "The print job name.", "access": "read/write", "static": true }, { "name": "printAllArtboards", "type": "boolean", "description": "Whether to print all artboards.", "access": "read/write", "static": true, "value": "true" }, { "name": "printArea", "type": "PrintingBounds", "description": "The printing bounds.", "access": "read/write", "static": true, "value": "PrintingBounds.ARTBOARDBOUNDS" }, { "name": "printAsBitmap", "type": "boolean", "description": "Whether to print as bitmap.", "access": "read/write", "static": true, "value": "false" }, { "name": "reversePages", "type": "boolean", "description": "Print pages in reverse order.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "PrintOptions", "kind": "Object", "description": "The print options.", "properties": [ { "name": "PPDName", "type": "string", "description": "The name of the PPD to use.", "access": "read/write", "static": true }, { "name": "colorManagementOptions", "type": "PrintColorManagementOptions", "description": "The printing color management options.", "access": "read/write", "static": true }, { "name": "colorSeparationOptions", "type": "PrintColorSeparationOptions", "description": "The printing color separation options.", "access": "read/write", "static": true }, { "name": "coordinateOptions", "type": "PrintCoordinateOptions", "description": "The printing coordinate options.", "access": "read/write", "static": true }, { "name": "flattenerOptions", "type": "PrintFlattenerOptions", "description": "The printing flattener options.", "access": "read/write", "static": true }, { "name": "flattenerPreset", "type": "string", "description": "The transparency flattener preset name.", "access": "read/write", "static": true }, { "name": "fontOptions", "type": "PrintFontOptions", "description": "The printing font options.", "access": "read/write", "static": true }, { "name": "jobOptions", "type": "PrintJobOptions", "description": "The printing job options.", "access": "read/write", "static": true }, { "name": "pageMarksOptions", "type": "PrintPageMarksOptions", "description": "The printing page marks options.", "access": "read/write", "static": true }, { "name": "paperOptions", "type": "PrintPaperOptions", "description": "The paper options.", "access": "read/write", "static": true }, { "name": "postScriptOptions", "type": "PrintPostScriptOptions", "description": "The printing PostScript options.", "access": "read/write", "static": true }, { "name": "printPreset", "type": "string", "description": "The name of a print preset to use.", "access": "read/write", "static": true }, { "name": "printerName", "type": "string", "description": "The name of the printer to print to.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PrintOrientation", "kind": "Enumeration", "description": "The artwork printing orientation.", "properties": [ { "name": "AUTOROTATE", "type": "number", "description": "Auto Rotate.", "access": "readonly", "value": "4" }, { "name": "LANDSCAPE", "type": "number", "description": "Landscape.", "access": "readonly", "value": "1" }, { "name": "PORTRAIT", "type": "number", "description": "Portrait.", "access": "readonly", "value": "0" }, { "name": "REVERSELANDSCAPE", "type": "number", "description": "Reverse landscape.", "access": "readonly", "value": "3" }, { "name": "REVERSEPORTRAIT", "type": "number", "description": "Reverse portrait.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "PrintPageMarksOptions", "kind": "Object", "description": "The page marks options.", "properties": [ { "name": "bleedOffsetRect", "type": "number[]", "description": "The bleed offset rect.", "access": "read/write", "static": true }, { "name": "colorBars", "type": "boolean", "description": "Whether to enable color bars printing.", "access": "read/write", "static": true, "value": "false" }, { "name": "marksOffsetRect", "type": "number[]", "description": "The page marks offset rect.", "access": "read/write", "static": true }, { "name": "pageInfoMarks", "type": "boolean", "description": "Whether to enable page info marks printing.", "access": "read/write", "static": true, "value": "false" }, { "name": "pageMarksType", "type": "PageMarksTypes", "description": "The page marks style.", "access": "read/write", "static": true, "value": "PageMarksTypes.Roman" }, { "name": "registrationMarks", "type": "boolean", "description": "Whether to enable registration marks printing.", "access": "read/write", "static": true, "value": "false" }, { "name": "trimMarks", "type": "boolean", "description": "Whether to enable trim marks printing.", "access": "read/write", "static": true, "value": "false" }, { "name": "trimMarksWeight", "type": "number", "description": "Stroke weight of trim marks.", "access": "read/write", "static": true, "value": "0.125", "range": { "min": "0", "max": "" } } ], "events": [], "methods": [] }, { "name": "PrintPaperOptions", "kind": "Object", "description": "The paper options.", "properties": [ { "name": "height", "type": "number", "description": "The custom height (in points) for using the custom paper.", "access": "read/write", "static": true, "value": "0" }, { "name": "name", "type": "string", "description": "The paper's name.", "access": "read/write", "static": true }, { "name": "offset", "type": "number", "description": "Custom offset (in points) for using the custom paper.", "access": "read/write", "static": true, "value": "0" }, { "name": "transverse", "type": "boolean", "description": "Whether to transverse the artwork (rotate 90 degrees) on the custom paper.", "access": "read/write", "static": true, "value": "false" }, { "name": "width", "type": "number", "description": "The custom width (in points) for using the custom paper.", "access": "read/write", "static": true, "value": "0" } ], "events": [], "methods": [] }, { "name": "PrintPosition", "kind": "Enumeration", "description": "The artwork printing position on media.", "properties": [ { "name": "TRANSLATEBOTTOM", "type": "number", "description": "Translate to the bottom center of media.", "access": "readonly", "value": "8" }, { "name": "TRANSLATEBOTTOMLEFT", "type": "number", "description": "Translate to the bottom left of media.", "access": "readonly", "value": "7" }, { "name": "TRANSLATEBOTTOMRIGHT", "type": "number", "description": "Translate to the bottom right of media.", "access": "readonly", "value": "9" }, { "name": "TRANSLATECENTER", "type": "number", "description": "Translate to the center of media.", "access": "readonly", "value": "5" }, { "name": "TRANSLATELEFT", "type": "number", "description": "Translate to the left center of media.", "access": "readonly", "value": "4" }, { "name": "TRANSLATERIGHT", "type": "number", "description": "Translate to the right center of media.", "access": "readonly", "value": "6" }, { "name": "TRANSLATETOP", "type": "number", "description": "Translate to the top center of media.", "access": "readonly", "value": "2" }, { "name": "TRANSLATETOPLEFT", "type": "number", "description": "Translate to the top left of media.", "access": "readonly", "value": "1" }, { "name": "TRANSLATETOPRIGHT", "type": "number", "description": "Translate to the top right of media.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "PrintPostScriptOptions", "kind": "Object", "description": "The PostScript options.", "properties": [ { "name": "binaryPrinting", "type": "boolean", "description": "Whether to print in binary mode.", "access": "read/write", "static": true, "value": "false" }, { "name": "compatibleShading", "type": "boolean", "description": "Use PostScript level 1 compatible gradient and gradient mesh printing.", "access": "read/write", "static": true, "value": "false" }, { "name": "forceContinuousTone", "type": "boolean", "description": "Whether to force continuous tone.", "access": "read/write", "static": true, "value": "false" }, { "name": "imageCompression", "type": "PostScriptImageCompressionType", "description": "The image compression type.", "access": "read/write", "static": true, "value": "PostScriptImageCompressionType.IMAGECOMPRESSIONNONE" }, { "name": "negativePrinting", "type": "boolean", "description": "Whether to print in negative mode.", "access": "read/write", "static": true, "value": "false" }, { "name": "postScriptLevel", "type": "PrinterPostScriptLevelEnum", "description": "The PostScript language level.", "access": "read/write", "static": true, "value": "PrinterPostScriptLevelEnum.PSLEVEL2" }, { "name": "shadingResolution", "type": "number", "description": "The shading resolution.", "access": "read/write", "static": true, "value": "300", "range": { "min": "1", "max": "9600" } } ], "events": [], "methods": [] }, { "name": "PrintTiling", "kind": "Enumeration", "description": "The page tiling type.", "properties": [ { "name": "TILEFULLPAGES", "type": "number", "description": "Tile full pages.", "access": "readonly", "value": "1" }, { "name": "TILEIMAGEABLEAREAS", "type": "number", "description": "Tile imageable areas.", "access": "readonly", "value": "2" }, { "name": "TILESINGLEFULLPAGE", "type": "number", "description": "Tile single full page.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "Printer", "kind": "Object", "description": "An installed printer.", "properties": [ { "name": "name", "type": "string", "description": "The printer name.", "access": "read/write", "static": true }, { "name": "printerInfo", "type": "PrinterInfo", "description": "The printer information.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PrinterColorMode", "kind": "Enumeration", "description": "The printer color mode.", "properties": [ { "name": "BLACKANDWHITEPRINTER", "type": "number", "description": "Black and white printer.", "access": "readonly", "value": "2" }, { "name": "COLORPRINTER", "type": "number", "description": "Color printer.", "access": "readonly", "value": "0" }, { "name": "GRAYSCALEPRINTER", "type": "number", "description": "Grayscale printer.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "PrinterInfo", "kind": "Object", "description": "Printer information.", "properties": [ { "name": "binaryPrintingSupport", "type": "boolean", "description": "Does the printer support binary printing?", "access": "read/write", "static": true }, { "name": "colorSupport", "type": "PrinterColorMode", "description": "The printer color capability.", "access": "read/write", "static": true }, { "name": "customPaperSupport", "type": "boolean", "description": "Does the printer support custom paper size?", "access": "read/write", "static": true }, { "name": "customPaperTransverseSupport", "type": "boolean", "description": "Does the printer support custom paper transverse?", "access": "read/write", "static": true }, { "name": "deviceResolution", "type": "number", "description": "The printer default resolution.", "access": "read/write", "static": true }, { "name": "inRIPSeparationSupport", "type": "boolean", "description": "Does the printer support InRIP color separation?", "access": "read/write", "static": true }, { "name": "maxDeviceResolution", "type": "number", "description": "The printer maximum device resolution.", "access": "read/write", "static": true }, { "name": "maxPaperHeight", "type": "number", "description": "Custom paper's maximum height.", "access": "read/write", "static": true }, { "name": "maxPaperHeightOffset", "type": "number", "description": "Custom paper's maximum height offset.", "access": "read/write", "static": true }, { "name": "maxPaperWidth", "type": "number", "description": "Custom paper's maximum width.", "access": "read/write", "static": true }, { "name": "maxPaperWidthOffset", "type": "number", "description": "Custom paper's maximum width offset.", "access": "read/write", "static": true }, { "name": "minPaperHeight", "type": "number", "description": "Custom paper's minimum height.", "access": "read/write", "static": true }, { "name": "minPaperHeightOffset", "type": "number", "description": "Custom paper's minimum height offset.", "access": "read/write", "static": true }, { "name": "minPaperWidth", "type": "number", "description": "Custom paper's minimum width.", "access": "read/write", "static": true }, { "name": "minPaperWidthOffset", "type": "number", "description": "Custom paper's minimum width offset.", "access": "read/write", "static": true }, { "name": "paperSizes", "type": "Paper[]", "description": "The list of supported paper sizes.", "access": "read/write", "static": true }, { "name": "postScriptLevel", "type": "PrinterPostScriptLevelEnum", "description": "The PostScript level.", "access": "read/write", "static": true }, { "name": "printerType", "type": "PrinterTypeEnum", "description": "The printer type.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "PrinterPostScriptLevelEnum", "kind": "Enumeration", "description": "The PostScript levels supported by various printers.", "properties": [ { "name": "PSLEVEL1", "type": "number", "description": "PostScript Level 1.", "access": "readonly", "value": "1" }, { "name": "PSLEVEL2", "type": "number", "description": "PostScript Level 2.", "access": "readonly", "value": "2" }, { "name": "PSLEVEL3", "type": "number", "description": "PostScript Level 3.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "PrinterTypeEnum", "kind": "Enumeration", "description": "The printer type.", "properties": [ { "name": "NONPOSTSCRIPTPRINTER", "type": "number", "description": "Non PostScript printer.", "access": "readonly", "value": "2" }, { "name": "POSTSCRIPTPRINTER", "type": "number", "description": "PostScript printer.", "access": "readonly", "value": "1" }, { "name": "Unknown", "type": "number", "description": "Unknown printer type.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "PrintingBounds", "kind": "Enumeration", "description": "The printing bounds type.", "properties": [ { "name": "ARTBOARDBOUNDS", "type": "number", "description": "Use artboard bounds.", "access": "readonly", "value": "0" }, { "name": "ARTWORKBOUNDS", "type": "number", "description": "Use artwork bounds.", "access": "readonly", "value": "1" }, { "name": "CROPBOUNDS", "type": "number", "description": "Use crop bounds.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "RGBColor", "kind": "Object", "description": "An RGB color specification.", "extends": "Color", "properties": [ { "name": "blue", "type": "number", "description": "The blue color value (between 0.0 and 255.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "255.0" } }, { "name": "green", "type": "number", "description": "The green color value (between 0.0 and 255.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "255.0" } }, { "name": "red", "type": "number", "description": "The red color value (between 0.0 and 255.0)", "access": "read/write", "static": true, "value": "0.0", "range": { "min": "0.0", "max": "255.0" } } ], "events": [], "methods": [] }, { "name": "RadialRepeatConfig", "kind": "Object", "description": "Options for radial repaat art configuration.", "properties": [ { "name": "numberOfInstances", "type": "number", "description": "Number of instances of radial repeat art.", "access": "read/write", "static": true, "value": "8" }, { "name": "radius", "type": "number", "description": "Radius of radial repeat art.", "access": "read/write", "static": true, "value": "-1" }, { "name": "reverseOverlap", "type": "boolean", "description": "Reverse overlap of radial repeat art.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "RadialRepeatItem", "kind": "Object", "description": "A radial repeat item.", "extends": "PageItem", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "radialConfig", "type": "RadialRepeatConfig", "description": "Radial repeat config for repeat art.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "RadialRepeatItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "RadialRepeatItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "setRadialConfiguration", "returns": "void", "description": "Update the radial repeat art.", "parameters": [ { "name": "config", "type": "RadialRepeatConfig", "description": "Updated radial repeat configuration." }, { "name": "state", "type": "RadialRepeatUpdate", "description": "Specify which properties of radial repeat gets updated." } ] } ] }, { "name": "RadialRepeatItems", "kind": "Collection", "description": "A collection of radial repeat items.", "elementType": "RadialRepeatItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "RadialRepeatItem", "description": "Creates a radial repeat art.", "parameters": [ { "name": "sourceArt", "type": "any", "description": "The page item(s) to apply to." }, { "name": "config", "type": "RadialRepeatConfig", "description": "The radial repeat configuration." } ] }, { "name": "getByName", "returns": "RadialRepeatItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "RadialRepeatUpdate", "kind": "Enumeration", "description": "Each flag represent which property of radial repeat gets updated.", "properties": [ { "name": "NUMBEROFINSTANCES", "type": "number", "description": "Update number of instances of radial repeat art.", "access": "readonly", "value": "32" }, { "name": "RADIALALL", "type": "number", "description": "Update all the properties of radial repeat art.", "access": "readonly", "value": "127" }, { "name": "RADIUSOFART", "type": "number", "description": "Update the radius of radial repeat art.", "access": "readonly", "value": "2" }, { "name": "REVERSEOVERLAP", "type": "number", "description": "Update reverse overlap of radial repeat art.", "access": "readonly", "value": "64" } ], "events": [], "methods": [] }, { "name": "RasterEffectOptions", "kind": "Object", "description": "The document raster effects settings.", "properties": [ { "name": "antiAliasing", "type": "boolean", "description": "Should the resulting image be antialiased.", "access": "read/write", "static": true, "value": "false" }, { "name": "clippingMask", "type": "boolean", "description": "Should a clipping mask be created for the resulting image.", "access": "read/write", "static": true, "value": "false" }, { "name": "colorModel", "type": "RasterizationColorModel", "description": "The color model for the rasterization.", "access": "read/write", "static": true, "value": "RasterizationColorModel.DEFAULTCOLORMODEL" }, { "name": "convertSpotColors", "type": "boolean", "description": "Whether to convert all spot colors to process colors in the resulting image.", "access": "read/write", "static": true, "value": "false" }, { "name": "padding", "type": "number", "description": "The amount of white space (in points) to be added around the object during rasterization.", "access": "read/write", "static": true, "value": "0" }, { "name": "resolution", "type": "number", "description": "The rasterization resolution in dots-per-inch (dpi)", "access": "read/write", "static": true, "value": "300", "range": { "min": "72.0", "max": "2400.0" } }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "RasterImageLocation", "kind": "Enumeration", "description": "Decide where the raster images will be stored.", "properties": [ { "name": "EMBED", "type": "number", "description": "Embed the raster images in the svg file.", "access": "readonly", "value": "0" }, { "name": "LINK", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "PRESERVE", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "RasterItem", "kind": "Object", "description": "Raster artwork item.", "extends": "PageItem", "properties": [ { "name": "bitsPerChannel", "type": "number", "description": "The number of bits per channel.", "access": "readonly" }, { "name": "boundingBox", "type": "number[]", "description": "Dimensions of raster art object regardless of transformations.", "access": "read/write" }, { "name": "channels", "type": "number", "description": "The number of image channels.", "access": "readonly" }, { "name": "colorants", "type": "string[]", "description": "List of colorant names.", "access": "readonly" }, { "name": "colorizedGrayscale", "type": "boolean", "description": "Is the raster art a colorized grayscale image?", "access": "readonly" }, { "name": "contentVariable", "type": "any", "description": "The content variable bound to this raster art object.", "access": "read/write" }, { "name": "embedded", "type": "boolean", "description": "Is the raster art embedded within the illustration?", "access": "read/write" }, { "name": "file", "type": "File", "description": "The file containing the raster artwork.", "access": "readonly" }, { "name": "imageColorSpace", "type": "ImageColorSpace", "description": "The color space of the raster image.", "access": "readonly" }, { "name": "matrix", "type": "Matrix", "description": "The transformation matrix of the raster art object.", "access": "read/write" }, { "name": "overprint", "type": "boolean", "description": "Is the raster art overprinting?", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "status", "type": "RasterLinkState", "description": "Status of the linked image.", "access": "readonly" }, { "name": "transparent", "type": "boolean", "description": "Is the raster art transparent?", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "colorize", "returns": "void", "description": "Colorize the RasterItem with a CMYK or RGB Color.", "parameters": [ { "name": "rasterColor", "type": "Color", "description": "The color to use for coloring the TIFF image." } ] }, { "name": "duplicate", "returns": "RasterItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "RasterItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "trace", "returns": "PluginItem", "description": "Trace this raster object using default options. Reorders this raster to the source art.", "parameters": [] } ] }, { "name": "RasterItems", "kind": "Collection", "description": "", "elementType": "RasterItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "RasterItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "RasterLinkState", "kind": "Enumeration", "description": "The raster link state.", "properties": [ { "name": "DATAFROMFILE", "type": "number", "description": "Image data is from the linked file.", "access": "readonly", "value": "2" }, { "name": "DATAMODIFIED", "type": "number", "description": "Image data has been modified.", "access": "readonly", "value": "3" }, { "name": "NODATA", "type": "number", "description": "Image data is not set.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "RasterizationColorModel", "kind": "Enumeration", "description": "Controls the color model for the rasterization.", "properties": [ { "name": "BITMAP", "type": "number", "description": "Rasterize as 1-bit bitmap.", "access": "readonly", "value": "3" }, { "name": "DEFAULTCOLORMODEL", "type": "number", "description": "Rasterize in the default document color space.", "access": "readonly", "value": "1" }, { "name": "GRAYSCALE", "type": "number", "description": "Rasterize as grayscale image.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "RasterizeOptions", "kind": "Object", "description": "Options which may be supplied when rasterizing the artwork.", "properties": [ { "name": "antiAliasingMethod", "type": "AntiAliasingMethod", "description": "The type of antialiasing method.", "access": "read/write", "static": true, "value": "AntiAliasingMethod.ARTOPTIMIZED" }, { "name": "backgroundBlack", "type": "boolean", "description": "Should rasterize against a black background instead of white.", "access": "read/write", "static": true, "value": "false" }, { "name": "clippingMask", "type": "boolean", "description": "Should a clipping mask be created for the resulting image.", "access": "read/write", "static": true, "value": "false" }, { "name": "colorModel", "type": "RasterizationColorModel", "description": "The color model for the rasterization.", "access": "read/write", "static": true, "value": "RasterizationColorModel.DEFAULTCOLORMODEL" }, { "name": "convertSpotColors", "type": "boolean", "description": "Whether to convert all spot colors to process colors in the resulting image.", "access": "read/write", "static": true, "value": "false" }, { "name": "convertTextToOutlines", "type": "boolean", "description": "Should all text be converted to outlines before rasterization.", "access": "read/write", "static": true, "value": "false" }, { "name": "includeLayers", "type": "boolean", "description": "Should the resulting image incorporates the layer attributes (such as opacity and blend mode)", "access": "read/write", "static": true, "value": "false" }, { "name": "padding", "type": "number", "description": "The amount of white space (in points) to be added around the object during rasterization.", "access": "read/write", "static": true, "value": "0" }, { "name": "resolution", "type": "number", "description": "The rasterization resolution in dots-per-inch (dpi)", "access": "read/write", "static": true, "value": "300", "range": { "min": "72.0", "max": "2400.0" } }, { "name": "transparency", "type": "boolean", "description": "Should the resulting image use transparency.", "access": "read/write", "static": true, "value": "false" } ], "events": [], "methods": [] }, { "name": "Rectangle", "kind": "Collection", "description": "Describes a rectangle. This class is also a four-element collection.", "properties": [ { "name": "bottom", "type": "number", "description": "The bottom coordinate.", "access": "read/write" }, { "name": "height", "type": "number", "description": "The height.", "access": "read/write" }, { "name": "left", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "length", "type": "number", "description": "The array length.", "access": "readonly", "value": "4" }, { "name": "right", "type": "number", "description": "The right coordinate.", "access": "read/write" }, { "name": "top", "type": "number", "description": "The top coordinate.", "access": "read/write" }, { "name": "width", "type": "number", "description": "The width.", "access": "read/write" }, { "name": "x", "type": "number", "description": "The left coordinate.", "access": "read/write" }, { "name": "y", "type": "number", "description": "The top coordinate.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "RepeatGridShiftFlipType", "kind": "Enumeration", "description": "Grid Repeat shift and flip type.", "properties": [ { "name": "HORIZONTALANDVERTICALSF", "type": "number", "description": "Create a grid after shifting both alternate rows and columns by half or flip the alternate rows about both x and y axis.", "access": "readonly", "value": "3" }, { "name": "HORIZONTALSF", "type": "number", "description": "Create a grid after shifting alternate rows by half or flip the alternate rows about y axis.", "access": "readonly", "value": "1" }, { "name": "NOSF", "type": "number", "description": "Create a normal grid of arts.", "access": "readonly", "value": "0" }, { "name": "VERTICALSF", "type": "number", "description": "Create a grid after shifting alternate columns by half or flip the alternate rows about x axis.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "RulerUnits", "kind": "Enumeration", "description": "", "properties": [ { "name": "Centimeters", "type": "number", "description": "Ruler units are measured in centimeters.", "access": "readonly", "value": "3" }, { "name": "Feet", "type": "number", "description": "Ruler units are measured in pixels.", "access": "readonly", "value": "12" }, { "name": "FeetInches", "type": "number", "description": "Ruler units are measured in pixels.", "access": "readonly", "value": "9" }, { "name": "Inches", "type": "number", "description": "Ruler units are unknown.", "access": "readonly", "value": "2" }, { "name": "Meters", "type": "number", "description": "Ruler units are measured in pixels.", "access": "readonly", "value": "10" }, { "name": "Millimeters", "type": "number", "description": "Ruler units are measured in millimeters.", "access": "readonly", "value": "6" }, { "name": "Picas", "type": "number", "description": "Ruler units are measured in picas.", "access": "readonly", "value": "5" }, { "name": "Pixels", "type": "number", "description": "Ruler units are measured in pixels.", "access": "readonly", "value": "8" }, { "name": "Points", "type": "number", "description": "Ruler units are measured in points.", "access": "readonly", "value": "4" }, { "name": "Qs", "type": "number", "description": "Ruler units are measured in Qs.", "access": "readonly", "value": "7" }, { "name": "Unknown", "type": "number", "description": "Ruler units are unknown.", "access": "readonly", "value": "1" }, { "name": "Yards", "type": "number", "description": "Ruler units are measured in pixels.", "access": "readonly", "value": "11" } ], "events": [], "methods": [] }, { "name": "SVGCSSPropertyLocation", "kind": "Enumeration", "description": "", "properties": [ { "name": "ENTITIES", "type": "number", "description": "Style attributes with entity reference.", "access": "readonly", "value": "2" }, { "name": "PRESENTATIONATTRIBUTES", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "STYLEATTRIBUTES", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "STYLEELEMENTS", "type": "number", "description": "", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "SVGDTDVersion", "kind": "Enumeration", "description": "The version of the SVG DTD.", "properties": [ { "name": "SVG1_0", "type": "number", "description": "SVG 1.0.", "access": "readonly", "value": "1" }, { "name": "SVG1_1", "type": "number", "description": "SVG 1.1.", "access": "readonly", "value": "2" }, { "name": "SVGBASIC1_1", "type": "number", "description": "SVG Basic 1.1.", "access": "readonly", "value": "5" }, { "name": "SVGTINY1_1", "type": "number", "description": "SVG Tiny 1.1.", "access": "readonly", "value": "3" }, { "name": "SVGTINY1_1PLUS", "type": "number", "description": "SVG Tiny 1.1 Plus.", "access": "readonly", "value": "4" }, { "name": "SVGTINY1_2", "type": "number", "description": "SVG Tiny 1.2.", "access": "readonly", "value": "6" } ], "events": [], "methods": [] }, { "name": "SVGDocumentEncoding", "kind": "Enumeration", "description": "", "properties": [ { "name": "ASCII", "type": "number", "description": "ISO 8859-1.", "access": "readonly", "value": "1" }, { "name": "UTF16", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "UTF8", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "SVGFontSubsetting", "kind": "Enumeration", "description": "What fonts to include with the file?", "properties": [ { "name": "ALLGLYPHS", "type": "number", "description": "", "access": "readonly", "value": "7" }, { "name": "COMMONENGLISH", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "COMMONROMAN", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "GLYPHSUSED", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "GLYPHSUSEDPLUSENGLISH", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "GLYPHSUSEDPLUSROMAN", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "None", "type": "number", "description": "Use system fonts.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "SVGFontType", "kind": "Enumeration", "description": "What font type to include with the file?", "properties": [ { "name": "OUTLINEFONT", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "SVGFONT", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "SVGIdType", "kind": "Enumeration", "description": "Type of SVG Id.", "properties": [ { "name": "SVGIDMINIMAL", "type": "number", "description": "Style attributes with entity reference.", "access": "readonly", "value": "0" }, { "name": "SVGIDREGULAR", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "SVGIDUNIQUE", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "SaveOptions", "kind": "Enumeration", "description": "The options that may be applied when saving a file.", "properties": [ { "name": "DONOTSAVECHANGES", "type": "number", "description": "Do not save changes.", "access": "readonly", "value": "2" }, { "name": "PROMPTTOSAVECHANGES", "type": "number", "description": "Ask the user whether to save.", "access": "readonly", "value": "3" }, { "name": "SAVECHANGES", "type": "number", "description": "Save changes.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Screen", "kind": "Object", "description": "Color separation screen.", "properties": [ { "name": "name", "type": "string", "description": "The color separation screen name.", "access": "read/write", "static": true }, { "name": "screenInfo", "type": "ScreenInfo", "description": "The color separation screen information.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "ScreenInfo", "kind": "Object", "description": "Screen information.", "properties": [ { "name": "angle", "type": "number", "description": "The screen's angle (in degrees)", "access": "read/write", "static": true }, { "name": "defaultScreen", "type": "boolean", "description": "Is it the default screen?", "access": "read/write", "static": true }, { "name": "frequency", "type": "number", "description": "The screen's frequency.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "ScreenMode", "kind": "Enumeration", "description": "The screen mode.", "properties": [ { "name": "DESKTOP", "type": "number", "description": "Full screen with menu bar.", "access": "readonly", "value": "2" }, { "name": "FULLSCREEN", "type": "number", "description": "Full screen without menu bar.", "access": "readonly", "value": "3" }, { "name": "MULTIWINDOW", "type": "number", "description": "Display multiple windows.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "ScreenSpotFunction", "kind": "Object", "description": "Color separation screen spot function.", "properties": [ { "name": "name", "type": "string", "description": "The color separation screen spot function name.", "access": "read/write", "static": true }, { "name": "spotFunction", "type": "string", "description": "The spot function in terms of the PostScript commands.", "access": "read/write", "static": true } ], "events": [], "methods": [] }, { "name": "Spot", "kind": "Object", "description": "A custom color.", "properties": [ { "name": "color", "type": "Color", "description": "", "access": "read/write" }, { "name": "colorType", "type": "ColorModel", "description": "Type of the custom color.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The custom color's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "spotKind", "type": "SpotColorKind", "description": "Kind of the spot color (i.e. RGB, CMYK or LAB), it is the name of color kind contained in spot.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getInternalColor", "returns": "number[]", "description": "Gets the internal color of a spot.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SpotColor", "kind": "Object", "description": "Information about the spot color.", "extends": "Color", "properties": [ { "name": "spot", "type": "Spot", "description": "", "access": "read/write", "static": true }, { "name": "tint", "type": "number", "description": "Percentage level of tint to be applied to the spot color.", "access": "read/write", "static": true, "value": "100.0", "range": { "min": "0.0", "max": "100.0" } } ], "events": [], "methods": [] }, { "name": "SpotColorKind", "kind": "Enumeration", "description": "Custom color kind of the spot color.", "properties": [ { "name": "SPOTCMYK", "type": "number", "description": "Solid ink, expressed in four CMYK values.", "access": "readonly", "value": "0" }, { "name": "SPOTLAB", "type": "number", "description": "Lab color. Only valid for spot colors.", "access": "readonly", "value": "2" }, { "name": "SPOTRGB", "type": "number", "description": "Solid color, expressed as three RGB values.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "Spots", "kind": "Collection", "description": "A collection of custom spot colors.", "elementType": "Spot", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Spot", "description": "Create a spot color.", "parameters": [] }, { "name": "getByName", "returns": "Spot", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Stories", "kind": "Collection", "description": "A collection of stories.", "elementType": "Story", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "Story", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "Story", "kind": "Collection", "description": "A contiguous block of text.", "properties": [ { "name": "characters", "type": "Characters", "description": "All the characters in this text range.", "access": "readonly" }, { "name": "insertionPoints", "type": "InsertionPoints", "description": "All the insertion points in this text range.", "access": "readonly" }, { "name": "length", "type": "number", "description": "The number of characters in the story.", "access": "readonly" }, { "name": "lines", "type": "Lines", "description": "All the lines in this text range.", "access": "readonly" }, { "name": "paragraphs", "type": "Paragraphs", "description": "All the paragraphs in this text range.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "textFrames", "type": "TextFrameItems", "description": "The text frame items in this story.", "access": "readonly" }, { "name": "textRange", "type": "TextRange", "description": "The text range of the story.", "access": "readonly" }, { "name": "textRanges", "type": "TextRanges", "description": "All the text in this text range.", "access": "readonly" }, { "name": "textSelection", "type": "TextRange[]", "description": "The selected text (ranges) in the story.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "words", "type": "Words", "description": "All the words in this text range.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "StrokeCap", "kind": "Enumeration", "description": "The stroke cap.", "properties": [ { "name": "BUTTENDCAP", "type": "number", "description": "Butted cap.", "access": "readonly", "value": "1" }, { "name": "PROJECTINGENDCAP", "type": "number", "description": "Projecting cap.", "access": "readonly", "value": "3" }, { "name": "ROUNDENDCAP", "type": "number", "description": "Rounded cap.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "StrokeJoin", "kind": "Enumeration", "description": "The stroke joint.", "properties": [ { "name": "BEVELENDJOIN", "type": "number", "description": "Beveled joints.", "access": "readonly", "value": "3" }, { "name": "MITERENDJOIN", "type": "number", "description": "Mitered joints.", "access": "readonly", "value": "1" }, { "name": "ROUNDENDJOIN", "type": "number", "description": "Rounded joints.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "StyleRunAlignmentType", "kind": "Enumeration", "description": "The style run alignment.", "properties": [ { "name": "ROMANBASELINE", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "bottom", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "center", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "icfBottom", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "icfTop", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "top", "type": "number", "description": "", "access": "readonly", "value": "5" } ], "events": [], "methods": [] }, { "name": "Swatch", "kind": "Object", "description": "A color swatch.", "properties": [ { "name": "color", "type": "Color", "description": "The color information of the swatch.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The swatch's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SwatchGroup", "kind": "Object", "description": "A Swatch group.", "properties": [ { "name": "name", "type": "string", "description": "Name of the swatch group.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "addSpot", "returns": "void", "description": "Add a spot swatch to the group.", "parameters": [ { "name": "spot", "type": "Spot", "description": "The spot swatch to be added to the group." } ] }, { "name": "addSwatch", "returns": "void", "description": "Add a swatch to the group.", "parameters": [ { "name": "swatch", "type": "Swatch", "description": "The swatch to be added to the group." } ] }, { "name": "getAllSwatches", "returns": "Swatch[]", "description": "Get all swatches in the swatch group.", "parameters": [] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SwatchGroups", "kind": "Collection", "description": "A collection of Swatch groups.", "elementType": "SwatchGroup", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "SwatchGroup", "description": "Create a Swatch group.", "parameters": [] }, { "name": "getByName", "returns": "SwatchGroup", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "getSelected", "returns": "SwatchGroup[]", "description": "Get selected swatchGroups in the document.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Swatches", "kind": "Collection", "description": "A collection of swatches.", "elementType": "Swatch", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Swatch", "description": "Create a swatch.", "parameters": [] }, { "name": "getByName", "returns": "Swatch", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "getSelected", "returns": "Swatch[]", "description": "Get selected swatches in the document.", "parameters": [ { "name": "includeSwatchInGroup", "type": "boolean", "description": "The selected element should include swatches in group.", "optional": true } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Symbol", "kind": "Object", "description": "A symbol.", "properties": [ { "name": "name", "type": "string", "description": "The symbol's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "Symbol", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SymbolItem", "kind": "Object", "description": "An instance of a Symbol.", "extends": "PageItem", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "symbol", "type": "Symbol", "description": "The symbol that was used to create this symbol item.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "breakLink", "returns": "void", "description": "Break link to the symbol.", "parameters": [] }, { "name": "duplicate", "returns": "SymbolItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "SymbolItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SymbolItems", "kind": "Collection", "description": "A collection of symbol items.", "elementType": "SymbolItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "SymbolItem", "description": "An instance of a symbol item.", "parameters": [ { "name": "symbol", "type": "Symbol", "description": "The symbol to make an instance of." } ] }, { "name": "getByName", "returns": "SymbolItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SymbolRegistrationPoint", "kind": "Enumeration", "description": "The symbol registration point.", "properties": [ { "name": "SYMBOLBOTTOMLEFTPOINT", "type": "number", "description": "Bottom left point of symbol bounding box.", "access": "readonly", "value": "7" }, { "name": "SYMBOLBOTTOMMIDDLEPOINT", "type": "number", "description": "Bottom middle point of symbol bounding box.", "access": "readonly", "value": "8" }, { "name": "SYMBOLBOTTOMRIGHTPOINT", "type": "number", "description": "Bottom right point of symbol bounding box.", "access": "readonly", "value": "9" }, { "name": "SYMBOLCENTERPOINT", "type": "number", "description": "Center point of symbol bounding box.", "access": "readonly", "value": "5" }, { "name": "SYMBOLMIDDLELEFTPOINT", "type": "number", "description": "Middle left point of symbol bounding box.", "access": "readonly", "value": "4" }, { "name": "SYMBOLMIDDLERIGHTPOINT", "type": "number", "description": "Middle right point of symbol bounding box.", "access": "readonly", "value": "6" }, { "name": "SYMBOLTOPLEFTPOINT", "type": "number", "description": "Top left point of symbol bounding box.", "access": "readonly", "value": "1" }, { "name": "SYMBOLTOPMIDDLEPOINT", "type": "number", "description": "Top middle point of symbol bounding box.", "access": "readonly", "value": "2" }, { "name": "SYMBOLTOPRIGHTPOINT", "type": "number", "description": "Top right point of symbol bounding box.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "Symbols", "kind": "Collection", "description": "A collection of symbols.", "elementType": "Symbol", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Symbol", "description": "Create a symbol.", "parameters": [ { "name": "sourceArt", "type": "PageItem", "description": "The art item from which to make this symbol." }, { "name": "registrationPoint", "type": "SymbolRegistrationPoint", "description": "The symbol registration point.", "optional": true } ] }, { "name": "getByName", "returns": "Symbol", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SymmetryRepeatConfig", "kind": "Object", "description": "Options for symmetry repaat art configuration.", "properties": [ { "name": "axisRotationAngleInRadians", "type": "number", "description": "Symmetry axis rotation angle wrt x-axis in anti-clockwise fashion.", "access": "read/write", "static": true, "value": "1.57" } ], "events": [], "methods": [] }, { "name": "SymmetryRepeatItem", "kind": "Object", "description": "A symmetry repeat item.", "extends": "PageItem", "properties": [ { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "symmetryConfig", "type": "SymmetryRepeatConfig", "description": "Symmetry repeat config for repeat art.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "duplicate", "returns": "SymmetryRepeatItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "move", "returns": "SymmetryRepeatItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "setSymmetryConfiguration", "returns": "void", "description": "Update the symmetry repeat art.", "parameters": [ { "name": "config", "type": "SymmetryRepeatConfig", "description": "Updated symmetry repeat configuration." }, { "name": "state", "type": "SymmetryRepeatUpdate", "description": "Specify which properties of symmetry repeat gets updated." } ] } ] }, { "name": "SymmetryRepeatItems", "kind": "Collection", "description": "A collection of symmetry repeat items.", "elementType": "SymmetryRepeatItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "SymmetryRepeatItem", "description": "Creates a symmetry repeat art.", "parameters": [ { "name": "sourceArt", "type": "any", "description": "The page item(s) to apply to." }, { "name": "config", "type": "SymmetryRepeatConfig", "description": "The symmetry repeat configuration." } ] }, { "name": "getByName", "returns": "SymmetryRepeatItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "SymmetryRepeatUpdate", "kind": "Enumeration", "description": "Each flag represent which property of symmetry repeat gets updated.", "properties": [ { "name": "AXISROTATION", "type": "number", "description": "Update axis rotation angle wrt x-axis.", "access": "readonly", "value": "2" }, { "name": "SYMMETRYALL", "type": "number", "description": "Update all the properties of symmetry repeat art.", "access": "readonly", "value": "7" } ], "events": [], "methods": [] }, { "name": "TIFFByteOrder", "kind": "Enumeration", "description": "Byte Order of TIFF file.", "properties": [ { "name": "IBMPC", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "MACINTOSH", "type": "number", "description": "", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "TabStopAlignment", "kind": "Enumeration", "description": "The tab alignment.", "properties": [ { "name": "Center", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "Decimal", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "Left", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "Right", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "TabStopInfo", "kind": "Object", "description": "Tab stop information (returned by tab stops from a paragraph object)", "properties": [ { "name": "alignment", "type": "TabStopAlignment", "description": "The alignment of the tab stop.", "access": "read/write", "static": true, "value": "TabStopAlignment.Left" }, { "name": "decimalCharacter", "type": "string", "description": "The character used for decimal tab stops.", "access": "read/write", "static": true, "value": "." }, { "name": "leader", "type": "string", "description": "The leader dot.", "access": "read/write", "static": true }, { "name": "position", "type": "number", "description": "The position of the tab stop expressed in points.", "access": "read/write", "static": true, "value": "0" } ], "events": [], "methods": [] }, { "name": "Tag", "kind": "Object", "description": "A tag associated with a piece of artwork.", "properties": [ { "name": "name", "type": "string", "description": "The tag's name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "value", "type": "string", "description": "The data stored in this tag.", "access": "read/write" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "Tags", "kind": "Collection", "description": "The collection of tags associated with a page item.", "elementType": "Tag", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Tag", "description": "Create a tag.", "parameters": [] }, { "name": "getByName", "returns": "Tag", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "TextAntialias", "kind": "Enumeration", "description": "The type of text antialiasing.", "properties": [ { "name": "CRISP", "type": "number", "description": "Text on a path.", "access": "readonly", "value": "3" }, { "name": "NONE", "type": "number", "description": "Text from a point.", "access": "readonly", "value": "1" }, { "name": "SHARP", "type": "number", "description": "Text within an area.", "access": "readonly", "value": "2" }, { "name": "STRONG", "type": "number", "description": "Text on a path.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "TextFont", "kind": "Object", "description": "An installed font.", "properties": [ { "name": "axisVector", "type": "number[]", "description": "The font's Axis Vector.", "access": "readonly" }, { "name": "family", "type": "string", "description": "The font's family name.", "access": "readonly" }, { "name": "name", "type": "string", "description": "The font's full name.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "style", "type": "string", "description": "The font's style name.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [] }, { "name": "TextFonts", "kind": "Collection", "description": "A collection of fonts.", "elementType": "TextFont", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "TextFont", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "getCurrentFont", "returns": "string", "description": "Returns the current font name.", "parameters": [] }, { "name": "getFontByName", "returns": "TextFont", "description": "Get the Text Font with the font name , if not avaiable it will create the substitute font.", "parameters": [ { "name": "fontName", "type": "string", "description": "The name of the font to find or create substitute." } ] }, { "name": "isFontAvailable", "returns": "boolean", "description": "Check if any original font is present with the given name.", "parameters": [ { "name": "fontName", "type": "string", "description": "The name of the font to find." } ] } ] }, { "name": "TextFrameItem", "kind": "Object", "description": "Text frame item.", "extends": "PageItem", "properties": [ { "name": "anchor", "type": "Point", "description": "The position of the anchor point (start of base line for point text)", "access": "read/write" }, { "name": "antialias", "type": "TextAntialias", "description": "The type of a text anti-aliasing on text frame item.", "access": "read/write" }, { "name": "characters", "type": "Characters", "description": "All the characters in this text range.", "access": "readonly" }, { "name": "columnCount", "type": "number", "description": "The column count in the text frame (area text only)", "access": "read/write" }, { "name": "columnGutter", "type": "number", "description": "The column gutter in the text frame (area text only)", "access": "read/write" }, { "name": "contentVariable", "type": "any", "description": "The content variable bound to this text art item.", "access": "read/write" }, { "name": "contents", "type": "string", "description": "The text contents of this text frame.", "access": "read/write" }, { "name": "endTValue", "type": "number", "description": "The end position of text along a path, as a value relative to the path's segments (path text only)", "access": "read/write" }, { "name": "firstBaseline", "type": "FirstBaselineType", "description": "The first baseline offset type for text frame item (for Area Text only)", "access": "read/write" }, { "name": "firstBaselineMin", "type": "number", "description": "The first baseline offset minimum value for text frame item (for Area Text only)", "access": "read/write" }, { "name": "flowLinksHorizontally", "type": "boolean", "description": "Flow text between linked frame horizontally first. (area text only)", "access": "read/write" }, { "name": "insertionPoints", "type": "InsertionPoints", "description": "All the insertion points in this text range.", "access": "readonly" }, { "name": "kind", "type": "TextType", "description": "The type of a text frame item.", "access": "readonly" }, { "name": "lines", "type": "Lines", "description": "All the lines in this text range.", "access": "readonly" }, { "name": "matrix", "type": "Matrix", "description": "The transformation matrix of the text frame object.", "access": "readonly" }, { "name": "nextFrame", "type": "TextFrameItem", "description": "The linked text frame following this one.", "access": "read/write" }, { "name": "opticalAlignment", "type": "boolean", "description": "Is the optical alignment active?", "access": "read/write" }, { "name": "orientation", "type": "TextOrientation", "description": "The orientation of the text in the frame.", "access": "read/write" }, { "name": "paragraphs", "type": "Paragraphs", "description": "All the paragraphs in this text range.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "previousFrame", "type": "TextFrameItem", "description": "The linked text frame preceding this one.", "access": "read/write" }, { "name": "rowCount", "type": "number", "description": "The row count in the text frame (area text only)", "access": "read/write" }, { "name": "rowGutter", "type": "number", "description": "The row gutter in the text frame (area text only)", "access": "read/write" }, { "name": "spacing", "type": "number", "description": "The amount of spacing (path text only)", "access": "read/write" }, { "name": "startTValue", "type": "number", "description": "The start position of text along a path, as a value relative to the path's segments (path text only)", "access": "read/write" }, { "name": "story", "type": "Story", "description": "The story of the text frame.", "access": "readonly" }, { "name": "textPath", "type": "TextPath", "description": "The path for the text frame (area and path text)", "access": "readonly" }, { "name": "textRange", "type": "TextRange", "description": "The text range of the text frame.", "access": "readonly" }, { "name": "textRanges", "type": "TextRanges", "description": "All the text in this text range.", "access": "readonly" }, { "name": "textSelection", "type": "TextRange[]", "description": "The selected text (ranges) in the story.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "words", "type": "Words", "description": "All the words in this text range.", "access": "readonly" } ], "events": [], "methods": [ { "name": "convertAreaObjectToPointObject", "returns": "TextFrameItem", "description": "Convert Area Type Text Object To Point Type Object.", "parameters": [] }, { "name": "convertPointObjectToAreaObject", "returns": "TextFrameItem", "description": "Convert Point Type Text Object To Area Type Object.", "parameters": [] }, { "name": "createOutline", "returns": "GroupItem", "description": "Convert text item to path items.", "parameters": [] }, { "name": "duplicate", "returns": "TextFrameItem", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "generateThumbnailWithTextFrameProperties", "returns": "void", "description": "Generates the thumbnail with the properties of first character in the text frame.", "parameters": [ { "name": "textString", "type": "string", "description": "The text string which is to be used in the thumbnail generation." }, { "name": "fontSize", "type": "number", "description": "The size in points of the text string." }, { "name": "textColor", "type": "Color", "description": "The color of the text string." }, { "name": "destinationPath", "type": "File", "description": "The location at which the thumbnail is to be stored." } ] }, { "name": "move", "returns": "TextFrameItem", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "TextFrameItems", "kind": "Collection", "description": "A collection of text frame items.", "elementType": "TextFrameItem", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "TextFrameItem", "description": "Create a point text frame item.", "parameters": [] }, { "name": "areaText", "returns": "TextFrameItem", "description": "Create an area text frame item.", "parameters": [ { "name": "textPath", "type": "PathItem", "description": "The path item associated with the text frame." }, { "name": "orientation", "type": "TextOrientation", "description": "The orientation of the text.", "optional": true }, { "name": "baseFrame", "type": "TextFrameItem", "description": "The base text frame if it has one.", "optional": true }, { "name": "postFix", "type": "boolean", "description": "Whether to postfix/prefix the new text frame to the specified base text frame.", "optional": true } ] }, { "name": "getByName", "returns": "TextFrameItem", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "pathText", "returns": "TextFrameItem", "description": "Create an on-path text frame item.", "parameters": [ { "name": "textPath", "type": "PathItem", "description": "The path item associated with the text frame." }, { "name": "startTValue", "type": "number", "description": "The start position of text along a path, as a value relative to the path's segments (path text only)", "optional": true }, { "name": "endTValue", "type": "number", "description": "The end position of text along a path, as a value relative to the path's segments (path text only)", "optional": true }, { "name": "orientation", "type": "TextOrientation", "description": "The orientation of the text.", "optional": true }, { "name": "baseFrame", "type": "TextFrameItem", "description": "The base text frame if it has one.", "optional": true }, { "name": "postFix", "type": "boolean", "description": "Whether to postfix/prefix the new text frame to the specified base text frame.", "optional": true } ] }, { "name": "pointText", "returns": "TextFrameItem", "description": "Create a point text frame item.", "parameters": [ { "name": "anchor", "type": "Point", "description": "The position (coordinates) of the anchor point." }, { "name": "orientation", "type": "TextOrientation", "description": "The orientation of the text.", "optional": true } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "TextOrientation", "kind": "Enumeration", "description": "The orientation.", "properties": [ { "name": "HORIZONTAL", "type": "number", "description": "Horizontal orientation.", "access": "readonly", "value": "0" }, { "name": "VERTICAL", "type": "number", "description": "Vertical orientation.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "TextPath", "kind": "Object", "description": "A text path item.", "properties": [ { "name": "area", "type": "number", "description": "The area of this path in square points.", "access": "readonly" }, { "name": "blendingMode", "type": "BlendModes", "description": "The mode used when compositing an object.", "access": "read/write" }, { "name": "clipping", "type": "boolean", "description": "Should this be used as a clipping path?", "access": "read/write" }, { "name": "closed", "type": "boolean", "description": "Is this path closed?", "access": "read/write" }, { "name": "editable", "type": "boolean", "description": "Can the text path be modified.", "access": "readonly" }, { "name": "evenodd", "type": "boolean", "description": "Should the even-odd rule be used to determine insideness?", "access": "read/write" }, { "name": "fillColor", "type": "Color", "description": "Fill color.", "access": "read/write" }, { "name": "fillOverprint", "type": "boolean", "description": "Will art beneath a filled object be overprinted?", "access": "read/write" }, { "name": "filled", "type": "boolean", "description": "Should the path be filled?", "access": "read/write" }, { "name": "guides", "type": "boolean", "description": "Is this path a guide object?", "access": "read/write" }, { "name": "height", "type": "number", "description": "The height of the text path.", "access": "read/write", "range": { "min": "0.0", "max": "16348.0" } }, { "name": "left", "type": "number", "description": "The left position of the text path.", "access": "read/write" }, { "name": "note", "type": "string", "description": "Note assigned to the path.", "access": "read/write" }, { "name": "opacity", "type": "number", "description": "The object's opacity (between 0.0 and 100.0)", "access": "read/write", "range": { "min": "0.0", "max": "100.0" } }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathPoints", "type": "PathPoints", "description": "", "access": "readonly" }, { "name": "polarity", "type": "PolarityValues", "description": "The polarity the path.", "access": "read/write" }, { "name": "position", "type": "Point", "description": "The position of the top left corner of the text path.", "access": "read/write" }, { "name": "resolution", "type": "number", "description": "The resolution of the path.", "access": "read/write" }, { "name": "selectedPathPoints", "type": "ObjectArray", "description": "All the selected points in the path.", "access": "readonly" }, { "name": "strokeCap", "type": "StrokeCap", "description": "Type of line capping.", "access": "read/write" }, { "name": "strokeColor", "type": "Color", "description": "Stroke color.", "access": "read/write" }, { "name": "strokeDashOffset", "type": "number", "description": "The default distance into the dash pattern at which the pattern should be started.", "access": "read/write" }, { "name": "strokeDashes", "type": "number[]", "description": "Dash lengths (set to {} for a solid line)", "access": "read/write" }, { "name": "strokeJoin", "type": "StrokeJoin", "description": "Type of joints.", "access": "read/write" }, { "name": "strokeMiterLimit", "type": "number", "description": "Whether a join is mitered (pointed) or beveled (squared-off)", "access": "read/write" }, { "name": "strokeOverprint", "type": "boolean", "description": "Will art beneath a stroked object be overprinted?", "access": "read/write" }, { "name": "strokeWidth", "type": "number", "description": "Width of stroke.", "access": "read/write" }, { "name": "stroked", "type": "boolean", "description": "Should the path be stroked?", "access": "read/write" }, { "name": "top", "type": "number", "description": "The top position of the text path.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "width", "type": "number", "description": "The width of the text path.", "access": "read/write", "range": { "min": "0.0", "max": "16348.0" } } ], "events": [], "methods": [ { "name": "setEntirePath", "returns": "void", "description": "Set the path using the provided array of anchor points.", "parameters": [ { "name": "pathPoints", "type": "any[]", "description": "Array of anchor values for the path points." } ] } ] }, { "name": "TextPreservePolicy", "kind": "Enumeration", "description": "Text preserve policy used by FXG file format.", "properties": [ { "name": "AUTOMATICALLYCONVERTTEXT", "type": "number", "description": "Automatically convert text.", "access": "readonly", "value": "4" }, { "name": "KEEPTEXTEDITABLE", "type": "number", "description": "Preserve the editability of text.", "access": "readonly", "value": "3" }, { "name": "OUTLINETEXT", "type": "number", "description": "Preserve the appearance of text by outlining it.", "access": "readonly", "value": "1" }, { "name": "RASTERIZETEXT", "type": "number", "description": "Preserve the appearance of text by rasterizing it.", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "TextRange", "kind": "Collection", "description": "A range of characters from a text item.", "properties": [ { "name": "characterAttributes", "type": "CharacterAttributes", "description": "The character properties for the text range.", "access": "readonly" }, { "name": "characterOffset", "type": "number", "description": "Offset of the first character of the range from the beginning of the story, in characters.", "access": "read/write" }, { "name": "characterStyles", "type": "CharacterStyles", "description": "List of referenced character styles in the text range.", "access": "readonly" }, { "name": "characters", "type": "Characters", "description": "All the characters in this text range.", "access": "readonly" }, { "name": "contents", "type": "string", "description": "The text string.", "access": "read/write" }, { "name": "end", "type": "number", "description": "End index of the text range.", "access": "read/write" }, { "name": "insertionPoints", "type": "InsertionPoints", "description": "All the insertion points in this text range.", "access": "readonly" }, { "name": "kerning", "type": "number", "description": "Controls the spacing between two characters (in milli-ems)", "access": "read/write" }, { "name": "length", "type": "number", "description": "Length of text range.", "access": "read/write", "range": { "min": "0", "max": "" } }, { "name": "lines", "type": "Lines", "description": "All the lines in this text range.", "access": "readonly" }, { "name": "paragraphAttributes", "type": "ParagraphAttributes", "description": "The paragraph properties for the text range.", "access": "readonly" }, { "name": "paragraphStyles", "type": "ParagraphStyles", "description": "List of referenced paragraph styles in the text range.", "access": "readonly" }, { "name": "paragraphs", "type": "Paragraphs", "description": "All the paragraphs in this text range.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "start", "type": "number", "description": "Start index of the text range.", "access": "read/write" }, { "name": "story", "type": "Story", "description": "The story of the text range.", "access": "readonly" }, { "name": "textRanges", "type": "TextRanges", "description": "All the text in this text range.", "access": "readonly" }, { "name": "textSelection", "type": "TextRange[]", "description": "The selected text (ranges) in the text range.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "words", "type": "Words", "description": "All the words in this text range.", "access": "readonly" } ], "events": [], "methods": [ { "name": "changeCaseTo", "returns": "void", "description": "Change the capitalization of text.", "parameters": [ { "name": "type", "type": "CaseChangeType", "description": "The type of case." } ] }, { "name": "deSelect", "returns": "void", "description": "Deselect the text range.", "parameters": [] }, { "name": "duplicate", "returns": "TextRange", "description": "Duplicate this object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "getParagraphLength", "returns": "number", "description": "Get the length of the first paragraph.", "parameters": [] }, { "name": "getTextRunLength", "returns": "number", "description": "Get the length of the first text run.", "parameters": [] }, { "name": "move", "returns": "TextRange", "description": "Move the object.", "parameters": [ { "name": "relativeObject", "type": "Object", "description": "" }, { "name": "insertionLocation", "type": "ElementPlacement", "description": "" } ] }, { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] }, { "name": "select", "returns": "void", "description": "Select the text range.", "parameters": [ { "name": "addToDocument", "type": "boolean", "description": "Whether to add the text range to the document text selection.", "optional": true } ] } ] }, { "name": "TextRanges", "kind": "Collection", "description": "A collection of text range items.", "elementType": "TextRange", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "TextRange", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "TextType", "kind": "Enumeration", "description": "The type of text art.", "properties": [ { "name": "AREATEXT", "type": "number", "description": "Text within an area.", "access": "readonly", "value": "1" }, { "name": "PATHTEXT", "type": "number", "description": "Text on a path.", "access": "readonly", "value": "2" }, { "name": "POINTTEXT", "type": "number", "description": "Text from a point.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "TracingColorType", "kind": "Enumeration", "description": "The input color type Full Color or Limited colors.", "properties": [ { "name": "TRACINGFULLCOLOR", "type": "number", "description": "Use Full colors for Tracing.", "access": "readonly", "value": "1" }, { "name": "TRACINGLIMITEDCOLOR", "type": "number", "description": "Use Limited colors for Tracing.", "access": "readonly", "value": "0" } ], "events": [], "methods": [] }, { "name": "TracingMethodType", "kind": "Enumeration", "description": "The tracing method: abutting and overlapping.", "properties": [ { "name": "TRACINGMETHODABUTTING", "type": "number", "description": "Tracing abutting method.", "access": "readonly", "value": "0" }, { "name": "TRACINGMETHODOVERLAPPING", "type": "number", "description": "Tracing overlapping method.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "TracingModeType", "kind": "Enumeration", "description": "The tracing mode: color, grayscale, black and white.", "properties": [ { "name": "TRACINGMODEBLACKANDWHITE", "type": "number", "description": "Black and white tracing mode.", "access": "readonly", "value": "2" }, { "name": "TRACINGMODECOLOR", "type": "number", "description": "Color tracing mode.", "access": "readonly", "value": "0" }, { "name": "TRACINGMODEGRAY", "type": "number", "description": "Grayscale tracing mode.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "TracingObject", "kind": "Object", "description": "A tracing object.", "properties": [ { "name": "anchorCount", "type": "number", "description": "The number of anchors in the tracing result.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathCount", "type": "number", "description": "The number of paths in the tracing result.", "access": "readonly" }, { "name": "sourceArt", "type": "PageItem", "description": "The source art used when creating a new tracing object.", "access": "readonly" }, { "name": "tracingOptions", "type": "TracingOptions", "description": "The options used when tracing the artwork.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "usedColorCount", "type": "number", "description": "The number of colors used in the tracing result.", "access": "readonly" } ], "events": [], "methods": [ { "name": "expandTracing", "returns": "GroupItem", "description": "Expand the tracing to paths. Deletes this tracing object.", "parameters": [ { "name": "viewed", "type": "boolean", "description": "Expand as viewed with the raster and vector view modes.", "optional": true } ] }, { "name": "releaseTracing", "returns": "PageItem", "description": "Release the source artwork for the tracing object. Deletes this tracing object.", "parameters": [] } ] }, { "name": "TracingOptions", "kind": "Object", "description": "Tracing options that guide the tracing process.", "properties": [ { "name": "colorFidelity", "type": "number", "description": "ColorFidelity when TracingColorTypeValue is TracingFullColor.", "access": "read/write" }, { "name": "colorGroup", "type": "string", "description": "The color group name used for tracing. Use 'All' or any color group name available in color Palette (library).", "access": "read/write" }, { "name": "cornerFidelity", "type": "number", "description": "Corner fidelity for tracing.", "access": "read/write" }, { "name": "fills", "type": "boolean", "description": "Tracing with fills. Fills, Strokes or both must be on.", "access": "read/write" }, { "name": "grayLevels", "type": "number", "description": "The gray levels for a grayscale mode tracing..", "access": "read/write", "range": { "min": "1", "max": "256" } }, { "name": "ignoreWhite", "type": "boolean", "description": "Controls whether to ignore white fill color. Works only if TracingMethod is TracingMethodAbutting and mode is Black and white.", "access": "read/write" }, { "name": "maxStrokeWeight", "type": "number", "description": "Maximum stroke weight (stroke only).", "access": "read/write" }, { "name": "noiseFidelity", "type": "number", "description": "Specifies minimum area of pixels to be vectorized.", "access": "read/write" }, { "name": "palette", "type": "string", "description": "The color palette (Library) name used for tracing. Use 'Document Library' or any other imported library name.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "pathFidelity", "type": "number", "description": "Path fidelity for tracing.", "access": "read/write" }, { "name": "preset", "type": "string", "description": "The name of the preset in use. Read-only.", "access": "readonly" }, { "name": "snapCurveToLines", "type": "boolean", "description": "Controls whether to snap curve to lines.", "access": "read/write" }, { "name": "strokes", "type": "boolean", "description": "Tracing with strokes. Fills, Strokes or both must be on.", "access": "read/write" }, { "name": "threshold", "type": "number", "description": "The threshold value for a black and white mode tracing.", "access": "read/write", "range": { "min": "1", "max": "256" } }, { "name": "tracingColorTypeValue", "type": "TracingColorType", "description": "Color Type used for tracing, TracingLimitedColor or TracingFullColor .", "access": "read/write" }, { "name": "tracingColors", "type": "number", "description": "Maximum number of colors allowed for tracing when TracingColorTypeValue is TracingLimitedColor.", "access": "read/write" }, { "name": "tracingMethod", "type": "TracingMethodType", "description": "Method for tracing, either abutting or adjoining paths.", "access": "read/write" }, { "name": "tracingMode", "type": "TracingModeType", "description": "The tracing mode: color, gray, black and white.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "viewMode", "type": "ViewType", "description": "The visualization mode.", "access": "read/write" } ], "events": [], "methods": [ { "name": "loadFromPreset", "returns": "boolean", "description": "Load options from preset.", "parameters": [ { "name": "presetName", "type": "string", "description": "The name of the preset." } ] }, { "name": "storeToPreset", "returns": "boolean", "description": "Store options to a preset kAiVectorizeSuite. Will overwrite an existing (unlocked) preset if names match.", "parameters": [ { "name": "presetName", "type": "string", "description": "The name of the preset." } ] } ] }, { "name": "Transformation", "kind": "Enumeration", "description": "The transformation type.", "properties": [ { "name": "BOTTOM", "type": "number", "description": "Transform relative to the object's bottom edge.", "access": "readonly", "value": "7" }, { "name": "BOTTOMLEFT", "type": "number", "description": "Transform relative to the object's bottom left corner.", "access": "readonly", "value": "4" }, { "name": "BOTTOMRIGHT", "type": "number", "description": "Transform relative to the object's bottom right corner.", "access": "readonly", "value": "10" }, { "name": "CENTER", "type": "number", "description": "Transform relative to the object's center.", "access": "readonly", "value": "6" }, { "name": "DOCUMENTORIGIN", "type": "number", "description": "Transform relative to the illustration's page origin.", "access": "readonly", "value": "1" }, { "name": "LEFT", "type": "number", "description": "Transform relative to the object's left edge.", "access": "readonly", "value": "3" }, { "name": "RIGHT", "type": "number", "description": "Transform relative to the object's right edge.", "access": "readonly", "value": "9" }, { "name": "TOP", "type": "number", "description": "Transform relative to the object's top edge.", "access": "readonly", "value": "5" }, { "name": "TOPLEFT", "type": "number", "description": "Transform relative to the object's top left corner.", "access": "readonly", "value": "2" }, { "name": "TOPRIGHT", "type": "number", "description": "Transform relative to the object's top right corner.", "access": "readonly", "value": "8" } ], "events": [], "methods": [] }, { "name": "TrappingType", "kind": "Enumeration", "description": "The trapping type.", "properties": [ { "name": "IGNOREOPAQUE", "type": "number", "description": "Ignore opaque trapping type.", "access": "readonly", "value": "3" }, { "name": "NORMALTRAPPING", "type": "number", "description": "Normal trapping type.", "access": "readonly", "value": "0" }, { "name": "OPAQUE", "type": "number", "description": "Opaque trapping type.", "access": "readonly", "value": "2" }, { "name": "TRANSPARENT", "type": "number", "description": "Transparent trapping type.", "access": "readonly", "value": "1" } ], "events": [], "methods": [] }, { "name": "UserInteractionLevel", "kind": "Enumeration", "description": "COM user interaction enumeration.", "properties": [ { "name": "DISPLAYALERTS", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "DONTDISPLAYALERTS", "type": "number", "description": "", "access": "readonly", "value": "-1" } ], "events": [], "methods": [] }, { "name": "Variable", "kind": "Object", "description": "Dynamic object used to create data-driven graphics.", "properties": [ { "name": "kind", "type": "VariableKind", "description": "The variable's type.", "access": "read/write" }, { "name": "name", "type": "string", "description": "The name of this variable.", "access": "read/write" }, { "name": "pageItems", "type": "PageItems", "description": "All the artwork in this document.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "remove", "returns": "void", "description": "Deletes this object.", "parameters": [] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "VariableKind", "kind": "Enumeration", "description": "", "properties": [ { "name": "GRAPH", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "IMAGE", "type": "number", "description": "", "access": "readonly", "value": "4" }, { "name": "TEXTUAL", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "Unknown", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "VISIBILITY", "type": "number", "description": "", "access": "readonly", "value": "2" } ], "events": [], "methods": [] }, { "name": "Variables", "kind": "Collection", "description": "A collection of variables.", "elementType": "Variable", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "Variable", "description": "Create a variable.", "parameters": [] }, { "name": "getByName", "returns": "Variable", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "View", "kind": "Object", "description": "A view.", "properties": [ { "name": "bounds", "type": "number[]", "description": "The bounding rectangle of this view.", "access": "readonly" }, { "name": "centerPoint", "type": "Point", "description": "The center point of this view.", "access": "read/write" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "rotate", "type": "number", "description": "The rotation angle of this view.", "access": "read/write" }, { "name": "screenMode", "type": "ScreenMode", "description": "The mode of display.", "access": "read/write" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" }, { "name": "visibleZoom", "type": "number", "description": "The zoom factor of this view that is visible to user.", "access": "read/write" }, { "name": "zoom", "type": "number", "description": "The zoom factor of this view.", "access": "read/write" } ], "events": [], "methods": [] }, { "name": "ViewType", "kind": "Enumeration", "description": "Controls the type of vector view.", "properties": [ { "name": "TRACINGVIEWIMAGE", "type": "number", "description": "View Source Image.", "access": "readonly", "value": "4" }, { "name": "TRACINGVIEWVECTOROUTLINES", "type": "number", "description": "View just the paths.", "access": "readonly", "value": "2" }, { "name": "TRACINGVIEWVECTOROUTLINESWITHTRACING", "type": "number", "description": "View paths and transparent fills.", "access": "readonly", "value": "1" }, { "name": "TRACINGVIEWVECTORTRACINGRESULT", "type": "number", "description": "View artwork.", "access": "readonly", "value": "0" }, { "name": "TRACINGVIEWVECTORWITHTRANSPARENTIMAGE", "type": "number", "description": "View Outlines with Transparent Image.", "access": "readonly", "value": "3" } ], "events": [], "methods": [] }, { "name": "Views", "kind": "Collection", "description": "A collection of views.", "elementType": "View", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "getByName", "returns": "View", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] } ] }, { "name": "WariChuJustificationType", "kind": "Enumeration", "description": "The Wari-Chu alignment type.", "properties": [ { "name": "Center", "type": "number", "description": "", "access": "readonly", "value": "2" }, { "name": "Left", "type": "number", "description": "", "access": "readonly", "value": "0" }, { "name": "Right", "type": "number", "description": "", "access": "readonly", "value": "1" }, { "name": "WARICHUAUTOJUSTIFY", "type": "number", "description": "", "access": "readonly", "value": "7" }, { "name": "WARICHUFULLJUSTIFY", "type": "number", "description": "", "access": "readonly", "value": "6" }, { "name": "WARICHUFULLJUSTIFYLASTLINECENTER", "type": "number", "description": "", "access": "readonly", "value": "5" }, { "name": "WARICHUFULLJUSTIFYLASTLINELEFT", "type": "number", "description": "", "access": "readonly", "value": "3" }, { "name": "WARICHUFULLJUSTIFYLASTLINERIGHT", "type": "number", "description": "", "access": "readonly", "value": "4" } ], "events": [], "methods": [] }, { "name": "Words", "kind": "Collection", "description": "A collection of words.", "elementType": "TextRange", "properties": [ { "name": "length", "type": "number", "description": "Number of elements in the collection.", "access": "readonly" }, { "name": "parent", "type": "The", "description": "The object's container.", "access": "readonly" }, { "name": "typename", "type": "string", "description": "The class name of the object.", "access": "readonly" } ], "events": [], "methods": [ { "name": "add", "returns": "TextRange", "description": "Create a word.", "parameters": [ { "name": "contents", "type": "string", "description": "The text string." } ] }, { "name": "addBefore", "returns": "TextRange", "description": "", "parameters": [ { "name": "contents", "type": "string", "description": "The text string." } ] }, { "name": "getByName", "returns": "TextRange", "description": "Get the first element in the collection with the provided name.", "parameters": [ { "name": "name", "type": "string", "description": "" } ] }, { "name": "removeAll", "returns": "void", "description": "Deletes all elements.", "parameters": [] } ] }, { "name": "ZOrderMethod", "kind": "Enumeration", "description": "How to re-arrange the art item.", "properties": [ { "name": "BRINGFORWARD", "type": "number", "description": "Move art one step forward in it's group or layer.", "access": "readonly", "value": "2" }, { "name": "BRINGTOFRONT", "type": "number", "description": "Move art to front of it's group or layer.", "access": "readonly", "value": "1" }, { "name": "SENDBACKWARD", "type": "number", "description": "Move art one step backwards in it's group or layer.", "access": "readonly", "value": "3" }, { "name": "SENDTOBACK", "type": "number", "description": "Move art to back of it's group or layer.", "access": "readonly", "value": "4" } ], "events": [], "methods": [] } ] }