@refinitiv-ui/efx-grid 6.0.91 → 6.0.93

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.d.ts

@@ -1,8 +1,7 @@
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
-import { cloneObject } from "../../tr-grid-util/es6/Util.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
-import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { cloneObject, injectCss, prettifyCss, deepEqual } from "../../tr-grid-util/es6/Util.js";
 
 declare namespace ColumnGroupingPlugin {
 
@@ -39,6 +38,8 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public renderGroups(): void;
 
+    public getMutualGroupId(colRefs: (string|number)[]|null): string;
+
     public addColumnToGroup(column: any, groupId: string, colIndex: number): void;
 
     public addGroup(groupDef: ColumnGroupingPlugin.GroupDefinition|null): string;

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.js

@@ -1,8 +1,7 @@
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
-import { cloneObject } from "../../tr-grid-util/es6/Util.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
-import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { cloneObject, injectCss, prettifyCss, deepEqual } from "../../tr-grid-util/es6/Util.js";
 
 /** @typedef {Array<ColumnGroupingPlugin~GroupDefinition>} ColumnGroupingPlugin~Options
 * @description This options can be specified by `columnGrouping` property of the main grid's options or extension options.
@@ -173,8 +172,8 @@ ColumnGroupingPlugin._cloneObject = function (obj) {
 */
 ColumnGroupingPlugin._flattenGroupDefs = function (groupDefs) {
   var grpCount = groupDefs ? groupDefs.length : 0;
-  for (var i = 0; i < grpCount; i++) {
-    ColumnGroupingPlugin._recursivelyFlatten(groupDefs[i], groupDefs);
+  for (var _i = 0; _i < grpCount; _i++) {
+    ColumnGroupingPlugin._recursivelyFlatten(groupDefs[_i], groupDefs);
   }
 };
 /** Flatten group definition structure by using group ID instead of nested group definitions.
@@ -187,13 +186,13 @@ ColumnGroupingPlugin._recursivelyFlatten = function (groupDef, groupDefs) {
   if (groupDef && groupDef.children) {
     var children = groupDef.children;
     var member, groupId;
-    for (var i = 0; i < children.length; i++) {
-      member = children[i];
+    for (var _i2 = 0; _i2 < children.length; _i2++) {
+      member = children[_i2];
       if (typeof member !== "string") {
         // member is nested group definition
         groupId = member.id;
         if (groupId) {
-          children[i] = groupId; // Use group ID instead of nested group definition
+          children[_i2] = groupId; // Use group ID instead of nested group definition
           if (groupDefs.indexOf(member) < 0) {
             groupDefs.push(member);
           }
@@ -431,8 +430,8 @@ ColumnGroupingPlugin.prototype._migrateLegacyStructure = function (groupDefs, co
 */
 ColumnGroupingPlugin.prototype._freezeColumn = function (frozenColIndex, numRightColumn) {
   var hosts = this._hosts;
-  for (var i = 0; i < hosts.length; i++) {
-    hosts[i].freezeColumn(frozenColIndex, numRightColumn);
+  for (var _i3 = 0; _i3 < hosts.length; _i3++) {
+    hosts[_i3].freezeColumn(frozenColIndex, numRightColumn);
   }
 };
 /** @private
@@ -561,8 +560,8 @@ ColumnGroupingPlugin.prototype._setGroupPinning = function (groupDef, side) {
     groupDef.rightPinned = true;
   }
   var children = groupDef["children"];
-  for (var i = 0; i < children.length; i++) {
-    var child = children[i];
+  for (var _i4 = 0; _i4 < children.length; _i4++) {
+    var child = children[_i4];
     var group = this._visibleGroupMap[child];
     if (group) {
       this._setGroupPinning(group, side);
@@ -726,8 +725,8 @@ ColumnGroupingPlugin.prototype._applyNearestGrouping = function (colIndex) {
     }
   }
   if (groupLeftCount && groupRightCount) {
-    for (var i = 0; i < groupLeftCount; i++) {
-      var groupLeftId = groupLeftIds[i];
+    for (var _i5 = 0; _i5 < groupLeftCount; _i5++) {
+      var groupLeftId = groupLeftIds[_i5];
       var sharedParentIdx = groupRightIds.indexOf(groupLeftId);
       if (sharedParentIdx >= 0) {
         this._groupDefs.addGroupChild(groupRightIds[sharedParentIdx], colId);
@@ -808,8 +807,8 @@ ColumnGroupingPlugin.prototype.renderGroups = function () {
   this._groupHeaderTimerId = 0;
   var hostCount = this._hosts.length;
   var groupMap = this._visibleGroupMap;
-  for (var i = 0; i < hostCount; ++i) {
-    var section = this._hosts[i].getSection("title");
+  for (var _i6 = 0; _i6 < hostCount; ++_i6) {
+    var section = this._hosts[_i6].getSection("title");
     if (!section) {
       continue;
     }
@@ -818,6 +817,34 @@ ColumnGroupingPlugin.prototype.renderGroups = function () {
     }
   }
 };
+
+/** @public
+* @param {Array<string|number>} colRefs
+* @return {string} groupId if all the given columns are children of that groupId, otherwise empty string
+*/
+ColumnGroupingPlugin.prototype.getMutualGroupId = function (colRefs) {
+  var colCount = colRefs.length;
+  for (var _i7 = 0; _i7 < colCount; _i7++) {
+    if (typeof colRefs[_i7] === "string") {
+      colRefs[_i7] = this.getColumnIndex(colRefs[_i7]);
+    }
+    var colIndex = colRefs[_i7];
+    var groupIds = this.getGroupIds(colIndex);
+    if (!groupIds) {
+      // If at least 1 column is not part of a group, there is no need to find the groupId.
+      return "";
+    }
+    var groupCount = groupIds.length;
+    for (var j = 0; j < groupCount; j++) {
+      var groupId = groupIds[j];
+      var childrenIndices = this.getChildColumnIndices(groupId);
+      if (deepEqual(childrenIndices, colRefs)) {
+        return groupId;
+      }
+    }
+  }
+  return "";
+};
 /** Render single column group header without affecting cell span.
 * @private
 * @param {Object} groupDef
@@ -834,8 +861,8 @@ ColumnGroupingPlugin.prototype._renderGroup = function (groupDef, section) {
   var isAllSelected = false;
   if (this._selectedColMap) {
     isAllSelected = true;
-    for (var i = 0; i < colIds.length; i++) {
-      if (!this._selectedColMap[colIds[i]]) {
+    for (var _i8 = 0; _i8 < colIds.length; _i8++) {
+      if (!this._selectedColMap[colIds[_i8]]) {
         isAllSelected = false;
         break;
       }
@@ -903,12 +930,13 @@ ColumnGroupingPlugin.prototype._applyTimeSeries = function (e) {
     var children = [];
     var timeSeriesId, timeSeriesName;
     var tsgChild = {};
-    for (var i = 0; i < addingEvents.length; i++) {
+    for (var _i9 = 0; _i9 < addingEvents.length; _i9++) {
       // WARNING: addingEvents column can be difference group
-      var addingEvent = addingEvents[i];
+      var addingEvent = addingEvents[_i9];
       timeSeriesName = addingEvent.context.timeSeriesName;
       timeSeriesId = addingEvent.context.timeSeriesId;
-      var childIndex, childId;
+      var childIndex = void 0,
+        childId = void 0;
       if (!tsgChild[timeSeriesId]) {
         tsgChild[timeSeriesId] = {
           name: timeSeriesName,
@@ -1216,8 +1244,8 @@ ColumnGroupingPlugin.prototype.setGroupName = function (groupId, groupName) {
     if (groupDef) {
       groupDef.name = groupName;
       var hostCount = this._hosts.length;
-      for (var i = 0; i < hostCount; ++i) {
-        var section = this._hosts[i].getSection("title");
+      for (var _i10 = 0; _i10 < hostCount; ++_i10) {
+        var section = this._hosts[_i10].getSection("title");
         if (!section) {
           continue;
         }
@@ -1239,8 +1267,8 @@ ColumnGroupingPlugin.prototype._getAvaliableChildren = function (groupId) {
     var validCols = host.getValidColumnList(chdr);
     validChildren = validCols.map(ColumnGroupingPlugin.getObjectId);
     var groupMap = this._groupDefs.getGroupMap();
-    for (var i = 0; i < childCount; i++) {
-      var childId = chdr[i];
+    for (var _i11 = 0; _i11 < childCount; _i11++) {
+      var childId = chdr[_i11];
       if (groupMap[childId]) {
         validChildren.push(childId);
       }
@@ -1418,8 +1446,8 @@ ColumnGroupingPlugin.prototype.moveColumnIntoGroup = function (colRef, to, group
 
   // Calculate left and right bound of the group, which column can be moved to.
   // destination should be between the bound, and it should not be placed between columns in child group
-  for (var i = 0; i < groupDef.children.length; i++) {
-    var notAllowIndices = this.getChildColumnIndices(groupDef.children[i]);
+  for (var _i12 = 0; _i12 < groupDef.children.length; _i12++) {
+    var notAllowIndices = this.getChildColumnIndices(groupDef.children[_i12]);
     if (notAllowIndices && notAllowIndices.length) {
       var leftLimit = notAllowIndices[0];
       var rightLimit = notAllowIndices[notAllowIndices.length - 1];
@@ -1589,8 +1617,8 @@ ColumnGroupingPlugin.prototype.getValidDestinationIndex = function (id, destCol)
 
     // handle group/column should not insert between group
     var groupChildren = this.getGroupChildren(parentGroupDef["id"]);
-    for (var i = 0; i < groupChildren.length; i++) {
-      var childId = groupChildren[i];
+    for (var _i13 = 0; _i13 < groupChildren.length; _i13++) {
+      var childId = groupChildren[_i13];
       var childGroupIndices = this.getChildColumnIndices(childId);
       if (childGroupIndices && childGroupIndices.length) {
         startIndex = childGroupIndices[0];
@@ -1636,8 +1664,8 @@ ColumnGroupingPlugin.prototype.moveGroup = function (id, destCol) {
   groupDef = this._groupDefs.getGroup(id);
   if (groupDef) {
     var indices = this.getChildColumnIndices(groupDef["id"]);
-    for (var i = 0; i < indices.length; i++) {
-      var index = indices[i];
+    for (var _i14 = 0; _i14 < indices.length; _i14++) {
+      var index = indices[_i14];
       var colId = this.getColumnId(index);
       members.push(colId);
     }
@@ -1762,8 +1790,8 @@ ColumnGroupingPlugin.prototype.selectGroupHeaders = function (colIndices) {
   var count = colIndices.length;
   if (host && count) {
     var colIds = [];
-    for (var i = 0; i < count; i++) {
-      colIds.push(host.getColumnId(colIndices[i]));
+    for (var _i15 = 0; _i15 < count; _i15++) {
+      colIds.push(host.getColumnId(colIndices[_i15]));
     }
     var colMap = host.createColumnMap(colIds);
     if (colMap) {