SplineItem

A path-based page item, such as a rectangle, oval, polygon, or graphic line.

Methods:

addEventListener, addPath, applyObjectStyle, asynchronousExportFile, autoTag, bringForward, bringToFront, changeObject, checkIn, checkOut, clearObjectStyleOverrides, clearTransformations, contentPlace, convertShape, createEmailQRCode, createHyperlinkQRCode, createPlainTextQRCode, createTextMsgQRCode, createVCardQRCode, detach, duplicate, excludeOverlapPath, exportFile, extractLabel, findObject, fit, flipItem, getElements, insertLabel, intersectPath, makeCompoundPath, markup, minusBack, move, override, place, placeXML, redefineScaling, reframe, releaseCompoundPath, remove, removeEventListener, removeOverride, resize, resolve, revert, select, sendBackward, sendToBack, store, subtractPath, toSource, toSpecifier, transform, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually, transformValuesOf

Objects:

AnchoredObjectSetting, AnimationSetting, ArrowHead, ArrowHeadAlignmentEnum, Article, AutofitPageItemSettings, Boolean, Buttons, CheckBoxes, ComboBoxes, ContentTransparencySetting, ContentType, CornerOptions, DimensionsConstraints, DisplaySettingOptions, EPSTexts, EPSs, EndCap, EndJoin, EndnoteTextFrames, EventListeners, Events, FillTransparencySetting, Flip, FormFields, Graphic, GraphicLines, Graphics, Groups, Guide, HtmlItems, Images, ImportedPages, Layer, LinkedPageItemOption, ListBoxes, LockStateValues, MediaItems, Movie, Movies, MultiStateObjects, Number, Object, ObjectExportOption, ObjectStyle, Ovals, PDFs, PICTs, Page, PageItem, PageItems, Paths, Polygons, Preferences, RadioButtons, Rectangles, SignatureFields, Sound, Sounds, SplineItems, String, StrokeAlignment, StrokeCornerAdjustment, StrokeStyle, StrokeTransparencySetting, Swatch, TextBoxes, TextFrames, TextPaths, TextWrapPreference, TimingSetting, TransparencySetting, TypefiPageItemSettings, WMFs, XMLItem

Preferences:

LinkedPageItemOption, ObjectExportOption, Preferences, TextWrapPreference

Hierarchy:

Superclass: PageItem

Class: SplineItem

Subclasses: Oval | Rectangle | GraphicLine | Polygon

Property Listing

Property

Type

Access

Description

absoluteFlip

Flip

Flip.BOTH

Flip.HORIZONTAL

Flip.HORIZONTAL_AND_VERTICAL

Flip.NONE

Flip.VERTICAL

read/write

Indicates whether the SplineItem has been flipped independently of its parent object and, if yes, the direction in which the SplineItem was flipped.

absoluteHorizontalScale

Number

read/write

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

absoluteRotationAngle

Number

read/write

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

absoluteShearAngle

Number

read/write

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

absoluteVerticalScale

Number

read/write

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

allArticles

Array of Article

readonly

The list of all articles this page item is part of

allGraphics

Array of Graphic

readonly

Lists all graphics contained by the SplineItem.

allPageItems

Array of PageItem

readonly

Lists all page items contained by the SplineItem.

allowOverrides

Boolean

read/write

If true, the master page item can be overridden.

anchoredObjectSettings

AnchoredObjectSetting

readonly

Anchored object settings.

animationSettings

AnimationSetting

readonly

The page item animation settings.

appliedObjectStyle

ObjectStyle

read/write

The object style applied to the SplineItem.

arrowHeadAlignment

ArrowHeadAlignmentEnum

ArrowHeadAlignmentEnum.INSIDE_PATH

ArrowHeadAlignmentEnum.OUTSIDE_PATH

read/write

The arrowhead alignment applied to the SplineItem.

associatedXMLElement

XMLItem

readonly

The XML element associated with the SplineItem.

autofitSettings

AutofitPageItemSettings

readonly

AutoFit specific settings to page items

bottomLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the bottom left corner of rectangular shapes.

bottomLeftCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes

bottomRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the bottom right corner of rectangular shapes.

bottomRightCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes

buttons

Buttons Button

readonly

A collection of buttons.

checkBoxes

CheckBoxes

readonly

