a generalized path shape
| Parameter | Type | Description |
|---|---|---|
| rawNode | Node | a DOM node to be used by this path object |
See the dojox/gfx/_gfxBidiSupport.Path reference documentation for more information.
converts an array of arguments to plain numeric values
| Parameter | Type | Description |
|---|---|---|
| array | Array | an output argument (array of numbers) |
| args | Array | an input argument (can be values of Boolean, Number, dojox/gfx.Point, or an embedded array of them) |
returns an array of four points or null four points represent four corners of the untransformed bounding box
returns the cumulative ('real') transformation matrix by combining the shape's matrix with its parent's matrix
renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()
renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()
adds a segment
| Parameter | Type | Description |
|---|---|---|
| action | String | valid SVG code for a segment's type |
| args | Array | a list of parameters for this segment |
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 |
forms a path using an SVG path string
| Parameter | Type | Description |
|---|---|---|
| path | String | an SVG path string |
updates the bounding box of path with new point
| Parameter | Type | Description |
|---|---|---|
| x | Number | an x coordinate |
| y | Number | a y coordinate |
| m | undefined |
updates the parent matrix with new matrix
| Parameter | Type | Description |
|---|---|---|
| matrix | dojox/gfx/Matrix2D | a 2D matrix or a matrix-like object |
updates the bounding box of path with new segment
| Parameter | Type | Description |
|---|---|---|
| segment | Object | a segment |
| matrix | undefined |
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) |
multiplies the existing matrix with an argument on left side (matrix * this.matrix)
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) |
multiplies the existing matrix with an argument on right side (this.matrix * matrix)
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) |
a shortcut for dojox/gfx/shape.Shape.applyRightTransform
forms an elliptic arc segment
forms an elliptic arc segment
connects a handler to an event on this shape
| Parameter | Type | Description |
|---|---|---|
| name | undefined | |
| object | undefined | |
| method | undefined |
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.
connects a handler by token from an event on this shape
| Parameter | Type | Description |
|---|---|---|
| token | undefined |
returns a Node, which is used as a source of events for this shape
Returns the current fill object or null (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/Color)
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 the parent Shape, Group or null if this Shape is unparented. (see dojox/gfx/shape.Surface, or dojox/gfx.Group)
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 the current stroke object or null (see dojox/gfx.defaultStroke)
Returns the current transformation matrix applied to this Shape or null
returns an array of four points or null four points represent four corners of the untransformed bounding box
forms a horizontal line segment
forms a horizontal line segment
moves a shape to back of its parent's list of shapes
moves a shape to back of its parent's list of shapes
moves a shape to front of its parent's list of shapes
moves a shape to front of its parent's list of shapes
Connects an event to this shape.
| Parameter | Type | Description |
|---|---|---|
| type | undefined | |
| listener | undefined |
forms a quadratic curve segment
forms a quadratic curve segment
forms a quadratic smooth curve segment
forms a quadratic smooth curve segment
removes the shape from its parent's list of shapes
| Parameter | Type | Description |
|---|---|---|
| silently | Boolean | if true, do not redraw a picture yet |
removes the shape from its parent's list of shapes
sets an absolute or relative mode for path points
| Parameter | Type | Description |
|---|---|---|
| mode | Boolean | true/false or "absolute"/"relative" to specify the mode |
sets an absolute or relative mode for path points
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:
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 |
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"});
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) |
sets a fill object (the default implementation simply ignores it)
forms a path using a shape
| Parameter | Type | Description |
|---|---|---|
| newShape | Object | an SVG path string or a path object (see dojox/gfx.defaultPath) |
forms a path using a shape
sets a stroke object (the default implementation simply ignores it)
| Parameter | Type | Description |
|---|---|---|
| stroke | Object | a stroke object (see dojox/gfx.defaultStroke) |
sets a stroke object (the default implementation simply ignores it)
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) |
forms a smooth curve segment
forms a smooth curve segment
forms a vertical line segment
forms a vertical line segment