a surface object to be used for drawings (SVG)
See the dojox/gfx/svg_attach.Surface reference documentation for more information.
Will be used as default for Text/TextPath/Group objects that created by this surface and textDir wasn't directly specified for them, though the bidi support was loaded. Can be set in two ways:
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
submits the current batch, append all pending child shapes to DOM
submits the current batch, append all pending child shapes to DOM
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 a mask object
Parameter | Type | Description |
---|---|---|
mask | Object | A mask object (see dojox/gfx.svg.Mask.defaultMask) |
Define a mask where content coordinates are fractions of the bounding box of the object using the mask:
var mask = surface.createMask({ maskContentUnits: "objectBoundingBox" }); mask.createRect({ width: 1, height: 1 }); mask.setFill({ type: 'linear', x2: 1, y2: 0, colors: [ { offset: 0, color: '#111' }, { offset: 1, color: '#ddd' } ] });
A mask with dimensions in user coordinates of element referring to mask
var mask = { maskUnits: 'userSpaceOnUse' };
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) |
returns a node, which can be used to attach event listeners
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
Parameter | Type | Description |
---|---|---|
shape | undefined | |
silently | undefined |
sets the width and height of the rawNode
Parameter | Type | Description |
---|---|---|
width | String | width of surface, e.g., "100px" |
height | String | height of surface, e.g., "100px" |
sets the width and height of the rawNode
Used for propagation and change of textDir. newTextDir will be forced as textDir for all of it's children (Group/Text/TextPath).
Parameter | Type | Description |
---|---|---|
newTextDir | String |
Parameter | Type | Description |
---|---|---|
context | Object | Null | |
method | Function | String |
local event, fired once when the surface is created asynchronously, used only when isLoaded is false, required only for Silverlight.
Parameter | Type | Description |
---|---|---|
surface | dojox/gfx/shape.Surface |
Define a mask where content coordinates are fractions of the bounding box of the object using the mask:
var mask = surface.createMask({ maskContentUnits: "objectBoundingBox" }); mask.createRect({ width: 1, height: 1 }); mask.setFill({ type: 'linear', x2: 1, y2: 0, colors: [ { offset: 0, color: '#111' }, { offset: 1, color: '#ddd' } ] });
A mask with dimensions in user coordinates of element referring to mask
var mask = { maskUnits: 'userSpaceOnUse' };