import type { ContextCallbackParams, DatumCallbackParams, HighlightState, SelectionState, SeriesCallbackParams, Styler } from '../../chart/callbackOptions'; import type { AgErrorBarOptions, AgErrorBarThemeableOptions } from '../../chart/errorBarOptions'; import type { AgChartLabelOptions } from '../../chart/labelOptions'; import type { AgSeriesTooltip, AgSeriesTooltipRendererParams } from '../../chart/tooltipOptions'; import type { ContextDefault, DatumDefault, DatumKey, LabelPlacement } from '../../chart/types'; import type { AgSeriesMarkerStyle } from '../markerOptions'; import type { AgBaseCartesianThemeableOptions, AgBaseSeriesOptions, AgHighlightStyleOptions, AgMultiSeriesHighlightOptions } from '../seriesOptions'; import type { AgErrorBoundSeriesTooltipRendererParams } from './cartesianSeriesTooltipOptions'; import type { AgBaseCartesianSeriesAxisOptions, AgColorScale, FillOptions, StrokeOptions } from './commonOptions'; export interface AgScatterSeriesTooltipRendererParams extends AgSeriesTooltipRendererParams, AgScatterSeriesOptionsKeys, AgScatterSeriesOptionsNames, AgErrorBoundSeriesTooltipRendererParams, FillOptions, StrokeOptions { } export type AgScatterSeriesLabelFormatterParams = AgScatterSeriesOptionsKeys & AgScatterSeriesOptionsNames; export interface AgScatterSeriesStylerParams extends AgScatterSeriesOptionsKeys, SeriesCallbackParams, ContextCallbackParams, AgSeriesMarkerStyle { } export interface AgScatterSeriesStylerResult extends AgSeriesMarkerStyle { } export type AgScatterSeriesItemStylerParams = DatumCallbackParams & ContextCallbackParams & AgScatterSeriesOptionsKeys & Required; export interface AgScatterSeriesLabel extends AgChartLabelOptions, TContext> { /** * Placement of label in relation to the marker. * * Default: `top` */ placement?: LabelPlacement; } export interface AgScatterSeriesThemeableOptions extends AgBaseCartesianThemeableOptions, AgSeriesMarkerStyle { /** 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?: AgScatterSeriesLabel; /** Series-specific tooltip configuration. */ tooltip?: AgSeriesTooltip>; /** Function used to return formatting for entire series, based on the given parameters.*/ styler?: Styler, AgScatterSeriesStylerResult>; /** Function used to return formatting for individual markers, based on the supplied information.*/ itemStyler?: Styler, AgSeriesMarkerStyle>; /** Configuration for the Error Bars. */ errorBar?: AgErrorBarThemeableOptions; /** 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 AgScatterSeriesOptionsKeys { /** 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 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 AgScatterSeriesOptionsNames { /** 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 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 AgScatterSeriesOptions extends Omit, 'highlight'>, AgBaseCartesianSeriesAxisOptions, AgScatterSeriesOptionsKeys, AgScatterSeriesOptionsNames, AgScatterSeriesThemeableOptions { /** Configuration for the Scatter Series. */ type: 'scatter'; /** Configuration for the Error Bars. */ errorBar?: AgErrorBarOptions; }