Scripter2 API

Scripter2 API is described below. This is a reference for the actual documentation of new scripter.

The new Scripter is composed of different modules, which are either accessible externally, or via methods of other apis.

• Scripter (Main API)
• Document API
• Page API
• Color API
• Layer API
• Printer API
• PDF File API
• Text API
• Dialogs API
• Preferences API
• Window API

Scripter

Properties

• activeDocument

This property return DocumentAPI object.

Usage:

document = Scripter.activeDocument

Here document will represent the active document, and is of type DocumentAPI

• activeWindow
• colors

Methods

• openDocument
• newDocument

Document API

Properties

• available
• margins
• modified
• activePage
• pageCount
• activeItem
• dimensions
• items
• selection
• colors
• layers

Methods

Layer Methods in activeDocument

• newLayer
• removeLayer
• getActiveLayer
• getActiveLayerName
• setActiveLayer

Color Methods in activeDocument

• newColorCMYK
• newColorRGB
• getColor

Printer method

• Printer

Image Export methods

• supportedImageTypes
• exportAsImages

Margins API

Properties

• top
• left
• right
• bottom

Dimensions API

Properties

• width
• height

Page API

Properties

• number
• items
• position
• selection

Methods

• newRectangle
• newEllipse
• newImage
• newText
• newLine
• placeSVG
• placeODG
• placeEPS
• placeSXD
• savePageAsEPS

Layer API

Properties

• name
• id
• level
• printable
• viewable
• editable
• flowControl
• outlineMode
• transparency
• blendMode
• active

Color API

Properties

• name
• spotColor

Methods

• changeCMYK
• changeRGB
• replace
• remove