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

ValueAxis.crosshair.tooltip

configuration

The crosshair tooltip configuration options.

valueAxis.crosshair.tooltip

Object

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    dataSource: {
        data: [
            { date: new Date("2023/1/1"), open: 100, high: 110, low: 95, close: 105 },
            { date: new Date("2023/1/2"), open: 105, high: 115, low: 100, close: 110 }
        ]
    },
    dateField: "date",
    valueAxis: {
        crosshair: {
            visible: true,
            tooltip: {
                visible: true,
                color: "white",
                background: "black"
            }
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

valueAxis.crosshair.tooltip.background

String

The background color of the tooltip.

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    dataSource: {
        data: [
            { date: new Date("2023/1/1"), open: 100, high: 110, low: 95, close: 105 },
            { date: new Date("2023/1/2"), open: 105, high: 115, low: 100, close: 110 }
        ]
    },
    dateField: "date",
    valueAxis: {
        crosshair: {
            visible: true,
            tooltip: {
                visible: true,
                background: "lightblue"
            }
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

valueAxis.crosshair.tooltip.border

Object

The border configuration options.

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    dataSource: {
        data: [
            { date: new Date("2023/1/1"), open: 100, high: 110, low: 95, close: 105 },
            { date: new Date("2023/1/2"), open: 105, high: 115, low: 100, close: 110 }
        ]
    },
    dateField: "date",
    valueAxis: {
        crosshair: {
            visible: true,
            tooltip: {
                visible: true,
                border: {
                    color: "red",
                    width: 2
                }
            }
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

valueAxis.crosshair.tooltip.color

String

The text color of the tooltip.

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    dataSource: {
        data: [
            { date: new Date("2023/1/1"), open: 100, high: 110, low: 95, close: 105 },
            { date: new Date("2023/1/2"), open: 105, high: 115, low: 100, close: 110 }
        ]
    },
    dateField: "date",
    valueAxis: {
        crosshair: {
            visible: true,
            tooltip: {
                visible: true,
                color: "white"
            }
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

valueAxis.crosshair.tooltip.font

String

The tooltip font.

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

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    dataSource: {
        data: [
            { date: new Date("2023/1/1"), open: 100, high: 110, low: 95, close: 105 },
            { date: new Date("2023/1/2"), open: 105, high: 115, low: 100, close: 110 }
        ]
    },
    dateField: "date",
    valueAxis: {
        crosshair: {
            visible: true,
            tooltip: {
                visible: true,
                font: "16px Arial"
            }
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

valueAxis.crosshair.tooltip.format

String

The tooltip format.

pseudo

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

valueAxis.crosshair.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 }

valueAxis.crosshair.tooltip.template

String|Function

The tooltip template. Template variables:

value - the point value (either a number or an object)

<div id="chart"></div>
<script>
// chart initialization
$("#chart").kendoChart({
     title: {
         text: "My Chart Title"
     },
     series: [{
             name: "Series 1",
             data: [200, 450, 300, 125]
     }],
     categoryAxis: {
         categories: [2000, 2001, 2002, 2003]
     },
     valueAxis: {
         crosshair: {
             visible: true,
             tooltip: {
                 visible: true,
                 template: "value: #= value #"
             }
         }
     }
});
</script>

valueAxis.crosshair.tooltip.visible

Boolean

A value indicating if the tooltip should be displayed.

Default: false

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    dataSource: {
        data: [
            { date: new Date("2023/1/1"), open: 100, high: 110, low: 95, close: 105 },
            { date: new Date("2023/1/2"), open: 105, high: 115, low: 100, close: 110 }
        ]
    },
    dateField: "date",
    valueAxis: {
        crosshair: {
            visible: true,
            tooltip: {
                visible: true
            }
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

Related Members