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

Series.notes.label

configuration

The label of the notes.

series.notes.label

Object

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    position: "top"
                }
            }]
        }
    }]
});
</script>

series.notes.label.background

String

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

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    background: "#ff0000"
                }
            }]
        }
    }]
});
</script>

series.notes.label.border

Object

The border of the label.

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    border: {
                        color: "#ff0000",
                        width: 2
                    }
                }
            }]
        }
    }]
});
</script>

series.notes.label.color

String

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

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    color: "#ff0000"
                }
            }]
        }
    }]
});
</script>

series.notes.label.font

String

The font style of the label.

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

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    font: "16px Arial"
                }
            }]
        }
    }]
});
</script>

series.notes.label.format

String

The format used to display the notes label. Uses kendo.format. Contains one placeholder ("{0}") which represents the axis value.

Default: "{0}"

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    format: "Value: {0}"
                }
            }]
        }
    }]
});
</script>

series.notes.label.position

String

The position of the labels.

"inside" - the label is positioned inside of the icon.
"outside" - the label is positioned outside of the icon.

Default: "inside"

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    position: "outside"
                }
            }]
        }
    }]
});
</script>

series.notes.label.rotation

Number

The rotation angle of the label. By default the label are not rotated.

Default: 0

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    rotation: 45
                }
            }]
        }
    }]
});
</script>

series.notes.label.template

String|Function

The template which renders the labels.

The fields which can be used in the template are:

value - the point value

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    template: (data) => `Note: ${data.value}`
                }
            }]
        }
    }]
});
</script>

series.notes.label.visible

Boolean

If set to true the chart will display the series notes label. By default the series notes label are visible.

Default: true

<div id="stock-chart"></div>
<script>
$("#stock-chart").kendoStockChart({
    series: [{
        type: "candlestick",
        data: [[new Date(2023, 0, 1), 100, 110, 95, 105]],
        notes: {
            data: [{
                value: new Date(2023, 0, 1),
                label: {
                    text: "Important note",
                    visible: false
                }
            }]
        }
    }]
});
</script>

Related Members