OrdinalAux

• Name: Ordinal Axis Auxiliary Line

• Description: Mainly used as an auxiliary line in conjunction with OrdinalBubbles.

• Playground Example

params$

• Type: Partial<OrdinalAuxParams>

• Fields:

  Name	Description	Type
  showLine	Show auxiliary line	boolean
  showLabel	Show auxiliary label	boolean
  lineDashArray	Line attribute dash-array	string
  lineColorType	Line color type	ColorType
  labelColorType	Label color type	ColorType
  labelTextColorType	Label text color type	ColorType
  labelTextFormat	Label text function	string | ((text: any) => string)
  labelPadding	Label padding	number

Detailed Types

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

• Default values:

{
  showLine: true,
  showLabel: true,
  lineDashArray: '3, 3',
  lineColorType: 'primary',
  labelColorType: 'primary',
  labelTextColorType: 'background',
  labelTextFormat: v => v,
  labelPadding: 20,
}