On this page

AWT. Ellipse

The Ellipse shape has the same constructor options as Rectangle

Constructor

new Ellipse(pos, dimopt, wopt, hopt)

Ellipse constructor

Parameters:

Name	Type	Attributes	Description
`pos`	Point \| Rectangle \| number \| Array.<number>
`dim`	Dimension \| number	<optional>
`w`	number	<optional>
`h`	number	<optional>

Source: AWT.js, line 1277

Extends

module:AWT.Rectangle

Members

dim :module:AWT.Dimension

The Dimension of the Rectangle

Type:

module:AWT.Dimension

Overrides: module:AWT.Rectangle#dim
Source: AWT.js, line 1266

pos :module:AWT.Point

The current position of the shape

Type:

module:AWT.Point

Overrides: module:AWT.Rectangle#pos
Source: AWT.js, line 1020

type :string

Shape type id

Type:

string

Overrides: module:AWT.Rectangle#type
Source: AWT.js, line 1368

Methods

add(shape) → {module:AWT.Rectangle}

Adds the boundaries of another shape to the current one

Parameters:

Name	Type	Description
`shape`	module:AWT.Shape	The `module:AWT.Shape` to be added

Overrides: module:AWT.Rectangle#add
Source: AWT.js, line 1165

Returns:

Type:: module:AWT.Rectangle

clip(ctx, fillRuleopt) → {external:CanvasRenderingContext2D}

Creates a clipping region on the specified HTML canvas 2D rendering context

Parameters:

Name	Type	Attributes	Default	Description
`ctx`	external:CanvasRenderingContext2D			The rendering context
`fillRule`	string	<optional>	'nonzero'	Can be 'nonzero' (default when not set) or 'evenodd'

Overrides: module:AWT.Rectangle#clip
Source: AWT.js, line 962

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

clone() → {module:AWT.Rectangle}

Clones this Rectangle

Overrides: module:AWT.Rectangle#clone
Source: AWT.js, line 1123

Returns:

Type:: module:AWT.Rectangle

contains(_p) → {boolean}

Checks if the provided module:AWT.Point is inside this shape.

Parameters:

Name	Type	Description
`_p`	module:AWT.Point	The point to check

Overrides: module:AWT.Rectangle#contains
Source: AWT.js, line 897

Returns:

Type:: boolean

equals(r) → {boolean}

Checks if two shapes are equivalent.

Parameters:

Name	Type	Description
`r`	module:AWT.Shape	The Shape to compare against

Overrides: module:AWT.Rectangle#equals
Source: AWT.js, line 1115

Returns:

Type:: boolean

fill(ctx, dirtyRegionopt) → {external:CanvasRenderingContext2D}

Fills the Shape with the current style in the provided HTML canvas context

Parameters:

Name	Type	Attributes	Description
`ctx`	external:CanvasRenderingContext2D		The canvas 2D rendering context where to fill this shape.
`dirtyRegion`	module:AWT.Rectangle	<optional>	The context region to be updated. Used as clipping region when drawing.

Overrides: module:AWT.Rectangle#fill
Source: AWT.js, line 919

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

getAttributes() → {object}

Gets a object with the basic attributes needed to rebuild this instance excluding functions,
parent references, constants and also attributes retaining the default value.
The resulting object is commonly usued to serialize elements in JSON format.

Overrides: module:AWT.Rectangle#getAttributes
Source: AWT.js, line 1242

Returns:

The resulting object, with minimal attrributes

Type:: object

getBounds() → {module:AWT.Rectangle}

Gets the enclosing Rectangle of this Shape.

Overrides: module:AWT.Rectangle#getBounds
Source: AWT.js, line 1091

Returns:

Type:: module:AWT.Rectangle

getCoords() → {string}

Gets a string with the co-ordinates of the upper-left and lower-right vertexs of this rectangle,
(with values rounded to int)

Overrides: module:AWT.Rectangle#getCoords
Source: AWT.js, line 1232

Returns:

Type:: string

getOppositeVertex() → {module:AWT.Point}

Gets the module:AWT.Point corresponding to the lower-right vertex of the Rectangle.