A collection of checkboxes.

comboBoxes

ComboBoxes

readonly

A collection of comboboxes.

contentTransparencySettings

ContentTransparencySetting

readonly

Transparency settings for the content of the SplineItem.

contentType

ContentType

ContentType.GRAPHIC_TYPE

ContentType.TEXT_TYPE

ContentType.UNASSIGNED

read/write

The type of content that a frame can contain.

endCap

EndCap

EndCap.BUTT_END_CAP

EndCap.PROJECTING_END_CAP

EndCap.ROUND_END_CAP

read/write

The end shape of an open path.

endJoin

EndJoin

EndJoin.BEVEL_END_JOIN

EndJoin.MITER_END_JOIN

EndJoin.ROUND_END_JOIN

read/write

The corner join applied to the SplineItem.

endnoteTextFrames

EndnoteTextFrames EndnoteTextFrame

readonly

A collection of endnote text frames.

epss

EPSs EPS

readonly

A collection of EPS files.

epstexts

EPSTexts EPSText

readonly

EPSTexts

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

fillColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the fill of the SplineItem. . Can also accept: String.

fillTint

Number (range 0 - 100)

read/write

The percent of tint to use in the SplineItem's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)

fillTransparencySettings

FillTransparencySetting

readonly

Transparency settings for the fill applied to the SplineItem.

flip

Flip

Flip.BOTH

Flip.HORIZONTAL

Flip.HORIZONTAL_AND_VERTICAL

Flip.NONE

Flip.VERTICAL

read/write

The direction in which to flip the printed image.

formFields

FormFields FormField

readonly

A collection of form fields.

gapColor

Swatch

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.

gapTint

Number (range 0 - 100)

read/write

The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)

geometricBounds

Array of Number

Array of String

read/write

The bounds of the SplineItem 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.

gradientFillAngle

Number

read/write

The angle of a linear gradient applied to the fill of the SplineItem. (Range: -180 to 180)

gradientFillLength

Number

String

read/write

The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the SplineItem.

gradientFillStart

Array of Number

Array of String

read/write

The starting point (in page coordinates) of a gradient applied to the fill of the SplineItem, in the format [x, y].

gradientStrokeAngle

Number

read/write

The angle of a linear gradient applied to the stroke of the SplineItem. (Range: -180 to 180)

gradientStrokeLength

Number

String

read/write

The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the SplineItem.

gradientStrokeStart

Array of Number

Array of String

read/write

The starting point (in page coordinates) of a gradient applied to the stroke of the SplineItem, in the format [x, y].

graphicLines

GraphicLines GraphicLine

readonly

A collection of graphic lines.

graphics

Graphics Graphic

readonly

A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).

groups

Groups Group

readonly

A collection of groups.

horizontalLayoutConstraints

Array of DimensionsConstraints

DimensionsConstraints.FIXED_DIMENSION

DimensionsConstraints.FLEXIBLE_DIMENSION

read/write

The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule.

horizontalScale

Number

read/write

The horizontal scaling applied to the SplineItem.

htmlItems

HtmlItems HtmlItem

readonly

A collection of embedded HTML page items.

id

Number

readonly

The unique ID of the SplineItem.

images

Images Image

readonly

A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).

importedPages

ImportedPages ImportedPage

readonly

Imported InDesign pages.

index

Number

readonly

The index of the SplineItem within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

itemLayer

Layer

read/write

The layer that the SplineItem is on.

label

String

read/write

A property that can be set to any string.

leftArrowHeadScale

Number (range 1 - 1000)

read/write

The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000)

leftLineEnd

ArrowHead

ArrowHead.BARBED_ARROW_HEAD

ArrowHead.BAR_ARROW_HEAD

ArrowHead.CIRCLE_ARROW_HEAD

ArrowHead.CIRCLE_SOLID_ARROW_HEAD

ArrowHead.CURVED_ARROW_HEAD

ArrowHead.NONE

ArrowHead.SIMPLE_ARROW_HEAD

ArrowHead.SIMPLE_WIDE_ARROW_HEAD

ArrowHead.SQUARE_ARROW_HEAD

ArrowHead.SQUARE_SOLID_ARROW_HEAD

ArrowHead.TRIANGLE_ARROW_HEAD

ArrowHead.TRIANGLE_WIDE_ARROW_HEAD

