Home Reference Source

References

Class Summary

Static Public Class Summary
public

Animation engine API for JavaScript-based animations.
public abstract

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

DOM Observer.
public

Class EventEmitter - base event manager
public

Minimalistic HTML5 Canvas Linear Gauge
public

Minimalistic HTML5 Canvas Gauge
public

Drawings on canvas using hidden canvas as a cache for better performance drawings during canvas animations.

Function Summary

Static Public Function Summary
public

Gauge collections type.
public

drawShadow(context: Canvas2DContext, options: GenericOptions, shadowDrawn: boolean): boolean

Draws the shadow if it was not drawn
public

drawValueBox(context: Canvas2DContext, options: GenericOptions, value: number | string, x: number, y: number, max: number)

Draws value box at given position
public

font(options: GenericOptions, target: string, baseSize: number): *

Constructs font styles for canvas fonts
public

formatContext(options: GenericOptions | any, format: string): string

Format string unit string format using option members Format option to set the “units” attribute.
public

Formats a number for display on the dial's plate using the majorTicksFormat config option.
public

linearGradient(context: Canvas2DContext, colorFrom: string, colorTo: string, length: number, isVertical: boolean, from: number): CanvasGradient

Creates and returns linear gradient canvas object
public

normalizedValue(options: GenericOptions): {normal: number, indented: number}

Returns normalized value
public

padValue(val: number, options: RadialGaugeOptions | {valueInt: number, valueDec: number}): string

Pads a given value with leading zeros using the given options
public

radialPoint(radius: number, angle: number): {x: number, y: number}

Calculates and returns radial point coordinates
public

radians(degrees: number): number

Transforms degrees to radians
public

roundRect(context: Canvas2DContext, x: number, y: number, w: number, h: number, r: number)

Draws rounded corners rectangle
public

vendorize(prop: string, from: HTMLElement | Window | object): *

Look-ups for a proper vendor-specific property and returns its value
public

Examines if a given error is something to throw or to ignore

Variable Summary

Static Public Variable Summary
public
public

GenericOptions: {renderTo: RenderTarget, width: number, height: number, minValue: number, maxValue: number, value: number, units: string|boolean, majorTicks: number[]|string[], exactTicks: boolean, minorTicks: number, strokeTicks: boolean, animatedValue: boolean, animateOnInit: boolean, title: string|boolean, borders: boolean, valueInt: number, valueDec: number, majorTicksInt: number, majorTicksDec: number, animation: boolean, animationDuration: number, animationRule: string|AnimationRule, colorPlate: string, colorPlateEnd: string, colorMajorTicks: string, colorMinorTicks: string, colorStrokeTicks: string, colorTitle: string, colorUnits: string, colorNumbers: string, colorNeedle: string, colorNeedleEnd: string, colorValueText: string, colorValueTextShadow: string, colorBorderShadow: string, colorBorderOuter: string, colorBorderOuterEnd: string, colorBorderMiddle: string, colorBorderMiddleEnd: string, colorBorderInner: string, colorBorderInnerEnd: string, colorValueBoxRect: string, colorValueBoxRectEnd: string, colorValueBoxBackground: string, colorValueBoxShadow: string, colorNeedleShadowUp: string, colorNeedleShadowDown: string, needle: boolean, needleShadow: boolean, needleType: string, needleStart: number, needleEnd: number, needleWidth: number, borderOuterWidth: number, borderMiddleWidth: number, borderInnerWidth: number, borderShadowWidth: number, valueBox: boolean, valueBoxWidth: number, valueBoxStroke: number, valueText: string, valueTextShadow: boolean, valueBoxBorderRadius: number, highlights: Highlight[], highlightsWidth: number, fontNumbers: string, fontTitle: string, fontUnits: string, fontValue: string, fontTitleSize: number, fontValueSize: number, fontUnitsSize: number, fontNumbersSize: number, fontNumbersStyle: string, fontTitleStyle: string, fontUnitsStyle: string, fontValueStyle: string, fontNumbersWeight: string, fontTitleWeight: string, fontUnitsWeight: string, fontValueWeight: string, barWidth: number, barStrokeWidth: number, barProgress: boolean, colorBar: string, colorBarStroke: string, colorBarProgress: string, colorBarShadow: string, barShadow: number, listeners: object}

Shared generic gauges options
public

Typedef Summary

Static Public Typedef Summary
public

Generic AnimationRule function interface
public

AnimationRules: { linear: AnimationRule, quad: AnimationRule, dequad: AnimationRule, quint: AnimationRule, dequint: AnimationRule, cycle: AnimationRule, decycle: AnimationRule, bounce: AnimationRule, debounce: AnimationRule, elastic: AnimationRule, delastic: AnimationRule, }

Predefined known animation rules.
public

Callback for animation step draw event.
public

Callback for animation complete event.
public

GaugeInterface: function(options: GenericOptions): GaugeInterface, draw

public

Highlight: {from: number, to: number, color: string}

Highlight area definition.
public

LinearGaugeOptions: GenericOptions | {borderRadius: number, barBeginCircle: number, tickSide: string, needleSide: string, numberSide: string, ticksWidth: number, ticksWidthMinor: number, ticksPadding: number, barLength: number, colorBarEnd: string, colorBarProgressEnd: string}

Linear gauge configuration options
public

RadialGaugeOptions: GenericOptions | { exactTicks: boolean, ticksAngle: number, startAngle: number, colorNeedleCircleOuter: string, colorNeedleCircleOuterEnd: string, colorNeedleCircleInner: string, colorNeedleCircleInnerEnd: string, needleCircleSize: number, needleCircleInner: boolean, needleCircleOuter: boolean, animationTarget: string, useMinPath: boolean, barStartPosition: 'right' | 'left', }

Gauge configuration options
public

RenderTarget: HTMLElement | string

Describes rendering target element.

External Summary

Static Public External Summary
public
public
public
public