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

ValueAxis.notes.label

configuration

The label of the notes.

valueAxis.notes.label

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: {
        notes: {
            data: [{
                value: 105,
                label: {
                    text: "Important level",
                    background: "yellow",
                    color: "black",
                    visible: true
                }
            }]
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

valueAxis.notes.label.background

String

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

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        background: "red"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

valueAxis.notes.label.border

Object

The border of the label.

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        border: {
          color: "green",
          dashType: "dashDot",
          width: 1
        }
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

valueAxis.notes.label.color

String

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

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        color: "#aa00bb"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

valueAxis.notes.label.font

String

The font style of the label.

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

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        font: "20px sans-serif"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

valueAxis.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="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        format: "value slot: {0}"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

valueAxis.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({
    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: {
        notes: {
            data: [{
                value: 105,
                label: {
                    text: "Important level",
                    position: "outside"
                }
            }]
        }
    },
    series: [{
        type: "candlestick",
        openField: "open",
        highField: "high",
        lowField: "low",
        closeField: "close"
    }]
});
</script>

valueAxis.notes.label.rotation

Number

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

Default: 0

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        rotation: 90
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

valueAxis.notes.label.template

String|Function

The template which renders the labels.

The fields which can be used in the template are:

value - the value value

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        template: "Year: #: value #"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

valueAxis.notes.label.visible

Boolean

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

Default: true

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  valueAxis: {
    notes: {
      label: {
        visible: false
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

Related Members