@refinitiv-ui/efx-grid 6.0.33 → 6.0.34

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;
 	}
 
@@ -1610,6 +1636,79 @@ Grid.prototype.setColumns = function(columns) {
 		}
 	}
 };
+
+
+/** 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 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);
+	}
+
+	this._grid.reorderColumns(columnOrdering);
+};
+
 /** Remove all existing columns and add new columns based on the given texts/fields
 * @public
 * @function
@@ -1754,10 +1853,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 +2203,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 +2620,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 +2943,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
 		}
 	}

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-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);
 			}
 		}
 	}
@@ -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

package/lib/tr-grid-conditional-coloring/es6/ConditionalColoring.d.ts

@@ -13,16 +13,16 @@ declare namespace ConditionalColoringPlugin {
 
     type ColumnOptions = {
         conditions?: (ConditionalColoringPlugin.Condition)[]|null,
-        colorText?: (string|boolean)|null,
-        tickColor?: (string|boolean)|null,
-        blinking?: (ConditionalColoringPlugin.Blinking|boolean)|null,
+        colorText?: (string|boolean|ConditionalColoringPlugin.ColorText)|null,
+        tickColor?: (string|boolean|ConditionalColoringPlugin.ColorText)|null,
+        blinking?: (string|boolean|ConditionalColoringPlugin.Blinking)|null,
         field?: string|null
     };
 
     type ConditionalColoringOptions = {
         conditions?: (ConditionalColoringPlugin.Condition)[]|null,
-        colorText?: (string|boolean)|null,
-        tickColor?: (string|boolean)|null,
+        colorText?: (string|boolean|ConditionalColoringPlugin.ColorText)|null,
+        tickColor?: (string|boolean|ConditionalColoringPlugin.ColorText)|null,
         field?: string|null
     };
 
@@ -41,6 +41,13 @@ declare namespace ConditionalColoringPlugin {
         level?: (string|boolean)|null
     };
 
+    type ColorText = {
+        field?: string|null,
+        upClass?: string|null,
+        downClass?: string|null,
+        levelClass?: string|null
+    };
+
 }
 
 declare class ConditionalColoringPlugin extends GridPlugin {