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=' box-plot']

type required 'box-plot'
Configuration for the Box Plot Series.
xKey required DatumKey
The key used to retrieve x-values (categories) from the data.
minKey required DatumKey
The key to use to retrieve minimum values from the data.
q1Key required DatumKey
The key to use to retrieve lower quartile values from the data.
medianKey required DatumKey
The key to use to retrieve median values from the data.
q3Key required DatumKey
The key to use to retrieve upper quartile values from the data.
maxKey required DatumKey
The key to use to retrieve maximum values from the data.
grouped boolean
Whether to group together (adjacently) separate columns.
legendItemName string
Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together.
direction 'horizontal' | 'vertical'
Bar rendering direction. __Note:__ This option affects the layout direction of X and Y data values.
tooltip AgSeriesTooltip
Series-specific tooltip configuration.
styler Styler
Function used to return formatting for entire series, based on the given parameters.
itemStyler Styler
Function used to return formatting for individual columns, based on the given parameters.
highlight AgMultiSeriesHighlightOptions
Configuration for highlighting when a series or legend item is hovered over.
segmentation AgSeriesSegmentation
Configuration for styling series as separate segments.
width PixelSize
Fixed width of each box in the series.
widthRatio Ratio
Ratio of the bandwidth (or specified width) to use for the width for each box in the series.
showInMiniChart boolean
Whether to include the series in the Mini Chart.
cursor string
The cursor to use for hovered markers. This config is identical to the CSS `cursor` property.
context ContextDefault
Context object to use in callbacks.
selection AgSelectionOptions
Configuration for data selection.
nodeClickRange InteractionRange
Range from a node that a click triggers the listener.
showInLegend boolean
Whether to include the series in the legend.
listeners AgSeriesListeners
A map of event names to event listeners.
cornerRadius PixelSize
Apply rounded corners to each bar.
cap AgBoxPlotCapOptions
Options to style chart's caps
whisker AgBoxPlotWhiskerOptions
Options to style chart's whiskers
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.
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.
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.
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.
xName string
A descriptive label for x-values.
minName string
A human-readable description of minimum values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
q1Name string
A human-readable description of lower quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
medianName string
A human-readable description of median values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
q3Name string
A human-readable description of upper quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
maxName string
A human-readable description of maximum 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 descriptive label for y-values.