@refinitiv-ui/efx-grid 6.0.0-next.0

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

@@ -0,0 +1,21 @@
+import {Ext} from "../../tr-grid-util/es6/Ext.js";
+import {EventDispatcher} from "../../tr-grid-util/es6/EventDispatcher.js";
+
+declare class SnapshotFiller extends EventDispatcher {
+
+    constructor();
+
+    public setRTK(rtk: any): void;
+
+    public addRic(ric: string): void;
+
+    public addField(str: string): void;
+
+    public addFields(fields: (string)[]): void;
+
+    public static isValidField(str: string): boolean;
+
+}
+
+export { SnapshotFiller };
+export default SnapshotFiller;

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

@@ -0,0 +1,252 @@
+import {Ext} from "../../tr-grid-util/es6/Ext.js";
+import {EventDispatcher} from "../../tr-grid-util/es6/EventDispatcher.js";
+
+/** @private
+* @param {Object} obj
+* @return {boolean}
+*/
+var isEmptyObject = function (obj) {
+	for (var key in obj) {
+		return false;
+	}
+	return true;
+};
+
+/** This class make requesting ADC field easier by encapsulating JET.Data APIs and mapping data to the row
+* @constructor
+* @extends {EventDispatcher}
+*/
+var SnapshotFiller = function () {
+	this._onRequest = this._onRequest.bind(this);
+
+	this._rics = {};
+	this._fields = {};
+};
+Ext.inherits(SnapshotFiller, EventDispatcher);
+
+//#region Private Members
+/** @type {number}
+* @private
+*/
+SnapshotFiller.prototype._timerId = 0;
+/** @type {!Object.<string, number>}
+* @private
+*/
+SnapshotFiller.prototype._rics;
+/** @type {!Object.<string, number>}
+* @private
+*/
+SnapshotFiller.prototype._fields;
+/** @type {!*}
+* @private
+*/
+SnapshotFiller.prototype._rtk;
+//#endregion Private Members
+
+/** @public
+* @param {*} rtk RTK instance
+*/
+SnapshotFiller.prototype.setRTK = function (rtk) {
+	this._rtk = rtk;
+};
+
+/** @public
+* @param {string} ric
+*/
+SnapshotFiller.prototype.addRic = function (ric) {
+	// TODO: since we use ric instead of rowDef
+	// We need to find a way to check isSubscribing and isAutoGenerated before add ric
+	// if (!rowDef.isSubscribing()) { // // Only real-time row (non-empty non-header) can be registered for snapshot.
+	// 	if (!rowDef.isAutoGenerated()) {  // However, chain constituents (auto generated) are still eligible.
+	// 		return;
+	// 	}
+	// }
+
+	if (ric && !this._rics[ric]) {
+		this._rics[ric] = 1;
+		this._request();
+	}
+};
+/** @public
+* @param {string} str
+*/
+SnapshotFiller.prototype.addField = function (str) {
+	if(this._addField(str)) {
+		this._request();
+	}
+};
+/** @public
+* @param {Array.<string>} fields
+*/
+SnapshotFiller.prototype.addFields = function (fields) {
+	var len = fields.length;
+	var dirty = 0;
+	for(var i = 0; i < len; ++i) {
+		dirty |= this._addField(fields[i]);
+	}
+	if(dirty) {
+		this._request();
+	}
+};
+
+/** @private
+* @param {string} str
+* @return {number}
+*/
+SnapshotFiller.prototype._addField = function (str) {
+	if(SnapshotFiller.isValidField(str)) {
+		if(!this._fields[str]) {
+			this._fields[str] = 1;
+			return 1;
+		}
+	}
+	return 0;
+};
+/** @public
+* @function
+* @param {string} str
+* @returns {boolean}
+*/
+SnapshotFiller.isValidField = function(str) {
+	// Only field with TR. is considered as ADC field
+	return (str && str.indexOf("TR.") === 0) ? true : false;
+};
+
+/** @private
+*/
+SnapshotFiller.prototype._request = function () {
+	if(!this._timerId) {
+		this._timerId = setTimeout(this._onRequest, 0);
+	}
+};
+/** @private
+*/
+SnapshotFiller.prototype._onRequest = function () {
+	this._timerId = 0;
+
+	var jet = window["JET"]; // Assume that JET is already exist.
+	if (this._rtk) {
+		if (!this._rtk.Data) {
+			return; // Require RTK.Data plugin to get snapshot data
+		}
+	} else if (!jet || !jet["ContainerDescription"] || (typeof jet["Data"] !== "function")) {
+		return; // Require JET to get snapshot data or JET is not ready to use
+	}
+
+	// Retrieve instruments and ADC fields
+	var instruments = Object.keys(this._rics);
+
+	var i;
+	var fields = Object.keys(this._fields);
+	var fieldLen = fields.length;
+
+	if (!fieldLen || !instruments.length) { // No ADC field or real-time RIC
+		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);
+	if (this._rtk) {
+		this._rtk.Data.DataGrid
+			.request(payload)
+			.then(onSuccess)
+			.catch(function (err) {
+				console.log(err);
+			});
+	} else {
+		jet["Data"]("datagrid")
+			.then(function (service) { return service["request"](payload); })
+			.then(JSON.parse)
+			.then(onSuccess)
+			.catch(function (err) {
+				console.log(err);
+			});
+	}
+};
+
+/** @private
+* @function
+* @param {Array.<string>} fields
+* @param {string} serverResult
+*/
+SnapshotFiller.prototype._onSuccess = function (fields, 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
+	// 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].field === 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 = 0; i < len; i++) {
+		var dataRow = data2D[i];
+		ric = dataRow[0];
+
+		if (ricMap[ric]) {
+			continue; // we interested only first row of ric
+		}
+
+		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 !== "") {
+				field = headers[j];
+				snapData[field] = value;
+			}
+		}
+	}
+
+	// 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/rt-grid/es6/StyleLoader.d.ts

