dojox/gfx/shape.Ellipse (version 1.10)

Summary

a generic ellipse

Usage

var foo = new shape.Ellipse(rawNode);
dojox/gfx/shape
Parameter Type Description
rawNode Node

a DOM Node

See the dojox/gfx/shape.Ellipse reference documentation for more information.

Method Summary

  • _applyTransform() physically sets a matrix
  • _getRealMatrix() returns the cumulative ('real') transformation matrix by combining the shape's matrix with its parent's matrix
  • _moveToBack() renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()
  • _moveToFront() renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()
  • _setParent(parent,matrix) sets a parent
  • _updateParentMatrix(matrix) updates the parent matrix with new matrix
  • applyLeftTransform(matrix) multiplies the existing matrix with an argument on left side (matrix * this.matrix)
  • applyRightTransform(matrix) multiplies the existing matrix with an argument on right side (this.matrix * matrix)
  • applyTransform(matrix) a shortcut for dojox/gfx/shape.Shape.applyRightTransform
  • connect(name,object,method) connects a handler to an event on this shape
  • destroy() Releases all internal resources owned by this shape.
  • disconnect(token) connects a handler by token from an event on this shape
  • getBoundingBox() returns the bounding box
  • getClip()
  • getEventSource() returns a Node, which is used as a source of events for this shape
  • getFill() Returns the current fill object or null (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/Color)
  • getNode() Different graphics rendering subsystems implement shapes in different ways.
  • getParent() Returns the parent Shape, Group or null if this Shape is unparented. (see dojox/gfx/shape.Surface, or dojox/gfx.Group)
  • getShape() returns the current Shape object or null (see dojox/gfx.defaultPath, dojox/gfx.defaultPolyline, dojox/gfx.defaultRect, dojox/gfx.defaultEllipse, dojox/gfx.defaultCircle, dojox/gfx.defaultLine, or dojox/gfx.defaultImage)
  • getStroke() Returns the current stroke object or null (see dojox/gfx.defaultStroke)
  • getTransform() Returns the current transformation matrix applied to this Shape or null
  • getTransformedBoundingBox() returns an array of four points or null four points represent four corners of the untransformed bounding box
  • moveToBack() moves a shape to back of its parent's list of shapes
  • moveToFront() moves a shape to front of its parent's list of shapes
  • on(type,listener) Connects an event to this shape.
  • removeShape(silently) removes the shape from its parent's list of shapes
  • setClip(clip) sets the clipping area of this shape.
  • setFill(fill) sets a fill object (the default implementation simply ignores it)
  • setShape(shape) sets a shape object (the default implementation simply ignores it)
  • setStroke(stroke) sets a stroke object (the default implementation simply ignores it)
  • setTransform(matrix) sets a transformation matrix

Methods

_applyTransform()
Defined by dojox/gfx/shape

physically sets a matrix

Returns:function

physically sets a matrix

_getRealMatrix()
Defined by dojox/gfx/shape

returns the cumulative ('real') transformation matrix by combining the shape's matrix with its parent's matrix

Returns:undefined
_moveToBack()
Defined by dojox/gfx/shape

renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()

_moveToFront()
Defined by dojox/gfx/shape

renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()

_setParent(parent,matrix)
Defined by dojox/gfx/shape

sets a parent

Parameter Type Description
parent Object

a parent or null (see dojox/gfx/shape.Surface, or dojox/gfx.Group)

matrix dojox/gfx/matrix.Matrix2D

a 2D matrix or a matrix-like object

Returns:undefined
_updateParentMatrix(matrix)
Defined by dojox/gfx/shape

updates the parent matrix with new matrix

Parameter Type Description
matrix dojox/gfx/Matrix2D

a 2D matrix or a matrix-like object

Returns:undefined
applyLeftTransform(matrix)
Defined by dojox/gfx/shape

multiplies the existing matrix with an argument on left side (matrix * this.matrix)

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)

Returns:function

multiplies the existing matrix with an argument on left side (matrix * this.matrix)

applyRightTransform(matrix)
Defined by dojox/gfx/shape

multiplies the existing matrix with an argument on right side (this.matrix * matrix)

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)

Returns:function

multiplies the existing matrix with an argument on right side (this.matrix * matrix)

applyTransform(matrix)
Defined by dojox/gfx/shape

a shortcut for dojox/gfx/shape.Shape.applyRightTransform

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)

Returns:function

a shortcut for dojox/gfx/shape.Shape.applyRightTransform

connect(name,object,method)
Defined by dojox/gfx/shape

connects a handler to an event on this shape

Parameter Type Description
name undefined
object undefined
method undefined
Returns:undefined
destroy()
Defined by dojox/gfx/shape

Releases all internal resources owned by this shape. Once this method has been called, the instance is considered destroyed and should not be used anymore.

disconnect(token)
Defined by dojox/gfx/shape

connects a handler by token from an event on this shape

Parameter Type Description
token undefined
Returns:undefined
getBoundingBox()
Defined by dojox/gfx/shape

returns the bounding box

Returns:object
getClip()
Defined by dojox/gfx/shape
Returns:undefined
getEventSource()
Defined by dojox/gfx/shape

