a group shape (SVG), which can be used to logically group shapes (e.g, to propagate matricies)
See the dojox/gfx/svg.Group reference documentation for more information.
returns the cumulative ('real') transformation matrix by combining the shape's matrix with its parent's matrix
moves a shape to back of the list of shapes
Parameter | Type | Description |
---|---|---|
shape | dojox/gfx/shape.Shape | one of the child shapes to move to the front |
moves a shape to back of the list of shapes
moves a shape to front of the list of shapes
Parameter | Type | Description |
---|---|---|
shape | dojox/gfx/shape.Shape | one of the child shapes to move to the front |
moves a shape to front of the list of shapes
moves a shape to back of its parent's list of shapes (SVG)
moves a shape to back of its parent's list of shapes (SVG)
moves a shape to front of its parent's list of shapes (SVG)
moves a shape to front of its parent's list of shapes (SVG)
Parameter | Type | Description |
---|---|---|
f | undefined | |
nodeType | undefined |
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 |
updates the parent matrix with new matrix
Parameter | Type | Description |
---|---|---|
matrix | dojox/gfx/Matrix2D | a 2D matrix or a matrix-like object |
adds a shape to a group/surface
Parameter | Type | Description |
---|---|---|
shape | dojox/gfx/shape.Shape | an VML shape object |
adds a shape to a group/surface
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
submits the current batch, append all pending child shapes to DOM
submits the current batch, append all pending child shapes to DOM
connects a handler to an event on this shape
Parameter | Type | Description |
---|---|---|
name | undefined | |
object | undefined | |
method | undefined |
creates a circle shape
Parameter | Type | Description |
---|---|---|
circle | Object | a circle object (see dojox/gfx.defaultCircle) |
creates an ellipse shape
Parameter | Type | Description |
---|---|---|
ellipse | Object | an ellipse object (see dojox/gfx.defaultEllipse) |
creates a image shape
Parameter | Type | Description |
---|---|---|
image | Object | an image object (see dojox/gfx.defaultImage) |
creates a line shape
Parameter | Type | Description |
---|---|---|
line | Object | a line object (see dojox/gfx.defaultLine) |
creates an instance of the passed shapeType class
Parameter | Type | Description |
---|---|---|
shapeType | Function | a class constructor to create an instance of |
rawShape | Object | properties to be passed in to the classes "setShape" method |
creates a path shape
Parameter | Type | Description |
---|---|---|
path | Object | a path object (see dojox/gfx.defaultPath) |
creates a polyline/polygon shape
Parameter | Type | Description |
---|---|---|
points | Object | a points object (see dojox/gfx.defaultPolyline) or an Array of points |
creates a rectangle shape
Parameter | Type | Description |
---|---|---|
rect | Object | a path object (see dojox/gfx.defaultRect) |
creates a shape object based on its type; it is meant to be used by group-like objects
Parameter | Type | Description |
---|---|---|
shape | Object | a shape descriptor object |
dojox/gfx/shape.Shape | Null a fully instantiated surface-specific Shape object
creates a text shape
Parameter | Type | Description |
---|---|---|
text | Object | a text object (see dojox/gfx.defaultText) |
creates a text shape
Parameter | Type | Description |
---|---|---|
text | Object | a textpath object (see dojox/gfx.defaultTextPath) |
Releases all internal resources owned by this shape. Once this method has been called, the instance is considered disposed 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
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 |
starts a new batch, subsequent new child shapes will be held in the batch instead of appending to the container directly
starts a new batch, subsequent new child shapes will be held in the batch instead of appending to the container directly
remove a shape from a group/surface
Parameter | Type | Description |
---|---|---|
shape | dojox/gfx/shape.Shape | an VML shape object |
silently | Boolean |
Optional if true, regenerate a picture |
remove a shape from a group/surface
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 the clipping area of this shape.
This method overrides the dojox/gfx/shape.Shape.setClip() method.
Parameter | Type | Description |
---|---|---|
clip | Object | an object that defines the clipping geometry, or null to remove clip. |
sets the clipping area of this shape.
sets a fill object (SVG)
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 (SVG)
sets a raw SVG node to be used by this shape
Parameter | Type | Description |
---|---|---|
rawNode | Node | an SVG node |
sets a shape object (SVG)
Parameter | Type | Description |
---|---|---|
newShape | 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) |
sets a shape object (SVG)
sets a stroke object (SVG)
Parameter | Type | Description |
---|---|---|
stroke | Object | a stroke object (see dojox/gfx.defaultStroke) |
sets a stroke object (SVG)
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) |