dojox/widget/AnalogGauge.js

• Provides:

  • dojox.widget.AnalogGauge

• Requires:

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

• dojox.widget.gauge.AnalogLineIndicator

  • type

    Function

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

• dojox.widget.gauge.AnalogLineIndicator._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 ArrowIndicator).

  • type

    Function

• dojox.widget.gauge.AnalogLineIndicator.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.AnalogLineIndicator.text

  • type

    Object

• dojox.widget.gauge.AnalogLineIndicator.color

  • type

    String

• dojox.widget.gauge.AnalogLineIndicator.length

  • type

    Object

• dojox.widget.gauge.AnalogLineIndicator.width

  • type

    Number

• dojox.widget.gauge.AnalogLineIndicator.offset

  • type

    Number

• dojox.widget.gauge.AnalogLineIndicator.highlight

  • type

    String

• dojox.widget.gauge.AnalogLineIndicator.shapes

  • type

    Object

• dojox.widget.gauge.AnalogLineIndicator.currentValue

• dojox.widget.gauge.AnalogLineIndicator._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.AnalogGauge

  • type

    Function

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

    a gauge 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 gauge component, used to display numerical data in a familiar format
    
    usage:
    <script type="text/javascript">
    dojo.require("dojox.widget.AnalogGauge");
    dojo.require("dijit.util.parser");
    </script>
    ...
    <div	dojoType="dojox.widget.AnalogGauge"
    id="testGauge"
    width="300"
    height="200"
    cx=150
    cy=175
    radius=125
    image="gaugeOverlay.png"
    imageOverlay="false"
    imageWidth="280"
    imageHeight="155"
    imageX="12"
    imageY="38">
    </div>

• dojox.widget.AnalogGauge.startAngle

  • type

    Number

  • summary

    angle (in degrees) for start of gauge (default is -90)

• dojox.widget.AnalogGauge.endAngle

  • type

    Number

  • summary

    angle (in degrees) for end of gauge (default is 90)

• dojox.widget.AnalogGauge.cx

  • type

    Number

  • summary

    center of gauge x coordinate (default is gauge width / 2)

• dojox.widget.AnalogGauge.cy

  • type

    Number

  • summary

    center of gauge x coordinate (default is gauge height / 2)

• dojox.widget.AnalogGauge.radius

  • type

    Number

  • summary

    radius of gauge (default is smaller of cx-25 or cy-25)

• dojox.widget.AnalogGauge._defaultIndicator

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

    override

  • summary

    of dojox.widget._Gauge._defaultIndicator

• dojox.widget.AnalogGauge.startup

  • type

    Function

• dojox.widget.AnalogGauge._oppositeMiddle

  • type

    Number

• dojox.widget.AnalogGauge._getAngle

  • parameters:
    • value: (typeof Number)

      A value to be converted to an angle for this gauage.

  • summary

    This is a helper function used to determine the angle that represents
    a given value on the gauge

  • type

    Function

• dojox.widget.AnalogGauge._getValueForAngle

  • parameters:
    • angle: (typeof Number)

      A angle to be converted to a value for this gauge.

  • summary

    This is a helper function used to determie the value represented by a
    given angle on the gauge

  • type

    Function

• dojox.widget.AnalogGauge._getRadians

  • parameters:
    • angle: (typeof Number)

      An angle, in degrees, to be converted to radians.

  • summary

    This is a helper function than converts degrees to radians

  • type

    Function

• dojox.widget.AnalogGauge._getDegrees

  • parameters:
    • radians: (typeof Number)

      An angle, in radians, to be converted to degrees.

  • summary

    This is a helper function that converts radians to degrees

  • type

    Function

• dojox.widget.AnalogGauge.draw

  • summary

    This function is used to draw (or redraw) the gauge.

  • description

    Draws the gauge by drawing the surface, the ranges, and the indicators.

  • type

    Function

• dojox.widget.AnalogGauge.drawRange

  • parameters:
    • range: (typeof Object)

      A range is 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.AnalogGauge.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.AnalogGauge._dragIndicator

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

    Handles the dragging of an indicator, including moving/re-drawing
    get angle for mouse position

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object