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

XAxis.notes.data.label

configuration

The label of the note.

xAxis.notes.data.label

Object

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  xAxis: {
    notes: {
      data: [
        { 
          value: 1, 
          label: {
            text: "Important Point",
            background: "yellow",
            color: "black"
          }
        }
      ]
    }
  },
  series: [
    { type: "line", data: [1, 2, 3, 4] }
  ]
});
</script>

xAxis.notes.data.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: {
        data: [{
          value: 1.3,
          label: {
            text: "avg",
            background: "orange"
          }
        }]
      }
    }
  });
</script>

xAxis.notes.data.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: {
        data: [{
          value: 1.3,
          label: {
            text: "avg",
            border: {
              color: "green",
              dashType: "dashDot",
              width: 1
            }
          }
        }]
      }
    }
  });
</script>

xAxis.notes.data.label.color

String

The text color of the note 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: {
        data: [{
          value: 1.3,
          label: {
            text: "avg",
            color: "#aa00bb"
          }
        }]
      }
    }
  });
</script>

xAxis.notes.data.label.font

String

The font style of the note label.

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

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

xAxis.notes.data.label.format

String

The format used to display the note 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: {
        data: [{
          value: 1.3,
          label: {
            text: "avg",
            format: "val: {0}"
          }
        }]
      }
    }
  });
</script>

xAxis.notes.data.label.position

String

The position of the x axis note label.

"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: {
        data: [{
          value: 1.3,
          label: {
            text: "avg",
            position: "outside"
          }
        }]
      }
    }
  });
</script>

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

xAxis.notes.data.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: {
        data: [{
          value: 1.3,
          label: {
            template: "Avg: #: value #"
          }
        }]
      }
    }
  });
</script>

xAxis.notes.data.label.text

String

The label note text.

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

xAxis.notes.data.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: {
        data: [{
          value: 1.3,
          label: {
            text: "label",
            visible: false
          }
        }]
      }
    }
  });
</script>

Related Members