@refinitiv-ui/efx-grid 6.0.33 → 6.0.35

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

@@ -1,70 +1,147 @@
+import { cloneObject } from "../../tr-grid-util/es6/Util.js";
+
+/** @private
+* @param {*} a
+* @param {*} b
+* @param {number} order
+* @return {number}
+*/
+var _defaultCompare = function(a, b, order) {
+	if(a == null || a !== a) {
+		if(b == null || b !== b) {
+			return 0;
+		}
+		return 1;
+	}
+	if(b == null || b !== b) {
+		return -1;
+	}
+
+	if(a < b) {
+		return -order;
+	}
+	if(b < a) {
+		return order;
+	}
+	return 0;
+};
+
 /** @constructor
 */
 var RowDefSorter = function() {
 	this._defaultSorter = this._defaultSorter.bind(this);
 	this._dataSorter = this._dataSorter.bind(this);
 	this._rowDefSorter = this._rowDefSorter.bind(this);
+	this._multiColumnsSorter = this._multiColumnsSorter.bind(this);
 
-	this._sortContext = {};
+	this._globalContext = {};
+	this._sortParams = [];
+	this._ctxCaches = [];
 };
 
-
-/** @type {string}
+/** @type {!Object}
 * @private
 */
-RowDefSorter.prototype._field = "";
-/** @type {!Object}
+RowDefSorter.prototype._globalContext;
+/** @type {!Array.<Array>}
+* @private
+*/
+RowDefSorter.prototype._sortParams;
+/** @type {!Array.<Object>}
 * @private
 */
-RowDefSorter.prototype._sortContext;
-/** @type {Function}
+RowDefSorter.prototype._ctxCaches;
+/** @type {Array}
 * @private
 */
-RowDefSorter.prototype._sortLogic = null;
+RowDefSorter.prototype._primaryParams;
 
 
 /** @public
 */
 RowDefSorter.prototype.dispose = function() {
-	this._sortLogic = null;
-	this._sortContext = {}; // Clear any existing reference
+	this._globalContext = {}; // Clear any existing reference
+	this._sortParams.length = 0;
+	this._ctxCaches.length = 0;
+	this._primaryParams = null;
 };
 
 /** @public
-* @param {boolean=} rowSorting=false
 * @return {Function}
 */
