tooltip - API Reference - Kendo UI StockChart

New to Kendo UI for jQuery? Start a free 30-day trial

configuration

The data point tooltip configuration options.

Object

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    tooltip: {
        visible: true
    },
    series: [{
        type: "line",
        data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ]
    }]
});
</script>

tooltip.background

String

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

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    tooltip: {
        visible: true,
        background: "#ff0000"
    },
    series: [{
        type: "line",
        data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ]
    }]
});
</script>

tooltip.border

Object

The border configuration options.

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    tooltip: {
        visible: true,
        border: {
            color: "#ff0000",
            width: 2
        }
    },
    series: [{
        type: "line",
        data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ]
    }]
});
</script>

tooltip.color

String

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

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    tooltip: {
        visible: true,
        color: "#ff0000"
    },
    series: [{
        type: "line",
        data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ]
    }]
});
</script>

tooltip.font

String

The tooltip font.

Default: "12px Arial,Helvetica,sans-serif"

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    tooltip: {
        visible: true,
        font: "16px Arial"
    },
    series: [{
        type: "line",
        data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ]
    }]
});
</script>

tooltip.format

String

The tooltip format.

pseudo

    //sets format of the tooltip
    format: "C"

tooltip.padding

Number|Object

The padding of the tooltip.

pseudo

    // 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 }

tooltip.shared

Boolean

A value indicating if the tooltip should be shared.

Default: false

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    tooltip: {
        visible: true,
        shared: true
    },
    series: [{
        type: "line",
        data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ],
    }, {
        type: "line",
        data: [
            { date: new Date(2023, 0, 4), value: 30 },
            { date: new Date(2023, 0, 5), value: 25 },
            { date: new Date(2023, 0, 6), value: 40 }
        ],
    }]
});
</script>

tooltip.sharedTemplate

String

The shared tooltip template. Template variables:

points - the category points
category - the category name

<div id="chart"></div>
<script>
$("#chart").kendoChart({
     title: {
         text: "Internet Users"
     },
     series: [{
         name: "United States",
         data: [67.96, 68.93, 75, 74, 78]
     }, {
         name: "World",
         data: [15.7, 16.7, 20, 23.5, 26.6]
     }],
     categoryAxis: {
         categories: [2005, 2006, 2007, 2008, 2009]
     },
     tooltip: {
         visible: true,
         shared: true,
         sharedTemplate:
            "#= category # </br>" +
            "# for (var i = 0; i < points.length; i++) { #" +
                "#= points[i].series.name #: #= points[i].value # </br>" +
            "# } #"
     }
});
</script>

tooltip.template

String|Function

The tooltip template. Template variables:

value - the point value
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.

<div id="chart"></div>
<script>
$("#chart").kendoStockChart({
     title: {
         text: "My Chart Title"
     },
     series: [{
         name: "Series 1",
         data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ],
     }],
     categoryAxis: {
         categories: [2000, 2001, 2002, 2003]
     },
     tooltip: {
         visible: true,
         template: "#= category # - #= value #"
     }
});
</script>

tooltip.visible

Boolean

A value indicating if the tooltip should be displayed.

Default: false

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    tooltip: {
        visible: true
    },
    series: [{
        type: "line",
        data: [
            { date: new Date(2023, 0, 1), value: 10 },
            { date: new Date(2023, 0, 2), value: 20 },
            { date: new Date(2023, 0, 3), value: 15 }
        ]
    }]
});
</script>

Related Members