Warning: Use of undefined constant Symbol - assumed 'Symbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215 Warning: Use of undefined constant JavaScriptSymbol - assumed 'JavaScriptSymbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215

dojox/gfx/shape.js

  • Provides:

    • dojox.gfx.shape
  • Requires:

    • dojox.gfx._base in common
  • dojox.gfx.shape.Shape

    • type
      Function
    • chains:
      • dojox.gfx.shape._eventsProcessing: (prototype)
    • summary
      a Shape object, which knows how to apply
      graphical attributes and transformations
  • dojox.gfx.shape.Surface

    • type
      Function
    • chains:
      • dojox.gfx.shape._eventsProcessing: (prototype)
    • summary
      a surface object to be used for drawings
  • dojox.gfx.shape.Shape.constructor

    • constructor - constructor
    • type
      Function
  • dojox.gfx.shape.Shape.getNode

    • returns
      Node
    • summary
      returns the current DOM Node or null
    • type
      Function
  • dojox.gfx.shape.Shape.getShape

    • returns
      Object
    • summary
      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)
    • type
      Function
  • dojox.gfx.shape.Shape.getTransform

    • returns
      dojox.gfx.Matrix2D
    • summary
      returns the current transformation matrix or null
    • type
      Function
  • dojox.gfx.shape.Shape.getFill

    • returns
      Object
    • summary
      returns the current fill object or null
      (see dojox.gfx.defaultLinearGradient,
      dojox.gfx.defaultRadialGradient,
      dojox.gfx.defaultPattern,
      or dojo.Color)
    • type
      Function
  • dojox.gfx.shape.Shape.getStroke

    • returns
      Object
    • summary
      returns the current stroke object or null
      (see dojox.gfx.defaultStroke)
    • type
      Function
  • dojox.gfx.shape.Shape.getParent

    • returns
      Object
    • summary
      returns the parent or null
      (see dojox.gfx.Surface,
      dojox.gfx.shape.VirtualGroup,
      or dojox.gfx.Group)
    • type
      Function
  • dojox.gfx.shape.Shape.getBoundingBox

    • returns
      dojox.gfx.Rectangle
    • summary
      returns the bounding box or null
      (see dojox.gfx.defaultRect)
    • type
      Function
  • dojox.gfx.shape.Shape.getTransformedBoundingBox

    • returns
      null|Array
    • summary
      returns an array of four points or null
      four points represent four corners of the untransformed bounding box
    • type
      Function
  • dojox.gfx.shape.Shape.getEventSource

    • returns
      Node
    • summary
      returns a Node, which is used as
      a source of events for this shape
    • type
      Function
  • dojox.gfx.shape.Shape.setShape

    • parameters:
      • shape: (typeof 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
      self
    • summary
      sets a shape object
      (the default implementation simply ignores it)
    • type
      Function
  • dojox.gfx.shape.Shape.shape

    • type
      Object
  • dojox.gfx.shape.Shape.bbox

    • type
      Object
  • dojox.gfx.shape.Shape.setShape.shape

    • type
      Object:
    • summary
      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)
  • dojox.gfx.shape.Shape.setFill

    • parameters:
      • fill: (typeof Object:)
        a fill object
        (see dojox.gfx.defaultLinearGradient,
        dojox.gfx.defaultRadialGradient,
        dojox.gfx.defaultPattern,
        or dojo.Color)
    • returns
      self
    • summary
      sets a fill object
      (the default implementation simply ignores it)
    • type
      Function
  • dojox.gfx.shape.Shape.fillStyle

    • type
      Object
  • dojox.gfx.shape.Shape.setStroke

    • parameters:
      • stroke: (typeof Object:)
        a stroke object
        (see dojox.gfx.defaultStroke)
    • returns
      self
    • summary
      sets a stroke object
      (the default implementation simply ignores it)
    • type
      Function
  • dojox.gfx.shape.Shape.strokeStyle

    • type
      Object
  • dojox.gfx.shape.Shape.setTransform

    • parameters:
      • matrix: (typeof dojox.gfx.Matrix2D:)
        a matrix or a matrix-like object
        (see an argument of dojox.gfx.Matrix2D
        constructor for a list of acceptable arguments)
    • returns
      self
    • summary
      sets a transformation matrix
    • type
      Function
  • dojox.gfx.shape.Shape.matrix

    • type
      Object
  • dojox.gfx.shape.Shape.setTransform.matrix

    • type
      dojox.gfx.Matrix2D:
    • summary
      a matrix or a matrix-like object
      (see an argument of dojox.gfx.Matrix2D
      constructor for a list of acceptable arguments)
  • dojox.gfx.shape.Shape._applyTransform

    • returns
      self
    • summary
      physically sets a matrix
    • type
      Function
  • dojox.gfx.shape.Shape.moveToFront

    • returns
      self
    • summary
      moves a shape to front of its parent's list of shapes
    • type
      Function
  • dojox.gfx.shape.Shape.moveToBack

    • summary
      moves a shape to back of its parent's list of shapes
    • type
      Function
  • dojox.gfx.shape.Shape._moveToFront

    • summary
      renderer-specific hook, see dojox.gfx.shape.Shape.moveToFront()
    • type
      Function
  • dojox.gfx.shape.Shape._moveToBack

    • summary
      renderer-specific hook, see dojox.gfx.shape.Shape.moveToFront()
    • type
      Function
  • dojox.gfx.shape.Shape.applyRightTransform

    • parameters:
      • matrix: (typeof dojox.gfx.Matrix2D:)
        a matrix or a matrix-like object
        (see an argument of dojox.gfx.Matrix2D
        constructor for a list of acceptable arguments)
    • returns
      self
    • summary
      multiplies the existing matrix with an argument on right side
      (this.matrix * matrix)
    • type
      Function
  • dojox.gfx.shape.Shape.applyLeftTransform

    • parameters:
      • matrix: (typeof dojox.gfx.Matrix2D:)
        a matrix or a matrix-like object
        (see an argument of dojox.gfx.Matrix2D
        constructor for a list of acceptable arguments)
    • returns
      self
    • summary
      multiplies the existing matrix with an argument on left side
      (matrix * this.matrix)
    • type
      Function
  • dojox.gfx.shape.Shape.applyTransform

    • parameters:
      • matrix: (typeof dojox.gfx.Matrix2D:)
        a matrix or a matrix-like object
        (see an argument of dojox.gfx.Matrix2D
        constructor for a list of acceptable arguments)
    • returns
      self
    • summary
      a shortcut for dojox.gfx.Shape.applyRightTransform
    • type
      Function
  • dojox.gfx.shape.Shape.removeShape

    • parameters:
      • silently: (typeof Boolean:)
        if true, do not redraw a picture yet
    • returns
      self
    • summary
      removes the shape from its parent's list of shapes
    • type
      Function
  • dojox.gfx.shape.Shape._setParent

    • parameters:
      • parent: (typeof Object:)
        a parent or null
        (see dojox.gfx.Surface,
        dojox.gfx.shape.VirtualGroup,
        or dojox.gfx.Group)
      • matrix: (typeof dojox.gfx.Matrix2D:)
        a 2D matrix or a matrix-like object
    • returns
      self
    • summary
      sets a parent
    • type
      Function
  • dojox.gfx.shape.Shape.parent

    • type
      Object
  • dojox.gfx.shape.Shape._setParent.parent

    • type
      Object:
    • summary
      a parent or null
      (see dojox.gfx.Surface,
      dojox.gfx.shape.VirtualGroup,
      or dojox.gfx.Group)
      matrix: dojox.gfx.Matrix2D:
      a 2D matrix or a matrix-like object
  • dojox.gfx.shape.Shape._updateParentMatrix

    • parameters:
      • matrix: (typeof dojox.gfx.Matrix2D:)
        a 2D matrix or a matrix-like object
    • returns
      self
    • summary
      updates the parent matrix with new matrix
    • type
      Function
  • dojox.gfx.shape.Shape.parentMatrix

    • type
      Object
  • dojox.gfx.shape.Shape._getRealMatrix

    • returns
      dojox.gfx.Matrix2D
    • summary
      returns the cumulative ("real") transformation matrix
      by combining the shape's matrix with its parent's matrix
    • type
      Function
  • dojox.gfx.shape.Shape.rawNode

    • type
      Node:
    • summary
      underlying node
  • dojox.gfx.shape.Surface.constructor

    • constructor - constructor
    • type
      Function
  • dojox.gfx.shape.Surface.destroy

    • summary
      destroy all relevant external resources and release all
      external references to make this object garbage-collectible
    • type
      Function
  • dojox.gfx.shape.Surface._nodes

    • type
      Array
  • dojox.gfx.shape.Surface._events

    • type
      Array
  • dojox.gfx.shape.Surface.rawNode

    • type
      Object
  • dojox.gfx.shape.Surface._parent.innerHTML

    • type
      String
  • dojox.gfx.shape.Surface._parent

    • type
      Object
  • dojox.gfx.shape.Surface.getEventSource

    • returns
      Node
    • summary
      returns a node, which can be used to attach event listeners
    • type
      Function
  • dojox.gfx.shape.Surface._getRealMatrix

    • returns
      dojox.gfx.Matrix2D
    • summary
      always returns the identity matrix
    • type
      Function
  • dojox.gfx.shape.Surface.isLoaded

    • type
      Object
  • dojox.gfx.shape.Surface.onLoad

    • parameters:
      • surface: (typeof dojox.gfx.Surface)
    • summary
      local event, fired once when the surface is created
      asynchronously, used only when isLoaded is false, required
      only for Silverlight.
    • type
      Function
  • dojox.gfx.shape.Surface.whenLoaded

    • parameters:
      • context: (typeof Object)
      • method: (typeof Function|String)
    • type
      Function
  • dojox.gfx.Point

    • type
      Function
    • summary
      a hypothetical 2D point to be used for drawings - {x, y}
    • description
      This object is defined for documentation purposes.
      You should use the naked object instead: {x: 1, y: 2}.
  • dojox.gfx.Rectangle

    • type
      Function
    • summary
      a hypothetical rectangle - {x, y, width, height}
    • description
      This object is defined for documentation purposes.
      You should use the naked object instead: {x: 1, y: 2, width: 100, height: 200}.
  • dojox.gfx.shape.Rect

    • type
      Function
    • chains:
      • dojox.gfx.shape.Shape: (prototype)
      • dojox.gfx.shape.Shape: (call)
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
    • summary
      a generic rectangle
  • dojox.gfx.shape.Rect.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
  • dojox.gfx.shape.Rect.getBoundingBox

    • returns
      dojox.gfx.Rectangle
    • summary
      returns the bounding box (its shape in this case)
    • type
      Function
  • dojox.gfx.shape.Rect.shape

    • type
      Object
  • dojox.gfx.shape.Rect.rawNode

    • type
      Node:
    • summary
      a DOM Node
  • dojox.gfx.shape.Ellipse

    • type
      Function
    • chains:
      • dojox.gfx.shape.Shape: (prototype)
      • dojox.gfx.shape.Shape: (call)
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
    • summary
      a generic ellipse
  • dojox.gfx.shape.Ellipse.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
  • dojox.gfx.shape.Ellipse.getBoundingBox

    • returns
      dojox.gfx.Rectangle
    • summary
      returns the bounding box
    • type
      Function
  • dojox.gfx.shape.Ellipse.shape

    • type
      Object
  • dojox.gfx.shape.Ellipse.bbox

    • type
      Object
  • dojox.gfx.shape.Ellipse.rawNode

    • type
      Node:
    • summary
      a DOM Node
  • dojox.gfx.shape.Circle

    • type
      Function
    • chains:
      • dojox.gfx.shape.Shape: (prototype)
      • dojox.gfx.shape.Shape: (call)
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
    • summary
      a generic circle
      (this is a helper object, which is defined for convenience)
  • dojox.gfx.shape.Circle.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
  • dojox.gfx.shape.Circle.getBoundingBox

    • returns
      dojox.gfx.Rectangle
    • summary
      returns the bounding box
    • type
      Function
  • dojox.gfx.shape.Circle.shape

    • type
      Object
  • dojox.gfx.shape.Circle.bbox

    • type
      Object
  • dojox.gfx.shape.Circle.rawNode

    • type
      Node:
    • summary
      a DOM Node
  • dojox.gfx.shape.Line

    • type
      Function
    • chains:
      • dojox.gfx.shape.Shape: (prototype)
      • dojox.gfx.shape.Shape: (call)
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
    • summary
      a generic line
      (this is a helper object, which is defined for convenience)
  • dojox.gfx.shape.Line.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
  • dojox.gfx.shape.Line.getBoundingBox

    • returns
      dojox.gfx.Rectangle
    • summary
      returns the bounding box
    • type
      Function
  • dojox.gfx.shape.Line.shape

    • type
      Object
  • dojox.gfx.shape.Line.bbox

    • type
      Object
  • dojox.gfx.shape.Line.rawNode

    • type
      Node:
    • summary
      a DOM Node
  • dojox.gfx.shape.Polyline

    • type
      Function
    • chains:
      • dojox.gfx.shape.Shape: (prototype)
      • dojox.gfx.shape.Shape: (call)
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
    • summary
      a generic polyline/polygon
      (this is a helper object, which is defined for convenience)
  • dojox.gfx.shape.Polyline.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
  • dojox.gfx.shape.Polyline.setShape

    • parameters:
      • points: (typeof Object:)
        a polyline/polygon shape object
      • closed: (typeof Boolean:)
        close the polyline to make a polygon
    • returns
      self
    • summary
      sets a polyline/polygon shape object
    • type
      Function
  • dojox.gfx.shape.Polyline._normalizePoints

    • summary
      normalize points to array of {x:number, y:number}
    • type
      Function
  • dojox.gfx.shape.Polyline.shape.points

  • dojox.gfx.shape.Polyline.getBoundingBox

    • returns
      dojox.gfx.Rectangle
    • summary
      returns the bounding box
    • type
      Function
  • dojox.gfx.shape.Polyline.shape.points.length

  • dojox.gfx.shape.Polyline.bbox

    • type
      Object
  • dojox.gfx.shape.Polyline.shape

    • type
      Object
  • dojox.gfx.shape.Polyline.rawNode

    • type
      Node:
    • summary
      a DOM Node
  • dojox.gfx.shape.Image

    • type
      Function
    • chains:
      • dojox.gfx.shape.Shape: (prototype)
      • dojox.gfx.shape.Shape: (call)
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
    • summary
      a generic image
      (this is a helper object, which is defined for convenience)
  • dojox.gfx.shape.Image.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
  • dojox.gfx.shape.Image.getBoundingBox

    • returns
      dojox.gfx.Rectangle
    • summary
      returns the bounding box (its shape in this case)
    • type
      Function
  • dojox.gfx.shape.Image.setStroke

    • returns
      self
    • summary
      ignore setting a stroke style
    • type
      Function
  • dojox.gfx.shape.Image.setFill

    • returns
      self
    • summary
      ignore setting a fill style
    • type
      Function
  • dojox.gfx.shape.Image.shape

    • type
      Object
  • dojox.gfx.shape.Image.rawNode

    • type
      Node:
    • summary
      a DOM Node
  • dojox.gfx.shape.Text

    • type
      Function
    • chains:
      • dojox.gfx.shape.Shape: (prototype)
      • dojox.gfx.shape.Shape: (call)
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
    • summary
      a generic text
  • dojox.gfx.shape.Text.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • rawNode: (typeof Node:)
        a DOM Node
  • dojox.gfx.shape.Text.getFont

    • returns
      Object
    • summary
      returns the current font object or null
    • type
      Function
  • dojox.gfx.shape.Text.setFont

    • parameters:
      • newFont: (typeof Object:)
        a font object (see dojox.gfx.defaultFont) or a font string
    • returns
      self
    • summary
      sets a font for text
    • type
      Function
  • dojox.gfx.shape.Text.fontStyle

    • type
      Object
  • dojox.gfx.shape.Text.shape

    • type
      Object
  • dojox.gfx.shape.Text.rawNode

    • type
      Node:
    • summary
      a DOM Node
  • dojox.gfx.shape._eventsProcessing

    • type
      Object
  • dojox.gfx.shape._eventsProcessing.connect

    • parameters:
      • name
      • object
      • method
    • returns
      Object
    • summary
      connects a handler to an event on this shape
    • type
      Function
  • dojox.gfx.shape._eventsProcessing.disconnect

    • parameters:
      • token
    • summary
      connects a handler by token from an event on this shape
    • type
      Function
  • dojox.gfx.shape.Container

    • 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)
    • type
      Object
  • dojox.gfx.shape.Container._init

    • type
      Function
  • dojox.gfx.shape.Container._init.children

    • type
      Array:
    • summary
      a list of children
  • dojox.gfx.shape.Container.openBatch

    • summary
      starts a new batch, subsequent new child shapes will be held in
      the batch instead of appending to the container directly
    • type
      Function
  • dojox.gfx.shape.Container.closeBatch

    • summary
      submits the current batch, append all pending child shapes to DOM
    • type
      Function
  • dojox.gfx.shape.Container.add

    • parameters:
      • shape: (typeof dojox.gfx.Shape:)
        a shape
    • returns
      self
    • summary
      adds a shape to the list
    • type
      Function
  • dojox.gfx.shape.Container.remove

    • parameters:
      • shape
      • silently: (typeof Boolean:)
        if true, do not redraw a picture yet
    • returns
      self
    • summary
      removes a shape from the list
    • type
      Function
  • dojox.gfx.shape.Container.clear

    • returns
      self
    • summary
      removes all shapes from a group/surface
    • type
      Function
  • dojox.gfx.shape.Container.clear.children

    • type
      Array
  • dojox.gfx.shape.Container._moveChildToFront

    • parameters:
      • shape
    • returns
      self
    • summary
      moves a shape to front of the list of shapes
    • type
      Function
  • dojox.gfx.shape.Container._moveChildToBack

    • parameters:
      • shape
    • returns
      self
    • summary
      moves a shape to back of the list of shapes
    • type
      Function
  • dojox.gfx.shape.Creator

    • summary
      shape creators
    • type
      Object
  • dojox.gfx.shape.Creator.createShape

    • parameters:
      • shape: (typeof Object:)
        a shape descriptor object
    • summary
      creates a shape object based on its type; it is meant to be used
      by group-like objects
    • type
      Function
  • dojox.gfx.shape.Creator.createGroup

    • returns
      dojox.gfx.Group
    • summary
      creates a group shape
    • type
      Function
  • dojox.gfx.shape.Creator.createRect

    • parameters:
      • rect: (typeof Object:)
        a path object (see dojox.gfx.defaultRect)
    • returns
      dojox.gfx.Rect
    • summary
      creates a rectangle shape
    • type
      Function
  • dojox.gfx.shape.Creator.createEllipse

    • parameters:
      • ellipse: (typeof Object:)
        an ellipse object (see dojox.gfx.defaultEllipse)
    • returns
      dojox.gfx.Ellipse
    • summary
      creates an ellipse shape
    • type
      Function
  • dojox.gfx.shape.Creator.createCircle

    • parameters:
      • circle: (typeof Object:)
        a circle object (see dojox.gfx.defaultCircle)
    • returns
      dojox.gfx.Circle
    • summary
      creates a circle shape
    • type
      Function
  • dojox.gfx.shape.Creator.createLine

    • parameters:
      • line: (typeof Object:)
        a line object (see dojox.gfx.defaultLine)
    • returns
      dojox.gfx.Line
    • summary
      creates a line shape
    • type
      Function
  • dojox.gfx.shape.Creator.createPolyline

    • parameters:
      • points: (typeof Object:)
        a points object (see dojox.gfx.defaultPolyline)
        or an Array of points
    • returns
      dojox.gfx.Polyline
    • summary
      creates a polyline/polygon shape
    • type
      Function
  • dojox.gfx.shape.Creator.createImage

    • parameters:
      • image: (typeof Object:)
        an image object (see dojox.gfx.defaultImage)
    • returns
      dojox.gfx.Image
    • summary
      creates a image shape
    • type
      Function
  • dojox.gfx.shape.Creator.createText

    • parameters:
      • text: (typeof Object:)
        a text object (see dojox.gfx.defaultText)
    • returns
      dojox.gfx.Text
    • summary
      creates a text shape
    • type
      Function
  • dojox.gfx.shape.Creator.createPath

    • parameters:
      • path: (typeof Object:)
        a path object (see dojox.gfx.defaultPath)
    • returns
      dojox.gfx.Path
    • summary
      creates a path shape
    • type
      Function
  • dojox.gfx.shape.Creator.createTextPath

    • parameters:
      • text: (typeof Object:)
        a textpath object (see dojox.gfx.defaultTextPath)
    • returns
      dojox.gfx.TextPath
    • summary
      creates a text shape
    • type
      Function
  • dojox.gfx.shape.Creator.createObject

    • parameters:
      • shapeType: (typeof Function:)
        a class constructor to create an instance of
      • rawShape: (typeof Object:)
        properties to be passed in to the classes "setShape" method
    • returns
      dojox.gfx.Shape
    • summary
      creates an instance of the passed shapeType class
    • type
      Function
  • dojox.gfx

    • alias - dojox.gfx
  • dojox.gfx.shape

    • type
      Object
  • dojox

    • type
      Object