An ellipse.
Go to Property Listing | Method Listing
addPath, applyObjectStyle, bringForward, bringToFront, checkIn, checkOut, detach, duplicate, excludeOverlapPath, exportFile, extractLabel, fit, flipItem, getElements, insertLabel, intersectPath, makeCompoundPath, markup, minusBack, move, override, place, placeXML, releaseCompoundPath, remove, removeOverride, resetScaling, resize, revert, rotate, select, sendBackward, sendToBack, shear, store, subtractPath, toSource, toSpecifier, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually
AnchoredObjectSetting, ArrowHead, BlendMode, Boolean, ContentType, CornerEffects, DisplaySettingOptions, EPSs, EndCap, EndJoin, FeatherCornerType, FeatherMode, Graphic, GraphicLines, Graphics, Groups, Guide, Images, Layer, LockStateValues, Movie, Movies, Number, Object, ObjectStyle, Ovals, PDFs, PICTs, PageItem, PageItems, Paths, Polygons, Rectangles, ShadowMode, Sound, Sounds, String, StrokeAlignment, StrokeCornerAdjustment, StrokeStyle, Swatch, TextFrames, TextPaths, TextWrapPreference, WMFs, XMLItem
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
read/write |
The horizontal scale of the Oval relative to its containing object. |
||
|
read/write |
The rotation angle of the Oval relative to its containing object. (Range: -360 to 360) |
||
|
read/write |
The skewing angle of the Oval relative to its containing object. (Range: -360 to 360) |
||
|
read/write |
The vertical scale of the Oval relative to its containing object. |
||
|
readonly |
Lists all graphics contained by the Oval. |
||
|
readonly |
Lists all page items contained by the Oval. |
||
|
readonly |
Anchored object settings. |
||
|
read/write |
The object style applied to the Oval. |
||
|
readonly |
The XML element associated with the Oval. |
||
|
read/write |
The blend mode used to combine the background with the color of the Oval. |
||
|
read/write |
The type of content that a frame can contain. |
||
|
read/write |
The shape to apply to corner points in a path. Note: corner effect differs from end join in that you can set a radius for a corner effect, whereas the rounded or beveled effect of an end join depends upon the stroke weight. |
||
|
read/write |
The radius of the corner |
||
|
read/write |
The end shape of an open path. |
||
|
read/write |
The corner join applied to the Oval. |
||
|
readonly |
A collection of EPS files. |
||
|
read/write |
The type of feathering. |
||
|
read/write |
The feather-enabling mode. |
||
|
Number (range 0 - 100) |
read/write |
The amount (as a percentage) of noise to apply to the feather. (Range: 0 to 100) |
|
|
read/write |
The width of the feathering. |
||
|
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Oval. . Can also accept: String. |
||
|
Number (range 0 - 100) |
read/write |
The percent of tint to use in the Oval's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
|
|
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. |
||
|
Number (range 0 - 100) |
read/write |
The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
|
|
read/write |
The bounds of the Oval excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. |
||
|
read/write |
The angle of a linear gradient applied to the fill of the Oval. (Range: -180 to 180) |
||
|
read/write |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Oval. |
||
|
read/write |
The starting point (in page coordinates) of a gradient applied to the fill of the Oval, in the format [x, y]. |
||
|
read/write |
The angle of a linear gradient applied to the stroke of the Oval. (Range: -180 to 180) |
||
|
read/write |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Oval. |
||
|
read/write |
The starting point (in page coordinates) of a gradient applied to the stroke of the Oval, in the format [x, y]. |
||
|
readonly |
A collection of graphic lines. |
||
|
readonly |
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
||
|
readonly |
A collection of groups. |
||
|
read/write |
The horizontal scaling applied to the Oval. |
||
|
readonly |
The unique ID of the Oval. |
||
|
readonly |
A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
||
|
readonly |
The index of the Oval within its containing object. |
||
|
read/write |
If true, the Oval blends in isolation. |
||
|
read/write |
The layer that the Oval is on. |
||
|
read/write |
If true, the Oval is a knockout group. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The arrowhead applied to the start of the path. |
||
|
read/write |
Display performance options for the Oval. |
||
|
readonly |
The lock state. |
||
|
read/write |
If true, the Oval is locked. |
||
|
Number (range 1 - 500) |
read/write |
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500) |
|
|
readonly |
A collection of movies. |
||
|
read/write |
If true, the Oval does not print. |
||
|
Number (range 0 - 100) |
read/write |
The opacity of the Oval. (Range: 0 to 100) |
|
|
readonly |
A collection of ellipses. |
||
|
read/write |
If true, the Oval's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
||
|
read/write |
If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
||
|
read/write |
If true, the Oval's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
||
|
readonly |
If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page. |
||
|
readonly |
An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. |
||
|
readonly |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
||
|
readonly |
The parent of the Oval (a Spread, MasterSpread, PageItem, Oval, Rectangle, Polygon, GraphicLine, Group, State, Document, Layer, Button, TextFrame, Story, Text, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, InsertionPoint, Page, Character or Footnote). |
||
|
readonly |
A collection of paths. |
||
|
readonly |
A collection of PDF files. |
||
|
readonly |
A collection of PICT graphics. |
||
|
readonly |
A collection of polygons. |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
A collection of rectangles. |
||
|
read/write |
The arrowhead applied to the end of the path. |
||
|
read/write |
The rotatation angle of the Oval. (Range: -360 to 360) |
||
|
read/write |
The blend mode to use for drawing the shadow. |
||
|
read/write |
The radius of the shadow blur. |
||
|
read/write |
The swatch (color or mixed ink) applied to the shadow. |
||
|
read/write |
The shadow mode. |
||
|
Number (range 0 - 100) |
read/write |
The amount (as a percentage) of noise to apply to the shadow. (Range: 0 to 100) |
|
|
Number (range 0 - 100) |
read/write |
The opacity of the shadow. (Range: 0 to 100) |
|
|
Number (range 0 - 100) |
read/write |
The amount (as a percentage) of the blur radius to use as the shadow footprint. (Range: 0 to 100) For information, see shadow blur radius. |
|
|
read/write |
The horizontal offset of the shadow. |
||
|
read/write |
The vertical offset of the shadow. |
||
|
read/write |
The skewing angle applied to the Oval. (Range: -360 to 360) |
||
|
readonly |
A collection of sound clips. |
||
|
read/write |
The stroke alignment applied to the Oval. |
||
|
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Oval. Can also accept: String. |
||
|
read/write |
The corner adjustment applied to the Oval. |
||
|
read/write |
The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3]. |
||
|
Number (range 0 - 100) |
read/write |
The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
|
|
read/write |
The stroke type |
||
|
read/write |
The weight (in points) to apply to the Oval's stroke. |
||
|
readonly |
A collection of text frames. |
||
|
readonly |
A collection of text paths. |
||
|
readonly |
The text wrap preference properties that define the default formatting for wrapping text around objects. |
||
|
read/write |
The vertical scaling applied to the Oval. |
||
|
read/write |
The bounds of the Oval including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. |
||
|
readonly |
A collection of WMF graphics. |
PageItem addPath (with:Array of PageItem)
Creates a new page item by combining the Oval with other objects. Deletes the objects if they do not intersect.
undefined applyObjectStyle (using:ObjectStyle, [clearingOverrides:Boolean=Boolean], [clearingOverridesThroughRootObjectStyle:Boolean=Boolean])
Applies the specified object style.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The object style to apply. |
|
|
clearingOverrides |
If true, clears the Oval's existing attributes before applying the style. (Optional) (default: true) |
|
|
clearingOverridesThroughRootObjectStyle |
If true, clears attributes and formatting applied to the Oval that are not defined in the object style. (Optional) (default: false) |
undefined bringForward ()
Brings the Oval forward one level in its layer.
undefined bringToFront ()
Brings the Oval to the front.
Boolean checkIn ()
Checks in the story.
Boolean checkOut ()
Checks out the story.
undefined detach ()
Detaches an overridden master page item from the master page.
PageItem duplicate (by:Array of Number String)
Duplicates the Oval.
|
Parameter |
Type |
Description |
|---|---|---|
|
by |
The amount (in points) to offset the new Oval, in the format [x, y]. (Optional) |
PageItem excludeOverlapPath (with:Array of PageItem)
Creates a new page item by excluding the overlapping areas of the Oval and other objects.
undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset)
Exports the object(s) to a file.
|
Parameter |
Type |
Description |
|---|---|---|
|
format |
The export format. Can accept: ExportFormat enumerator or String. |
|
|
to |
The path of the export file. |
|
|
showingOptions |
If true, prompts the user to select export options. (Optional) (default: false) |
|
|
using |
The export style to use. (Optional) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
undefined fit (given:FitOptions)
Applies the specified fit option to content in a frame.
|
Parameter |
Type |
Description |
|---|---|---|
|
given |
The fit option to use. |
undefined flipItem (given:FlipItemOptions, around:Array of Varies 2 Units AnchorPoint, [transformingContent:Boolean=Boolean])
Flip item about given axis
|
Parameter |
Type |
Description |
|---|---|---|
|
given |
flip item options |
|
|
around |
Array of 2 Units |
The point to flip around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
|
transformingContent |
If true then both the object and items within it are flipped (Optional) (default: true) |
Object getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
PageItem intersectPath (with:Array of PageItem)
Creates a new page item by intersecting the Oval with other objects. Returns an error if the objects do not intersect.
PageItem makeCompoundPath (with:Array of PageItem)
Creates a compound path by combining the path(s) of the Oval with the paths of other objects.
|
Parameter |
Type |
Description |
|---|---|---|
|
with |
The other objects whose paths to include in the new compound path. |
undefined markup (using:XMLElement)
Associates the page item with the specified XML element while preserving existing content.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The XML element. |
PageItem minusBack (with:Array of PageItem)
Creates a new page item by reverse subtracting the overlapping areas of the Oval and other objects.
undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String, [transformingContent:Boolean=Boolean])
Move Page Item to a new location. One of the 'To' or 'By' parameters is required.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
Array of 2 Units |
The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) |
|
by |
Amount by which to move the object relative to its current position (Optional) |
|
|
transformingContent |
If true then both the object and items within it are moved (Optional) (default: true) |
Varies override (destinationPage:Page)
Overrides a master page item and places the item on the document page as a new object.
|
Parameter |
Type |
Description |
|---|---|---|
|
destinationPage |
The document page that contains the master page item to override. |
Varies place (fileName:File, [showingOptions:Boolean=Boolean], withProperties:Object)
Place a file
|
Parameter |
Type |
Description |
|---|---|---|
|
fileName |
The file to place |
|
|
showingOptions |
Whether to display the import options dialog (Optional) (default: false) |
|
|
withProperties |
Initial values for properties of the placed object(s) (Optional) |
undefined placeXML (using:XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The XML element whose content you want to place. |
PageItem releaseCompoundPath ()
Releases a compound path.
undefined remove ()
Deletes the Oval.
undefined removeOverride ()
Removes the override from a previously overridden master page item.
undefined resetScaling ()
Resets the Oval's scaling to 100%. Note: This does not change the size of the Oval. Instead, it makes the current size of the Oval the basis for future scaling.
undefined resize (horizontalScale:Number, verticalScale:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentScale:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsScale:Boolean=Boolean])
Resize the page item. You must specify either horizontal scale or vertical scale or both.
|
Parameter |
Type |
Description |
|---|---|---|
|
horizontalScale |
The percentage of horizontal scale (Optional) |
|
|
verticalScale |
The percentage of vertical scale (Optional) |
|
|
around |
Array of 2 Units |
The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
|
consideringCurrentScale |
If true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false) |
|
|
transformingContent |
If true then both the object and items within it are scaled (Optional) (default: true) |
|
|
consideringParentsScale |
If true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false) |
Boolean revert ()
Reverts the document to its state at the last save operation.
undefined rotate (by:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentRotation:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsRotation:Boolean=Boolean])
Rotate the page item
|
Parameter |
Type |
Description |
|---|---|---|
|
by |
Angle by which to rotate the page item |
|
|
around |
Array of 2 Units |
The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
|
consideringCurrentRotation |
If true then the object's current rotation and new rotation will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false) |
|
|
transformingContent |
If true then both the object and items within it are rotated (Optional) (default: true) |
|
|
consideringParentsRotation |
If true then the object is rotated relative to its parent page item. If false it is rotated relative to the spread. Cannot rotate with considering current rotation and considering parents rotation both set at the same time. (Optional) (default: false) |
undefined select ([existingSelection:SelectionOptions=SelectionOptions])
Selects the object.
|
Parameter |
Type |
Description |
|---|---|---|
|
existingSelection |
The selection status of the Oval in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
undefined sendBackward ()
Sends the Oval back one level in its layer.
undefined sendToBack ()
Sends the Oval to the back.
undefined shear (by:Number, around:Array of Varies 2 Units AnchorPoint, [shearAxisAngle:Number=Number], [consideringCurrentShear:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsShear:Boolean=Boolean])
Shear the page item
|
Parameter |
Type |
Description |
|---|---|---|
|
by |
Angle by which to shear the object |
|
|
around |
Array of 2 Units |
The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
|
shearAxisAngle |
The amount that the shear axis is rotated. If 0 degree then shear at its horizontal axis. If 90 degrees then shear at the vertical axis. (Optional) (default: 0) |
|
|
consideringCurrentShear |
If true then the object's current shear and new shear will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false) |
|
|
transformingContent |
If true then both the object and items within it are sheared (Optional) (default: true) |
|
|
consideringParentsShear |
If true then the object is sheared relative to its parent page item. If false it is sheared relative to the spread. Cannot shear with considering current shear and considering parents shear both set at the same time. (Optional) (default: false) |
Asset store (using:Library)
Store a page item in a library
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The library in which to store |
PageItem subtractPath (with:Array of PageItem)
Creates a new page item by subtracting the overlapping areas of the Oval and other objects.
String toSource ()
Generates a string which, if executed, will return the Oval.
String toSpecifier ()
Retrieves the object specifier.
String transformAgain ()
Transforms the Oval using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.
String transformAgainIndividually ()
Transforms the Oval using the last transformation performed on any Oval. Transformations include moving, rotating, shearing, scaling, and flipping.
String transformSequenceAgain ()
Transforms the Oval using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
String transformSequenceAgainIndividually ()
Transforms the Oval using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
AssignedStory.storyReference
AnchoredObjectSetting.parent
EPS.parent
Graphic.parent
GraphicLine.parent
Group.parent
Image.parent
Movie.parent
Oval.parent
PDF.parent
PICT.parent
PageItem.parent
Path.parent
Polygon.parent
Rectangle.parent
Sound.parent
TextFrame.parent
TextPath.parent
TextWrapPreference.parent
WMF.parent