ITextLabelOptions | API Documentation for SciChart.js

Hierarchy

ILabel2DOptions
- ITextLabelOptions

Index

Properties

Optional alwaysShowFirstLabel

alwaysShowFirstLabel: boolean

Whether to show the leftmost (or rightmost on axes with flippedCoordinates) label as long as its tick line is visible.

If true and the label width is wider than the difference between majorTicks, it will prefer to push/hide the 2nd label instead of disappearing itself, as long as its tick-line is still in view.

Valuable when used inside of a SmartDateLabelProvider, paired with its showWiderDateOnFirstLabel: true.

Default false for all label providers, except for SmartDateLabelProvider.

Optional asyncLabels

asyncLabels: boolean

deprecated: This functionality has been removed. useNativeText: true provides much greater performance benefit.

Optional cursorLabelFormat

cursorLabelFormat: ENumericFormat

The formatting mode to apply to tooltips CursorModifier, RolloverModifier

Optional cursorLabelPrecision

cursorLabelPrecision: number

Specifies the number of decimal places for the tooltip value CursorModifier, RolloverModifier

Optional labelFormat

labelFormat: ENumericFormat

The formatting mode to apply to the labels

Optional labelPostfix

labelPostfix: string

A postfix for the label values

Optional labelPrecision

labelPrecision: number

Specifies the number of decimal places for the label value

Optional labelPrefix

labelPrefix: string

A prefix for the label values

Optional labels

labels: Record<number, string | string[]>

The label text to use. If you pass an object like {1:"one", 2:"two", 3:"three"} then labels will be chosen based on the tick value. eg ticks 3,1 will result in "three", "one". If you pass an array like ["one", "two", "three"] then for a category axis it will use the labels in the order given, regardless of data value. If you know that your x data will be a fixed set in a fixed order, then passing an array of labels is simpler. To manually specify multiple lines, pass an array for the label eg ["One line",["Two","Lines"],["Three","more","lines"]]

Optional lineSpacing

lineSpacing: number

Line spacing to use if text is wrapped. For normal labels this is a multiple of the text height and defaults to 1.1 For native text it is a number of pixels and defaults to 2

Optional maxLength

maxLength: number

Wrap text longer than this number of characters. Will only wrap whole words.

Optional rotation

rotation: number

Optional useNativeText

useNativeText: boolean

Whether to use WebGL for rendering axis labels. Default true (was false before v4). These are much faster than rendering using canvas text, but do not have quite the same font and style support.

note

Set SciChartDefaults.useNativeText to change the global default.

note

If you want native labels for best performance, but NON-native axis titles for a more flexible Title, set:

const xAxis = new NumericAxis(wasmContext);

xAxis.useNativeText = true; // Native axis labels for performance - already set to `true` by default

xAxis.axisTitle = "X Axis Title";
xAxis.axisTitleStyle.useNativeText: false // Non-native axis title for more font and style options

Optional useSharedCache

useSharedCache: boolean

Whether to use cached labels from other axes that have the same style. You may need to set this false if you are overriding getLabelTexture or getLabelTextureAsync without setting a unique style.