Creates an instance of NumericLabelProvider
Optional parameters of type ILabelOptions used to configure the axis at instantiation time
The parent AxisCore. This will be set once attachedToAxis is called
This is the id for the text style used by this axis, as stored in the label cache. Cached labels are accessed by text and styleId. If you have useSharedCache = true and are overriding getLabelTexture or getLabelTextureAsync and do not ensure the style is unique, you might not get the labels you expect. You can either set useSharedCache = false, set this to some unique value, or override getCachedStyle
Set this true if the format function could return different results for the same input (eg SmartDateLabelprovider)
Experimental - set true to use native text for axes. Not all text features currently supported
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 without setting a unique style. Can be set globally using SciChartDefaults. Currently default false.
Gets or sets numeric format to use for cursor labels. For a list of values, see ENumericFormat
Gets or sets numeric format to use for cursor labels. For a list of values, see ENumericFormat
Gets or sets the precision to use for cursors labels
Gets or sets the precision to use for cursors labels
Gets or sets the engineering prefixes to use when formatting values to text.
Default - ['K','M','B,'T']
for "large" prefixes, ['m','u','n','p']
for small prefixes
Gets or sets the engineering prefixes to use when formatting values to text.
Default - ['K','M','B,'T']
for "large" prefixes, ['m','u','n','p']
for small prefixes
Gets or sets a formatCursorLabel function which is used for formatting a data-value into a string for display on a cursor or tooltip If you are creating a custom LabelProvider, you should override formatCursorLabelProperty, not the formatCursorLabel property! See our Documentation
Gets or sets a formatCursorLabel function which is used for formatting a data-value into a string for display on a cursor or tooltip If you are creating a custom LabelProvider, you should override formatCursorLabelProperty, not the formatCursorLabel property! See our Documentation
Gets or sets a formatLabel function which is used for formatting a data-value into a string for display on the axis labels. If you are creating a custom LabelProvider, you should override formatLabelProperty, not the formatLabel property! See our Documentation
Gets or sets a formatLabel function which is used for formatting a data-value into a string for display on the axis labels. If you are creating a custom LabelProvider, you should override formatLabelProperty, not the formatLabel property! See our Documentation
Line spacing to use if text is wrapped, as a multiple of the text height. Defaults to 1.1
Line spacing to use if text is wrapped, as a multiple of the text height. Defaults to 1.1
Gets or sets numeric format to use. For a list of values, see ENumericFormat
Gets or sets numeric format to use. For a list of values, see ENumericFormat
Gets or sets a string to add to the end of each label
Gets or sets a string to add to the end of each label
Gets or sets the precision to use when formatting
Gets or sets the precision to use when formatting
Gets or sets a string to add to the beginning of each label
Gets or sets a string to add to the beginning of each label
Called when the LabelProvider is attached to an Axis
The Axis we are attached to.
Called when the LabelProvider is detached from an Axis
Get a texture for the given label text. By default the textures are created first and then the resulting sizes are used by the layout functions
The required text
A textureManager instance which contains methods for creating textures
The style for the text
A TTextureObject containing the bitmapTexture and the size
This method creates the text style to be stored in the label cache. When useSharedCache = true, the label cache will generate a new styleId if this style does not match any existing style. Cached labels are accessed by text and styleId. If you are overriding getLabelTexture or getLabelTextureAsync and do not ensure the style is unique, you might not get the labels you expect. You can either set useSharedCache = false, override this and set the extras field in TCachedLabelStyle, or set styleId directly
Called during axis layout to get the height of the label
the CanvasRenderingContext2D which can be used to perform text measurment
the text of the label
the style of the label
the label height in pixels
Create a texture for the given label text. This method is called if useNativeText is false. If overriding this method with useSharedCache = true, consider setting it false for this LabelProvider, otherwise other axes using the same style and text may see your custom texture. Alternatively you can override getCachedStyle or set styleId directly
Called during axis layout to get the width of the label
the CanvasRenderingContext2D which can be used to perform text measurment
the text of the label
the style of the label
the label width in pixels
Returns an array of label strings for an array of major tick numeric values
The major tick numeric values
Called during axis layout to get the maximum height of labels on a horizontal axis. Normally this calls getLabelHeight for each label and returns the largest.
an array of text labels
the CanvasRenderingContext2D which can be used to perform text measurment
the style of the labels
the maximum label height in pixels
Called during axis layout to get the maximum width of labels on a vertical axis. Normally this calls getLabelWidth for each label and returns the largest.
an array of text labels
the CanvasRenderingContext2D which can be used to perform text measurment
the style of the labels
the maximum label width in pixels
Generated using TypeDoc
The NumericLabelProvider formats Axis Labels and Cursor / Tooltips for NumericAxis types