@refinitiv-ui/efx-grid 6.0.67 → 6.0.69

package/lib/grid/index.js

@@ -1,3 +1,3 @@
 import {Grid} from "./lib/efx-grid.js";
 export {Grid}
-window.EFX_GRID = { version: "6.0.67" };
+window.EFX_GRID = { version: "6.0.69" };

package/lib/rt-grid/dist/rt-grid.js

@@ -14756,7 +14756,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
@@ -14784,12 +14784,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);
 };
 
@@ -15181,7 +15181,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
@@ -16087,8 +16086,9 @@ ColumnDefinition.prototype._setField = function(field, columnOption) {
 	// We need to cache time series in field definition for improve performance of checking methond
 	js_FieldDefinition.setFieldProperty(field, "timeSeries", js_FieldDefinition.isTimeSeries(field) ? true : false);
 
-	if(columnOption && columnOption["parent"]) {
-		js_FieldDefinition.setFieldProperty(field, "timeSeriesChild", true);
+	var parentColDef = columnOption["parent"];
+	if(columnOption && parentColDef) {
+		js_FieldDefinition.setFieldProperty(field, "timeSeriesParent", parentColDef.getField());
 	}
 
 	this._updateContext("field", field);
@@ -16264,6 +16264,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
 */
@@ -16429,12 +16466,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
@@ -16635,61 +16679,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);
 };
 
 
@@ -29082,6 +29131,10 @@ DataView.prototype._excludedRids = null;
 * @type {boolean}
 */
 DataView.prototype._emptySegmentFiltering = false;
+/** @private
+* @type {boolean}
+*/
+DataView.prototype._separatorFiltering = false;
 
 /** @private
 * @type {Object.<string, number>}
@@ -31517,7 +31570,7 @@ DataView.prototype.sortSeparators = function (sortLogics, sortOrders, cids) {
 DataView.prototype.sortSegments = function (compare) {
 	this._dt.sortSegments(compare);
 };
-/** Automatically hide empty segment when all of its member are filtered out. An empty segment will not be hidden, if there is no active filter. Collapsed segment does not count as filtering.
+/** Automatically hide empty segment when all of its member are filtered out. An empty segment will NOT be hidden, if there is no active filter. Collapsed segment does not count as filtering. A segment with no child is treated the same way as an empty segment.
 * @public
 * @param {boolean=} enabled
 */
@@ -31530,6 +31583,19 @@ DataView.prototype.enableEmptySegmentFiltering = function (enabled) {
 		}
 	}
 };
+/** Allow filtering of segment separators as if they were normal rows. Note that even if a separator row is filtered out, its child row may remain in the view and not be filtered out.
+* @public
+* @param {boolean=} enabled
+*/
+DataView.prototype.enableSeparatorFiltering = function (enabled) {
+	enabled = enabled !== false;
+	if(this._separatorFiltering !== enabled) {
+		this._separatorFiltering = enabled;
+		if(this._userFilter) {
+			this._refreshAndNotify();
+		}
+	}
+};
 /**
 * @public
 * @param {string|number} segmentRef Row id or row index
@@ -31697,14 +31763,19 @@ DataView.prototype._updateRowIds = function(opt_rowIds) {
 
 	// Segment separators should not be filtered out (hidden)
 	var segments = this._dt._getSegmentSeparators();
-	var filterExceptions = segments ? segments.getSegments() : null;
-	var userRemoval = this._getRemovalMap(this._excludedRids, this._userFilter, this._filteringOut, filterExceptions);
+	var segmentIds = segments ? segments.getSegments() : null;
+	var userRemoval = this._getRemovalMap(
+		this._excludedRids,
+		this._userFilter,
+		this._filteringOut,
+		this._separatorFiltering ? null : segmentIds
+	);
 	exclusionCount += userRemoval;
 
 	this._collapsedRids = null;
 	if(segments) {
 		if(userRemoval && this._emptySegmentFiltering) {
-			exclusionCount += this._getEmptySegments(this._excludedRids, filterExceptions);
+			exclusionCount += this._getEmptySegments(this._excludedRids, segmentIds);
 		}
 		this._collapsedRids = segments.getCollapsedRows();
 		 // Children of collapsed segments must be filtered out (hidden)
@@ -36149,7 +36220,7 @@ Core.prototype._batches = null;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.76";
+	return "5.1.77";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -45327,7 +45398,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];
@@ -45337,9 +45408,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 = js_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;
@@ -45594,52 +45675,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);
-			js_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);
+				js_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);
 	}
 
 };
@@ -45659,12 +45737,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 = js_FieldDefinition.getTimeSeriesChildren(colDef.getField());
+		var parentField = colDef.getField();
+		var childFields = js_FieldDefinition.getTimeSeriesChildren(parentField);
 		if(!childFields) { // not found time series field
 			return;
 		}
@@ -45689,18 +45767,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++);
 
 };
@@ -45766,10 +45840,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
 	}
@@ -46105,18 +46175,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) {
@@ -46249,18 +46307,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.