@refinitiv-ui/efx-grid 6.0.4 → 6.0.5

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

@@ -30,6 +30,10 @@ declare namespace Grid {
         debug?: boolean
     };
 
+    type ADCOptions = {
+        productId?: string
+    };
+
     type GridOptions = {
         columns?: (ColumnDefinition.Options|string)[],
         defaultColumnOptions?: ColumnDefinition.Options,
@@ -63,6 +67,7 @@ declare namespace Grid {
         verticalLines?: boolean,
         horizontalLines?: boolean,
         RTK?: any,
+        ADC?: Grid.ADCOptions,
         synapse?: Grid.SynapseConfig,
         contentRightPadding?: number,
         contentBottomPadding?: number,
@@ -120,6 +125,8 @@ declare class Grid extends EventDispatcher {
 
     public insertColumn(columnOption: ColumnDefinition.Options|string, idx?: number): void;
 
+    public replaceColumn(columnOption: ColumnDefinition.Options|string, colRef: Grid.ColumnReference): void;
+
     public setColumns(columns: (any)[]): void;
 
     public setFields(ary: (string)[]): void;

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

@@ -31,6 +31,11 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {boolean=} debug=false If true, Synapse response will be mock
 */
 
+/** @typedef {Object} Grid~ADCOptions
+* @description ADC requesting level config from adc team
+* @property {string=} productId=001 required parameter, it specifies the product for which you request data. Contact the adc staff to create one.
+*/
+
 /** @typedef {Object} Grid~GridOptions
 * @description Configuration object that can be provided directly at the initialization phase
 * @property {Array.<ColumnDefinition~Options|string>=} columns Collection of the column definitions
@@ -65,6 +70,7 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {boolean=} verticalLines=true Vertical lines for all sections
 * @property {boolean=} horizontalLines=true Horizontal lines for all sections
 * @property {*=} RTK=null rtk toolkit instance
+* @property {Grid~ADCOptions=} ADC=null ADC requesting level config object from adc team
 * @property {Grid~SynapseConfig=} synapse=null synapse config object
 * @property {number=} contentRightPadding=0 Padding that is added next to the right most column. The padding is still a part of scrollable content.
 * @property {number=} contentBottomPadding=0 Padding that is added below the last section. The padding is still a part of scrollable content.
@@ -455,6 +461,10 @@ Grid.prototype._defaultColumnOptions = null;
 * @type {*}
 */
 Grid.prototype._RTK = null;
+/** @private
+* @type {Grid~ADCOptions}
+*/
+Grid.prototype._ADCOptions = null;
 /** use for synapse service
 * @private
 * @type {string}
@@ -729,6 +739,12 @@ Grid.prototype.initialize = function(gridOption) {
 		t._RTK = gridOption["RTK"];
 		t._snapshot.setRTK(t._RTK);
 	}
+
+	if (gridOption["ADC"]) {
+		t._ADCOptions = gridOption["ADC"];
+		t._snapshot.setADCOptions(t._ADCOptions);
+	}
+
 	if (gridOption["synapse"]) {
 		t._synapse = gridOption["synapse"];
 		FieldDefinition.setSynapseConfig(t._synapse);
@@ -1084,7 +1100,7 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	// topFreezingCount, bottomFreezingCount
 	// scrollbarParent
 
-	// NOTE: no need to export synapseApiKey and RTK
+	// NOTE: no need to export synapseApiKey, ADC and RTK
 
 	return obj;
 };
@@ -1245,6 +1261,70 @@ Grid.prototype.insertColumn = function (columnOption, idx) {
 };
 
 
+/** @public
+* @param {ColumnDefinition~Options|string} columnOption String will be treated as field, while object is treated as the column options
+* @param {Grid~ColumnReference} colRef
+*/
+Grid.prototype.replaceColumn = function (columnOption, colRef) {
+	var colIndex = this.getColumnIndex(colRef);
+	if(colIndex < 0) {
+		return;
+	}
+	var colConfig = {};
+	var core = this._grid;
+	var columnDef = core._getColumnDef(colIndex);
+
+	var value = core.getColumnScalability(colIndex);
+	colConfig["scalable"] = value;
+
+	value = core.getColumnCustomLaneSize(colIndex);
+	colConfig["width"] = value;
+
+	value = core.getMinimumColumnWidth(colIndex);
+	if(value !== 32) {
+		colConfig["minWidth"] = value;
+	}
+
+	value = core.isColumnVisible(colIndex);
+	if(!value) {
+		colConfig["hidden"] = true;
+	}
+
+	value = columnDef["stationary"];
+	if (value) {
+		colConfig["stationary"] = value;
+	}
+
+	value = columnDef["leftPinned"];
+	if (value) {
+		colConfig["leftPinned"] = value;
+	}
+
+	value = columnDef["rightPinned"];
+	if (value) {
+		colConfig["rightPinned"] = value;
+	}
+
+	if(typeof columnOption === "string") {
+		colConfig["field"] = columnOption;
+	} else { // type object from user
+		for (var key in columnOption) {
+			colConfig[key] = columnOption[key];
+		}
+	}
+
+	if(columnOption["width"] && !columnOption["scalable"]) {
+		colConfig["scalable"] = false;
+	}
+
+	if(columnOption["scalable"] && !columnOption["width"]) {
+		colConfig["width"] = 1;
+	}
+
+	this.insertColumn(colConfig, colIndex);
+	this.removeColumn(colIndex + 1); // remove existing column after insert
+};
+
 /** to update column name when field info is loaded
  * @private
  * @param {string} field

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

@@ -1,3 +1,4 @@
+import Grid from "./Grid.js";
 import {Ext} from "../../tr-grid-util/es6/Ext.js";
 import {EventDispatcher} from "../../tr-grid-util/es6/EventDispatcher.js";
 
@@ -7,6 +8,8 @@ declare class SnapshotFiller extends EventDispatcher {
 
     public setRTK(rtk: any): void;
 
+    public setADCOptions(adcOptions: Grid.ADCOptions): void;
+
     public addRic(ric: string): void;
 
     public addRics(rics: (string)[]): boolean;

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

@@ -1,3 +1,5 @@
+/* eslint-disable */
+import Grid from "./Grid.js";
 import {Ext} from "../../tr-grid-util/es6/Ext.js";
 import {EventDispatcher} from "../../tr-grid-util/es6/EventDispatcher.js";
 
@@ -21,6 +23,9 @@ var SnapshotFiller = function () {
 
 	this._rics = {};
 	this._fields = {};
+	this._adcOptions = { // TODO: support requesting level parameter
+		productId: "001"
+	};
 };
 Ext.inherits(SnapshotFiller, EventDispatcher);
 
@@ -41,6 +46,10 @@ SnapshotFiller.prototype._fields;
 * @private
 */
 SnapshotFiller.prototype._rtk;
+/** @type {!Grid~ADCOptions}
+* @private
+*/
+SnapshotFiller.prototype._adcOptions = null;
 //#endregion Private Members
 
 /** @public
@@ -50,6 +59,26 @@ SnapshotFiller.prototype.setRTK = function (rtk) {
 	this._rtk = rtk;
 };
 
+/** @public
+* @param {Grid~ADCOptions} adcOptions ADC requesting level parameter options
+*/
+SnapshotFiller.prototype.setADCOptions = function (adcOptions) {
+
+	var val = adcOptions["productId"];
+	if(val) {
+		this._adcOptions.productId = val;
+	}
+	// TODO: support requesting level parameter https://confluence.refinitiv.com/display/ADC/Request+level+parameters
+	// var val = adcOptions["lang"];
+	// if(val) {
+	// 	this._adcOptions.lang = val;
+	// }
+	// var val = adcOptions["cache"];
+	// if(val) {
+	// 	this._adcOptions.cache = val;
+	// }
+};
+
 /** @public
 * @param {string} ric
 */
@@ -167,29 +196,37 @@ SnapshotFiller.prototype._onRequest = function () {
 		return;
 	}
 
-	var reqFields = [];
-	for(i = 0; i < fieldLen; i++) {
-		reqFields.push({ "name": fields[i] });
-	}
-
 	// Clean up members, preparing for the next request
 	this._rics = {};
 	this._fields = {};
 
-	var payload = {
-		"instruments": instruments,
-		"fields": reqFields
-	};
-
-	var onSuccess = this._onSuccess.bind(this, fields);
+	var onSuccess, payload;
 	if (this._rtk) {
-		this._rtk.Data.DataGrid
+		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);
 			});
 	} else {
+		var reqFields = [];
+		for(i = 0; i < fieldLen; i++) {
+			reqFields.push({ "name": fields[i] });
+		}
+		payload = {
+			"instruments": instruments,
+			"fields": reqFields
+		};
+		onSuccess = this._onJETSuccess.bind(this, fields);
 		jet["Data"]("datagrid")
 			.then(function (service) { return service["request"](payload); })
 			.then(JSON.parse)
@@ -205,16 +242,15 @@ SnapshotFiller.prototype._onRequest = function () {
 * @param {Array.<string>} fields
 * @param {string} serverResult
 */
-SnapshotFiller.prototype._onSuccess = function (fields, serverResult) {
+SnapshotFiller.prototype._onJETSuccess = function (fields, serverResult) {
+	this._dispatch("adcDataReceived", serverResult);
 	var data2D = serverResult["data"];
 	var svHeaders = serverResult["headers"] && serverResult["headers"][0];
 
 	if (!Array.isArray(data2D) || !Array.isArray(svHeaders)) {
-		console.log("Invalid server response detected");
 		return; //TODO: Return Promise.reject(errMsg);
 	}
 
-	this._dispatch("adcDataReceived", serverResult);
 
 	// Server will return field only in UPPERCASE
 	// ex. requestField = TR.Volume ===> serverField = TR.VOLUME
@@ -271,5 +307,75 @@ SnapshotFiller.prototype._onSuccess = function (fields, serverResult) {
 	});
 };
 
+/** @private
+* @function
+* @param {Array.<string>} fields
+* @param {string} serverResult
+*/
+SnapshotFiller.prototype._onRTKSuccess = function (fields, serverResult) {
+	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);
+	}
+
+	// Server will return field only in UPPERCASE
+	// ex. requestField = TR.Volume ===> serverField = TR.VOLUME
+	// so we need convert UPPERCASE to be original
+	var i, field, ric;
+	var j = 1; //  to skip instrument index, use j = 1
+	var fLength = fields.length;
+	var hLength = svHeaders.length;
+	var headers = new Array(hLength);
+	for (i = 0; i < fLength && j < hLength; i++) {
+		field = fields[i];
+		if (svHeaders[j].r.toUpperCase() === field.toUpperCase()) {
+			headers[j] = field;
+			j++;
+		}
+	}
+
+	var len = data2D.length;
+	var fieldLen = headers.length;
+	var ricMap = {};
+
+	// 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 snapData = ricMap[ric] = {};
+
+		// loop for create rowData for update
+		for (j = 1; j < fieldLen; j++) { // to skip instrument index, use j = 1
+			var value = dataRow[j];
+			if (value != null && value !== "") {
+				if(typeof value !== 'object') {
+					field = headers[j];
+					snapData[field] = value;
+				}
+				// TODO : handled when a cell has a mistake and the value appears as {f: "1"} ( description error in fault attribute at index 1 ),
+				// Therefore, we need to store information to the error field for this cell.
+				// else {}
+
+			}
+		}
+	}
+
+	// return result only ric that has update data
+	var updatedData = {};
+	for (ric in ricMap) {
+		var obj = ricMap[ric];
+		if (!isEmptyObject(obj)) {
+			updatedData[ric] = obj;
+		}
+	}
+
+	this._dispatch("dataChanged", {
+		data: updatedData
+	});
+};
+
 export { SnapshotFiller };
 export default SnapshotFiller;

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

