@refinitiv-ui/efx-grid 6.0.21 → 6.0.22

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

@@ -74,6 +74,10 @@ ColumnGroupingPlugin.prototype._maxDepth = 0;
 * @private
 */
 ColumnGroupingPlugin.prototype._restructuring = false;
+/** @type {boolean}
+* @private
+*/
+ColumnGroupingPlugin.prototype._autoGrouping = true;
 /** @type {number}
 * @private
 */
@@ -128,6 +132,31 @@ ColumnGroupingPlugin._isValidGroup = function (groupDef) {
 };
 /** @private
 * @function
+* @param {Array|Object} obj
+* @param {string=} groupId
+* @return {ColumnGroupingPlugin~GroupDefinition}
+*/
+ColumnGroupingPlugin._toGroupDefinition = function (obj, groupId) {
+  var groupDef = null;
+  if (obj) {
+    if (Array.isArray(obj)) {
+      groupDef = {
+        children: obj
+      };
+    } else {
+      groupDef = ColumnGroupingPlugin._cloneObject(obj);
+    }
+    if (groupId) {
+      if (!groupDef.id) {
+        groupDef.name = groupId;
+      }
+      groupDef.id = groupId;
+    }
+  }
+  return groupDef;
+};
+/** @private
+* @function
 * @param {Object} obj
 * @return {Object}
 */
@@ -400,8 +429,8 @@ ColumnGroupingPlugin.prototype._applyGrouping = function () {
 */
 ColumnGroupingPlugin.prototype._evaluateGroupStructure = function () {
   // Clear existing group structure
-  var groupMap = this._groupMap = {};
-  var childToParent = this._childToParent = {};
+  var groupMap = this._groupMap = {}; // TODO: This is bad
+  var childToParent = this._childToParent = {}; // TODO: This is bad
   var visibleGroupMap = this._visibleGroupMap = {};
   this._maxDepth = -1;
 
@@ -501,7 +530,7 @@ ColumnGroupingPlugin.prototype._flattenGroupDefs = function (groupDef, groupDefs
           }
           this._flattenGroupDefs(member, groupDefs);
         }
-      }
+      } // TODO: Invalid group is not flatten
     }
   }
 };
