dojox/gfx/canvas_attach.Polyline (version 1.10)

Summary

a polyline/polygon shape (Canvas)

Usage

var foo = new canvas_attach.Polyline();
dojox/gfx/shape

See the dojox/gfx/canvas_attach.Polyline reference documentation for more information.

Property Summary

Method Summary

  • _applyTransform() physically sets a matrix
  • _getRealMatrix() returns the cumulative ('real') transformation matrix by combining the shape's matrix with its parent's matrix
  • _moveToBack() renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()
  • _moveToFront() renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()
  • _normalizePoints() normalize points to array of {x:number, y:number}
  • _render(ctx) render the shape
  • _renderClip(ctx)
  • _renderDashedStroke(ctx,apply)
  • _renderFill(ctx,apply)
  • _renderShape(ctx)
  • _renderStroke(ctx,apply)
  • _renderTransform(ctx)
  • _setParent(parent,matrix) sets a parent
  • _updateParentMatrix(matrix) updates the parent matrix with new matrix
  • applyLeftTransform(matrix) multiplies the existing matrix with an argument on left side (matrix * this.matrix)
  • applyRightTransform(matrix) multiplies the existing matrix with an argument on right side (this.matrix * matrix)
  • applyTransform(matrix) a shortcut for dojox/gfx/shape.Shape.applyRightTransform
  • connect()
  • destroy() Releases all internal resources owned by this shape.
  • disconnect()
  • getBoundingBox() Returns the bounding box Rectangle for this shape or null if a BoundingBox cannot be calculated for the shape on the current renderer or for shapes with no geometric area (points).
  • getClip()
  • getEventSource()
  • getFill() Returns the current fill object or null (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/Color)
  • getNode() Different graphics rendering subsystems implement shapes in different ways.
  • getParent() Returns the parent Shape, Group or null if this Shape is unparented. (see dojox/gfx/shape.Surface, or dojox/gfx.Group)
  • getShape() 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)
  • getStroke() Returns the current stroke object or null (see dojox/gfx.defaultStroke)
  • getTransform() Returns the current transformation matrix applied to this Shape or null
  • getTransformedBoundingBox() returns an array of four points or null four points represent four corners of the untransformed bounding box
  • moveToBack() moves a shape to back of its parent's list of shapes
  • moveToFront() moves a shape to front of its parent's list of shapes
  • on()
  • removeShape(silently) removes the shape from its parent's list of shapes
  • setClip(clip)
  • setFill(fill) sets a fill object (the default implementation simply ignores it)
  • setShape()
  • setStroke(stroke) sets a stroke object (the default implementation simply ignores it)
  • setTransform(matrix) sets a transformation matrix

Properties

canvasClip
Defined by: dojox/gfx/canvas

Methods

_applyTransform()
Defined by dojox/gfx/shape

physically sets a matrix

Returns:function

physically sets a matrix

_getRealMatrix()
Defined by dojox/gfx/shape

returns the cumulative ('real') transformation matrix by combining the shape's matrix with its parent's matrix

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

renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()

_moveToFront()
Defined by dojox/gfx/shape

renderer-specific hook, see dojox/gfx/shape.Shape.moveToFront()

_normalizePoints()
Defined by dojox/gfx/shape

normalize points to array of {x:number, y:number}

_render(ctx)
Defined by dojox/gfx/canvas

render the shape

Parameter Type Description
ctx Object
_renderClip(ctx)
Defined by dojox/gfx/canvas
Parameter Type Description
ctx undefined
_renderDashedStroke(ctx,apply)
Defined by dojox/gfx/canvas
Parameter Type Description
ctx undefined
apply undefined
_renderFill(ctx,apply)
Defined by dojox/gfx/canvas
Parameter Type Description
ctx Object
apply Boolean
_renderShape(ctx)
Defined by dojox/gfx/canvas
Parameter Type Description
ctx Object
_renderStroke(ctx,apply)
Defined by dojox/gfx/canvas
Parameter Type Description
ctx Object
apply Boolean
_renderTransform(ctx)
Defined by dojox/gfx/canvas
Parameter Type Description
ctx Object
_setParent(parent,matrix)
Defined by dojox/gfx/shape

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

