ValueAxis

• Name: Value Axis

• Description: Value axis (default is Y axis)

• Usage: The format of the axis will be set with the valueAxis field of 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 setting of axis labels).

• Axis label setting: Use the valueAxis.label setting of dataFormatter to set the label text, as shown in the example below:

chart.dataFormatter$.next({
  valueAxis: {
    label: 'Quantity'
  }
})

• Playground Example

params$

• Type: Partial<ValueAxisParams>

• 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	number | null
  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 Type

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

• Default values:

{
  labelOffset: [0, 0],
  labelColorType: 'primary',
  axisLineVisible: false,
  axisLineColorType: 'primary',
  ticks: null,
  tickFormat: num => {
    if (num === null || Number.isNaN(num) == true) {
      return num || 0
    }
    var parts = num.toString().split('.')
    parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ',')
    return parts.join('.')
  },
  tickLineVisible: true,
  tickPadding: 20,
  tickFullLine: true,
  tickFullLineDasharray: 'none',
  tickColorType: 'secondary',
  tickTextRotate: 0,
  tickTextColorType: 'primary'
}