dojox/gfx/shape (version 1.10)

Summary

This module contains the core graphics Shape API. Different graphics renderer implementation modules (svg, canvas, vml, silverlight, etc.) extend this basic api to provide renderer-specific implementations for each shape.

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

Property Summary

  • _eventsProcessing
  • Containera 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)
  • Creatorshape creators

Method Summary

  • byId(id) Returns the shape that matches the specified id.
  • Circle()
  • dispose(s,recurse) Removes the specified shape from the registry.
  • Ellipse()
  • fixCallback(gfxElement,fixFunction,scope,method) Wraps the callback to allow for tests and event normalization before it gets invoked.
  • Image()
  • Line()
  • Polyline()
  • Rect()
  • register(s) Register the specified shape into the graphics registry.
  • Shape()
  • Surface()
  • Text()

Properties

_eventsProcessing
Defined by: dojox/gfx/shape
Container
Defined by: dojox/gfx/shape

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)

Creator
Defined by: dojox/gfx/shape

shape creators

Methods

byId(id)
Defined by dojox/gfx/registry

Returns the shape that matches the specified id.

Parameter Type Description
id String

The unique identifier for this Shape.

Returns:dojox/gfx/shape.Shape | undefined
Circle()
Defined by dojox/gfx/shape
dispose(s,recurse)
Defined by dojox/gfx/registry

Removes the specified shape from the registry.

Parameter Type Description
s dojox/gfx/shape.Shape

The shape to unregister.

recurse Boolean
Optional
Ellipse()
Defined by dojox/gfx/shape
fixCallback(gfxElement,fixFunction,scope,method)
Defined by dojox/gfx/shape

Wraps the callback to allow for tests and event normalization before it gets invoked. This is where 'fixTarget' is invoked.

Parameter Type Description
gfxElement Object

The GFX object that triggers the action (ex.: dojox/gfx.Surface and dojox/gfx/shape.Shape). A new event property 'gfxTarget' is added to the event to reference this object. for easy manipulation of GFX objects by the event handlers.

fixFunction Function

The function that implements the logic to set the 'gfxTarget' property to the event. It should be 'dojox/gfx.fixTarget' for most of the cases

scope Object

Optional. The scope to be used when invoking 'method'. If omitted, a global scope is used.

method Function | String

The original callback to be invoked.

Image()
Defined by dojox/gfx/shape
Line()
Defined by dojox/gfx/shape
Polyline()
Defined by dojox/gfx/shape
Rect()
Defined by dojox/gfx/shape
register(s)
Defined by dojox/gfx/registry

Register the specified shape into the graphics registry.

Parameter Type Description
s dojox/gfx/shape.Shape

The shape to register.

Returns:Number

The unique id associated with this shape.

Shape()
Defined by dojox/gfx/shape
Surface()
Defined by dojox/gfx/shape
Text()
Defined by dojox/gfx/shape
Error in the documentation? Can’t find what you are looking for? Let us know!