PICT

A placed PICT graphic.

Methods:

applyObjectStyle, detach, duplicate, exportFile, extractLabel, fit, flipItem, getElements, insertLabel, move, override, place, remove, removeOverride, resize, rotate, shear, store, toSource, toSpecifier, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually

Objects:

BlendMode, Boolean, ClippingPathSettings, DisplaySettingOptions, FeatherCornerType, FeatherMode, Graphic, Guide, Link, Movie, Number, Object, ObjectStyle, PageItem, ShadowMode, Sound, String, Swatch, TextWrapPreference, XMLItem

Preferences:

TextWrapPreference

Hierarchy:

Superclass: Graphic

Class: PICT

Property Listing

Property

Type

Access

Description

absoluteHorizontalScale

Number

read/write

The horizontal scale of the PICT relative to its containing object.

absoluteRotationAngle

Number

read/write

The rotation angle of the PICT relative to its containing object. (Range: -360 to 360)

absoluteShearAngle

Number

read/write

The skewing angle of the PICT relative to its containing object. (Range: -360 to 360)

absoluteVerticalScale

Number

read/write

The vertical scale of the PICT relative to its containing object.

appliedObjectStyle

ObjectStyle

read/write

The object style applied to the PICT.

associatedXMLElement

XMLItem

readonly

The XML element associated with the PICT.

blendMode

BlendMode

BlendMode.COLOR

BlendMode.COLOR_BURN

BlendMode.COLOR_DODGE

BlendMode.DARKEN

BlendMode.DIFFERENCE

BlendMode.EXCLUSION

BlendMode.HARD_LIGHT

BlendMode.HUE

BlendMode.LIGHTEN

BlendMode.LUMINOSITY

BlendMode.MULTIPLY

BlendMode.NORMAL

BlendMode.OVERLAY

BlendMode.SATURATION

BlendMode.SCREEN

BlendMode.SOFT_LIGHT

read/write

The blend mode used to combine the background with the color of the PICT.

clippingPath

ClippingPathSettings

readonly

Clipping path settings.

featherCornerType

FeatherCornerType

FeatherCornerType.DIFFUSION

FeatherCornerType.ROUNDED

FeatherCornerType.SHARP

read/write

The type of feathering.

featherMode

FeatherMode

FeatherMode.NONE

FeatherMode.STANDARD

read/write

The feather-enabling mode.

featherNoise

Number (range 0 - 100)

read/write

The amount (as a percentage) of noise to apply to the feather. (Range: 0 to 100)

featherWidth

Number

String

read/write

The width of the feathering.

geometricBounds

Array of Number

Array of String

read/write

The bounds of the PICT excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.

horizontalScale

Number

read/write

The horizontal scaling applied to the PICT.

id

Number

readonly

The unique ID of the PICT.

imageTypeName

String

readonly

The type of the image.

index

Number

readonly

The index of the PICT within its containing object.

isolateBlending

Boolean

read/write

If true, the PICT blends in isolation.

itemLink

Link

readonly

The source file of the link.

knockoutGroup

Boolean

read/write

If true, the PICT is a knockout group.

label

String

read/write

A property that can be set to any string.

localDisplaySetting

DisplaySettingOptions

DisplaySettingOptions.DEFAULT_VALUE

DisplaySettingOptions.HIGH_QUALITY

DisplaySettingOptions.OPTIMIZED

DisplaySettingOptions.TYPICAL

read/write

Display performance options for the PICT.

nonprinting

Boolean

read/write

If true, the PICT does not print.

opacity

Number (range 0 - 100)

read/write

The opacity of the PICT. (Range: 0 to 100)

overridden

Boolean

readonly

If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.

overriddenMasterPageItem

Graphic

Guide

Movie

PageItem

Sound

readonly

An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.

parent

Button

GraphicLine

Group

Oval

Polygon

Rectangle

State

PageItem

XMLElement

readonly

The parent of the PICT (a PageItem, Oval, Rectangle, Polygon, GraphicLine, State, Group, Button or XMLElement).

properties

Object

read/write

A property that allows setting of several properties at the same time.

rotationAngle

Number

read/write

The rotatation angle of the PICT. (Range: -360 to 360)

shadowBlendMode

