@refinitiv-ui/efx-grid 6.0.22 → 6.0.23

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

@@ -89,7 +89,7 @@ declare class ColumnDefinition {
 
     public isRealTimeField(): boolean;
 
-    public isTimeSeriesField(): boolean;
+    public isTimeSeries(): boolean;
 
     public isFormulaField(): boolean;
 

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

@@ -213,10 +213,6 @@ ColumnDefinition.prototype._eventArg;
 /** @type {boolean}
 * @private
 */
-ColumnDefinition.prototype._realTimeField = false;
-/** @type {boolean}
-* @private
-*/
 ColumnDefinition.prototype._autoGenerated = false;
 
 /** @type {!Array.<string>}
@@ -263,10 +259,6 @@ ColumnDefinition.prototype._parent = null;
 * @private
 */
 ColumnDefinition.prototype._children = null;
-/** @type {boolean}
-* @private
-*/
-ColumnDefinition.prototype._timeSeriesField = false;
 /** @type {Object}
 * @private
 */
@@ -353,7 +345,7 @@ ColumnDefinition.prototype.initialize = function(columnOption) {
 		}
 	}
 
-	this._setField(field, columnOption["formula"]); // Perform some field manipulation
+	this._setField(field, columnOption); // Perform some field manipulation
 
 	val = columnOption["name"] || columnOption["title"]; // title is migrated from Composite Grid
 	if(val != null) { // Name can be empty string
@@ -368,7 +360,7 @@ ColumnDefinition.prototype.initialize = function(columnOption) {
 
 	val = columnOption["notRealTimeField"];
 	if(val != null) {
-		this._realTimeField = !val;
+		FieldDefinition.setFieldProperty(field, "IsRealtimeField", !val);
 	}
 
 	val = columnOption["tooltip"];
@@ -585,17 +577,13 @@ ColumnDefinition.prototype.getAllFields = function() {
 * @return {boolean}
 */
 ColumnDefinition.prototype.isRealTimeField = function() {
-	// TODO: Simplify this logic
-	if(this._field && this._realTimeField && !this._formula) {
-		return ColumnDefinition.isRealTimeField(this._field);
-	}
-	return false;
+	return FieldDefinition.isRealTimeField(this._field);
 };
 /** @public
 * @return {boolean}
 */
-ColumnDefinition.prototype.isTimeSeriesField = function() {
-	return this._timeSeriesField;
+ColumnDefinition.prototype.isTimeSeries = function() {
+	return FieldDefinition.isTimeSeries(this._field);
 };
 /** @public
 * @return {boolean}
@@ -608,27 +596,21 @@ ColumnDefinition.prototype.isFormulaField = function() {
 * @return {boolean}
 */
 ColumnDefinition.isFormulaField = function(field) {
-	return field.charAt(0) === "=";
+	return FieldDefinition.isFormula(field);
 };
 /** @public
 * @param {string} field
 * @return {boolean}
 */
 ColumnDefinition.isAdcField = function(field) {
-	return field.indexOf("TR.") === 0;
+	return FieldDefinition.isAdc(field);
 };
 /** @public
 * @param {string} field
 * @return {boolean}
 */
 ColumnDefinition.isRealTimeField = function(field) {
-	if(field) {
-		if(!ColumnDefinition.isFormulaField(field)) {
-			return !ColumnDefinition.isAdcField(field);
-		}
-	}
-
-	return false;
+	return FieldDefinition.isRealTimeField(field);
 };
 /** @public
 * @function
@@ -753,8 +735,10 @@ ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 		obj["name"] = this._name;
 	}
 
-	if(!this._realTimeField) {
-		obj["notRealTimeField"] = true;
+	// The 'IsRealtimeField' property will only be set if the user sets 'notRealTimeField' in the column options. It will be returned if the user has this option enabled, otherwise it will not be returned
+	value = FieldDefinition.getFieldProperty(this._field, "IsRealtimeField") === false;
+	if(value) {
+		obj["notRealTimeField"] = value;
 	}
 
 	if(this._tooltip != null) {
@@ -975,7 +959,7 @@ ColumnDefinition.prototype.setSorter = function(func) {
 */
 ColumnDefinition.prototype.isRowSorting = function() {
 	if(this._rowSorting == null) {
-		return !this._realTimeField;
+		return !FieldDefinition.getFieldProperty(this._field, "IsRealtimeField");
 	}
 	return this._rowSorting ? true : false;
 };
@@ -998,9 +982,9 @@ ColumnDefinition.prototype.setName = function(str) {
 
 /** @private
 * @param {string|null=} field
-* @param {string} formulaStr
+* @param {ColumnDefinition~Options=} columnOption
 */
-ColumnDefinition.prototype._setField = function(field, formulaStr) {
+ColumnDefinition.prototype._setField = function(field, columnOption) {
 	var defaultField = (field == null); // undefined or null
 	if(!field) {
 		field = "";
@@ -1008,6 +992,7 @@ ColumnDefinition.prototype._setField = function(field, formulaStr) {
 	// Trim white spaces -- equivalent to String.trim(), which is not support in IE8
 	field = field.replace(/^\s+|\s+$/gm, "");
 
+	var formulaStr = columnOption["formula"];
 	if(this._fnEngine) {
 		var uppercasedF = field.toUpperCase(); // For comparison only
 		var predefinedF = formulaStr || PredefinedFormula.get(uppercasedF);
@@ -1035,13 +1020,13 @@ ColumnDefinition.prototype._setField = function(field, formulaStr) {
 		this._field = field;
 		this._name = field;
 		this._emptyField = false;
-		this._realTimeField = field ? true : false;
 	}
 
-	if(FieldDefinition.isTimeSeriesField(field)) {
-		// children will be clone the config from parent too
-		this._realTimeField = false;
-		this._timeSeriesField = true;
+	// We need to cache time series in field definition for improve performance of checking methond
+	FieldDefinition.setFieldProperty(field, "timeSeries", FieldDefinition.isTimeSeries(field) ? true : false);
+
+	if(columnOption["parent"]) {
+		FieldDefinition.setFieldProperty(field, "timeSeriesChild", true);
 	}
 
 	this._isDefaultName = true;

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

@@ -18,7 +18,13 @@ declare namespace FieldDefinition {
 
     function setFieldCaching(caching: boolean): void;
 
-    function isTimeSeriesField(field: string): boolean;
+    function isFormula(field: string): boolean;
+
+    function isAdc(field: string): boolean;
+
+    function isRealTimeField(field: string): boolean;
+
+    function isTimeSeries(field: string): boolean;
 
 }
 

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

@@ -57,7 +57,7 @@ var FieldDefinition = {};
 FieldDefinition._defs = {
 	"X_RIC_NAME": {
 		name: "RIC",
-		notRealTimeField: true,
+		IsRealtimeField: false,
 		width: 100,
 		binding: xRicNameRenderer,
 		sortLogic: xRicNameSorter
@@ -195,7 +195,13 @@ FieldDefinition._loadingField = {};
 * @param {Object} def
 */
 FieldDefinition.set = function(field, def) {
-	FieldDefinition._defs[field] = def || null;
+	if (!FieldDefinition._defs[field]) {
+		FieldDefinition._defs[field] = def;
+	} else {
+		for (var key in def) {
+			FieldDefinition._defs[field][key] = def[key];
+		}
+	}
 };
 /** @public
 * @function
@@ -252,11 +258,64 @@ FieldDefinition.setFieldCaching = function (caching) {
 	FieldDefinition._caching = caching;
 };
 
+/** @public
+* @param {string} field
+* @return {boolean}
+*/
+FieldDefinition.isFormula = function(field) {
+	return field.charAt(0) === "=";
+};
+/** @public
+* @param {string} field
+* @return {boolean}
+*/
+FieldDefinition.isAdc = function(field) {
+	return field.indexOf("TR.") === 0;
+};
+
+/** @public
+* @param {string} field
+* @return {boolean}
+*/
+FieldDefinition.isRealTimeField = function(field) {
+	if (!field) {
+		return false;
+	}
+
+	if(FieldDefinition.isAdc(field)) {
+		return false;
+	}
+
+	if(FieldDefinition.isFormula(field)) {
+		return false;
+	}
+
+	if(FieldDefinition.getFieldProperty(field, "timeSeriesChild")) {
+		return false;
+	}
+
+	if(FieldDefinition.isTimeSeries(field)) {
+		return false;
+	}
+
+	return FieldDefinition.getFieldProperty(field, "IsRealtimeField") !== false;
+};
+
 /** @public
 * @param {string} field
 * @return {boolean}=true if field is time series field
 */
-FieldDefinition.isTimeSeriesField = function (field) {
+FieldDefinition.isTimeSeries = function (field) {
+	if (!field) {
+		return false;
+	}
+
+	// We can check time series using a cache to avoid duplicating checks in regular expressions.
+	var timeSeriesField = FieldDefinition.getFieldProperty(field, "timeSeries");
+	if (timeSeriesField != null) {
+		return timeSeriesField;
+	}
+
 	/*
 		^TR.                    => start with TR.
 		[\w]+                   => any field with string and value
@@ -265,9 +324,39 @@ FieldDefinition.isTimeSeriesField = function (field) {
 		EDATE\=+                => EDATE in bucket
 		[\w\-\=\,]+             => another propertie param
 		[\)]$                   => end with only )
+		i						=> for match both upper and lower cases
 	*/
+	var timeSeriesRegex = /^TR.[\w]+[\(][\w\-\=\,]*EDATE\=+[\w\-\=\,]+[\)]$/i;
+	return timeSeriesRegex.test(field);
+};
 
-	return !!field.toUpperCase().match(/^TR.[\w]+[\(][\w\-\=\,]*EDATE\=+[\w\-\=\,]+[\)]$/g);
+/**
+ * Set property value into field definition
+ * @private
+ * @param {string} field field definition
+ * @param {string} propertyName
+ * @param {*} value
+ */
+FieldDefinition.setFieldProperty = function(field, propertyName, value) {
+	if(!FieldDefinition._defs[field]) {
+		FieldDefinition._defs[field] = {};
+	}
+	FieldDefinition._defs[field][propertyName] = value;
+};
+
+/**
+ * Set property value into field definition
+ * @private
+ * @param {string} field field definition
+ * @param {string} propertyName
+ * @return {*}
+ */
+FieldDefinition.getFieldProperty = function(field, propertyName) {
+	var fieldDef = FieldDefinition._defs[field];
+	if(fieldDef) {
+		return fieldDef[propertyName];
+	}
+	return null;
 };
 
 /** to get more info about field via synapse service

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

@@ -281,8 +281,7 @@ var Grid = function(placeholder, config) {
 	t._recalculateFormulas = t._recalculateFormulas.bind(t);
 	t._updateStreamingData = t._updateStreamingData.bind(t);
 	t.updateColumnTitle = t.updateColumnTitle.bind(t);
-	t._insertTimeSeriesChildren = t._insertTimeSeriesChildren.bind(t);
-
+	t._populateTimeSeriesChildren = t._populateTimeSeriesChildren.bind(t);
 
 	t._onPostSectionDataBinding = t._onPostSectionDataBinding.bind(t);
 	t._asyncClearDataUpdates = t._asyncClearDataUpdates.bind(t);
@@ -306,7 +305,7 @@ var Grid = function(placeholder, config) {
 	t._formulaConflator = new Conflator(300, t._onFormulaDataChanged);
 	t._chainConflator = new Conflator(100, t._addMemberOfChain);
 	t._columnTitleConflator = new Conflator(0, t.updateColumnTitle);
-	t._timeSeriesChildConflator = new Conflator(0, t._insertTimeSeriesChildren);
+	t._timeSeriesChildConflator = new Conflator(0, t._populateTimeSeriesChildren);
 
 
 	t._defaultColumnOptions = {};
@@ -1264,7 +1263,7 @@ Grid.prototype._onFieldAdded = function(e) {
 
 	// JET
 	if (this._subs) {
-		var realtimeFields = addedFields.filter(ColumnDefinition.isRealTimeField);
+		var realtimeFields = addedFields.filter(FieldDefinition.isRealTimeField);
 		this._subs["addFields"](realtimeFields);
 	}
 
@@ -1373,7 +1372,7 @@ Grid.prototype._updateTimeSeriesFields = function (e) {
 /** @private
 * @param {ColumnDefinition} colDef
 */
-Grid.prototype._insertTimeSeriesChildren = function (colDef) {
+Grid.prototype._populateTimeSeriesChildren = function (colDef) {
 	if(this._timeSeriesChildConflator.conflate(colDef) ) {
 		return;
 	}
@@ -1423,7 +1422,7 @@ Grid.prototype._cloneTimeSeriesColumn = function (parentColDef, childField, idx)
 		}
 	}
 	columnOption = cloneObject(obj);
-	columnOption["field"] = childField.replace("TR.", "");
+	columnOption["field"] = childField.replace("TR.", ""); // We need to remove the 'TR' prefix from the field to avoid confusion with time series fields.
 	columnOption["name"] = childField.split("_")[1].split("T")[0]; // Currently, response server format utc date ex "2022-11-23T00:00:00"
 	columnOption["parent"] = parentColDef;
 	this.insertColumn(columnOption, idx++);
@@ -1530,6 +1529,11 @@ Grid.prototype._onFieldLoadedError = function (err) {
  * @param {string} referrer
  */
 Grid.prototype._onFieldLoaded = function (field, referrer) {
+	// For time series, we need to wait until the field is loadedm, then we can insert a child from the field data.
+	if(FieldDefinition.isTimeSeries(field)) {
+		var colDef = this.getColumnDefinitionById(referrer); // The 'referrer' is a column ID that was just added
+		this._populateTimeSeriesChildren(colDef);
+	}
 	this._connector.addFields(field, referrer);
 };
 
@@ -1559,7 +1563,7 @@ Grid.prototype._shouldLoadFieldInfo = function (field, isRealTime) {
 	var fieldDef = FieldDefinition.get(field);
 	if (!fieldDef &&
 		field !== 'X_RIC_NAME' && // ignore X_RIC_NAME
-		(isRealTime || ColumnDefinition.isAdcField(field)) && // realtime field or adc field (Without static field)
+		(isRealTime || FieldDefinition.isAdc(field)) && // realtime field or adc field (Without static field)
 		(this._RTK || window["JET"]) // have rtk instance or window jet sub
 	) {
 		return true;
@@ -1663,14 +1667,13 @@ Grid.prototype._onColumnAdded = function(e) {
 		}
 	}
 	this._grid.setDataColumnName(idx, ROW_DEF); // This make ColumnDefinition renderer work
-
 	var fields = colDef.getAllFields();
 	var referrer = colDef.getId();
 	var len = fields.length;
 	var field, dataType, prom, isRealTimeField, onLoaded;
 	for(i = 0; i < len; i++) {
 		field = fields[i];
-		isRealTimeField = ColumnDefinition.isRealTimeField(field);
+		isRealTimeField = FieldDefinition.isRealTimeField(field);
 		if(this._shouldLoadFieldInfo(field, isRealTimeField)) {
 			if(field === colField) {
 				dataType = colDef.getDataType(); // Data-type from user's column options
@@ -1686,14 +1689,14 @@ Grid.prototype._onColumnAdded = function(e) {
 				onLoaded = this._onFieldLoaded.bind(this, field, referrer);
 				prom = prom.then(onLoaded).catch(onLoaded);
 			} else {
-				if(colDef.isTimeSeriesField()) {
-					this._insertTimeSeriesChildren(colDef);
+				if(colDef.isTimeSeries()) {
+					this._populateTimeSeriesChildren(colDef);
 				}
 				this._connector.addFields(field, referrer);
 			}
 		} else {
-			if(colDef.isTimeSeriesField()) {
-				this._insertTimeSeriesChildren(colDef);
+			if(colDef.isTimeSeries()) {
+				this._populateTimeSeriesChildren(colDef);
 			}
 			this._connector.addFields(field, referrer);
 		}
@@ -1975,7 +1978,7 @@ Grid.prototype.addDataFields = function(fieldRef, referrer) {
 	var i, field, dataType, prom, isRealTimeField, onLoaded;
 	for(i = 0; i < len; i++) {
 		field = fields[i];
-		isRealTimeField = ColumnDefinition.isRealTimeField(field);
+		isRealTimeField = FieldDefinition.isRealTimeField(field);
 		if(this._shouldLoadFieldInfo(field, isRealTimeField)) {
 			dataType = ColumnDefinition.getDataType(field);
 			prom = FieldDefinition.loadFieldInfo(field)

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

@@ -193,7 +193,7 @@ SnapshotFiller.prototype._onRequest = function () {
 	var fields = [];
 	var timeSeriesFields = [];
 	for (var field in this._fields) {
-		if(!FieldDefinition.isTimeSeriesField(field)) {
+		if(!FieldDefinition.isTimeSeries(field)) {
 			fields.push(field);
 		} else {
 			timeSeriesFields.push(field);

package/package.json

@@ -62,5 +62,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.22"
+	"version": "6.0.23"
 }