AG Studio: Build dashboards using native components in web apps. Join us for a webinar on 28th July at 2pm UTC+1 Register

series[type=' histogram']

type required 'histogram'
Configuration for Histogram Series.
xKey required DatumKey
The key to use to retrieve x-values from the data.
listeners AgHistogramSeriesListeners
A map of event names to event listeners.
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 string default: 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.
context ContextDefault
Context object to use in callbacks.
data DatumDefault[]
The data to use when rendering the series. If this is not supplied, data must be set on the chart instead.
visible boolean
Whether to display the series.
cursor string
The cursor to use for hovered markers. This config is identical to the CSS `cursor` property.
nodeClickRange InteractionRange
Range from a node that a click triggers the listener.
showInLegend boolean
Whether to include the series in the legend.
xKeyAxis string default: 'x'
The key of the x-axis to which this series is bound.
yKeyAxis string default: '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.
xName string
A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
yName string
A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
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.
label AgHistogramSeriesLabelOptions
Configuration for the labels shown on bars.
tooltip AgSeriesTooltip
Series-specific tooltip configuration.
highlight AgMultiSeriesHighlightOptions
Configuration for highlighting when a series or legend item is hovered over.
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.
showInMiniChart boolean
Whether to include the series in the Mini Chart.
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.