@refinitiv-ui/efx-grid 6.0.15 → 6.0.16

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

@@ -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";
 
 /** @private
 * @param {Object} obj
@@ -189,10 +190,19 @@ SnapshotFiller.prototype._onRequest = function () {
 	var instruments = Object.keys(this._rics);
 
 	var i;
-	var fields = Object.keys(this._fields);
+	var fields = [];
+	var timeSeriesFields = [];
+	for (var field in this._fields) {
+		if(!FieldDefinition.isTimeSeriesField(field)) {
+			fields.push(field);
+		} else {
+			timeSeriesFields.push(field);
+		}
+	}
 	var fieldLen = fields.length;
+	var timeSeriesFieldLen = timeSeriesFields.length;
 
-	if (!fieldLen || !instruments.length) { // No ADC field or real-time RIC
+	if ( (!fieldLen && !timeSeriesFieldLen ) || !instruments.length) { // No ADC field or real-time RIC
 		return;
 	}
 
@@ -202,21 +212,47 @@ SnapshotFiller.prototype._onRequest = function () {
 
 	var onSuccess, payload;
 	if (this._rtk) {
-		var strFields = fields.join(',');
-		payload = {
-			"method": "select",
-			"formula": strFields,
-			"identifiers": instruments,
-			"productId": this._adcOptions.productId,
-			"output": "Col,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._onRTKSuccess.bind(this, fields);
-		this._rtk.Data.Adc
-			.request(payload)
-			.then(onSuccess)
-			.catch(function (err) {
-				console.log(err);
-			});
+		var strFields;
+		// Request time serie fields
+		if(timeSeriesFields.length > 0) {
+			// request time series field
+			var strtTimeSeriesFields = timeSeriesFields.join(',');
+			payload = {
+				"method": "select",
+				"formula": strtTimeSeriesFields,
+				"identifiers": instruments,
+				"productId": this._adcOptions.productId,
+				"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
+				.request(payload)
+				.then(onSuccess)
+				.catch(function (err) {
+					console.log(err);
+				});
+		}
+
+		// Request normal adc field
+		if(fields.length > 0) {
+			strFields = fields.join(',');
+			payload = {
+				"method": "select",
+				"formula": strFields,
+				"identifiers": instruments,
+				"productId": this._adcOptions.productId,
+				"output": "Col,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._onRTKSuccess.bind(this, fields);
+			this._rtk.Data.Adc
+				.request(payload)
+				.then(onSuccess)
+				.catch(function (err) {
+					console.log(err);
+				});
+		}
+
+
 	} else {
 		var reqFields = [];
 		for(i = 0; i < fieldLen; i++) {
@@ -377,5 +413,77 @@ SnapshotFiller.prototype._onRTKSuccess = function (fields, serverResult) {
 	});
 };
 
+
+/** @private
+* @function
+* @param {Array.<string>} fields
+* @param {string} serverResult
+*/
+SnapshotFiller.prototype._onRTKTimeSeriesSuccess = function (fields, serverResult) {
+
+	// TODO: noti the user for change structure
+	this._dispatch("adcDataReceived", serverResult);
+	var data2D = serverResult["rows"];
+	var svHeaders = serverResult["rows"] && serverResult["rows"][0];
+	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 = {};
+
+	var fileNameToTSField = {};
+	var count = 0;
+	for (let i = 1; i < len; i++) {
+		var dataRow = data2D[i];
+		var fieldName = dataRow[1];
+		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
+		var dataRow = data2D[i];
+		ric = dataRow[0];
+		var fieldName = dataRow[1]; // ex. PRICECLOSE
+		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
+		}
+	}
+
+	// return result only ric that has update data
+	var dataMapping = {};
+	for (ric in ricMap) {
+		var obj = ricMap[ric];
+		if (!isEmptyObject(obj)) {
+			dataMapping[ric] = obj;
+		}
+	}
+
+	this._dispatch("dataChanged", {
+		data: dataMapping,
+		timeSeries: true,
+		childrenFieldToParent: childrenFieldToParent
+	});
+};
+
 export { SnapshotFiller };
 export default SnapshotFiller;

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

