• Global community
    • Language:
      • Deutsch
      • English
      • Español
      • Français
      • Português
  • 日本語コミュニティ
    Dedicated community for Japanese speakers
  • 한국 커뮤니티
    Dedicated community for Korean speakers
Exit
2

What's New in Illustrator Scripting CC2018

Community Expert ,
Oct 21, 2017 Oct 21, 2017

Copy link to clipboard

Copied

CC2018

New Class

Asset

Adobe Illustrator 22 Type Library

An (exportable) asset.

Properties

Asset.assetID  (Read Only)

Data Type: Int32

Adobe Illustrator 22 Type Library

The UID for the asset which is unique within a document.

Asset.assetName

Data Type: string

Adobe Illustrator 22 Type Library

Name of the asset.

Asset.parent  (Read Only)

Data Type: Object

Adobe Illustrator 22 Type Library

The object's container.

Asset.typename  (Read Only)

Data Type: string

Adobe Illustrator 22 Type Library

The class name of the object.

Methods

Asset.getNormalizedName (): string

Adobe Illustrator 22 Type Library

Gets the normalized name without special characters, such that it can be used as a file name.

Asset.remove ()

Adobe Illustrator 22 Type Library

Deletes this object.

Asset.removeAll ()

Adobe Illustrator 22 Type Library

Deletes all elements.

New Collection

Assets

Adobe Illustrator 22 Type Library

A collection of assets.

Properties

Assets.length  (Read Only)

Data Type: int

Adobe Illustrator 22 Type Library

Number of elements in the collection.

Assets.parent  (Read Only)

Data Type: Object

Adobe Illustrator 22 Type Library

The object's container.

Assets.typename  (Read Only)

Data Type: string

Adobe Illustrator 22 Type Library

The class name of the object.

Methods

Assets.add (sourceArt:any): Asset

Adobe Illustrator 22 Type Library

Creates an asset from the given art(s)

sourceArt: Data Type: any

The page item(s) to apply to.

Assets.addFromSelection (): Asset

Adobe Illustrator 22 Type Library

Creates an asset from the selected arts.

