[IMP] chart: explicit calendar granularities

Using a full explicit definition is better if one day we want to change
the default value (without affecting existing charts)

And I'm also simplifying chart classes in another branch where we no longer
can do `... ?? "day_of_week"`

closes #7529

Task: 0
Signed-off-by: Rémi Rahir (rar) <rar@odoo.com>

Author: LucasLefevre

packages/o-spreadsheet-engine/src/types/chart/calendar_chart.ts

@@ -19,10 +19,10 @@ export type CalendarChartGranularity = (typeof CALENDAR_CHART_GRANULARITIES)[num
 
 export interface CalendarChartDefinition extends CommonChartDefinition {
   readonly type: "calendar";
+  readonly horizontalGroupBy: CalendarChartGranularity;
+  readonly verticalGroupBy: CalendarChartGranularity;
   readonly colorScale?: ChartColorScale;
   readonly missingValueColor?: Color;
-  readonly horizontalGroupBy?: CalendarChartGranularity;
-  readonly verticalGroupBy?: CalendarChartGranularity;
 }
 
 export type CalendarChartRuntime = {

src/helpers/figures/charts/calendar_chart.ts

@@ -50,16 +50,10 @@ import {
 } from "./runtime";
 
 function checkDateGranularity(definition: CalendarChartDefinition): CommandResult {
-  if (
-    definition.horizontalGroupBy &&
-    !CALENDAR_CHART_GRANULARITIES.includes(definition.horizontalGroupBy)
-  ) {
+  if (!CALENDAR_CHART_GRANULARITIES.includes(definition.horizontalGroupBy)) {
     return CommandResult.InvalidChartDefinition;
   }
-  if (
-    definition.verticalGroupBy &&
-    !CALENDAR_CHART_GRANULARITIES.includes(definition.verticalGroupBy)
-  ) {
+  if (!CALENDAR_CHART_GRANULARITIES.includes(definition.verticalGroupBy)) {
     return CommandResult.InvalidChartDefinition;
   }
   return CommandResult.Success;
@@ -91,8 +85,8 @@ export class CalendarChart extends AbstractChart {
     this.showValues = definition.showValues;
     this.colorScale = definition.colorScale;
     this.axesDesign = definition.axesDesign;
-    this.horizontalGroupBy = definition.horizontalGroupBy ?? "day_of_week";
-    this.verticalGroupBy = definition.verticalGroupBy ?? "month_number";
+    this.horizontalGroupBy = definition.horizontalGroupBy;
+    this.verticalGroupBy = definition.verticalGroupBy;
     this.legendPosition = definition.legendPosition;
     this.missingValueColor = definition.missingValueColor;
   }
@@ -132,6 +126,8 @@ export class CalendarChart extends AbstractChart {
       showValues: context.showValues,
       axesDesign: context.axesDesign,
       legendPosition,
+      horizontalGroupBy: "day_of_week",
+      verticalGroupBy: "month_number",
     };
   }
 

tests/figures/chart/calendar/calendar_chart_plugin.test.ts

@@ -174,6 +174,8 @@ describe("calendar chart", () => {
       legendPosition: "left",
       labelRange: "Sheet1!A1:A4",
       showValues: false,
+      horizontalGroupBy: "day_of_week",
+      verticalGroupBy: "month_number",
       axesDesign: {},
     });
   });

tests/test_helpers/commands_helpers.ts

@@ -241,6 +241,8 @@ export function createChart(
     cumulative: ("cumulative" in data && data.cumulative) || false,
     showSubTotals: ("showSubTotals" in data && data.showSubTotals) || false,
     showConnectorLines: ("showConnectorLines" in data && data.showConnectorLines) || false,
+    horizontalGroupBy: ("horizontalGroupBy" in data && data.horizontalGroupBy) || "day_of_week",
+    verticalGroupBy: ("verticalGroupBy" in data && data.verticalGroupBy) || "month_number",
   };
   return model.dispatch("CREATE_CHART", {
     figureId: figureData.figureId || model.uuidGenerator.smallUuid(),
@@ -349,8 +351,8 @@ export function createCalendarChart(
       labelRange: data.labelRange,
       type: "calendar",
       background: data.background,
-      horizontalGroupBy: data.horizontalGroupBy,
-      verticalGroupBy: data.verticalGroupBy,
+      horizontalGroupBy: data.horizontalGroupBy ?? "day_of_week",
+      verticalGroupBy: data.verticalGroupBy ?? "month_number",
       legendPosition: data.legendPosition || "top",
       colorScale: data.colorScale,
     },