Options
All
  • Public
  • Public/Protected
  • All
Menu

A DataLabelProvider sepcifically designed to work with or any series that uses an {@link XYTextDataSeries } Text is taken directly from the textValues on the dataSeries and placed at the x,y coordinates (anchored top, left)

Hierarchy

Index

Constructors

constructor

Properties

calculateTextBounds

calculateTextBounds: boolean = false

This default false for maximum performance. It will be true if you set the textPosition to something other than Above, Right. You can force it true if you want to make use of the text sizes in onAfterGenerate

Protected colorProperty

colorProperty: string

dataLabels

dataLabels: TDataLabel[] = []

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

Protected horizontalTextPositionProperty

horizontalTextPositionProperty: EHorizontalTextPosition = EHorizontalTextPosition.Right

Protected isEnabledProperty

isEnabledProperty: boolean = true

Protected parentSeries

parentSeries: IRenderableSeries

The Parent RenderableSeries

Protected styleProperty

styleProperty: TDataLabelStyle

type

type: EDataLabelProviderType = EDataLabelProviderType.Text

Protected verticalTextPositionProperty

verticalTextPositionProperty: EVerticalTextPosition = EVerticalTextPosition.Above

Protected webAssemblyContext

webAssemblyContext: TSciChart

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

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

horizontalTextPosition

  • Gets or sets the horizontal text position for the label For more control, override getPosition

    Returns EHorizontalTextPosition

  • Gets or sets the horizontal text position for the label For more control, override getPosition

    Parameters

    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

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

verticalTextPosition

  • Gets or sets the vertical text position for the label For more control, override getPosition

    Returns EVerticalTextPosition

  • Gets or sets the vertical text position for the label For more control, override getPosition

    Parameters

    Returns void

Methods

delete

  • delete(): void
  • Returns void

draw

generateDataLabels

getColor

  • Parameters

    Returns number

getPosition

  • Parameters

    Returns Point

Protected invalidateParent

  • invalidateParent(): void

onAfterGenerate

  • Called after labels are generated but before they are drawn.

    Parameters

    Returns void

onAttach

onDetach

  • onDetach(): void
  • Returns void

resolveAutoColors

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

toJSON

updateStyle

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

    Parameters

    Returns void

Generated using TypeDoc