label
Configures point labels.
Declared in commonSeriesSettings, the label settings apply to all point labels in the chart. Declared in a series configuration object, the label settings apply only to the point labels that belong to this particular series. The series-specific label settings override the common ones.
See Also
- customizeLabel - сustomizes the appearance of an individual point label.
alignment
Aligns point labels in relation to their points.
When using the widget as an ASP.NET MVC Control, specify this option using the HorizontalAlignment enum. This enum accepts the following values: Left, Center and Right.
argumentFormat
Formats the point argument before it will be displayed in the point label.
Be default, a point label displays only the point value. Using the label.customizeText option, you can instruct the label to display the point argument as well. The argumentFormat option applies in this case only.
This option accepts an object whose fields are described in the format section. However, there is one more field available called argumentPrecision. This field accepts a number specifying how many digits after the decimal point to save in a value of a numeric format. See an example in the following code.
// 12.3456 --> 12.34
argumentFormat: {
type: "fixedPoint",
argumentPrecision: 2
}See Also
- format - provides a comprehensive overview of formatting capabilities.
- Data Formatting - shows how to apply formatting to various widget elements.
argumentPrecision
Use the series.label.argumentFormat.precision instead.
Specifies a precision for formatted point arguments displayed in point labels.
backgroundColor
Colors the background of point labels. By default, point labels inherit the color from their points.
connector
Configures the label connectors.
A point label is always displayed near its series point, though the label is placed separately. To make the relationship between the series point and its label evident, use a connector.
By default, label connectors are hidden. To make them visible, set the connector.visible option to true.
customizeText
Customizes the text displayed by point labels.
Information defining the series point.
The text to be displayed in the point label.
This option accepts a function whose parameter exposes the following fields.
| Field | Description |
|---|---|
| originalValue | The raw value of the point. |
| value | The originalValue after type cast. |
| valueText | The value with an applied format and converted to string. |
| originalArgument | The raw argument of the point. |
| argument | The originalArgument after type cast. |
| argumentText | The argument with an applied format and converted to string. |
| percent | The percentage value of the point. |
| percentText | The percent with an applied format and converted to string. |
| total | The sum of all values in the stack. |
| totalText | The total with an applied format and converted to string. |
| point | The Point object. |
| seriesName | The name of the series to which the point belongs. |
See Also
- Data Formatting - shows how to apply formatting to various widget elements.
format
Formats the point value before it will be displayed in the point label.
This option accepts an object whose fields are described in the format section. However, there is one more field, called percentPrecision, which is available only to full-stacked-like series, where one point always has an absolute and a percentage value. The percentPrecision field specifies how many digits after the decimal point to save in the percentage value. See an example in the following code.
format: {
type: "fixedPoint", // the format of absolute values
precision: 1, // the precision of absolute values (123.456 --> 123.4)
percentPrecision: 2 // the precision of percentage values (12.3456 % --> 12.34 %)
}See Also
- format - provides a comprehensive overview of formatting capabilities.
- Data Formatting - shows how to apply formatting to various widget elements.
horizontalOffset
Along with verticalOffset, shifts point labels from their initial positions.
The number assigned to this option specifies the shift in pixels. A negative number shifts the point labels to the left, a positive number - to the right.
percentPrecision
Use the series.label.format.percentPrecision instead.
Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series.
position
Specifies whether to display point labels inside or outside of series points. Applies only to bubble, range-like and bar-like series.
When using the widget as an ASP.NET MVC Control, specify this option using the RelativePosition enum. This enum accepts the following values: Inside and Outside.
precision
Use the series.label.format.precision option instead.
Specifies a precision for formatted point values displayed in point labels.
showForZeroValues
Specifies whether or not to show labels for points with zero value. Applies only to bar-like series.
verticalOffset
Along with horizontalOffset, shifts point labels from their initial positions.
The number assigned to this option specifies the shift in pixels. A negative number shifts the point labels up, a positive number shifts them down.