A collection of ellipses.
Methods
Ovaladd ([layer:
Layer][, at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates a new Oval
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the Oval. (Optional) |
| at | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location at which to insert the Oval relative to the reference object or within the container object. (Optional) (default: UNKNOWN ) |
| reference | Document Spread MasterSpread Page Layer PageItem |
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 Oval (Optional) |
OvalanyItem ()
Returns any Oval in the collection.
number count ()
Displays the number of elements in the Oval.
Array of OvaleveryItem ()
Returns every Oval in the collection.
OvalfirstItem ()
Returns the first Oval in the collection.
Ovalitem (index:
any)
Returns the Oval with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
OvalitemByID (id:
number)
Returns the Oval with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
OvalitemByName (name:
string)
Returns the Oval with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of OvalitemByRange (from:
any, to:
any)
Returns the Ovals within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Oval Long Integer String |
The Oval, index, or name at the beginning of the range. Can accept: Oval, Long Integer or String. |
| to | Oval Long Integer String |
The Oval, index, or name at the end of the range. Can accept: Oval, Long Integer or String. |
OvallastItem ()
Returns the last Oval in the collection.
OvalmiddleItem ()
Returns the middle Oval in the collection.
OvalnextItem (obj:
Oval)
Returns the Oval whose index follows the specified Oval in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Oval | The Oval whose index comes before the desired Oval. |
OvalpreviousItem (obj:
Oval)
Returns the Oval with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Oval | The index of the Oval that follows the desired Oval. |
string toSource ()
Generates a string which, if executed, will return the Oval.
Element of:
Button.ovals
Cell.ovals
Character.ovals
Document.ovals
Footnote.ovals
GraphicLine.ovals
Group.ovals
InsertionPoint.ovals
Layer.ovals
Line.ovals
MasterSpread.ovals
Oval.ovals
Page.ovals
PageItem.ovals
Paragraph.ovals
Polygon.ovals
Rectangle.ovals
Spread.ovals
State.ovals
Story.ovals
Table.ovals
Text.ovals
TextColumn.ovals
TextFrame.ovals
TextStyleRange.ovals
Word.ovals