series.tooltip Object

The data point tooltip configuration options.

series.tooltip.background String

The background color of the tooltip. The default is determined from the series color.

series.tooltip.border Object

The border configuration options.

series.tooltip.border.color String(default: "black")

The color of the border.

series.tooltip.border.width Number(default: 0)

The width of the border.

series.tooltip.color String

The text color of the tooltip. The default is the same as the series labels color.

series.tooltip.font String(default: "12px Arial,Helvetica,sans-serif")

The tooltip font.

series.tooltip.format String

The tooltip format. Format variables depend on the series type:

  • Area, column, line and pie
  • 0 - value

  • Candlestick and OHLC

  • 0 - open value
  • 1 - high value
  • 2 - low value
  • 3 - close value
  • 4 - category name

Example

    //sets format of the tooltip
    format: "{0:C}--{1:C}"

series.tooltip.padding Number|Object

The padding of the tooltip.

Example

    // sets the top, right, bottom and left padding to 3px.
    padding: 3


    // sets the top and left padding to 1px
    // right and bottom padding are left at their default values
    padding: { top: 1, left: 1 }

series.tooltip.template String|Function

The tooltip template. Template variables:

  • value - the point value (either a number or an object)
  • category - the category name
  • series - the data series
  • dataItem - the original data item used to construct the point. Will be null if binding to array.

Example

    $("#chart").kendoChart({
         title: {
             text: "My Chart Title"
         },
         series: [
             {
                 type: "area",
                 name: "Series 1",
                 data: [200, 450, 300, 125],
                 tooltip: {
                     visible: true,
                     template: "#= category # - #= value #"
                 }
             }
         ],
         categoryAxis: {
             categories: [2000, 2001, 2002, 2003]
         }
    });

series.tooltip.visible Boolean(default: false)

A value indicating if the tooltip should be displayed.

In this article
Not finding the help you need?