@@ -500,7 +500,7 @@ ColumnGroupingPlugin.prototype._applyTimeSeries = function (e) {
     var firstChildColumn;
     for (i = 0; i < addingEvents.length; i++) {
       addingEvent = addingEvents[i];
-      if (addingEvent.context.asChildrenTimeSeries) {
+      if (addingEvent.context.parent) {
         if (!firstChildColumn) {
           firstChildColumn = addingEvent.context;
         }
@@ -509,7 +509,7 @@ ColumnGroupingPlugin.prototype._applyTimeSeries = function (e) {
         children.push(childId);
       }
     }
-    if (firstChildColumn && firstChildColumn.asChildrenTimeSeries) {
+    if (firstChildColumn && firstChildColumn.parent) {
       var tsParentDef = firstChildColumn.parent;
       if (tsParentDef) {
         var parentName = tsParentDef.getName();

package/lib/tr-grid-row-filtering/es6/RowFiltering.d.ts

@@ -12,33 +12,34 @@ declare namespace RowFilteringPlugin {
 
     type FilterExpression = {
         field: string,
-        expression: RowFilteringPlugin.Expression,
+        expression: RowFilteringPlugin.Expression|null,
         context: any
     };
 
     type ColumnOptions = {
-        filter?: RowFilteringPlugin.Expression,
+        filter?: RowFilteringPlugin.Expression|null,
         filterState?: any,
-        filterIcon?: boolean
+        filterIcon?: boolean|null
     };
 
     type FilterDialogOptions = {
-        sortUI?: boolean,
-        filterUI?: boolean,
-        fieldDataType?: string,
-        lang?: string,
-        rawDataAccessor?: ((...params: any[]) => any),
-        formattedDataAccessor?: ((...params: any[]) => any),
-        sortLogic?: ((...params: any[]) => any)
+        sortUI?: boolean|null,
+        filterUI?: boolean|null,
+        fieldDataType?: string|null,
+        lang?: string|null,
+        rawDataAccessor?: ((...params: any[]) => any)|null,
+        formattedDataAccessor?: ((...params: any[]) => any)|null,
+        sortLogic?: ((...params: any[]) => any)|null
     };
 
     type Options = {
-        disabledUI?: boolean,
-        iconActivation?: string,
-        click?: ((...params: any[]) => any),
-        clicked?: ((...params: any[]) => any),
-        iconCreated?: ((...params: any[]) => any),
-        filterChanged?: ((...params: any[]) => any)
+        disabledUI?: boolean|null,
+        iconActivation?: string|null,
+        dialogOptions?: RowFilteringPlugin.FilterDialogOptions|null,
+        click?: ((...params: any[]) => any)|null,
+        clicked?: ((...params: any[]) => any)|null,
+        iconCreated?: ((...params: any[]) => any)|null,
+        filterChanged?: ((...params: any[]) => any)|null
     };
 
 }
@@ -57,17 +58,17 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public getConfigObject(gridOptions?: any): any;
 
-    public disable(opt_disabled?: boolean, opt_id?: string): void;
+    public disable(opt_disabled?: boolean|null, opt_id?: string|null): void;
 
-    public addFilter(exp: RowFilteringPlugin.Expression, funcName?: string, ctx?: any): string;
+    public addFilter(exp: RowFilteringPlugin.Expression|null, funcName?: string|null, ctx?: any): string;
 
-    public addGridFilter(exp: RowFilteringPlugin.Expression, ctx?: any): string;
+    public addGridFilter(exp: RowFilteringPlugin.Expression|null, ctx?: any): string;
 
-    public addColumnFilter(colIndex: number, exp: RowFilteringPlugin.Expression, ctx?: (any|string)): boolean;
+    public addColumnFilter(colIndex: number, exp: RowFilteringPlugin.Expression|null, ctx?: (any|string)|null): boolean;
 
-    public setColumnFilter(colIndex: number, exp: RowFilteringPlugin.Expression, ctx?: (any|string)): boolean;
+    public setColumnFilter(colIndex: number, exp: RowFilteringPlugin.Expression|null, ctx?: (any|string)|null): boolean;
 
-    public removeFilter(funcRef: ((...params: any[]) => any)|string): boolean;
+    public removeFilter(funcRef: ((...params: any[]) => any)|string|null): boolean;
 
     public removeColumnFilters(colIndex: number): boolean;
 
@@ -77,11 +78,11 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public removeAllFilters(): void;
 
-    public setOverridingFilter(func: ((...params: any[]) => any)): void;
+    public setOverridingFilter(func: ((...params: any[]) => any)|null): void;
 
-    public setPreTransform(func: ((...params: any[]) => any)): void;
+    public setPreTransform(func: ((...params: any[]) => any)|null): void;
 
-    public setRowTransform(func: ((...params: any[]) => any)): void;
+    public setRowTransform(func: ((...params: any[]) => any)|null): void;
 
     public getFilters(): (((...params: any[]) => any))[];
 
@@ -89,7 +90,7 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public getFilterExpressions(): (RowFilteringPlugin.FilterExpression)[]|null;
 
-    public setFilterExpressions(filterExps: (RowFilteringPlugin.FilterExpression)[]): void;
+    public setFilterExpressions(filterExps: (RowFilteringPlugin.FilterExpression)[]|null): void;
 
     public hasColumnFilter(): boolean;
 
@@ -109,13 +110,13 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public getColumnFilterStates(): any[];
 
-    public getUniqueValues(field: string, formatter?: ((...params: any[]) => any), fmtField?: string, rawDataAccessor?: ((...params: any[]) => any), formattedDataAccessor?: ((...params: any[]) => any)): any;
+    public getUniqueValues(field: string, formatter?: ((...params: any[]) => any)|null, fmtField?: string|null, rawDataAccessor?: ((...params: any[]) => any)|null, formattedDataAccessor?: ((...params: any[]) => any)|null): any;
 
-    public openDialog(colIndex: number, options?: RowFilteringPlugin.FilterDialogOptions): void;
+    public openDialog(colIndex: number, runtimeDialogOptions?: RowFilteringPlugin.FilterDialogOptions|null): void;
 
 }
 
-declare function field(colIndex: number, exp: RowFilteringPlugin.Expression, ctx?: (any|string)): boolean;
+declare function field(colIndex: number, exp: RowFilteringPlugin.Expression|null, ctx?: (any|string)|null): boolean;
 
 export default RowFilteringPlugin;
 export { RowFilteringPlugin, RowFilteringPlugin as RowFiltering, RowFilteringPlugin as RowFilteringExtension };