@@ -3,6 +3,7 @@ import { GridPlugin } from '../../tr-grid-util/es6/GridPlugin.js';
 import { extendObject } from '../../tr-grid-util/es6/Util.js';
 import {CellPainter} from '../../tr-grid-util/es6/CellPainter.js';
 import {FilterBuilder} from '../../tr-grid-util/es6/FilterBuilder.js';
+import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
 
 declare namespace ConditionalColoringPlugin {
 
@@ -54,7 +55,7 @@ declare class ConditionalColoringPlugin extends GridPlugin {
 
     public blinkRow(rowIndex: number, blinkSignal: number, host?: any): void;
 
-    public getColumnPainter(colIndex: number): CellPainter;
+    public getColumnPainter(colIndex: number): CellPainter|null;
 
     public applyColor(colIndex: number, cell: any, rowData?: any): void;
 
@@ -62,7 +63,7 @@ declare class ConditionalColoringPlugin extends GridPlugin {
 
     public static setThemeColors(colors: { [key: string]:  string }): void;
 
-    public reloadThemeColors(): Promise<any>;
+    public reloadThemeColors(): Promise<any>|null;
 
 }
 

package/lib/tr-grid-conditional-coloring/es6/ConditionalColoring.js

@@ -3,6 +3,7 @@ import { GridPlugin } from '../../tr-grid-util/es6/GridPlugin.js';
 import { extendObject } from '../../tr-grid-util/es6/Util.js';
 import {CellPainter} from '../../tr-grid-util/es6/CellPainter.js';
 import {FilterBuilder} from '../../tr-grid-util/es6/FilterBuilder.js';
+import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
 
 /** @typedef {Object} ConditionalColoringPlugin~ColumnOptions
 * @description Extension column options that can be specified on each individual grid's column option:
@@ -97,6 +98,10 @@ ConditionalColoringPlugin.prototype.initialize = function (host, options) {
 	if (!CellPainter.themeReady) {
 		CellPainter.loadThemeColors().then(this._onThemeLoaded);
 	}
+
+	// Register callback for movement-color-profile attribute changed event
+	ElfUtil.getThemeColors(this._onThemeLoaded);
+
 	// In case of lazy loading
 	// DO something
 };

package/lib/tr-grid-percent-bar/es6/PercentBar.js

@@ -130,7 +130,7 @@ PercentBarPlugin.prototype.initialize = function (host, options) {
 
   if (!PercentBarPlugin._themeLoaded && !this._themeLoading) {
     this._themeLoading = true;
-    ElfUtil.getThemeColors().then(this._onThemeLoaded);
+    ElfUtil.getThemeColors(this._onThemeLoaded).then(this._onThemeLoaded);
   }
 };
 /** @override */

package/lib/tr-grid-row-selection/es6/RowSelection.js

@@ -50,7 +50,6 @@ var RowSelectionPlugin = function (options) {
 	t._updateMenuIcon = t._updateMenuIcon.bind(t);
 
 	t._hosts = [];
-	t._anchorRowDict = {};
 	t._isIE = isIE();
 	t._textRange = document.createRange();
 
@@ -94,11 +93,11 @@ RowSelectionPlugin.prototype._basedOnContent = false;
 * @private
 */
 RowSelectionPlugin.prototype._selectionField = "SELECTED_ROW";
-/** @type {Object}
+/** @type {string}
 * @private
 * @description use with _basedOnContent mode for tracking current anchor row
 */
-RowSelectionPlugin.prototype._anchorRowDict = null;
+RowSelectionPlugin.prototype._anchorRowId = "";
 /** @type {boolean}
 * @private
 */
@@ -367,13 +366,18 @@ RowSelectionPlugin.prototype.getActiveGrid = function () {
 * @return {number} rowIndex of anchor
 */
 RowSelectionPlugin.prototype.getRowAnchor = function (sectRef) {
-	var section = this._getSection(sectRef);
-	if (!section || !section.getRowAnchor) return -1;
 	if (this._basedOnContent) {
-		return this._anchorRowDict[section] || -1;
+		var dv = this._activeGrid ? this._activeGrid.getDataSource() : null;
+		if( dv && this._anchorRowId){
+			return dv.getRowIndex(this._anchorRowId);
+		}
 	} else {
-		return section.getRowAnchor();
+		var section = this._getSection(sectRef);
+		if (section && section.getRowAnchor){
+			return section.getRowAnchor();
+		}
 	}
+	return -1;
 };
 
 /** @public
@@ -868,7 +872,7 @@ RowSelectionPlugin.prototype._onPostSectionDataBinding = function (e) {
 
 	var fromR = section.getFirstIndexInView();
 	var toR = section.getLastIndexInView();
-	for (var r = fromR; r < toR; ++r) {
+	for (var r = fromR; r <= toR; ++r) {
 		var dataRow = this._rowGetter(dv.getRowDataAt(r));
 		if(dataRow) {
 			if(dataRow[field]) {
@@ -1084,7 +1088,7 @@ RowSelectionPlugin.prototype._sectionSetSelectedRow = function (section, rowInde
 			var dataRow = this._getRow(dv, rowIndex);
 			if (dataRow) {
 				this._setData(dv, rowIndex, this._selectionField, isSelect);
-				if (isSelect) this._anchorRowDict[section] = rowIndex;
+				if (isSelect) this._anchorRowId = dv.getRowId(rowIndex);
 			}
 		}
 	} else {
@@ -1142,7 +1146,7 @@ RowSelectionPlugin.prototype._sectionClearSelectedRows = function (section, pres
 			}
 		}
 		if (!preserveAnchor) {
-			this._anchorRowDict[section] = -1;
+			this._anchorRowId = "";
 		}
 	} else {
 		section.clearSelectedRows();

package/lib/tr-grid-util/es6/CellPainter.js

@@ -840,7 +840,7 @@ CellPainter._onThemeChanged = function(colors) {
 */
 CellPainter.loadThemeColors = function() {
 	if(!CellPainter.themeReady) {
-		CellPainter.themeReady = ElfUtil.getThemeColors().then(CellPainter._onThemeChanged);
+		CellPainter.themeReady = ElfUtil.getThemeColors(CellPainter._onThemeChanged).then(CellPainter._onThemeChanged);
 	}
 	return CellPainter.themeReady;
 };

package/lib/tr-grid-util/es6/ElementObserver.js

@@ -22,10 +22,10 @@ var _onAttributeMutated = function (listener, attributeName, mutation) {
 	if (mutation.type === "attributes") {
 		if (attributeName != null) {
 			if (mutation.attributeName === attributeName) {
-				listener(mutation);
+				listener(mutation.target.getAttribute(attributeName));
 			}
 		} else {
-			listener(mutation);
+			listener(mutation.target);
 		}
 	}
 };
@@ -78,9 +78,12 @@ ElementObserver._addListener = function(elem, fn) {
 	}
 	if (!elem._observeId) {
 		var id = ElementObserver._getNewId();
-		listeners[id] = [];
 		elem._observeId = id;
 	}
+	if (!listeners[elem._observeId]) { // Always check to support the using of separated ElfUtil module in testing page
+		listeners[elem._observeId] = [];
+	}
+
 	var listener = listeners[elem._observeId];
 	if (listener.indexOf(fn) < 0) {
 		listener.push(fn);

package/lib/tr-grid-util/es6/ElfUtil.d.ts

@@ -1,5 +1,6 @@
 import { nestedObjectToArray, rgb2Hex } from "./Util.js";
 import { Deferred } from "./Deferred.js";
+import { ElementObserver } from "./ElementObserver.js";
 
 declare namespace ElfUtil {
 
@@ -23,10 +24,12 @@ declare namespace ElfUtil {
 
     function prepareIconPreloading(): (string)[]|null;
 
-    function getThemeColors(): Promise<any>|null;
+    function setRTK(rtk: any): void;
 
     function getMovementColorProfile(): string;
 
+    function getThemeColors(themeChangedCb?: ((...params: any[]) => any)): Promise<any>|null;
+
 }
 
 export default ElfUtil;