read/write

The arrowhead applied to the start of the path.

linkedPageItemOptions

LinkedPageItemOption

readonly

Linked Page Item options

listBoxes

ListBoxes

readonly

A collection of listboxes.

localDisplaySetting

DisplaySettingOptions

DisplaySettingOptions.DEFAULT_VALUE

DisplaySettingOptions.HIGH_QUALITY

DisplaySettingOptions.OPTIMIZED

DisplaySettingOptions.TYPICAL

read/write

Display performance options for the SplineItem.

lockState

LockStateValues

LockStateValues.CHECKED_IN_STORY

LockStateValues.CHECKED_OUT_STORY

LockStateValues.EMBEDDED_STORY

LockStateValues.LOCKED_STORY

LockStateValues.MISSING_LOCK_STATE

LockStateValues.MIXED_LOCK_STATE

LockStateValues.NONE

LockStateValues.UNMANAGED_STORY

readonly

The lock state.

locked

Boolean

read/write

If true, the SplineItem is locked.

mediaItems

MediaItems MediaItem

readonly

The media items collection.

miterLimit

Number (range 1 - 500)

read/write

The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.

movies

Movies

readonly

A collection of movies.

multiStateObjects

MultiStateObjects MultiStateObject

readonly

A collection of multi-state objects.

name

String

read/write

The name of the SplineItem.

nonprinting

Boolean

read/write

If true, the SplineItem does not print.

objectExportOptions

ObjectExportOption

readonly

Export options for the object

ovals

Ovals Oval

readonly

A collection of ellipses.

overprintFill

Boolean

read/write

If true, the SplineItem's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.

overprintGap

Boolean

read/write

If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.

overprintStroke

Boolean

read/write

If true, the SplineItem's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.

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.

pageItems

PageItems PageItem

readonly

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.

parent

Cell

Character

GraphicLine

Group

ListBox

MasterSpread

Oval

PlaceGun

Polygon

Rectangle

SignatureField

SplineItem

Spread

State

TextBox

ComboBox

Snippet

readonly

The parent of the SplineItem (a ComboBox, ListBox, TextBox, SignatureField, Spread, MasterSpread, Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, State, Cell, Character, PlaceGun or Snippet).

parentPage

Page

readonly

The page on which this page item appears.

paths

Paths Path

readonly

A collection of paths.

pdfs

PDFs PDF

readonly

A collection of PDF files.

picts

PICTs PICT

readonly

A collection of PICT graphics.

polygons

Polygons Polygon

readonly

A collection of polygons.

preferences

Preferences Preference

readonly

A collection of preferences objects.

properties

Object

read/write

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

radioButtons

RadioButtons RadioButton

readonly

A collection of radio buttons.

rectangles

Rectangles Rectangle

readonly

A collection of rectangles.

rightArrowHeadScale

Number (range 1 - 1000)

read/write

The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000)

rightLineEnd

ArrowHead

ArrowHead.BARBED_ARROW_HEAD

ArrowHead.BAR_ARROW_HEAD

ArrowHead.CIRCLE_ARROW_HEAD

ArrowHead.CIRCLE_SOLID_ARROW_HEAD

ArrowHead.CURVED_ARROW_HEAD

ArrowHead.NONE

ArrowHead.SIMPLE_ARROW_HEAD

ArrowHead.SIMPLE_WIDE_ARROW_HEAD

ArrowHead.SQUARE_ARROW_HEAD

ArrowHead.SQUARE_SOLID_ARROW_HEAD

ArrowHead.TRIANGLE_ARROW_HEAD

ArrowHead.TRIANGLE_WIDE_ARROW_HEAD

read/write

The arrowhead applied to the end of the path.

rotationAngle

Number

read/write

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

shearAngle

Number

read/write

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

signatureFields

SignatureFields SignatureField

readonly

A collection of signature fields.

sounds

Sounds Sound

readonly

A collection of sound clips.

splineItems

SplineItems SplineItem

readonly

The spline items collection.

strokeAlignment

StrokeAlignment

StrokeAlignment.CENTER_ALIGNMENT

StrokeAlignment.INSIDE_ALIGNMENT

StrokeAlignment.OUTSIDE_ALIGNMENT

read/write

The stroke alignment applied to the SplineItem.

strokeColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the SplineItem. Can also accept: String.

strokeCornerAdjustment

StrokeCornerAdjustment

StrokeCornerAdjustment.DASHES

StrokeCornerAdjustment.DASHES_AND_GAPS

StrokeCornerAdjustment.GAPS

StrokeCornerAdjustment.NONE

read/write

The corner adjustment applied to the SplineItem.

strokeDashAndGap

Array of Number

Array of String

read/write

The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].

strokeTint

Number (range 0 - 100)

read/write

The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)

strokeTransparencySettings

StrokeTransparencySetting

readonly

Transparency settings for the stroke.

strokeType

StrokeStyle

String

read/write

The name of the stroke style to apply. Can also accept: String.

strokeWeight

Number

String

read/write

The weight (in points) to apply to the SplineItem's stroke.

textBoxes

TextBoxes

readonly

A collection of text boxes.

textFrames

TextFrames TextFrame

readonly

A collection of text frames.

textPaths

TextPaths TextPath

readonly

A collection of text paths.

textWrapPreferences

TextWrapPreference

readonly

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

timingSettings

TimingSetting

readonly

The object timing settings.

topLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.

topLeftCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes

topRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the top right corner of rectangular shapes

topRightCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes

transparencySettings

TransparencySetting

readonly

Transparency settings.

typefiSettings

TypefiPageItemSettings

readonly

Typefi specific settings to page items

verticalLayoutConstraints

Array of DimensionsConstraints

DimensionsConstraints.FIXED_DIMENSION

DimensionsConstraints.FLEXIBLE_DIMENSION

read/write

The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule.

verticalScale

Number

read/write

The vertical scaling applied to the SplineItem.

visible

Boolean

read/write

If true, the SplineItem is visible.

visibleBounds

Array of Number

Array of String

read/write

The bounds of the SplineItem 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.

wmfs

WMFs WMF

readonly

A collection of WMF graphics.

Constants/Events

Name

Type

Access

Description

AFTER_PLACE

String

readonly

Dispatched after a SplineItem is placed. This event bubbles. This event is not cancelable.

BEFORE_PLACE

String

readonly

Dispatched before a SplineItem is placed. This event bubbles. This event is cancelable.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

PageItem addPath (with:Array of PageItem)

Creates a new page item by combining the SplineItem with other objects. Deletes the objects if they do not intersect.

Parameter

Type

Description

with

Array of PageItem

The object(s) to add.

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 SplineItem's existing attributes before applying the style. (Optional)

(default: true)

clearingOverridesThroughRootObjectStyle

Boolean

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

(default: false)

BackgroundTask asynchronousExportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

asynchronously exports the object(s) to a file.

Parameter

Type

Description

format

ExportFormat

ExportFormat.EPS_TYPE

ExportFormat.EPUB

ExportFormat.FIXED_LAYOUT_EPUB

ExportFormat.HTML

ExportFormat.HTMLFXL

ExportFormat.INCOPY_MARKUP

ExportFormat.INDESIGN_MARKUP

ExportFormat.INDESIGN_SNIPPET

ExportFormat.INTERACTIVE_PDF

ExportFormat.JPG

ExportFormat.PACKAGED_XFL

ExportFormat.PDF_TYPE

ExportFormat.PNG_FORMAT

ExportFormat.RTF

ExportFormat.SWF

ExportFormat.TAGGED_TEXT

ExportFormat.TEXT_TYPE

ExportFormat.XML

String

The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.

to

File

The path to the export file.

showingOptions

Boolean

If true, displays the export options dialog. (Optional)

(default: false)

using

PDFExportPreset

The export style. (Optional)

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

undefined autoTag ()

Tag the object or the parent story using default tags defined in XML preference.

undefined bringForward ()

Brings the SplineItem forward one level in its layer.

undefined bringToFront (reference:PageItem)

Brings the SplineItem to the front of its layer or in front of a particular item.

Parameter

Type

Description

reference

PageItem

The reference object to bring the object in front of (must have same parent) (Optional)

PageItem changeObject (reverseOrder:Boolean)

Finds objects that match the find what value and replace the objects with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Boolean checkIn (versionComments:String, [forceSave:Boolean=Boolean])

Checks in the story or stories.

Parameter

Type

Description

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

Boolean checkOut ()

