Charts / API / ChartYAxisItemProps
material theme

ChartYAxisItemProps

Represents the props of the KendoReact ChartYAxisItem component (see example).

axisCrossingValue? any | any[]

  • (Only for objects) The value at which the Y axis crosses this axis.
  • (Only for arrays) The value indices at which the Y axes cross the value axis.
  • (Only for dates) The date at which the Y axis crosses this axis.

To denote the far end of the axis, set a value that is greater than or equal to the axis maximum value.

background? string

The background color of the axis.

baseUnit? BaseUnit

The base time interval for the axis labels. The default baseUnit is automatically determined from the value range.

The available options are:

  • milliseconds
  • seconds
  • minutes
  • hours
  • days
  • weeks
  • months
  • years

color? string

The color of the axis. Accepts a valid CSS color string, including hex and rgb.

crosshair? YAxisCrosshair

The configuration options of the crosshair. The crosshair is displayed when the yAxis.crosshair.visible option is set to true.

labels? YAxisLabels

The axis labels configuration.

line? AxisLine

The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.

majorGridLines? GridLines

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? AxisTicks

The configuration of the Scatter Chart Y-axis major ticks.

majorUnit? number

The interval between major divisions. If this is a date axis, the value represents the number of yAxis.baseUnits between major divisions. If the yAxis.type is set to "log", the majorUnit value is used for the base of the logarithm.

max? any

The maximum value of the axis.

min? any

The minimum value of the axis.

minorGridLines? GridLines

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? AxisTicks

The configuration of the Y-axis minor ticks.

minorUnit? number

The interval between minor divisions. It defaults to one-fifth (1/5) of yAxis.majorUnit. If yAxis.type is set to "log", the minorUnit value represents the number of divisions between two major units and defaults to the major unit minus one.

name? string

The unique axis name. Used to associate a series with a Y axis by using the series.yAxis option.

narrowRange? boolean

If set to true, the Chart prevents the automatic axis range from snapping to zero. Setting it to false forces the automatic axis range to snap to zero.

notes? YAxisNotes

The Y-axis notes configuration.

pane? string

The name of the pane in which the axis has to be rendered. If not set, the axis is rendered in the first (default) pane.

plotBands? PlotBand[]

The plot bands of the Y axis.

reverse? boolean

If set to true, the value axis direction is reversed. By default, the values increase from left to right and from bottom to top.

title? YAxisTitle

The title configuration of the Scatter Chart Y axis. To display the title, set the yAxis.title.text option.

type? "numeric" | "log" | "date"

The axis type.

The supported values are:

  • "numeric"—Numeric axis.
  • "date"—Specialized axis for displaying chronological data.
  • "log"—Logarithmic axis.

If the series Y value is of the date type, the Chart automatically switches to a date axis. To avoid this behavior, set the type.

visible? boolean

If set to true, the Chart displays the Y axis. By default, the Y axis is visible.