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 [] (index:Number)

Returns the Oval with the specified index.

Parameter	Type	Description
index	Number	The index.

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

Creates 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	The location at which to insert the Oval relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
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. (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 LongInteger String)

Returns the Oval with the specified index or name.

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

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer 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 LongInteger Oval String, to:Varies LongInteger Oval String)

Returns the Ovals within the specified range.

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

Parameter

Type

Description

from

LongInteger

Oval

String

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

LongInteger

Oval

String

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