Checks out the story.

undefined clearObjectStyleOverrides ()

Clear overrides for object style

undefined clearTransformations ()

Clears transformations from the SplineItem. Transformations include rotation, scaling, flipping, fitting, and shearing.

Varies contentPlace (pageItems:Array of PageItem, [linkPageItems:Boolean=Boolean], [linkStories:Boolean=Boolean], [mapStyles:Boolean=Boolean], [showingOptions:Boolean=Boolean])

Duplicate an object and place it into the target page item.

Parameter

Type

Description

pageItems

Array of PageItem

One or more page items to place or load

linkPageItems

Boolean

Whether to link pageItems in content placer (if true it will override link stories value) (Optional)

(default: false)

linkStories

Boolean

Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional)

(default: false)

mapStyles

Boolean

Whether to map styles in content placer (Optional)

(default: false)

showingOptions

Boolean

Whether to display the link options dialog (Optional)

(default: false)

undefined convertShape (given:ConvertShapeOptions, numberOfSides:Number, insetPercentage:Number, cornerRadius:Number String)

Converts the SplineItem to a different shape.

Parameter

Type

Description

given

ConvertShapeOptions

ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE

ConvertShapeOptions.CONVERT_TO_CLOSED_PATH

ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE

ConvertShapeOptions.CONVERT_TO_LINE

ConvertShapeOptions.CONVERT_TO_OPEN_PATH

ConvertShapeOptions.CONVERT_TO_OVAL

ConvertShapeOptions.CONVERT_TO_POLYGON

ConvertShapeOptions.CONVERT_TO_RECTANGLE

ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE

ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE

ConvertShapeOptions.CONVERT_TO_TRIANGLE

The SplineItem's new shape.

numberOfSides

Number (range 3 - 100)

The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)

insetPercentage

Number (range 0 - 100)

The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)

cornerRadius

Number

String

The corner radius of the resulting rectangle. (Optional)

