Edit this page

series.labels.to Object

The chart series to label configuration.

The chart displays the series to labels when the series.labels.visible option is set to true or when the series.labels.to.visible option is set to true.

series.labels.to.background String |Function

The background color of the to labels. Accepts a valid CSS color string, including hex and rgb.

series.labels.to.border Object

The border of the to labels.

series.labels.to.border.color String |Function (default: "black")

The color of the border. Accepts a valid CSS color string, including hex and rgb.

series.labels.to.border.dashType String |Function (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

series.labels.to.border.width Number |Function (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.

series.labels.to.color String |Function

The text color of the to labels. Accepts a valid CSS color string, including hex and rgb.

series.labels.to.font String |Function (default: "12px Arial,Helvetica,sans-serif")

The font style of the to labels.

series.labels.to.format String |Function (default: "{0}")

The format of the to labels. Uses kendo.format.

series.labels.to.margin Number |Object (default: 5)

The margin of the to labels. A numeric value will set all margins.

series.labels.to.margin.bottom Number (default: 0)

The bottom margin of the to labels.

series.labels.to.margin.left Number (default: 0)

The left margin of the to labels.

series.labels.to.margin.right Number (default: 0)

The right margin of the to labels.

series.labels.to.margin.top Number (default: 0)

The top margin of the to labels.

series.labels.to.padding Number |Object (default: 0)

The padding of the to labels. A numeric value will set all paddings.

series.labels.to.padding.bottom Number (default: 0)

The bottom padding of the to labels.

series.labels.to.padding.left Number (default: 0)

The left padding of the to labels.

series.labels.to.padding.right Number (default: 0)

The right padding of the to labels.

series.labels.to.padding.top Number (default: 0)

The top padding of the to labels.

series.labels.to.position String |Function

The position of the to labels.

  • "center" - the label is positioned at the point center.
  • "insideBase" - the label is positioned inside, near the base of the bar.
  • "insideEnd" - the label is positioned inside, near the end of the point.
  • "outsideEnd" - the label is positioned outside, near the end of the point.
  • "above" - the label is positioned at the top of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.
  • "below" - the label is positioned at the bottom of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.
  • "left" - the label is positioned to the left of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.
  • "right" - the label is positioned to the right of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.

series.labels.to.template String |Function

The template which renders the chart series to label.

The fields which can be used in the template are:

  • category - the category name.
  • dataItem - the original data item used to construct the point. Will be null if binding to array.
  • series - the data series
  • value - the point value. An object containing from and to values.

The text can be split into multiple lines by using line feed characters ("\n").

series.labels.to.visible Boolean |Function (default: false)

If set to true the chart will display the series to labels. By default chart series to labels are not displayed.

Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy