Ovals

A collection of ellipses.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

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

Method Listing

Oval add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document MasterSpread Page Spread Layer, withProperties:Object)

Create a new Oval

Parameter	Type	Description
layer	Layer	The layer on which to create the Oval. (Optional)
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	Location (Optional) (default: LocationOptions.UNKNOWN)
reference	Document MasterSpread Page Spread Layer	Before/after this Oval or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (Optional)
withProperties	Object	Initial values for properties of the new Oval (Optional)

Oval anyItem ()

Returns any Oval in the collection.

Number count ()

Displays the number of elements in the Oval.

Oval everyItem ()

Returns every Oval in the collection.

Oval firstItem ()

Returns the first Oval in the collection.

Oval item (index:Varies Long String)

Returns the Oval with the specified index or name.

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

Parameter

Type

Description

index

Long

String

The index or name. Can accept: Long or String.

Oval itemByID (id:Number)

Returns the Oval with the specified ID.

Parameter	Type	Description
id	Number	The ID.

Oval itemByName (name:String)

Returns the Oval with the specified name.

Parameter	Type	Description
name	String	The name.

Oval itemByRange (from:Varies Long Oval String, to:Varies Long Oval String)

Returns the Ovals within the specified range.

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

Parameter

Type

Description

from

Long

Oval

String

The Oval, index, or name at the beginning of the range. Can accept: Oval, Long or String.

Long

Oval

String

The Oval, index, or name at the end of the range. Can accept: Oval, Long or String.