returns a Node, which is used as a source of events for this shape

Returns:undefined
getFill()
Defined by dojox/gfx/shape

Returns the current fill object or null (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/Color)

Returns:undefined
getNode()
Defined by dojox/gfx/shape

Different graphics rendering subsystems implement shapes in different ways. This method provides access to the underlying graphics subsystem object. Clients calling this method and using the return value must be careful not to try sharing or using the underlying node in a general way across renderer implementation. Returns the underlying graphics Node, or null if no underlying graphics node is used by this shape.

Returns:undefined
getParent()
Defined by dojox/gfx/shape

Returns the parent Shape, Group or null if this Shape is unparented. (see dojox/gfx/shape.Surface, or dojox/gfx.Group)

Returns:undefined
getShape()
Defined by dojox/gfx/shape

returns the current Shape object or null (see dojox/gfx.defaultPath, dojox/gfx.defaultPolyline, dojox/gfx.defaultRect, dojox/gfx.defaultEllipse, dojox/gfx.defaultCircle, dojox/gfx.defaultLine, or dojox/gfx.defaultImage)

Returns:undefined
getStroke()
Defined by dojox/gfx/shape

Returns the current stroke object or null (see dojox/gfx.defaultStroke)

Returns:undefined
getTransform()
Defined by dojox/gfx/shape

Returns the current transformation matrix applied to this Shape or null

Returns:undefined
getTransformedBoundingBox()
Defined by dojox/gfx/shape

returns an array of four points or null four points represent four corners of the untransformed bounding box

Returns:null | Array
moveToBack()
Defined by dojox/gfx/shape

moves a shape to back of its parent's list of shapes

Returns:function

moves a shape to back of its parent's list of shapes

moveToFront()
Defined by dojox/gfx/shape

moves a shape to front of its parent's list of shapes

Returns:function

moves a shape to front of its parent's list of shapes

on(type,listener)
Defined by dojox/gfx/shape

Connects an event to this shape.

Parameter Type Description
type undefined
listener undefined
Returns:undefined
removeShape(silently)
Defined by dojox/gfx/shape

removes the shape from its parent's list of shapes

Parameter Type Description
silently Boolean

if true, do not redraw a picture yet

Returns:function

removes the shape from its parent's list of shapes

setClip(clip)
Defined by dojox/gfx/shape

sets the clipping area of this shape.

The clipping area defines the shape area that will be effectively visible. Everything that would be drawn outside of the clipping area will not be rendered. The possible clipping area types are rectangle, ellipse, polyline and path, but all are not supported by all the renderers. vml only supports rectangle clipping, while the gfx silverlight renderer does not support path clipping. The clip parameter defines the clipping area geometry, and should be an object with the following properties:

  • {x:Number, y:Number, width:Number, height:Number} for rectangular clip
  • {cx:Number, cy:Number, rx:Number, ry:Number} for ellipse clip
  • {points:Array} for polyline clip
  • {d:String} for a path clip.

The clip geometry coordinates are expressed in the coordinate system used to draw the shape. In other words, the clipping area is defined in the shape parent coordinate system and the shape transform is automatically applied.

Parameter Type Description
clip undefined

Examples

Example 1

The following example shows how to clip a gfx image with all the possible clip geometry: a rectangle, an ellipse, a circle (using the ellipse geometry), a polyline and a path:

surface.createImage({src:img, width:200,height:200}).setClip({x:10,y:10,width:50,height:50});
surface.createImage({src:img, x:100,y:50,width:200,height:200}).setClip({cx:200,cy:100,rx:20,ry:30});
surface.createImage({src:img, x:0,y:350,width:200,height:200}).setClip({cx:100,cy:425,rx:60,ry:60});
surface.createImage({src:img, x:300,y:0,width:200,height:200}).setClip({points:[350,0,450,50,380,130,300,110]});
surface.createImage({src:img, x:300,y:350,width:200,height:200}).setClip({d:"M 350,350 C314,414 317,557 373,450.0000 z"});
setFill(fill)
Defined by dojox/gfx/shape

sets a fill object (the default implementation simply ignores it)

Parameter Type Description
fill Object

a fill object (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/_base/Color)

Returns:function

sets a fill object (the default implementation simply ignores it)

setShape(shape)
Defined by dojox/gfx/shape

sets a shape object (the default implementation simply ignores it)

Parameter Type Description
shape Object

a shape object (see dojox/gfx.defaultPath, dojox/gfx.defaultPolyline, dojox/gfx.defaultRect, dojox/gfx.defaultEllipse, dojox/gfx.defaultCircle, dojox/gfx.defaultLine, or dojox/gfx.defaultImage)

Returns:function

sets a shape object (the default implementation simply ignores it)

setStroke(stroke)
Defined by dojox/gfx/shape

sets a stroke object (the default implementation simply ignores it)

Parameter Type Description
stroke Object

a stroke object (see dojox/gfx.defaultStroke)

Returns:function

sets a stroke object (the default implementation simply ignores it)

setTransform(matrix)
Defined by dojox/gfx/shape

sets a transformation matrix

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)

Returns:undefined
Error in the documentation? Can’t find what you are looking for? Let us know!