Assets.getByID (assetID: Int32 😞 Asset

Adobe Illustrator 22 Type Library

Gets the asset with the specified AssetID.

assetID: Data Type: Int32

The UID of the asset.

Assets.getByName (name: string 😞 Asset

Adobe Illustrator 22 Type Library

Get the first element in the collection with the provided name.

name: Data Type: string

Assets.getByName (name: string 😞 Asset

Adobe Illustrator 22 Type Library

Get the first element in the collection with the provided name.

name: Data Type: string

Assets.remove (assetID: Int32 )

Adobe Illustrator 22 Type Library

Deletes the asset with specified id.

assetID: Data Type: Int32

UID of the asset to be deleted.

Assets.removeAll ()

Adobe Illustrator 22 Type Library

Deletes all elements.

Application Class

New Method

Application.getIsFileOpen (filePath: string 😞 Boolean

Adobe Illustrator 22 Type Library

Returns if the specified filePath is open.

filePath: Data Type: string

The filePath to be checked.

Document Class

New Method

Document.exportForScreens (exportFolder: File , exportFormat: ExportForScreensType , options:any, itemToExport: ExportForScreensItemToExport , fileNamePrefix: string )

Adobe Illustrator 22 Type Library

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

exportFolder: Data Type: File

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

exportFormat: Data Type: ExportForScreensType

The file type in which the document is exported.

options (optional): Data Type: any

Options for the file type specified.

itemToExport (optional): Data Type: ExportForScreensItemToExport

What to export.

fileNamePrefix (optional): Data Type: string

String prepended to each file name.

DocumentPreset Class

New Properties

DocumentPreset.documentBleedOffset

Data Type: Rect

Adobe Illustrator 22 Type Library

Document bleed offset rect.

DocumentPreset.documentBleedLink

Data Type: Boolean , Default Value: true

Adobe Illustrator 22 Type Library

Document link for bleed values.

TextRange Class

New Properties

TextRange.start

Data Type: Int32

Adobe Illustrator 22 Type Library

Start index of the text range.

TextRange.end

Data Type: Int32

Adobe Illustrator 22 Type Library

End index of the text range.

New Methods

TextRange.getParagraphLength (): Int32

Adobe Illustrator 22 Type Library

Get the length of the first paragraph.

TextRange.getTextRunLength (): Int32

Adobe Illustrator 22 Type Library

Get the length of the first text run.

CharacterAttributes Class

New Properties

CharacterAttributes.kana

Data Type: Boolean

Adobe Illustrator 22 Type Library

Does the Japanese OpenType support kana?

CharacterAttributes.ruby

Data Type: Boolean

Adobe Illustrator 22 Type Library

Does the Japanese OpenType support ruby?

CharacterAttributes.kashidas

Data Type: KashidasType

Adobe Illustrator 22 Type Library

Kashidas attribute.

CharacterAttributes.dirOverride

Data Type: DirOverrideType

Adobe Illustrator 22 Type Library

Direction override attribute.

CharacterAttributes.digitSet

Data Type: DigitSetType

Adobe Illustrator 22 Type Library

Digit set attribute.

CharacterAttributes.diacVPos

Data Type: DiacVPosType

Adobe Illustrator 22 Type Library

Diacritics positioning attribute.

CharacterAttributes.diacXOffset

Data Type: number

Adobe Illustrator 22 Type Library

Diacritics x offset attribute.

CharacterAttributes.diacYOffset

Data Type: number

Adobe Illustrator 22 Type Library

Diacritics y offset attribute.

CharacterAttributes.justificationAlternates

Data Type: Boolean

Adobe Illustrator 22 Type Library

Justification alternates attribute.

CharacterAttributes.overlapSwash

Data Type: Boolean

Adobe Illustrator 22 Type Library

OpenType overlap swash attribute.

CharacterAttributes.stretchedAlternates

Data Type: Boolean

Adobe Illustrator 22 Type Library

Stretched alternates attribute.

ParagraphAttributes Class

New Properties

ParagraphAttributes.composerEngine

Data Type: ComposerEngineType

Adobe Illustrator 22 Type Library

Composer engine attribute.

ParagraphAttributes.defaultTabWidth

Data Type: number

Adobe Illustrator 22 Type Library

Default tab width attribute.

ParagraphAttributes.kashidaWidth

Data Type: KashidaWidthType

Adobe Illustrator 22 Type Library

The Kashida Width attribute.

ParagraphAttributes.paragraphDirection

Data Type: ParagraphDirectionType

Adobe Illustrator 22 Type Library

Main writing direction attribute.

Here's the xml including all Enumerations, please note it might have missing closing tags.

<map title="Adobe Illustrator 22 Type Library" time="Thu Feb 2 12:20:30 UTC+5 2017">

      <topicref navtitle="JPEGCompressionMethodType" href="#/JPEGCompressionMethodType" />

      <topicref navtitle="KashidasType" href="#/KashidasType" />

      <topicref navtitle="DirOverrideType" href="#/DirOverrideType" />

      <topicref navtitle="DigitSetType" href="#/DigitSetType" />

      <topicref navtitle="DiacVPosType" href="#/DiacVPosType" />

      <topicref navtitle="KashidaWidthType" href="#/KashidaWidthType" />

      <topicref navtitle="ComposerEngineType" href="#/ComposerEngineType" />

      <topicref navtitle="ParagraphDirectionType" href="#/ParagraphDirectionType" />

      <topicref navtitle="ExportForScreensScaleType" href="#/ExportForScreensScaleType" />

      <topicref navtitle="ExportForScreensType" href="#/ExportForScreensType" />

      <topicref navtitle="ExportForScreensItemToExport" href="#/ExportForScreensItemToExport" />

      <topicref navtitle="ExportForScreensOptionsJPEG" href="#/ExportForScreensOptionsJPEG" />

      <topicref navtitle="ExportForScreensOptionsPNG8" href="#/ExportForScreensOptionsPNG8" />

      <topicref navtitle="ExportForScreensOptionsPNG24" href="#/ExportForScreensOptionsPNG24" />

      <topicref navtitle="ExportForScreensOptionsWebOptimizedSVG" href="#/ExportForScreensOptionsWebOptimizedSVG" />

      <topicref navtitle="ExportForScreensPDFOptions" href="#/ExportForScreensPDFOptions" />

    <topicref navtitle="Classes used for working with (exportable) assets in Adobe Illustrator">

      <topicref navtitle="Asset" href="#/Asset" />

    </topicref>

      <topicref navtitle="Assets" href="#/Assets" />

  </map>

  <package>

    <classdef name="ExportForScreensScaleType" enumeration="true">

      <shortdesc>Export for screens scale type.</shortdesc>

      <elements type="class">

        <property name="SCALEBYFACTOR" rwaccess="readonly">

          <shortdesc>Scale artwork by factors like 1x, 2x, 3x and so on, where 1x means 72 ppi.</shortdesc>

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="SCALEBYWIDTH" rwaccess="readonly">

          <shortdesc>Scale artwork by specifying artwork width in pixels like 100px, 124px etc. Height of the artwork is adjusted automatically to maintain the aspect ratio.</shortdesc>

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="SCALEBYHEIGHT" rwaccess="readonly">

          <shortdesc>Scale artwork by specifying artwork height in pixels like 100px, 124px etc. Width of the artwork is adjusted automatically to maintain the aspect ratio.</shortdesc>

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

        <property name="SCALEBYRESOLUTION" rwaccess="readonly">

          <shortdesc>Scale artwork by specifying resolution in ppi like 72 ppi, 100 ppi, 144 ppi etc.</shortdesc>

          <datatype>

            <type>int</type>

            <value>3</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ExportForScreensType" enumeration="true">

      <shortdesc>Export for screens type.</shortdesc>

      <elements type="class">

        <property name="SE_JPEG100" rwaccess="readonly">

          <shortdesc>Export file in JPEG (100% quality) format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="SE_JPEG80" rwaccess="readonly">

          <shortdesc>Export file in JPEG (80% quality) format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

        <property name="SE_JPEG50" rwaccess="readonly">

          <shortdesc>Export file in JPEG (50% quality) format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>3</value>

          </datatype>

        </property>

        <property name="SE_JPEG20" rwaccess="readonly">

          <shortdesc>Export file in JPEG (20% quality) format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>4</value>

          </datatype>

        </property>

        <property name="SE_SVG" rwaccess="readonly">

          <shortdesc>Export file in SVG format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>5</value>

          </datatype>

        </property>

        <property name="SE_PNG8" rwaccess="readonly">

          <shortdesc>Export file in PNG 8-bit format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>6</value>

          </datatype>

        </property>

        <property name="SE_PNG24" rwaccess="readonly">

          <shortdesc>Export file in PNG 24-bit format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>7</value>

          </datatype>

        </property>

        <property name="SE_PDF" rwaccess="readonly">

          <shortdesc>Export file in Acrobat PDF format.</shortdesc>

          <datatype>

            <type>int</type>

            <value>8</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="KashidasType" enumeration="true">

      <shortdesc>The kashida type constants.</shortdesc>

      <elements type="class">

        <property name="kashidaDefault" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="kashidaOn" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="kashidaOff" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="DirOverrideType" enumeration="true">

      <shortdesc>Direction override type constants.</shortdesc>

      <elements type="class">

        <property name="dirOverrideDefault" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="dirOverrideLTR" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="dirOverrideRTL" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="DigitSetType" enumeration="true">

      <shortdesc>Digit set type constants.</shortdesc>

      <elements type="class">

        <property name="defaultDigits" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="arabicDigits" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="hindiDigits" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

        <property name="farsiDigits" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>3</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="DiacVPosType" enumeration="true">

      <shortdesc>Diacritic vertical position type constants.</shortdesc>

      <elements type="class">

        <property name="diacVPosOff" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="diacVPosLoose" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="diacVPosMedium" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

        <property name="diacVPosTight" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>3</value>

          </datatype>

        </property>

        <property name="diacVPosOpenType" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>4</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="KashidaWidthType" enumeration="true">

      <shortdesc>The kashida width type constants.</shortdesc>

      <elements type="class">

        <property name="kashidaNone" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="kashidaSmall" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="kashidaMedium" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

        <property name="kashidaLong" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>3</value>

          </datatype>

        </property>

        <property name="kashidaStylistic" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>4</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ComposerEngineType" enumeration="true">

      <shortdesc>The composer type constants.</shortdesc>

      <elements type="class">

        <property name="latinCJKComposer" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="pptycaComposer" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="adornment" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ParagraphDirectionType" enumeration="true">

      <shortdesc>The composer type constants.</shortdesc>

      <elements type="class">

        <property name="leftToRight" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="rightToLeft" rwaccess="readonly">

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="JPEGCompressionMethodType" enumeration="true">

      <shortdesc>JPEG Compression Method type.</shortdesc>

      <elements type="class">

        <property name="BASELINESTANDARD" rwaccess="readonly">

          <shortdesc>Select Baseline (Standard) to use a format recognized by most web browsers.</shortdesc>

          <datatype>

            <type>int</type>

            <value>0</value>

          </datatype>

        </property>

        <property name="BASELINEOPTIMIZED" rwaccess="readonly">

          <shortdesc>Select Baseline Optimized for optimized color and a slightly smaller file size. Not supported by all web browsers.</shortdesc>

          <datatype>

            <type>int</type>

            <value>1</value>

          </datatype>

        </property>

        <property name="PROGRESSIVE" rwaccess="readonly">

          <shortdesc>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.</shortdesc>

          <datatype>

            <type>int</type>

            <value>2</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="Assets" dynamic="true">

      <shortdesc>A collection of assets.</shortdesc>

      <elements type="class">

        <method name="addFromSelection">

          <shortdesc>Creates an asset from the selected arts.</shortdesc>

          <datatype>

            <type>Asset</type>

          </datatype>

        </method>

        <method name="add">

          <shortdesc>Creates an asset from the given art(s)</shortdesc>

          <parameters>

            <parameter name="sourceArt">

              <shortdesc>The page item(s) to apply to.</shortdesc>

              <datatype>

                <type>any</type>

              </datatype>

            </parameter>

          </parameters>

          <datatype>

            <type>Asset</type>

          </datatype>

        </method>

      </elements>

      <elements type="instance">

        <property name="parent" rwaccess="readonly">

          <shortdesc>The object's container.</shortdesc>

          <datatype>

            <type>Object</type>

          </datatype>

        </property>

        <property name="typename" rwaccess="readonly">

          <shortdesc>The class name of the object.</shortdesc>

          <datatype>

            <type>string</type>

          </datatype>

        </property>

        <property name="length" rwaccess="readonly">

          <shortdesc>Number of elements in the collection.</shortdesc>

          <datatype>

            <type>int</type>

          </datatype>

        </property>

        <method name="removeAll">

          <shortdesc>Deletes all elements.</shortdesc>

        </method>

        <method name="getByName">

          <shortdesc>Get the first element in the collection with the provided name.</shortdesc>

          <parameters>

            <parameter name="name">

              <datatype>

                <type>string</type>

              </datatype>

            </parameter>

          </parameters>

          <datatype>

            <type href="#/Asset">Asset</type>

          </datatype>

        </method>

        <method name="remove">

          <shortdesc>Deletes the asset with specified id.</shortdesc>

          <parameters>

            <parameter name="assetID">

              <shortdesc>UID of the asset to be deleted.</shortdesc>

              <datatype>

                <type href="#/Int32">Int32</type>

              </datatype>

            </parameter>

          </parameters>

        </method>

        <method name="getByName">

          <shortdesc>Gets the first asset with specified name.</shortdesc>

          <parameters>

            <parameter name="assetName">

              <shortdesc>Name of the asset.</shortdesc>

              <datatype>

                <type>string</type>

              </datatype>

            </parameter>

          </parameters>

          <datatype>

            <type href="#/Asset">Asset</type>

          </datatype>

        </method>

        <method name="getByID">

          <shortdesc>Gets the asset with the specified AssetID.</shortdesc>

          <parameters>

            <parameter name="assetID">

              <shortdesc>The UID of the asset.</shortdesc>

              <datatype>

                <type href="#/Int32">Int32</type>

              </datatype>

            </parameter>

          </parameters>

          <datatype>

            <type href="#/Asset">Asset</type>

          </datatype>

        </method>

      </elements>

    </classdef>

    <classdef name="ExportForScreensItemToExport" dynamic="true">

      <shortdesc>An item that needs to be exported; for example, a document, artboard, or asset.</shortdesc>

      <elements type="class">

        <property name="artboards">

          <shortdesc>Range of artboards to export [possible values: '', 'all'(default), range]</shortdesc>

          <datatype>

            <type>string</type>

            <value>all</value>

          </datatype>

        </property>

        <property name="assets">

          <shortdesc>Array of asset id to export (default:empty)</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

            <array />

          </datatype>

        </property>

        <property name="document">

          <shortdesc>Whether to export the document or not.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>false</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ExportForScreensOptionsJPEG" dynamic="true">

      <shortdesc>Options which may be provided when exporting a document as a JPEG100 file.</shortdesc>

      <elements type="class">

        <property name="compressionMethod">

          <shortdesc>Should the image be compressed.</shortdesc>

          <datatype>

            <type href="#/JPEGCompressionMethodType">JPEGCompressionMethodType</type>

            <value>JPEGCompressionMethodType.BASELINESTANDARD</value>

          </datatype>

        </property>

        <property name="progressiveScan">

          <shortdesc>Specify the number of detailed scans when downloading a JPEG file using the Progressive option as the CompressionMethod.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

            <min>3</min>

            <max>5</max>

            <value>3</value>

          </datatype>

        </property>

        <property name="antiAliasing">

          <shortdesc>Should the resulting image be antialiased.</shortdesc>

          <datatype>

            <type href="#/AntiAliasingMethod">AntiAliasingMethod</type>

            <value>AntiAliasingMethod.ARTOPTIMIZED</value>

          </datatype>

        </property>

        <property name="embedICCProfile">

          <shortdesc>Embed an ICC profile when exporting.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>false</value>

          </datatype>

        </property>

        <property name="scaleType">

          <shortdesc>How should the resulting image be scaled.</shortdesc>

          <datatype>

            <type href="#/ExportForScreensScaleType">ExportForScreensScaleType</type>

            <value>ExportForScreensScaleType.SCALEBYFACTOR</value>

          </datatype>

        </property>

        <property name="scaleTypeValue">

          <shortdesc>The value by which the resulting image should be scaled.</shortdesc>

          <datatype>

            <type>number</type>

            <value>1</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ExportForScreensOptionsPNG8" dynamic="true">

      <shortdesc>Options which may be provided when exporting a document as an 8 bit PNG file.</shortdesc>

      <elements type="class">

        <property name="colorCount">

          <shortdesc>Number of colors in exported color table.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

            <min>2</min>

            <max>256</max>

            <value>128</value>

          </datatype>

        </property>

        <property name="transparency">

          <shortdesc>Should the resulting image use transparency.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>true</value>

          </datatype>

        </property>

        <property name="interlaced">

          <shortdesc>Should the resulting image be interlaced.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>false</value>

          </datatype>

        </property>

        <property name="matte">

          <shortdesc>Should the artboard be matted with a color.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>true</value>

          </datatype>

        </property>

        <property name="matteColor">

          <shortdesc>The color to use when matting the artboard (default: white)</shortdesc>

          <datatype>

            <type href="#/RGBColor">RGBColor</type>

          </datatype>

        </property>

        <property name="antiAliasing">

          <shortdesc>Should the resulting image be antialiased.</shortdesc>

          <datatype>

            <type href="#/AntiAliasingMethod">AntiAliasingMethod</type>

            <value>AntiAliasingMethod.ARTOPTIMIZED</value>

          </datatype>

        </property>

        <property name="scaleType">

          <shortdesc>How should the resulting image be scaled.</shortdesc>

          <datatype>

            <type href="#/ExportForScreensScaleType">ExportForScreensScaleType</type>

            <value>ExportForScreensScaleType.SCALEBYFACTOR</value>

          </datatype>

        </property>

        <property name="scaleTypeValue">

          <shortdesc>The value by which the resulting image should be scaled.</shortdesc>

          <datatype>

            <type>number</type>

            <value>1</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ExportForScreensOptionsPNG24" dynamic="true">

      <shortdesc>Options which may be provided when exporting a document as an 24 bit PNG file.</shortdesc>

      <elements type="class">

        <property name="transparency">

          <shortdesc>Should the resulting image use transparency.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>true</value>

          </datatype>

        </property>

        <property name="antiAliasing">

          <shortdesc>Should the resulting image be antialiased.</shortdesc>

          <datatype>

            <type href="#/AntiAliasingMethod">AntiAliasingMethod</type>

            <value>AntiAliasingMethod.ARTOPTIMIZED</value>

          </datatype>

        </property>

        <property name="backgroundBlack">

          <shortdesc>Should the resulting image rasterize against a black background (with value true) or white background(with value false) if it doesn't use transparency.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>false</value>

          </datatype>

        </property>

        <property name="interlaced">

          <shortdesc>Should the resulting image be interlaced.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>false</value>

          </datatype>

        </property>

        <property name="scaleType">

          <shortdesc>How should the resulting image be scaled.</shortdesc>

          <datatype>

            <type href="#/ExportForScreensScaleType">ExportForScreensScaleType</type>

            <value>ExportForScreensScaleType.SCALEBYFACTOR</value>

          </datatype>

        </property>

        <property name="scaleTypeValue">

          <shortdesc>The value by which the resulting image should be scaled.</shortdesc>

          <datatype>

            <type>number</type>

            <value>1</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ExportForScreensOptionsWebOptimizedSVG" dynamic="true">

      <shortdesc>Options which may be provided when exporting a document as a web optimized SVG file.</shortdesc>

      <elements type="class">

        <property name="fontType">

          <shortdesc>The type of font that should be included in the exported file.</shortdesc>

          <datatype>

            <type href="#/SVGFontType">SVGFontType</type>

            <value>SVGFontType.SVGFONT</value>

          </datatype>

        </property>

        <property name="coordinatePrecision">

          <shortdesc>Decimal precision for element coordinate values.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

            <min>1</min>

            <max>7</max>

            <value>3</value>

          </datatype>

        </property>

        <property name="cssProperties">

          <shortdesc>How should the CSS properties of the document be included in the document.</shortdesc>

          <datatype>

            <type href="#/SVGCSSPropertyLocation">SVGCSSPropertyLocation</type>

            <value>SVGCSSPropertyLocation.STYLEATTRIBUTES</value>

          </datatype>

        </property>

        <property name="svgId">

          <shortdesc>How object names (IDs) are generated in exported SVG.</shortdesc>

          <datatype>

            <type href="#/SVGIdType">SVGIdType</type>

            <value>SVGIdType.SVGIDREGULAR</value>

          </datatype>

        </property>

        <property name="svgMinify">

          <shortdesc>Reduces the size of the svg.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>false</value>

          </datatype>

        </property>

        <property name="svgResponsive">

          <shortdesc>Makes the SVG Responsive.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>true</value>

          </datatype>

        </property>

        <property name="rasterImageLocation">

          <shortdesc>Should the raster images in the exported file be included.</shortdesc>

          <datatype>

            <type href="#/RasterImageLocation">RasterImageLocation</type>

            <value>RasterImageLocation.PRESERVE</value>

          </datatype>

        </property>

      </elements>

    </classdef>

    <classdef name="ExportForScreensPDFOptions" dynamic="true">

      <shortdesc>Options which may be provided when exporting a document as a PDF file.</shortdesc>

      <elements type="class">

        <property name="pdfPreset">

          <shortdesc>The max string length is 255 bytes. Name of PDF preset to use.</shortdesc>

          <datatype>

            <type>string</type>

            <value>[Smallest File Size]</value>

          </datatype>

        </property>

      </elements>

    </classdef>

        <property name="documentBleedOffset">

          <shortdesc>Document bleed offset rect.</shortdesc>

          <datatype>

            <type href="#/Rect">Rect</type>

          </datatype>

        </property>

        <property name="documentBleedLink">

          <shortdesc>Document link for bleed values.</shortdesc>

          <datatype>

            <type>bool</type>

            <value>true</value>

          </datatype>

        </property>

        <method name="getIsFileOpen">

          <shortdesc>Returns if the specified filePath is open.</shortdesc>

          <parameters>

            <parameter name="filePath">

              <shortdesc>The filePath to be checked.</shortdesc>

              <datatype>

                <type>string</type>

              </datatype>

            </parameter>

          </parameters>

          <datatype>

            <type>bool</type>

          </datatype>

        </method>

            <parameter name="assetType">

              <shortdesc>For internal use.</shortdesc>

              <datatype>

                <type>string</type>

              </datatype>

            </parameter>

        <property name="assets" rwaccess="readonly">

          <shortdesc>All assets in the document.</shortdesc>

          <datatype>

            <type href="#/Assets">Assets</type>

          </datatype>

        </property>

        <method name="exportForScreens">

          <shortdesc>Export the specified document/asset(s)/artboard(s)</shortdesc>

          <parameters>

            <parameter name="exportFolder">

              <shortdesc>The folder where the exported documents/assets/artboards are saved.</shortdesc>

              <datatype>

                <type href="#/File">File</type>

              </datatype>

            </parameter>

            <parameter name="exportFormat">

              <shortdesc>The file type in which the document is exported.</shortdesc>

              <datatype>

                <type href="#/ExportForScreensType">ExportForScreensType</type>

              </datatype>

            </parameter>

            <parameter name="options" optional="true">

              <shortdesc>Options for the file type specified.</shortdesc>

              <datatype>

                <type>any</type>

              </datatype>

            </parameter>

            <parameter name="itemToExport" optional="true">

              <shortdesc>What to export.</shortdesc>

              <datatype>

                <type href="#/ExportForScreensItemToExport">ExportForScreensItemToExport</type>

              </datatype>

            </parameter>

            <parameter name="fileNamePrefix" optional="true">

              <shortdesc>String prepended to each file name.</shortdesc>

              <datatype>

                <type>string</type>

              </datatype>

            </parameter>

          </parameters>

        </method>

        <property name="start">

          <shortdesc>Start index of the text range.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

          </datatype>

        </property>

        <property name="end">

          <shortdesc>End index of the text range.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

          </datatype>

        </property>

        <method name="getTextRunLength">

          <shortdesc>Get the length of the first text run.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

          </datatype>

        </method>

        <method name="getParagraphLength">

          <shortdesc>Get the length of the first paragraph.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

          </datatype>

        </method>

        <property name="kana">

          <shortdesc>Does the Japanese OpenType support kana?</shortdesc>

          <datatype>

            <type>bool</type>

          </datatype>

        </property>

        <property name="ruby">

          <shortdesc>Does the Japanese OpenType support ruby?</shortdesc>

          <datatype>

            <type>bool</type>

          </datatype>

        </property>

        <property name="kashidas">

          <shortdesc>Kashidas attribute.</shortdesc>

          <datatype>

            <type href="#/KashidasType">KashidasType</type>

          </datatype>

        </property>

        <property name="dirOverride">

          <shortdesc>Direction override attribute.</shortdesc>

          <datatype>

            <type href="#/DirOverrideType">DirOverrideType</type>

          </datatype>

        </property>

        <property name="digitSet">

          <shortdesc>Digit set attribute.</shortdesc>

          <datatype>

            <type href="#/DigitSetType">DigitSetType</type>

          </datatype>

        </property>

        <property name="diacVPos">

          <shortdesc>Diacritics positioning attribute.</shortdesc>

          <datatype>

            <type href="#/DiacVPosType">DiacVPosType</type>

          </datatype>

        </property>

        <property name="diacXOffset">

          <shortdesc>Diacritics x offset attribute.</shortdesc>

          <datatype>

            <type>number</type>

          </datatype>

        </property>

        <property name="diacYOffset">

          <shortdesc>Diacritics y offset attribute.</shortdesc>

          <datatype>

            <type>number</type>

          </datatype>

        </property>

        <property name="overlapSwash">

          <shortdesc>OpenType overlap swash attribute.</shortdesc>

          <datatype>

            <type>bool</type>

          </datatype>

        </property>

        <property name="justificationAlternates">

          <shortdesc>Justification alternates attribute.</shortdesc>

          <datatype>

            <type>bool</type>

          </datatype>

        </property>

        <property name="stretchedAlternates">

          <shortdesc>Stretched alternates attribute.</shortdesc>

          <datatype>

            <type>bool</type>

          </datatype>

        </property>

        <property name="defaultTabWidth">

          <shortdesc>Default tab width attribute.</shortdesc>

          <datatype>

            <type>number</type>

          </datatype>

        </property>

        <property name="paragraphDirection">

          <shortdesc>Main writing direction attribute.</shortdesc>

          <datatype>

            <type href="#/ParagraphDirectionType">ParagraphDirectionType</type>

          </datatype>

        </property>

        <property name="kashidaWidth">

          <shortdesc>The Kashida Width attribute.</shortdesc>

          <datatype>

            <type href="#/KashidaWidthType">KashidaWidthType</type>

          </datatype>

        </property>

        <property name="composerEngine">

          <shortdesc>Composer engine attribute.</shortdesc>

          <datatype>

            <type href="#/ComposerEngineType">ComposerEngineType</type>

          </datatype>

        </property>

          </datatype>

        </method>

      </elements>

    </classdef>

    <classdef name="Asset" dynamic="true">

      <shortdesc>An (exportable) asset.</shortdesc>

      <elements type="instance">

        <property name="parent" rwaccess="readonly">

          <shortdesc>The object's container.</shortdesc>

          <datatype>

            <type>Object</type>

          </datatype>

        </property>

        <property name="typename" rwaccess="readonly">

          <shortdesc>The class name of the object.</shortdesc>

          <datatype>

            <type>string</type>

          </datatype>

        </property>

        <property name="assetID" rwaccess="readonly">

          <shortdesc>The UID for the asset which is unique within a document.</shortdesc>

          <datatype>

            <type href="#/Int32">Int32</type>

          </datatype>

        </property>

        <property name="assetName">

          <shortdesc>Name of the asset.</shortdesc>

          <datatype>

            <type>string</type>

          </datatype>

        </property>

        <method name="remove">

          <shortdesc>Deletes this object.</shortdesc>

        </method>

        <method name="removeAll">

          <shortdesc>Deletes all elements.</shortdesc>

        </method>

        <method name="getNormalizedName">

          <shortdesc>Gets the normalized name without special characters, such that it can be used as a file name.</shortdesc>

          <datatype>

            <type>string</type>

          </datatype>

        </method>

      </elements>

    </classdef>

  </package>

TOPICS
Scripting

Views

6.5K

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Adobe
Valorous Hero ,
Oct 22, 2017 Oct 22, 2017

Copy link to clipboard

Copied

Thank you for posting this, Carlos.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Valorous Hero ,
Oct 24, 2017 Oct 24, 2017

Copy link to clipboard

Copied

I wonder what possibilites and uses are for this:

JavaScriptExecutionMode

When should a JavaScript debugger be shown.

JavaScriptExecutionMode.BeforeRunning  (Read Only)

Data Type: int, Value: 3

Show the JavaScript debugger at the first line of the JavaScript.

JavaScriptExecutionMode.OnRuntimeError  (Read Only)

Data Type: int, Value: 2

Show the JavaScript debugger is a runtime error occurs.

JavaScriptExecutionMode.never  (Read Only)

Data Type: int, Value: 1

Never show the JavaScript debugger. Treat runtime errors by throwing a JavaScript exceptions.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Expert ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Hi Silly-V,

JavaScriptExecutionMode has been around since at least CS4, it seems to be used for testing purposes, their testing purposes.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Valorous Hero ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Expert ,
Oct 22, 2017 Oct 22, 2017

Copy link to clipboard

Copied

Thanks, Its very helpful. (^-^)/

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Explorer ,
Oct 23, 2017 Oct 23, 2017

Copy link to clipboard

Copied

Thank you CarlosCanto.

MichaelK ¯\_(ツ)_/¯

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Participant ,
Oct 24, 2017 Oct 24, 2017

Copy link to clipboard

Copied

Hey CarlosCanto,

Thanks alot for posting this.

Is the asset class and collection at the top for cloud libraries?

Thanks,

Dane

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Expert ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Hi daneJ, no, the new Assets collection refers to the assets in the Asset Export Panel.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Participant ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Too bad. I'd sure like some methods to work with and modify the cloud libraries. When you have thousands of Library elements and much of your work involves these libraries, some scripting could really make a difference. Maybe CC 2019.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Valorous Hero ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

I have never used this, but could this be useful regarding cloud library assets?

Application.openCloudLibraryAssetForEditing (assetURL: File , thumbnailURL: File , options:any): Document

For Internal Use.

assetURL: Data Type: File

For Internal use.

thumbnailURL: Data Type: File

For Internal use.

options (optional): Data Type: any

For internal use.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Expert ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Participant ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Thanks. ya i have been looking at that for a bit, but it does not work for me.

using:

#target "illustrator"

var aiApp = app.activeDocument;

var artItem = aiApp.placedItems[0]

var location = File(artItem.file.fsName);

var asset = app.openCloudLibraryAssetForEditing (location,location);

I get the error that the third argument is illigal. however the third argument is optional,  and it is not given in my code. also i have no idea what to put in there.

in any event i'd like to be able to iterate through the elements and change their names, I dont think this method will help with that. I was thinking about digging in the xml(assuming that is xml behing it) to try to and directly make a name change there but i couldnt understand a lot of it.

Still, it would be interesting to understand how "openCloudLibraryAssetForEditing " works.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Participant ,
Oct 26, 2017 Oct 26, 2017

Copy link to clipboard

Copied

CarlosCanto​

Do you know if the asset class and collection at the top for manipulating cloud libraries?

Thanks.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Participant ,
Oct 26, 2017 Oct 26, 2017

Copy link to clipboard

Copied

Thanks for posting this Carlos!!

Looks like they changed the interface for "TextFrame.textRange.justification.CENTER" enumeration? My scripts are throwing an error when trying to " myDoc.textFrames.textRange.justification = Justification.CENTER;"?

Cheers,

Scott

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Expert ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Hi Scott, it works fine here with Win10, CC2018.

change this

myDoc.textFrames.textRange.justification = Justification.CENTER

you're missing the index, perhaps that's the problem?

myDoc.textFrames[0].textRange.justification = Justification.CENTER

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Participant ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

*** Sharing the solution in case anyone sees this problem. ***

Hey Carlos, thanks for the reply and I found the issue!

So, you were able to create a textFrame object, and set the parameters WITHOUT assigning any content:

    // create number textFrame

    var artBoardNum = myDoc.textFrames.add();

    // sets style on number textFrame

    artBoardNum.textRange.characterAttributes.fillColor = fontColor;

    artBoardNum.textRange.characterAttributes.size = fontSize;

    artBoardNum.textRange.characterAttributes.strokeWeight = 0;

    artBoardNum.textRange.characterAttributes.textFont = fontStyle;

   

    // BELOW LINE WILL NOT WORK!!!

    artBoardNum.textRange.justification = Justification.LEFT;

   

    // assign number to textFrame object

    artBoardNum.contents = artboardNum.toString();

   

Solution: You have to assign content to the textFrame BEFORE changing the justification property!?!?

    // create number textFrame

    var artBoardNum = myDoc.textFrames.add();

    // sets style on number textFrame

    artBoardNum.textRange.characterAttributes.fillColor = fontColor;  

    artBoardNum.textRange.characterAttributes.size = fontSize;

    artBoardNum.textRange.characterAttributes.strokeWeight = 0;

    artBoardNum.textRange.characterAttributes.textFont = fontStyle;

   

    // assign number to textFrame object

    artBoardNum.contents = artboardNum.toString();

  

    // MOVE AFTER CONTENT HAS BEEN ADDED?

    artBoardNum.textRange.justification = Justification.LEFT;

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Beginner ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

I was having the same issue. Thanks so much for posting the solution!!

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Valorous Hero ,
Oct 27, 2017 Oct 27, 2017

Copy link to clipboard

Copied

Holy moly I thought you were the same person. !!

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Advocate ,
Jan 29, 2020 Jan 29, 2020

Copy link to clipboard

Copied

Really great, how did you found this data?

 

its 2020 and they still have their official docs at 2017?!?!?

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Advocate ,
Jan 29, 2020 Jan 29, 2020

Copy link to clipboard

Copied

Call me crazy but why doesnt have antiAliasing any effect? i changed it to ARTOPTIMZED or NONE, makes no difference. Also checked SCALEBYRESOLUTION. its still looking jagged?

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Advocate ,
Jan 29, 2020 Jan 29, 2020

Copy link to clipboard

Copied

setting it to Type does work, but when we use the export screen function Art simple works and is smooth. But it is now when using it with scripting

 

 

 

jpegParam.antiAliasing = AntiAliasingMethod.TYPEOPTIMIZED;

 

 
See below the 3 versions both None and ArtOptimized look exactly same
NoneNoneTypeTypeArtArt

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Expert ,
Jan 30, 2020 Jan 30, 2020

Copy link to clipboard

Copied

it's a bug, fortunately TYPEOPTIMIZED works.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Advocate ,
Jan 31, 2020 Jan 31, 2020

Copy link to clipboard

Copied

Indeed, i was thinking the same that it would be a bug. I was going crazy over it.

 

Wonder why 3 years after this post its still there or no one posted it? Not sure no one posted a bug about it, but i did see this piece of code in some other posts. But on the other hand, im not surprised. I dont know where you got all the data/info from shown in the first post. This data is nowhere on there official docs. But hey, those date to cc 2017, written before or around 2016. All the data is pretty much older i guess, not much changes every year.

 

So question now, how did you come by all of this new data, where did you find this?

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Expert ,
Jan 31, 2020 Jan 31, 2020

Copy link to clipboard

Copied

data comes from the Object Model Viewer, you can open it from the ESTK's help menu. There's is an xml document the actual data gets pulled.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines