Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Protected colorProperty

colorProperty: string

Protected colorValue

colorValue: number

dataLabels

dataLabels: TDataLabel[] = []

The text to draw, along with the sizes and positions. Usually generated, but can be updated before final drawing

Protected dataSeries

Protected isEnabledProperty

isEnabledProperty: boolean = true

metaDataSelector

metaDataSelector: (metadata: IPointMetadata) => string

If this is set it will be used to get text values from metaData, rather than formatting y values. The selector will be called even if the metaData for an index is undefined.

Type declaration

Protected parentSeries

parentSeries: IRenderableSeries

The Parent RenderableSeries

Protected styleProperty

styleProperty: TDataLabelStyle

Readonly type

type: EDataLabelProviderType = EDataLabelProviderType.Heatmap

Protected webAssemblyContext

webAssemblyContext: TSciChart

The SciChart 2D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

Protected zValues

zValues: number[][]

Accessors

color

  • get color(): string
  • set color(value: string): void
  • Gets or sets the color for data labels. Defaults to axis label color

    Returns string

  • Gets or sets the color for data labels. Defaults to axis label color

    Parameters

    • value: string

    Returns void

isEnabled

  • get isEnabled(): boolean
  • set isEnabled(value: boolean): void
  • Flag to enable/disable dataLabel generation. Default true

    Returns boolean

  • Flag to enable/disable dataLabel generation. Default true

    Parameters

    • value: boolean

    Returns void

numericFormat

  • Gets or sets numeric format to use when formatting values to text. For a list of values, see ENumericFormat For more control, override getText

    Returns ENumericFormat

  • Gets or sets numeric format to use when formatting values to text. For a list of values, see ENumericFormat For more control, override getText

    Parameters

    Returns void

precision

  • get precision(): number
  • set precision(value: number): void
  • Gets or sets the precision to use when formatting values to text For more control, override getText

    Returns number

  • Gets or sets the precision to use when formatting values to text For more control, override getText

    Parameters

    • value: number

    Returns void

style

  • Gets or sets the text style used for data labels. The style must be set, with fontFamily and fontSize set, in order for text to be drawn.

    Returns TDataLabelStyle

  • Gets or sets the text style used for data labels. The style must be set, with fontFamily and fontSize set, in order for text to be drawn.

    Parameters

    Returns void

Methods

delete

  • delete(): void
  • Returns void

draw

generateDataLabels

getColor

  • getColor(xIndex: number, yIndex: number, text: string): number
  • Parameters

    • xIndex: number
    • yIndex: number
    • text: string

    Returns number

getPosition

  • getPosition(xIndex: number, yIndex: number, xVal: number, yVal: number, textSize: Size, cellWidth: number, cellHeight: number, renderPassData: RenderPassData): Point
  • Parameters

    • xIndex: number
    • yIndex: number
    • xVal: number
    • yVal: number
    • textSize: Size
    • cellWidth: number
    • cellHeight: number
    • renderPassData: RenderPassData

    Returns Point

getText

  • getText(xIndex: number, yIndex: number): string
  • Parameters

    • xIndex: number
    • yIndex: number

    Returns string

Protected invalidateParent

  • invalidateParent(): void

onAttach

onDetach

  • onDetach(): void
  • Returns void

resolveAutoColors

  • resolveAutoColors(index: number, maxSeries: number, theme: IThemeProvider): void

shouldGenerate

  • shouldGenerate(textSize: Size, cellWidth: number, cellHeight: number): boolean
  • Parameters

    • textSize: Size
    • cellWidth: number
    • cellHeight: number

    Returns boolean

shouldSkipLabel

  • shouldSkipLabel(xIndex: number, yIndex: number, label: TDataLabel, cellWidth: number, cellHeight: number): boolean
  • Parameters

    • xIndex: number
    • yIndex: number
    • label: TDataLabel
    • cellWidth: number
    • cellHeight: number

    Returns boolean

toJSON

updateStyle

  • Update the style. Only the properties passed will be updated

    Parameters

    Returns void

Generated using TypeDoc