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

AxisDefaults.labels

configuration

The axis labels configuration.

axisDefaults.labels

Object

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      font: "16px Arial",
      color: "blue"
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

axisDefaults.labels.font

String

The font style of the labels. Accepts a valid CSS color string, for example "20px 'Courier New'".

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

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      font: "20px 'Courier New'"
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

axisDefaults.labels.format

String

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

Default: "{0}"

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      format: "Value: {0:N0}"
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

axisDefaults.labels.margin

Number|Object

The margin of the labels. A numeric value will set all margins.

Default: 0

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      margin: 5
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

axisDefaults.labels.mirror

Boolean

If set to true the chart will mirror the axis labels and ticks. If the labels are normally on the left side of the axis, mirroring the axis will render them to the right.

Default: false

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      mirror: true
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

axisDefaults.labels.padding

Object|Number

The padding of the labels. A numeric value will set all paddings.

Default: 0

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      padding: 10
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

The rotation angle of the labels. By default the labels are not rotated. Can be set to "auto" if the axis is horizontal in which case the labels will be rotated only if the slot size is not sufficient for the entire labels.

Default: 0

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      rotation: 45
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

axisDefaults.labels.skip

Number

The number of labels to skip. By default no labels are skipped.

Default: 0

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      skip: 2
    }
  },
  series: [
    { data: [1, 2, 3, 4, 5, 6] }
  ]
});
</script>

axisDefaults.labels.step

Number

The label rendering step - render every n-th label. By default every label is rendered.

Default: 1

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      step: 2
    }
  },
  series: [
    { data: [1, 2, 3, 4, 5, 6] }
  ]
});
</script>

axisDefaults.labels.template

String|Function

The template which renders the labels.

The fields which can be used in the template are:

value - the category value
dataItem - the data item, in case a field has been specified. If the category does not have a corresponding item in the data then an empty object will be passed.
format - the default format of the label
culture - the default culture (if set) on the label

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

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    categories: ["2011", "2012", "2013"],
    labels: {
      template: "Value: #: value #"
    },
  },
  series: [{
    data: [1, 2, 3]
  }]
});
</script>

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    categories: ["2011", "2012", "2013"],
    labels: {
      template: kendo.template("Value: #: value #")
    },
  },
  series: [{
    data: [1, 2, 3]
  }]
});
</script>

axisDefaults.labels.visible

Boolean

If set to true the chart will display the axis labels. By default the axis labels are visible.

Default: true

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

axisDefaults.labels.visual

Function

A function that can be used to create a custom visual for the labels. The available argument fields are:

createVisual - a function that can be used to get the default visual.
culture - the default culture (if set) on the label
dataItem - the data item, in case a field has been specified
format - the default format of the label
options - the label options.
rect - the kendo.geometry.Rect that defines where the visual should be rendered.
sender - the chart instance (may be undefined).
text - the label text.
value - the category value

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  axisDefaults: {
    labels: {
      visual: function(e) {
        var rect = new kendo.geometry.Rect(e.rect.origin, [e.rect.size.width, e.rect.size.height]);
        var layout = new kendo.drawing.Layout(rect, {
          orientation: "vertical",
          alignContent: "center"
        });
        var text = new kendo.drawing.Text(e.text, e.rect.center(), {
          fill: {
            color: "#aa0000"
          }
        });
        layout.append(text);
        return layout;
      }
    }
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

Related Members