BlendMode

BlendMode.COLOR

BlendMode.COLOR_BURN

BlendMode.COLOR_DODGE

BlendMode.DARKEN

BlendMode.DIFFERENCE

BlendMode.EXCLUSION

BlendMode.HARD_LIGHT

BlendMode.HUE

BlendMode.LIGHTEN

BlendMode.LUMINOSITY

BlendMode.MULTIPLY

BlendMode.NORMAL

BlendMode.OVERLAY

BlendMode.SATURATION

BlendMode.SCREEN

BlendMode.SOFT_LIGHT

read/write

The blend mode to use for drawing the shadow.

shadowBlurRadius

Number

String

read/write

The radius of the shadow blur.

shadowColor

Swatch

read/write

The swatch (color or mixed ink) applied to the shadow.

shadowMode

ShadowMode

ShadowMode.DROP

ShadowMode.NONE

read/write

The shadow mode.

shadowNoise

Number (range 0 - 100)

read/write

The amount (as a percentage) of noise to apply to the shadow. (Range: 0 to 100)

shadowOpacity

Number (range 0 - 100)

read/write

The opacity of the shadow. (Range: 0 to 100)

shadowSpread

Number (range 0 - 100)

read/write

The amount (as a percentage) of the blur radius to use as the shadow footprint. (Range: 0 to 100) For information, see shadow blur radius.

shadowXOffset

Number

String

read/write

The horizontal offset of the shadow.

shadowYOffset

Number

String

read/write

The vertical offset of the shadow.

shearAngle

Number

read/write

The skewing angle applied to the PICT. (Range: -360 to 360)

textWrapPreferences

TextWrapPreference

readonly

The text wrap preference properties that define the default formatting for wrapping text around objects.

verticalScale

Number

read/write

The vertical scaling applied to the PICT.

visibleBounds

Array of Number

Array of String

read/write

The bounds of the PICT including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.

Method Listing

undefined applyObjectStyle (using:ObjectStyle, [clearingOverrides:Boolean=Boolean], [clearingOverridesThroughRootObjectStyle:Boolean=Boolean])

Applies the specified object style.

Parameter

Type

Description

using

ObjectStyle

The object style to apply.

clearingOverrides

Boolean

If true, clears the PICT's existing attributes before applying the style. (Optional)

(default: true)

clearingOverridesThroughRootObjectStyle

Boolean

If true, clears attributes and formatting applied to the PICT that are not defined in the object style. (Optional)

(default: false)

undefined detach ()

Detaches an overridden master page item from the master page.

PageItem duplicate (by:Array of Number String)

Duplicates the PICT.

Parameter

Type

Description

by

Array of Number

Array of String

The amount (in points) to offset the new PICT, in the format [x, y]. (Optional)

undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset)

Exports the object(s) to a file.

Parameter

Type

Description

format

ExportFormat

ExportFormat.EPS_TYPE

ExportFormat.INCOPY

ExportFormat.INCOPY_CS2_STORY

ExportFormat.INDESIGN_INTERCHANGE

ExportFormat.INDESIGN_SNIPPET

ExportFormat.JPG

ExportFormat.PDF_TYPE

ExportFormat.RTF

ExportFormat.SVG

ExportFormat.SVG_COMPRESSED

ExportFormat.TAGGED_TEXT

ExportFormat.TEXT_TYPE

ExportFormat.XML

String

The export format. Can accept: ExportFormat enumerator or String.

to

File

The path of the export file.

showingOptions

Boolean

If true, prompts the user to select export options. (Optional)

(default: false)

using

PDFExportPreset

The export style to use. (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

undefined fit (given:FitOptions)

Applies the specified fit option to content in a frame.

Parameter

Type

Description

given

FitOptions

FitOptions.CENTER_CONTENT

FitOptions.CONTENT_TO_FRAME

FitOptions.FILL_PROPORTIONALLY

FitOptions.FRAME_TO_CONTENT

FitOptions.PROPORTIONALLY

The fit option to use.

undefined flipItem (given:FlipItemOptions, around:Array of Varies 2 Units AnchorPoint, [transformingContent:Boolean=Boolean])

Flip item about given axis

Parameter

Type

Description

given

FlipItemOptions

FlipItemOptions.BOTH

FlipItemOptions.HORIZONTAL

FlipItemOptions.VERTICAL

flip item options

around

Array of 2 Units

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The point to flip around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

transformingContent

Boolean

If true then both the object and items within it are flipped (Optional)

(default: true)

Object getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter

Type

Description

key

String

The key.

value

String

The value.

undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String, [transformingContent:Boolean=Boolean])