undefined createEmailQRCode (emailAddress:String, subject:String, body:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Email QR Code on the page item or document

Parameter

Type

Description

emailAddress

String

QR code Email Address (Optional)

subject

String

QR code Email Subject (Optional)

body

String

QR code Email Body Message (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional)

undefined createHyperlinkQRCode (urlLink:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Hyperlink QR Code on the page item or document

Parameter

Type

Description

urlLink

String

QR code Hyperlink URL (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional)

undefined createPlainTextQRCode (plainText:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Plain Text QR Code on the page item

Parameter

Type

Description

plainText

String

QR code Plain Text (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional)

undefined createTextMsgQRCode (cellNumber:String, textMessage:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Text Msg QR Code on the page item or document

Parameter

Type

Description

cellNumber

String

QR code Text Phone Number (Optional)

textMessage

String

QR code Text Message (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional)

undefined createVCardQRCode (firstName:String, lastName:String, jobTitle:String, cellPhone:String, phone:String, email:String, organisation:String, streetAddress:String, city:String, adrState:String, country:String, postalCode:String, website:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Business Card QR Code on the page item or load on document's placegun

Parameter

Type

Description

firstName

String

QR code Business Card First Name (Optional)

lastName

String

QR code Business Card Last Name (Optional)

jobTitle

String

QR code Business Card Title (Optional)

cellPhone

String

QR code Business Card Cell Phone Number (Optional)

phone

String

QR code Business Card Phone Number (Optional)

email

String

QR code Business Card Email Address (Optional)

organisation

String

QR code Business Card Organisation (Optional)

streetAddress

String

QR code Business Card Street Address (Optional)

city

String

QR code Business Card City (Optional)

adrState

String

QR code Business Card State (Optional)

country

String

QR code Business Card Country (Optional)

postalCode

String

QR code Business Card Postal Code (Optional)

website

String

QR code Business Card URL (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional)

undefined detach ()

Detaches an overridden master page item from the master page.

PageItem duplicate (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)

Duplicates the SplineItem at the specified location or offset.

Parameter

Type

Description

to

Array of 2 Units

Page

Spread

Layer

The location of the new SplineItem, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

by

Array of Number

Array of String

Amount by which to offset the new SplineItem from the original SplineItem's position. (Optional)

PageItem excludeOverlapPath (with:Array of PageItem)

Creates a new page item by excluding the overlapping areas of the SplineItem and other objects.

Parameter

Type

Description

with

Array of PageItem

The object(s) to exclude.

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

Exports the object(s) to a file.

Parameter

Type

Description

format

ExportFormat

ExportFormat.EPS_TYPE

ExportFormat.EPUB

ExportFormat.FIXED_LAYOUT_EPUB

ExportFormat.HTML

ExportFormat.HTMLFXL

ExportFormat.INCOPY_MARKUP

ExportFormat.INDESIGN_MARKUP

ExportFormat.INDESIGN_SNIPPET

ExportFormat.INTERACTIVE_PDF

ExportFormat.JPG

ExportFormat.PACKAGED_XFL

ExportFormat.PDF_TYPE

ExportFormat.PNG_FORMAT

ExportFormat.RTF

ExportFormat.SWF

ExportFormat.TAGGED_TEXT

ExportFormat.TEXT_TYPE

ExportFormat.XML

String

The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.

to

File

The path to the export file.

showingOptions

Boolean

If true, displays the export options dialog. (Optional)

(default: false)

using

PDFExportPreset

The export style. (Optional)

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

PageItem findObject (reverseOrder:Boolean)

Finds objects that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

undefined fit (given:FitOptions)

Applies the specified fit option to content in a frame.

Parameter

Type

Description

given

FitOptions

FitOptions.APPLY_FRAME_FITTING_OPTIONS

FitOptions.CENTER_CONTENT

FitOptions.CONTENT_TO_FRAME

FitOptions.FILL_PROPORTIONALLY

FitOptions.FRAME_TO_CONTENT

FitOptions.PROPORTIONALLY

The fit option to use.

undefined flipItem (given:Flip, around:Array of Varies 2 Units AnchorPoint)

Flips the SplineItem.

Parameter

Type

Description

given

Flip

Flip.BOTH

Flip.HORIZONTAL

Flip.HORIZONTAL_AND_VERTICAL

Flip.NONE

Flip.VERTICAL

The axis around which to flip the SplineItem.

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 around which to flip the SplineItem. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

SplineItem 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.

PageItem intersectPath (with:Array of PageItem)

Creates a new page item by intersecting the SplineItem with other objects. Returns an error if the objects do not intersect.

Parameter

Type

Description

with

Array of PageItem

The object(s) with which to intersect.

PageItem makeCompoundPath (with:Array of PageItem)

Creates a compound path by combining the path(s) of the SplineItem with the paths of other objects.

Parameter

Type

Description

with

Array of PageItem

The other objects whose paths to include in the new compound path.

undefined markup (using:XMLElement)

Associates the page item with the specified XML element while preserving existing content.

Parameter

Type

Description

using

XMLElement

The XML element.

PageItem minusBack (with:Array of PageItem)

Creates a new page item by reverse subtracting the overlapping areas of the SplineItem and other objects.

Parameter

Type

Description

with

Array of PageItem

The object(s) to reverse subtract.

undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)

Moves the SplineItem to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.

Parameter

Type

Description

to

Array of 2 Units

Page

Spread

Layer

The new location of the SplineItem,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

by

Array of Number

Array of String

The amount (in measurement units) to move the SplineItem relative to its current position, in the format (x, y). (Optional)

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)

Places the 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 placeXML (using:XMLElement)

Places XML content into the specified object. Note: Replaces any existing content.

Parameter

Type

Description

using

XMLElement

The XML element whose content you want to place.

undefined redefineScaling (to:Array of Number)

Apply an item's scaling to its content if possible.

Parameter

Type

Description

to

Array of Number

The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

undefined reframe (in:Varies CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, opposingCorners:Array of Varies)

Move the bounding box of the page item

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

BoundsKind:BoundingBoxLimits

OrderedarraycontainingcoordinateSpace:CoordinateSpaces

The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.

opposingCorners

Array of Varies

Opposing corners of new bounding box in the given coordinate space

PageItem releaseCompoundPath ()

Releases a compound path.

undefined remove ()

Deletes the SplineItem.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resize (in:Varies BoundingBoxLimits CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, by:ResizeMethods, values:Array of Varies Reals ResizeConstraintss CoordinateSpacess, [resizeIndividually:Boolean=Boolean], [consideringRulerUnits:Boolean=Boolean])

Resize the page item.

Parameter

Type

Description

in

BoundingBoxLimits

BoundingBoxLimits.GEOMETRIC_PATH_BOUNDS

BoundingBoxLimits.OUTER_STROKE_BOUNDS

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

BoundsKind:BoundingBoxLimits

OrderedarraycontainingcoordinateSpace:CoordinateSpaces

The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.

from

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

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

by

ResizeMethods

ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO

ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY

ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH

ResizeMethods.RESHAPING_AREA_TO_RATIO

ResizeMethods.RESHAPING_BORDER_TO_RATIO

How the current dimensions are affected by the given values

values

Array of Reals

Array of ResizeConstraintss ResizeConstraints

Array of CoordinateSpacess CoordinateSpaces

The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.

resizeIndividually

Boolean

If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional)

(default: true)

consideringRulerUnits

Boolean

If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

Varies resolve (location:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, in:CoordinateSpaces, [consideringRulerUnits:Boolean=Boolean])

Get the coordinates of the given location in the specified coordinate system.

Parameter

Type

Description

location

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

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use.

consideringRulerUnits

Boolean

If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

Boolean revert ()

Reverts the document to its state at the last save operation.

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

SelectionOptions.SET_KEY

The selection status of the SplineItem in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

undefined sendBackward ()

Sends the SplineItem back one level in its layer.

undefined sendToBack (reference:PageItem)

Sends the SplineItem to the back of its layer or behind a particular item (must have same parent).

Parameter

Type

Description

reference

PageItem

The reference object to send the object behind (Optional)

Asset store (using:Library, withProperties:Object)

Stores the object in the specified library.

Parameter

Type

Description

using

Library

The library in which to store the object.

withProperties

Object

Initial values for properties of the new SplineItem (Optional)

PageItem subtractPath (with:Array of PageItem)

Creates a new page item by subtracting the overlapping areas of the SplineItem and other objects.

Parameter

Type

Description

with

Array of PageItem

The object(s) to subtract.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])

