@refinitiv-ui/efx-grid 6.0.17 → 6.0.19

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

@@ -56,16 +56,16 @@ ColumnGroupingPlugin.prototype._groupDefs;
 * @private
 */
 ColumnGroupingPlugin.prototype._groupMap;
-/** @type {!Object.<string, ColumnGroupingPlugin~GroupDefinition>}
-* @description A map of visible group id to group defintion
-* @private
-*/
-ColumnGroupingPlugin.prototype._visibleGroupMap;
 /** @type {!Object.<string, string>}
 * @description A map of child id to parent id
 * @private
 */
 ColumnGroupingPlugin.prototype._childToParent;
+/** @type {!Object.<string, ColumnGroupingPlugin~GroupDefinition>}
+* @description A map of visible group id to group defintion
+* @private
+*/
+ColumnGroupingPlugin.prototype._visibleGroupMap;
 /** @type {number}
 * @private
 */
@@ -87,6 +87,14 @@ ColumnGroupingPlugin.prototype._addingTimerId = 0;
 */
 ColumnGroupingPlugin.prototype._addingEvents = null;
 
+/** @private
+* @param {number} a
+* @param {number} b
+* @return {number}
+*/
+ColumnGroupingPlugin._ascSortLogic = function (a, b) {
+  return a - b;
+};
 /** @private
 * @param {ColumnGroupingPlugin~GroupDefinition} groupingOptions
 * @return {string}
@@ -305,7 +313,7 @@ ColumnGroupingPlugin.prototype._migrateLegacyStructure = function (colModels) {
 
   // Add new definitions and structure to the given legacy objects
   for (i = 0; i < groupCount; ++i) {
-    groupDef = cloneObject(legacyColumnGroups[i]);
+    groupDef = ColumnGroupingPlugin._cloneObject(legacyColumnGroups[i]);
     if (groupDef && groupDef.id) {
       // WARNING: Modify user's object
       var childAry = groupMap[groupDef.id];
@@ -317,6 +325,7 @@ ColumnGroupingPlugin.prototype._migrateLegacyStructure = function (colModels) {
       this._groupDefs.push(groupDef);
     }
   }
+  this._groupDefs = this._groupDefs.filter(ColumnGroupingPlugin._isValidGroup);
 };
 
 /** Consolidate and process configuration. Force rerendering on column adding, removing, moving, initializaing, and run-time API execution.
@@ -390,7 +399,7 @@ ColumnGroupingPlugin.prototype._evaluateGroupStructure = function () {
     groupMap[groupDef.id] = groupDef;
 
     // Clone group definitions for rendering
-    visibleGroupMap[groupDef.id] = cloneObject(groupDef);
+    visibleGroupMap[groupDef.id] = ColumnGroupingPlugin._cloneObject(groupDef);
     visibleGroupMap[groupDef.id].children = groupDef.children.slice();
   }
 
@@ -553,7 +562,14 @@ ColumnGroupingPlugin.prototype._applyNearestGrouping = function (colIndex) {
   var groupLeftIds = this.getGroupIds(colIndexLeft);
   var groupRightIds = this.getGroupIds(colIndexRight);
   if (groupLeftIds && groupRightIds) {
-    var i, j, groupLeftId, groupRightId, field;
+    var colId = this.getColumnId(colIndex);
+    var groupId = this._childToParent[colId];
+    if (groupId) {
+      if (groupLeftIds.indexOf(groupId) > -1 || groupRightIds.indexOf(groupId) > -1) {
+        return;
+      }
+    }
+    var i, j, groupLeftId, groupRightId;
     var found = false;
     for (i = 0; i < groupLeftIds.length; i++) {
       groupLeftId = groupLeftIds[i];
@@ -561,12 +577,15 @@ ColumnGroupingPlugin.prototype._applyNearestGrouping = function (colIndex) {
         groupRightId = groupRightIds[j];
         if (groupLeftId === groupRightId) {
           // found same Id between group
-          field = this.getColumnId(colIndex);
-          this._addGroupChild(field, groupRightId);
+
+          // This method modifies the group definition and outdates the group structure.
+          // It is necessary to recalculate group structure manually.
+          this._addGroupChild(colId, groupRightId);
           found = true;
         }
       }
       if (found) {
+        this._evaluateGroupStructure();
         break;
       }
     }
@@ -603,23 +622,29 @@ ColumnGroupingPlugin.prototype._spanGroupVertically = function (titleSection) {
 */
 ColumnGroupingPlugin.prototype._spanGroupHorizontally = function (titleSection) {
   var section = titleSection;
-  var groupTable = this._visibleGroupMap;
+  var visibleGroupMap = this._visibleGroupMap;
 
   // Span column of column group
-  for (var id in groupTable) {
-    var node = groupTable[id];
-    var colSpans = this._findColumnSpans(node); // find appropriate span
-
-    for (var col = 0; col < colSpans.length; col++) {
-      var spanIndexes = colSpans[col];
-      if (spanIndexes.length > 0) {
-        // This could be unnecessary
-        var start = spanIndexes[0];
-        var end = spanIndexes[1];
-        section.setCellColSpan(start, node["onRow"], end - start + 1);
-        node["colIndex"] = start;
+  var groupDef, spanIndices, len, colIds, index, i;
+  for (var id in visibleGroupMap) {
+    spanIndices = [];
+    groupDef = visibleGroupMap[id];
+    colIds = this._getGroupMembers(visibleGroupMap, groupDef);
+    for (i = 0; i < colIds.length; i++) {
+      index = this._getColumnIndexById(colIds[i]);
+      if (index > -1) {
+        spanIndices.push(index);
       }
     }
+    spanIndices.sort(ColumnGroupingPlugin._ascSortLogic);
+    len = spanIndices.length;
+    if (len > 0) {
+      // This could be unnecessary
+      var start = spanIndices[0];
+      var end = spanIndices[len - 1];
+      section.setCellColSpan(start, groupDef["onRow"], end - start + 1);
+      groupDef["colIndex"] = start;
+    }
   }
 };
 /** @private
@@ -636,6 +661,9 @@ ColumnGroupingPlugin.prototype._renderGroups = function () {
     for (var id in groupMap) {
       var node = groupMap[id];
       var colIndex = node["colIndex"];
+      if (colIndex == null) {
+        continue;
+      }
       var rowIndex = node["onRow"];
       var cell = section.getCell(colIndex, rowIndex);
       if (cell) {
@@ -717,9 +745,17 @@ ColumnGroupingPlugin.prototype._applyTimeSeries = function (e) {
         var groupDef = this._groupMap[groupId];
         if (groupDef) {
           // add children time series field to parent
+          var dirty = false;
+          var child;
           for (i = 0; i < children.length; i++) {
-            var child = children[i];
-            this._addGroupChild(child, groupId);
+            child = children[i];
+
+            // This method modifies the group definition and outdates the group structure.
+            // It is necessary to recalculate group structure manually.
+            dirty |= this._addGroupChild(child, groupId);
+          }
+          if (dirty) {
+            this._evaluateGroupStructure();
           }
         } else {
           // create new group
@@ -757,24 +793,22 @@ ColumnGroupingPlugin.prototype._onColumnMoved = function (e) {
   var toColIndex = e.toColIndex;
   var colId = this.getColumnId(toColIndex);
   var groupId = this._childToParent[colId];
-  var colIndexLeft = toColIndex - 1;
-  var colIndexRight = toColIndex + 1;
-  var colIdLeft = this.getColumnId(colIndexLeft);
-  var colIdRight = this.getColumnId(colIndexRight);
-  var groupIdLeft = this._childToParent[colIdLeft];
-  var groupIdRight = this._childToParent[colIdRight];
-  if (groupId != groupIdLeft && groupId != groupIdRight) {
-    // remove column from previous group
-    if (groupId) {
-      var groupChild = this.getGroupChildren(groupId);
-      var removeIndex = groupChild.indexOf(colId);
+  if (groupId) {
+    var colIdLeft = this.getColumnId(toColIndex - 1);
+    var colIdRight = this.getColumnId(toColIndex + 1);
+    var groupIdLeft = this._childToParent[colIdLeft];
+    var groupIdRight = this._childToParent[colIdRight];
+    if (groupId != groupIdLeft && groupId != groupIdRight) {
+      // Remove column from previous group
+      var children = this.getGroupChildren(groupId);
+      var removeIndex = children.indexOf(colId);
       if (removeIndex > -1) {
-        groupChild.splice(removeIndex, 1);
+        children.splice(removeIndex, 1);
       }
-      this.setGroupChildren(groupId, groupChild);
+      this.setGroupChildren(groupId, children);
     }
-    this._applyNearestGrouping(toColIndex);
   }
+  this._applyNearestGrouping(toColIndex);
   this._requestApplyGrouping();
 };
 /** @private
@@ -806,7 +840,7 @@ ColumnGroupingPlugin.prototype._onColumnRemoved = function (e) {
 * @param {Object} e
 */
 ColumnGroupingPlugin.prototype._onBeforeColumnBoundUpdate = function (e) {
-  var selectedColumns = e.selectedColumns;
+  var selectedColumns = e.selectedColumns; // Hidden columns are included
   var parentMap = this._childToParent;
 
   // Find non-grouped column
@@ -855,7 +889,7 @@ ColumnGroupingPlugin.prototype._onBeforeColumnBoundUpdate = function (e) {
     for (groupId in findingGroup) {
       group = findingGroup[groupId];
       allSelected = true;
-      members = this._getGroupMembers(group);
+      members = this._getGroupMembers(this._groupMap, group);
       if (members.length <= colIds.length) {
         for (n = 0; n < members.length; n++) {
           if (colIds.indexOf(members[n]) < 0) {
@@ -892,7 +926,13 @@ ColumnGroupingPlugin.prototype._onBeforeColumnBoundUpdate = function (e) {
 ColumnGroupingPlugin.prototype.addColumnToGroup = function (column, groupId, colIndex) {
   if (!column || !groupId) return;
   var columnIndex = colIndex || this.getColumnCount();
-  this._addGroupChild(column.id, groupId);
+
+  // This method modifies the group definition and outdates the group structure.
+  // It is necessary to recalculate group structure manually.
+  if (this._addGroupChild(column.id, groupId)) {
+    this._evaluateGroupStructure(); // To prevent event handler from using outdated group structure
+  }
+
   if (this._realTimeGrid) {
     this._realTimeGrid.insertColumn(column, columnIndex);
   } else if (this._compositeGrid) {
@@ -909,7 +949,7 @@ ColumnGroupingPlugin.prototype.addGroup = function (groupDef) {
   if (groupDef && groupDef.id) {
     var curDef = this.getGroupDefinition(groupDef.id);
     if (!curDef) {
-      var newGroupDef = cloneObject(groupDef);
+      var newGroupDef = ColumnGroupingPlugin._cloneObject(groupDef);
       this._groupDefs.push(newGroupDef);
       this._applyGrouping();
       return true;
@@ -969,10 +1009,6 @@ ColumnGroupingPlugin.prototype.setGroupDefinitions = function (groupDefs) {
 ColumnGroupingPlugin._isValidGroup = function (groupDef) {
   if (groupDef) {
     if (groupDef.id) {
-      if (!groupDef.children) {
-        groupDef.children = []; // WARNING: Modify user's object
-      }
-
       return true;
     }
   }
@@ -984,7 +1020,13 @@ ColumnGroupingPlugin._isValidGroup = function (groupDef) {
 * @return {boolean}
 */
 ColumnGroupingPlugin._cloneObject = function (obj) {
-  return cloneObject(obj);
+  var newObj = cloneObject(obj);
+  if (Array.isArray(newObj.children)) {
+    newObj.children = newObj.children;
+  } else {
+    newObj.children = [];
+  }
+  return newObj;
 };
 /** Get a shallow copy of all existing group definitions
 * @public
@@ -1002,7 +1044,7 @@ ColumnGroupingPlugin.prototype.setGroupDefinition = function (groupId, newDef) {
   var curDef = this.getGroupDefinition(groupId);
   if (curDef) {
     var at = this._groupDefs.indexOf(curDef);
-    newDef = cloneObject(newDef);
+    newDef = ColumnGroupingPlugin._cloneObject(newDef);
     newDef.id = groupId;
     this._groupDefs[at] = newDef;
     this._applyGrouping();
@@ -1027,6 +1069,7 @@ ColumnGroupingPlugin.prototype.setGroupChildren = function (groupId, newChildLis
   var groupDef = this.getGroupDefinition(groupId);
   if (groupDef) {
     if (Array.isArray(newChildList)) {
+      groupDef.aaa = 0; // TODO: for testing, need to be removed
       groupDef.children = newChildList.slice();
       this._applyGrouping();
     } else if (!newChildList && groupDef.children.length) {
@@ -1042,9 +1085,8 @@ ColumnGroupingPlugin.prototype.setGroupChildren = function (groupId, newChildLis
 ColumnGroupingPlugin.prototype.getGroupChildren = function (groupId) {
   var groupDef = this.getGroupDefinition(groupId);
   if (groupDef) {
-    return groupDef.children.slice(); // Shallow copy
+    return groupDef.children;
   }
-
   return null;
 };
 
@@ -1056,7 +1098,7 @@ ColumnGroupingPlugin.prototype.getGroupChildren = function (groupId) {
 ColumnGroupingPlugin.prototype.getChildColumnIndices = function (groupId) {
   var group = this._groupMap[groupId];
   if (group) {
-    var colIds = this._getGroupMembers(group);
+    var colIds = this._getGroupMembers(this._groupMap, group);
     var colIndices = [];
     var index;
     for (var i = 0; i < colIds.length; i++) {
@@ -1065,7 +1107,7 @@ ColumnGroupingPlugin.prototype.getChildColumnIndices = function (groupId) {
         colIndices.push(index);
       }
     }
-    return colIndices.sort();
+    return colIndices.sort(ColumnGroupingPlugin._ascSortLogic);
   }
   return null;
 };
@@ -1120,22 +1162,26 @@ ColumnGroupingPlugin.prototype.getGroupLevel = function (groupId) {
 };
 
 /** @private
+* @param {Object.<string, ColumnGroupingPlugin~GroupDefinition>} groupMap
 * @param {ColumnGroupingPlugin~GroupDefinition} group Group definition
 * @param {Array=} members
 * @return {Array.<string>}
 */
-ColumnGroupingPlugin.prototype._getGroupMembers = function (group, members) {
+ColumnGroupingPlugin.prototype._getGroupMembers = function (groupMap, group, members) {
   if (!members) {
     members = [];
   }
   var children = group.children;
-  var groupMap = this._groupMap;
   var g, id;
   for (var i = 0; i < children.length; i++) {
     id = children[i];
+    if (id === group.id) {
+      // prevent from infinite loop
+      continue;
+    }
     g = groupMap[id];
     if (g) {
-      this._getGroupMembers(g, members);
+      this._getGroupMembers(groupMap, g, members);
     } else {
       members.push(id);
     }
@@ -1176,82 +1222,11 @@ ColumnGroupingPlugin.prototype._getColumnIndexById = function (id) {
   }
   return -1;
 };
-/** @private
-* @param {Object} node
-* @param {Array} cluster
-*/
-ColumnGroupingPlugin.prototype._findColumnIndexArr = function (node, cluster) {
-  if (node) {
-    var childrens = node.children;
-    if (childrens && childrens.length) {
-      for (var i = 0; i < childrens.length; i++) {
-        var child = childrens[i];
-        if (!child.id) {
-          if (!this._visibleGroupMap[child]) {
-            var colIndex = this._getColumnIndexById(child);
-            if (colIndex !== -1) {
-              cluster.push(colIndex);
-            }
-          } else {
-            this._findColumnIndexArr(this._visibleGroupMap[child], cluster);
-          }
-        } else {
-          // skip children that has same id as parent
-          if (child.id === node.id) {
-            return;
-          }
-          this._findColumnIndexArr(this._visibleGroupMap[child.id], cluster);
-        }
-      }
-    }
-  }
-};
-/** @private
-* @param {Object} node
-* @return {Array} group of span index
-*/
-ColumnGroupingPlugin.prototype._findColumnSpans = function (node) {
-  var cluster = [];
-  this._findColumnIndexArr(node, cluster); // Recursively get column index
-
-  return ColumnGroupingPlugin._groupConsecutiveArr(cluster);
-};
-/** @private
-* @param {Array} arr
-* @return {Array} group of Consecutive number
-*/
-ColumnGroupingPlugin._groupConsecutiveArr = function (arr) {
-  var result = [];
-  if (!arr || !arr.length) {
-    return result;
-  }
-  var array = arr.sort(function (a, b) {
-    return a - b;
-  });
-  var start = array[0];
-  var stop = start;
-  // start at second member of array
-  for (var i = 1; i <= array.length; i++) {
-    var next = array[i];
-    if (next === stop + 1) {
-      // move to next member
-      stop = next;
-    } else {
-      if (start === stop) {
-        result.push([start, start]);
-      } else {
-        result.push([start, stop]);
-      }
-      // reset the start and stop pointers
-      start = array[i];
-      stop = start;
-    }
-  }
-  return result;
-};
-/** @private
+/** This method modifies the group definition and outdates the group structure. It is necessary to recalculate group structure manually.
+* @private
 * @param {string} childId
 * @param {string} groupId
+* @return {boolean}
 */
 ColumnGroupingPlugin.prototype._addGroupChild = function (childId, groupId) {
   var groupDef = this._groupMap[groupId];
@@ -1259,8 +1234,10 @@ ColumnGroupingPlugin.prototype._addGroupChild = function (childId, groupId) {
     var chdr = groupDef.children;
     if (chdr && chdr.indexOf(childId) < 0) {
       chdr.push(childId);
+      return true;
     }
   }
+  return false;
 };
 /** @private
 * @param {string} childId
@@ -1325,17 +1302,12 @@ ColumnGroupingPlugin.prototype.getCellInfo = function (e) {
   return cellInfo;
 };
 /** @public
-* @param {number|string} colRef //Column index or id that should be moved
+* @param {number|string} colRef Column index or id that should be moved
 * @param {number} to
 * @param {string} groupId
 */
 ColumnGroupingPlugin.prototype.moveColumnIntoGroup = function (colRef, to, groupId) {
-  var fromIndex = -1;
-  if (typeof colRef == "string") {
-    fromIndex = this._getColumnIndexById(colRef);
-  } else {
-    fromIndex = colRef;
-  }
+  var fromIndex = this.getColumnIndex(colRef);
   if (fromIndex == -1) {
     return;
   }
@@ -1353,6 +1325,9 @@ ColumnGroupingPlugin.prototype.moveColumnIntoGroup = function (colRef, to, group
   if (childIndices && childIndices.length) {
     startIndex = childIndices[0];
     endIndex = childIndices[childIndices.length - 1];
+  } else {
+    startIndex = 0;
+    endIndex = this.getColumnCount();
   }
   if (to < startIndex) {
     to = startIndex;
@@ -1368,49 +1343,53 @@ ColumnGroupingPlugin.prototype.moveColumnIntoGroup = function (colRef, to, group
     }
   }
 
-  //find column index that should be moved, it should not be between columns in child 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]);
     if (notAllowIndices && notAllowIndices.length) {
-      var notAllowStart = notAllowIndices[0];
-      var notAllowEnd = notAllowIndices[notAllowIndices.length - 1];
+      var leftLimit = notAllowIndices[0];
+      var rightLimit = notAllowIndices[notAllowIndices.length - 1];
       if (to > fromIndex) {
-        notAllowStart -= 1;
+        leftLimit -= 1;
       }
       if (to < fromIndex) {
-        notAllowEnd += 1;
+        rightLimit += 1;
       }
-      if (to > notAllowStart && to < notAllowEnd) {
-        to = notAllowEnd;
+      if (to > leftLimit && to < rightLimit) {
+        to = rightLimit;
       }
     }
   }
+
+  // Get column id before start moving
+  var colId = this.getColumnId(fromIndex);
   for (var gridIndex = this._hosts.length; --gridIndex >= 0;) {
     var host = this._hosts[gridIndex];
     host.moveColumn(fromIndex, to);
   }
+  if (colId) {
+    // Remove from current group
+    var previousGroup = this._childToParent[colId];
+    if (previousGroup) {
+      var previousGroupChild = this.getGroupChildren(previousGroup);
+      var removeIndex = previousGroupChild.indexOf(colId);
+      if (removeIndex !== -1) {
+        previousGroupChild.splice(previousGroupChild.indexOf(colId), 1);
+      }
+      this.setGroupChildren(previousGroup, previousGroupChild);
+    }
 
-  //remove previous group apply to column
-  var colId = this.getColumnId(to);
-  var previousGroup = this._childToParent[colId];
-  if (previousGroup) {
-    var previousGroupChild = this.getGroupChildren(previousGroup);
-    previousGroupChild.splice(previousGroupChild.indexOf(colId), 1);
-    this.setGroupChildren(previousGroup, previousGroupChild);
-  }
-
-  //apply new group
-  var children = this.getGroupChildren(groupId);
-  if (children.indexOf(colId) == -1) {
-    if (colId) {
+    // Add to new group
+    var children = this.getGroupChildren(groupId);
+    if (children.indexOf(colId) < 0) {
       children.push(colId);
+      this.setGroupChildren(groupId, children);
     }
   }
-  this.setGroupChildren(groupId, children);
-  this._requestApplyGrouping();
 };
 /** @public
-* @param {number|string} colRef //Column index or id that should be moved
+* @param {number|string} colRef Column index or id that should be moved
 * @param {string} groupId
 */
 ColumnGroupingPlugin.prototype.setColumnParent = function (colRef, groupId) {
@@ -1420,7 +1399,17 @@ ColumnGroupingPlugin.prototype.setColumnParent = function (colRef, groupId) {
   }
   var grid = this._hosts[0];
   var colCount = grid.getColumnCount();
-  this.moveColumnIntoGroup(colRef, colCount, groupId);
+  var toIndex = -1;
+  var childIndices = this.getChildColumnIndices(groupId);
+
+  // When group has at least one child, move column to last index within a group
+  // Otherwise, column will not be moved
+  if (childIndices && childIndices.length) {
+    toIndex = colCount;
+  } else {
+    toIndex = this.getColumnIndex(colRef);
+  }
+  this.moveColumnIntoGroup(colRef, toIndex, groupId);
 };
 export default ColumnGroupingPlugin;
 export { ColumnGroupingPlugin, ColumnGroupingPlugin as ColumnGrouping, ColumnGroupingPlugin as ColumnGroupingExtension };

package/lib/tr-grid-column-stack/es6/ColumnStack.js

@@ -311,15 +311,10 @@ ColumnStackPlugin.prototype.getConfigObject = function (gridOptions) {
 		if(columnOptions && columnOptions.length){
 			var memberIndices = this.getStackMemberIndices(stackOption.stackId);
 			for(var i = 0; i < memberIndices.length; i++){
-				var colOption = columnOptions[memberIndices[i]];
+				var colIndex = memberIndices[i];
+				var colOption = columnOptions[colIndex];
 				if(colOption){
-					if(memberIndices[i] == activeColIndex){
-						if(colOption["hidden"]) {
-							delete colOption["hidden"];
-						}
-					} else {
-						colOption.hidden = true;
-					}
+					colOption.hidden = colIndex !== activeColIndex;
 				}
 			}
 		}
@@ -1423,7 +1418,8 @@ ColumnStackPlugin.prototype._onStackButtonClicked = function(e) {
 		menuData[i] = {
 			value: i,
 			selected: i === activeIndex,
-			label: this.getColumnName(colIndices[i])
+			label: this.getColumnName(colIndices[i]),
+			field: this._getField(colIndices[i])
 		};
 	}
 	pos["menuData"] = menuData;

package/lib/tr-grid-filter-input/es6/FilterInput.d.ts

@@ -17,6 +17,7 @@ declare namespace FilterInputPlugin {
         placeholder?: string,
         type?: string,
         entries?: any[],
+        defaultValue?: any,
         trigger?: string
     };