Move Page Item to a new location. One of the 'To' or 'By' parameters is required.

Parameter

Type

Description

to

Array of 2 Units

Page

Spread

Layer

The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

by

Array of Number

Array of String

Amount by which to move the object relative to its current position (Optional)

transformingContent

Boolean

If true then both the object and items within it are moved (Optional)

(default: true)

Varies override (destinationPage:Page)

Overrides a master page item and places the item on the document page as a new object.

Parameter

Type

Description

destinationPage

Page

The document page that contains the master page item to override.

Varies place (fileName:File, [showingOptions:Boolean=Boolean], withProperties:Object)

Place a file

Parameter

Type

Description

fileName

File

The file to place

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

undefined remove ()

Deletes the PICT.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resize (horizontalScale:Number, verticalScale:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentScale:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsScale:Boolean=Boolean])

Resize the page item. You must specify either horizontal scale or vertical scale or both.

Parameter

Type

Description

horizontalScale

Number

The percentage of horizontal scale (Optional)

verticalScale

Number

The percentage of vertical scale (Optional)

around

Array of 2 Units

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

consideringCurrentScale

Boolean

If true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional)

(default: false)

transformingContent

Boolean

If true then both the object and items within it are scaled (Optional)

(default: true)

consideringParentsScale

Boolean

If true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional)

(default: false)

undefined rotate (by:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentRotation:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsRotation:Boolean=Boolean])

Rotate the page item

Parameter

Type

Description

by

Number

Angle by which to rotate the page item

around

Array of 2 Units

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

consideringCurrentRotation

Boolean

If true then the object's current rotation and new rotation will be combined. If false then the new value is absolute. The default value is false. (Optional)

(default: false)

transformingContent

Boolean

If true then both the object and items within it are rotated (Optional)

(default: true)

consideringParentsRotation

Boolean

If true then the object is rotated relative to its parent page item. If false it is rotated relative to the spread. Cannot rotate with considering current rotation and considering parents rotation both set at the same time. (Optional)

(default: false)

undefined shear (by:Number, around:Array of Varies 2 Units AnchorPoint, [shearAxisAngle:Number=Number], [consideringCurrentShear:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsShear:Boolean=Boolean])

Shear the page item

Parameter

Type

Description

by

Number

Angle by which to shear the object

around

Array of 2 Units

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

shearAxisAngle

Number

The amount that the shear axis is rotated. If 0 degree then shear at its horizontal axis. If 90 degrees then shear at the vertical axis. (Optional)

(default: 0)

consideringCurrentShear

Boolean

If true then the object's current shear and new shear will be combined. If false then the new value is absolute. The default value is false. (Optional)

(default: false)

transformingContent

Boolean

If true then both the object and items within it are sheared (Optional)

(default: true)

consideringParentsShear

Boolean

If true then the object is sheared relative to its parent page item. If false it is sheared relative to the spread. Cannot shear with considering current shear and considering parents shear both set at the same time. (Optional)

(default: false)

Asset store (using:Library)

Store a page item in a library

Parameter

Type

Description

using

Library

The library in which to store

String toSource ()

Generates a string which, if executed, will return the PICT.

String toSpecifier ()

Retrieves the object specifier.

String transformAgain ()

Transforms the PICT using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformAgainIndividually ()

Transforms the PICT using the last transformation performed on any PICT. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformSequenceAgain ()

Transforms the PICT using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformSequenceAgainIndividually ()

Transforms the PICT using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Object of

ClippingPathSettings.parent

TextWrapPreference.parent

Return

PICTs.anyItem()

PICTs.everyItem()

PICTs.nextItem()

PICTs.previousItem()

PICTs.itemByID()

PICTs.item()

PICTs.itemByName()

PICTs.itemByRange()

PICTs.firstItem()

PICTs.lastItem()

PICTs.middleItem()