Merge pull request #1943 from ag-grid/imoses/types

Type fixes
ag-grid · Jun 28, 2024 · 647bda5 · 647bda5
2 parents 1fa2e73 + e90e518
commit 647bda5
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 17 deletions.
diff --git a/packages/ag-charts-community/src/chart/series/cartesian/bubbleSeriesProperties.ts b/packages/ag-charts-community/src/chart/series/cartesian/bubbleSeriesProperties.ts
@@ -2,7 +2,7 @@ import type {
  AgBubbleSeriesLabelFormatterParams,
  AgBubbleSeriesOptions,
  AgBubbleSeriesOptionsKeys,
- AgBubbleSeriesStyles,
+ AgBubbleSeriesStyle,
  AgBubbleSeriesTooltipRendererParams,
  BubbleSeriesItemStylerParams,
  LabelPlacement,
@@ -126,7 +126,7 @@ export class BubbleSeriesProperties extends CartesianSeriesProperties<AgBubbleSe
  strokeOpacity!: number;
 
  @ProxyProperty('marker.itemStyler', { optional: true })
- itemStyler?: Styler<BubbleSeriesItemStylerParams<unknown>, AgBubbleSeriesStyles>;
+ itemStyler?: Styler<BubbleSeriesItemStylerParams<unknown>, AgBubbleSeriesStyle>;
 
  @Validate(OBJECT)
  readonly label = new BubbleSeriesLabel();

diff --git a/packages/ag-charts-enterprise/src/series/range-bar/rangeBarProperties.ts b/packages/ag-charts-enterprise/src/series/range-bar/rangeBarProperties.ts
@@ -3,7 +3,7 @@ import type {
  AgRangeBarSeriesLabelFormatterParams,
  AgRangeBarSeriesLabelPlacement,
  AgRangeBarSeriesOptions,
- AgRangeBarSeriesStyles,
+ AgRangeBarSeriesStyle,
  AgRangeBarSeriesTooltipRendererParams,
  Styler,
 } from 'ag-charts-community';
@@ -79,7 +79,7 @@ export class RangeBarProperties extends AbstractBarSeriesProperties<AgRangeBarSe
  cornerRadius: number = 0;
 
  @Validate(FUNCTION, { optional: true })
- itemStyler?: Styler<AgRangeBarSeriesItemStylerParams<unknown>, AgRangeBarSeriesStyles>;
+ itemStyler?: Styler<AgRangeBarSeriesItemStylerParams<unknown>, AgRangeBarSeriesStyle>;
 
  @Validate(OBJECT)
  readonly shadow = new DropShadow().set({ enabled: false });
@@ -88,5 +88,5 @@ export class RangeBarProperties extends AbstractBarSeriesProperties<AgRangeBarSe
  readonly label = new RangeBarSeriesLabel();
 
  @Validate(OBJECT)
- readonly tooltip = new SeriesTooltip<AgRangeBarSeriesTooltipRendererParams>();
+ readonly tooltip = new SeriesTooltip<AgRangeBarSeriesTooltipRendererParams<unknown>>();
 }
diff --git a/packages/ag-charts-types/src/series/cartesian/bubbleOptions.ts b/packages/ag-charts-types/src/series/cartesian/bubbleOptions.ts
@@ -20,14 +20,14 @@ export interface AgBubbleSeriesLabel<TDatum> extends AgChartLabelOptions<TDatum,
  placement?: LabelPlacement;
 }
 
-export type AgBubbleSeriesStyles = AgSeriesMarkerStyle;
+export type AgBubbleSeriesStyle = AgSeriesMarkerStyle;
 
 export type BubbleSeriesItemStylerParams<TDatum> = DatumCallbackParams<TDatum> &
  AgBubbleSeriesOptionsKeys &
- Required<AgBubbleSeriesStyles>;
+ Required<AgBubbleSeriesStyle>;
 
 export interface AgBubbleSeriesThemeableOptions<TDatum = any>
