navigator.miniChart.series[type=' histogram']
- type
'histogram' - Configuration for Histogram Series.
- xKey
DatumKey - The key to use to retrieve x-values from the data.
- getItemId
Function - A callback to provide a stable identifier for each bin, exposed as `itemId` in events and active state. The returned identifier must be unique across all bins in the series. If not supplied, an identifier is generated from the bin boundaries.
- id
stringdefault: auto-generated value - Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value.
- data
DatumDefault[] - The data to use when rendering the series. If this is not supplied, data must be set on the chart instead.
- xKeyAxis
stringdefault: 'x' - The key of the x-axis to which this series is bound.
- yKeyAxis
stringdefault: 'y' - The key of the y-axis to which this series is bound.
- yKey
DatumKey - The key to use to retrieve y-values from the data.
- styler
Styler - A callback function for adjusting the styles of the whole series based on the highlight or selection state.
- itemStyler
Styler - A callback function for adjusting the styles of each bin individually, based on its range, frequency and aggregated value.
- shadow
AgDropShadowOptions - Configuration for the shadow used behind the chart series.
- areaPlot
boolean - If `true`, the aggregated `yKey` values will be represented using the area of the bar, instead of just the height.
- bins
[number, number][] - Set the bin sizes explicitly. __Note:__ `bins` is ignored if `binCount` is also supplied.
- binCount
number - The number of bins to try to split the x-axis into.
- aggregation
'count' | 'sum' | 'mean'default: sum - Dictates how the `yKey` values are aggregated within each bin.
- cornerRadius
PixelSize - Apply rounded corners to each bar.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- stroke
AgCssColorOrRef - The colour for the stroke.
- strokeWidth
PixelSize - The width of the stroke in pixels.
- strokeOpacity
Opacity - The opacity of the stroke colour.
- lineDash
PixelSize[] - An array specifying the length in pixels of alternating dashes and gaps.
- lineDashOffset
PixelSize - The initial offset of the dashed line in pixels.
navigator.miniChart.series[type=' histogram']
- type
'histogram' - Configuration for Histogram Series.
- xKey
DatumKey - The key to use to retrieve x-values from the data.
- getItemId
Function - A callback to provide a stable identifier for each bin, exposed as `itemId` in events and active state. The returned identifier must be unique across all bins in the series. If not supplied, an identifier is generated from the bin boundaries.
- id
stringdefault: auto-generated value - Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value.
- data
DatumDefault[] - The data to use when rendering the series. If this is not supplied, data must be set on the chart instead.
- xKeyAxis
stringdefault: 'x' - The key of the x-axis to which this series is bound.
- yKeyAxis
stringdefault: 'y' - The key of the y-axis to which this series is bound.
- yKey
DatumKey - The key to use to retrieve y-values from the data.
- styler
Styler - A callback function for adjusting the styles of the whole series based on the highlight or selection state.
- itemStyler
Styler - A callback function for adjusting the styles of each bin individually, based on its range, frequency and aggregated value.
- shadow
AgDropShadowOptions - Configuration for the shadow used behind the chart series.
- areaPlot
boolean - If `true`, the aggregated `yKey` values will be represented using the area of the bar, instead of just the height.
- bins
[number, number][] - Set the bin sizes explicitly. __Note:__ `bins` is ignored if `binCount` is also supplied.
- binCount
number - The number of bins to try to split the x-axis into.
- aggregation
'count' | 'sum' | 'mean'default: sum - Dictates how the `yKey` values are aggregated within each bin.
- cornerRadius
PixelSize - Apply rounded corners to each bar.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- stroke
AgCssColorOrRef - The colour for the stroke.
- strokeWidth
PixelSize - The width of the stroke in pixels.
- strokeOpacity
Opacity - The opacity of the stroke colour.
- lineDash
PixelSize[] - An array specifying the length in pixels of alternating dashes and gaps.
- lineDashOffset
PixelSize - The initial offset of the dashed line in pixels.