@@ -813,25 +842,27 @@ ColumnGroupingPlugin.prototype._onColumnChanged = function () {
 * @param {Object} e dispatching of columnMoved event object
 */
 ColumnGroupingPlugin.prototype._onColumnMoved = function (e) {
-  var toColIndex = e.toColIndex;
-  var colId = this.getColumnId(toColIndex);
-  var groupId = this._childToParent[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) {
-        children.splice(removeIndex, 1);
+  if (this._autoGrouping) {
+    var toColIndex = e.toColIndex;
+    var colId = this.getColumnId(toColIndex);
+    var groupId = this._childToParent[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) {
+          children.splice(removeIndex, 1);
+        }
+        this.setGroupChildren(groupId, children);
       }
-      this.setGroupChildren(groupId, children);
     }
+    this._applyNearestGrouping(toColIndex);
   }
-  this._applyNearestGrouping(toColIndex);
   this._requestApplyGrouping();
 };
 /** @private
@@ -956,21 +987,48 @@ ColumnGroupingPlugin.prototype.addColumnToGroup = function (column, groupId, col
  * @param {Array.<string>} children
  */
 ColumnGroupingPlugin.prototype._ungroupChildren = function (children) {
-  if (Array.isArray(children) && children.length) {
-    var childToParent = this._childToParent;
-    var groupMap = this._groupMap;
+  if (Array.isArray(children)) {
     var len = children.length;
-    var childId, parentId, groupDef, at;
-    for (var i = 0; i < len; i++) {
-      childId = children[i];
-      parentId = childToParent[childId];
-      if (parentId) {
-        groupDef = groupMap[parentId];
-        if (groupDef) {
-          at = groupDef.children.indexOf(childId);
-          if (at > -1) {
-            groupDef.children.splice(at, 1);
-          }
+    for (var i = 0; i < len; ++i) {
+      this._unsetParent(children[i]);
+    }
+  }
+};
+/** Unset parent of the specified id
+ * @private
+ * @param {string} childId
+ */
+ColumnGroupingPlugin.prototype._unsetParent = function (childId) {
+  var parentId = this._childToParent[childId];
+  if (parentId) {
+    this._childToParent[childId] = "";
+    var grpDef = this._groupMap[parentId];
+    if (grpDef) {
+      var chdr = grpDef.children;
+      if (chdr.length) {
+        var at = chdr.indexOf(childId);
+        if (at >= 0) {
+          chdr.splice(at, 1); // splice is slow
+        }
+      }
+    }
+  }
+};
+/** Remove all children from the specified group
+ * @private
+ * @param {string} grpId
+ */
+ColumnGroupingPlugin.prototype._removeAllChildren = function (grpId) {
+  var grpDef = this._groupMap[grpId];
+  if (grpDef) {
+    var chdr = grpDef.children;
+    var len = chdr.length;
+    if (len) {
+      grpDef.children = [];
+      for (var i = 0; i < len; ++i) {
+        var childId = chdr[i];
+        if (this._childToParent[childId]) {
+          this._childToParent[childId] = "";
         }
       }
     }
@@ -984,16 +1042,7 @@ ColumnGroupingPlugin.prototype._ungroupChildren = function (children) {
 */
 ColumnGroupingPlugin.prototype.addGroup = function (groupDef) {
   if (ColumnGroupingPlugin._isValidGroup(groupDef)) {
-    var curDef = this._groupMap[groupDef.id];
-    if (!curDef) {
-      var newGroupDef = ColumnGroupingPlugin._cloneObject(groupDef);
-      this._ungroupChildren(newGroupDef.children);
-      this._groupDefs.push(newGroupDef);
-      this._applyGrouping();
-    } else {
-      this.setGroupDefinition(groupDef.id, groupDef);
-    }
-    return groupDef.id;
+    return this.setGroupDefinition(groupDef.id, groupDef);
   }
   return "";
 };
@@ -1030,7 +1079,7 @@ ColumnGroupingPlugin.prototype.getGroupDefinition = function (groupId) {
     if (!groupDef) {
       return null;
     }
-    groupDef = ColumnGroupingPlugin._cloneObject(groupDef);
+    groupDef = ColumnGroupingPlugin._cloneObject(groupDef); // TODO: this is slow
     var children = this._getAvaliableChildren(groupId);
     groupDef.children = children;
     return groupDef;
@@ -1053,24 +1102,44 @@ ColumnGroupingPlugin.prototype.getGroupDefinitions = function () {
   }
   return validGroupDefs;
 };
-/** Replace and update existing group definition. Existing group id will not be modified
+/** Replace and update existing group definition. New group is added if the given id has no match. Existing group will be removed of no new definition is given.
 * @public
 * @param {string} groupId
-* @param {ColumnGroupingPlugin~GroupDefinition} newDef
+* @param {ColumnGroupingPlugin~GroupDefinition=} groupDef
+* @return {string} Group Id
 */
-ColumnGroupingPlugin.prototype.setGroupDefinition = function (groupId, newDef) {
+ColumnGroupingPlugin.prototype.setGroupDefinition = function (groupId, groupDef) {
   if (!groupId) {
-    return;
+    return "";
   }
-  var curDef = this._groupMap[groupId];
-  if (curDef) {
-    newDef = ColumnGroupingPlugin._cloneObject(newDef);
-    newDef.id = groupId;
+  if (groupDef) {
+    var newDef = ColumnGroupingPlugin._toGroupDefinition(groupDef, groupId);
     this._ungroupChildren(newDef.children);
-    var at = this._groupDefs.indexOf(curDef);
-    this._groupDefs[at] = newDef;
+    var curDef = this._groupMap[groupId];
+    if (curDef) {
+      // Replace
+      var at = this._groupDefs.indexOf(curDef);
+      this._groupDefs[at] = newDef;
+    } else {
+      // Add
+      this._groupDefs.push(newDef);
+    }
+    var chdr = newDef.children;
+    var len = chdr.length;
+    // TODO: Filter out group id
+    if (len > 1) {
+      var gridApi = this.getGridApi();
+      if (gridApi && gridApi.reorderColumns) {
+        gridApi.reorderColumns(chdr, chdr[0]); // WARNING: group id doesn't work
+      }
+    }
+
     this._applyGrouping();
+  } else {
+    // Remove
+    this.removeGroup(groupId);
   }
+  return groupId;
 };
 /** Remove all existing group definitions and replace with the given definitions.
 * @public
@@ -1128,10 +1197,11 @@ ColumnGroupingPlugin.prototype._getAvaliableChildren = function (groupId) {
     for (var i = 0; i < children.length; i++) {
       childId = children[i];
       if (groupMap[childId] || this.getColumnIndex(childId) > -1) {
-        validChildren.push(childId);
+        validChildren.push(childId); // TODO: This is slow
       }
     }
   }
+
   return validChildren;
 };
 
@@ -1429,6 +1499,7 @@ ColumnGroupingPlugin.prototype.moveColumnIntoGroup = function (colRef, to, group
     host.moveColumn(fromIndex, to);
   }
   if (colId) {
+    // TODO:
     // Remove from current group
     var previousGroup = this._childToParent[colId];
     if (previousGroup) {
@@ -1470,5 +1541,107 @@ ColumnGroupingPlugin.prototype.setColumnParent = function (colRef, groupId) {
   }
   this.moveColumnIntoGroup(colRef, toIndex, groupId);
 };
+
+/** @public
+* Get a valid index for moving group/column to specific index
+* @param {string} id group id or column id
+* @param {number|string} destCol destination column index / id
+* @returns {number} destination index
+*/
+ColumnGroupingPlugin.prototype.getValidDestinationIndex = function (id, destCol) {
+  var groupDef, parentGroupDef;
+  groupDef = this._groupMap[id];
+  if (groupDef) {
+    parentGroupDef = this.getGroupDefinition(groupDef["parent"]);
+  } else if (this.getColumnIndex(id) > -1) {
+    parentGroupDef = this._getParentGroup(id);
+  }
+  var startIndex = -1;
+  var endIndex = -1;
+  var destColIndex = typeof destCol === "string" ? this.getColumnIndex(destCol) : destCol;
+  if (parentGroupDef) {
+    // If group/column is a child of a group, it should be move within the parent group
+    var childIndices = this.getChildColumnIndices(parentGroupDef["id"]);
+    if (childIndices && childIndices.length) {
+      startIndex = childIndices[0];
+      endIndex = childIndices[childIndices.length - 1];
+    }
+    if (destColIndex < startIndex && destColIndex != -1) {
+      destColIndex = this.getColumnId(startIndex);
+    } else if (destColIndex > endIndex || destColIndex == -1) {
+      destColIndex = this.getColumnId(endIndex + 1);
+    }
+
+    // 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];
+      var childGroupIndices = this.getChildColumnIndices(childId);
+      if (childGroupIndices && childGroupIndices.length) {
+        startIndex = childGroupIndices[0];
+        endIndex = childGroupIndices[childGroupIndices.length - 1];
+        if (destColIndex > startIndex && destColIndex <= endIndex) {
+          destColIndex = endIndex + 1;
+          break;
+        }
+      }
+    }
+  } else {
+    // handle group/column should not insert between group when group/column is not a child of any group
+    var destMemberIndices = [];
+    var destColId = this.getColumnId(destColIndex);
+    var destParent = this._getParentGroup(destColId);
+    if (destParent) {
+      if (destParent["parent"]) {
+        destParent = this._getRootGroup(destParent["id"]);
+      }
+      destMemberIndices = this.getChildColumnIndices(destParent["id"]);
+    }
+    if (destMemberIndices && destMemberIndices.length) {
+      startIndex = destMemberIndices[0];
+      endIndex = destMemberIndices[destMemberIndices.length - 1];
+      if (destColIndex > startIndex && destColIndex <= endIndex) {
+        destColIndex = endIndex + 1;
+      }
+    }
+  }
+  return destColIndex;
+};
+
+/** @public
+* Move group or column to left side of the destination column.
+* Group or column can only be moved within the parent group.
+* If the destination is between other column group, the destination will change to the end of  that group instead.
+* @param {string} id group id or column id
+* @param {number|string} destCol destination column index / id
+*/
+ColumnGroupingPlugin.prototype.moveGroup = function (id, destCol) {
+  var groupDef;
+  var members = [];
+  groupDef = this._groupMap[id];
+  if (groupDef) {
+    var indices = this.getChildColumnIndices(groupDef["id"]);
+    for (var i = 0; i < indices.length; i++) {
+      var index = indices[i];
+      var colId = this.getColumnId(index);
+      members.push(colId);
+    }
+  } else if (this.getColumnIndex(id) > -1) {
+    members.push(id);
+  } else {
+    return;
+  }
+  var destColIndex = this.getValidDestinationIndex(id, destCol);
+  var destColId = this.getColumnId(destColIndex);
+
+  // TODO: create method for toggling autoGrouping flag
+  this._autoGrouping = false;
+  if (this._realTimeGrid) {
+    this._realTimeGrid.reorderColumns(members, destColId);
+  } else if (this._compositeGrid) {
+    this._compositeGrid.reorderColumns(members, destColId);
+  }
+  this._autoGrouping = true;
+};
 export default ColumnGroupingPlugin;
 export { ColumnGroupingPlugin, ColumnGroupingPlugin as ColumnGrouping, ColumnGroupingPlugin as ColumnGroupingExtension };

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

@@ -48,7 +48,7 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public getGroupDefinitions(): ColumnGroupingPlugin.GroupDefinitions;
 
-    public setGroupDefinition(groupId: string, newDef: ColumnGroupingPlugin.GroupDefinition|null): void;
+    public setGroupDefinition(groupId: string, groupDef?: ColumnGroupingPlugin.GroupDefinition|null): string;
 
     public setGroupDefinitions(groupDefs: ColumnGroupingPlugin.GroupDefinitions|null): void;
 
@@ -70,6 +70,10 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public setColumnParent(colRef: number|string|null, groupId: string): void;
 
+    public getValidDestinationIndex(id: string, destCol: number|string|null): number;
+
+    public moveGroup(id: string, destCol: number|string|null): void;
+
 }
 
 export default ColumnGroupingPlugin;

package/lib/types/es6/Core/grid/components/CellSpans.d.ts

@@ -6,6 +6,8 @@ declare class CellSpans {
 
     public removeColumn(at: number): boolean;
 
+    public freezeMapping(bool?: boolean|null): void;
+
     public shiftColumn(from: number, amount: number): boolean;
 
     public removeSpan(indexX: number, indexY: number): CellSpan|null;

package/lib/types/es6/Core/grid/plugins/SortableTitlePlugin.d.ts

@@ -110,6 +110,8 @@ declare class SortableTitlePlugin extends EventDispatcher {
 
     public disableTwoStateSorting(disabled?: boolean|null): void;
 
+    public freezeIndicator(bool?: boolean|null): void;
+
     public disableSortSymbols(disabled?: boolean|null): void;
 
     public disableDataSorting(disabled?: boolean|null): void;

package/lib/types/es6/RealtimeGrid/Grid.d.ts

@@ -82,7 +82,8 @@ declare namespace Grid {
         scrollbarParent?: Element|null,
         formulaEngine?: boolean|null,
         adcPollingInterval?: number|null,
-        fieldCaching?: boolean|null
+        fieldCaching?: boolean|null,
+        childDataField?: string|null
     };
 
     type RowReference = number|string|RowDefinition|null;
@@ -145,6 +146,8 @@ declare class Grid extends EventDispatcher {
 
     public moveColumnById(srcCol: number|string|null, destCol?: (number|string)|null): boolean;
 
+    public reorderColumns(colRefs: number|string|(number|string)[]|null, destCol: number|string|null): boolean;
+
     public hideColumn(colRef: Grid.ColumnReference|null, hidden?: boolean|null): void;
 
     public hideColumns(colRefs: (Grid.ColumnReference)[]|null, hidden?: boolean|null): void;

package/lib/types/es6/RealtimeGrid/RowDefinition.d.ts

@@ -45,6 +45,8 @@ declare class RowDefinition {
 
     public setStaticRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]|null): void;
 
+    public _getStaticRowData(): { [key: string]:  any };
+
     public updateRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]|null): void;
 
     public setStaticData(field: string, value: any): void;

package/lib/versions.json

@@ -1,6 +1,6 @@
 {
 	"tr-grid-util": "1.3.82",
-	"@grid/column-dragging": "1.0.10",
+	"@grid/column-dragging": "1.0.11",
 	"@grid/row-segmenting": "1.0.22",
 	"@grid/statistics-row": "1.0.13",
 	"@grid/zoom": "1.0.11",
@@ -9,7 +9,7 @@
 	"tr-grid-checkbox": "1.0.60",
 	"tr-grid-column-fitter": "1.0.39",
 	"tr-grid-column-formatting": "0.9.34",
-	"tr-grid-column-grouping": "1.0.37",
+	"tr-grid-column-grouping": "1.0.41",
 	"tr-grid-column-resizing": "1.0.28",
 	"tr-grid-column-selection": "1.0.25",
 	"tr-grid-column-stack": "1.0.48",

package/package.json

@@ -52,7 +52,8 @@
 		"./filter-dialog/themes/solar/pearl": "./lib/filter-dialog/themes/solar/pearl.js",
 		"./extensions": "./lib/index.js",
 		"./window-exporter": "./lib/window-exporter.js",
-		"./grid": "./lib/grid/lib/efx-grid.js"
+		"./grid": "./lib/grid/lib/efx-grid.js",
+		"./formatters/": "./lib/formatters/es6/"
 	},
 	"peerDependencies": {
 		"@refinitiv-ui/core": "^6.2.0",
@@ -61,5 +62,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.21"
+	"version": "6.0.22"
 }