Adobe InDesign CS6 Server (8.0) Object Model JS: Polygons

InDesign Server CS6

previous page next page

Class

Polygons

A collection of polygons.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

Property	Type	Access	Description
length	number	readonly	The number of objects in the collection.

Methods

Instances

Polygon [] (index: number)
Returns the Polygon with the specified index.

Parameter	Type	Description
index	number	The index.

Polygon add ([layer: Layer][, numberOfSides: number][, insetPercentage: number][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new Polygon.

Parameter	Type	Description
layer	Layer	The layer on which to create the Polygon. (Optional)
numberOfSides	number	The number of sides to give the Polygon. (Range: 3 to 100) (Optional)
insetPercentage	number	The star inset percentage applied to the Polygon. (Optional)
at	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location at which to insert the Polygon relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
reference	Document Layer MasterSpread Page PageItem Spread	The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties	Object	Initial values for properties of the new Polygon (Optional)

Polygon anyItem ()
Returns any Polygon in the collection.

number count ()
Displays the number of elements in the Polygon.

Array of Polygon everyItem ()
Returns every Polygon in the collection.

Polygon firstItem ()
Returns the first Polygon in the collection.

Polygon item (index: varies)
Returns the Polygon with the specified index or name.

Parameter	Type	Description
index	Long Integer String	The index or name. Can accept: Long Integer or String.

Polygon itemByID (id: number)
Returns the Polygon with the specified ID.

Parameter	Type	Description
id	number	The ID.

Polygon itemByName (name: string)
Returns the Polygon with the specified name.

Parameter	Type	Description
name	string	The name.

Array of Polygon itemByRange (from: varies, to: varies)
Returns the Polygons within the specified range.

Parameter	Type	Description
from	Long Integer Polygon String	The Polygon, index, or name at the beginning of the range. Can accept: Polygon, Long Integer or String.
to	Long Integer Polygon String	The Polygon, index, or name at the end of the range. Can accept: Polygon, Long Integer or String.