Class StackedCollectionDataLabelProvider

Go to JavaScript Charting Documentation

Go to JavaScript Chart Examples

Go to SciChart.js on Github

Hierarchy

BaseDataLabelProvider
- StackedCollectionDataLabelProvider

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new StackedCollectionDataLabelProvider(): StackedCollectionDataLabelProvider

Overrides BaseDataLabelProvider.constructor
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/StackedCollectionDataLabelProvider.ts
Returns StackedCollectionDataLabelProvider

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

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

Returns string
Inherited from BaseDataLabelProvider.color
- 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

Inherited from BaseDataLabelProvider.style
- 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
Inherited from BaseDataLabelProvider.style
- 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

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

Methods

delete

delete(): void

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

draw

draw(renderContext: WebGlRenderContext2D): void

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

generateDataLabels

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

Overrides BaseDataLabelProvider.generateDataLabels
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/StackedCollectionDataLabelProvider.ts
Parameters
- renderContext: WebGlRenderContext2D
- renderPassData: RenderPassData
Returns void

Protected getLineSpacing

getLineSpacing(): number

Inherited from BaseDataLabelProvider.getLineSpacing
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.ts
Returns number

Protected invalidateParent

invalidateParent(): void

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

onAttach

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

Inherited from BaseDataLabelProvider.onAttach
- 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

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

resolveAutoColors

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

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

toJSON

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

Inherited from BaseDataLabelProvider.toJSON
- 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

Inherited from BaseDataLabelProvider.updateStyle
- 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