Returns:undefined
_updateParentMatrix(matrix)
Defined by dojox/gfx/shape

updates the parent matrix with new matrix

Parameter Type Description
matrix dojox/gfx/Matrix2D

a 2D matrix or a matrix-like object

Returns:undefined
applyLeftTransform(matrix)
Defined by dojox/gfx/shape

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)

Returns:function

multiplies the existing matrix with an argument on left side (matrix * this.matrix)

applyRightTransform(matrix)
Defined by dojox/gfx/shape

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)

Returns:function

multiplies the existing matrix with an argument on right side (this.matrix * matrix)

applyTransform(matrix)
Defined by dojox/gfx/shape

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)

Returns:function

a shortcut for dojox/gfx/shape.Shape.applyRightTransform

connect()
Defined by dojox/gfx/canvas
destroy()
Defined by dojox/gfx/shape

Releases all internal resources owned by this shape. Once this method has been called, the instance is considered destroyed and should not be used anymore.

disconnect()
Defined by dojox/gfx/canvas
getBoundingBox()
Defined by dojox/gfx/shape

Returns the bounding box Rectangle for this shape or null if a BoundingBox cannot be calculated for the shape on the current renderer or for shapes with no geometric area (points). A bounding box is a rectangular geometric region defining the X and Y extent of the shape. (see dojox/gfx.defaultRect) Note that this method returns a direct reference to the attribute of this instance. Therefore you should not modify its value directly but clone it instead.

Returns:undefined
getClip()
Defined by dojox/gfx/shape
Returns:undefined
getEventSource()
Defined by dojox/gfx/canvas
Returns:null
getFill()
Defined by dojox/gfx/shape

Returns the current fill object or null (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/Color)

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

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:undefined
getParent()
Defined by dojox/gfx/shape

Returns the parent Shape, Group or null if this Shape is unparented. (see dojox/gfx/shape.Surface, or dojox/gfx.Group)

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

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:undefined
getStroke()
Defined by dojox/gfx/shape

Returns the current stroke object or null (see dojox/gfx.defaultStroke)

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

Returns the current transformation matrix applied to this Shape or null

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

returns an array of four points or null four points represent four corners of the untransformed bounding box

Returns:null | Array
moveToBack()
Defined by dojox/gfx/shape

moves a shape to back of its parent's list of shapes

Returns:function

moves a shape to back of its parent's list of shapes

moveToFront()
Defined by dojox/gfx/shape

moves a shape to front of its parent's list of shapes

Returns:function

moves a shape to front of its parent's list of shapes

on()
Defined by dojox/gfx/canvas
removeShape(silently)
Defined by dojox/gfx/shape

removes the shape from its parent's list of shapes

Parameter Type Description
silently Boolean

if true, do not redraw a picture yet

Returns:function

removes the shape from its parent's list of shapes

setClip(clip)
Defined by dojox/gfx/canvas
Parameter Type Description
clip Object
Returns:function
setFill(fill)
Defined by dojox/gfx/shape

sets a fill object (the default implementation simply ignores it)

Parameter Type Description
fill Object

a fill object (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/_base/Color)

Returns:function

sets a fill object (the default implementation simply ignores it)

setShape()
Defined by dojox/gfx/canvas
Returns:function
setStroke(stroke)
Defined by dojox/gfx/shape

sets a stroke object (the default implementation simply ignores it)

Parameter Type Description
stroke Object

a stroke object (see dojox/gfx.defaultStroke)

Returns:function

sets a stroke object (the default implementation simply ignores it)

setTransform(matrix)
Defined by dojox/gfx/shape

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)

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