Polygons
See also Polygon.
QuickLinks
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. |
Polygon lastItem ()
Returns the last Polygon in the collection.
Polygon middleItem ()
Returns the middle Polygon in the collection.
Polygon nextItem (obj:
Polygon)
Returns the Polygon whose index follows the specified Polygon in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Polygon | The Polygon whose index comes before the desired Polygon. |
Polygon previousItem (obj:
Polygon)
Returns the Polygon with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Polygon | The index of the Polygon that follows the desired Polygon. |
string toSource ()
Generates a string which, if executed, will return the Polygon.
Element of
Button.polygons
Cell.polygons
Character.polygons
Document.polygons
Footnote.polygons
GraphicLine.polygons
Group.polygons
InsertionPoint.polygons
Layer.polygons
Line.polygons
MasterSpread.polygons
MultiStateObject.polygons
Oval.polygons
Page.polygons
Paragraph.polygons
PlaceGun.polygons
Polygon.polygons
Rectangle.polygons
Snippet.polygons
SplineItem.polygons
Spread.polygons
State.polygons
Story.polygons
Table.polygons
Text.polygons
TextColumn.polygons
TextFrame.polygons
TextStyleRange.polygons
Word.polygons
XmlStory.polygons
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |