@refinitiv-ui/efx-grid 6.0.26 → 6.0.28

package/lib/rt-grid/es6/Grid.js

@@ -85,6 +85,7 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {number=} adcPollingInterval=0 Length of polling interval for refreshing ADC data in milliseconds. The default value (0) means no polling.
 * @property {boolean=} fieldCaching=false If enabled, field definition will be caching internal mechanism
 * @property {string=} childDataField=CHILD_VALUES The given field will be used to store children's static data, such as row color assignment.
+* @property {boolean=} topSection=true If disabled, title section will not be rendered
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference
@@ -228,26 +229,6 @@ var compareNumber = function(rowDefA, rowDefB, sortOrder, fieldName) { // edit n
 	return (rowDefA.getData(fieldName) - rowDefB.getData(fieldName)) * sortOrder; // for numeric comparison
 };
 
-/** @private
-* @param {ColumnDefinition} colDef
-* @return {string}
-*/
-var _getId = function(colDef) {
-	if(colDef) {
-		return colDef.getId();
-	}
-	return "";
-};
-/** @private
-* @param {ColumnDefinition} colDef
-* @return {string}
-*/
-var _getField = function(colDef) {
-	if(colDef) {
-		return colDef.getField();
-	}
-	return "";
-};
 /** @private
 * @param {ColumnDefinition} colDef
 * @return {string}
@@ -336,6 +317,9 @@ var Grid = function(placeholder, config) {
 		if(config["SortableTitle"]) { // Exception for built-in plugin
 			t._stp = config["SortableTitle"];
 		}
+		if(config["topSection"] === false) {
+			t._topSection = false;
+		}
 	}
 	if(!t._sharedDataSource) {
 		t._dc = new DataCache();
@@ -550,7 +534,10 @@ Grid.prototype._fieldCaching = false;
 * @private
 */
 Grid.prototype._childDataField = "";
-
+/** @type {boolean}
+* @private
+*/
+Grid.prototype._topSection = true;
 
 /** @public
 */
