series[type=' pyramid']
- type required
'pyramid' - Configuration for the Pyramid Series.
- stageKey required
DatumKey - The key to use to retrieve stage values from the data.
- valueKey required
DatumKey - The key to use to retrieve values from the data.
- 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.
- 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.
- highlight
AgHighlightOptions - Configuration for highlighting when a series or legend item is hovered over.
- 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.
- fills
AgColorType[] - The colours to cycle through for the fills of the stages. An array of colour strings, or fill objects for gradients, patterns, or images.
- strokes
CssColor[] - The colours to cycle through for the strokes of the stages.
- fillOpacity
Opacity - The opacity of the fill for the stages.
- strokeOpacity
Opacity - The opacity of the stroke for the stages.
- strokeWidth
PixelSize - The width in pixels of the stroke for the stages.
- direction
'horizontal' | 'vertical' - Stage rendering direction.
- reverse
boolean - Reverse the order of the stages.
- spacing
number - Spacing between the stages.
- aspectRatio
number - Ratio of the triangle width to its height. When unset, the triangle will fill the available space.
- label
AgPyramidSeriesLabelOptions - Configuration for the labels shown on stages.
- stageLabel
AgPyramidSeriesStageLabelOptions - Configuration for the stage labels.
- shadow
AgDropShadowOptions - Configuration for the shadow used behind the series items.
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - Function used to return formatting for individual bars, based on the given parameters.
- 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.
series[type=' pyramid']
- type required
'pyramid' - Configuration for the Pyramid Series.
- stageKey required
DatumKey - The key to use to retrieve stage values from the data.
- valueKey required
DatumKey - The key to use to retrieve values from the data.
- 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.
- 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.
- highlight
AgHighlightOptions - Configuration for highlighting when a series or legend item is hovered over.
- 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.
- fills
AgColorType[] - The colours to cycle through for the fills of the stages. An array of colour strings, or fill objects for gradients, patterns, or images.
- strokes
CssColor[] - The colours to cycle through for the strokes of the stages.
- fillOpacity
Opacity - The opacity of the fill for the stages.
- strokeOpacity
Opacity - The opacity of the stroke for the stages.
- strokeWidth
PixelSize - The width in pixels of the stroke for the stages.
- direction
'horizontal' | 'vertical' - Stage rendering direction.
- reverse
boolean - Reverse the order of the stages.
- spacing
number - Spacing between the stages.
- aspectRatio
number - Ratio of the triangle width to its height. When unset, the triangle will fill the available space.
- label
AgPyramidSeriesLabelOptions - Configuration for the labels shown on stages.
- stageLabel
AgPyramidSeriesStageLabelOptions - Configuration for the stage labels.
- shadow
AgDropShadowOptions - Configuration for the shadow used behind the series items.
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - Function used to return formatting for individual bars, based on the given parameters.
- 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.