[IMP] pivot: add menu items to collapse/expand all groups

src/components/icons/icons.xml

@@ -1024,4 +1024,12 @@
       />
     </svg>
   </t>
+  <t t-name="o-spreadsheet-Icon.COLLAPSE">
+    <svg class="o-icon" viewBox="0 0 18 18">
+      <path
+        d="M12.124 2.576a.6.6 0 0 1 0 .848l-2.7 2.7a.6.6 0 0 1-.848 0l-2.7-2.7a.6.6 0 0 1 .848-.848L8.4 4.2V.9a.6.6 0 0 1 1.2 0v3.3l1.676-1.624a.6.6 0 0 1 .848 0M5.876 15.424a.6.6 0 0 1 0-.848l2.7-2.7a.6.6 0 0 1 .848 0l2.7 2.7a.6.6 0 0 1-.848.848L9.6 13.8v3.3a.6.6 0 0 1-1.2 0v-3.3l-1.676 1.624a.6.6 0 0 1-.848 0M2 7a.5.5 0 0 0 0 1h14a.5.5 0 0 0 0-1M2 10a.5.5 0 0 0 0 1h14a.5.5 0 0 0 0-1"
+        fill="currentColor"
+      />
+    </svg>
+  </t>
 </templates>

src/components/menu/menu.ts

