Class ValueFormatterAbstract

Class to format all values before they are drawn as labels.

Hierarchy (View Summary)

Implements

Constructors

constructor

Methods

getAxisLabel getBarLabel getBarStackedLabel getBubbleLabel getCandleLabel getFormattedValue getPieLabel getPointLabel getRadarLabel

Constructors

constructor

Methods

getAxisLabel

  • getAxisLabel(value: number, axis: AxisBase): string

  • Used to draw axis labels, calls #getFormattedValue by default.

    Parameters

    • value: number

      float to be formatted

    • axis: AxisBase

      axis being labeled

    Returns string

    formatted string label

getBarLabel

  • getBarLabel(value: any, entry: BarEntry): string

  • Used to draw bar labels, calls #getFormattedValue by default.

    Parameters

    • value: any

      current value to be formatted

    • entry: BarEntry

    Returns string

    formatted string label

getBarStackedLabel

  • getBarStackedLabel(value: any, entry: BarEntry): string

  • Used to draw stacked bar labels, calls #getFormattedValue by default.

    Parameters

    • value: any

      current value to be formatted

    • entry: BarEntry

      stacked entry being labeled, contains all Y values

    Returns string

    formatted string label

getBubbleLabel

  • getBubbleLabel(value: any, entry: BubbleEntry): string

  • Used to draw bubble size labels, calls #getFormattedValue by default.

    Parameters

    • value: any
    • entry: BubbleEntry

      bubble being labeled, also contains X and Y values

    Returns string

    formatted string label

getCandleLabel

  • getCandleLabel(value: any, entry: CandleEntry): string

  • Used to draw high labels, calls #getFormattedValue by default.

    Parameters

    Returns string

    formatted string label

getFormattedValue

  • getFormattedValue(value: number, entry?: BaseEntry): string

  • Called when drawing any label, used to change numbers into formatted strings.

    Parameters

    • value: number

      float to be formatted

    • Optionalentry: BaseEntry

    Returns string

    formatted string label

getPieLabel

  • getPieLabel(value: any, entry: PieEntry): string

  • Used to draw pie value labels, calls #getFormattedValue by default.

    Parameters

    • value: any

      float to be formatted, may have been converted to percentage

    • entry: PieEntry

      slice being labeled, contains original, non-percentage Y value

    Returns string

    formatted string label

getPointLabel

  • getPointLabel(value: any, entry: Entry): string

  • Used to draw line and scatter labels, calls #getFormattedValue by default.

    Parameters

    • value: any
    • entry: Entry

      point being labeled, contains X value

    Returns string

    formatted string label

getRadarLabel

  • getRadarLabel(value: any, entry: RadarEntry): string

  • Used to draw radar value labels, calls #getFormattedValue by default.

    Parameters

    Returns string

    formatted string label

Settings

Member Visibility

On This Page

Constructors
Methods