Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISmartDateLabelProviderOptions

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Hierarchy

Index

Properties

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 dateOffset

dateOffset: number

A timestamp in seconds to add to the value being formatted. This allows you to plot dates with more than millisecond precision but still show a full date with year on the axis.

Optional datePrecision

datePrecision: EDatePrecision

Defines the precision of the input data values. Default EDatePrecision.Seconds (Unix time)

Optional highPrecisionLabelMode

highPrecisionLabelMode: EHighPrecisionLabelMode

How to format high-precision (nano / micro / milli) labels. Default EHighPrecisionLabelMode.Suffix

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 labelThresholds

labelThresholds: TLabelThresholds

Custom label thresholds that map label formats to maximum time ranges in seconds. Allows you to customize when different label formats are used based on the visible time range. You can update individual thresholds by providing a partial object. Defaults to DEFAULT_LABEL_THRESHOLDS.

example
// Override only the Minutes threshold
labelThresholds: {
    [ETradeChartLabelFormat.Minutes]: 60 * 60 * 24 * 7 // 7 days instead of 5
}

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 rotation

rotation: number

Optional showSecondsOnPreciseDate

showSecondsOnPreciseDate: boolean

Whether to show the seconds component on precise date formats. This will NOT affect wide formats (e.g. Jan 1 2026 12:59:59).

example

"59.123456ms" // when true "123456ms" // when false

note

only applies to EHighPrecisionLabelMode.Suffix and EHighPrecisionLabelMode.Fractional

remark

You may use this alongside showSecondsOnWideDate. When one is true, the other can be set to false (to keep labels tidy & avoid repetitions).

Default: false

Optional showSecondsOnWideDate

showSecondsOnWideDate: boolean

Whether to show the seconds component on wide date formats. This will NOT affect precise formats (e.g. 59s123ms).

example

"Jan 1 2026 12:59:59" // when true "Jan 1 2026 12:59" // when false

remark

You may use this alongside showSecondsOnPreciseDate. When one is true, the other can be set to false (to keep labels tidy & avoid repetitions).

Default: true

Optional showWiderDateOnFirstLabel

showWiderDateOnFirstLabel: boolean

Sets whether the first label should be formatted using the wider format (eg Month Day). If false the wider format will only be used when it changes (eg day/month boundary). Default true.

Optional showYearOnWiderDate

showYearOnWiderDate: boolean

Sets whether the year should be shown in the wider format used on first label. Default false.

Optional splitWideDateWithComma

splitWideDateWithComma: boolean

Flag that decides whether your wide formatted dates have a comma in between date + month, and everything else

example

"Jan 1, 2026" // when true "Jan 1 2026" // when false

Default: true

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.

Generated using TypeDoc