seriesDefaults.labels.toObject
The chart series to label configuration.
The chart displays the series labels when the seriesDefaults.labels.visible option is set to
true
or when the seriesDefaults.labels.to.visible option is set totrue
.
seriesDefaults.labels.to.backgroundString
The background color of the to labels. Accepts a valid CSS color string, including hex and rgb.
seriesDefaults.labels.to.borderObject
The border of the to labels.
seriesDefaults.labels.to.border.colorString
(default: "black")
The color of the border. Accepts a valid CSS color string, including hex and rgb.
seriesDefaults.labels.to.border.dashTypeString
(default: "solid")
The dash type of the border.
The following dash types are supported:
- "dash" - a line consisting of dashes
- "dashDot" - a line consisting of a repeating pattern of dash-dot
- "dot" - a line consisting of dots
- "longDash" - a line consisting of a repeating pattern of long-dash
- "longDashDot" - a line consisting of a repeating pattern of long-dash-dot
- "longDashDotDot" - a line consisting of a repeating pattern of long-dash-dot-dot
- "solid" - a solid line
seriesDefaults.labels.to.border.widthNumber
(default: 0)
The width of the border in pixels. By default the border width is set to zero which means that the border will not appear.
seriesDefaults.labels.to.colorString
The text color of the to labels. Accepts a valid CSS color string, including hex and rgb.
seriesDefaults.labels.to.fontString
(default: "12px Arial,Helvetica,sans-serif")
The font style of the to labels.
seriesDefaults.labels.to.formatString
(default: "{0}")
The format of the to labels. Uses kendo.format.
seriesDefaults.labels.to.marginNumber|Object
(default: 0)
The margin of the to labels. A numeric value will set all margins.
seriesDefaults.labels.to.margin.bottomNumber
(default: 0)
The bottom margin of the to labels.
seriesDefaults.labels.to.margin.leftNumber
(default: 0)
The left margin of the to labels.
seriesDefaults.labels.to.margin.rightNumber
(default: 0)
The right margin of the to labels.
seriesDefaults.labels.to.margin.topNumber
(default: 0)
The top margin of the to labels.
seriesDefaults.labels.to.paddingNumber|Object
(default: 0)
The padding of the to labels. A numeric value will set all paddings.
seriesDefaults.labels.to.padding.bottomNumber
(default: 0)
The bottom padding of the to labels.
seriesDefaults.labels.to.padding.leftNumber
(default: 0)
The left padding of the to labels.
seriesDefaults.labels.to.padding.rightNumber
(default: 0)
The right padding of the to labels.
seriesDefaults.labels.to.padding.topNumber
(default: 0)
The top padding of the to labels.
seriesDefaults.labels.to.templateString|Function
The template which renders the chart series to label.
The fields which can be used in the template are:
- category - the category name. Available for area, bar, column, bubble, donut, funnel, pyramid, line and pie series.
- dataItem - the original data item used to construct the point. Will be null if binding to array.
- percentage - the point value represented as a percentage value. Available for donut, funnel, pyramid and pie series.
- series - the data series
- value - the point value. Can be a number or object containing each bound field.
- runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series.
- total - the sum of all previous series values. Available for waterfall series.
The text can be split into multiple lines by using line feed characters ("\n").
seriesDefaults.labels.to.visibleBoolean
(default: false)
If set to true
the chart will display the series to labels. By default chart series to labels are not displayed.