InDesign Server2025
API 20.5.0.49
Collection of Polygon

Polygons

A collection of polygons.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

Polygon

Returns the Polygon with the specified index.

index Number The index.
Polygon

Creates a new Polygon.

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

Returns any Polygon in the collection.

Number

Displays the number of elements in the Polygon.

Polygon[]

Returns every Polygon in the collection.

Polygon

Returns the first Polygon in the collection.

Polygon

Returns the Polygon with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
Polygon

Returns the Polygon with the specified ID.

id Number The ID.
Polygon

Returns the Polygon with the specified name.

name String The name.
Polygon[]

Returns the Polygons within the specified range.

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

Returns the last Polygon in the collection.

Polygon

Returns the middle Polygon in the collection.

Polygon

Returns the Polygon whose index follows the specified Polygon in the collection.

obj Polygon The Polygon whose index comes before the desired Polygon.
Polygon

Returns the Polygon with the index previous to the specified index.

obj Polygon The index of the Polygon that follows the desired Polygon.
String

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

Object of 37

Properties elsewhere that hold a Polygons.