Class GaugeChart <PublicSlice, InternalSlice >

Properties

engine

engine: PublicEngine

pixelScale

pixelScale: Vec2<Scale>

uiScale

uiScale: Vec2<Scale>

Methods

addLegendBox

addLegendBox(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addUIElement

addUIElement(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

disableAnimations(): this

Returns this

Chart itself for fluent interface.

dispose

dispose(): this

Returns this

Object itself for fluent interface

getAnimationsEnabled

getAnimationsEnabled(): boolean

Returns boolean

Boolean state for animations enabled

getBackgroundFillStyle

getBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getBackgroundStrokeStyle

getBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getPadding

getPadding(): Margin

Returns Margin

Padding datastructure

getTitle

getTitle(): string

Returns string

Chart title as a string.

getTitleFillStyle

getTitleFillStyle(): FillStyle

Returns FillStyle

FillStyle object

getTitleFont

getTitleFont(): FontSettings

Returns FontSettings

FontSettings object

getTitleMarginBottom

getTitleMarginBottom(): number

Returns number

Padding after Chart title

getTitleMarginTop

getTitleMarginTop(): number

Returns number

Padding before Chart title

offResize

offResize(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onResize

onResize(handler: function): Token

Parameters
- handler: function
  - - Parameters
      - obj: this
      - width: pixel
      - height: pixel
      - engineWidth: pixel
      - engineHeight: pixel
      Returns void
Returns Token

Token of subscription

saveToFile

saveToFile(fileName: string, type: undefined | string, encoderOptions: undefined | number): this

Parameters
- fileName: string
- Optional type: undefined | string
- Optional encoderOptions: undefined | number
Returns this

setAnimationsEnabled

setAnimationsEnabled(animationsEnabled: boolean): this

Parameters
- animationsEnabled: boolean
Returns this

Gauge itself for fluent interface.

setBackgroundFillStyle

setBackgroundFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setBackgroundStrokeStyle

setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setPadding

setPadding(padding: Partial<Margin> | number): this

Parameters
- padding: Partial<Margin> | number
Returns this

Object itself

setTitle

setTitle(title: string): this

Parameters
- title: string
Returns this

Object itself for fluent interface.

setTitleFillStyle

setTitleFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Chart itself

setTitleFont

setTitleFont(value: FontSettings | ImmutableMutator<FontSettings>): this

Parameters
- value: FontSettings | ImmutableMutator<FontSettings>
Returns this

Chart itself

setTitleMarginBottom

setTitleMarginBottom(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface

setTitleMarginTop

setTitleMarginTop(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface