An object defining the label configuration options.
Each series point can be accompanied by a text label that represents data related to the point. These are called series point labels. Use the label object's properties to set label options for all chart series at once.
Specify the label object's properties within the commonSeriesSettings configuration object to set label options for all chart series at once.
If you have several series of a single type, you can set label options to the values specific to this series type using the corresponding object (area, line, etc.) within the commonSeriesSettings configuration object. The values that are set within series-type-specific configuration objects override the corresponding common values.
If you need to set a label option for an individual series, use the label object within the series object of the series array. The values that are set individually override the corresponding common values.
Formats the point argument before it is displayed in the point label. To format the point value, use the format option.
- format - provides a comprehensive overview of formatting capabilities.
- Data Formatting - shows how to apply formatting to various widget elements.
This option supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
You can remove the label's background by setting this option to "none". In this case, the label's text is the same color as the point.
The function's parameter has the following fields:
Specifies the value of the represented point as it is set in the data source.
Specifies the value of the represented point. Differs from the originalValue when the axis' value type differs from the value type in the data source. In this instance, value has the type of the value axis.
Specifies the value of the represented point with applied formatting if the format property is specified (see label).
Specifies the argument value of the represented point as it is set in the data source.
Specifies the argument value of the represented point. Differs from the originalArgument when the axis' argument type differs from the argument type in the data source. In this instance, argument has the type of the argument axis.
Specifies the argument value of the represented point with applied formatting if the argumentFormat property is specified.
- size (for bubble series only)
Specifies the size of the represented bubble as it is set in the data source.
- index (for range area and range bar series only)
Specifies whether the represented point is maximum (index = 1) or minimum (index = 0).
Provides access to the represented point. To learn more about the field and methods of the point object, refer to the Point topic in the "Chart Elements" reference section.
Specifies the series of the represented point.
See the format section for details on accepted values.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
We appreciate your feedback.