Merge pull request #3682 from ag-grid/AG-14185-donut-inner-radius

AG-14185 Add default donut inner radius ratio
ag-grid · Feb 27, 2025 · 53c2548 · 53c2548
2 parents 466fdf6 + c750091
commit 53c2548
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 18 deletions.
diff --git a/packages/ag-charts-community/src/chart/series/polar/donutSeriesModule.ts b/packages/ag-charts-community/src/chart/series/polar/donutSeriesModule.ts
@@ -1,4 +1,4 @@
-import { type SeriesModuleDefinition, ValidationError, validate } from 'ag-charts-core';
+import { type SeriesModuleDefinition } from 'ag-charts-core';
 import type { AgDonutSeriesOptions } from 'ag-charts-types';
 
 import type { SeriesModule } from '../../../module/coreModules';
@@ -29,15 +29,4 @@ export const NewDonutSeriesModule: SeriesModuleDefinition<AgDonutSeriesOptions>
     options: donutSeriesOptionsDef,
 
     create: (ctx: ModuleContext) => new DonutSeries(ctx),
-    validate(options, optionsDefs, path) {
-        const result = validate(options, optionsDefs, path);
-
-        if (result.valid?.innerRadiusRatio == null && result.valid?.innerRadiusOffset == null) {
-            const extendPath = (key: string) => (path ? `${path}.${key}` : key);
-            const message = `Either \`${extendPath('innerRadiusRatio')}\` or \`${extendPath('innerRadiusOffset')}\` is required.`;
-            result.errors.push(new ValidationError(message, path, true));
-        }
-
-        return result;
-    },
 };
diff --git a/packages/ag-charts-community/src/chart/series/polar/donutTheme.ts b/packages/ag-charts-community/src/chart/series/polar/donutTheme.ts
@@ -41,6 +41,7 @@ export const donutTheme: ExtensibleTheme<'donut'> = {
         lineDashOffset: 0,
         rotation: 0,
         sectorSpacing: 1,
+        innerRadiusRatio: { $if: [{ $eq: [{ $path: './innerRadiusOffset' }, undefined] }, 0.7, undefined] },
         shadow: {
             enabled: false,
             color: DEFAULT_SHADOW_COLOUR,

diff --git a/packages/ag-charts-types/src/series/polar/donutOptions.ts b/packages/ag-charts-types/src/series/polar/donutOptions.ts
@@ -99,13 +99,9 @@ export interface AgDonutSeriesThemeableOptions<TDatum = any>
     outerRadiusOffset?: PixelSize;
     /** The ratio of the outer radius of the series. Used to adjust the outer radius proportionally to the automatically calculated value. */
     outerRadiusRatio?: Ratio;
-    /** The offset in pixels of the inner radius of the series.
-     *
-     * __Note:__ An `innerRadiusRatio` or an `innerRadiusOffset` must be provided in order to render a Donut series. */
+    /** The offset in pixels of the inner radius of the series. */
     innerRadiusOffset?: PixelSize;
-    /** The ratio of the inner radius of the series.
-     *
-     *  __Note:__ An `innerRadiusRatio` or an `innerRadiusOffset` must be provided in order to render a Donut series. */
+    /** The ratio of the inner radius of the series. */
     innerRadiusRatio?: Ratio;
     /** Override of the automatically determined minimum radiusKey value from the data. */
     radiusMin?: number;