Creates an instance of the DataLabelProvider
The text to draw, along with the sizes and positions. Usually generated, but can be set or updated before final drawing
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.
The Parent RenderableSeries
Whether the label text should update when the label position is animating. Default false.
The SciChart 2D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
A function to pick which y values to use from the pointSeries passed in on the renderPassData
Gets or sets the color for data labels. Defaults to axis label color
Gets or sets the color for data labels. Defaults to axis label color
Gets the engineering prefixes to use when formatting values to text.
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 horizontal text position for the label For more control, override getPosition
Gets or sets the horizontal text position for the label For more control, override getPosition
Flag to enable/disable dataLabel generation. Default true
Flag to enable/disable dataLabel generation. Default true
Gets or sets numeric format to use when formatting values to text. For a list of values, see ENumericFormat For more control, override getText
Gets or sets numeric format to use when formatting values to text. For a list of values, see ENumericFormat For more control, override getText
Gets or sets the number of points below which drawing will start. Default Infinity This can be used instead of pointGapThreshold when data is unevenly spaced or has large y variation
Gets or sets the number of points below which drawing will start. Default Infinity This can be used instead of pointGapThreshold when data is unevenly spaced or has large y variation
Gets or sets the zoom threshold above which label drawing will start. Default 0. This is expressed as the gap between the first points divided by the size of the first text If data is unevenly spaced, consider pointCountThreshold or override shouldDrawText
Gets or sets the zoom threshold above which label drawing will start. Default 0. This is expressed as the gap between the first points divided by the size of the first text If data is unevenly spaced, consider pointCountThreshold or override shouldDrawText
Gets or sets the precision to use when formatting values to text For more control, override getText
Gets or sets the precision to use when formatting values to text For more control, override getText
How do decide whether to keep or skip a label once generated. Override shouldSkipLabel for more control
How do decide whether to keep or skip a label once generated. Override shouldSkipLabel for more control
The number of points to skip while generating labels. Default 0 = no skip. 1 = skip every other. When creating text with many data points, it will help performance to skip points rather than creating and checking overlap for every data point.
The number of points to skip while generating labels. Default 0 = no skip. 1 = skip every other. When creating text with many data points, it will help performance to skip points rather than creating and checking overlap for every data point.
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.
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.
Gets or sets the vertical text position for the label For more control, override getPosition
Gets or sets the vertical text position for the label For more control, override getPosition
Generates labels using getText, getPosition, getColor. Overrides manually set labels.
Called at the start of generateDataLabels. If false, no labels will be generated. Checks pointCountThreshold then pointGapThreshold
Update the style. Only the properties passed will be updated
Generated using TypeDoc
This is the standard DataLabelProvider which provides a number of options for configuring data labels. It defines a much richer api than BaseDataLabelProvider and is intended to be used as a base for doing small changes to data label behaviour generateDataLabels calls the following functions which you can override parts of the behaviour ySelector to pick the desired yValues from the pointSeries. shouldGenerate to determine if any labels should be generated so you can enable labels depending on zoom or data level. Then for each data point: getText Build in behaviour can get text from metadata using metaDataSelector or format the y values using numericFormat and precision getPosition By default return the x and y coordinate of the data point. Series-specific DataLabelProviders eg LineSeriesDataLabelProvider have logic to adjust text position based on the series getColor Returns the color from the text style. Use parseColorToUIntArgb to turn color string to the required numeric value if overriding. shouldSkipLabel Decides whether to keep or ship the generated label based on the {@link }