GroupAxis

• Name: Group Axis

• Description: Group axis (default is X axis, label text corresponds to columnLabels in dataFormatter$)

• Usage: The axis format will be set with the groupAxis field in dataFormatter. For detailed API, please refer to the documentation (However, in most cases, if you are using Preset, you do not need to set dataFormatter yourself. More commonly used is the axis label setting)

• Axis label setting: Use dataFormatter's groupAxis.label to set the label text, as shown below:

chart.dataFormatter$.next({
  groupAxis: {
    label: 'Region'
  }
})

• Playground Example

params$

• Type: Partial<GroupAxisParams>

• Fields:

  Name	Description	Type
  labelOffset	Axis label offset	[number, number]
  labelColorType	Axis label color type	ColorType
  axisLineVisible	Show axis line	boolean
  axisLineColorType	Axis line color type	ColorType
  ticks	Number of ticks * number: appropriate number * null: auto-detect * all: all	number | null | 'all'
  tickFormat	Tick text format * string: annotated with d3-format format * Function: custom function returning display text	string | ((text: d3.NumberValue) => string | d3.NumberValue)
  tickLineVisible	Show tick line	boolean
  tickPadding	Distance between tick and text	number
  tickFullLine	Show tick line across the entire scene	boolean
  tickFullLineDasharray	Set tick line dash format (used with tickFullLine as true)	string
  tickColorType	Tick color type	ColorType
  tickTextRotate	Tick text rotation	number
  tickTextColorType	Tick text color type	ColorType

Detailed Types

type ColorType = 'none' | 'label' | 'labelContrast' | 'primary' | 'secondary' | 'background'

• Default values:

{
  labelOffset: [0, 0],
  labelColorType: 'primary',
  axisLineVisible: true,
  axisLineColorType: 'primary',
  ticks: 'all',
  tickFormat: text => text,
  tickLineVisible: true,
  tickPadding: 20,
  tickFullLine: false,
  tickFullLineDasharray: 'none',
  tickColorType: 'secondary',
  tickTextRotate: 0,
  tickTextColorType: 'primary',
}