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

YAxis.notes.label

configuration

The label configuration of the notes.

yAxis.notes.label

Object

<div id="chart"></div>
<script>
$("#chart").kendoChart({
    series: [{
        data: [1, 2, 3]
    }],
    yAxis: {
        notes: {
            data: [{
                value: 2
            }],
            label: {
                background: "yellow",
                color: "black",
                font: "12px Arial"
            }
        }
    }
});
</script>

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

yAxis.notes.label.border

Object

The border of the label.

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

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

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

yAxis.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]]
  }],
  yAxis: {
    notes: {
      label: {
        format: "value slot: {0}"
      },
      data: [{ value: 1 }]
    }
  }
});
</script>

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

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

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

yAxis.notes.label.visible

Boolean

If set to true the chart will display the y axis notes label. By default the y axis notes label is visible.

Default: true

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

Related Members