dojox/charting/action2d/Highlight.js

• Provides:

  • dojox.charting.action2d.Highlight

• Requires:

  • dojox.charting.action2d.Base in common
  • dojox.color in common

• dojox.charting.action2d.__HighlightCtorArgs

  • type

    Function

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

    Additional arguments for highlighting actions.

• dojox.charting.action2d.__HighlightCtorArgs.highlight

  • optional
  • type

    String|dojo.Color|Function

  • summary

    Either a color or a function that creates a color when highlighting happens.

• dojox.charting.action2d.Highlight

  • 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.__HighlightCtorArgs)

      Optional keyword arguments object for setting parameters.

  • summary

    Creates a highlighting action on a plot, where an element on that plot
    has a highlight on it.

• dojox.charting.action2d.Highlight.defaultParams

  • type

    Object

• dojox.charting.action2d.Highlight.defaultParams.duration

  • type

    Number

• dojox.charting.action2d.Highlight.defaultParams.easing

  • alias - dojo.fx.easing.backOut

• dojox.charting.action2d.Highlight.optionalParams

  • type

    Object

• dojox.charting.action2d.Highlight.optionalParams.highlight

  • type

    String

• dojox.charting.action2d.Highlight.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.__HighlightCtorArgs)

      Optional keyword arguments object for setting parameters.

  • summary

    Create the highlighting action and connect it to the plot.

• dojox.charting.action2d.Highlight.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.Highlight.colorFun

• dojox.color

  • alias - dojox.color

• dojox.charting.action2d

  • type

    Object

• dojox.charting

  • type

    Object

• dojox

  • type

    Object