@@ -58,7 +58,10 @@ export class Menu extends Component<MenuProps, SpreadsheetChildEnv> {
     const menuItemsAndSeparators: MenuItemOrSeparator[] = [];
     for (let i = 0; i < this.props.menuItems.length; i++) {
       const menuItem = this.props.menuItems[i];
-      if (menuItem.isVisible(this.env)) {
+      if (
+        menuItem.isVisible(this.env) &&
+        (!this.isRoot(menuItem) || this.hasVisibleChildren(menuItem))
+      ) {
         menuItemsAndSeparators.push(menuItem);
       }
       if (
@@ -109,6 +112,10 @@ export class Menu extends Component<MenuProps, SpreadsheetChildEnv> {
     return !menu.execute;
   }
 
+  private hasVisibleChildren(menu: Action) {
+    return menu.children(this.env).some((child) => child.isVisible(this.env));
+  }
+
   isEnabled(menu: Action) {
     if (menu.isEnabled(this.env)) {
       return this.env.model.getters.isReadonly() ? menu.isReadonlyAllowed : true;

src/helpers/pivot/pivot_helpers.ts

@@ -12,13 +12,15 @@ import {
 import { Registry } from "../../registries/registry";
 import { _t } from "../../translation";
 import {
+  CellPosition,
   CellValue,
   DEFAULT_LOCALE,
   FunctionResultObject,
   Locale,
   Matrix,
   Maybe,
   Pivot,
+  SpreadsheetChildEnv,
 } from "../../types";
 import { EvaluationError } from "../../types/errors";
 import {
@@ -33,7 +35,7 @@ import {
   PivotSortedColumn,
   PivotTableCell,
 } from "../../types/pivot";
-import { getUniqueText, isDefined } from "../misc";
+import { deepEquals, getUniqueText, isDefined } from "../misc";
 import { PivotRuntimeDefinition } from "./pivot_runtime_definition";
 import { pivotTimeAdapter } from "./pivot_time_adapter";
 
@@ -422,3 +424,31 @@ export function getCustomFieldWithParentField(
     }
   );
 }
+
+export function togglePivotCollapse(position: CellPosition, env: SpreadsheetChildEnv) {
+  const pivotCell = env.model.getters.getPivotCellFromPosition(position);
+  const pivotId = env.model.getters.getPivotIdFromPosition(position);
+  if (!pivotId || pivotCell.type !== "HEADER") {
+    return;
+  }
+  const definition = env.model.getters.getPivotCoreDefinition(pivotId);
+
+  const collapsedDomains = definition.collapsedDomains?.[pivotCell.dimension]
+    ? [...definition.collapsedDomains[pivotCell.dimension]]
+    : [];
+  const index = collapsedDomains.findIndex((domain) => deepEquals(domain, pivotCell.domain));
+  if (index !== -1) {
+    collapsedDomains.splice(index, 1);
+  } else {
+    collapsedDomains.push(pivotCell.domain);
+  }
+
+  const newDomains = definition.collapsedDomains
+    ? { ...definition.collapsedDomains }
+    : { COL: [], ROW: [] };
+  newDomains[pivotCell.dimension] = collapsedDomains;
+  env.model.dispatch("UPDATE_PIVOT", {
+    pivotId,
+    pivot: { ...definition, collapsedDomains: newDomains },
+  });
+}

src/helpers/pivot/pivot_menu_items.ts

@@ -5,23 +5,26 @@ import {
   PivotCoreDefinition,
   PivotCustomGroup,
   PivotCustomGroupedField,
+  PivotDomain,
   PivotField,
   PivotFields,
   PivotHeaderCell,
   SortDirection,
   SpreadsheetChildEnv,
+  UID,
 } from "../..";
 import { ActionSpec } from "../../actions/action";
 import { _t } from "../../translation";
 import { CellValueType } from "../../types";
-import { deepCopy } from "../misc";
+import { deepCopy, deepEquals } from "../misc";
 import { cellPositions } from "../zones";
 import { domainToColRowDomain } from "./pivot_domain_helpers";
 import {
   addDimensionToPivotDefinition,
   getCustomFieldWithParentField,
   getUniquePivotGroupName,
   removePivotGroupsContainingValues,
+  togglePivotCollapse,
 } from "./pivot_helpers";
 import { pivotRegistry } from "./pivot_registry";
 
@@ -209,6 +212,145 @@ export const ungroupPivotHeadersAction: ActionSpec = {
   },
 };
 
+export const toggleCollapsePivotGroupAction: ActionSpec = {
+  name: (env) => {
+    const position = env.model.getters.getActivePosition();
+    const pivotCellState = getPivotCellCollapseState(env.model.getters, position);
+    if (pivotCellState.isPivotGroup) {
+      return pivotCellState.isCollapsed ? _t("Expand") : _t("Collapse");
+    }
+    return "";
+  },
+  execute(env) {
+    const position = env.model.getters.getActivePosition();
+    togglePivotCollapse(position, env);
+  },
+  isVisible: (env) => {
+    const position = env.model.getters.getActivePosition();
+    const pivotCellState = getPivotCellCollapseState(env.model.getters, position);
+    return pivotCellState.isPivotGroup;
+  },
+};
+
+export const collapseAllPivotGroupAction: ActionSpec = {
+  name: _t("Collapse all"),
+  execute(env) {
+    const position = env.model.getters.getActivePosition();
+    const pivotCellState = getPivotCellCollapseState(env.model.getters, position);
+    if (!pivotCellState.isPivotGroup) {
+      return;
+    }
+    const { pivotCell, pivotId, siblingDomains } = pivotCellState;
+
+    const definition = deepCopy(env.model.getters.getPivotCoreDefinition(pivotId));
+    definition.collapsedDomains = definition.collapsedDomains || { COL: [], ROW: [] };
+    const newCollapsed = [
+      ...(definition.collapsedDomains[pivotCell.dimension] || []),
+      ...siblingDomains,
+    ];
+
+    const filteredCollapsed = newCollapsed.filter(
+      (domain, index) => index === newCollapsed.findIndex((d) => deepEquals(d, domain))
+    );
+
+    definition.collapsedDomains[pivotCell.dimension] = filteredCollapsed;
+    env.model.dispatch("UPDATE_PIVOT", { pivotId, pivot: definition });
+  },
+  isVisible: (env) => {
+    const position = env.model.getters.getActivePosition();
+    const pivotCellState = getPivotCellCollapseState(env.model.getters, position);
+    if (!pivotCellState.isPivotGroup) {
+      return false;
+    }
+
+    const { pivotCell, pivotId, siblingDomains } = pivotCellState;
+    const definition = env.model.getters.getPivotCoreDefinition(pivotId);
+
+    return !siblingDomains.every((domain) =>
+      (definition.collapsedDomains?.[pivotCell.dimension] || []).some((d) => deepEquals(d, domain))
+    );
+  },
+};
+
+export const expandAllPivotGroupAction: ActionSpec = {
+  name: _t("Expand all"),
+  execute(env) {
+    const position = env.model.getters.getActivePosition();
+    const pivotCellState = getPivotCellCollapseState(env.model.getters, position);
+    if (!pivotCellState.isPivotGroup) {
+      return;
+    }
+    const { pivotCell, pivotId, siblingDomains } = pivotCellState;
+
+    const definition = deepCopy(env.model.getters.getPivotCoreDefinition(pivotId));
+    definition.collapsedDomains = definition.collapsedDomains || { COL: [], ROW: [] };
+
+    const domains = definition.collapsedDomains[pivotCell.dimension] || [];
+    const filteredDomains = domains.filter(
+      (domain) => !siblingDomains.find((d) => deepEquals(d, domain))
+    );
+
+    definition.collapsedDomains[pivotCell.dimension] = filteredDomains;
+    env.model.dispatch("UPDATE_PIVOT", { pivotId, pivot: definition });
+  },
+  isVisible: (env) => {
+    const position = env.model.getters.getActivePosition();
+    const pivotCellState = getPivotCellCollapseState(env.model.getters, position);
+    if (!pivotCellState.isPivotGroup) {
+      return false;
+    }
+
+    const { pivotCell, pivotId, siblingDomains } = pivotCellState;
+    const definition = env.model.getters.getPivotCoreDefinition(pivotId);
+    const collapsedDomains = definition.collapsedDomains?.[pivotCell.dimension] || [];
+    return collapsedDomains.some((domain) => siblingDomains.some((d) => deepEquals(d, domain)));
+  },
+};
+
+function getPivotCellCollapseState(
+  getters: Getters,
+  position: CellPosition
+):
+  | { isPivotGroup: false }
+  | {
+      isPivotGroup: true;
+      isCollapsed: boolean;
+      pivotCell: PivotHeaderCell;
+      pivotId: UID;
+      siblingDomains: PivotDomain[];
+    } {
+  if (!getters.isSpillPivotFormula(position)) {
+    return { isPivotGroup: false };
+  }
+  const pivotCell = getters.getPivotCellFromPosition(position);
+  const pivotId = getters.getPivotIdFromPosition(position);
+
+  if (pivotCell.type !== "HEADER" || !pivotId || !pivotCell.domain.length) {
+    return { isPivotGroup: false };
+  }
+  const definition = getters.getPivotCoreDefinition(pivotId);
+  const isDashboard = getters.isDashboard();
+
+  const fields = pivotCell.dimension === "COL" ? definition.columns : definition.rows;
+  const hasIcon = !isDashboard && pivotCell.domain.length !== fields.length;
+  if (!hasIcon) {
+    return { isPivotGroup: false };
+  }
+
+  const domains = definition.collapsedDomains?.[pivotCell.dimension] ?? [];
+  const isCollapsed = domains.some((domain) => deepEquals(domain, pivotCell.domain));
+
+  const pivot = getters.getPivot(pivotId);
+  const table = pivot.getExpandedTableStructure();
+  const depth = pivotCell.domain.length - 1;
+  const siblingDomains =
+    pivotCell.dimension === "ROW"
+      ? table.getRowDomainsAtDepth(depth)
+      : table.getColumnDomainsAtDepth(depth);
+
+  return { isPivotGroup: true, isCollapsed, pivotCell, pivotId, siblingDomains };
+}
+
 export function canSortPivot(getters: Getters, position: CellPosition): boolean {
   const pivotId = getters.getPivotIdFromPosition(position);
   if (!pivotId || !getters.isExistingPivot(pivotId) || !getters.isSpillPivotFormula(position)) {

src/helpers/pivot/table_spreadsheet_pivot.ts

@@ -410,6 +410,20 @@ export class SpreadsheetPivotTable {
   get numberOfCells() {
     return this.rows.length * this.getNumberOfDataColumns();
   }
+
+  getColumnDomainsAtDepth(depth: number) {
+    if (depth < 0 || depth >= this.columns.length - 1) {
+      return [];
+    }
+    return this.columns[depth].map((col) => this.getDomain(col)).filter((d) => d.length);
+  }
+
+  getRowDomainsAtDepth(depth: number) {
+    if (depth < 0 || depth > this.maxIndent) {
+      return [];
+    }
+    return this.rows.filter((row) => row.indent === depth + 1).map((row) => this.getDomain(row));
+  }
 }
 
 export const EMPTY_PIVOT_CELL = { type: "EMPTY" } as const;

src/registries/icons_on_cell_registry.ts

@@ -20,6 +20,7 @@ import {
   PIVOT_INDENT,
 } from "../constants";
 import { computeTextFontSizeInPixels, deepEquals, relativeLuminance } from "../helpers";
+import { togglePivotCollapse } from "../helpers/pivot/pivot_helpers";
 import { Align, CellPosition, Getters, SpreadsheetChildEnv } from "../types";
 import { ImageSVG } from "../types/image";
 import { Registry } from "./registry";
@@ -206,34 +207,6 @@ iconsOnCellRegistry.add("pivot_collapse", (getters, position) => {
   return undefined;
 });
 
-function togglePivotCollapse(position: CellPosition, env: SpreadsheetChildEnv) {
-  const pivotCell = env.model.getters.getPivotCellFromPosition(position);
-  const pivotId = env.model.getters.getPivotIdFromPosition(position);
-  if (!pivotId || pivotCell.type !== "HEADER") {
-    return;
-  }
-  const definition = env.model.getters.getPivotCoreDefinition(pivotId);
-
-  const collapsedDomains = definition.collapsedDomains?.[pivotCell.dimension]
-    ? [...definition.collapsedDomains[pivotCell.dimension]]
-    : [];
-  const index = collapsedDomains.findIndex((domain) => deepEquals(domain, pivotCell.domain));
-  if (index !== -1) {
-    collapsedDomains.splice(index, 1);
-  } else {
-    collapsedDomains.push(pivotCell.domain);
-  }
-
-  const newDomains = definition.collapsedDomains
-    ? { ...definition.collapsedDomains }
-    : { COL: [], ROW: [] };
-  newDomains[pivotCell.dimension] = collapsedDomains;
-  env.model.dispatch("UPDATE_PIVOT", {
-    pivotId,
-    pivot: { ...definition, collapsedDomains: newDomains },
-  });
-}
-
 iconsOnCellRegistry.add("pivot_dashboard_sorting", (getters, position) => {
   if (!getters.isDashboard()) {
     return undefined;

src/registries/menus/cell_menu_registry.ts

@@ -122,6 +122,23 @@ cellMenuRegistry
     icon: "o-spreadsheet-Icon.MINUS_IN_BOX",
     ...ACTIONS_PIVOT.ungroupPivotHeadersAction,
   })
+  .add("collapse_pivot", {
+    sequence: 156,
+    name: _t("Expand/Collapse"),
+    icon: "o-spreadsheet-Icon.COLLAPSE",
+  })
+  .addChild("toggle_collapse_pivot_cell", ["collapse_pivot"], {
+    sequence: 10,
+    ...ACTIONS_PIVOT.toggleCollapsePivotGroupAction,
+  })
+  .addChild("collapse_all_pivot", ["collapse_pivot"], {
+    sequence: 20,
+    ...ACTIONS_PIVOT.collapseAllPivotGroupAction,
+  })
+  .addChild("expand_all_pivot", ["collapse_pivot"], {
+    sequence: 30,
+    ...ACTIONS_PIVOT.expandAllPivotGroupAction,
+  })
   .add("pivot_sorting", {
     name: _t("Sort pivot"),
     sequence: 155,