import BaseGauge from 'canvas-gauges/lib/BaseGauge.js'

public class | source

BaseGauge

Extends:

EventEmitter → BaseGauge

Direct Subclass:

LinearGauge, RadialGauge

Basic abstract BaseGauge class implementing common functionality for different type of gauges.

It should not be instantiated directly but must be extended by a final gauge implementation.

Example:


class MyCoolGauge extends BaseGauge {

    // theses methods below MUST be implemented:

    constructor(options) {
       // ... do something with options
       super(options);
       // ... implement anything else
    }

    draw() {
        // ... some implementation here
        return this;
    }
}

Static Member Summary

Static Public Members
public static get	version: string: * Returns gauges version string

Static Method Summary

Static Public Methods
public static	ensureValue(value: *, min: number): number Ensures value is proper number
public static	fromElement(element: HTMLElement) Initializes gauge from a given HTML element (given element should be valid HTML canvas gauge definition)
public static	initialize(type: string, options: GenericOptions): * Inject given gauge object into DOM
public static	mod(n: number, m: number): number Corrects javascript modulus bug

Static Protected Methods
protected static	configure(options: *): BaseGauge Updates gauge options

Constructor Summary

Public Constructor
public abstract	constructor(options: GenericOptions)

Member Summary

Public Members
public	animation: Animation
public	canvas: SmartCanvas
public	initialized: boolean True if gauge has been drawn for the first time, false otherwise.
public	options: GenericOptions Gauge options
public	type: BaseGauge Gauge type class
public set	value(value: number): * Sets new value for this gauge.
public get	value: number: * Returns current value of the gauge
public	version: string Gauges version string

Method Summary

Public Methods
public	destroy() Performs destruction of this object properly
public abstract	draw(): BaseGauge Triggering gauge render on a canvas.
public	update(options: RadialGaugeOptions): BaseGauge Updates gauge configuration options at runtime and redraws the gauge