dojox/widget/BarGauge.js

• Provides:

  • dojox.widget.BarGauge

• Requires:

  • dojox.gfx in common
  • dojox.widget.gauge._Gauge in common

• dojox.widget.gauge.BarLineIndicator

  • type

    Function

  • chains:
    • dojox.widget.gauge._Indicator: (prototype)
    • dojox.widget.gauge._Indicator: (call)

• dojox.widget.gauge.BarLineIndicator.width

  • type

    Number

• dojox.widget.gauge.BarLineIndicator._getShapes

  • summary

    Private function for generating the shapes for this indicator. An indicator that behaves the
    same might override this one and simply replace the shapes (such as BarIndicator).

  • type

    Function

• dojox.widget.gauge.BarLineIndicator._gauge.max

• dojox.widget.gauge.BarLineIndicator.draw

  • parameters:
    • dontAnimate: (typeof Boolean)

      Indicates if the drawing should not be animated (vs. the default of doing an animation)

  • summary

    Override of dojox.widget.gauge._Indicator.draw

  • type

    Function

• dojox.widget.gauge.BarLineIndicator.shapes

  • type

    Object

• dojox.widget.gauge.BarLineIndicator.text

  • type

    Object

• dojox.widget.gauge.BarLineIndicator.color

  • type

    String

• dojox.widget.gauge.BarLineIndicator.length

  • type

    Object

• dojox.widget.gauge.BarLineIndicator.offset

  • type

    Number

• dojox.widget.gauge.BarLineIndicator.highlight

  • type

    String

• dojox.widget.gauge.BarLineIndicator.highlight2

  • type

    String

• dojox.widget.gauge.BarLineIndicator.currentValue

• dojox.widget.gauge.BarLineIndicator._move

  • parameters:
    • dontAnimate: (typeof Boolean)

      Indicates if the drawing should not be animated (vs. the default of doing an animation)

  • summary

    Moves this indicator (since it's already been drawn once)

  • type

    Function

• dojox.widget.BarGauge

  • type

    Function

  • chains:
    • dojox.widget.gauge._Gauge: (prototype)
    • dojox.widget.gauge._Gauge: (call)
  • summary

    a bar graph built using the dojox.gfx package.

  • description

    using dojo.gfx (and thus either SVG or VML based on what is supported), this widget
    builds a bar graph component, used to display numerical data in a familiar format.
    
    usage:
    <script type="text/javascript">
    dojo.require("dojox.widget.BarGauge");
    dojo.require("dijit.util.parser");
    </script>
    ...
    <div 	dojoType="dojox.widget.BarGauge"
    id="testBarGauge"
    barGaugeHeight="55"
    dataY="25"
    dataHeight="25"
    dataWidth="225">
    </div>

• dojox.widget.BarGauge.dataX

  • type

    Number

  • summary

    x position of data area (default 5)

• dojox.widget.BarGauge.dataY

  • type

    Number

  • summary

    y position of data area (default 5)

• dojox.widget.BarGauge.dataWidth

  • type

    Number

  • summary

    width of data area (default is bar graph width - 10)

• dojox.widget.BarGauge.dataHeight

  • type

    Number

  • summary

    height of data area (default is bar graph width - 10)

• dojox.widget.BarGauge._defaultIndicator

  • alias - dojox.widget.gauge.BarLineIndicator
  • type

    override

  • summary

    of dojox.widget._Gauge._defaultIndicator

• dojox.widget.BarGauge.startup

  • type

    Function

• dojox.widget.BarGauge._getPosition

  • parameters:
    • value: (typeof Number)

      A value to be converted to a position for this bar graph.

  • summary

    This is a helper function used to determine the position that represents
    a given value on the bar graph

  • type

    Function

• dojox.widget.BarGauge._getValueForPosition

  • parameters:
    • pos: (typeof Number)

      A position to be converted to a value.

  • summary

    This is a helper function used to determine the value represented by
    a position on the bar graph

  • type

    Function

• dojox.widget.BarGauge.draw

  • summary

    This function is used to draw (or redraw) the bar graph

  • description

    Draws the bar graph by drawing the surface, the ranges, and the indicators.

  • type

    Function

• dojox.widget.BarGauge.drawRange

  • parameters:
    • range: (typeof Object)

      A range is either a dojox.widget.gauge.Range or an object
      with similar parameters (low, high, hover, etc.).

  • summary

    This function is used to draw (or redraw) a range

  • description

    Draws a range (colored area on the background of the gauge)
    based on the given arguments.

  • type

    Function

• dojox.widget.BarGauge.getRangeUnderMouse

  • parameters:
    • event: (typeof Object)

      The event object as received by the mouse handling functions below.

  • summary

    Determines which range the mouse is currently over

  • type

    Function

• dojox.widget.BarGauge._dragIndicator

  • parameters:
    • widget: (typeof Object)
    • event: (typeof Object)
  • summary

    Handles the dragging of an indicator, including moving/re-drawing
    get new value based on mouse position

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object