Transform the page item.

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use

from

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

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

withMatrix

Array of 6 Reals

TransformationMatrix

Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.

replacingCurrent

Array of MatrixContent enumerators

MatrixContent

MatrixContent.ROTATION_VALUE

MatrixContent.SCALE_VALUES

MatrixContent.SHEAR_VALUE

MatrixContent.TRANSLATION_VALUES

LongInteger

Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)

consideringRulerUnits

Boolean

If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

String transformAgain ()

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

String transformAgainIndividually ()

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

String transformSequenceAgain ()

Transforms the SplineItem 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 SplineItem 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.

TransformationMatrix transformValuesOf (in:CoordinateSpaces)

Get the transformation values of the page item.

Parameter

Type

Description

in

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PAGE_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use

Object of

AnchoredObjectSetting.parent

AnimationSetting.parent

AutofitPageItemSettings.parent

Button.parent

CheckBox.parent

ComboBox.parent

ContentTransparencySetting.parent

EPS.parent

EPSText.parent

EndnoteTextFrame.parent

Event.parent

EventListener.parent

FillTransparencySetting.parent

FormField.parent

Graphic.parent

GraphicLine.parent

Group.parent

HtmlItem.parent

Image.parent

ImportedPage.parent

LinkedPageItemOption.parent

ListBox.parent

MediaItem.parent

Movie.parent

MultiStateObject.parent

MutationEvent.parent

ObjectExportOption.parent

Oval.parent

PDF.parent

PICT.parent

PageItem.parent

Path.parent

Polygon.parent

Preference.parent

RadioButton.parent

Rectangle.parent

SignatureField.parent

Sound.parent

SplineItem.parent

StrokeTransparencySetting.parent

TextBox.parent

TextFrame.parent

TextPath.parent

TextWrapPreference.parent

TimingSetting.parent

TransparencySetting.parent

TypefiPageItemSettings.parent

WMF.parent

Return

SplineItem.getElements()

SplineItems.anyItem()

SplineItems.everyItem()

SplineItems.nextItem()

SplineItems.previousItem()

SplineItems.itemByID()

SplineItems.item()

SplineItems.[]()

SplineItems.itemByName()

SplineItems.itemByRange()

SplineItems.firstItem()

SplineItems.lastItem()

SplineItems.middleItem()