categoryAxis.labelsObject
Configures the axis labels.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
visible: true,
color: "#ff0000",
font: "12px Arial"
}
}
});
</script>categoryAxis.labels.backgroundString
The background color of the labels. Any valid CSS color string will work here, including hex and rgb.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
background: "#ffe0e0"
}
}
});
</script>categoryAxis.labels.borderObject
The border of the labels.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
border: {
color: "#ff0000",
width: 2,
dashType: "dash"
}
}
}
});
</script>categoryAxis.labels.border.colorString(default: "black")
The color of the border. Any valid CSS color string will work here, including hex and rgb.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
border: {
color: "#00ff00"
}
}
}
});
</script>categoryAxis.labels.border.dashTypeString(default: "solid")
The dash type of the border.
"solid"
Specifies a solid line.
"dot"
Specifies a line consisting of dots.
"dash"
Specifies a line consisting of dashes.
"longDash"
Specifies a line consisting of a repeating pattern of long-dash.
"dashDot"
Specifies a line consisting of a repeating pattern of dash-dot.
"longDashDot"
Specifies a line consisting of a repeating pattern of long-dash-dot.
"longDashDotDot"
Specifies a line consisting of a repeating pattern of long-dash-dot-dot.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
border: {
dashType: "dash"
}
}
}
});
</script>categoryAxis.labels.border.widthNumber(default: 0)
The width of the border.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
border: {
width: 2
}
}
}
});
</script>categoryAxis.labels.colorString
The text color of the labels. Any valid CSS color string will work here, including hex and rgb.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
color: "#0000ff"
}
}
});
</script>categoryAxis.labels.fontString(default: "12px Arial,Helvetica,sans-serif")
The font style of the labels.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
font: "16px Verdana"
}
}
});
</script>categoryAxis.labels.formatString
The format of the labels.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
format: "{0:N2}"
}
}
});
</script>categoryAxis.labels.marginNumber | Object(default: 0)
The margin of the labels.
Example
// sets the top, right, bottom and left margin to 3px.
margin: 3
// sets the top and left margin to 1px
// margin right and bottom are with 0px (by default)
margin: { top: 1, left: 1 }categoryAxis.labels.mirrorBoolean
Mirrors 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.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
mirror: true
}
}
});
</script>categoryAxis.labels.paddingNumber | Object(default: 0)
The padding of the labels.
Example
// sets the top, right, bottom and left padding to 3px.
padding: 3
// sets the top and left padding to 1px
// padding right and bottom are with 0px (by default)
padding: { top: 1, left: 1 }categoryAxis.labels.rotationNumber(default: 0)
The rotation angle of the labels.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
rotation: 45
}
}
});
</script>categoryAxis.labels.skipNumber(default: 1)
Number of labels to skip. Skips rendering the first n labels.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
skip: 2
}
}
});
</script>categoryAxis.labels.stepNumber(default: 1)
Label rendering step. Every n-th label is rendered where n is the step
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
step: 2
}
}
});
</script>categoryAxis.labels.templateString | 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
- index - the 0-based index of the current label
- count - the total number of labels on the axis
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
template: (data) => `Category: ${data.value}`
}
}
});
</script>categoryAxis.labels.visibleBoolean(default: true)
The visibility of the labels.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
data: [1, 2, 3, 4, 5],
categoryAxis: {
labels: {
visible: false
}
}
});
</script>categoryAxis.labels.cultureString
Culture to use for formatting the dates. See Globalization for more information. It uses the global culture by default.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
categoryAxis: {
type: "date",
labels: {
culture: "de-DE"
},
categories: [
new Date("2023/01/01"),
new Date("2023/02/01"),
new Date("2023/03/01")
]
},
series: [{
data: [10, 15, 8]
}]
});
</script>categoryAxis.labels.dateFormatsObject
Date format strings
"hours"
"HH:mm"
"days"
"M/d"
"weeks"
"M/d"
"months"
"MMM 'yy"
"years"
"yyyy"
The Chart will choose the appropriate format for the current baseUnit.
Setting the labelsformatoption will override these defaults.
Example
<div id="sparkline"></div>
<script>
$("#sparkline").kendoSparkline({
categoryAxis: {
type: "date",
baseUnit: "months",
labels: {
dateFormats: {
months: "MMM yyyy"
}
},
categories: [
new Date("2023/01/01"),
new Date("2023/02/01"),
new Date("2023/03/01")
]
},
series: [{
data: [10, 15, 8]
}]
});
</script>