@refinitiv-ui/efx-grid 6.0.33 → 6.0.35

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

@@ -579,7 +579,7 @@ ColumnDefinition.prototype.getAllFields = function() {
 * @return {boolean}
 */
 ColumnDefinition.prototype.isRealTimeField = function() {
-	return FieldDefinition.isRealTimeField(this.getField());
+	return FieldDefinition.isRealTimeField(this.getField() || this._field);
 };
 /** @public
 * @return {boolean}
@@ -770,8 +770,9 @@ ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 		obj["sort"] = this._initialOrder;
 	}
 
-	if(this._classes) {
-		obj["className"] = this._classes.join(" ");
+	var classes = this._classes;
+	if(classes && classes.length > 0) {
+		obj["className"] = classes.join(" ");
 	}
 
 	if(this._textSelect) {
@@ -789,14 +790,18 @@ ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 	var core = this._eventArg["core"];
 	var grid = this._eventArg["grid"];
 	var colIndex = grid.getColumnIndex(this);
-	value = core.getColumnScalability(colIndex);
-	obj["scalable"] = value;
 
-	value = core.getColumnCustomLaneSize(colIndex);
-	obj["width"] = value;
+	// The scalable, width and minWidth cannot be shifted into core as getConfigObject is accessible from colDef.
+	var scalable = core.getColumnScalability(colIndex);
+	var width = core.getColumnCustomLaneSize(colIndex);
+
+	if (scalable !== true || width !== 1) {
+		obj["scalable"] = scalable;
+		obj["width"] = width;
+	}
 
 	value = core.getMinimumColumnWidth(colIndex);
-	if(value !== 32) {
+	if(value !== 0) {
 		obj["minWidth"] = value;
 	}
 

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

@@ -85,7 +85,7 @@ DataConnector.prototype.getRowDefByRic = function (ric) {
 * @return {boolean} True if new reference is added.
 */
 DataConnector.prototype.addRic = function (rowDef) {
-	var ric = rowDef ? rowDef.getRic() : "";
+	var ric = rowDef ? rowDef.getSymbol() : "";
 	if(!ric) {
 		return false;
 	}
@@ -113,7 +113,8 @@ DataConnector.prototype.addRic = function (rowDef) {
 */
 DataConnector.prototype.removeRic = function (rowDef, ric) {
 	if(!ric) {
-		ric = rowDef ? rowDef.getRic() : "";
+		// TODO: RIC or permId maybe change during run-time, need to check before remove RIC/permId
+		ric = rowDef ? rowDef.getSymbol() : "";
 	}
 	if(!ric) {
 		return;

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

@@ -3,7 +3,7 @@ import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { EventDispatcher } from "../../tr-grid-util/es6/EventDispatcher.js";
 import { Engine } from "../../tr-grid-util/es6/formula/Engine.js";
-import { cloneObject, extendObject, arrayToObject } from "../../tr-grid-util/es6/Util.js";
+import { cloneObject, extendObject, arrayToObject, isEmptyObject, deepEqual } from "../../tr-grid-util/es6/Util.js";
 import { DateTime } from "../../tr-grid-util/es6/DateTime.js";
 
 import { RowDefinition, ROW_DEF } from "./RowDefinition.js";
@@ -134,6 +134,8 @@ declare class Grid extends EventDispatcher {
 
     public setColumns(columns: (any)[]|null): void;
 
+    public restoreColumns(columns: (any)[]|null): void;
+
     public setFields(ary: (string)[]|null): void;
 
     public removeColumn(colRef: Grid.ColumnReference|null): void;

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

@@ -4,7 +4,7 @@ import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { EventDispatcher } from "../../tr-grid-util/es6/EventDispatcher.js";
 import { Engine } from "../../tr-grid-util/es6/formula/Engine.js";
-import { cloneObject, extendObject, arrayToObject } from "../../tr-grid-util/es6/Util.js";
+import { cloneObject, extendObject, arrayToObject, isEmptyObject, deepEqual } from "../../tr-grid-util/es6/Util.js";
 import { DateTime } from "../../tr-grid-util/es6/DateTime.js";
 
 import { RowDefinition, ROW_DEF } from "./RowDefinition.js";
@@ -1062,6 +1062,28 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 		grid.getConfigObject(obj);
 	}
 
+	// Difference from composite grid in default config
+	if(obj["columnVirtualization"] === false) {
+		delete obj["columnVirtualization"];
+	}
+
+	if(obj["rowVirtualization"] === true) {
+		delete obj["rowVirtualization"];
+	}
+
+	if(obj["rowHighlighting"] === true) {
+		delete obj["rowHighlighting"];
+	}
+
+	if(obj["contentVerticalLines"] === false) { // the default value change in wrapper (atlas-blotter)
+		delete obj["contentVerticalLines"];
+	}
+
+	if(obj["borders"] === false) { // the default value change in wrapper (atlas-blotter)
+		delete obj["borders"];
+	}
+
+
 	var i, len;
 	len = this.getColumnCount();
 	for (i = 0; i < len; ++i) {
@@ -1086,12 +1108,12 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	}
 
 	val = grid.getDefaultRowHeight();
-	if(val !== 32) {
+	if(val !== 28) { // the default value change in wrapper (atlas-blotter)
 		obj["rowHeight"] = val;
 	}
 
 	val = grid.getSection("title").getDefaultRowHeight();
-	if(val !== 32) {
+	if(val !== 28) { // the default value change in wrapper (atlas-blotter)
 		obj["headerRowHeight"] = val;
 	}
 
@@ -1099,7 +1121,8 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 		obj["autoLayoutUpdate"] = true;
 	}
 
-	if (this._defaultColumnOptions) {
+	val = isEmptyObject(this._defaultColumnOptions);
+	if (!val) { // Currently, this variable is the object, we need to check empty array for default value
 		obj["defaultColumnOptions"] = this._defaultColumnOptions;
 	}
 
@@ -1158,10 +1181,13 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	}
 
 	// TODO: The following states need to be retrieved
-	// rowHighlighting
-	// columnVirtualization
 	// topFreezingCount, bottomFreezingCount
 	// scrollbarParent
+	// linearWheelScrolling
+	// stepScroll
+	// noColumnDragging
+	// columnReorder
+	// topSection
 
 	// NOTE: no need to export synapseApiKey, ADC and RTK
 
@@ -1237,7 +1263,7 @@ Grid.prototype._onRicAdded = function(e) {
 		var jLen = rowDefs ? rowDefs.length : 0;
 		for (var j = 0; j < jLen; ++j) {
 			var rowDef = rowDefs[j];
-			if (rowDef.getRic() === ric) {
+			if (rowDef.getSymbol() === ric) {
 				this._snapshot.addRic(ric); // ADC
 			}
 		}
@@ -1262,7 +1288,7 @@ Grid.prototype._onFieldAdded = function(e) {
 
 	// ADC
 	for (var i in rowDefs) {
-		this._snapshot.addRic(rowDefs[i].getRic());
+		this._snapshot.addRic(rowDefs[i].getSymbol());
 	}
 	this._snapshot.addFields(addedFields);
 
@@ -1456,7 +1482,7 @@ Grid.prototype.replaceColumn = function (columnOption, colRef) {
 	colConfig["width"] = value;
 
 	value = core.getMinimumColumnWidth(colIndex);
-	if(value !== 32) {
+	if(value > 0) {
 		colConfig["minWidth"] = value;
 	}
 
@@ -1594,22 +1620,101 @@ Grid.prototype._shouldLoadFieldInfo = function (field) {
 * @param {Array.<Object>} columns Array of column options
 */
 Grid.prototype.setColumns = function(columns) {
+	var grid = this._grid;
 	var colCount = (columns) ? columns.length : 0;
 
+	grid.startBatch("reset");
 	this.removeAllColumns();
 	if(colCount > 0) {
 		var prevState = false;
 		if(colCount > 1) {
-			prevState = this._grid.freezeLayout(true); // Insert multiple columns can be a huge time consuming
+			prevState = grid.freezeLayout(true); // Insert multiple columns can be a huge time consuming
 		}
 		for(var i = 0; i < colCount; ++i) {
 			this.insertColumn(columns[i], i);
 		}
 		if(colCount > 1) {
-			this._grid.freezeLayout(prevState);
+			grid.freezeLayout(prevState);
 		}
 	}
+	grid.stopBatch("reset");
 };
+
+
+/** Remove, add and keep column based on the given column data
+* @public
+* @param {Array.<Object>} columns Array of column options
+*/
+Grid.prototype.restoreColumns = function(columns) {
+	var grid = this._grid;
+	grid.startBatch("reset");
+	var configObj = this.getConfigObject();
+	var previousColumns = configObj.columns;
+
+	var preColLen = previousColumns.length;
+	var newColLen = columns.length;
+
+	var removingFields = [];
+	var keepingColumns = [];
+	var columnOrdering = [];
+
+	var i, j, found;
+	// Slow, time complexity BigO(n ^ 2)
+	for (i = 0; i < preColLen; i++) {
+		found = false;
+		for (j = 0; j < newColLen; j++) {
+			if (deepEqual(previousColumns[i], columns[j])) {
+				keepingColumns.push(previousColumns[i]);
+				found = true;
+				break;
+			}
+		}
+		if (!found) {
+			removingFields.push(previousColumns[i].field);
+		}
+	}
+
+	var sortingStates;
+	var removeLen = removingFields.length;
+	if(removeLen > 0 && this._stp) {
+		sortingStates = this._stp.getSortingStates().slice(); // We need to clone array for avoid object reference in remove column
+	}
+
+	this.removeColumns(removingFields);
+
+	var keepingLen = keepingColumns.length;
+	var prevState = false;
+	if(newColLen > 1) {
+		prevState = this._grid.freezeLayout(true); // Insert multiple columns can be a huge time consuming
+	}
+	for (i = 0; i < newColLen; i++) {
+		found = false;
+		for (j = 0; j < keepingLen; j++) { // loop only keeping column
+			if (deepEqual(columns[i], keepingColumns[j])) {
+				found = true;
+				var colIndex = this.getColumnIndex(columns[i].field); // We cannot use 'i' (colIndex) in this case, as it will sort the columns. Instead, we need to obtain a new column index from the field.
+				columnOrdering.push(this.getColumnId(colIndex));
+				break;
+			}
+		}
+		if (!found) {
+			this.insertColumn(columns[i], i);
+			columnOrdering.push(this.getColumnId(i)); // Use new insertion column index
+		}
+	}
+
+	if(newColLen > 1) {
+		this._grid.freezeLayout(prevState);
+	}
+
+	if(removeLen > 0 && this._stp) {
+		this._stp.sortColumns(sortingStates);
+	}
+
+	grid.reorderColumns(columnOrdering);
+	grid.stopBatch("reset");
+};
+
 /** Remove all existing columns and add new columns based on the given texts/fields
 * @public
 * @function
@@ -1754,10 +1859,11 @@ Grid.prototype.removeColumn = function(colRef) {
 			this._dc.removeStaticFields([colDef.getField()]);
 		}
 	}
-	colDef.dispose();
-	this._grid.removeColumnAt(colIndex);
 
+	this._grid.removeColumnAt(colIndex);
 	this._connector.removeFields(colDef);
+
+	colDef.dispose(); // Dispose at the last line to avoid making properties inaccessible
 	// TODO: Remove fields that are related to the column (e.g. fields for coloring)
 };
 /** Remove multiple columns through array. To remove all columns, use removeAllColumns() instead of this method
@@ -2103,7 +2209,7 @@ Grid.prototype.setColumnSorter = function(colRef, func) {
 * @param {RowDefinition} rowDef
 */
 Grid.prototype._initDuplicateRicData = function(rowDef) {
-	var ric = rowDef.getRic();
+	var ric = rowDef.getSymbol();
 	var rowDefs = this._connector.getRowDefByRic(ric);
 	if(rowDefs && rowDefs.length) {
 		cloneRowData(rowDefs[0], rowDef);
@@ -2520,8 +2626,9 @@ Grid.prototype.setRic = function(rowRef, str, options) {
 				this.insertRow(options, rowIndex);
 			}
 		} else {
-			var oldRic = rowDef.getRic();
-			if(rowDef.setContent(str)) { // The given string may not be a RIC
+			var oldRic = rowDef.getSymbol();
+			var permId = options["permId"] || "";
+			if(rowDef.setContent(str, permId)) { // The given string may not be a RIC
 				this._connector.removeRic(rowDef, oldRic);
 				this._initDuplicateRicData(rowDef);
 				this._connector.addRic(rowDef);
@@ -2842,7 +2949,7 @@ Grid.prototype.setRicData = function(ric, values) {
 	var rowCount = rowDefs ? rowDefs.length : 0;
 	for (var i = 0; i < rowCount; ++i) {
 		var rowDef = rowDefs[i];
-		if (rowDef && rowDef.getRic() === ric) {
+		if (rowDef && rowDef.getSymbol() === ric) {
 			rowDef.setRowData(values); // TODO: Need conflator to improve performance
 		}
 	}
@@ -3298,33 +3405,34 @@ Grid.prototype._updateStreamingData = function() {
 * @param {Object} e
 */
 Grid.prototype._onPreDataSorting = function (e) {
-	var field = "";
-	var rowSorting = false;
-	var sortLogic = null;
-
-	var states = this._stp.getSortingStates(); // WARNING: Use of deprecated function
-	var state = states ? states[0] : null; // TODO: Support multi-column sorting
-
-	if(state) {
-		field = state["field"] || "";
-		var colIndex = this._stp.getSortedColumnIndex(0);
-		var colDef = (colIndex >= 0) ? this.getColumnDefinition(colIndex) : null;
-		this._sorter.setContext("colIndex", colIndex);
-		this._sorter.setContext("colDef", colDef);
+	var objs = this._stp.getSortedColumns();
+
+	this._sorter.reset();
+	if(Array.isArray(objs)) {
+		var sortCount = objs.length;
+		for(var i = 0; i < sortCount; ++i) {
+			var obj = objs[i];
+			var field = obj["field"] || "";
+			var colIndex = obj["colIndex"];
+			var colDef = (colIndex >= 0) ? this.getColumnDefinition(colIndex) : null;
+
+			var rowSorting = false;
+			var sortLogic = null;
+			if(colDef) {
+				field = colDef.getField(); // WARNING: Field and logic could be out of sync
+				rowSorting = colDef.isRowSorting();
+				sortLogic = colDef.getSorter();
+			}
+			// TODO: get sortLogic from DataView
+			// if(!sortLogic && field) {
+			// sortLogic = state["sortLogic"];
+			// }
 
-		if(colDef) {
-			field = colDef.getField(); // WARNING: Field and logic could be out of sync
-			sortLogic = colDef.getSorter();
-			rowSorting = colDef.isRowSorting();
+			this._sorter.addColumnContext(field, sortLogic, rowSorting, obj["sortOrder"], colIndex, colDef);
 		}
 	}
-	if(!sortLogic && field) {
-		sortLogic = state["sortLogic"];
-	}
 
-	this._sorter.setField(field);
-	this._sorter.setSortLogic(sortLogic);
-	this._columnSorter = this._sorter.getSorter(rowSorting);
+	this._columnSorter = this._sorter.getSorter();
 };
 /** @private
 * @param {RowDefinition} rowDefA

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

@@ -1,4 +1,4 @@
-
+import { cloneObject } from "../../tr-grid-util/es6/Util.js";
 
 declare class RowDefSorter {
 
@@ -6,14 +6,14 @@ declare class RowDefSorter {
 
     public dispose(): void;
 
-    public getSorter(rowSorting?: boolean|null): ((...params: any[]) => any)|null;
-
-    public setSortLogic(func?: ((...params: any[]) => any)|null): void;
+    public getSorter(): ((...params: any[]) => any)|null;
 
-    public setField(field: string): void;
+    public reset(key: string, value: any): void;
 
     public setContext(key: string, value: any): void;
 
+    public addColumnContext(field: string, logic: ((...params: any[]) => any)|null, rowSorting: boolean, order: string, colIndex: number, colDef: any): void;
+
 }
 
 export default RowDefSorter;