Overrides: module:AWT.Rectangle#getOppositeVertex
Source: AWT.js, line 1156

Returns:

Type:: module:AWT.Point

getShape(rect) → {module:AWT.Shape}

Gets a clone of this shape moved to the pos component of the rectangle and scaled
by its dim value.

Parameters:

Name	Type	Description
`rect`	module:AWT.Rectangle	The rectangle to be taken as a base for moving and scaling this shape.

Overrides: module:AWT.Rectangle#getShape
Source: AWT.js, line 888

Returns:

Type:: module:AWT.Shape

grow(dx, dy) → {module:AWT.Rectangle}

Expands the boundaries of this shape. This affects the current position and dimension.

Parameters:

Name	Type	Description
`dx`	number	The amount to grow (or decrease) in horizontal direction
`dy`	number	The amount to grow (or decrease) in vertical direction

Overrides: module:AWT.Rectangle#grow
Source: AWT.js, line 1144

Returns:

Type:: module:AWT.Rectangle

intersects(_r) → {boolean}

Checks if the provided Rectangle r intersects with this shape.

Parameters:

Name	Type	Description
`_r`	module:AWT.Rectangle

Overrides: module:AWT.Rectangle#intersects
Source: AWT.js, line 907

Returns:

Type:: boolean

isRect() → {boolean}

Shorthand method for determining if a Shape is an Rectangle

Overrides: module:AWT.Rectangle#isRect
Source: AWT.js, line 972

Returns:

Type:: boolean

moveBy(delta) → {module:AWT.Shape}

Shifts the shape a specified amount in horizontal and vertical directions

Parameters:

Name	Type	Description
`delta`	Point \| Dimension	The amount to shift the Shape

Overrides: module:AWT.Rectangle#moveBy
Source: AWT.js, line 839

Returns:

Type:: module:AWT.Shape

moveTo(newPos) → {module:AWT.Shape}

Moves this shape to a new position

Parameters:

Name	Type	Description
`newPos`	module:AWT.Point	The new position of the shape

Overrides: module:AWT.Rectangle#moveTo
Source: AWT.js, line 849

Returns:

Type:: module:AWT.Shape

preparePath(ctx) → {external:CanvasRenderingContext2D}

Prepares an HTML canvas 2D rendering context with a path that can be used to stroke a line,
to fill a surface or to define a clipping region.

Parameters:

Name	Type	Description
`ctx`	external:CanvasRenderingContext2D

Overrides: module:AWT.Rectangle#preparePath
Source: AWT.js, line 951

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

scaleBy(delta) → {module:AWT.Rectangle}

Multiplies the dimension of the Shape by the specified delta amount.

Parameters:

Name	Type	Description
`delta`	Point \| Dimension	Object containing the X and Y ratio to be scaled.

Overrides: module:AWT.Rectangle#scaleBy
Source: AWT.js, line 1132

Returns:

Type:: module:AWT.Rectangle

setAttributes(data) → {module:AWT.Rectangle}

Reads the properties of this Rectangle from a data object

Parameters:

Name	Type	Description
`data`	object	The data object to be parsed

Overrides: module:AWT.Rectangle#setAttributes
Source: AWT.js, line 1251

Returns:

Type:: module:AWT.Rectangle

setBounds(rect) → {module:AWT.Rectangle}

Sets this Rectangle the position and dimension of another one

Parameters:

Name	Type	Description
`rect`	module:AWT.Rectangle

Overrides: module:AWT.Rectangle#setBounds
Source: AWT.js, line 1100

Returns:

Type:: module:AWT.Rectangle

stroke(ctx) → {external:CanvasRenderingContext2D}

Draws this shape in the provided HTML canvas 2D rendering context.

Parameters:

Name	Type	Description
`ctx`	external:CanvasRenderingContext2D	The canvas 2D rendering context where to draw the shape.

Overrides: module:AWT.Rectangle#stroke
Source: AWT.js, line 939

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

toString() → {string}

Overwrites the original 'Object.toString' method with a more descriptive text

Overrides: module:AWT.Rectangle#toString
Source: AWT.js, line 980

Returns:

Type:: string