Class BaseDataLabelProvider

Go to JavaScript Charting Documentation

Go to JavaScript Chart Examples

Go to SciChart.js on Github

Hierarchy

BaseDataLabelProvider

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new BaseDataLabelProvider(options?: IBaseDataLabelProviderOptions): BaseDataLabelProvider

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Creates an instance of the DataLabelProvider

Parameters
- Optional options: IBaseDataLabelProviderOptions
Returns BaseDataLabelProvider

Properties

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

drawImmediate

drawImmediate: boolean = false

Draws immediately, set this True when using sub-surfaces for proper data label layering

Protected parentSeries

parentSeries: IRenderableSeries

The Parent RenderableSeries

Protected styleProperty

styleProperty: TDataLabelStyle

Readonly type

type: EDataLabelProviderType

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

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Gets or sets the color for data labels. Defaults to axis label color

Returns string
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Gets or sets the color for data labels. Defaults to axis label color

Parameters
- value: string
Returns void

style

get style(): TDataLabelStyle
set style(value: TDataLabelStyle): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
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
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
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
- value: TDataLabelStyle
Returns void

Protected useRotation

get useRotation(): boolean

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Returns boolean

Methods

delete

delete(): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Returns void

draw

draw(renderContext: WebGlRenderContext2D): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Parameters
- renderContext: WebGlRenderContext2D
Returns void

generateDataLabels

generateDataLabels(renderContext: WebGlRenderContext2D, renderPassData: RenderPassData): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Base behaviour is to do nothing. Labels will only be drawn if they have been manually set

Parameters
- renderContext: WebGlRenderContext2D
- renderPassData: RenderPassData
Returns void

Protected invalidateParent

invalidateParent(): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Returns void

onAttach

onAttach(webAssemblyContext: TSciChart, parentSeries: IRenderableSeries): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Called when a DataLabelProvider is attached to a parent RenderableSeries

Parameters
- webAssemblyContext: TSciChart
- parentSeries: IRenderableSeries
Returns void

onDetach

onDetach(): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Returns void

resolveAutoColors

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

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Parameters
- index: number
- maxSeries: number
- theme: IThemeProvider
Returns void

toJSON

toJSON(): { type: EDataLabelProviderType; options: object }

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Returns { type: EDataLabelProviderType; options: object }
- type: EDataLabelProviderType
- options: object
  - color: string
  - style: { fontFamily?: string; fontSize?: number; lineSpacing?: number; multiLineAlignment?: EMultiLineAlignment; padding?: Thickness }
    - Optional fontFamily?: string
    - Optional fontSize?: number
    - Optional lineSpacing?: number
    - Optional multiLineAlignment?: EMultiLineAlignment
    - Optional padding?: Thickness

updateStyle

updateStyle(value: TDataLabelStyle): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Update the style. Only the properties passed will be updated

Parameters
- value: TDataLabelStyle
Returns void

Generated using TypeDoc