@refinitiv-ui/efx-grid 6.0.24 → 6.0.25

package/lib/core/es6/grid/Core.d.ts

@@ -1,4 +1,5 @@
 import Ext from "../../../tr-grid-util/es6/Ext.js";
+import GroupDefinitions from "../../../tr-grid-util/es6/GroupDefinitions.js"; // eslint-disable-line
 import ElementWrapper from "./components/ElementWrapper.js";
 import ILayoutGrid from "./ILayoutGrid.js"; // eslint-disable-line
 import LayoutGrid from "./LayoutGrid.js";
@@ -382,6 +383,16 @@ declare class Core extends ElementWrapper {
 
     public normalizeConfig(configObj: any): any;
 
+    public setColumnGrouping(groupDefs: GroupDefinitions|null): void;
+
+    public getColumnGroupParentId(colRef: string|number|null): string;
+
+    public getColumnGroupChildIds(groupId: string): (string)[]|null;
+
+    public getColumnId(colIndex: number): string;
+
+    public getColumnIds(): (string)[];
+
 }
 
 declare function num(opt_type?: string|null): (ILayoutGrid)[];

package/lib/core/es6/grid/Core.js

@@ -1,4 +1,5 @@
 import Ext from "../../../tr-grid-util/es6/Ext.js";
+import GroupDefinitions from "../../../tr-grid-util/es6/GroupDefinitions.js"; // eslint-disable-line
 import ElementWrapper from "./components/ElementWrapper.js";
 import ILayoutGrid from "./ILayoutGrid.js"; // eslint-disable-line
 import LayoutGrid from "./LayoutGrid.js";
@@ -74,6 +75,9 @@ var Core = function (opt_initializer) {
 	var _t = this;
 
 	// Initialize method binding
+	_t.getColumnId = _t.getColumnId.bind(_t);
+	_t.getColumnIndex = _t.getColumnIndex.bind(_t);
+
 	_t._onMouseMove = _t._onMouseMove.bind(_t);
 	_t._onRowHightlighted = _t._onRowHightlighted.bind(_t);
 
@@ -521,6 +525,10 @@ Core.prototype._preserveGridSize = false;
 * @private
 */
 Core.prototype._rowHeightTimerId = 0;
+/** @type {GroupDefinitions}
+* @private
+*/
+Core.prototype._groupDefs = null;
 //#region Public Methods
 
 /**
@@ -528,7 +536,7 @@ Core.prototype._rowHeightTimerId = 0;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.32";
+	return "5.1.34";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -1656,7 +1664,7 @@ Core.prototype._moveColumn = function (fromCol, destCol) {
 		vEnd = this._colVirtualizer.getLastIndexInView();
 	}
 
-	var colId = this._getColumnId(fromCol);
+	var colId = this.getColumnId(fromCol);
 	this._layoutX.moveLane(fromCol, destCol);
 	var sectionCount = this._settings.length;
 	for (var i = 0; i < sectionCount; ++i) {
@@ -1776,6 +1784,11 @@ Core.prototype._deserializeColumn = function (index, jsonObj) {
 	// TODO: Load specific styles for each column type (e.g. "content", "title", "header")
 
 	var colDef = this._getColumnDef(index);
+	var colId = jsonObj["id"];
+	if(colId && typeof colId === "string") {
+		colDef["id"] = colId; // WARNING: We do not guarantee uniqueness of user id
+	}
+
 	var value = jsonObj["dataColumnName"];
 	if (value != null) {
 		colDef["dataColumnName"] = value;
@@ -3219,14 +3232,19 @@ Core.prototype.getRelativePosition = function (obj, context) {
 	return ret_obj;
 };
 
-/** @public
-* @param {string} str data column name
-* @return {number} Return negative if the mouse is not hit
+/** Find column index by column id or data column name
+* @public
+* @param {string} str Column id or data column name
+* @return {number} Return negative value if there is no match
 */
 Core.prototype.getColumnIndex = function (str) {
-	for(var c = this.getColumnCount(); --c >= 0;) {
-		if(str === this.getDataColumnName(c)) {
-			return c;
+	if(str) {
+		var colCount = this.getColumnCount();
+		for(var c = 0; c < colCount; ++c) {
+			var colDef = this._getColumnDef(c);
+			if(str === colDef["id"] || str === colDef["dataColumnName"]) {
+				return c;
+			}
 		}
 	}
 	return -1;
@@ -4111,6 +4129,37 @@ Core.prototype.normalizeConfig = function (configObj) {
 
 	return configObj;
 };
+/** @public
+* @param {GroupDefinitions} groupDefs
+*/
+Core.prototype.setColumnGrouping = function (groupDefs) {
+	this._groupDefs = groupDefs || null;
+};
+/** @public
+* @param {string|number} colRef
+* @return {string} Return group id of immediate group parent. Return empty string, if no parent is found.
+*/
+Core.prototype.getColumnGroupParentId = function (colRef) {
+	if(this._groupDefs) {
+		var colId = (typeof colRef === "number") ? this.getColumnId(colRef) : colRef;
+		return this._groupDefs.getParentId(colId);
+	}
+	return "";
+};
+
+/** @public
+* @param {string} groupId
+* @return {Array.<string>} Return array of column id. Return null if the specified group has no child
+*/
+Core.prototype.getColumnGroupChildIds = function (groupId) {
+	if(this._groupDefs) {
+		var ary = this._groupDefs.getLeafDescendants(groupId);
+		if(ary && ary.length > 0) {
+			return ary;
+		}
+	}
+	return null;
+};
 //#endregion Public Methods
 
 //#region Private Methods
@@ -4768,13 +4817,35 @@ Core.prototype._getNestedColumnDef = function (colIndex, firstLvl, secondLvl) {
 	}
 	return def;
 };
+
 /** @public
+* @param {number} colIndex
+* @return {string} Return empty string if the specified column does not exist
+*/
+Core.prototype.getColumnId = function (colIndex) {
+	if(colIndex >= 0 && colIndex < this.getColumnCount()) {
+		return this._getColumnDef(colIndex)["id"] || "";
+	}
+	return "";
+};
+/** @deprecated
+* @public
+* @function
 * @ignore
 * @param {number} colIndex
 * @return {string}
 */
-Core.prototype._getColumnId = function (colIndex) {
-	return this._getColumnDef(colIndex)["id"];
+Core.prototype._getColumnId = Core.prototype.getColumnId;
+/** @public
+* @return {!Array.<string>} Return all column ids from existing column
+*/
+Core.prototype.getColumnIds = function () {
+	var colCount = this.getColumnCount();
+	var ary = new Array(colCount);
+	for(var c = 0; c < colCount; ++c) {
+		ary[c] = this._getColumnDef(c)["id"] || "";
+	}
+	return ary;
 };
 
 

package/lib/grid/index.js

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