Home Reference Source

Typedef

Static Public 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}

Gauge configuration options

public

RenderTarget: HTMLElement | string

Describes rendering target element.

Static Public

public AnimationRule: function(percent: number): number source

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} source

Predefined known animation rules. It's a simple collection of math for some most used animations.

public DrawEventCallback: function(percent: number): * source

Callback for animation step draw event. It will be called each time animation step is executed, bypassing as first argument a percent of animation completeness. It is expected that this callback will do an actual work of animating an elements or whatever, as far as animation engine is just calculating and executing animation steps without any knowledge about things under animation.

public EndEventCallback: function(): * source

Callback for animation complete event. It is called once each animation is complete.

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

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

Highlight area definition. It describes highlight area starting from value to value using color. Color can be describes with hex, rgb or rgba value.

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} source

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} source

Gauge configuration options

public RenderTarget: HTMLElement | string source

Describes rendering target element. Can be either string identifier of the element or the element itself.