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

CategoryAxis.notes.label

configuration

The label of the notes.

categoryAxis.notes.label

Object

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  categoryAxis: {
    categories: ["Q1", "Q2", "Q3", "Q4"],
    notes: {
      label: {
        background: "lightblue",
        color: "darkblue",
        font: "14px Arial",
        template: (data) => `Value: ${data.value}`,
        visible: true,
        position: "outside"
      },
      data: [{ value: "Q2" }]
    }
  },
  series: [
    { data: [1, 2, 3, 4] }
  ]
});
</script>

categoryAxis.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]
  }],
  categoryAxis: {
    notes: {
      label: {
        background: "red"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

categoryAxis.notes.label.border

Object

The border of the label.

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

categoryAxis.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]
  }],
  categoryAxis: {
    notes: {
      label: {
        color: "#aa00bb"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

categoryAxis.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]
  }],
  categoryAxis: {
    notes: {
      label: {
        font: "20px sans-serif"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

categoryAxis.notes.label.format

String

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

Default: "{0}"

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  series: [{
    data: [1, 2, 3]
  }],
  categoryAxis: {
    notes: {
      label: {
        format: "Category slot: {0}"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

categoryAxis.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="chart"></div>
<script>
$("#chart").kendoChart({
  categoryAxis: {
    categories: ["Q1", "Q2", "Q3", "Q4"],
    notes: {
      label: {
        position: "outside",
        text: "Note",
        background: "yellow"
      },
      data: [{ value: "Q2" }]
    }
  },
  series: [
    { data: [1, 2, 3, 4] }
  ]
});
</script>

categoryAxis.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]
  }],
  categoryAxis: {
    notes: {
      label: {
        rotation: 90
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

categoryAxis.notes.label.template

String|Function

The template which renders the labels.

The fields which can be used in the template are:

value - the category value

The text can be split into multiple lines by using line feed characters ("\n").

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

categoryAxis.notes.label.visible

Boolean

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

Default: true

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

Related Members