dojox/gfx/path.js

• Provides:

  • dojox.gfx.path

• Requires:

  • dojox.gfx.matrix in common
  • dojox.gfx.shape in common

• dojox.gfx.path.Path

  • type

    Function

  • chains:
    • dojox.gfx.shape.Shape: (prototype)
    • dojox.gfx.shape.Shape: (call)
  • parameters:
    • rawNode: (typeof Node:)

      a DOM node to be used by this path object

  • summary

    a generalized path shape

• dojox.gfx.path.Path.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • rawNode: (typeof Node:)

      a DOM node to be used by this path object

  • summary

    a path constructor

• dojox.gfx.path.Path.setAbsoluteMode

  • parameters:
    • mode: (typeof Boolean:)

      true/false or "absolute"/"relative" to specify the mode

  • returns

    self

  • summary

    sets an absolute or relative mode for path points

  • type

    Function

• dojox.gfx.path.Path.absolute

  • type

    Object

• dojox.gfx.path.Path.getAbsoluteMode

  • returns

    Boolean

  • summary

    returns a current value of the absolute mode

  • type

    Function

• dojox.gfx.path.Path.getBoundingBox

  • returns

    dojox.gfx.Rectangle

  • summary

    returns the bounding box {x, y, width, height} or null

  • type

    Function

• dojox.gfx.path.Path._getRealBBox

  • returns

    Array

  • summary

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

  • type

    Function

• dojox.gfx.path.Path.bbox

  • type

    Object

• dojox.gfx.path.Path.segments.length

• dojox.gfx.path.Path.tbbox

  • type

    Object

• dojox.gfx.path.Path.getLastPosition

  • returns

    Object

  • summary

    returns the last point in the path, or null

  • type

    Function

• dojox.gfx.path.Path._applyTransform

  • type

    Function

• dojox.gfx.path.Path._updateBBox

  • parameters:
    • x: (typeof Number:)

      an x coordinate

    • y: (typeof Number:)

      a y coordinate

    • matrix
  • summary

    updates the bounding box of path with new point

  • type

    Function

• dojox.gfx.path.Path.bbox.l

• dojox.gfx.path.Path.bbox.r

• dojox.gfx.path.Path.bbox.t

• dojox.gfx.path.Path.bbox.b

• dojox.gfx.path.Path._updateWithSegment

  • parameters:
    • segment: (typeof Object:)

      a segment

    • matrix
  • summary

    updates the bounding box of path with new segment

  • type

    Function

• dojox.gfx.path.Path.last.x

• dojox.gfx.path.Path.last.y

• dojox.gfx.path.Path._validSegments

  • type

    Object

• dojox.gfx.path.Path._validSegments.m

  • type

    Number

• dojox.gfx.path.Path._validSegments.l

  • type

    Number

• dojox.gfx.path.Path._validSegments.h

  • type

    Number

• dojox.gfx.path.Path._validSegments.v

  • type

    Number

• dojox.gfx.path.Path._validSegments.c

  • type

    Number

• dojox.gfx.path.Path._validSegments.s

  • type

    Number

• dojox.gfx.path.Path._validSegments.q

  • type

    Number

• dojox.gfx.path.Path._validSegments.t

  • type

    Number

• dojox.gfx.path.Path._validSegments.a

  • type

    Number

• dojox.gfx.path.Path._validSegments.z

  • type

    Number

• dojox.gfx.path.Path._pushSegment

  • parameters:
    • action: (typeof String:)

      valid SVG code for a segment's type

    • args: (typeof Array:)

      a list of parameters for this segment

  • summary

    adds a segment

  • type

    Function

• dojox.gfx.path.Path._collectArgs

  • parameters:
    • array: (typeof Array:)

      an output argument (array of numbers)

    • args: (typeof Array:)

      an input argument (can be values of Boolean, Number, dojox.gfx.Point, or an embedded array of them)

  • summary

    converts an array of arguments to plain numeric values

  • type

    Function

• dojox.gfx.path.Path.moveTo

  • returns

    self

  • summary

    formes a move segment

  • type

    Function

• dojox.gfx.path.Path.lineTo

  • returns

    self

  • summary

    formes a line segment

  • type

    Function

• dojox.gfx.path.Path.hLineTo

  • returns

    self

  • summary

    formes a horizontal line segment

  • type

    Function

• dojox.gfx.path.Path.vLineTo

  • returns

    self

  • summary

    formes a vertical line segment

  • type

    Function

• dojox.gfx.path.Path.curveTo

  • returns

    self

  • summary

    formes a curve segment

  • type

    Function

• dojox.gfx.path.Path.smoothCurveTo

  • returns

    self

  • summary

    formes a smooth curve segment

  • type

    Function

• dojox.gfx.path.Path.qCurveTo

  • returns

    self

  • summary

    formes a quadratic curve segment

  • type

    Function

• dojox.gfx.path.Path.qSmoothCurveTo

  • returns

    self

  • summary

    formes a quadratic smooth curve segment

  • type

    Function

• dojox.gfx.path.Path.arcTo

  • returns

    self

  • summary

    formes an elliptic arc segment

  • type

    Function

• dojox.gfx.path.Path.closePath

  • returns

    self

  • summary

    closes a path

  • type

    Function

• dojox.gfx.path.Path._confirmSegmented

  • type

    Function

• dojox.gfx.path.Path.shape.path

  • type

    Object

• dojox.gfx.path.Path.segmented

  • type

    bool

• dojox.gfx.path.Path._setPath

  • parameters:
    • path: (typeof String:)

      an SVG path string

  • summary

    forms a path using an SVG path string

  • type

    Function

• dojox.gfx.path.Path.segments

  • type

    Array

• dojox.gfx.path.Path.last

  • type

    Object

• dojox.gfx.path.Path.setShape

  • parameters:
    • newShape: (typeof Object:)

      an SVG path string or a path object (see dojox.gfx.defaultPath)

  • returns

    self

  • summary

    forms a path using a shape

  • type

    Function

• dojox.gfx.path.Path._2PI

  • type

    Number

• dojox.gfx.path.Path.shape

  • type

    Object

• dojox.gfx.path.Path.rawNode

  • type

    Node:

  • summary

    a DOM node to be used by this path object

• dojox.gfx.path.TextPath

  • type

    Function

  • chains:
    • dojox.gfx.path.Path: (prototype)
    • dojox.gfx.path.Path: (call)
  • parameters:
    • rawNode: (typeof Node:)

      a DOM node to be used by this TextPath object

  • summary

    a generalized TextPath shape

• dojox.gfx.path.TextPath.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • rawNode: (typeof Node:)

      a DOM node to be used by this TextPath object

  • summary

    a TextPath shape constructor

• dojox.gfx.path.TextPath.getText

  • returns

    Object

  • summary

    returns the current text object or null

  • type

    Function

• dojox.gfx.path.TextPath.setText

  • parameters:
    • newText
  • returns

    self

  • summary

    sets a text to be drawn along the path

  • type

    Function

• dojox.gfx.path.TextPath.text

  • type

    Object

• dojox.gfx.path.TextPath.getFont

  • returns

    Object

  • summary

    returns the current font object or null

  • type

    Function

• dojox.gfx.path.TextPath.setFont

  • parameters:
    • newFont
  • returns

    self

  • summary

    sets a font for text

  • type

    Function

• dojox.gfx.path.TextPath.fontStyle

  • type

    Object

• dojox.gfx.path

  • type

    Object

• dojox.gfx

  • type

    Object

• dojox

  • type

    Object