dojox/gfx/svg_attach.Surface (version 1.10)

Summary

a surface object to be used for drawings (SVG)

Usage

var foo = new svg_attach.Surface();
dojox/gfx/svg

See the dojox/gfx/svg_attach.Surface reference documentation for more information.

Property Summary

  • isLoaded
  • textDirWill 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.

Method Summary

Event Summary

  • onLoad(surface) local event, fired once when the surface is created asynchronously, used only when isLoaded is false, required only for Silverlight.

Properties

isLoaded
Defined by: dojox/gfx/shape
textDir

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:

  1. When the surface is created and textDir value passed to it as fourth parameter.
  2. Using the setTextDir(String) function, when this function is used the value of textDir propagates to all of it's children and the children of children (for Groups) etc.

Methods

_getRealMatrix()
Defined by dojox/gfx/shape

always returns the identity matrix

Returns:null
_init()
Defined by dojox/gfx/shape
_moveChildToBack(shape)
Defined by dojox/gfx/svg

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

Returns:function

moves a shape to back of the list of shapes

_moveChildToFront(shape)
Defined by dojox/gfx/svg

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

Returns:function

moves a shape to front of the list of shapes

add(shape)
Defined by dojox/gfx/svg_mask
Parameter Type Description
shape undefined
Returns:function
clear()
Defined by dojox/gfx/svg

removes all shapes from a group/surface

Returns:undefined
closeBatch()
Defined by dojox/gfx/svg

submits the current batch, append all pending child shapes to DOM

Returns:function

submits the current batch, append all pending child shapes to DOM

connect(name,object,method)
Defined by dojox/gfx/svg
Parameter Type Description
name undefined
object undefined
method undefined
Returns:Array
createCircle(circle)
Defined by dojox/gfx/shape

creates a circle shape

Parameter Type Description
circle Object

a circle object (see dojox/gfx.defaultCircle)

Returns:undefined
createEllipse(ellipse)
Defined by dojox/gfx/shape

creates an ellipse shape

Parameter Type Description
ellipse Object

an ellipse object (see dojox/gfx.defaultEllipse)

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

creates a group shape

Returns:undefined
createImage(image)
Defined by dojox/gfx/shape

creates a image shape

Parameter Type Description
image Object

an image object (see dojox/gfx.defaultImage)

Returns:undefined
createLine(line)
Defined by dojox/gfx/shape

creates a line shape

Parameter Type Description
line Object

a line object (see dojox/gfx.defaultLine)

Returns:undefined
createMask(mask)
Defined by dojox/gfx/svg_mask

Creates a mask object

Parameter Type Description
mask Object

A mask object (see dojox/gfx.svg.Mask.defaultMask)

Returns:undefined

Examples

Example 1

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' }
    ]
});

Example 2

A mask with dimensions in user coordinates of element referring to mask

var mask = {
    maskUnits: 'userSpaceOnUse'
};
createObject(shapeType,rawShape)
Defined by dojox/gfx/svg

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

Returns:null | instance
createPath(path)
Defined by dojox/gfx/shape

creates a path shape

Parameter Type Description
path Object

a path object (see dojox/gfx.defaultPath)

Returns:undefined
createPolyline(points)
Defined by dojox/gfx/shape

creates a polyline/polygon shape

Parameter Type Description
points Object

a points object (see dojox/gfx.defaultPolyline) or an Array of points

Returns:undefined
createRect(rect)
Defined by dojox/gfx/shape

creates a rectangle shape

Parameter Type Description
rect Object

a path object (see dojox/gfx.defaultRect)

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

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

Returns:any | undefined | null

dojox/gfx/shape.Shape | Null a fully instantiated surface-specific Shape object

createText(text)
Defined by dojox/gfx/shape

creates a text shape

Parameter Type Description
text Object

a text object (see dojox/gfx.defaultText)

Returns:undefined
createTextPath(text)
Defined by dojox/gfx/shape

creates a text shape

Parameter Type Description
text Object

a textpath object (see dojox/gfx.defaultTextPath)

Returns:undefined
createViewport()
Defined by dojox/gfx3d/object
Returns:undefined
destroy()
Defined by dojox/gfx/svg
disconnect(token)
Defined by dojox/gfx/svg
Parameter Type Description
token undefined
getBoundingBox()
Defined by dojox/gfx/svg

Returns the bounding box Rectangle for this shape.

Returns:null
getDimensions()
Defined by dojox/gfx/svg

returns an object with properties "width" and "height"

Returns:null
getEventSource()
Defined by dojox/gfx/shape

returns a node, which can be used to attach event listeners

Returns:undefined
getTextDir()
Returns:undefined
on(type,listener)
Defined by dojox/gfx/shape

Connects an event to this shape.

Parameter Type Description
type undefined
listener undefined
Returns:undefined
openBatch()
Defined by dojox/gfx/svg

starts a new batch, subsequent new child shapes will be held in the batch instead of appending to the container directly

Returns:function

starts a new batch, subsequent new child shapes will be held in the batch instead of appending to the container directly

remove(shape,silently)
Defined by dojox/gfx/svg_mask
Parameter Type Description
shape undefined
silently undefined
Returns:function
setDimensions(width,height)
Defined by dojox/gfx/svg

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"

Returns:function

sets the width and height of the rawNode

setTextDir(newTextDir)

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
whenLoaded(context,method)
Defined by dojox/gfx/shape
Parameter Type Description
context Object | Null
method Function | String

Events

onLoad(surface)
Defined by: dojox/gfx/shape

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

Examples

Example 1

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' }
    ]
});

Example 2

A mask with dimensions in user coordinates of element referring to mask

var mask = {
    maskUnits: 'userSpaceOnUse'
};
Error in the documentation? Can’t find what you are looking for? Let us know!