Skip to contents

Configuration for a cartesian axis (xAxis or yAxis). Combines fields from AxisBaseOptionCommon, NumericAxisBaseOptionCommon, CategoryAxisBaseOption, ValueAxisBaseOption, LogAxisBaseOption, and TimeAxisBaseOption.

Usage

Axis(
  type = NULL,
  show = NULL,
  inverse = NULL,
  name = NULL,
  name_location = NULL,
  name_rotate = NULL,
  name_gap = NULL,
  name_text_style = NULL,
  silent = NULL,
  trigger_event = NULL,
  min = NULL,
  max = NULL,
  scale = NULL,
  split_number = NULL,
  interval = NULL,
  min_interval = NULL,
  max_interval = NULL,
  align_ticks = NULL,
  log_base = NULL,
  boundary_gap = NULL,
  data = NULL,
  axis_line = NULL,
  axis_tick = NULL,
  minor_tick = NULL,
  axis_label = NULL,
  split_line = NULL,
  minor_split_line = NULL,
  split_area = NULL,
  position = NULL,
  grid_index = NULL
)

Arguments

type

Optional Character {"value", "category", "time", "log"}: Axis type.

show

Optional Logical: Whether to show the axis.

inverse

Optional Logical: Whether to invert the axis.

name

Optional Character: Axis name.

name_location

Optional Character {"start", "middle", "center", "end"}: Axis name location.

name_rotate

Optional Numeric: Axis name rotation angle in degrees.

name_gap

Optional Numeric [0, Inf): Gap between the axis name and axis line.

name_text_style

Optional TextStyle: Axis name text style.

silent

Optional Logical: Whether the axis is silent.

trigger_event

Optional Logical: Whether the axis triggers events.

min

Optional Numeric or Character {"dataMin", "dataMax"}: Minimum axis value.

max

Optional Numeric or Character {"dataMin", "dataMax"}: Maximum axis value.

scale

Optional Logical: Whether a value axis should avoid forcing zero.

split_number

Optional Numeric [0, Inf): Suggested number of split segments.

interval

Optional Numeric [0, Inf): Tick interval.

min_interval

Optional Numeric [0, Inf): Minimum auto-calculated tick interval.

max_interval

Optional Numeric [0, Inf): Maximum auto-calculated tick interval.

align_ticks

Optional Logical: Whether to align ticks with the first axis.

log_base

Optional Numeric [0, Inf): Logarithm base for log axes.

boundary_gap

Optional Logical, Numeric, or Character: Gap at axis boundaries. Logical (category) or length-2 vector of numbers/strings (numeric axes).

data

Optional Vector: Category data.

axis_line

Optional AxisLine: Axis line configuration.

axis_tick

Optional AxisTick: Axis tick configuration.

minor_tick

Optional MinorTick: Minor tick configuration.

axis_label

Optional AxisLabel: Axis label configuration.

split_line

Optional SplitLine: Split line configuration.

minor_split_line

Optional MinorSplitLine: Minor split line configuration.

split_area

Optional SplitArea: Split area configuration.

position

Optional Character {"left", "right", "top", "bottom"}: Axis position. For yAxis: "left" (default) or "right". For xAxis: "bottom" (default) or "top".

grid_index

Optional Numeric [0, Inf): Index of the grid this axis belongs to. Used when the chart has multiple grids (e.g. heatmap + dendrogram panels).

Details

Corresponds to AxisBaseOption in src/coord/axisCommonTypes.ts (line 376). ECharts docs: https://echarts.apache.org/en/option.html#xAxis