React PolarChart - commonSeriesSettings.label

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.

See Also

• 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

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.

Use this object to make the borders of point labels visible/invisible and set up border options such as color and width.

A series point label can be placed separately, near the represented point. To make the relationship between a label and its respective point clear, use a connector. Set the connector's visibility and appearance options using the connector object.

The function's parameter has the following fields:

• originalValue
  Specifies the value of the currently represented point as it is set in the data source.
• value
  Specifies the value of the currently 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.
• valueText
  Specifies the value of the currently represented point with applied formatting if the format property is specified (see label).
• originalArgument
  Specifies the argument value of the currently represented point as it is set in the data source.
• argument
  Specifies the argument value of the currently 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.
• argumentText
  Specifies the argument value of the currently represented point with applied formatting if the argumentFormat property is specified.
• size (for bubble series only)
  Specifies the size of the currently represented bubble as it is set in the data source.
• index (for range area and range bar series only)
  Specifies whether the currently represented point is maximum (index = 1) or minimum (index = 0).
• point
  Provides access to the currently 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.
• seriesName
  Specifies the series of the currently represented point.

See Also

• Data Formatting

See the format section for details on accepted values.

See Also

• Data Formatting

Use the RelativePosition enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Inside and Outside.