MultiValueAxis
Name: Multi Value Axis
Description: Functions similarly to the
ValueAxisin the Grid data category, corresponding to each grid data by default, and drawing axes for each grid data separately. Note thatdataFormatter$'sseparateGridmust betrueto correctly display multiple axes (otherwise they will overlap).Usage: The axis format will be set using the
dataFormatter'sgridList[].valueAxisfield. For detailed API, refer to the documentation (in most cases, if usingPreset, you don't need to setdataFormattermanually, and it's more common to set axis labels).Axis label settings: Use
dataFormatter'sgridList[].valueAxis.labelto set the label text, as shown in the example below:
chart.dataFormatter$.next({
gridList: [
{
valueAxis: {
label: 'Quantity'
}
}
]
})
params$
Type:
Partial<MultiValueAxisParams>Fields:
Name Description Type labelOffset Axis label offset [number, number]labelColorType Axis label color type ColorTypeaxisLineVisible Show axis line booleanaxisLineColorType Axis line color type ColorTypeticks Number of ticks
*number: appropriate number
*null: auto-detectnumber | nulltickFormat Tick text format
*string: annotated withd3-formatformat
*Function: custom function returning display textstring | ((text: d3.NumberValue) => string | d3.NumberValue)tickLineVisible Show tick line booleantickPadding Distance between tick and text numbertickFullLine Show tick line across the entire scene booleantickFullLineDasharray Set tick line dash format (used with tickFullLineastrue)stringtickColorType Tick color type ColorTypetickTextRotate Tick text rotation numbertickTextColorType Tick text color type ColorTypegridIndexes Indexes of the corresponding data$grid data, can correspond to one or more grid datanumber[] | 'all'
Detailed Types
type ColorType = 'none' | 'label' | 'labelContrast' | 'primary' | 'secondary' | 'background'
- Default values:
{
labelOffset: [0, 0],
labelColorType: 'primary',
axisLineVisible: false,
axisLineColorType: 'primary',
ticks: 4,
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',
gridIndexes: 'all'
}