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

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

@@ -0,0 +1,418 @@
+// TODO: Merge this with Fields in mobile-mon repository
+/* eslint-disable */
+import Grid from "./Grid.js";
+import RowDefinition from "./RowDefinition.js";
+/* eslint-enable */
+import { Deferred } from "../../tr-grid-util/es6/Deferred.js";
+
+/** @type {string}
+* @private
+* @const
+*/
+var SYNAPSE_URL =
+	'/synapse/service/suggestions/suggest/?'
+	+ 'hits=1' // search only 1 result
+	+ '&profile=' + encodeURIComponent('Field Selector');
+
+/** @function
+* @private
+* @param {Object} e
+*/
+function xRicNameRenderer(e) {
+	e.cell.setContent(e.rowDef.getDisplayText());
+}
+/** @function
+* @private
+* @param {RowDefinition} rowA
+* @param {RowDefinition} rowB
+* @param {number} order
+* @returns {number}
+*/
+function xRicNameSorter(rowA, rowB, order) {
+	var A = rowA.getDisplayText();
+	var B = rowB.getDisplayText();
+	if(A === B) {
+		return 0;
+	}
+	if(!A) {
+		return 1;
+	}
+	if(!B) {
+		return -1;
+	}
+	if(A < B) {
+		return -order;
+	}
+
+	return order;
+}
+
+
+/* @namespace */
+var FieldDefinition = {};
+
+/** @type {Object.<string, Object>}
+* @private
+*/
+FieldDefinition._defs = {
+	"X_RIC_NAME": {
+		name: "RIC",
+		notRealTimeField: true,
+		width: 100,
+		binding: xRicNameRenderer,
+		sortLogic: xRicNameSorter
+	},
+	"CF_NAME": {
+		name: "Name",
+		rank: 2800003,
+		fieldDataType: "ALPHANUMERIC",
+		id: "6307",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 100003,
+		description: "The name of the instrument"
+	},
+	"CF_LAST": {
+		name: "Last",
+		rank: 2800024,
+		fieldDataType: "PRICE",
+		id: "5364",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 100024,
+		description: "The latest trade price or value."
+	},
+	"PCTCHNG": {
+		name: "Pct. Chng",
+		rank: 2709440,
+		fieldDataType: "PRICE",
+		id: "56",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 9440,
+		description: "Percentage change in the latest trade price or value from the historic close."
+	},
+	"CF_NETCHNG": {
+		name: "Net. Chng",
+		rank: 2800027,
+		fieldDataType: "PRICE",
+		id: "5367",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 100027,
+		description: "Net Change is the difference between latest trade price or value and the historic closing value or settlement price."
+	},
+	"CF_CLOSE": {
+		name: "Close",
+		rank: 2800023,
+		fieldDataType: "PRICE",
+		id: "5360",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 100023,
+		description: "The last trade price, settlement value or closing value."
+	},
+	"CF_CURR": {
+		name: "Currency",
+		rank: 2800021,
+		fieldDataType: "ENUMERATED",
+		id: "6452",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 100021,
+		description: "The currency that the instrument is quoted in"
+	},
+	"CF_BID": {
+		name: "Bid",
+		rank: 2800025,
+		fieldDataType: "PRICE",
+		id: "5359",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 100025,
+		description: "The latest Bid price."
+	},
+	"CF_ASK": {
+		name: "Ask",
+		rank: 2800026,
+		fieldDataType: "PRICE",
+		id: "5358",
+		IsMonitorOnlyField: false,
+		IsRealtimePortfolioField: false,
+		IsRealtimeField: true,
+		source: "IDN",
+		sourceRank: 100026,
+		description: "The latest Ask price."
+	}
+};
+/** api-key to call synapse service
+* @type {string}
+* @private
+* @const
+*/
+FieldDefinition._synapse = '';
+/**
+* @type {string}
+* @private
+* @const
+*/
+FieldDefinition._lang = 'en';
+
+/**
+ * @type {Object.<string, boolean>}
+ * @private
+ */
+FieldDefinition._loadingField = {};
+
+/** @public
+* @function
+* @param {string} field
+* @param {Object} def
+*/
+FieldDefinition.set = function(field, def) {
+	FieldDefinition._defs[field] = def || null;
+};
+/** @public
+* @function
+* @param {string} field
+* @return {Object}
+*/
+FieldDefinition.get = function(field) {
+	return FieldDefinition._defs[field];
+};
+/** @public
+* @function
+* @param {string} field
+*/
+FieldDefinition.remove = function(field) {
+	delete FieldDefinition._defs[field];
+};
+
+/** @public
+* @function
+* @param {Grid~SynapseConfig} config
+*/
+FieldDefinition.setSynapseConfig = function (config) {
+	FieldDefinition._synapse = config;
+
+};
+
+/** @public
+* @function
+* @param {string} field
+* @param {Object} def
+*/
+FieldDefinition.set = function (field, def) {
+	FieldDefinition._defs[field] = def || null;
+};
+
+/** to get more info about field via synapse service
+* @private
+* @param {string} field
+* @returns {Promise}
+*/
+FieldDefinition.loadFieldInfo = function (field) {
+	if (FieldDefinition._loadingField[field]) {
+		return FieldDefinition._loadingField[field].promise;
+	}
+
+	var defer = new Deferred();
+	var synapse = FieldDefinition._synapse;
+	// cannot call request without synapse config
+	if (!synapse) {
+		defer.resolve(null);
+	}
+	// already have field definition then return
+	else if (FieldDefinition._defs[field]) {
+		defer.resolve(FieldDefinition._defs[field]);
+	}
+	// in debug using mock data instead
+	else if (synapse.debug) {
+		var mockData = this._mockOnLoadEndData(field, defer);
+		setTimeout(onLoadEnd.bind(null, mockData), 1000);
+	}
+	// cannot call request without apiKey and  contextApp
+	else if (!synapse.apiKey || !synapse.contextApp) {
+		defer.resolve(null); // cannot request without apiKey and contextApp
+	}
+	// everything fine, call synapse service
+	else {
+		var queryUrl = SYNAPSE_URL
+			+ '&api-key=' + encodeURIComponent(synapse.apiKey)
+			+ '&contextApp=' + encodeURIComponent(synapse.contextApp)
+			+ '&language=' + encodeURIComponent(FieldDefinition._lang)
+			+ '&query=' + encodeURIComponent(field);
+		if (synapse.auth) {
+			queryUrl += '&auth=' + encodeURIComponent(synapse.auth);
+		}
+		// TODO: handle client timeout
+		var xmr = new XMLHttpRequest();
+		xmr._defer = defer;
+		xmr._field = field;
+		FieldDefinition._loadingField[field] = defer;
+
+		// for now we care only successful case
+		xmr.addEventListener('loadend', onLoadEnd);
+		xmr.addEventListener('timeout', onError);
+		xmr.addEventListener('error', onError);
+		xmr.open("GET", queryUrl, true); // true for asynchronous
+		xmr.send();
+	}
+	return defer.promise;
+};
+
+/**
+* @private
+* @param {Event} e
+*/
+function onError(e) {
+	// provide information for timeout and error cases and will be used in onLoadEnd handler
+	e.currentTarget._error = {
+		type: e.type
+	};
+}
+
+/** @private
+* @function
+* @param {string} field
+* @param {Object} defer
+* @returns {Object}
+*/
+FieldDefinition._mockOnLoadEndData = function (field, defer) {
+	var fieldUpperCase = field.toUpperCase();
+	var fieldLowerCase = fieldUpperCase.toLowerCase();
+	var label;
+	if (fieldLowerCase.indexOf('_') === 2) { // transform XX_ABCD -> Abcd
+		label = fieldUpperCase[3] + fieldLowerCase.substring(4);
+	} else {
+		label = fieldUpperCase[0] + fieldLowerCase.substring(1);
+	}
+	var dataType = (fieldUpperCase.indexOf("DATE") >= 0) ? "DATE" : "PRICE";
+	var item = {
+		cmd: label,
+		explanation: null,
+		fr: false,
+		id: "1635614732",
+		navigation: null,
+		p: {
+			Rank: 2800024,
+			fdt: dataType,
+			fid: "5364",
+			fimo: false,
+			firp: false,
+			firt: true,
+			fl: label,
+			fn: fieldUpperCase,
+			fsrc: "IDN",
+			fsrnk: 100024
+		},
+		position: 0,
+		preview: false,
+		relations: {},
+		score: 2840024,
+		source: "87",
+		subtitle: "",
+		symbol: label,
+		title: "title mockup of " + fieldUpperCase,
+		vc: "FLD"
+	};
+
+	var response = {
+		action: '\"' + fieldUpperCase + '\" SRCH',
+		assetClassifierExplanation: "AssetClassifier is disabled.",
+		assetClassifierStatus: "NOT_INVOKED",
+		// header: { request: { … }, response: { … } }, // whatever
+		result: [{ name: "Fields", default: false, size: 1, hits: [item], hasMore: false }],
+		search: "cpurl://apps.cp./apps/SearchAll?Search.Value=" + fieldLowerCase + "*"
+	};
+	response = JSON.stringify(response);
+	return {
+		currentTarget: {
+			_defer: defer,
+			_field: field,
+			status: 200,
+			response: response,
+			responseText: response
+		}
+	};
+};
+
+/**
+* @private
+* @param {Event} e
+*/
+function onLoadEnd(e) {
+	var xmr = e.currentTarget;
+	var defer = xmr._defer;
+	var resolve = defer.resolve;
+	var reject = defer.reject;
+
+	delete FieldDefinition._loadingField[xmr._field];
+
+	if (xmr.status === 200) { // case success
+		var returnObj = {
+			field: xmr._field,
+			fieldDefinition: null
+		};
+		var res = JSON.parse(xmr.responseText);
+
+		var result = res.result && res.result[0];
+		if (result) {
+			var item = result.hits && result.hits[0];
+			if (item && item.p) {
+				var profile = item.p;
+				if (profile.fn.toUpperCase() === xmr._field.toUpperCase()) {
+					var fieldDef = FieldDefinition.get(xmr._field) || {};
+
+					fieldDef.field = profile.fn; // name
+					fieldDef.rank = profile.Rank;
+					fieldDef.fieldDataType = profile.fdt; // data type
+					fieldDef.IsMonitorOnlyField = profile.fimo;
+					fieldDef.IsRealtimePortfolioField = profile.firp;
+					fieldDef.IsRealtimeField = profile.firt;
+					fieldDef.name = profile.fl; // label
+					fieldDef.source = profile.fsrc;
+					fieldDef.sourceRank = profile.fsrnk;
+					fieldDef.description = item.title;
+
+					FieldDefinition.set(xmr._field, fieldDef);
+					returnObj.fieldDefinition = fieldDef;
+				}
+			}
+		}
+		resolve(returnObj);
+	} else if (xmr._error) { // case error && time out
+		xmr._error.field = xmr._field;
+		reject(xmr._error);
+	} else { // case status not 200
+		reject({
+			field: xmr._field,
+			status: xmr.status,
+			statusText: xmr.statusText,
+			request: xmr
+		});
+	}
+}
+
+(function() { // Add "field" property to all default field definitions. This reduces file size and redundancy
+	for(var key in FieldDefinition._defs) {
+		FieldDefinition._defs[key]["field"] = key;
+	}
+})();
+
+export {FieldDefinition};
+export default FieldDefinition;

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

