dojox/gfx/canvas_attach.TextPath (version 1.10)

Summary

a text shape (Canvas)

Usage

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

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

Property Summary

Method Summary

  • _applyTransform() physically sets a matrix
  • _collectArgs(array,args) converts an array of arguments to plain numeric values
  • _confirmSegmented()
  • _getRealBBox() returns an array of four points or null four points represent four corners of the untransformed bounding box
  • _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()
  • _pushSegment(action,args) adds a segment
  • _render(ctx) render the shape
  • _renderClip(ctx)
  • _renderDashedStroke(ctx,apply)
  • _renderFill(ctx,apply)
  • _renderShape(ctx)
  • _renderStroke(ctx,apply)
  • _renderTransform(ctx)
  • _setFont()
  • _setParent(parent,matrix) sets a parent
  • _setPath(path) forms a path using an SVG path string
  • _setText()
  • _updateBBox(x,y,m) updates the bounding box of path with new point
  • _updateParentMatrix(matrix) updates the parent matrix with new matrix
  • _updateWithSegment(segment,matrix) updates the bounding box of path with new segment
  • 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
  • arcTo() forms an elliptic arc segment
  • bidiPreprocess(newText)
  • closePath() closes a path
  • connect()
  • curveTo() forms a curve segment
  • destroy() Releases all internal resources owned by this shape.
  • disconnect()
  • formatText(text,textDir) Applies the right transform on text, according to renderer.
  • getAbsoluteMode() returns a current value of the absolute mode
  • 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)
  • getFont() returns the current font object or null
  • getLastPosition() returns the last point in the path, or null
  • 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)
  • getText() returns the current text object or null
  • 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
  • hLineTo() forms a horizontal line segment
  • lineTo() forms a line segment
  • moveTo() forms a move segment
  • 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()
  • qCurveTo() forms a quadratic curve segment
  • qSmoothCurveTo() forms a quadratic smooth curve segment
  • removeShape(silently) removes the shape from its parent's list of shapes
  • setAbsoluteMode(mode) sets an absolute or relative mode for path points
  • setClip(clip)
  • setFill(fill) sets a fill object (the default implementation simply ignores it)
  • setFont(newFont) sets a font for text
  • setShape(shape) sets a shape object (the default implementation simply ignores it)
  • setStroke(stroke) sets a stroke object (the default implementation simply ignores it)
  • setText(newText) sets a text to be drawn along the path
  • setTransform(matrix) sets a transformation matrix
  • smoothCurveTo() forms a smooth curve segment
  • vLineTo() forms a vertical line segment

Properties

_2PI
Defined by: dojox/gfx/path
_validSegments
Defined by: dojox/gfx/path
canvasClip
Defined by: dojox/gfx/canvas
textDir
Defined by: dojox/gfx/_gfxBidiSupport

Used for displaying bidi scripts in right layout. Defines the base direction of text that displayed, can have 3 values:

  1. "ltr" - base direction is left to right.
  2. "rtl" - base direction is right to left.
  3. "auto" - base direction is contextual (defined by first strong character).

Methods

_applyTransform()
Defined by dojox/gfx/shape

physically sets a matrix

Returns:function

physically sets a matrix

_collectArgs(array,args)
Defined by dojox/gfx/path

converts an array of arguments to plain numeric values

Parameter Type Description
array Array

an output argument (array of numbers)
args Array

an input argument (can be values of Boolean, Number, dojox/gfx.Point, or an embedded array of them)
_confirmSegmented()
Defined by dojox/gfx/path
_getRealBBox()
Defined by dojox/gfx/path

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

Returns:undefined | null
_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()

_pushSegment(action,args)
Defined by dojox/gfx/path

adds a segment

Parameter Type Description
action String

valid SVG code for a segment's type
args Array

a list of parameters for this segment
_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
_setFont()
Defined by dojox/gfx/canvas
_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
_setPath(path)
Defined by dojox/gfx/path

forms a path using an SVG path string

Parameter Type Description
path String

