@refinitiv-ui/efx-grid 6.0.31 → 6.0.33

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

@@ -2337,7 +2337,7 @@ Grid.prototype.removeRow = function(rowRef) {
 	if(this._mainGrid) {
 		return this._mainGrid.removeRow(this._getRowId(rowRef));
 	}
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		if(!rowDef.isAutoGenerated()) { // Users cannot remove auto-generated row by themselves
 			this._removeRow(rowDef);
@@ -2368,7 +2368,7 @@ Grid.prototype.removeRows = function(rowRefs) {
 
 	// Verify user input
 	for(i = 0; i < len; ++i) {
-		rowDef = this._getRowDefinition(rowRefs[i]);
+		rowDef = this._getRowDefinitionByRef(rowRefs[i]);
 		if(rowDef) {
 			if(!rowDef.isAutoGenerated()) {
 				rowDefs.push(rowDef);
@@ -2504,7 +2504,7 @@ Grid.prototype.setRic = function(rowRef, str, options) {
 		this._mainGrid.setRic(this._toRowId(rowRef), str);
 		return;
 	}
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		options = options || {};
 		var newChain = false;
@@ -2539,7 +2539,7 @@ Grid.prototype.setRic = function(rowRef, str, options) {
  * @param {Grid~RowReference} rowRef
  */
 Grid.prototype.unlinkChain = function(rowRef) {
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(!rowDef) {
 		return;
 	}
@@ -2718,7 +2718,8 @@ Grid.prototype.getRowType = function(rowRef) {
 	var rowDef = this.getRowDefinition(rowRef);
 	return rowDef ? rowDef.getType() : "";
 };
-/** @public
+/** Get RowDefinition object by either number or row id
+* @public
 * @param {number|string} rowRef Row index as shown in the view or row id (string)
 * @return {RowDefinition}
 */
@@ -2748,7 +2749,7 @@ Grid.prototype._getRowDefinitionById = function(rowId) {
 * @param {Grid~RowReference} rowRef
 * @return {RowDefinition}
 */
-Grid.prototype._getRowDefinition = function(rowRef) {
+Grid.prototype._getRowDefinitionByRef = function(rowRef) {
 	if(rowRef instanceof RowDefinition) {
 		if(rowRef.getRowId()) { // The row may have been removed from the grid
 			return /** @type{!RowDefinition} */(rowRef);
@@ -2852,7 +2853,7 @@ Grid.prototype.setRicData = function(ric, values) {
 * @param {Object} values {"FIELD1": value1, "FIELD2": value2, ...} Use null to remove current row data (not row in the view).
 */
 Grid.prototype.setRowData = function(rowRef, values) {
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		rowDef.setRowData(values);
 	}
@@ -2864,7 +2865,7 @@ Grid.prototype.setRowData = function(rowRef, values) {
 * @param {Object} values
 */
 Grid.prototype.setStaticRowData = function(rowRef, values) {
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		rowDef.setStaticRowData(values);
 	}
@@ -2877,7 +2878,7 @@ Grid.prototype.setStaticRowData = function(rowRef, values) {
 * @param {*} value
 */
 Grid.prototype.setStaticData = function(rowRef, field, value) {
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		rowDef.setStaticData(field, value);
 	}
@@ -3227,7 +3228,7 @@ Grid.prototype._onDataChanged = function(e) {
 	// The new data update has no row definition, meaning that we have found a new constituent from a chain.
 	var subId = rowData[SUB_ID]; // The constituent will share the same sub id as its parent
 	if(subId) {
-		var parentDef = this._getRowDefinition(subId);
+		var parentDef = this._getRowDefinitionById(subId);
 		if(parentDef && parentDef.getRic() !== rowData["RIC"]) { // TODO: Check for delayed ric
 			if(!this._chainMembers) {
 				this._chainMembers = {};
@@ -3259,7 +3260,7 @@ Grid.prototype._addMemberOfChain = function(rowData) {
 	for(i = 0; i < len; ++i) {
 		rowData = /** @type{!Object} */(rows[i]);
 		var subId = rowData[SUB_ID];
-		var parentDef = this._getRowDefinition(subId);
+		var parentDef = this._getRowDefinitionById(subId);
 		if(parentDef) {
 			var childDef = parentDef.addConstituent(/** @type{string} */(rowData["RIC"]), this._dt);
 			if(childDef) {
@@ -3405,7 +3406,7 @@ Grid.prototype.getPageCount = function() {
  * @param {Grid~RowReference} rowRef
  */
 Grid.prototype.toggleChain = function(rowRef) {
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		rowDef.toggleChain();
 	}
@@ -3417,7 +3418,7 @@ Grid.prototype.toggleChain = function(rowRef) {
  * @return {boolean}
  */
 Grid.prototype.setClassification = function(rowRef, fields) {
-	var rowDef = this._getRowDefinition(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		return this._dt.setSegmentClassification(rowDef.getRowId(), fields);
 	}

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

@@ -49,7 +49,7 @@ var ROW_TYPES = {
 */
 var RowDefinition = function(rowOptions) {
 	this._changes = {};
-	if(rowOptions && rowOptions["segmentId"]) {
+	if(rowOptions && rowOptions["segmentId"]) { // This row will be classification header row
 		this._dataId = this._rowId = rowOptions["segmentId"];
 		this._autoGenerated = true;
 		this._subSegment = true;

package/lib/statistics-row/es6/StatisticsRow.d.ts

@@ -4,42 +4,42 @@ import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 declare namespace StatisticsRowPlugin {
 
     type Options = {
-        rows?: any[],
-        invalidText?: string,
-        noColoring?: boolean,
-        noFormatting?: boolean,
-        postCalculation?: ((...params: any[]) => any),
-        postRendering?: ((...params: any[]) => any)
+        rows?: any[]|null,
+        invalidText?: string|null,
+        noColoring?: boolean|null,
+        noFormatting?: boolean|null,
+        postCalculation?: ((...params: any[]) => any)|null,
+        postRendering?: ((...params: any[]) => any)|null
     };
 
     type ColumnOptions = {
-        statistics?: (boolean|string)
+        statistics?: (boolean|string)|null
     };
 
     type RowOptions = {
-        placement?: string,
-        statistic?: string,
-        label?: string,
-        id?: string
+        placement?: string|null,
+        statistic?: string|null,
+        label?: string|null,
+        id?: string|null
     };
 
-    type RowReference = string|number;
+    type RowReference = string|number|null;
 
     type Stats = {
-        field?: string,
-        label?: boolean,
-        count?: number,
-        sum?: number,
-        average?: number,
-        min?: number,
-        max?: number
+        field?: string|null,
+        label?: boolean|null,
+        count?: number|null,
+        sum?: number|null,
+        average?: number|null,
+        min?: number|null,
+        max?: number|null
     };
 
 }
 
 declare class StatisticsRowPlugin extends GridPlugin {
 
-    constructor(options?: StatisticsRowPlugin.Options);
+    constructor(options?: StatisticsRowPlugin.Options|null);
 
     public getName(): string;
 
@@ -51,15 +51,15 @@ declare class StatisticsRowPlugin extends GridPlugin {
 
     public getConfigObject(gridOptions?: any): any;
 
-    public setStatisticsRows(rows: (StatisticsRowPlugin.RowOptions)[]): void;
+    public setStatisticsRows(rows: (StatisticsRowPlugin.RowOptions)[]|null): void;
 
-    public getStatisticsRows(): (StatisticsRowPlugin.RowOptions)[];
+    public getStatisticsRows(): (StatisticsRowPlugin.RowOptions)[]|null;
 
-    public setStatisticsRow(rowRef: StatisticsRowPlugin.RowReference, options: StatisticsRowPlugin.RowOptions): boolean;
+    public setStatisticsRow(rowRef: StatisticsRowPlugin.RowReference|null, options: StatisticsRowPlugin.RowOptions|null): boolean;
 
-    public addStatisticsRow(options: StatisticsRowPlugin.RowOptions): void;
+    public addStatisticsRow(options: StatisticsRowPlugin.RowOptions|null): void;
 
-    public removeStatisticsRow(rowRef: StatisticsRowPlugin.RowReference): void;
+    public removeStatisticsRow(rowRef: StatisticsRowPlugin.RowReference|null): void;
 
 }
 

package/lib/statistics-row/es6/StatisticsRow.js

@@ -734,13 +734,13 @@ StatisticsRowPlugin.prototype._renderStatistics = function (colIndex, stats, act
 
 	var r, rowCount;
 	if(this._headerSect) {
-		rowCount = this._headerSect.getRowCount();
+		rowCount = this._headerRows.length;
 		for(r = 0; r < rowCount; ++r) {
 			this._headerRows[r].cell = this._headerSect.getCell(colIndex, r);
 		}
 	}
 	if(this._footerSect) {
-		rowCount = this._footerSect.getRowCount();
+		rowCount = this._footerRows.length;
 		for(r = 0; r < rowCount; ++r) {
 			this._footerRows[r].cell = this._footerSect.getCell(colIndex, r);
 		}
@@ -752,6 +752,11 @@ StatisticsRowPlugin.prototype._renderStatistics = function (colIndex, stats, act
 		var row = rows[r];
 		var txt = null;
 
+		var cell = row.cell;
+		if(cell == null) {
+			continue;
+		}
+
 		var statistic = row.statistic;
 		if(stats.label) {
 			txt = row.label;
@@ -770,12 +775,12 @@ StatisticsRowPlugin.prototype._renderStatistics = function (colIndex, stats, act
 				if(this._ccExt && !this._noColoring) {
 					var rowData = row.cachedData;
 					rowData[stats.field] = num;
-					this._ccExt.applyColor(colIndex, row.cell, rowData, actualUpdate);
+					this._ccExt.applyColor(colIndex, cell, rowData, actualUpdate);
 				}
 			}
 		}
 
-		row.cell.setContent(txt);
+		cell.setContent(txt);
 		row.cell = null;
 	}
 };

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

@@ -37,6 +37,8 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public getConfigObject(gridOptions?: any): any;
 
+    public renderGroups(): void;
+
     public addColumnToGroup(column: any, groupId: string, colIndex: number): void;
 
     public addGroup(groupDef: ColumnGroupingPlugin.GroupDefinition|null): string;
@@ -55,6 +57,8 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public setGroupChildren(groupId: string, newChildList: (string)[]|null): boolean;
 
+    public setGroupName(groupId: string, groupName: string): void;
+
     public getGroupChildren(groupId: string): (string)[]|null;
 
     public getChildColumnIndices(groupId: string): (number)[]|null;

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

@@ -661,9 +661,10 @@ ColumnGroupingPlugin.prototype._spanGroupHorizontally = function (titleSection)
     }
   }
 };
-/** @private
+/** Render all column group headers without affecting cell spans.
+* @public
 */
-ColumnGroupingPlugin.prototype._renderGroups = function () {
+ColumnGroupingPlugin.prototype.renderGroups = function () {
   var hostCount = this._hosts.length;
   var groupMap = this._visibleGroupMap;
   for (var i = 0; i < hostCount; ++i) {
@@ -671,35 +672,42 @@ ColumnGroupingPlugin.prototype._renderGroups = function () {
     if (!section) {
       continue;
     }
-    var arg = {};
     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) {
-        // Overide the defaults
-        cell.setStyle("text-align", node["alignment"] || "");
-        cell.setTooltip(ColumnGroupingPlugin._getTooltip(node));
-        cell.setContent(node["title"] || node["name"]);
+      this._renderGroup(groupMap[id], section);
+    }
+  }
+};
+/** Render single column group header without affecting cell span.
+* @private
+* @param {Object} groupDef
+* @param {Object} section
+*/
+ColumnGroupingPlugin.prototype._renderGroup = function (groupDef, section) {
+  var colIndex = groupDef["colIndex"];
+  if (colIndex == null) {
+    return;
+  }
+  var rowIndex = groupDef["onRow"];
+  var cell = section.getCell(colIndex, rowIndex);
+  if (cell) {
+    // Overide the defaults
+    cell.setStyle("text-align", groupDef["alignment"] || "");
+    cell.setTooltip(ColumnGroupingPlugin._getTooltip(groupDef));
+    cell.setContent(groupDef["name"] || groupDef["title"]);
 
-        // Additional cell settings must be removed in the _applyGrouping() method
-        cell.addClass("no-sort");
-        cell.setAttribute("group-id", node["id"]);
-        if (node["legacyRender"]) {
-          // Built-in version if render receive colIndex, cell, groupDefinition as arguments
-          node["legacyRender"](colIndex, cell, node);
-        }
-        if (node["render"]) {
-          arg["cell"] = cell;
-          arg["colIndex"] = colIndex;
-          arg["groupNode"] = node;
-          node["render"](arg);
-        }
-      }
+    // Additional cell settings must be removed in the _applyGrouping() method
+    cell.addClass("no-sort");
+    cell.setAttribute("group-id", groupDef["id"]);
+    if (groupDef["legacyRender"]) {
+      // Built-in version if render receive colIndex, cell, groupDefinition as arguments
+      groupDef["legacyRender"](colIndex, cell, groupDef);
+    }
+    if (groupDef["render"]) {
+      var arg = {};
+      arg["cell"] = cell;
+      arg["colIndex"] = colIndex;
+      arg["groupNode"] = groupDef;
+      groupDef["render"](arg);
     }
   }
 };
@@ -709,7 +717,7 @@ ColumnGroupingPlugin.prototype._renderGroups = function () {
 */
 ColumnGroupingPlugin.prototype._onPostSectionRender = function (e) {
   if (e.sectionType === "title" && !this._restructuring) {
-    this._renderGroups();
+    this.renderGroups();
   }
 };
 
@@ -1029,6 +1037,26 @@ ColumnGroupingPlugin.prototype.setGroupChildren = function (groupId, newChildLis
   }
   return false;
 };
+/** @public
+* @param {string} groupId
+* @param {string} groupName
+*/
+ColumnGroupingPlugin.prototype.setGroupName = function (groupId, groupName) {
+  if (this._groupDefs.setGroupName(groupId, groupName)) {
+    var groupDef = this._visibleGroupMap[groupId];
+    if (groupDef) {
+      groupDef.name = groupName;
+      var hostCount = this._hosts.length;
+      for (var i = 0; i < hostCount; ++i) {
+        var section = this._hosts[i].getSection("title");
+        if (!section) {
+          continue;
+        }
+        this._renderGroup(groupDef, section);
+      }
+    }
+  }
+};
 /** @private
 * @param {string} groupId
 * @return {!Array.<string>} The list of immediate valid child, including invisible child groups

package/lib/tr-grid-column-selection/es6/ColumnSelection.d.ts

@@ -70,6 +70,8 @@ declare class ColumnSelectionPlugin extends GridPlugin {
 
     public getActiveGrid(): any;
 
+    public dispatchSelectionChanged(): void;
+
 }
 
 export default ColumnSelectionPlugin;

package/lib/tr-grid-column-selection/es6/ColumnSelection.js

@@ -1333,6 +1333,20 @@ ColumnSelectionPlugin.prototype._dispatchSelectionChanged = function (e, colInde
     "event": e
   });
 };
+/** @public
+*/
+
+
+ColumnSelectionPlugin.prototype.dispatchSelectionChanged = function () {
+  var selectedCols = this.getSelectedColumns();
+  var colIndex = selectedCols.length ? selectedCols[0] : -1;
+
+  this._dispatch("selectionChanged", {
+    "selectedCols": selectedCols,
+    "colIndex": colIndex,
+    "grid": this._activeGrid
+  });
+};
 
 export default ColumnSelectionPlugin;
 export { ColumnSelectionPlugin, ColumnSelectionPlugin as ColumnSelection, ColumnSelectionPlugin as ColumnSelectionExtension };

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

@@ -119,6 +119,8 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getActiveColumnField(stackId: string): string;
 
+    public getActiveColumnIndex(stackId: string): number;
+
     public addStackChild(stackId: string, colRef: number|string|null): void;
 
     public removeStackChild(stackId: string, colRef: number|string|null): void;

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

@@ -1045,8 +1045,22 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options) {
 		stack.activeColumn = stack.stackRefs[stack.stackRefs.length - 1]; // Right most column is the active column
 	} else {
 		var csp = this._getPlugin("ColumnSelectionPlugin");
-		if(csp && csp.isEnabled()) {
-			csp.selectSingleColumn(activeIndex);
+		if(csp && csp.isEnabled()){
+			var stackSelection = false;
+			for(i = 0; i < len; ++i){
+				colIndex = colRefs[i];
+				if(colIndex === activeIndex){
+					continue;
+				}
+				if(csp.isSelectedColumn(colIndex)){
+					stackSelection = true;
+					break;
+				}
+			}
+			if(stackSelection) {
+				csp.selectSingleColumn(activeIndex);
+				csp.dispatchSelectionChanged();
+			}
 		}
 	}
 
@@ -1113,7 +1127,6 @@ ColumnStackPlugin.prototype.unstackColumns = function(colIndices) {
 	}
 
 	var dirty = false;
-	var selFrom, selLen;
 
 	for(var sid in stacks) {
 		var stack = this._stacks[sid];
@@ -1124,8 +1137,6 @@ ColumnStackPlugin.prototype.unstackColumns = function(colIndices) {
 
 		var stackRefs = stack.stackRefs;
 		len = stackRefs.length;
-		selFrom = this._getColumnIndex(stack.stackRefs[0]);
-		selLen = len - 1;
 
 		for(i = 0; i < len; ++i) {
 			var stackRef = stackRefs[i];
@@ -1140,10 +1151,6 @@ ColumnStackPlugin.prototype.unstackColumns = function(colIndices) {
 		delete this._stacks[sid]; // Remove all reference to the stack
 	}
 	if(dirty) {
-		var csp = this._getPlugin("ColumnSelectionPlugin");
-		if(csp && csp.isEnabled()) {
-			csp.selectRange(selFrom, selLen);
-		}
 		var cfp = this._getPlugin("ColumnFilterPlugin");
 		if(cfp) {
 			cfp["refresh"]();
@@ -1256,6 +1263,7 @@ ColumnStackPlugin.prototype.swapColumn = function(colRef, swappingIndex) {
 	var csp = this._getPlugin("ColumnSelectionPlugin");
 	if(csp && csp.isEnabled()) {
 		csp.selectSingleColumn(newActiveColumnIndex);
+		csp.dispatchSelectionChanged();
 	}
 	var cfp = this._getPlugin("ColumnFilterPlugin");
 	if(cfp) {
@@ -1513,6 +1521,7 @@ ColumnStackPlugin.prototype._onStackButtonClicked = function(e) {
 	pos["columnIndices"] = colIndices;
 	pos["activeColIndex"] = this._getColumnIndex(colData.activeColumn);
 	pos["event"] = e;
+	pos["stackId"] = colData.stackId;
 
 	elem.focus();
 	this._dispatch("clicked", pos);
@@ -1809,15 +1818,29 @@ ColumnStackPlugin.prototype.getStackName = function(stackId) {
 */
 ColumnStackPlugin.prototype.getActiveColumnField = function(stackId) {
 	var field  = "";
+	var activeColIndex = this.getActiveColumnIndex(stackId);
+	if(activeColIndex !== -1){
+		field = this._getField(activeColIndex);
+	}
+	return field;
+};
+
+/** @public
+* @description Get active column index of specific stack
+* @param {string} stackId
+* @return {number} active column index
+*/
+ColumnStackPlugin.prototype.getActiveColumnIndex = function(stackId) {
+	var activeColIndex  = -1;
 	if(stackId !== null) {
 		var stack = this._stacks[stackId];
 		if(stack){
-			var activeColIndex = this._getColumnIndex(stack.activeColumn);
-			field = this._getField(activeColIndex);
+			activeColIndex = this._getColumnIndex(stack.activeColumn);
 		}
 	}
-	return field;
+	return activeColIndex;
 };
+//getActiveColumnIndex
 
 /** @public
 * @param {string} stackId

package/lib/tr-grid-row-dragging/es6/RowDragging.d.ts

@@ -39,7 +39,7 @@ declare class RowDraggingPlugin extends GridPlugin {
 
     public getConfigObject(out_obj?: any): any;
 
-    public startDrag(startRef: any, opt_suppressEvent?: boolean|null): void;
+    public startDrag(startRef?: any): void;
 
     public stopDrag(): void;
 
@@ -53,6 +53,28 @@ declare class RowDraggingPlugin extends GridPlugin {
 
     public disableUIs(disabled?: boolean|null): void;
 
+    public allowDrag(allowed?: boolean|null): void;
+
+    public allowDrop(allowed?: boolean|null): void;
+
+    public setDragContent(content: any): void;
+
+    public getDragBox(): Element|null;
+
+    public getDragSource(): string;
+
+    public isDragging(): boolean;
+
+    public disableDragging(disabled?: boolean|null): void;
+
+    public enableJETDragAndDrop(enabled?: boolean|null): void;
+
+    public getJETDragContent(): any;
+
+    public setJETDragContent(content: any): void;
+
+    public setJETDragContent(content: any): void;
+
 }
 
 export default RowDraggingPlugin;