-RowDefSorter.prototype.getSorter = function(rowSorting) {
-	if(this._sortLogic) {
-		return rowSorting ? this._rowDefSorter : this._dataSorter;
-	} else {
-		return this._defaultSorter;
+RowDefSorter.prototype.getSorter = function() {
+	this._primaryParams = null;
+	var sortCount = this._sortParams.length;
+	if(sortCount === 1) {
+		var params = this._primaryParams = this._sortParams[0];
+		var sortLogic = params[1];
+		if(sortLogic) {
+			var rowSorting = params[3];
+			return rowSorting ? this._rowDefSorter : this._dataSorter;
+		} else {
+			return this._defaultSorter;
+		}
+	} else if(sortCount > 1) {
+		return this._multiColumnsSorter;
 	}
-};
-/** @public
-* @param {Function=} func
-*/
-RowDefSorter.prototype.setSortLogic = function(func) {
-	this._sortLogic = (typeof func === "function") ? func : null;
-};
 
+	return RowDefSorter._noSorting;
+};
 
 /** @public
-* @param {string} field
+* @param {string} key
+* @param {*} value
 */
-RowDefSorter.prototype.setField = function(field) {
-	if(!field) {
-		field = "";
+RowDefSorter.prototype.reset = function() {
+	if(this._sortParams.length) {
+		this._sortParams.length = 0;
 	}
-	this._sortContext["field"] = this._field = field;
-	this._sortContext["formattedField"] = field + "_FORMATTED";
 };
 /** @public
 * @param {string} key
 * @param {*} value
 */
 RowDefSorter.prototype.setContext = function(key, value) {
-	this._sortContext[key] = value;
+	this._globalContext[key] = value;
+};
+/** @public
+* @param {string} field
+* @param {Function} logic
+* @param {boolean} rowSorting
+* @param {string} order
+* @param {number} colIndex
+* @param {*} colDef
+*/
+RowDefSorter.prototype.addColumnContext = function(field, logic, rowSorting, order, colIndex, colDef) {
+	if(!field) {
+		field = "";
+	}
+	var sortPriority = this._sortParams.length;
+	var ctx = this._ctxCaches[sortPriority];
+	if(!ctx) {
+		ctx = this._ctxCaches[sortPriority] = cloneObject(this._globalContext);
+	}
+	var orderNum = 0;
+	if(order === "a") {
+		orderNum = 1;
+	} else if(order === "d") {
+		orderNum = -1;
+	}
+
+	var params = [
+		field, // 0
+		(typeof logic === "function") ? logic : null,  // 1
+		ctx, // 2
+		rowSorting, // 3
+		orderNum  // 4
+	];
+
+	ctx["colIndex"] = colIndex;
+	ctx["field"] = field;
+	ctx["formattedField"] = field + "_FORMATTED";
+	ctx["colDef"] = colDef;
+
+	this._sortParams.push(params);
 };
 
 /** @private
@@ -73,32 +150,7 @@ RowDefSorter.prototype.setContext = function(key, value) {
 * @param {number} order
 * @return {number}
 */
-RowDefSorter.prototype._defaultSorter = function(rowDefA, rowDefB, order) {
-	var orderA = rowDefA.getGroupOrder();
-	var orderB = rowDefB.getGroupOrder();
-	if(orderA !== orderB) {
-		return orderA - orderB; // Regardless of sort order
-	}
-
-	var a = rowDefA.getData(this._field);
-	var b = rowDefB.getData(this._field);
-
-	if(a == null || a !== a) {
-		if(b == null || b !== b) {
-			return 0;
-		}
-		return 1;
-	}
-	if(b == null || b !== b) {
-		return -1;
-	}
-
-	if(a < b) {
-		return -order;
-	}
-	if(b < a) {
-		return order;
-	}
+RowDefSorter._noSorting = function(rowDefA, rowDefB, order) {
 	return 0;
 };
 /** @private
@@ -107,16 +159,30 @@ RowDefSorter.prototype._defaultSorter = function(rowDefA, rowDefB, order) {
 * @param {number} order
 * @return {number}
 */
+RowDefSorter.prototype._defaultSorter = function(rowDefA, rowDefB, order) {
+	var field = this._primaryParams[0];
+	return _defaultCompare(
+		rowDefA.getData(field),
+		rowDefB.getData(field),
+		order
+	);
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
 RowDefSorter.prototype._dataSorter = function(rowDefA, rowDefB, order) {
-	var orderA = rowDefA.getGroupOrder();
-	var orderB = rowDefB.getGroupOrder();
-	if(orderA !== orderB) {
-		return orderA - orderB; // Regardless of sort order
-	}
-
-	var a = rowDefA.getData(this._field);
-	var b = rowDefB.getData(this._field);
-	return this._sortLogic(a, b, order, this._sortContext);
+	var params = this._primaryParams;
+	var field = params[0];
+	var sortLogic = params[1];
+	return sortLogic(
+		rowDefA.getData(field),
+		rowDefB.getData(field),
+		order,
+		params[2]
+	);
 };
 /** @private
 * @param {RowDefinition} rowDefA
@@ -125,13 +191,41 @@ RowDefSorter.prototype._dataSorter = function(rowDefA, rowDefB, order) {
 * @return {number}
 */
 RowDefSorter.prototype._rowDefSorter = function(rowDefA, rowDefB, order) {
-	var orderA = rowDefA.getGroupOrder();
-	var orderB = rowDefB.getGroupOrder();
-	if(orderA !== orderB) {
-		return orderA - orderB; // Regardless of sort order
+	var params = this._primaryParams;
+	var sortLogic = params[1];
+	return sortLogic(rowDefA, rowDefB, order, params[2]);
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} primaryOrder
+* @return {number}
+*/
+RowDefSorter.prototype._multiColumnsSorter = function(rowDefA, rowDefB, primaryOrder) {
+	var sortParams = this._sortParams;
+	var sortCount = sortParams.length;
+	for(var i = 0; i < sortCount; ++i) {
+		var params = sortParams[i];
+		var field = params[0];
+		var sortLogic = params[1];
+		var ctx = params[2];
+		var rowSorting = params[3];
+		var orderNum = params[4];
+		var ret = 0;
+		if(sortLogic) {
+			if(rowSorting) {
+				ret = sortLogic(rowDefA, rowDefB, orderNum, ctx);
+			} else {
+				ret = sortLogic(rowDefA.getData(field), rowDefB.getData(field), orderNum, ctx);
+			}
+		} else {
+			ret = _defaultCompare(rowDefA.getData(field), rowDefB.getData(field), orderNum);
+		}
+		if(ret) {
+			return ret;
+		}
 	}
-
-	return this._sortLogic(rowDefA, rowDefB, order, this._sortContext);
+	return 0;
 };
 
 export default RowDefSorter;

package/lib/rt-grid/es6/RowDefinition.d.ts

@@ -6,6 +6,7 @@ declare namespace RowDefinition {
 
     type Options = {
         ric?: string|null,
+        permId?: string|null,
         values?: (any[]|any)|null,
         fields?: (string)[]|null,
         asChain?: boolean|null,
@@ -36,7 +37,7 @@ declare class RowDefinition {
 
     public initialize(rowOptions?: RowDefinition.Options|null): void;
 
-    public setContent(userInput: string): boolean;
+    public setContent(userInput: string, permId?: string|null): boolean;
 
     public getRowId(): string;
 
@@ -70,6 +71,10 @@ declare class RowDefinition {
 
     public getRic(): string;
 
+    public getPermId(): string;
+
+    public getSymbol(): string;
+
     public getDisplayText(): string;
 
     public getLabel(): string|null|null;
@@ -138,7 +143,7 @@ declare const ROW_DEF: string;
 
 declare const ROW_TYPES: RowDefinition.RowTypes;
 
-declare function rowData(userInput: string): boolean;
+declare function rowData(userInput: string, permId?: string|null): boolean;
 
 export {RowDefinition, ROW_DEF, ROW_TYPES};
 export default RowDefinition;

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

@@ -7,6 +7,7 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 /** @typedef {Object} RowDefinition~Options
 * @description RowDefinition options
 * @property {string=} ric="" RIC for real-time fields. Prefixing 0# to the ric is equivalent to specifying asChain property.
+* @property {string=} permId="" Organization PermId to be used instead of ric for private company.
 * @property {(Array|Object)=} values=null Values for static data
 * @property {Array.<string>=} fields=null Field that corresponds to the given static values
 * @property {boolean=} asChain=false The given ric will be treated as a chain
@@ -88,6 +89,10 @@ RowDefinition.prototype._ric = ""; // Contains no 0#
 /** @type {string}
 * @private
 */
+RowDefinition.prototype._permId = "";
+/** @type {string}
+* @private
+*/
 RowDefinition.prototype._displayText = "";
 /** @type {string|null}
 * @private
@@ -213,13 +218,20 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 
 	var val = rowOptions["ric"];
 	if(val != null) {
-		this.setContent(/** @type{string} */(val)); // this._dataId is modified
+		this._ric = val;
+	}
+	val = rowOptions["permId"];
+	if(val != null) {
+		this._permId = val;
+	}
+	if(this._ric || this._permId){
+		this.setContent(this._ric, this._permId); // this._dataId is modified
 	}
+
 	val = rowOptions["chainRic"];
 	if(val != null) {
 		this._chainRic = val;
 	}
-
 	val = rowOptions["values"];
 	// eslint-disable-next-line no-undefined
 	if(val !== undefined) {
@@ -273,10 +285,11 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 	}
 };
 /** @public
-* @param {string} userInput
+* @param {string} userInput RIC
+* @param {string=} permId=null Organization PermId, which use for getting ADC data for private  company
 * @return {boolean} True if there is any change otherwise false
 */
-RowDefinition.prototype.setContent = function(userInput) {
+RowDefinition.prototype.setContent = function(userInput, permId) {
 	if(this._autoGenerated) { // AutoGenerated RowDefinition cannot be changed by user input
 		return false;
 	}
@@ -287,7 +300,15 @@ RowDefinition.prototype.setContent = function(userInput) {
 		userInput += "";
 	}
 
-	if(this._userInput === userInput) {
+	var dirty = (this._userInput !== userInput);
+	if(this._permId !== permId){
+		this._permId = permId || "";
+		if(!userInput){
+			this._displayText = this._permId;
+			dirty = true;
+		}
+	}
+	if(!dirty) {
 		return false;
 	}
 
@@ -314,7 +335,7 @@ RowDefinition.prototype.setContent = function(userInput) {
 		this._displayText = this._ric; // No 0#
 	}
 
-	this._dataId = this._rowId + this._ric; // JET/RTK will generate data id to be rowId (given from this rowDef) + ric;
+	this._dataId = this._rowId + this.getSymbol(); // JET/RTK will generate data id to be rowId (given from this rowDef) + ric;
 
 	// This will work for runtime ric modification, but not for first initilization.
 	if(!this.subscribeForUpdates()) {
@@ -342,6 +363,11 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["ric"] = val;
 	}
 
+	val = this._permId;
+	if(val) {
+		obj["permId"] = val;
+	}
+
 	val = this._chainRic;
 	if(val) {
 		obj["chainRic"] = val;
@@ -587,6 +613,18 @@ RowDefinition.prototype.getRic = function() {
 /** @public
 * @return {string}
 */
+RowDefinition.prototype.getPermId = function() {
+	return this._permId;
+};
+/** @public
+* @return {string}
+*/
+RowDefinition.prototype.getSymbol = function() {
+	return this._ric || this._permId;
+};
+/** @public
+* @return {string}
+*/
 RowDefinition.prototype.getDisplayText = function() {
 	if(this._label != null) { // Empty string is allowed
 		return this._label;
@@ -652,7 +690,7 @@ RowDefinition.prototype.isAutoGenerated = function() {
 * @return {boolean}
 */
 RowDefinition.prototype.isRealTimeRow = function() {
-	if(!this._ric) { // Empty row
+	if(!this.getRic()) { // Empty row
 		return false;
 	}
 	if(this.isRowHeader()) {
@@ -669,7 +707,7 @@ RowDefinition.prototype.isRealTimeRow = function() {
 * @return {boolean} If a subscription is made, return true.
 */
 RowDefinition.prototype.subscribeForUpdates = function() {
-	if(!this.isRealTimeRow()) {
+	if(!this.isRealTimeRow() && !this.getPermId()) {
 		return false;
 	}
 
@@ -683,14 +721,14 @@ RowDefinition.prototype.subscribeForUpdates = function() {
 	if(this.isChain()) {
 		this._subId = subs["addChain"](this._chainRic || this._ric, this._rowId); // Some chain require 0# symbol to populate its constituents
 		// TODO: Handle Dynamic chain such as .PG.PA
-	} else {
+	} else if(this._ric) {
 		this._subId = subs["addRic"](this._ric, this._rowId);
 	}
 
 	if(prevRowData) {
 		this._dc.setRowData(this._dataId, prevRowData); // TODO: We may need to create a new object instead of prevRowData for data correctness
 	} else {
-		this._dc.setRowData(this._dataId, {"X_RIC_NAME": this._ric, "ROW_DEF": this}); // Trigger data update immediately
+		this._dc.setRowData(this._dataId, {"X_RIC_NAME": this.getSymbol(), "ROW_DEF": this}); // Trigger data update immediately
 	}
 	return true;
 };

package/lib/rt-grid/es6/SnapshotFiller.d.ts

@@ -2,6 +2,7 @@ import Grid from "./Grid.js";
 import {Ext} from "../../tr-grid-util/es6/Ext.js";
 import {EventDispatcher} from "../../tr-grid-util/es6/EventDispatcher.js";
 import {FieldDefinition} from "./FieldDefinition.js";
+import { isEmptyObject } from "../../tr-grid-util/es6/Util.js";
 
 declare class SnapshotFiller extends EventDispatcher {
 

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

@@ -3,17 +3,7 @@ import Grid from "./Grid.js";
 import {Ext} from "../../tr-grid-util/es6/Ext.js";
 import {EventDispatcher} from "../../tr-grid-util/es6/EventDispatcher.js";
 import {FieldDefinition} from "./FieldDefinition.js";
-
-/** @private
-* @param {Object} obj
-* @return {boolean}
-*/
-var isEmptyObject = function (obj) {
-	for (var key in obj) {
-		return false;
-	}
-	return true;
-};
+import { isEmptyObject } from "../../tr-grid-util/es6/Util.js";
 
 /** This class make requesting ADC field easier by encapsulating JET.Data APIs and mapping data to the row
 * @constructor

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

@@ -38,6 +38,8 @@ var ColumnSelectionPlugin = function ColumnSelectionPlugin(options) {
   t._onReselection = t._onReselection.bind(t);
   t._onThemeLoaded = t._onThemeLoaded.bind(t);
   t._onColumnPositionChanged = t._onColumnPositionChanged.bind(t);
+  t._onBeforeBatchOperation = t._onBeforeBatchOperation.bind(t);
+  t._onAfterBatchOperation = t._onAfterBatchOperation.bind(t);
   t._updateMenuIcon = t._updateMenuIcon.bind(t);
   t._hosts = [];
 
@@ -121,6 +123,12 @@ ColumnSelectionPlugin.prototype._menuPosition = "outside";
 
 ColumnSelectionPlugin.prototype._cgp = null; // Column grouping extension
 
+/** @type {Array.<string>}
+* @private
+*/
+
+ColumnSelectionPlugin.prototype._prevSelectedCols = {}; // previous selected columns during batch operation
+
 /** @public
 * @return {string}
 */
@@ -156,6 +164,8 @@ ColumnSelectionPlugin.prototype.initialize = function (host, options) {
   host.listen("columnRemoved", this._onColumnRemoved);
   host.listen("columnAdded", this._onColumnAdded);
   host.listen("columnPositionChanged", this._onColumnPositionChanged);
+  host.listen("beforeBatchOperation", this._onBeforeBatchOperation);
+  host.listen("afterBatchOperation", this._onAfterBatchOperation);
   this.config(options);
 
   if (ColumnSelectionPlugin._stylePromise) {
@@ -1098,6 +1108,62 @@ ColumnSelectionPlugin.prototype._onReselection = function (e) {
   this._activeGrid.focus();
 };
 /** @private
+* @param {Object} e
+*/
+
+
+ColumnSelectionPlugin.prototype._onBeforeBatchOperation = function (e) {
+  var host = this._activeGrid;
+
+  if (this._hasSelection && e["batchType"] === "reset") {
+    var colCount = this.getColumnCount();
+
+    for (var i = 0; i < colCount; ++i) {
+      if (this.isSelectedColumn(i)) {
+        var colId = host.getColumnId(i);
+        var field = host.getColumnField(i);
+
+        if (colId) {
+          this._prevSelectedCols[colId] = field;
+        } else {
+          this._prevSelectedCols[field] = "";
+        }
+      }
+    }
+
+    this.clearAllSelections(); //clear all to improve performance during add/remove operation
+  }
+};
+/** @private
+* @param {Object} e
+*/
+
+
+ColumnSelectionPlugin.prototype._onAfterBatchOperation = function (e) {
+  if (e["batchType"] === "reset") {
+    var prevSelectedCols = Object.keys(this._prevSelectedCols);
+    var prevSelectedCount = prevSelectedCols.length;
+
+    if (prevSelectedCount) {
+      this.clearAllSelections();
+
+      for (var i = 0; i < prevSelectedCount; i++) {
+        var colId = prevSelectedCols[i];
+        var field = this._prevSelectedCols[colId];
+        var prevSelectedIndex = this.getColumnIndex(colId);
+
+        if (prevSelectedIndex < 0) {
+          prevSelectedIndex = this.getColumnIndex(field);
+        }
+
+        this.setSelectedColumn(prevSelectedIndex, true);
+      }
+
+      this._prevSelectedCols = {};
+    }
+  }
+};
+/** @private
 * @param {KeyboardEvent} e
 * @return {boolean}
 */

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

@@ -137,6 +137,8 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public isStackHidden(stackId: string): boolean|null|null;
 
+    public moveStack(stackId: string, destCol?: (number|string)|null): boolean;
+
 }
 
 export default ColumnStackPlugin;

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

@@ -1314,16 +1314,7 @@ ColumnStackPlugin.prototype._onColumnRemoved = function (e) {
 					delete this._stacks[stackOpt.stackId];
 				}
 			} else {
-				if(stackOpt.spreading) {
-					stackOpt.activeColumn = stackOpt.stackRefs[stackOpt.stackRefs.length - 1];
-				} else {
-					stackOpt.activeColumn = stackOpt.stackRefs[0];
-				}
-
-				// TODO: Add a proper way to set visibility to activeColumn when activeColumn is changed
-				var activeColIndex = this._getColumnIndex(stackOpt.activeColumn);
-				this._setColumnVisibility(activeColIndex, true);
-				this._updateUI();
+				this._updateActiveColumn(stackOpt);
 			}
 		}
 	}
@@ -1876,11 +1867,11 @@ ColumnStackPlugin.prototype.unsetParent = ColumnStackPlugin.prototype.removeColu
 */
 ColumnStackPlugin.prototype.reorderColumns = function(colList, destCol) {
 	var dirty = false;
-	this._stacking = false;
+	this._stacking = true;
 
-	this._reorderColumns(colList, destCol);
+	dirty = this._reorderColumns(colList, destCol);
 
-	this._stacking = true;
+	this._stacking = false;
 	return dirty;
 };
 /** Move the specified column to position before the destination
@@ -1922,6 +1913,26 @@ ColumnStackPlugin.prototype._setStackVisibility = function(stackId, visible) {
 	}
 };
 
+/** @private
+* @description Check for active column in a stack if it needs an update.
+* @param {Object} stackOpt
+*/
+ColumnStackPlugin.prototype._updateActiveColumn = function(stackOpt) {
+	if(!stackOpt) { return; }
+
+	var stackRefs = stackOpt["stackRefs"];
+	if(!stackRefs || !stackRefs.length) { return; }
+
+	if(stackRefs.indexOf(stackOpt.activeColumn) === -1) {
+		stackOpt.activeColumn = stackOpt["spreading"] ? stackRefs[stackRefs.length - 1] : stackRefs[0];
+
+		// TODO: Add a proper way to set visibility to activeColumn when activeColumn is changed
+		var activeColIndex = this._getColumnIndex(stackOpt.activeColumn);
+		this._setColumnVisibility(activeColIndex, true);
+		this._updateUI();
+	}
+};
+
 /** @public
 * @description Hide specific stack from grid
 * @param {string} stackId
@@ -1962,6 +1973,20 @@ ColumnStackPlugin.prototype.isStackHidden = function(stackId) {
 
 	return !isVisible;
 };
+/** Move an entire stack to position before the destination
+* @public
+* @param {string} stackId Stack id to be moved
+* @param {(number|string)=} destCol Destination column id or index
+* @return {boolean}
+*/
+ColumnStackPlugin.prototype.moveStack = function(stackId, destCol) {
+	if(!stackId){
+		return false;
+	}
+	var colList = this.getStackMemberIds(stackId);
+	var dirty = this.reorderColumns(colList, destCol);
+	return dirty;
+};