- extends AgBubbleSeriesStyles,
+ extends AgBubbleSeriesStyle,
  AgBaseCartesianThemeableOptions<TDatum> {
  /** Explicitly specifies the extent of the domain for series `sizeKey`. */
  domain?: [number, number];
@@ -42,7 +42,7 @@ export interface AgBubbleSeriesThemeableOptions<TDatum = any>
  /** Series-specific tooltip configuration. */
  tooltip?: AgSeriesTooltip<AgBubbleSeriesTooltipRendererParams<TDatum>>;
  /** Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states. */
- itemStyler?: Styler<BubbleSeriesItemStylerParams<TDatum>, AgBubbleSeriesStyles>;
+ itemStyler?: Styler<BubbleSeriesItemStylerParams<TDatum>, AgBubbleSeriesStyle>;
 }
 
 export interface AgBubbleSeriesOptionsKeys {

diff --git a/packages/ag-charts-types/src/series/cartesian/heatmapOptions.ts b/packages/ag-charts-types/src/series/cartesian/heatmapOptions.ts
@@ -18,7 +18,7 @@ export type AgHeatmapSeriesTooltipRendererParams<TDatum> = AgSeriesTooltipRender
  AgHeatmapSeriesOptionsNames;
 
 export interface AgHeatmapSeriesThemeableOptions<TDatum = any>
- extends AgHeatmapSeriesStyle,
+ extends StrokeOptions,
  AgBaseCartesianThemeableOptions<TDatum> {
  /** Options for the label in each cell. */
  label?: AgChartAutoSizedSecondaryLabelOptions<TDatum, AgHeatmapSeriesLabelFormatterParams>;

diff --git a/packages/ag-charts-types/src/series/cartesian/rangeBarOptions.ts b/packages/ag-charts-types/src/series/cartesian/rangeBarOptions.ts
@@ -8,14 +8,14 @@ import type { FillOptions, LineDashOptions, StrokeOptions } from './commonOption
 
 export type AgRangeBarSeriesItemStylerParams<TDatum> = DatumCallbackParams<TDatum> &
  AgRangeBarSeriesOptionsKeys &
- Required<AgRangeBarSeriesStyles>;
+ Required<AgRangeBarSeriesStyle>;
 
-export interface AgRangeBarSeriesStyles extends FillOptions, StrokeOptions, LineDashOptions {
+export interface AgRangeBarSeriesStyle extends FillOptions, StrokeOptions, LineDashOptions {
  /** Apply rounded corners to each bar. */
  cornerRadius?: PixelSize;
 }
 
-export type AgRangeBarSeriesTooltipRendererParams<TDatum = any> = AgSeriesTooltipRendererParams<TDatum> &
+export type AgRangeBarSeriesTooltipRendererParams<TDatum> = AgSeriesTooltipRendererParams<TDatum> &
  AgRangeBarSeriesOptionsKeys &
  AgRangeBarSeriesOptionsNames;
 
@@ -31,7 +31,7 @@ export type AgRangeBarSeriesLabelPlacement = 'inside' | 'outside';
 
 export interface AgRangeBarSeriesThemeableOptions<TDatum = any>
  extends AgBaseCartesianThemeableOptions<TDatum>,
- AgRangeBarSeriesStyles {
+ AgRangeBarSeriesStyle {
  /**
  * Bar rendering direction.
  *
@@ -47,7 +47,7 @@ export interface AgRangeBarSeriesThemeableOptions<TDatum = any>
  /** Configuration for the shadow used behind the series items. */
  shadow?: AgDropShadowOptions;
  /** Function used to return formatting for individual RangeBar series item cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states. */
- itemStyler?: Styler<AgRangeBarSeriesItemStylerParams<TDatum>, AgRangeBarSeriesStyles>;
+ itemStyler?: Styler<AgRangeBarSeriesItemStylerParams<TDatum>, AgRangeBarSeriesStyle>;
 }
 
 export type AgRangeBarSeriesLabelFormatterParams = AgRangeBarSeriesOptionsKeys & AgRangeBarSeriesOptionsNames;

diff --git a/.../ag-charts-website/src/content/gallery/_examples/horizontal-range-bar-with-labels/main.ts b/.../ag-charts-website/src/content/gallery/_examples/horizontal-range-bar-with-labels/main.ts
@@ -9,7 +9,7 @@ const numberFormatOptions: Intl.NumberFormatOptions = {
  currency: 'GBP',
 };
 
-const tooltip: AgSeriesTooltip<AgRangeBarSeriesTooltipRendererParams> = {
+const tooltip: AgSeriesTooltip<AgRangeBarSeriesTooltipRendererParams<any>> = {
  renderer: ({ datum, xName, xKey, yLowKey, yHighKey, yLowName, yHighName }) => {
  return {
  content: `<b>${xName}:</b> ${datum[xKey]}<br/><b>${yLowName}: </b>${datum[yLowKey].toLocaleString(

diff --git a/packages/ag-charts-website/src/content/gallery/_examples/range-bar-with-labels/main.ts b/packages/ag-charts-website/src/content/gallery/_examples/range-bar-with-labels/main.ts
@@ -8,7 +8,7 @@ import {
 
 import { getData } from './data';
 
-const tooltip: AgSeriesTooltip<AgRangeBarSeriesTooltipRendererParams> = {
+const tooltip: AgSeriesTooltip<AgRangeBarSeriesTooltipRendererParams<any>> = {
  renderer: ({ datum, xName, xKey, yLowKey, yHighKey, yLowName, yHighName }) => {
  return {
  content: `<b>${xName}:</b> ${datum[xKey]}<br/><b>${yLowName}: </b>${datum[yLowKey].toLocaleString('en-GB', {