Class Gauge

The Gauge Control is a versatile component designed to display various types of measurements in a visually intuitive manner.

It is particularly suitable for representing real-time data such as speed, volume levels, pressure, temperature, or filling levels. The gauge provides a clear and immediate visual indication of these measurements, making it an ideal choice for monitoring and control applications.

Hierarchy

  • UpControl
    • Gauge

Methods

getGaugeArrow getGaugeSettings reload reloadJS

Methods

getGaugeArrow

  • This method returns the GaugeArrow instance that represents the arrow in the gauge control. The GaugeArrow object can be used to manipulate the appearance and behavior of the arrow in the gauge.

    Returns GaugeArrow

    Example

    var gaugeControl = ix.api.dom.getControl("<GUID>");
    var gaugeArrow = gaugeControl.getGaugeArrow();

getGaugeSettings

  • Retrieves the current settings of the gauge control.

    This method returns the options object that contains the current configuration settings of the gauge control. These settings include properties such as minimum and maximum values, color, size, and other gauge-specific options.

    Returns GaugeSettings

    Example

    var gaugeControl = ix.api.dom.getControl("<GUID>");
    var gaugeSettings = gaugeControl.getGaugeSettings();

reload

  • Reloads the gauge control.

    Parameters

    • element: HTMLElement

      The HTML element that represents the gauge control.

    • Optional object: {
          animated: boolean;
      }

      An optional object containing the animated property, which determines whether the gauge's changes are animated.

      • animated: boolean

    Returns void

    Example

    var gaugeControl = ix.api.dom.getControl("<GUID>");
    gaugeControl.reload(ix.util.getHTML("<GUID>"), { animated: true });

reloadJS

  • Reloads the gauge based on the provided settings.

    • This method updates the gauge control's settings based on the provided data.
    • The data should be a JSON object that includes properties for the gauge's arrows, axes, and bands.
    • The method updates the gauge's display value, value description, and band ranges based on this data.

    Parameters

    • data: JSON

      A JSON object containing the new settings for the gauge.

    Returns void

    Example

    var gaugeControl = ix.api.dom.getControl("<GUID>");
    var gaugeSettings = gaugeControl.getGaugeSettings();

    gaugeControl.reloadJS(gaugeSettings);

Settings

Member Visibility

Theme

On This Page