Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

A base class for Label Providers - types which allow programmatic overriding of Axis labels

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns LabelProvider

Properties

Protected formatCursorLabelProperty

formatCursorLabelProperty: TFormatLabelFn

Protected formatLabelProperty

formatLabelProperty: TFormatLabelFn

parentAxis

parentAxis: AxisCore

The parent AxisCore. This will be set once attachedToAxis is called

Readonly Abstract type

type: ELabelProviderType | string

Accessors

cursorNumericFormat

  • Gets or sets numeric format to use for cursor labels. For a list of values, see ENumericFormat

    Returns ENumericFormat

  • Gets or sets numeric format to use for cursor labels. For a list of values, see ENumericFormat

    Parameters

    Returns void

cursorPrecision

  • get cursorPrecision(): number
  • set cursorPrecision(value: number): void
  • Gets or sets the precision to use for cursors labels

    Returns number

  • Gets or sets the precision to use for cursors labels

    Parameters

    • value: number

    Returns void

formatCursorLabel

  • Gets or sets a formatCursorLabel function which is used for formatting a data-value into a string for display on a cursor or tooltip If you are creating a custom LabelProvider, you should override formatCursorLabelProperty, not the formatCursorLabel property! See our Documentation

    Returns TFormatLabelFn

  • Gets or sets a formatCursorLabel function which is used for formatting a data-value into a string for display on a cursor or tooltip If you are creating a custom LabelProvider, you should override formatCursorLabelProperty, not the formatCursorLabel property! See our Documentation

    Parameters

    Returns void

formatLabel

  • Gets or sets a formatLabel function which is used for formatting a data-value into a string for display on the axis labels. If you are creating a custom LabelProvider, you should override formatLabelProperty, not the formatLabel property! See our Documentation

    Returns TFormatLabelFn

  • Gets or sets a formatLabel function which is used for formatting a data-value into a string for display on the axis labels. If you are creating a custom LabelProvider, you should override formatLabelProperty, not the formatLabel property! See our Documentation

    Parameters

    Returns void

numericFormat

  • Gets or sets numeric format to use. For a list of values, see ENumericFormat

    Returns ENumericFormat

  • Gets or sets numeric format to use. For a list of values, see ENumericFormat

    Parameters

    Returns void

postfix

  • get postfix(): string
  • set postfix(v: string): void
  • Gets or sets a string to add to the end of each label

    Returns string

  • Gets or sets a string to add to the end of each label

    Parameters

    • v: string

    Returns void

precision

  • get precision(): number
  • set precision(value: number): void
  • Gets or sets the precision to use when formatting

    Returns number

  • Gets or sets the precision to use when formatting

    Parameters

    • value: number

    Returns void

prefix

  • get prefix(): string
  • set prefix(v: string): void
  • Gets or sets a string to add to the beginning of each label

    Returns string

  • Gets or sets a string to add to the beginning of each label

    Parameters

    • v: string

    Returns void

Methods

applyFormat

  • applyFormat(value: string): string
  • Parameters

    • value: string

    Returns string

attachedToAxis

  • Called when the LabelProvider is attached to an Axis

    Parameters

    • axis: AxisCore

      The Axis we are attached to.

    Returns void

Protected invalidateParent

  • invalidateParent(): void
  • Returns void

Abstract onBeginAxisDraw

  • onBeginAxisDraw(): void
  • Called once when an axis drawing pass begins. Use this method to do one-time setup

    Returns void

toJSON

  • toJSON(): { options: {}; type: string }
  • Returns { options: {}; type: string }

    • options: {}
    • type: string

Generated using TypeDoc