@refinitiv-ui/efx-grid 6.0.2 → 6.0.5

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

@@ -0,0 +1,19 @@
+
+
+declare class RowDefSorter {
+
+    constructor();
+
+    public dispose(): void;
+
+    public getSorter(rowSorting?: boolean): ((...params: any[]) => any)|null;
+
+    public setSortLogic(func?: ((...params: any[]) => any)): void;
+
+    public setField(field: string): void;
+
+    public setContext(key: string, value: any): void;
+
+}
+
+export default RowDefSorter;

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

@@ -0,0 +1,137 @@
+/** @constructor
+*/
+var RowDefSorter = function() {
+	this._defaultSorter = this._defaultSorter.bind(this);
+	this._dataSorter = this._dataSorter.bind(this);
+	this._rowDefSorter = this._rowDefSorter.bind(this);
+
+	this._sortContext = {};
+};
+
+
+/** @type {string}
+* @private
+*/
+RowDefSorter.prototype._field = "";
+/** @type {!Object}
+* @private
+*/
+RowDefSorter.prototype._sortContext;
+/** @type {Function}
+* @private
+*/
+RowDefSorter.prototype._sortLogic = null;
+
+
+/** @public
+*/
+RowDefSorter.prototype.dispose = function() {
+	this._sortLogic = null;
+	this._sortContext = {}; // Clear any existing reference
+};
+
+/** @public
+* @param {boolean=} rowSorting=false
+* @return {Function}
+*/
+RowDefSorter.prototype.getSorter = function(rowSorting) {
+	if(this._sortLogic) {
+		return rowSorting ? this._rowDefSorter : this._dataSorter;
+	} else {
+		return this._defaultSorter;
+	}
+};
+/** @public
+* @param {Function=} func
+*/
+RowDefSorter.prototype.setSortLogic = function(func) {
+	this._sortLogic = (typeof func === "function") ? func : null;
+};
+
+
+/** @public
+* @param {string} field
+*/
+RowDefSorter.prototype.setField = function(field) {
+	if(!field) {
+		field = "";
+	}
+	this._sortContext["field"] = this._field = field;
+	this._sortContext["formattedField"] = field + "_FORMATTED";
+};
+/** @public
+* @param {string} key
+* @param {*} value
+*/
+RowDefSorter.prototype.setContext = function(key, value) {
+	this._sortContext[key] = value;
+};
+
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._defaultSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	var a = rowDefA.getData(this._field);
+	var b = rowDefB.getData(this._field);
+
+	if(a == null || a !== a) {
+		if(b == null || b !== b) {
+			return 0;
+		}
+		return 1;
+	}
+	if(b == null || b !== b) {
+		return -1;
+	}
+
+	if(a < b) {
+		return -order;
+	}
+	if(b < a) {
+		return order;
+	}
+	return 0;
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._dataSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	var a = rowDefA.getData(this._field);
+	var b = rowDefB.getData(this._field);
+	return this._sortLogic(a, b, order, this._sortContext);
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._rowDefSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	return this._sortLogic(rowDefA, rowDefB, order, this._sortContext);
+};
+
+export default RowDefSorter;

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

