JavaScript/jQuery Chart - series.label
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
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 is displayed in the point label. To format the point value, use the format option.
A point label displays only the point value by default. 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.
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.
backgroundColor
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.
customizeText
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. |
size | The size value of the point. For bubble series only. |
index | 0 - if the point is minimum; 1 - if the point is maximum. For range area and range bar series only. |
point | The Point object. |
seriesName | The name of the series to which the point belongs. |
The following fields are inherent to stacked-like series only.
Field | Description |
---|---|
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. |
The following fields are inherent to financial series (candlestick and stock) only.
Field | Description |
---|---|
originalOpenValue | The raw open value of the point. |
openValue | The originalOpenValue after type cast. |
openValueText | The openValue with an applied format and converted to string. |
originalCloseValue | The raw close value of the point. |
closeValue | The originalCloseValue after type cast. |
closeValueText | The closeValue with an applied format and converted to string. |
originalHighValue | The raw high value of the point. |
highValue | The originalHighValue after type cast. |
highValueText | The highValue with an applied format and converted to string. |
originalLowValue | The raw low value of the point. |
lowValue | The originalLowValue after type cast. |
lowValueText | The lowValue with an applied format and converted to string. |
reductionValue | The reduction value. |
reductionValueText | The reductionValue with an applied format and converted to string. |
this
keyword.See Also
format
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.
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
.
showForZeroValues
Specifies whether or not to show labels for points with zero value. Applies only to bar-like series.
If you have technical questions, please create a support ticket in the DevExpress Support Center.