ROU-11649: Implemented RemoveColumnsFromGroupPanel API (#447)

* Implemented RemoveColumnsFromGroupPanel APIs

* Fixed typo on addColumnsToGroupPanel comment

Author: gnbm

package.json

@@ -30,7 +30,7 @@
     "UI Components"
   ],
   "devDependencies": {
-    "@types/lodash": "^4.17.6",
+    "@types/lodash": "^4.17.15",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "browser-sync": "^3.0.2",

src/OSFramework/DataGrid/Enum/ErrorCodes.ts

@@ -83,6 +83,7 @@ namespace OSFramework.DataGrid.Enum {
 		API_FailedSetColumnWordWrap = 'GRID-API-10008',
 		API_FailedSetColumnHeader = 'GRID-API-10009',
 		API_FailedSetNumberAggregateConditionalFormatting = 'GRID-API-10010',
+		API_FailedRemoveColumnsFromGroupPanel = 'GRID-API-10011',
 		//EXPORT
 		API_FailedCustomizeExportingMessage = 'GRID-API-11001',
 		//COLUMNPICKER

src/OSFramework/DataGrid/Feature/IGroupPanel.ts

@@ -4,7 +4,7 @@ namespace OSFramework.DataGrid.Feature {
 		/** Boolean that indicates whether the grid is grouped or not */
 		isGridGrouped: boolean;
 		/**
-		 * Add a given column to the grid group panel
+		 * Add a given column or columns list to the grid group panel
 		 * @param binding binding of the column
 		 */
 		addColumnsToGroupPanel(binding: string): void;
@@ -13,6 +13,11 @@ namespace OSFramework.DataGrid.Feature {
 		 * @param binding binding of the column
 		 */
 		columnInGroupPanel(binding: string): boolean;
+		/**
+		 * Remove a given column or columns list from the grid group panel
+		 * @param binding binding of the column
+		 */
+		removeColumnsFromGroupPanel(binding: string): void;
 		/**
 		 * Sets the column aggregation function inside the Group Panel
 		 * @param binding binding of the column

src/OutSystems/GridAPI/ColumnManager.ts

@@ -3,11 +3,11 @@ namespace OutSystems.GridAPI.ColumnManager {
 	const columnArr = new Array<OSFramework.DataGrid.Column.IColumn>();
 
 	/**
-	 * Add a given column to the grid group panel.
+	 * Add a given column or columns list to the grid group panel.
 	 *
 	 * @export
 	 * @param {string} gridID ID of the Grid where the change will occur.
-	 * @param {string} columnID ID of the Column block that will be programmatically added to the grid group panel.
+	 * @param {string} ListOfColumnIDs List of Ids of the Column blocks that will be programmatically added to the grid group panel.
 	 */
 	export function AddColumnsToGroupPanel(gridID: string, ListOfColumnIDs: string): string {
 		Performance.SetMark('ColumnManager.AddColumnToGroupPanel');
@@ -144,7 +144,7 @@ namespace OutSystems.GridAPI.ColumnManager {
 		Performance.SetMark('ColumnManager.changeProperty');
 
 		const column = GetColumnById(columnID);
-		if(column === undefined){
+		if (column === undefined) {
 			throw new Error(OSFramework.DataGrid.Enum.ErrorMessages.Column_NotFound);
 		}
 
@@ -188,6 +188,33 @@ namespace OutSystems.GridAPI.ColumnManager {
 		);
 	}
 
+	/**
+	 * Remove a given column or columns list from the grid group panel
+	 *
+	 * @export
+	 * @param {string} gridID ID of the Grid where the change will occur.
+	 * @param {string} ListOfColumnIDs List of Ids of the Column blocks that will be programmatically removed from the grid group panel.
+	 */
+	export function RemoveColumnsFromGroupPanel(gridID: string, ListOfColumnIDs: string): string {
+		Performance.SetMark('ColumnManager.RemoveColumnsFromGroupPanel');
+		const result = Auxiliary.CreateApiResponse({
+			gridID,
+			errorCode: OSFramework.DataGrid.Enum.ErrorCodes.API_FailedRemoveColumnsFromGroupPanel,
+			callback: () => {
+				GridManager.GetGridById(gridID).features.groupPanel.removeColumnsFromGroupPanel(ListOfColumnIDs);
+			},
+		});
+
+		Performance.SetMark('ColumnManager.RemoveColumnsFromGroupPanel-end');
+		Performance.GetMeasure(
+			'@datagrid-ColumnManager.RemoveColumnsFromGroupPanell',
+			'ColumnManager.RemoveColumnsFromGroupPanel',
+			'ColumnManager.RemoveColumnsFromGroupPanel-end'
+		);
+
+		return result;
+	}
+
 	/**
 	 * Set column aggregate in group panel
 	 *

src/Providers/DataGrid/Wijmo/Features/GroupPanel.ts

@@ -161,6 +161,36 @@ namespace Providers.DataGrid.Wijmo.Feature {
 			});
 		}
 
+		public removeColumnsFromGroupPanel(bindingList: string): void {
+			const groupDescriptions = this._grid.provider.collectionView.groupDescriptions; // Group array
+			const columnList = JSON.parse(bindingList);
+			const source = this._grid.provider.itemsSource;
+
+			source.deferUpdate(() => {
+				for (const binding of columnList) {
+					const column = this._grid.getColumn(binding);
+					if (column) {
+						// Find the index of the group description for the column's binding
+						const index = groupDescriptions.findIndex((gd) => {
+							if (gd instanceof wijmo.collections.PropertyGroupDescription) {
+								return gd.propertyName === column.config.binding;
+							}
+							return false;
+						});
+
+						// If the group description exists, remove it
+						if (index > -1) {
+							groupDescriptions.splice(index, 1);
+							// Make the column visible again
+							column.provider.visible = true;
+						}
+					} else {
+						throw new Error(OSFramework.DataGrid.Enum.ErrorMessages.InvalidColumnIdentifier);
+					}
+				}
+			});
+		}
+
 		public setAggregate(binding: string, aggregate: wijmo.Aggregate): void {
 			const column = this._grid.getColumn(binding);