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

XAxis.notes.label

configuration

The label of the notes.

xAxis.notes.label

Object

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  xAxis: {
    notes: {
      label: {
        background: "lightgreen",
        color: "black",
        font: "bold 12px Arial"
      },
      data: [{
        value: 2,
        text: "Styled label"
      }]
    }
  },
  series: [
    { type: "scatter", data: [[1, 2], [2, 3], [3, 4]] }
  ]
});
</script>

xAxis.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: [{
      type: "scatter",
      data: [[1, 2], [2, 3]]
    }],
    xAxis: {
      notes: {
        label: {
          background: "red"
        },
        data: [{ value: 1.3 }]
      }
    }
  });
</script>

xAxis.notes.label.border

Object

The border of the label.

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

xAxis.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: [{
      type: "scatter",
      data: [[1, 2], [2, 3]]
    }],
    xAxis: {
      notes: {
        label: {
          text: "label",
          color: "#aa00bb"
        },
        data: [{ value: 1.3 }]
      }
    }
  });
</script>

xAxis.notes.label.font

String

The font style of the label.

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

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

xAxis.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: [{
      type: "scatter",
      data: [[1, 2], [2, 3]]
    }],
    xAxis: {
      notes: {
        label: {
          text: "avg",
          format: "val: {0}"
        },
        data: [{ value: 1.3 }]
      }
    }
  });
</script>

xAxis.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({
    series: [{
      type: "scatter",
      data: [[1, 2], [2, 3]]
    }],
    xAxis: {
      notes: {
        label: {
          text: "avg",
          position: "outside"
        },
        data: [{ value: 1.3 }]
      }
    }
  });
</script>

xAxis.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: [{
      type: "scatter",
      data: [[1, 2], [2, 3]]
    }],
    xAxis: {
      notes: {
        label: {
          text: "label",
          rotation: 90
        },
        data: [{ value: 1.3 }]
      }
    }
  });
</script>

xAxis.notes.label.template

String|Function

The template which renders the labels.

The fields which can be used in the template are:

value - the axis value

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

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

xAxis.notes.label.visible

Boolean

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

Default: true

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

Related Members