label

An object defining the label configuration options.

Type: Object

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.

alignment

Specifies how to align point labels relative to the corresponding data points that they represent.

Type: String
Default Value: 'center'
Accepted Values: 'left' | 'center' | 'right'

argumentFormat

Specifies a format for arguments displayed by point labels.

Type: String
Default Value: ''

Use this property to set a format for arguments when you are going to display them in point labels. For a listing of acceptable formats, refer to the format property. To learn how to set a custom text for labels so that they include an argument value of the currently represented point, refer to the customizeText property.

For general information on data formatting, refer to the Data Formatting topic.

argumentPrecision

Specifies a precision for formatted point arguments displayed in point labels.

Type: Number
Default Value: 0

This property's value must be an integer that indicates how many digits to show in the argument displayed in point labels. This property value is considered when labels display arguments in one of the following numeric formats: 'fixedPoint', 'exponential', 'currency', 'percent'. To learn how to set a format for arguments, refer to the argumentFormat property description. To learn how to set a custom text for point labels so that they include an argument value of the currently represented point, refer to the customizeText property description.

For general information on data formatting, refer to the Data Formatting topic.

backgroundColor

Specifies a background color for point labels.

Type: String
Default Value: undefined

Labels are painted in the color of the series whose points they represent by default. You can set a custom background color. For this purpose, use the backgroundColor property of the label object.

border

Specifies border options for point labels.

Type: Object

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

connector

Specifies connector options for series point labels.

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.

customizeText

Specifies a callback function that returns the text to be displayed by point labels.

Type: function(pointInfo)
Function parameters:
pointInfo: Object

Defines the point value to be displayed in a label.

Return Value: String

The text to be displayed in a label.

Cannot be used in themes.

When implementing a callback function for this property, use the point value to be displayed in a label. In addition, you can use the argument of the currently displayed value. These values can be accessed using the following properties of the this object.

  • 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 and precision (optional) properties are 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 and argumentPrecision (optional) properties are 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.

The following fields come with the stacked-like series such as stacked bar or full-stacked area.

  • percent
    Specifies the percent value of the currently represented point.
  • percentText
    Specifies the percent value of the currently represented point with the 'percent' format and percentPrecision (optional) applied.
  • total
    Specifies the total value of all the points with the same argument as the currently represented point.
  • totalText
    Specifies the total value of all the points with the same argument as the currently represented point. This value is displayed with applied formatting if the format and precision (optional) properties are specified.

The following fields come with financial chart series such as candle stick or stock.

  • originalOpenValue
    Specifies the open value of the currently represented point as it is set in the data source.
  • openValue
    Specifies the open value of the currently represented point. Differs from the originalOpenValue when the value in the data source is not in a numeric format.
  • openValueText
    Specifies the open value of the currently represented point with applied formatting if the format and precision (optional) properties are specified.
  • originalCloseValue
    Specifies the close value of the currently represented point as it is set in the data source.
  • closeValue
    Specifies the close value of the currently represented point. Differs from the originalCloseValue when the value in the data source is not in a numeric format.
  • closeValueText
    Specifies the close value of the currently represented point with applied formatting if the format and precision (optional) properties are specified.
  • originalHighValue
    Specifies the high value of the currently represented point as it is set in the data source.
  • highValue
    Specifies the high value of the currently represented point. Differs from the originalHighValue when the value in the data source is not in a numeric format.
  • highValueText
    Specifies the high value of the currently represented point with applied formatting if the format and precision (optional) properties are specified.
  • originalLowValue
    Specifies the low value of the currently represented point as it is set in the data source.
  • lowValue
    Specifies the low value of the currently represented point. Differs from the originalLowValue when the value in the data source is not in a numeric format.
  • lowValueText
    Specifies the low value of the currently represented point with applied formatting if the format and precision (optional) properties are specified.
  • reductionValue
    Specifies the reduction value of the currently represented point.
  • reductionValueText
    Specifies the reduction value of the currently represented point with applied formatting if the format and precision (optional) properties are specified.

The function's parameter represents the same object as the this object. If appropriate, you can use the function's parameter to obtain the value that is currently represented by a label.

To get general information on data formatting, refer to the Data Formatting topic.

font

Specifies font options for the text displayed in point labels.

Type: Object

format

Specifies a format for the text displayed by point labels.

Type: String
Default Value: ''
Accepted Values: 'currency' | 'fixedPoint' | 'percent' | 'decimal' | 'exponential' | 'largeNumber' | 'thousands' | 'millions' | 'billions' | 'trillions' | 'longDate' | 'longTime' | 'monthAndDay' | 'monthAndYear' | 'quarterAndYear' | 'shortDate' | 'shortTime' | 'millisecond' | 'day' | 'month' | 'quarter' | 'year'

A point label displays the value(s) of the point that the label represents. You can apply formatting to this value by using one of the available formats.

NOTE
You can set a precision for a label value when the 'fixedPoint', 'exponential', 'currency' or 'percent' format is applied. Use the precision and argumentPrecision properties to do this.

For details on formatting, refer to the Data Formatting topic.

horizontalOffset

Specifies how to shift point labels horizontally from their initial positions.

Type: Number
Default Value: 0

percentPrecision

Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series.

Type: Number
Default Value: 0
This member is exposed by the following entities:

The property's value must be an integer indicating the number of digits to show in the percentage values displayed in labels. To learn how to set custom text for labels so that they include a percentage value for the point that is currently represented, refer to the customizeText property description.

For general information on data formatting, refer to the Data Formatting topic.

position

Specifies a label position in a bubble, range-like or bar-like series.

Type: String
Default Value: 'outside'
Accepted Values: 'outside' | 'inside'
NOTE
The default value for the FullStackedBarSeries and StackedBarSeries is 'inside'.

precision

Specifies a precision for formatted point values displayed in point labels.

Type: Number
Default Value: 0

This property's value must be an integer indicating the number of digits to show in the value displayed in point labels. This property value is considered when labels display values in one of the following numeric formats: 'fixedPoint', 'exponential', 'currency' or 'percent'. To learn how to set a format for point values, refer to the format property description.

For general information on data formatting, refer to the Data Formatting topic.

rotationAngle

Specifies the angle used to rotate point labels from their initial position.

Type: Number
Default Value: 0

showForZeroValues

Specifies whether or not to show a label when the point has a zero value.

Type: Boolean
Default Value: true
This member is exposed by the following entities:

verticalOffset

Specifies how to shift point labels vertically from their initial positions.

Type: Number
Default Value: 0

visible

Specifies the visibility of point labels.

Type: Boolean
Default Value: false