LayoutOvals

A collection of ellipses.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
 → Oval
anyItem(
)
 → Oval
count(
)
 → number
everyItem(
)
 → Oval
firstItem(
)
 → Oval
item(
index)
 → Oval
itemByID(
id)
 → Oval
itemByName(
name)
 → Oval
itemByRange(
from, to)
 → Oval
lastItem(
)
 → Oval
middleItem(
)
 → Oval
nextItem(
obj)
 → Oval
previousItem(
obj)
 → Oval
toSource(
)
 → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
 → Oval
Creates a new Oval
layer Layer The layer on which to create the Oval. (Optional)
at LocationOptions The location at which to insert the Oval relative to the reference object or within the container object. (Optional)
reference 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)
anyItem(
)
 → Oval
Returns any Oval in the collection.
count(
)
 → number
Displays the number of elements in the Oval.
everyItem(
)
 → Oval
Returns every Oval in the collection.
firstItem(
)
 → Oval
Returns the first Oval in the collection.
item(
index)
 → Oval
Returns the Oval with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
 → Oval
Returns the Oval with the specified ID.
id number The ID.
itemByName(
name)
 → Oval
Returns the Oval with the specified name.
name string The name.
itemByRange(
from, to)
 → Oval
Returns the Ovals within the specified range.
from The Oval, index, or name at the beginning of the range. Can accept: Oval, Long Integer or String.
to The Oval, index, or name at the end of the range. Can accept: Oval, Long Integer or String.
lastItem(
)
 → Oval
Returns the last Oval in the collection.
middleItem(
)
 → Oval
Returns the middle Oval in the collection.
nextItem(
obj)
 → Oval
Returns the Oval whose index follows the specified Oval in the collection.
obj Oval The Oval whose index comes before the desired Oval.
previousItem(
obj)
 → Oval
Returns the Oval with the index previous to the specified index.
obj Oval The index of the Oval that follows the desired Oval.
toSource(
)
 → string
Generates a string which, if executed, will return the Oval.