ContoursDataLabelProvider | API Documentation for SciChart.js

Hierarchy

BaseDataLabelProvider
- ContoursDataLabelProvider

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ContoursDataLabelProvider(options?: IContoursDataLabelProviderOptions): ContoursDataLabelProvider

Overrides BaseDataLabelProvider.constructor
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Parameters
- Optional options: IContoursDataLabelProviderOptions
Returns ContoursDataLabelProvider

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

dataSeries: BaseHeatmapDataSeries

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

- (metadata: IPointMetadata): string
- Parameters
  - metadata: IPointMetadata
  Returns string

Protected parentSeries

parentSeries: IRenderableSeries

The Parent RenderableSeries

Protected styleProperty

styleProperty: TDataLabelStyle

Readonly type

type: EDataLabelProviderType = EDataLabelProviderType.Contours

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

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

isEnabled

get isEnabled(): boolean
set isEnabled(value: boolean): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Flag to enable/disable dataLabel generation. Default true

Returns boolean
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Flag to enable/disable dataLabel generation. Default true

Parameters
- value: boolean
Returns void

labelRowCount

get labelRowCount(): number
set labelRowCount(value: number): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Gets or sets the number of rows of data labels. Default 10

Returns number
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Gets or sets the number of rows of data labels. Default 10

Parameters
- value: number
Returns void

numericFormat

get numericFormat(): ENumericFormat
set numericFormat(value: ENumericFormat): void

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

precision

get precision(): number
set precision(value: number): void

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Gets or sets the precision to use when formatting values to text For more control, override getText

Returns number
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Gets or sets the precision to use when formatting values to text For more control, override getText

Parameters
- value: number
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

Methods

delete

delete(): void

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

draw

draw(renderContext: WebGlRenderContext2D): void

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

generateDataLabels

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

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

getColor

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

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Parameters
- xIndex: number
- yIndex: number
- text: string
Returns number

getPosition

getPosition(xIndex: number, yIndex: number, xVal: number, yVal: number, textSize: Size, renderPassData: RenderPassData): Point

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Parameters
- xIndex: number
- yIndex: number
- xVal: number
- yVal: number
- textSize: Size
- renderPassData: RenderPassData
Returns Point

getText

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

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Parameters
- xIndex: number
- yIndex: number
Returns string

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

shouldGenerate

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

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Parameters
- textSize: Size
- cellWidth: number
- cellHeight: number
Returns boolean

shouldSkipLabel

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

- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.ts
Parameters
- xIndex: number
- yIndex: number
- label: TDataLabel
- cellWidth: number
- cellHeight: number
Returns boolean

toJSON

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

Overrides BaseDataLabelProvider.toJSON
- Defined in src/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: IContoursDataLabelProviderOptions

Returns ContoursDataLabelProvider

Properties

Protected colorProperty

Protected colorValue

dataLabels

Protected dataSeries

Protected isEnabledProperty

metaDataSelector

Type declaration

Parameters

metadata: IPointMetadata

Returns string

Protected parentSeries

Protected styleProperty

Readonly type

Protected webAssemblyContext

Protected zValues

Accessors

color

Returns string

Parameters

value: string

Returns void

isEnabled

Returns boolean

Parameters

value: boolean

Returns void

labelRowCount

Returns number

Parameters

value: number

Returns void

numericFormat

Returns ENumericFormat

Parameters

value: ENumericFormat

Returns void

precision

Returns number

Parameters

value: number

Returns void

style

Returns TDataLabelStyle

Parameters

value: TDataLabelStyle

Returns void

Methods

delete

Returns void

draw

Parameters

renderContext: WebGlRenderContext2D

Returns void

generateDataLabels

Parameters

renderContext: WebGlRenderContext2D

renderPassData: RenderPassData

Returns void

getColor

Parameters

xIndex: number

yIndex: number

text: string

Returns number

getPosition

Parameters

xIndex: number

yIndex: number