@@ -31,12 +31,14 @@ declare class RowDefinition {
 
     public getRowId(): string;
 
-    public getConfigObject(rowOptions?: RowDefinition.Options): RowDefinition.Options;
+    public getConfigObject(rowOptions?: RowDefinition.Options): RowDefinition.Options|null;
 
     public getDataId(): string;
 
     public setDataSource(dataSource: DataCache): void;
 
+    public getDataSource(): DataCache|null;
+
     public getRowData(): any;
 
     public getData(field: string): any;
@@ -57,7 +59,7 @@ declare class RowDefinition {
 
     public getDisplayText(): string;
 
-    public getLabel(): string|null;
+    public getLabel(): string|null|null;
 
     public isRowHeader(): boolean;
 
@@ -81,13 +83,13 @@ declare class RowDefinition {
 
     public addUpdate(e: any): boolean;
 
-    public getUpdates(): { [key: string]:  number };
+    public getUpdates(): { [key: string]:  number }|null;
 
     public resetUpdates(): void;
 
     public registerToView(view: DataTable, rowId?: string): void;
 
-    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[];
+    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[]|null;
 
     public collapseChain(): boolean;
 
@@ -95,15 +97,15 @@ declare class RowDefinition {
 
     public toggleChain(): boolean;
 
-    public getChildren(): (RowDefinition)[];
+    public getChildren(): (RowDefinition)[]|null;
 
     public getDescendants(ary?: (RowDefinition)[]): (RowDefinition)[];
 
-    public getAllDescendantIds(): (string)[];
+    public getAllDescendantIds(): (string)[]|null;
 
     public getChildCount(): number;
 
-    public getParent(): RowDefinition;
+    public getParent(): RowDefinition|null;
 
     public getDepthLevel(): number;
 

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

@@ -363,6 +363,12 @@ RowDefinition.prototype.setDataSource = function(dataSource) {
 	// This will work for runtime row insertion, but not for first initilization.
 	this.subscribeForUpdates();
 };
+/** @public
+* @return {DataCache} dataSource
+*/
+RowDefinition.prototype.getDataSource = function() {
+	return this._dc;
+};
 
 /** @public
 * @return {Object} rowData

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,11 +8,15 @@ 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;
+
     public addField(str: string): void;
 
-    public addFields(fields: (string)[]): void;
+    public addFields(fields: (string)[]): boolean;
 
     public static isValidField(str: 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
 */
@@ -68,6 +97,26 @@ SnapshotFiller.prototype.addRic = function (ric) {
 	}
 };
 /** @public
+* @param {Array.<string>} rics
+* @return {boolean}
+*/
+SnapshotFiller.prototype.addRics = function (rics) {
+	var len = rics ? rics.length : 0;
+	var dirty = false;
+	for(var i = 0; i < len; ++i) {
+		var ric = rics[i];
+		if (ric && !this._rics[ric]) {
+			this._rics[ric] = 1;
+			dirty = true;
+		}
+	}
+	if(dirty) {
+		this._request();
+		return true;
+	}
+	return false;
+};
+/** @public
 * @param {string} str
 */
 SnapshotFiller.prototype.addField = function (str) {
@@ -77,6 +126,7 @@ SnapshotFiller.prototype.addField = function (str) {
 };
 /** @public
 * @param {Array.<string>} fields
+* @return {boolean}
 */
 SnapshotFiller.prototype.addFields = function (fields) {
 	var len = fields.length;
@@ -86,7 +136,9 @@ SnapshotFiller.prototype.addFields = function (fields) {
 	}
 	if(dirty) {
 		this._request();
+		return true;
 	}
+	return false;
 };
 
 /** @private
@@ -144,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)
@@ -182,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
@@ -248,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-checkbox/es6/Checkbox.d.ts

@@ -1,7 +1,7 @@
 import {Ext} from '../../tr-grid-util/es6/Ext.js';
 import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
 import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
-import {injectCss, prettifyCss, extendObject} from "../../tr-grid-util/es6/Util.js";
+import {injectCss, prettifyCss} from "../../tr-grid-util/es6/Util.js";
 
 declare namespace CheckboxPlugin {
 
@@ -12,7 +12,8 @@ declare namespace CheckboxPlugin {
         checkboxCreated?: ((...params: any[]) => any),
         checkboxBinding?: ((...params: any[]) => any),
         clicked?: ((...params: any[]) => any),
-        width?: number
+        width?: number,
+        topCheckboxHandler?: boolean
     };
 
     type ColumnOptions = {
@@ -41,7 +42,7 @@ declare class CheckboxPlugin extends GridPlugin {
 
     public getDisplayColumn(): number;
 
-    public getCheckbox(sectionRef: any, rowIndex: number): Element;
+    public getCheckbox(sectionRef: any, rowIndex: number): Element|null;
 
     public selectAll(): void;
 

package/lib/tr-grid-checkbox/es6/Checkbox.js

@@ -1,7 +1,7 @@
 import {Ext} from '../../tr-grid-util/es6/Ext.js';
 import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
 import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
-import {injectCss, prettifyCss, extendObject} from "../../tr-grid-util/es6/Util.js";
+import {injectCss, prettifyCss} from "../../tr-grid-util/es6/Util.js";
 
 /** @typedef {Object} CheckboxPlugin~Options
 * @description Available options describing `checkbox` object specified in grid's option
@@ -12,6 +12,7 @@ import {injectCss, prettifyCss, extendObject} from "../../tr-grid-util/es6/Util.
 * @property {Function=} checkboxBinding=null Function handler for checkboxBinding event
 * @property {Function=} clicked=null Function handler for checkbox clicked event
 * @property {number=} width=34 Width for checkbox column
+* @property {boolean=} topCheckboxHandler=true If disabled, when clicked on header row checkbox it will not perform default behavior
 */
 
 /** @typedef {Object} CheckboxPlugin~ColumnOptions
@@ -103,6 +104,10 @@ CheckboxPlugin.prototype._disablingField = "CHECK_BOX_DISABLED";
 * @private
 */
 CheckboxPlugin.prototype._autoRowSelection = false;
+/** @type {boolean}
+* @private
+*/
+CheckboxPlugin.prototype._topCheckboxHandler = true;
 /** @type {Function}
 * @private
 */
@@ -121,9 +126,11 @@ CheckboxPlugin._styles = prettifyCss([
 	".tr-checkbox-column input[type='checkbox'], .tr-checkbox-column input+label", [
 		"cursor: pointer;"
 	],
-	".column.tr-checkbox-column .cell", [
-		"padding: 0;",
-		"text-align: center;"
+	".column.tr-checkbox-column.tr-align-left .cell", [
+		"text-align: left;"
+	],
+	".column.tr-checkbox-column.tr-align-right .cell", [
+		"text-align: right;"
 	]
 ]);
 /** @private
@@ -348,6 +355,10 @@ CheckboxPlugin.prototype.config = function (options) {
 	if(val) {
 		this._width = val;
 	}
+	val = chkboxOpt["topCheckboxHandler"];
+	if(val != null) {
+		this._topCheckboxHandler = val ? true : false;
+	}
 
 	this.addListener(chkboxOpt, "checkboxCreated");
 	this.addListener(chkboxOpt, "clicked");
@@ -437,31 +448,30 @@ CheckboxPlugin.prototype.beforeInit = function(elem, config, runTime) {
 		}
 	}
 
-	var chbxCol = t._genCheckboxColumn();
-	var checkboxIdx = t._userCheckboxIdx = t._findCheckboxColumnIndexFromConfig(columns);
-
-	if (checkboxIdx >= 0) {
-		// WARNING:: User column config will be deleted here since we swap user column with our generated checkbox column
-		extendObject(columns[checkboxIdx], chbxCol);
+	t._userCheckboxIdx = t._findCheckboxColumnIndexFromConfig(columns);
+	if (t._userCheckboxIdx >= 0) {
+		t._genCheckboxColumn(columns[t._userCheckboxIdx]);
 	} else {
-		checkboxIdx = t._userCheckboxIdx = 0;
-		columns.unshift(chbxCol);
+		columns.unshift(t._genCheckboxColumn());
+		t._userCheckboxIdx = 0; // TODO: This _userCheckboxIdx has some misleading meaning
 	}
 };
 
 /** @private
-* @return {Object} checkbox column config
+* @param {Object=} userObj
+* @return {!Object} checkbox column config
 */
-CheckboxPlugin.prototype._genCheckboxColumn = function () {
-	return {
-		autoGenerated: true,
+CheckboxPlugin.prototype._genCheckboxColumn = function (userObj) {
+	var defaultObj = {
 		width: this._width,
 		sortable: false,
 		className: "tr-checkbox-column", // For rt-grid
 		classes: { "tr-checkbox-column": 1 }, // For composite grid
 		noResizing: true, // ColumnResizing Extension
 		resizable: false, // ResizableTitlePlugin
-		headerRenderer: this._onPreSectionRender, // rt-grid support
+		title: "",
+		tooltip: "",
+		// headerRenderer: CheckboxPlugin._emptyFunc, // rt-grid support
 		filterInput: { disabled: true },
 		field: this._checkboxField,
 		notRealTimeField: true, // Checkbox column is not a real-time field
@@ -473,6 +483,26 @@ CheckboxPlugin.prototype._genCheckboxColumn = function () {
 			bind: CheckboxPlugin._emptyFunc
 		}
 	};
+
+	if(userObj && !userObj.autoGenerated) {
+		if(userObj.field && this._checkboxField === "CHECK_BOX") {
+			this._checkboxField = userObj.field;
+		}
+		if(userObj.width && this._width === 34) {
+			this._width = +userObj.width;
+		}
+
+		for(var key in defaultObj) {
+			var userVal = userObj[key];
+			if(userVal == null) {
+				userObj[key] = defaultObj[key];
+			}
+		}
+		return userObj;
+	}
+
+	defaultObj.autoGenerated = true;
+	return defaultObj;
 };
 
 /** @private
@@ -606,9 +636,6 @@ CheckboxPlugin.prototype._createCheckbox = function (sectionSettings, colIndex,
 
 	cell.setContent(chkbox);
 	var sectionType = sectionSettings.getType();
-	if(sectionType == "title") {
-		cell.enableClass("no-sort");
-	}
 
 	if(!this._coralCheckboxVer) { // Workaround for UIFR theme styling
 		var lbl = document.createElement("label");
@@ -695,7 +722,7 @@ CheckboxPlugin.prototype.setAllCheckStates = function (checked) {
 * @see {@link CheckboxPlugin#checkAll}
 */
 CheckboxPlugin.prototype.selectAllPages = function (checked) {
-	var state = CheckboxPlugin._toCheckState(checked != null ? checked : true);
+	var state = checked != null ? checked : true;
 	var host = this._hosts[0];
 	var dv = host ? host.getDataSource() : null;
 
@@ -982,6 +1009,9 @@ CheckboxPlugin.prototype._getAllCheckboxes = function (sectionSettings, ary) {
 * @param {string} state
 */
 CheckboxPlugin.prototype._setDescendantCheckState = function (sectionSettings, state) {
+	if(!this._topCheckboxHandler){
+		return;
+	}
 	var children = sectionSettings.getChildren();
 	if (children) {
 		for (var i = 0; i < children.length; ++i) {