Interface for a class Axis
Configures the appearance of the border around multi-level labels, including the color, width, and type of the border.
number
The coefficient
value adjusts the size of the polar radar chart’s radius. A higher value increases the radius size, while a smaller value decreases it.
number
Specifies the index of the column where the axis is associated when the chart area is divided into multiple plot areas using columns
.
<div id='Chart'></div>
let chart: Chart = new Chart({
...
columns: [{ width: '50%' },
{ width: '50%' }],
axes: [{
name: 'xAxis 1',
columnIndex: 1
}],
...
});
chart.appendTo('#Chart');
Object
Specifies the value at which the axis line intersects with the vertical axis or vice versa.
string
Specifies the name of the axis with which the axis line should intersect.
Options to customize the appearance and behavior of the crosshair tooltip that appears when hovering over the chart.
string
A description for the axis that provides additional information about its content for screen readers.
number
The desiredIntervals
property allows the axis to calculate intervals that are roughly equal to the specified number, promoting a more readable and evenly spaced axis.
The edgeLabelPlacement
property ensures that labels positioned at the edges of the axis do not overlap with the axis boundaries or other chart elements, offering several options to improve chart readability by managing edge labels effectively.
Available options are:
boolean
If set to true, the axis interval will be calculated automatically based on the zoomed range.
boolean
If set to true, a scrollbar will appear while zooming to help navigate through the zoomed content.
boolean
If set to true, axis labels will be trimmed based on the maximumLabelWidth
.
number
Specifies the interval for the axis.
The intervalType
property defines how the intervals on a date-time axis are calculated and displayed.
Available options are:
boolean
If set to true, data points are rendered based on their index.
boolean
If set to true, the axis will be rendered in an inversed manner.
string
Used to format the axis label. This property accepts global string formats such as C
, n1
, P
, etc.
It also accepts placeholders like {value}°C
, where {value}
represents the axis label (e.g., 20°C).
Specifies the action to take when axis labels intersect with each other. The available options are:
number
The labelPadding
property adjusts the distance to ensure a clear space between the axis labels and the axis line.
The labelPlacement
property controls where the category axis labels are rendered in relation to the axis ticks.
Available options are:
The labelPosition
property determines where the axis labels are rendered in relation to the axis line.
Available options are:
number
The angle to which the axis label gets rotated.
This property allows defining various font settings to control how the labels are displayed on the axis.
Determines the alignment of labels when a line break occurs in the axis labels.
Options for customizing the axis lines.
number
Specifies the base value for a logarithmic axis.
Note that
valueType
must be set toLogarithmic
for this feature to work.
Options for customizing major grid lines on the axis.
Options for customizing major tick lines on the axis.
Object
Specifies the maximum value of the axis range, which sets the upper bound of the axis and defines the largest value displayed on the chart, helping to control the visible range of data.
number
Specifies the maximum width of an axis label.
number
Specifies the maximum number of labels per 100 pixels relative to the axis length.
Object
Specifies the minimum value of the axis range, which sets the lower bound of the axis and defines the smallest value that will be displayed on the chart to control the visible range of data.
Options for customizing minor grid lines on the axis.
Options for customizing minor tick lines on the axis.
number
Specifies the number of minor ticks per interval.
Multi-level labels are used to display hierarchical or grouped labels on the axis, allowing for a more detailed and structured data representation.
string
A unique identifier for an axis. To associate an axis with a series, set this name to the xAxisName
or yAxisName
properties of the series.
boolean
If set to true, the axis will render on the opposite side of its default position.
boolean
Specifies whether axis elements, such as axis labels and the axis title, should be crossed by the axis line.
number
Specifies the padding on the top, bottom, left and right sides of the chart area, in pixels.
number
Specifies the bottom padding for the chart area, in pixels.
number
Specifies the left padding for the chart area, in pixels.
number
Specifies the right padding for the chart area, in pixels.
number
Specifies the top padding for the chart area, in pixels.
The rangePadding
property determines how padding is applied to the axis range, affecting the appearance of the chart by adjusting the minimum and maximum values of the axis.
Available options are:
number
Specifies the index of the row where the axis is associated when the chart area is divided into multiple plot areas using rows
.
<div id='Chart'></div>
let chart: Chart = new Chart({
...
rows: [{ height: '50%' },
{ height: '50%' }],
axes: [{
name: 'yAxis 1',
rowIndex: 1
}],
...
});
chart.appendTo('#Chart');
Configures the scrollbar with options for customization, including appearance, behavior, and lazy loading settings.
string
Specifies the skeleton format used for processing date-time values.
Specifies the format type to be used in date-time formatting.
number
Specifies the number of columns
or rows
that an axis spans horizontally or vertically.
number
Specifies the start angle for the series in a polar or radar chart, measured in degrees from the horizontal axis, determining the initial angle from which the series begins.
boolean
If set to true, the axis starts from zero. If set to false, the axis starts from the minimum value of the data.
Specifies the collection of strip lines for the axis, which are visual elements used to mark or highlight specific ranges.
number
The tabIndex
value for the axis, determining its position in the tab order.
The tickPosition
property determines where the axis ticks are rendered in relation to the axis line.
Available options are:
string
Specifies the title of an axis, displayed along the axis to provide context about the represented data.
number
Specifies the padding between the axis title and the axis labels.
number
Defines an angle for rotating the axis title. By default, the angle is calculated based on the position and orientation of the axis.
Options for customizing the appearance of the axis title, including font family, size, style, weight, and color.
The valueType
property defines the type of data that the axis can manage, ensuring correct rendering based on the data type. This property supports multiple data types, each suited for different kinds of data visualization.
Available options include:
boolean
If set to true, axis labels will be visible in the chart. By default, axis labels are enabled.
number
The axis is scaled by this factor. When zoomFactor
is 0.5, the chart is scaled by 200% along this axis.
Note the value ranges from 0 to 1.
number
Sets the position of the zoomed axis on the chart, with the zoomPosition
property specifying the position within the zoomed range, from 0 (start) to 1 (end).