an SVG path string
_setText()
Defined by dojox/gfx/canvas
_updateBBox(x,y,m)
Defined by dojox/gfx/path

updates the bounding box of path with new point

Parameter Type Description
x Number

an x coordinate
y Number

a y coordinate
m 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
_updateWithSegment(segment,matrix)
Defined by dojox/gfx/path

updates the bounding box of path with new segment

Parameter Type Description
segment Object

a segment
matrix 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

arcTo()
Defined by dojox/gfx/path

forms an elliptic arc segment

Returns:function

forms an elliptic arc segment

bidiPreprocess(newText)
Defined by dojox/gfx/_gfxBidiSupport
Parameter Type Description
newText undefined
Returns:undefined
closePath()
Defined by dojox/gfx/path

closes a path

Returns:function

closes a path

connect()
Defined by dojox/gfx/canvas
curveTo()
Defined by dojox/gfx/path

forms a curve segment

Returns:function

forms a curve segment

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
formatText(text,textDir)
Defined by dojox/gfx/_gfxBidiSupport

Applies the right transform on text, according to renderer.

Finds the right transformation that should be applied on the text, according to renderer. Was tested in:

Renderers: canvas (FF, Chrome, Safari), vml (IE), svg (FF, Chrome, Safari, Opera), silverlight (IE8), svgWeb(FF, Chrome, Safari, Opera, IE).

Browsers: IE [6,7,8], FF [3.6], Chrome (latest for February 2011), Safari [5.0.3], Opera [11.01].

Parameter Type Description
text String

the string for manipulation, by default return value.
textDir String

text direction direction. Can be:

  1. "ltr" - for left to right layout.
  2. "rtl" - for right to left layout
  3. "auto" - for contextual layout: the first strong letter decides the direction.
Returns:String | undefined | string

the string for manipulation, by default return value.

getAbsoluteMode()
Defined by dojox/gfx/path

returns a current value of the absolute mode

Returns:undefined
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
getFont()
Defined by dojox/gfx/path

returns the current font object or null

Returns:undefined
getLastPosition()
Defined by dojox/gfx/path

returns the last point in the path, or null

Returns:null
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
getText()
Defined by dojox/gfx/path

returns the current text object or null

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
hLineTo()
Defined by dojox/gfx/path

forms a horizontal line segment

Returns:function

forms a horizontal line segment

lineTo()
Defined by dojox/gfx/path

forms a line segment

Returns:function

forms a line segment

moveTo()
Defined by dojox/gfx/path

forms a move segment

Returns:function

forms a move segment

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
qCurveTo()
Defined by dojox/gfx/path

forms a quadratic curve segment

Returns:function

forms a quadratic curve segment

qSmoothCurveTo()
Defined by dojox/gfx/path

forms a quadratic smooth curve segment

Returns:function

forms a quadratic smooth curve segment

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

setAbsoluteMode(mode)
Defined by dojox/gfx/path

sets an absolute or relative mode for path points

Parameter Type Description
mode Boolean

true/false or "absolute"/"relative" to specify the mode
Returns:function

sets an absolute or relative mode for path points

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)

setFont(newFont)
Defined by dojox/gfx/path

sets a font for text

Parameter Type Description
newFont undefined
Returns:function

sets a font for text

setShape(shape)
Defined by dojox/gfx/shape

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

Parameter Type Description
shape Object

a shape object (see dojox/gfx.defaultPath, dojox/gfx.defaultPolyline, dojox/gfx.defaultRect, dojox/gfx.defaultEllipse, dojox/gfx.defaultCircle, dojox/gfx.defaultLine, or dojox/gfx.defaultImage)
Returns:function

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

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)

setText(newText)
Defined by dojox/gfx/path

sets a text to be drawn along the path

Parameter Type Description
newText undefined
Returns:function

sets a text to be drawn along the path

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
smoothCurveTo()
Defined by dojox/gfx/path

forms a smooth curve segment

Returns:function

forms a smooth curve segment

vLineTo()
Defined by dojox/gfx/path

forms a vertical line segment

Returns:function

forms a vertical line segment

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