@@ -665,7 +652,11 @@ Grid.prototype.updateRowData = Grid.prototype._updateRowData;
  */
 Grid.prototype._addGridSections = function () {
 	var title = this._grid.addSection("title");
-	title.setRowCount(1);
+	if(this._topSection == false){
+		title.setRowCount(0);
+	} else {
+		title.setRowCount(1);
+	}
 	this._grid.addSection("content");
 
 	var titleSettings = this._grid.getSectionSettings("title");
@@ -1617,10 +1608,13 @@ Grid.prototype.setFields = Grid.prototype.setColumns;
 * @param {Object} e
 */
 Grid.prototype._onColumnAdded = function(e) {
-	var colDef = e.context[COL_DEF];
+	var colDef = /** @type{ColumnDefinition} */(e.context[COL_DEF]);
 	delete e.context[COL_DEF];
 	var idx = e.colIndex;
 
+	var coreColDef = this._grid._getColumnDef(idx);
+	colDef._setCoreColumnDef(coreColDef); // For column id and field
+
 	var colData = this._grid.getColumnData(idx);
 	if(!colData) { // Save column inside grid
 		colData = this._grid.setColumnData(idx, {});
@@ -1847,102 +1841,16 @@ Grid.prototype.moveColumn = function (fromColIndex, toColIndex) {
 * grid.moveColumnById("sourceColumnId", ""); // move to the last position
 */
 Grid.prototype.moveColumnById = function (srcCol, destCol) {
-	var colCount = this.getColumnCount();
-	var srcIndex = this.getColumnIndex(srcCol);
-	if(srcIndex < 0 || srcIndex >= colCount) {
-		return false;
-	}
-	var destIndex = this.getColumnIndex(destCol);
-	if(destIndex < 0) {
-		destIndex = colCount;
-	}
-	return this._moveColumnByIndex(srcIndex, destIndex);
-};
-/** Move column without verification for better performance
-* @private
-* @param {number} srcIndex Column index
-* @param {number} destIndex Column index of the destination
-* @return {boolean} Return true if there is any change, and false otherwise
-*/
-Grid.prototype._moveColumnByIndex = function (srcIndex, destIndex) {
-	if(srcIndex < destIndex) { // Ensure that the source column is put in front of the destination index
-		--destIndex;
-	}
-	if(srcIndex === destIndex) {
-		return false;
-	}
-	return this.moveColumn(srcIndex, destIndex);
+	return this._grid.moveColumnById(srcCol, destCol);
 };
 
 /** @public
 * @param {number|string|Array.<number|string>} colRefs List of column index or column id to be moved
-* @param {number|string} destCol Destination position where the moved columns will be placed BEFORE the specified position. This can be column id or index
+* @param {(number|string)=} destCol Destination position where the moved columns will be placed BEFORE the specified position. This can be column id or index
 * @return {boolean} Return true if there is any change, and false otherwise
 */
 Grid.prototype.reorderColumns = function (colRefs, destCol) {
-	var destId = (typeof destCol === "number") ? this.getColumnId(destCol) : destCol;
-
-	if(Array.isArray(colRefs)) {
-		var srcLen = colRefs.length;
-		if(srcLen > 1) {
-			var colIds = this.getColumnIds();
-			var colCount = colIds.length;
-			var srcIds = [];
-			var invalidDest = false;
-			var i, srcId, srcIdx;
-			for(i = 0; i < srcLen; ++i) {
-				var colRef = colRefs[i];
-				if(typeof colRef === "number") {
-					srcIdx = colRef;
-					srcId = colIds[colRef] || "";
-				} else {
-					srcId = colRef;
-					srcIdx = colIds.indexOf(srcId);
-				}
-				if(srcId && srcIdx >= 0) {
-					srcIds.push(srcId);
-					if(destId === srcId) {
-						invalidDest = true; // Destination must not exist in source columns
-					}
-				}
-			}
-
-			var destIdx;
-			srcLen = srcIds.length;
-			if(invalidDest) { // Find the next valid destination where it is not contained in the source columns
-				destIdx = this.getColumnIndex(destId);
-				if(destIdx >= 0) {
-					while(++destIdx < colCount) {
-						destId = colIds[destIdx];
-						if(srcIds.indexOf(destId) < 0) {
-							break;
-						}
-					}
-				}
-				if(destIdx < 0 || destIdx >= colCount) {
-					destId = "";
-				}
-			}
-
-			var dirty = 0;
-			for(i = srcLen; --i >= 0;) {
-				srcId = srcIds[i]; // Only valid source columns are left at this point
-				srcIdx = this.getColumnIndex(srcId);
-				destIdx = this.getColumnIndex(destId);
-				if(destIdx < 0) { // Insert to the back when id is not found
-					destIdx = colCount;
-				}
-				dirty |= this._moveColumnByIndex(srcIdx, destIdx);
-				destId = srcId;
-			}
-			return dirty ? true : false;
-		} else {
-			return this.moveColumnById(colRefs[0], destId);
-		}
-	}
-
-	// colRefs will be a number or string
-	return this.moveColumnById(colRefs, destId);
+	return this._grid.reorderColumns(colRefs, destCol);
 };
 
 /** The hidden column still occupies the same index.
@@ -2981,30 +2889,19 @@ Grid.prototype._getRowId = function(rowRef) {
 * @return {number}
 */
 Grid.prototype.getColumnIndex = function(colRef) {
-	if(typeof colRef === "number") {
-		return colRef;
-	}
-
 	if(colRef) {
 		var colCount = this.getColumnCount();
-		var i, colDef;
 		if(colRef instanceof ColumnDefinition) {
-			for(i = 0; i < colCount; ++i) {
-				colDef = this.getColumnDefinition(i);
+			for(var i = 0; i < colCount; ++i) {
+				var colDef = this.getColumnDefinition(i);
 				if(colDef === colRef) {
 					return i;
 				}
 			}
-		} else if(typeof colRef === "string") {
-			for(i = 0; i < colCount; ++i) {
-				colDef = this.getColumnDefinition(i);
-				if(_hasFieldOrId(colDef, colRef)) {
-					return i; // Return the first found field
-				}
-			}
+			return -1;
 		}
 	}
-	return -1;
+	return this._grid.getColumnIndex(colRef);
 };
 /** Any invalid column reference will be excluded from the output array
 * @public
@@ -3020,7 +2917,7 @@ Grid.prototype.getColumnIndices = function(colRefs) {
 	for(var i = 0; i < len; ++i) {
 		var colIndex = this.getColumnIndex(inputAry[i]);
 		if(colIndex >= 0 && colIndex < colCount) {
-			ary.push(colIndex); // WARNING: We have not check for duplication
+			ary.push(colIndex); // WARNING: We have not checked for duplication
 		}
 	}
 	return ary;
@@ -3032,14 +2929,14 @@ Grid.prototype.getColumnIndices = function(colRefs) {
 * @see {@link Grid#getColumnDefinition}
 */
 Grid.prototype.getColumnId = function(colIndex) {
-	return _getId(this.getColumnDefinition(colIndex));
+	return this._grid.getColumnId(colIndex);
 };
 /** Get ids from each column definition.
 * @public
 * @return {!Array.<string>} New array is created
 */
 Grid.prototype.getColumnIds = function() {
-	return this.getColumnDefinitions().map(_getId);
+	return this._grid.getColumnIds();
 };
 /** Return field defined in the column definition
 * @public
@@ -3048,14 +2945,14 @@ Grid.prototype.getColumnIds = function() {
 * @see {@link Grid#getColumnDefinition}
 */
 Grid.prototype.getColumnField = function(colIndex) {
-	return _getField(this.getColumnDefinition(colIndex));
+	return this._grid.getColumnField(colIndex);
 };
 /** Get fields from each column definition. Note that this does not include any required field or data fields. Duplicates may exist.
 * @public
 * @return {!Array.<string>} New array is created
 */
 Grid.prototype.getColumnFields = function() {
-	return this.getColumnDefinitions().map(_getField);
+	return this._grid.getColumnFields();
 };
 /** Get column name from each column definition. Note that this does not include any required field or data fields. Duplicates may exist.
 * @public
@@ -3513,6 +3410,32 @@ Grid.prototype.setClassification = function(rowRef, fields) {
 	return false;
 };
 
+/** Check element in the grid element
+ * @public
+ * @param {Element} elem
+ * @return {boolean}=true if an element from the parameter is inside a grid element
+ */
+Grid.prototype.contains = function(elem) {
+	if(elem) {
+		// This will impact the contents within the rt-grid element, but not those outside of it, such as the wrapper elements atlas-blotter and ef-grid.
+		return this._topNode.contains(elem);
+	}
+	return false;
+};
+
+/** Check grid element is focused
+ * @public
+ * @return {boolean}
+ */
+Grid.prototype.isFocused = function() {
+	var activeElement = document.activeElement;
+	if(!activeElement || !activeElement.shadowRoot) {
+		// active element is not in the shadow DOM. try using contains method to check
+		return this.contains(activeElement);
+	}
+ 	// For wrapper scenarios, such as atlas-blotter or efx-grid
+	return  activeElement.shadowRoot === this._topNode.parentNode;
+};
 /** @description Focus grid element without moving window scrollbar
  * @public
  */

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

@@ -69,11 +69,21 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public moveColumnIntoGroup(colRef: number|string|null, to: number, groupId: string): void;
 
-    public setColumnParent(colRef: number|string|null, groupId: string): void;
+    public setColumnParent(colRef: number|string|null, groupId: string): boolean;
+
+    public addGroupChild(parentId: string, childRef: number|string|null): boolean;
+
+    public removeGroupChild(parentId: string, childRef: number|string|null): boolean;
+
+    public unsetParent(childRef: number|string|null): boolean;
 
     public getValidDestinationIndex(id: string, destCol: number|string|null): number;
 
-    public moveGroup(id: string, destCol: number|string|null): void;
+    public moveGroup(id: string, destCol?: (number|string)|null): void;
+
+    public reorderColumns(colList: (number|string)[]|null, destCol?: (number|string)|null): boolean;
+
+    public moveColumnById(srcCol: number|string|null, destCol?: (number|string)|null): boolean;
 
 }
 

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

@@ -318,16 +318,7 @@ ColumnGroupingPlugin.prototype.config = function (options) {
   }
   var columns = options["columns"];
   if (columns) {
-    var len = columns.length;
-    for (var i = 0; i < len; ++i) {
-      var colData = this._newColumnData(i);
-      colData["columnGrouping"] = {
-        // used for columnRemoved event
-        id: columns[i].id // TODO: This does not work with runtime change
-      };
-    }
-
-    groupDefs = this._migrateLegacyStructure(groupDefs, options["columns"]);
+    groupDefs = this._migrateLegacyStructure(groupDefs, columns);
   }
   if (groupDefs) {
     ColumnGroupingPlugin._flattenGroupDefs(groupDefs);
@@ -591,7 +582,7 @@ ColumnGroupingPlugin.prototype._applyNearestGrouping = function (colIndex) {
       }
     }
     // The current column is no longer close to its parent
-    if (this._groupDefs.removeGroupChild(colId)) {
+    if (this._groupDefs.unsetParent(colId)) {
       chdr = this._groupDefs.getGroupChildren(parentId);
       childCount = chdr ? chdr.length : 0;
       if (childCount === 1) {
@@ -805,10 +796,9 @@ ColumnGroupingPlugin.prototype._onColumnMoved = function (e) {
 * @param {Object} e
 */
 ColumnGroupingPlugin.prototype._onColumnRemoved = function (e) {
-  var colData = e.columnData;
-  if (colData && colData.columnGrouping) {
-    var colId = colData.columnGrouping.id;
-    if (this._groupDefs.removeGroupChild(colId)) {
+  var colId = e.colId;
+  if (colId) {
+    if (this._groupDefs.unsetParent(colId)) {
       this._requestApplyGrouping();
     }
   }
@@ -1002,11 +992,7 @@ ColumnGroupingPlugin.prototype.setGroupDefinition = function (groupId, groupDef)
       var len = chdr.length;
       // TODO: Filter out group id
       if (len > 1) {
-        var gridApi = this.getGridApi();
-        if (gridApi && gridApi.reorderColumns) {
-          // TODO: Support multi-table feature
-          gridApi.reorderColumns(chdr, chdr[0]); // WARNING: group id doesn't work
-        }
+        this.reorderColumns(chdr, chdr[0]); // WARNING: group id doesn't work
       }
     }
 
@@ -1086,10 +1072,10 @@ ColumnGroupingPlugin.prototype.getChildColumnIndices = function (groupId) {
   var colIds = this._groupDefs.getLeafDescendants(groupId);
   if (colIds) {
     var colIndices = [];
-    var index;
-    for (var i = 0; i < colIds.length; i++) {
-      index = this.getColumnIndex(colIds[i]);
-      if (index > -1) {
+    var leafCount = colIds.length;
+    for (var i = 0; i < leafCount; i++) {
+      var index = this.getColumnIndex(colIds[i]);
+      if (index >= 0) {
         colIndices.push(index);
       }
     }
@@ -1268,31 +1254,114 @@ ColumnGroupingPlugin.prototype.moveColumnIntoGroup = function (colRef, to, group
     }
   }
 };
-/** @public
+/**
+* @public
 * @param {number|string} colRef Column index or id that should be moved
 * @param {string} groupId
+* @return {boolean}
 */
 ColumnGroupingPlugin.prototype.setColumnParent = function (colRef, groupId) {
-  var api = this.getGridApi();
-  if (!api) {
-    return;
+  if (groupId) {
+    return this.addGroupChild(groupId, colRef);
   }
-  var colCount = this.getColumnCount();
-  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;
+  return this.unsetParent(colRef);
+};
+/** If a column is added as a new child in a group, the column will be moved to the last position in the group. If the column is already a child of the group, nothing happens.
+* @public
+* @param {string} parentId
+* @param {number|string} childRef Column index, column id, group id to be added
+* @return {boolean}
+*/
+ColumnGroupingPlugin.prototype.addGroupChild = function (parentId, childRef) {
+  var parentDef = this._groupDefs.getGroup(parentId);
+  if (!parentDef) {
+    return false;
+  }
+  var colId = "";
+  if (typeof childRef === "string") {
+    var groupDef = this._groupDefs.getGroup(childRef);
+    if (groupDef) {
+      if (this._groupDefs.addGroupChild(parentId, childRef)) {
+        this._applyGrouping();
+        return true;
+      }
+    } else {
+      colId = childRef;
+    }
+  } else {
+    colId = this.getColumnId(childRef);
+  }
+  if (!colId) {
+    return false;
+  }
+  var leafIndices = this.getChildColumnIndices(parentId);
+  if (this._groupDefs.addGroupChild(parentId, colId)) {
+    if (leafIndices && leafIndices.length) {
+      if (this.moveColumnById(colId, leafIndices[leafIndices.length - 1] + 1)) {
+        return true;
+      }
+    }
+    this._applyGrouping();
+    return true;
+  }
+  return false;
+};
+/**
+* @public
+* @param {string} parentId
+* @param {number|string} childRef Column index, column id, group id to be added
+* @return {boolean}
+*/
+ColumnGroupingPlugin.prototype.removeGroupChild = function (parentId, childRef) {
+  var parentDef = this._groupDefs.getGroup(parentId);
+  if (!parentDef) {
+    return false;
+  }
+  var colId = "";
+  if (typeof childRef === "string") {
+    var groupDef = this._groupDefs.getGroup(childRef);
+    if (groupDef) {
+      if (this._groupDefs.unsetParent(childRef)) {
+        this._applyGrouping();
+        return true;
+      }
+    } else {
+      colId = childRef;
+    }
   } else {
-    toIndex = this.getColumnIndex(colRef);
+    colId = this.getColumnId(childRef);
   }
-  this.moveColumnIntoGroup(colRef, toIndex, groupId);
+  if (!colId) {
+    return false;
+  }
+  var leafIndices = this.getChildColumnIndices(parentId);
+  if (this._groupDefs.removeGroupChild(parentId, colId)) {
+    if (leafIndices && leafIndices.length > 1) {
+      if (this.moveColumnById(colId, leafIndices[leafIndices.length - 1] + 1)) {
+        return true;
+      }
+    }
+    this._applyGrouping();
+    return true;
+  }
+  return false;
+};
+/**
+* @public
+* @param {number|string} childRef Column index, column id, group id to be removed from its own parent
+* @return {boolean}
+*/
+ColumnGroupingPlugin.prototype.unsetParent = function (childRef) {
+  var refId = typeof childRef === "string" ? childRef : this.getColumnId(childRef);
+  var parentId = this._groupDefs.getParentId(refId);
+  if (parentId) {
+    return this.removeGroupChild(parentId, refId);
+  }
+  return false;
 };
 
 /** @public
-* Get a valid index for moving group/column to specific index
+* @description 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
@@ -1357,11 +1426,11 @@ ColumnGroupingPlugin.prototype.getValidDestinationIndex = function (id, destCol)
 };
 
 /** @public
-* Move group or column to left side of the destination column.
+* @description 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
+* @param {(number|string)=} destCol destination column index / id
 */
 ColumnGroupingPlugin.prototype.moveGroup = function (id, destCol) {
   var groupDef;
@@ -1380,16 +1449,38 @@ ColumnGroupingPlugin.prototype.moveGroup = function (id, destCol) {
     return;
   }
   var destColIndex = this.getValidDestinationIndex(id, destCol);
-  var destColId = this.getColumnId(destColIndex);
+  var destColId = this.getColumnId(destColIndex); // TODO: This may not necessary
 
+  this.reorderColumns(members, destColId);
+};
+/** Move and reorder the specified columns to position before the destination
+* @public
+* @param {Array.<number|string>} colList Column list to be reordered
+* @param {(number|string)=} destCol Destination column id or index
+* @return {boolean}
+*/
+ColumnGroupingPlugin.prototype.reorderColumns = function (colList, destCol) {
+  var dirty = false;
   // TODO: create method for toggling autoGrouping flag
-  this._autoGrouping = false;
-  var gridApi = this.getGridApi();
-  if (gridApi && gridApi.reorderColumns) {
-    gridApi.reorderColumns(members, destColId); // TODO: Support multi-table feature
-  }
+  this._autoGrouping = false; // Prevent re-grouping in columnMoved event
+
+  this._reorderColumns(colList, destCol);
+  this._autoGrouping = true;
+  return dirty;
+};
+/** Move the specified column to position before the destination
+* @public
+* @param {number|string} srcCol Source column id or index
+* @param {(number|string)=} destCol Destination column id or index
+* @return {boolean}
+*/
+ColumnGroupingPlugin.prototype.moveColumnById = function (srcCol, destCol) {
+  var dirty = false;
+  this._autoGrouping = false; // Prevent re-grouping in columnMoved event
 
+  this._moveColumnById(srcCol, destCol);
   this._autoGrouping = true;
+  return dirty;
 };
 export default ColumnGroupingPlugin;
 export { ColumnGroupingPlugin, ColumnGroupingPlugin as ColumnGrouping, ColumnGroupingPlugin as ColumnGroupingExtension };

package/lib/tr-grid-column-stack/es6/ColumnStack.d.ts

@@ -12,7 +12,8 @@ declare namespace ColumnStackPlugin {
     type Options = {
         fields: (string)[]|null,
         stacks: (ColumnStackPlugin.StackDefinition)[]|null,
-        autoStacking?: boolean|null
+        autoStacking?: boolean|null,
+        clicked?: ((...params: any[]) => any)|null
     };
 
     type ColumnOptions = {
@@ -90,6 +91,8 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public unstackColumns(colIndices?: (number)[]|null): boolean;
 
+    public removeStack(stackId: string): boolean;
+
     public removeAllStacks(enableUpdateUI?: boolean|null): boolean;
 
     public swapColumn(colRef: number|Event|null, swappingIndex: number): boolean;
@@ -116,6 +119,16 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getActiveColumnField(stackId: string): string;
 
+    public addStackChild(stackId: string, colRef: number|string|null): void;
+
+    public removeStackChild(stackId: string, colRef: number|string|null): void;
+
+    public unsetParent(colRef: number|string|null): void;
+
+    public reorderColumns(colList: (number|string)[]|null, destCol?: (number|string)|null): boolean;
+
+    public moveColumnById(srcCol: number|string|null, destCol?: (number|string)|null): boolean;
+
 }
 
 export default ColumnStackPlugin;