dojox/charting/action2d/Tooltip.js

• Provides:

  • dojox.charting.action2d.Tooltip

• Requires:

  • dijit.Tooltip in common
  • dojox.charting.action2d.Base in common
  • dojox.gfx.matrix in common
  • dojox.lang.functional in common
  • dojox.lang.functional.scan in common
  • dojox.lang.functional.fold in common

• dojox.charting.action2d.__TooltipCtorArgs

  • type

    Function

  • chains:
    • dojox.charting.action2d.__BaseCtorArgs: (prototype)
    • dojox.charting.action2d.__BaseCtorArgs: (call)
  • summary

    Additional arguments for tooltip actions.

• dojox.charting.action2d.__TooltipCtorArgs.text

  • optional
  • type

    Function

  • summary

    The function that produces the text to be shown within a tooltip.  By default this will be
    set by the plot in question, by returning the value of the element.

• dojox.charting.action2d.Tooltip

  • type

    Function

  • chains:
    • dojox.charting.action2d.Base: (prototype)
    • dojox.charting.action2d.Base: (call)
  • parameters:
    • chart: (typeof dojox.charting.Chart2D)

      The chart this action belongs to.

    • plot: (typeof String)

      The plot this action is attached to.  If not passed, "default" is assumed.

    • kwArgs: (typeof dojox.charting.action2d.__TooltipCtorArgs)

      Optional keyword arguments object for setting parameters.

  • summary

    Create an action on a plot where a tooltip is shown when hovering over an element.

• dojox.charting.action2d.Tooltip.defaultParams

  • type

    Object

• dojox.charting.action2d.Tooltip.defaultParams.text

  • alias - DEFAULT_TEXT

• dojox.charting.action2d.Tooltip.optionalParams

  • type

    Object

• dojox.charting.action2d.Tooltip.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • chart: (typeof dojox.charting.Chart2D)

      The chart this action belongs to.

    • plot: (typeof String)

      The plot this action is attached to.  If not passed, "default" is assumed.

    • kwArgs: (typeof dojox.charting.action2d.__TooltipCtorArgs)

      Optional keyword arguments object for setting parameters.

  • summary

    Create the tooltip action and connect it to the plot.

• dojox.charting.action2d.Tooltip.process

  • parameters:
    • o: (typeof dojox.gfx.Shape)

      The object on which to process the highlighting action.

  • summary

    Process the action on the given object.

  • type

    Function

• dojox.charting.action2d.Tooltip.aroundRect

  • type

    Object

• dojox.charting.action2d.Tooltip.angles

  • type

    Object

• dojox.charting.action2d.Tooltip.text

• dojox.lang.functional

  • alias - dojox.lang.functional

• dojox.gfx.matrix

  • alias - dojox.gfx.matrix

• dojox.charting.action2d

  • type

    Object

• dojox.charting

  • type

    Object

• dojox

  • type

    Object