@@ -0,0 +1,17 @@
+import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { Core } from "../../core/es6/grid/Core.js";
+
+declare class StyleLoader {
+
+    constructor();
+
+    public static readonly chainIcon: string;
+
+    public static readonly styles: string;
+
+    public static applyStyle(grid: Core): void;
+
+}
+
+export { StyleLoader };
+export default StyleLoader;

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

@@ -0,0 +1,47 @@
+/* eslint-disable */
+import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { Core } from "../../core/es6/grid/Core.js";
+/* eslint-enable */
+
+/**
+* @constructor
+*/
+var StyleLoader = {};
+
+/** @public
+ * @type {string}
+ */
+StyleLoader.chainIcon = '';
+
+/** @type {string}
+* @public
+*/
+StyleLoader.styles = prettifyCss([
+	".tr-grid .chain-icon", [
+		"cursor: pointer;"
+	],
+	".tr-grid .chain-icon .fallback-arrow", [
+		"vertical-align: middle;",
+		"font-size: 7px;",
+		"line-height: 1;",
+		"display: inline-block;", // For transformation
+		"transform: scaleX(1.5);",
+		"font-family: Arial;"
+	],
+	".tr-grid .closed .chain-icon", [
+		"transform: translate(0px, -1px) rotate(-90deg);"
+	]
+]);
+
+/** @public
+* @param {Core} grid
+*/
+StyleLoader.applyStyle = function (grid) {
+	if (grid && !grid._rowGroupingStyles) { // TODO: Support run-time theme loading
+		grid._rowGroupingStyles = true; // Prevent loading the same style twice
+		injectCss(StyleLoader.styles, grid.getElement());
+	}
+};
+
+export { StyleLoader };
+export default StyleLoader;

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

@@ -0,0 +1,8 @@
+/* eslint-disable */
+import {Grid} from "./Grid.js";
+/* eslint-enable */
+
+
+
+export { Grid };
+export default Grid;

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

@@ -0,0 +1,43 @@
+/* eslint-disable */
+import {Grid} from "./Grid.js";
+/* eslint-enable */
+
+// tsd-disable
+import {MockJET} from "../node_modules/tr-grid-util/es6/jet/MockJET.js";
+import {Dom} from "../node_modules/tr-grid-util/es6/Dom.js";
+import {CellPainter} from "../node_modules/tr-grid-util/es6/CellPainter.js";
+
+if (window) {
+	var trNamespace = window['tr'];
+	if(!trNamespace) {
+		trNamespace = window['tr'] = {};
+	}
+	var rtNamespace = trNamespace['rt'];
+	if(!rtNamespace) {
+		rtNamespace = trNamespace['rt'] = {};
+	}
+	var gridNamespace = trNamespace['grid'];
+	if(!gridNamespace) {
+		gridNamespace = trNamespace['grid'] = {};
+	}
+
+	if(!trNamespace['MockJET']) {
+		trNamespace.MockJET = MockJET;
+	}
+	if(!trNamespace['closestElement']) {
+		trNamespace.closestElement = Dom.closestElement;
+	}
+	if(!trNamespace['CellPainter']) {
+		trNamespace.CellPainter = CellPainter;
+	}
+	if(!rtNamespace['Grid']) {
+		rtNamespace.Grid = Grid;
+	}
+	if(!gridNamespace['CellPainter']) {
+		gridNamespace.CellPainter = CellPainter;
+	}
+}
+// tsd-enable
+
+export { Grid };
+export default Grid;

package/lib/statistics-row/es6/StatisticsRow.d.ts

@@ -0,0 +1,67 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+
+declare namespace StatisticsRowPlugin {
+
+    type Options = {
+        rows?: any[],
+        invalidText?: string,
+        noColoring?: boolean,
+        noFormatting?: boolean,
+        postCalculation?: ((...params: any[]) => any),
+        postRendering?: ((...params: any[]) => any)
+    };
+
+    type ColumnOptions = {
+        statistics?: (boolean|string)
+    };
+
+    type RowOptions = {
+        placement?: string,
+        statistic?: string,
+        label?: string,
+        id?: string
+    };
+
+    type RowReference = string|number;
+
+    type Stats = {
+        field?: string,
+        label?: boolean,
+        count?: number,
+        sum?: number,
+        average?: number,
+        min?: number,
+        max?: number
+    };
+
+}
+
+declare class StatisticsRowPlugin extends GridPlugin {
+
+    constructor(options?: StatisticsRowPlugin.Options);
+
+    public getName(): string;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public setStatisticsRows(rows: (StatisticsRowPlugin.RowOptions)[]): void;
+
+    public getStatisticsRows(): (StatisticsRowPlugin.RowOptions)[];
+
+    public setStatisticsRow(rowRef: StatisticsRowPlugin.RowReference, options: StatisticsRowPlugin.RowOptions): boolean;
+
+    public addStatisticsRow(options: StatisticsRowPlugin.RowOptions): void;
+
+    public removeStatisticsRow(rowRef: StatisticsRowPlugin.RowReference): void;
+
+}
+
+export default StatisticsRowPlugin;
+export { StatisticsRowPlugin, StatisticsRowPlugin as StatisticsRow, StatisticsRowPlugin as StatisticsRowExtension };