@refinitiv-ui/efx-grid 6.1.29 → 6.1.30

package/lib/grid/index.js

@@ -1,3 +1,3 @@
 import {Grid} from "./lib/efx-grid.js";
 export {Grid}
-window.EFX_GRID = { version: "6.1.29" };
+window.EFX_GRID = { version: "6.1.30" };

package/lib/tr-grid-row-grouping/es6/RowGrouping.d.ts

@@ -47,6 +47,18 @@ declare namespace RowGroupingPlugin {
         groupId?: (number|string)|null
     };
 
+    type GroupedRowInfo = {
+        rowId: string,
+        parentRowId: string,
+        header: boolean,
+        groupLevel: number,
+        collapsed: boolean,
+        groupId?: string|null,
+        groupValue?: any,
+        hidden: boolean,
+        rowData: any
+    };
+
 }
 
 declare class RowGroupingPlugin extends GridPlugin {
@@ -115,6 +127,8 @@ declare class RowGroupingPlugin extends GridPlugin {
 
     public getFooterRowCount(): number;
 
+    public getGroupedRows(): (RowGroupingPlugin.GroupedRowInfo)[]|null;
+
 }
 
 declare function isNonFunction(obj: any): boolean;

package/lib/tr-grid-row-grouping/es6/RowGrouping.js

@@ -121,6 +121,19 @@ import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 * @property {(number|string)=} groupId
 */
 
+/** @typedef {Object} RowGroupingPlugin~GroupedRowInfo
+* @description Represents a single row within a grouped. A row may be a group header or a normal data row.
+* @property {string} rowId A unique identifier for this row. Used for tracking, rendering, and updates.
+* @property {string} parentRowId A unique identifier for parent row.
+* @property {boolean} header Indicates whether the row is a group header (true) or a regular data row (false).
+* @property {number} groupLevel The zero‑based depth of the row within the grouping hierarchy. Level 0 represents a top‑level group or row.
+* @property {boolean} collapsed The local collapsed state for this row if it is a group header. For content row, this will always be false
+* @property {string=} groupId Identifier for the group represented by this row.
+* @property {*=} groupValue The grouping key or value associated with this row.
+* @property {boolean} hidden Whether this row is currently hidden from view. Usually derived from the collapsed states of ancestor rows or filtering logic.
+* @property {Object} rowData The underlying data record associated with this row. For header rows, this will always be null.
+*/
+
 /** Creates groups based on the given criteria. Group should appears in order of data in the data view. Use {@link RowGroupingPlugin#sortGroups} to re-order groups manually.
 * @constructor
 * @extends {GridPlugin}
@@ -1761,6 +1774,77 @@ RowGroupingPlugin.prototype.getFooterRowCount = function () {
 	return this._footerRows;
 };
 
+/** @public
+* @description
+* Returns a complete list of row information objects currently managed by the
+* grid’s grouping system. The returned array includes both group header rows
+* and regular data rows, in the same order they appear within the grouped structure.
+* @return {Array.<RowGroupingPlugin~GroupedRowInfo>}
+*/
+RowGroupingPlugin.prototype.getGroupedRows = function () {
+	let dv = this.getDataView();
+	if (!dv) {
+		return null;
+	}
+	let ary = [];
+	let groupList = dv.hasGroup() ? dv.getAllGroups() : [dv];
+	let groupCount = groupList.length;
+	let visibilityStack = [true];
+	let rowIdStack = [''];
+	for(let i = 0; i < groupCount; ++i) {
+		let groupDv = groupList[i];
+		let groupRowId = groupDv.getGroupRowId();
+		let groupLevel = groupDv.getGroupLevel();
+		let effectiveVisibility = true;
+		let parentRowId = '';
+		if(groupLevel > 0) { // Only non root groups are included in the output
+			// visibility of a group is always derived from its parent and ancestors' collapsed states
+			effectiveVisibility = visibilityStack[groupLevel - 1];
+			parentRowId = rowIdStack[groupLevel - 1];
+			if(groupLevel + 1 >= visibilityStack.length) {
+				visibilityStack[groupLevel] = effectiveVisibility && !groupDv.isCollapsed();
+				rowIdStack[groupLevel] = groupRowId;
+			} else {
+				do {
+					visibilityStack.pop();
+					rowIdStack.pop();
+				} while(groupLevel + 1 < visibilityStack.length);
+			}
+
+			ary.push({
+				"rowId": groupRowId,
+				"parentRowId": parentRowId,
+				"header": true,
+				"groupLevel": groupLevel,
+				"collapsed": groupDv.isCollapsed(),
+				"groupId": groupDv.getGroupId(), // Group header specific info
+				"groupValue": groupDv.getGroupValue(), // Group header specific info
+				"hidden": !effectiveVisibility || dv.isRowFiltered(groupRowId),
+				"rowData": null
+			});
+		}
+		if(!groupDv.hasGroup()) { // If this is a leaf group, add its row members
+			let rowIds = groupDv.getSortedRowIds(true);
+			let rowCount = rowIds.length;
+			effectiveVisibility = visibilityStack[groupLevel];
+			for(let r = 0; r < rowCount; ++r) {
+				let rowId = rowIds[r];
+				let rowData = this._rowGetter(dv.getRowData(rowId));
+				ary.push({
+					"rowId": rowId,
+					"parentRowId": groupRowId,
+					"header": false,
+					"groupLevel": groupLevel + 1,
+					"collapsed": false,
+					"hidden": !effectiveVisibility || dv.isRowFiltered(rowId, rowData),
+					"rowData": rowData
+				});
+			}
+		}
+	}
+	return ary;
+};
+
 /** @function
 * @param {Object} obj
 * @return {boolean}

package/lib/types/es6/HeatMap.d.ts

@@ -11,8 +11,10 @@ declare namespace HeatMapPlugin {
     };
 
     type HeatMap = {
+        mode?: string|null,
         midPoint?: number|null,
-        mode?: string|null
+        min?: number|null,
+        max?: number|null
     };
 
 }
@@ -35,11 +37,13 @@ declare class HeatMapPlugin extends GridPlugin {
 
     public setColumnHeatMap(colIndex: number, columnDef: any, opt_grid?: any): void;
 
+    public _getColumnHeatMapOptions(hm: any, options?: any): boolean;
+
     public getColumnHeatMapOptions(colIndex: number, options?: any): any;
 
 }
 
-declare function cond(colIndex: number, options?: any): any;
+declare function hmMode(hm: any, options?: any): boolean;
 
 export default HeatMapPlugin;
 export { HeatMapPlugin, HeatMapPlugin as HeatMap, HeatMapPlugin as HeatMapExtension };

package/lib/types/es6/RowGrouping.d.ts

@@ -47,6 +47,18 @@ declare namespace RowGroupingPlugin {
         groupId?: (number|string)|null
     };
 
+    type GroupedRowInfo = {
+        rowId: string,
+        parentRowId: string,
+        header: boolean,
+        groupLevel: number,
+        collapsed: boolean,
+        groupId?: string|null,
+        groupValue?: any,
+        hidden: boolean,
+        rowData: any
+    };
+
 }
 
 declare class RowGroupingPlugin extends GridPlugin {
@@ -115,6 +127,8 @@ declare class RowGroupingPlugin extends GridPlugin {
 
     public getFooterRowCount(): number;
 
+    public getGroupedRows(): (RowGroupingPlugin.GroupedRowInfo)[]|null;
+
 }
 
 declare function isNonFunction(obj: any): boolean;

package/lib/versions.json

@@ -25,7 +25,7 @@
 	"tr-grid-range-bar": "2.0.9",
 	"tr-grid-row-dragging": "1.0.39",
 	"tr-grid-row-filtering": "1.0.90",
-	"tr-grid-row-grouping": "1.0.91",
+	"tr-grid-row-grouping": "1.0.93",
 	"tr-grid-row-selection": "1.0.33",
 	"tr-grid-rowcoloring": "1.0.26",
 	"tr-grid-textformatting": "1.0.49",

package/package.json

@@ -77,5 +77,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.1.29"
+	"version": "6.1.30"
 }