@@ -0,0 +1,261 @@
+import {Dom} from "../../tr-grid-util/es6/Dom.js";
+import {Conflator} from "../../tr-grid-util/es6/Conflator.js";
+import {Ext} from "../../tr-grid-util/es6/Ext.js";
+import { EventDispatcher } from "../../tr-grid-util/es6/EventDispatcher.js";
+import { Engine } from "../../tr-grid-util/es6/formula/Engine.js";
+import { cloneObject, extendObject, arrayToObject } from "../../tr-grid-util/es6/Util.js";
+import { DateTime } from "../../tr-grid-util/es6/DateTime.js";
+
+import {RowDefinition, ROW_DEF} from "./RowDefinition.js";
+import {ColumnDefinition, COL_DEF} from "./ColumnDefinition.js";
+import SnapshotFiller from "./SnapshotFiller.js";
+import StyleLoader from "./StyleLoader.js";
+import FieldDefinition from "./FieldDefinition.js";
+import DataConnector from "./DataConnector.js";
+
+import { Core } from "../../core/es6/grid/Core.js";
+import { SortableTitlePlugin } from "../../core/es6/grid/plugins/SortableTitlePlugin.js";
+import { DragAndDropTitlePlugin } from "../../core/es6/grid/plugins/DragAndDropTitlePlugin.js";
+import { DataCache } from "../../core/es6/data/DataCache.js";
+import { DataTable } from "../../core/es6/data/DataTable.js";
+import { DataView } from "../../core/es6/data/DataView.js";
+import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js";
+
+declare namespace Grid {
+
+    type SynapseConfig = {
+        apiKey: string,
+        contextApp: string,
+        auth?: string,
+        debug?: boolean
+    };
+
+    type GridOptions = {
+        columns?: (ColumnDefinition.Options|string)[],
+        defaultColumnOptions?: ColumnDefinition.Options,
+        rows?: (RowDefinition.Options)[],
+        fields?: (string)[],
+        rics?: (string)[],
+        plugins?: any[],
+        extensions?: any[],
+        scrollbar?: boolean,
+        linearWheelScrolling?: boolean,
+        stepScroll?: boolean,
+        autoHideScrollbar?: boolean,
+        pageSize?: string,
+        rowHeight?: number,
+        headerRowHeight?: number,
+        noColumnDragging?: boolean,
+        columnReorder?: boolean,
+        rowHighlighting?: boolean,
+        autoLayoutUpdate?: (boolean|number),
+        columnFreezing?: number,
+        freezeColumn?: number,
+        pinnedRightColumns?: number,
+        staticDataRows?: any[],
+        dataFields?: (string)[],
+        rowVirtualization?: boolean,
+        columnVirtualization?: boolean,
+        topFreezingCount?: (number|null|boolean),
+        bottomFreezingCount?: (number|null),
+        borders?: boolean,
+        gridlines?: boolean,
+        verticalLines?: boolean,
+        horizontalLines?: boolean,
+        RTK?: any,
+        synapse?: Grid.SynapseConfig,
+        contentRightPadding?: number,
+        contentBottomPadding?: number,
+        dataConflationRate?: number,
+        dataComposed?: ((...params: any[]) => any),
+        autoDateConversion?: boolean,
+        textSelect?: boolean,
+        lang?: string
+    };
+
+    type RowReference = number|string|RowDefinition;
+
+    type ColumnReference = number|string|ColumnDefinition;
+
+}
+
+declare class Grid extends EventDispatcher {
+
+    constructor(placeholder?: (Element|null), config?: Grid.GridOptions);
+
+    public dispose(): void;
+
+    public getElement(): Element;
+
+    public removeEventListeners(): void;
+
+    public listen(type: string, handler: ((...params: any[]) => any)): void;
+
+    public initSubscription(): void;
+
+    public updateLayout(): void;
+
+    public updateRowData(opt_rowIndex?: number): void;
+
+    public addHeaderSection(sectionName?: string): any;
+
+    public addFooterSection(sectionName?: string): any;
+
+    public setParent(elem: Element): void;
+
+    public insertBefore(elem: Element): void;
+
+    public getRelativePosition(obj: ElementWrapper|Element|Event|MouseEvent): any;
+
+    public getCoreGrid(): Core;
+
+    public initialize(gridOption?: Grid.GridOptions): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public insertColumn(columnOption: ColumnDefinition.Options|string, idx?: number): void;
+
+    public setColumns(columns: (any)[]): void;
+
+    public setFields(ary: (string)[]): void;
+
+    public removeColumn(colRef: Grid.ColumnReference): void;
+
+    public removeColumns(colRefs: (Grid.ColumnReference)[]): void;
+
+    public removeAllColumns(): void;
+
+    public moveColumn(fromColIndex: number|(number)[], toColIndex: number): boolean;
+
+    public hideColumn(colRef: Grid.ColumnReference, hidden?: boolean): void;
+
+    public hideColumns(colRefs: (Grid.ColumnReference)[], hidden?: boolean): void;
+
+    public showAllColumns(): void;
+
+    public addDataFields(fieldRef: string|(string)[], referrer?: string): boolean;
+
+    public removeDataFields(fieldRef: string|(string)[], referrer?: string): boolean;
+
+    public sortColumn(colRef: Grid.ColumnReference, opt_order?: string): void;
+
+    public setColumnName(colIndex: number, str: string): void;
+
+    public setColumnRenderer(colRef: Grid.ColumnReference, func?: ((...params: any[]) => any)): void;
+
+    public activateColumnRenderer(colRef: Grid.ColumnReference, id?: string, func?: ((...params: any[]) => any)): void;
+
+    public setColumnFormatter(colIndex: number, formatter?: any|((...params: any[]) => any)): void;
+
+    public setColumnSorter(colRef: Grid.ColumnReference, func?: ColumnDefinition.SortLogic): void;
+
+    public _initDuplicateRicData(rowDef: RowDefinition): void;
+
+    public insertRow(rowOption?: any, rowRef?: Grid.RowReference): any;
+
+    public insertRows(rowOptions: (any)[], rowRef?: Grid.RowReference, opt_fields?: (string)[]): void;
+
+    public addStaticDataRows(dataRows: any[], fields?: (string)[]): void;
+
+    public updateDataSet(records: (any)[], rowIdentifier: string): void;
+
+    public removeRow(rowRef: Grid.RowReference): RowDefinition;
+
+    public removeRows(rowRefs: (Grid.RowReference)[]): (RowDefinition)[];
+
+    public removeAllRows(): void;
+
+    public hideRow(rowRef: Grid.RowReference, hidden?: boolean): void;
+
+    public hideRows(rowRefs: Grid.RowReference | (Grid.RowReference)[], hidden?: boolean): void;
+
+    public showRows(rowRefs: Grid.RowReference | (Grid.RowReference)[], shown?: boolean): void;
+
+    public unhideAllRows(): void;
+
+    public hasHiddenRow(): boolean;
+
+    public setRic(rowRef: Grid.RowReference, str: string): void;
+
+    public setRowContent(rowRef: Grid.RowReference, str: string): void;
+
+    public toggleRowExpansion(rid: string|number, force?: boolean): void;
+
+    public setRics(ary: (string)[]): void;
+
+    public getRowCount(): number;
+
+    public getPageItemCount(): number;
+
+    public getDataRowCount(): number;
+
+    public getColumnCount(): number;
+
+    public getColumnDataType(colIndex: number): string;
+
+    public getColumnDefinition(colIndex: number): ColumnDefinition;
+
+    public getRowDefinition(rowRef: number|string): RowDefinition;
+
+    public getRowDefinitions(): (RowDefinition)[];
+
+    public getRowData(rowIndex: number): any;
+
+    public getMultipleRowData(obj?: any): (any)[];
+
+    public setRicData(ric: string, values: any): void;
+
+    public setRowData(rowRef: Grid.RowReference, values: any): void;
+
+    public getColumnIndex(colRef: Grid.ColumnReference): number;
+
+    public getColumnIndices(colRefs: (Grid.ColumnReference)[]): (number)[];
+
+    public getColumnId(colIndex: number): string;
+
+    public getColumnField(colIndex: number): string;
+
+    public getColumnFields(): (string)[];
+
+    public getAllFields(): (string)[];
+
+    public freezeColumn(opt_colIndex?: number, pinnedRightColumns?: number): void;
+
+    public updateColumnTitle(): void;
+
+    public isSorting(): boolean;
+
+    public getSortedColumnIndex(): number;
+
+    public getSortOrder(): string;
+
+    public clearSort(): void;
+
+    public getDataView(): DataView;
+
+    public setPage(pageIndex: number): boolean;
+
+    public setPageSize(size: number): void;
+
+    public getPageIndex(): number;
+
+    public getPageSize(): number;
+
+    public getPageCount(): number;
+
+    public toggleChain(rowRef: Grid.RowReference): void;
+
+    public focus(): void;
+
+    public requestRowRefresh(): void;
+
+    public logDT(opt_options?: any): void;
+
+    public logDV(opt_options?: any): void;
+
+}
+
+declare function borders(gridOptions?: any): any;
+
+export { Grid };
+export default Grid;