dojox/gfx/shape.Container (version 1.10)

Summary

a container of shapes, which can be used as a foundation for renderer-specific groups, or as a way to logically group shapes (e.g, to propagate matricies)

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

Method Summary

  • _init()
  • _moveChildToBack(shape) moves a shape to back of the list of shapes
  • _moveChildToFront(shape) moves a shape to front of the list of shapes
  • add(shape) adds a shape to the list
  • clear(destroy) removes all shapes from a group/surface.
  • closeBatch() submits the current batch, append all pending child shapes to DOM
  • getBoundingBox() Returns the bounding box Rectangle for this shape.
  • openBatch() starts a new batch, subsequent new child shapes will be held in the batch instead of appending to the container directly.
  • remove(shape,silently) removes a shape from the list

Methods

_init()
Defined by dojox/gfx/shape
_moveChildToBack(shape)
Defined by dojox/gfx/shape

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/shape

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/shape

adds a shape to the list

Parameter Type Description
shape dojox/gfx/shape.Shape

the shape to add to the list

Returns:undefined
clear(destroy)
Defined by dojox/gfx/shape

removes all shapes from a group/surface.

Parameter Type Description
destroy Boolean
Optional

Indicates whether the children should be destroyed. Optional.

Returns:function

removes all shapes from a group/surface.

closeBatch()
Defined by dojox/gfx/shape

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

On canvas, this method flushes the pending redraws queue.

Returns:function

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

getBoundingBox()
Defined by dojox/gfx/shape

Returns the bounding box Rectangle for this shape.

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

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

Because the canvas renderer has no DOM hierarchy, the canvas implementation differs such that it suspends the repaint requests for this container until the current batch is closed by a call to closeBatch().

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/shape

removes a shape from the list

Parameter Type Description
shape dojox/gfx/shape.Shape

the shape to remove

silently Boolean

if true, do not redraw a picture yet

Returns:function

removes a shape from the list

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