@refinitiv-ui/efx-grid 6.0.67 → 6.0.68

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

@@ -124,7 +124,6 @@ var ColumnDefinition = function(columnOption, hostGrid) {
 	this._classes = [];
 	this._requiredFields = [];
 	this._children = [];
-	this._parent = [];
 
 	if(columnOption) {
 		if(columnOption["parent"]) { // WARNING: This assume time series child, when have a parent
@@ -1030,8 +1029,9 @@ ColumnDefinition.prototype._setField = function(field, columnOption) {
 	// 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 && columnOption["parent"]) {
-		FieldDefinition.setFieldProperty(field, "timeSeriesChild", true);
+	var parentColDef = columnOption["parent"];
+	if(columnOption && parentColDef) {
+		FieldDefinition.setFieldProperty(field, "timeSeriesParent", parentColDef.getField());
 	}
 
 	this._updateContext("field", field);

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

@@ -280,7 +280,7 @@ FieldDefinition.isRealTimeField = function(field) {
 * @return {boolean}
 */
 FieldDefinition.isTimeSeriesChild = function(field) {
-	return FieldDefinition.getFieldProperty(field, "timeSeriesChild") ? true : false;
+	return FieldDefinition.getFieldProperty(field, "timeSeriesParent") ? true : false;
 };
 
 /** @public
@@ -308,12 +308,12 @@ FieldDefinition.isTimeSeries = function (field) {
 		[\w]+                   => any field with string and value
 		[\(]                    => open bucket (
 		[\w\-\=\,]*             => any property name and follow by = EX. SDATE=2011-11-11, PRIOD=123123
-		EDATE\=+                => EDATE in bucket
+		(?:EDATE|SDATE )		=> non-capturing group match EDATE or SDATE
 		[\w\-\=\,]+             => another propertie param
 		[\)]$                   => end with only )
 		i						=> for match both upper and lower cases
 	*/
-	var timeSeriesRegex = /^TR.[\w]+[\(][\w\-\=\,]*EDATE\=+[\w\-\=\,]+[\)]$/i;
+	var timeSeriesRegex = /^TR\.[\w]+\([\w\-\=\,]*(?:EDATE|SDATE)\=+[\w\-\=\,]*[ \w]*\)$/i;
 	return timeSeriesRegex.test(field);
 };
 

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

@@ -1142,7 +1142,7 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	}
 
 
-	var i, len;
+	var i, len, prevTimeSeriesField;
 	len = this.getColumnCount();
 	for (i = 0; i < len; ++i) {
 		var column = columns[i];
@@ -1152,9 +1152,19 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 		var colDef = this.getColumnDefinition(i);
 		// TODO: Update width and scalability changed by the extensions
 		colDef.getConfigObject(column);
-	}
+		var parentField = FieldDefinition.getFieldProperty(colDef.getField(), "timeSeriesParent");
+		if(parentField && !prevTimeSeriesField) { // Assume first column of time series child to convert to time series parent
+			prevTimeSeriesField = parentField;
+			column.field = parentField;
+			delete column.name; // WARNING: Name of child should be retained
+			delete column.autoGenerated; // Convert to parent time series field
+		}
 
-	obj.columns = columns = columns.filter(_byNonAutoGeneratedColumn);
+		if(!parentField && prevTimeSeriesField) { // Handled duplicate parent time series field in difference position of column
+			prevTimeSeriesField = null;
+		}
+	}
+	obj.columns = columns = columns.filter(_byNonAutoGeneratedColumn); // Time series child will be filtered out
 
 	if(this._topNode.style.overflow === "") {
 		obj["scrollbar"] = false;
@@ -1409,52 +1419,49 @@ Grid.prototype.insertColumn = function (columnOption, idx) {
 	this._grid.insertColumn(idx, configObj); // columnAdded is fired
 };
 
-/** @private
+/**
+* @private
 * @param {Object} e snapshort change event object
 */
 Grid.prototype._updateTimeSeriesFields = function (e) {
-	var snapShortData = e.data;
-	var childFields;
-	for (var ric in snapShortData) {
-		childFields = snapShortData[ric];
-		this.setRicData(ric, snapShortData[ric]);
+	var childField;
+	var snapShotData = e.data;
+	var childFields = {};
+	for (var ric in snapShotData) {
+		// childFields = snapShotData[ric];
+		for (childField in snapShotData[ric]) {
+			childFields[childField] = true; // Merge child fields to parent (Don't truth each ric it will be have some empty data)
+		}
+		this.setRicData(ric, snapShotData[ric]); // update cell data if exist
 	}
 	var parentField, field, colIndex, parentColDef, childColIndex;
-
-	var firstField;
-	for (field in childFields) {
-		firstField = field;
-		break;
-	}
-
-	parentField = e.childrenFieldToParent[firstField];
-	colIndex = this.getColumnIndex(parentField);
-	this._grid.setColumnVisibility(colIndex);
-	parentColDef = this._getColumnDefinition(colIndex);
-
-
-	var children = parentColDef.getChildren();
-	var i, len, childDef, childField;
-	len = children.length;
-	if(len > 0){
-		for (i = 0; i < len; i++) {
-			childDef = children[i];
-			childField = childDef.getField();
-			if(!childFields[childField]) {
-				this.removeColumn(childField);
-			}
+	var parentMap = {}; // map parent time series field and their first child
+	for (field in childFields) { // Warning: data change can be differ time series child field
+		parentField = e.childrenFieldToParent[field];
+		if(!parentMap[parentField]) {
+			parentMap[parentField] = [field];
+		} else {
+			parentMap[parentField].push(field);
 		}
 	}
 
-	for (childField in childFields) {
-		parentField = e.childrenFieldToParent[childField];
+	for (parentField in parentMap) { // WARNING: one dataChanged event can be multiple fields
+		var childrenField = parentMap[parentField];
 		colIndex = this.getColumnIndex(parentField);
 		parentColDef = this._getColumnDefinition(colIndex);
-		childColIndex = this.getColumnIndex(childField);
-		if(childColIndex < 0) { // not found column index in view tried to clone from parent
-			this._cloneTimeSeriesColumn(parentColDef, childField, colIndex);
-			FieldDefinition.addTimeSeriesChild(parentField, childField);
+		var i, len;
+		len = childrenField.length;
+		for (i = 0; i < len; i++) {
+			childField = childrenField[i];
+			childColIndex = this.getColumnIndex(childField);
+			if(childColIndex < 0) { // not found column index in view tried to clone from parent
+				colIndex = this.getColumnIndex(parentField);
+				parentColDef = this._getColumnDefinition(colIndex);
+				this._cloneTimeSeriesColumn(parentColDef, childField, colIndex);
+				FieldDefinition.addTimeSeriesChild(parentField, childField); // TODO: time series child can be difference of response even if the input is the same, It should be dynamic add/remove fields
+			}
 		}
+		this.removeColumn(parentField);
 	}
 
 };
@@ -1474,12 +1481,12 @@ Grid.prototype._populateTimeSeriesChildren = function (colDef) {
 	for (i = 0; i < colDefs.length; i++) {
 		colDef = colDefs[i];
 		idx = this.getColumnIndex(colDef);
-		this._grid.setColumnVisibility(idx); // hide parent field
 
 		if(!colDef) {
 			continue;
 		}
-		var childFields = FieldDefinition.getTimeSeriesChildren(colDef.getField());
+		var parentField = colDef.getField();
+		var childFields = FieldDefinition.getTimeSeriesChildren(parentField);
 		if(!childFields) { // not found time series field
 			return;
 		}
@@ -1504,18 +1511,14 @@ Grid.prototype._populateTimeSeriesChildren = function (colDef) {
 * @param {number} idx index of insertion column
 */
 Grid.prototype._cloneTimeSeriesColumn = function (parentColDef, childField, idx) {
-	var parentConfig, columnOption, obj, key;
+	var parentConfig, columnOption;
 	parentConfig = parentColDef.getConfigObject();
-	obj = {};
-	for (key in parentConfig) {
-		if(key !== "hidden") {
-			obj[key] = parentConfig[key];
-		}
-	}
-	columnOption = cloneObject(obj);
+	columnOption = cloneObject(parentConfig);
 	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;
+	columnOption["timeSeriesName"] = parentColDef.getName();
+	columnOption["timeSeriesId"] = parentColDef.getId();
 	this.insertColumn(columnOption, idx++);
 
 };
@@ -1581,10 +1584,6 @@ Grid.prototype.replaceColumn = function (columnOption, colRef) {
 	}
 
 	var colDef = this.getColumnDefinition(colIndex);
-	if(colDef && colDef.getChildren().length > 0) { // Parent time series field doesn't provide hidden property
-		colConfig["hidden"] = false;
-	}
-
 	if(colDef && colConfig.id == null) {
 		colConfig.id =  colDef.getId(); // retain ID
 	}
@@ -1920,18 +1919,6 @@ Grid.prototype.removeColumn = function(colRef) {
 	}
 
 	var colDef = this.getColumnDefinition(colIndex);
-	var children = colDef.getChildren();
-	if(children) {
-		var len = children.length;
-		if(len > 0) { // remove time series child
-			var i, childDef;
-			for (i = 0; i < len; i++) {
-				childDef = children[i];
-				this.removeColumn(childDef);
-			}
-			colIndex = this.getColumnIndex(colRef); // children in parent will be remove the parent should be get new index
-		}
-	}
 
 	if(!colDef.isRealTimeField()) {
 		if(this._dc) {
@@ -2064,18 +2051,7 @@ Grid.prototype.hideColumn = function(colRef, hidden) {
 	if(colIndex < 0) { // not found
 		return;
 	}
-	var colDef = this.getColumnDefinition(colIndex);
-	var children = colDef.getChildren();
-	var len = children.length;
-	if(len > 0) { // remove time series child, and parent shouldn't unHide
-		var i, childDef;
-		for (i = 0; i < len; i++) {
-			childDef = children[i];
-			this.hideColumn(childDef, hidden);
-		}
-	} else {
-		this._grid.hideColumn(colIndex, hidden);
-	}
+	this._grid.hideColumn(colIndex, hidden);
 
 };
 /** Hide multiple columns at once. The hidden columns still occupy the same index.

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

@@ -8,8 +8,16 @@ declare class SnapshotFiller extends EventDispatcher {
 
     constructor();
 
+    public static readonly _mockAdc: any;
+
     public setRTK(rtk: any): void;
 
+    public static setMockAdc(str: string, value: any): void;
+
+    public static getMockAdc(str: string): any;
+
+    public static clearMockAdc(): void;
+
     public setADCOptions(adcOptions: Grid.ADCOptions|null): void;
 
     public addRic(ric: string): void;

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

@@ -50,6 +50,43 @@ SnapshotFiller.prototype.setRTK = function (rtk) {
 	this._rtk = rtk;
 };
 
+/** 
+* @public
+* @type {Object}
+*/
+SnapshotFiller._mockAdc = null;
+
+/**
+* @public
+* @param {string} str 
+* @param {*} value 
+*/
+SnapshotFiller.setMockAdc = function(str, value) {
+	if(!SnapshotFiller._mockAdc) {
+		SnapshotFiller._mockAdc  = {};
+	}
+	SnapshotFiller._mockAdc[str] = value;
+};
+
+/**
+* @public
+* @param {string} str 
+* @return {*} 
+*/
+SnapshotFiller.getMockAdc = function(str) {
+	if(!SnapshotFiller._mockAdc) {
+		return null;
+	}
+	return SnapshotFiller._mockAdc[str];
+};
+
+/**
+* @public
+*/
+SnapshotFiller.clearMockAdc = function() {
+	SnapshotFiller._mockAdc = null;
+}
+
 /** @public
 * @param {Grid~ADCOptions} adcOptions ADC requesting level parameter options
 */
@@ -215,12 +252,19 @@ SnapshotFiller.prototype._onRequest = function () {
 				"output": "Col,date|,Row,In|,va,T,NoEmptyTickers" // For customize output server, for more information please visit "https://confluence.refinitiv.com/display/ADC/Data+Cloud+Output+Format"
 			};
 			onSuccess = this._onRTKTimeSeriesSuccess.bind(this, timeSeriesFields);
-			this._rtk.Data.Adc
+			var responseMockAdc = SnapshotFiller.getMockAdc(payload.formula);
+			if(responseMockAdc) {
+				setTimeout(function() {
+					onSuccess(responseMockAdc);
+				}, 10); // Mock Async operation
+			} else {
+				this._rtk.Data.Adc
 				.request(payload)
 				.then(onSuccess)
 				.catch(function (err) {
 					console.log(err);
 				});
+			}
 		}
 
 		// Request normal adc field
@@ -421,61 +465,66 @@ SnapshotFiller.prototype._onRTKTimeSeriesSuccess = function (fields, serverResul
 	if (!Array.isArray(data2D) || !Array.isArray(svHeaders)) {
 		return; // TODO: Return Promise.reject(errMsg);
 	}
-
-	var headerLen = svHeaders.length;
-
-	var headerDates = [];
-	var i, j;
-
-	for (i = 2; i < headerLen; i++) { // Start with 2 (Skip instrunment and date header)
-		headerDates.push(svHeaders[i].v);
-	}
-
-	var ric, j, field;
-	var len = data2D.length;
-	var ricMap = {};
-	var childrenFieldToParent = {};
-
+	// Extract header dates
+	var headerDates = svHeaders.slice(2).map(header => header.v);
+	// Create necessary variables
 	var fileNameToTSField = {};
 	var count = 0;
-	for (let i = 1; i < len; i++) {
+	// Convert map to fieldMap
+	var data2DLength = data2D.length;
+	for (var i = 1; i < data2DLength; i++) {
 		var dataRow = data2D[i];
 		var fieldName = dataRow[1];
-		if(!fileNameToTSField[fieldName]) {
+		if (!fileNameToTSField[fieldName]) {
 			fileNameToTSField[fieldName] = fields[count++];
-		}   	
+		}
 	}
-
-	// TODO: Freeze the data view before setting multiple data
-	for (i = 1; i < len; i++) { // to skip column header index, use i = 1
+	// Process data and populate ricMap and childrenFieldToParent
+	var ricMap = {};
+	var childrenFieldToParent = {};
+	for (var i = 1; i < data2DLength; i++) {
 		var dataRow = data2D[i];
-		ric = dataRow[0];
-		var fieldName = dataRow[1]; // ex. PRICECLOSE
-		if(!ricMap[ric]) {
+		var ric = dataRow[0];
+		var fieldName = dataRow[1];
+
+		if (!ricMap[ric]) {
 			ricMap[ric] = {};
 		}
 		var snapData = ricMap[ric];
-		for (var k = 0; k < headerDates.length; k++) {
-			field = fileNameToTSField[fieldName].replace("TR.", "") + "_"  + headerDates[k]; // TODO: make support time series field definition cache
-			childrenFieldToParent[field] = fileNameToTSField[fieldName];
-			snapData[field] = dataRow[2 + k]; // Start with field value
+		if (headerDates.length === 1) {
+			// Time series with only 1 column, it will be a normal adc field
+			snapData[fileNameToTSField[fieldName]] = dataRow[2];
+		} else {
+			// Multiple columns, it will be a time series field
+			for (var k = 0; k < headerDates.length; k++) {
+				var field = fileNameToTSField[fieldName].replace("TR.", "") + "_" + headerDates[k];
+				var celLData =  dataRow[2 + k];
+				if(celLData !== null) {
+					childrenFieldToParent[field] = fileNameToTSField[fieldName];
+					snapData[field] = celLData;
+				}
+			}
 		}
 	}
 
-	// return result only ric that has update data
+	// Return result only for ric that has updated data
 	var dataMapping = {};
-	for (ric in ricMap) {
+	for (var ric in ricMap) {
 		var obj = ricMap[ric];
 		if (!isEmptyObject(obj)) {
 			dataMapping[ric] = obj;
 		}
 	}
 
-	this._dispatch("dataChanged", {
+	// Dispatch events based on the header length
+	var eventData = {
 		data: dataMapping,
-		timeSeries: true,
-		childrenFieldToParent: childrenFieldToParent
-	});
+	};
+	if (headerDates.length > 1) {
+		eventData.timeSeries = true;
+		eventData.childrenFieldToParent = childrenFieldToParent;
+	}
+	this._dispatch("dataChanged", eventData);
 };
 
 export { SnapshotFiller };

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

@@ -36,7 +36,6 @@ var ColumnGroupingPlugin = function ColumnGroupingPlugin(options) {
   t._requestApplyAddChildGroup = t._requestApplyAddChildGroup.bind(this);
   t._onPostSectionRender = t._onPostSectionRender.bind(t);
   t._onBeforeColumnBoundUpdate = t._onBeforeColumnBoundUpdate.bind(t);
-  t._onPinningChanged = t._onPinningChanged.bind(this);
   t._groupDefs = new GroupDefinitions();
   if (options) {
     t.config({
@@ -84,10 +83,6 @@ ColumnGroupingPlugin.prototype._addingEvents = null;
 * @private
 */
 ColumnGroupingPlugin.prototype._legacyColumnGroups = null;
-/** @type {boolean}
-* @private
-*/
-ColumnGroupingPlugin.prototype._inPinning = false;
 /** @type {!Object.<string, boolean>}
 * @description A map of selected groups
 * @private
@@ -211,6 +206,15 @@ ColumnGroupingPlugin._recursivelyFlatten = function (groupDef, groupDefs) {
   }
 };
 
+/** Filter time series group out
+* @private
+* @param {Object} groupDef
+* @return {boolean}
+*/
+ColumnGroupingPlugin._isNotTimeSeriesGroup = function (groupDef) {
+  return groupDef.timeSeriesGroup ? false : true;
+};
+
 /** @public
 * @return {string}
 */
@@ -247,7 +251,6 @@ ColumnGroupingPlugin.prototype.initialize = function (host, options) {
     host.listen("columnVisibilityChanged", this._onColumnChanged);
     host.listen("postSectionRender", this._onPostSectionRender);
     host.listen("beforeColumnBoundUpdate", this._onBeforeColumnBoundUpdate);
-    host.listen("pinningChanged", this._onPinningChanged);
   }
   this.config(options);
   this._legacyColumnGroups = null;
@@ -301,7 +304,6 @@ ColumnGroupingPlugin.prototype.unload = function (host) {
   host.unlisten("columnRemoved", this._onColumnRemoved);
   host.unlisten("postSectionRender", this._onPostSectionRender);
   host.unlisten("beforeColumnBoundUpdate", this._onBeforeColumnBoundUpdate);
-  host.unlisten("pinningChanged", this._onPinningChanged);
   if (!this._hosts.length) {
     if (this._rerenderTimerId) {
       clearTimeout(this._rerenderTimerId);
@@ -350,6 +352,7 @@ ColumnGroupingPlugin.prototype.getConfigObject = function (gridOptions) {
 
   // TODO: Handle legacyRender method that has been migrated
   var groupDefs = this.getGroupDefinitions();
+  groupDefs = groupDefs.filter(ColumnGroupingPlugin._isNotTimeSeriesGroup);
   if (groupDefs.length) {
     obj.columnGrouping = groupDefs;
   }
@@ -429,12 +432,10 @@ ColumnGroupingPlugin.prototype._migrateLegacyStructure = function (groupDefs, co
 * @param {number=} numRightColumn
 */
 ColumnGroupingPlugin.prototype._freezeColumn = function (frozenColIndex, numRightColumn) {
-  this._inPinning = true;
   var hosts = this._hosts;
   for (var i = 0; i < hosts.length; i++) {
     hosts[i].freezeColumn(frozenColIndex, numRightColumn);
   }
-  this._inPinning = false;
 };
 /** @private
 */
@@ -893,28 +894,38 @@ ColumnGroupingPlugin.prototype._requestApplyAddChildGroup = function (e) {
 };
 
 /** @private
-  * @param {Object} e dispatching of columnAdded event object
-  */
+* @param {Object} e dispatching of columnAdded event object
+*/
 ColumnGroupingPlugin.prototype._applyTimeSeries = function (e) {
   this._addingTimerId = 0; // clear timer
   var addingEvents = this._addingEvents;
   this._addingEvents = [];
   if (addingEvents.length > 0) {
     var children = [];
-    var tsParentDef;
+    var timeSeriesId, timeSeriesName;
+    var tsgChild = {};
     for (var i = 0; i < addingEvents.length; i++) {
+      // WARNING: addingEvents column can be difference group
       var addingEvent = addingEvents[i];
-      tsParentDef = addingEvent.context.parent;
-      if (tsParentDef) {
-        var childIndex = addingEvent.colIndex; // Assume time series column ordered
-        var childId = this.getColumnId(childIndex);
-        children.push(childId);
+      timeSeriesName = addingEvent.context.timeSeriesName;
+      timeSeriesId = addingEvent.context.timeSeriesId;
+      var childIndex, childId;
+      if (!tsgChild[timeSeriesId]) {
+        tsgChild[timeSeriesId] = {
+          name: timeSeriesName,
+          children: []
+        };
+        childIndex = addingEvent.colIndex;
+        childId = this.getColumnId(childIndex);
+        tsgChild[timeSeriesId].children.push(childId);
+      } else {
+        childIndex = addingEvent.colIndex;
+        childId = this.getColumnId(childIndex);
+        tsgChild[timeSeriesId].children.push(childId);
       }
     }
-    if (tsParentDef) {
-      var parentName = tsParentDef.getName();
-      var parentId = tsParentDef.getId();
-      var groupId = "timeSerieGroup_" + parentId;
+    for (timeSeriesId in tsgChild) {
+      var groupId = "timeSerieGroup_" + timeSeriesId;
       var groupDef = this._groupDefs.getGroup(groupId);
       if (groupDef) {
         // add children time series field to parent
@@ -925,12 +936,14 @@ ColumnGroupingPlugin.prototype._applyTimeSeries = function (e) {
         // create new group
         this.addGroup({
           id: groupId,
-          title: parentName,
-          children: children
+          title: tsgChild[timeSeriesId].name,
+          children: tsgChild[timeSeriesId].children,
+          timeSeriesGroup: true // For remove it when getConfigObject
         });
       }
     }
   }
+
   this._requestApplyGrouping();
 };
 
@@ -979,22 +992,6 @@ ColumnGroupingPlugin.prototype._onColumnRemoved = function (e) {
 /** @private
 * @param {Object} e
 */
-ColumnGroupingPlugin.prototype._onPinningChanged = function (e) {
-  if (!this._inPinning) {
-    // Clear current pinning states
-    var groupMap = this._visibleGroupMap;
-    for (var groupId in groupMap) {
-      var groupDef = groupMap[groupId];
-      groupDef.leftPinned = false;
-      groupDef.rightPinned = false;
-    }
-    this._verifyColumnPinning();
-    this._applyPinning();
-  }
-};
-/** @private
-* @param {Object} e
-*/
 ColumnGroupingPlugin.prototype._onBeforeColumnBoundUpdate = function (e) {
   var selectedColumns = e.selectedColumns; // Hidden columns are included