CategoryAxisItemComponent
The configuration component for a category axis (see example).
Selector
kendo-chart-category-axis-item
Inputs
autoBaseUnitSteps
The time-interval steps when baseUnit
is set either to "fit"
or "auto"
.
The axis will try to divide the active period into the smallest possible units
that yield maxDateGroups
or less discrete intervals.
axisCrossingValue
any
The category index or the date (for date category axis) at which the first value axis crosses this axis. The category indices or the date (for date category axis) at which the value axes cross the category axis (when set as an array). To denote the far end of the axis, set an index greater than or equal to the number of categories.
background
string
The background color of the axis.
baseUnit
The base time interval for the date axis. The default base unit is automatically determined by the minimum difference between subsequent categories.
The supported values are:
"fit"
"milliseconds"
"seconds"
"minutes"
"hours"
"days"
"weeks"
"months"
"years"
Setting baseUnit
to "fit"
sets such a base unit and categoryAxis.baseUnitStep
that the total number of categories does not exceed categoryAxis.maxDateGroups
.
Series data is aggregated for the specified base unit by using the series.aggregate
function.
baseUnitStep
number | "auto"
The step (interval) between the categories in base units. Setting it to "auto"
sets the step to such
a value that the total number of categories does not exceed categoryAxis.maxDateGroups
.
The option is ignored if categoryAxis.baseUnit
is set to "fit"
.
categories
any[]
The category names. The Chart creates a category for every item of the array.
color
string
The color to apply to all axis elements. Accepts a valid CSS color string, including hex and rgb.
Can be overridden by categoryAxis.labels.color
and categoryAxis.line.color
.
crosshair
The configuration options of the crosshair.
The crosshair is displayed when the categoryAxis.crosshair.visible
option is set to true
.
justified
boolean
If set to true
, the Chart positions categories and series points on major ticks.
This removes the empty space before and after the series.
The default value is false
except for "area"
, "verticalArea"
, "rangeArea"
, and "verticalRangeArea"
.
The option is ignored if the series.type
option is set to "bar"
, "column"
, "boxPlot"
, "ohlc"
,
"candlestick"
, or "waterfall"
.
labels
The configuration of the axis labels.
line
The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.
majorGridLines
The configuration of the major grid lines. These are the lines that are an extension of the major ticks through the body of the Chart.
majorTicks
The configuration of the category axis major ticks.
max
any
The last date displayed on a date category axis or the index of the last category displayed on a category axis.
By default, the max value is the same as the last category.
This is often used in combination with the categoryAxis.min
and
categoryAxis.roundToBaseUnit
options to set up a fixed date range.
maxDateGroups
number
The maximum number of groups (categories) to display when
categoryAxis.baseUnit
is set to "fit"
or
categoryAxis.baseUnitStep
is set to "auto"
.
maxDivisions
number
The maximum number of ticks and labels to display. Applicable for date category axis.
min
any
The first date which is displayed on a date category axis or the index of the first category which is displayed on a category axis.
By default, the min value is the same as the first category.
This is often used in combination with the categoryAxis.max
and
categoryAxis.roundToBaseUnit
options to set up a fixed date range.
minorGridLines
The configuration of the minor grid lines. These are the lines that are an extension of the minor ticks through the body of the Chart.
minorTicks
The configuration of the category axis minor ticks.
name
string
The unique axis name. Used to associate a series with a category axis,
which utilizes the series.categoryAxis
option.
notes
The configuration of the category axis notes.
pane
string
The name of the pane in which the category axis has to be rendered. If not set, the axis will be rendered in the first (default) pane.
plotBands
PlotBand[]
The plot bands of the category axis.
rangeLabels
The configuration of the date axis date range labels.
reverse
boolean
If set to true
, the category axis direction is reversed.
By default, categories are listed from left to right and from bottom to top.
roundToBaseUnit
boolean
If set to true
, the Chart rounds the first and last date to the nearest base unit.
select
The selected axis range. If set, the axis selection is enabled.
The range is index-based, starting from zero.
Categories with indexes in the range (select.from
, select.to
) will be selected.
That is, the last category in the range will not be included in the selection.
If the categories are dates, the range has to be also specified with date values.
Selection is only supported if the axis is horizontal.
startAngle
number
The angle (degrees) of the first category on the axis. Angles increase clockwise with zero to the left. Negative values are acceptable.
title
The title configuration of the category axis.
To display the title, set the categoryAxis.title.text
option.
type
"category" | "date"
The category axis type.
The supported values are:
"category"
—Discrete category axis."date"
—Specialized axis for displaying chronological data.
visible
boolean
If set to true
, the Chart displays the category axis. By default, the category axis is visible.
weekStartDay
The week start day when the baseUnit
is set to "weeks"
.
Methods
notifyChanges
Updates the component fields with the specified values and refreshes the Chart.
Use this method when the configuration values cannot be set through the template.
item.notifyChanges({ visible: true });
Parameters
changes
any
An object containing the updated input fields.