import type { ContextCallbackParams, DatumCallbackParams, HighlightState, SelectionState, SeriesCallbackParams, Styler } from '../../chart/callbackOptions'; import type { AgNumericValue } from '../../chart/dataValues'; import type { AgChartLabelOptions } from '../../chart/labelOptions'; import type { AgSeriesTooltip, AgSeriesTooltipRendererParams } from '../../chart/tooltipOptions'; import type { ContextDefault, DatumDefault, DatumKey, LabelPlacement, PixelSize } from '../../chart/types'; import type { AgSeriesMarkerStyle } from '../markerOptions'; import type { AgBaseCartesianThemeableOptions, AgBaseSeriesOptions, AgHighlightStyleOptions, AgMultiSeriesHighlightOptions } from '../seriesOptions'; import type { AgBaseCartesianSeriesAxisOptions, AgColorScale, FillOptions, StrokeOptions } from './commonOptions'; export interface AgBubbleSeriesTooltipRendererParams extends AgSeriesTooltipRendererParams, AgBubbleSeriesOptionsKeys, AgBubbleSeriesOptionsNames, FillOptions, StrokeOptions { } export type AgBubbleSeriesLabelFormatterParams = AgBubbleSeriesOptionsKeys & AgBubbleSeriesOptionsNames; export interface AgBubbleSeriesLabel extends AgChartLabelOptions, TContext> { /** * Placement of label in relation to the marker. * * Default: `top` */ placement?: LabelPlacement; } export interface AgBubbleSeriesStyle extends AgSeriesMarkerStyle { } export interface AgBubbleSeriesStylerParams extends AgBubbleSeriesOptionsKeys, SeriesCallbackParams, ContextCallbackParams, Omit { /** The smallest size a marker can be in pixels. */ minSize: PixelSize; /** The largest size a marker can be in pixels. */ maxSize: PixelSize; } export interface AgBubbleSeriesStylerResult extends Omit { /** The smallest size a marker can be in pixels. */ minSize?: PixelSize; /** The largest size a marker can be in pixels. */ maxSize?: PixelSize; } export type BubbleSeriesItemStylerParams = DatumCallbackParams & ContextCallbackParams & AgBubbleSeriesOptionsKeys & Required; export type AgBubbleSeriesItemStylerParams = BubbleSeriesItemStylerParams; export interface AgBubbleSeriesThemeableOptions extends Omit, AgBaseCartesianThemeableOptions { /** * Explicitly specifies the extent of the domain of `sizeKey` values to map onto the `[minSize, maxSize]` range. * * Reverse the bounds (e.g. `[100, 0]`) to invert the mapping so that larger values produce smaller markers. */ sizeDomain?: [AgNumericValue, AgNumericValue]; /** * Determines the smallest size a marker can be in pixels. `sizeKey` values at the lower end of `sizeDomain` map to this size. * * Default: `7` */ minSize?: PixelSize; /** * Determines the largest size a marker can be in pixels. `sizeKey` values at the upper end of `sizeDomain` map to this size. * * Default: `30` */ maxSize?: PixelSize; /** Determines the largest number of items that can be rendered at once. If there are more items, they will be aggregated to resemble similar visual appearance. * * Default: `2000` */ maxRenderedItems?: number; /** The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not. */ title?: string; /** Configuration for the labels shown on top of data points. */ label?: AgBubbleSeriesLabel; /** Series-specific tooltip configuration. */ tooltip?: AgSeriesTooltip>; /** Function used to return formatting for entire series, based on the given parameters.*/ styler?: Styler, AgBubbleSeriesStylerResult>; /** Function used to return formatting for individual markers, based on the supplied information.*/ itemStyler?: Styler, AgBubbleSeriesStyle>; /** Configuration for highlighting when a series or legend item is hovered over. */ highlight?: AgMultiSeriesHighlightOptions; /** Configuration for colour scale with fills, domain, and mode. */ colorScale?: AgColorScale; } export interface AgBubbleSeriesOptionsKeys { /** The key to use to retrieve x-values from the data. */ xKey: DatumKey; /** The key to use to retrieve y-values from the data. */ yKey: DatumKey; /** The key to use to retrieve size values from the data, used to control the size of the markers. */ sizeKey: DatumKey; /** The key to use to retrieve values from the data to use as labels for the markers. */ labelKey?: DatumKey; /** The key to use to retrieve colour values from the data. This value (along with `colorScale` config) will be used to determine the marker colour. */ colorKey?: DatumKey; } export interface AgBubbleSeriesOptionsNames { /** 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. */ xName?: 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. */ yName?: string; /** A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. */ sizeName?: string; /** A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. */ labelName?: string; /** A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. */ colorName?: string; /** The text to display in the legend for this series. If supplied, matching items with the same value will be toggled together. */ legendItemName?: string; } export interface AgBubbleSeriesOptions extends Omit, 'highlight'>, AgBaseCartesianSeriesAxisOptions, AgBubbleSeriesThemeableOptions, AgBubbleSeriesOptionsKeys, AgBubbleSeriesOptionsNames { /** Configuration for Bubble Series. */ type: 'bubble'; }