Interface IAxes

The chart's axes.

interface IAxes {
    getCategoryAxis(group?: AxisGroup): IChart.IAxis | null;
    getChartAxis(
        type: "value" | "category" | "series",
        group?: AxisGroup,
    ): IChart.IAxis | null;
    getItems(): readonly IChart.IAxis[];
    getSeriesAxis(): IChart.IAxis | null;
    getValueAxis(group?: AxisGroup): IChart.IAxis | null;
}

Index

Methods

getCategoryAxis getChartAxis getItems getSeriesAxis getValueAxis

Methods

getCategoryAxis

getCategoryAxis(group?: AxisGroup): IChart.IAxis | null
Returns the axis the categories run along, shown or hidden: a scatter's horizontal one. null when the chart has none on those axes.
Parameters
- Optionalgroup: AxisGroup
Returns IChart.IAxis | null

getChartAxis

getChartAxis(
type: "value" | "category" | "series",
group?: AxisGroup,
): IChart.IAxis | null
Returns the axis of type on group's axes, or null.
Parameters
- type: "value" | "category" | "series"
- Optionalgroup: AxisGroup
Returns IChart.IAxis | null

getItems

getItems(): readonly IChart.IAxis[]

Returns the axes the chart shows, in the order the chart lists them; a hidden axis is left out.

Returns readonly IChart.IAxis[]

getSeriesAxis

getSeriesAxis(): IChart.IAxis | null

Returns the series axis of a 3-D or surface chart, or null.

Returns IChart.IAxis | null

getValueAxis

getValueAxis(group?: AxisGroup): IChart.IAxis | null
Returns the axis the values are measured along, shown or hidden: a scatter's vertical one. null when the chart has none on those axes.
Parameters
- Optionalgroup: AxisGroup
  The primary axes, by default, or the secondary ones.
Returns IChart.IAxis | null