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

package/lib/tr-grid-util/es6/jet/mockDataAPI.js

@@ -0,0 +1,131 @@
+import { DataGenerator } from "./DataGenerator.js";
+
+/**
+* @private
+* @type {object}
+*/
+var _invalidFieldDict = {
+	'TR.NonExistField': true,
+	'TR.NotExistField': true,
+	'CF_IGNORE_FIELD': true
+};
+
+/** to mock invalid fields.
+* @public
+* @param {Array<string>|string} fields ex. TR.NonExistField, CF_IGNORE_FIELD
+*/
+function setInvalidFields(fields) {
+	if (fields && typeof fields === 'string') {
+		_invalidFieldDict[fields] = true;
+	} else if (Array.isArray(fields)) {
+		for (var i = 0; i < fields.length; i++) {
+			_invalidFieldDict[fields[i]] = true;
+		}
+	}
+}
+
+var dataGen = new DataGenerator();
+
+/** @private
+* @namespace
+*/
+var DataGrid = {};
+
+/** @private
+* @function
+* @param {Object} payload
+* @param {Object=} mockResponse
+* @return {Promise}
+*/
+DataGrid.request = function (payload, mockResponse) {
+	if (mockResponse) {
+		return Promise.resolve(JSON.stringify(mockResponse));
+	}
+
+	var i, f, len, row;
+	var instruments = payload.instruments;
+	var fields = payload.fields;
+
+	// _invalidFieldDict is a dictionary of non exist field
+	// so we must remove invalid field to make "mocking api" return result more like a "real api".
+	var invalidDict = _invalidFieldDict;
+	fields = [];
+	for (i = 0; i < payload.fields.length; i++) {
+		f = payload.fields[i];
+		if (!invalidDict[f.name]) {
+			fields.push(f);
+		}
+	}
+
+	// for filter duplicate instrument
+	var rowMap = {};
+
+	// build data
+	len = instruments.length;
+	var data2D = [];
+	var rowData = dataGen.generate(fields, len);
+	for (i = 0; i < len; ++i) {
+		var inst = instruments[i];
+		row = rowMap[inst];
+		if (!row) {
+			row = rowMap[inst] = rowData[i];
+			row.unshift(inst); // prepend instrument on each row
+		}
+		data2D.push(row);
+	}
+
+	// There is a chance that rtk will return multiple row data per instrument
+	// so we must create mock up for this case
+	if (data2D.length > 0) {
+		var chance = dataGen.randInt(1, 10);
+		if (chance <= 3) { // chance 30%
+			var pos = dataGen.randInt(0, data2D.length - 1); // random row pos
+			row = data2D[pos];
+			len = row.length;
+			var mockupRow = new Array(len);
+			mockupRow[0] = row[0]; // 1st index is for instrument
+			for (i = 1; i < len; i++) {
+				mockupRow[i] = ''; // real case will return null or empty string
+			}
+			data2D.splice(pos + 1, 0, mockupRow);
+		}
+	}
+
+	// build header
+	var headers = [{
+		"displayName": "Instrument"
+	}];
+	for (i = 0; i < fields.length; i++) {
+		f = fields[i];
+		headers.push({
+			"displayName": f.name,
+			"field": f.name.toUpperCase() // server only return in uppercase
+		});
+	}
+
+	return Promise.resolve(JSON.stringify({
+		data: data2D,
+		headers: [headers]
+	}));
+};
+
+/** @public
+* @function
+* @param {string} dataType
+* @return {Promise}
+*/
+var mockDataAPI = function (dataType) {
+	if (dataType === "datagrid") {
+		return Promise.resolve(DataGrid);
+	} else {
+		return Promise.reject(dataType + " is not supported.");
+	}
+};
+
+/** to mock invalid fields.
+* @public
+* @param {Array<string>} fields ex. TR.NonExistField, CF_IGNORE_FIELD
+*/
+mockDataAPI.setInvalidFields = setInvalidFields;
+
+export { mockDataAPI, DataGrid, setInvalidFields };

package/lib/tr-grid-util/es6/locale/translation-de.d.ts

@@ -0,0 +1,7 @@
+
+
+declare namespace translationDe {
+
+}
+
+export default translationDe;

package/lib/tr-grid-util/es6/locale/translation-de.js

@@ -0,0 +1,51 @@
+/**
+* @namespace
+*/
+var translationDe = {
+	"sun": "So",
+	"mon": "Mo",
+	"tue": "Di",
+	"wed": "Mi",
+	"thu": "Do",
+	"fri": "Fr",
+	"sat": "Sa",
+	"Sunday": "Sonntag",
+	"Monday": "Montag",
+	"Tuesday": "Dienstag",
+	"Wednesday": "Mittwoch",
+	"Thursday": "Donnerstag",
+	"Friday": "Freitag",
+	"Saturday": "Samstag",
+
+	"jan": "Jan",
+	"feb": "Feb",
+	"mar": "Mrz",
+	"apr": "Apr",
+	"may": "Mai",
+	"jun": "Jun",
+	"jul": "Jul",
+	"aug": "Aug",
+	"sep": "Sep",
+	"oct": "Okt",
+	"nov": "Nov",
+	"dec": "Dez",
+	"January": "Januar",
+	"February": "Februar",
+	"March": "März",
+	"April": "April",
+	"May": "Mai",
+	"June": "Juni",
+	"July": "Juli",
+	"August": "August",
+	"September": "September",
+	"October": "Oktober",
+	"November": "November",
+	"December": "Dezember",
+
+	"am": "am",
+	"AM": "AM",
+	"pm": "pm",
+	"PM": "PM"
+};
+
+export default translationDe;

package/lib/tr-grid-util/es6/locale/translation-en.d.ts

@@ -0,0 +1,7 @@
+
+
+declare namespace translationEn {
+
+}
+
+export default translationEn;

package/lib/tr-grid-util/es6/locale/translation-en.js

@@ -0,0 +1,51 @@
+/**
+* @namespace
+*/
+var translationEn = {
+	"sun": "Sun",
+	"mon": "Mon",
+	"tue": "Tue",
+	"wed": "Wed",
+	"thu": "Thu",
+	"fri": "Fri",
+	"sat": "Sat",
+	"Sunday": "Sunday",
+	"Monday": "Monday",
+	"Tuesday": "Tuesday",
+	"Wednesday": "Wednesday",
+	"Thursday": "Thursday",
+	"Friday": "Friday",
+	"Saturday": "Saturday",
+
+	"jan": "Jan",
+	"feb": "Feb",
+	"mar": "Mar",
+	"apr": "Apr",
+	"may": "May",
+	"jun": "Jun",
+	"jul": "Jul",
+	"aug": "Aug",
+	"sep": "Sep",
+	"oct": "Oct",
+	"nov": "Nov",
+	"dec": "Dec",
+	"January": "January",
+	"February": "February",
+	"March": "March",
+	"April": "April",
+	"May": "May",
+	"June": "June",
+	"July": "July",
+	"August": "August",
+	"September": "September",
+	"October": "October",
+	"November": "November",
+	"December": "December",
+
+	"am": "am",
+	"AM": "AM",
+	"pm": "pm",
+	"PM": "PM"
+};
+
+export default translationEn;

package/lib/tr-grid-util/es6/locale/translation-ja.d.ts

@@ -0,0 +1,7 @@
+
+
+declare namespace translationJa {
+
+}
+
+export default translationJa;

package/lib/tr-grid-util/es6/locale/translation-ja.js

@@ -0,0 +1,51 @@
+/**
+* @namespace
+*/
+var translationJa = {
+	'sun': '日',
+	'mon': '月',
+	'tue': '火',
+	'wed': '水',
+	'thu': '木',
+	'fri': '金',
+	'sat': '土',
+	'Sunday': '日曜日',
+	'Monday': '月曜日',
+	'Tuesday': '火曜日',
+	'Wednesday': '水曜日',
+	'Thursday': '木曜日',
+	'Friday': '金曜日',
+	'Saturday': '土曜日',
+
+	'jan': '1月',
+	'feb': '2月',
+	'mar': '3月',
+	'apr': '4月',
+	'may': '5月',
+	'jun': '6月',
+	'jul': '7月',
+	'aug': '8月',
+	'sep': '9月',
+	'oct': '10月',
+	'nov': '11月',
+	'dec': '12月',
+	'January': '1月',
+	'February': '2月',
+	'March': '3月',
+	'April': '4月',
+	'May': '5月',
+	'June': '6月',
+	'July': '7月',
+	'August': '8月',
+	'September': '9月',
+	'October': '10月',
+	'November': '11月',
+	'December': '12月',
+
+	'am': '午前',
+	'AM': '午前',
+	'pm': '午後',
+	'PM': '午後'
+};
+
+export default translationJa;

package/lib/tr-grid-util/es6/locale/translation-zh-hant.d.ts

@@ -0,0 +1,7 @@
+
+
+declare namespace translationZhHant {
+
+}
+
+export default translationZhHant;

package/lib/tr-grid-util/es6/locale/translation-zh-hant.js

@@ -0,0 +1,51 @@
+/**
+* @namespace
+*/
+var translationZhHant = {
+	'sun': '週日',
+	'mon': '週一',
+	'tue': '週二',
+	'wed': '週三',
+	'thu': '週四',
+	'fri': '週五',
+	'sat': '週六',
+	'Sunday': '星期日',
+	'Monday': '星期一',
+	'Tuesday': '星期二',
+	'Wednesday': '星期三',
+	'Thursday': '星期四',
+	'Friday': '星期五',
+	'Saturday': '星期六',
+
+	'jan': '1月',
+	'feb': '2月',
+	'mar': '3月',
+	'apr': '4月',
+	'may': '5月',
+	'jun': '6月',
+	'jul': '7月',
+	'aug': '8月',
+	'sep': '9月',
+	'oct': '10月',
+	'nov': '11月',
+	'dec': '12月',
+	'January': '一月',
+	'February': '二月',
+	'March': '三月',
+	'April': '四月',
+	'May': '五月',
+	'June': '六月',
+	'July': '七月',
+	'August': '八月',
+	'September': '九月',
+	'October': '十月',
+	'November': '十一月',
+	'December': '十二月',
+
+	'am': '上午',
+	'AM': '上午',
+	'pm': '下午',
+	'PM': '下午'
+};
+
+export default translationZhHant;

package/lib/tr-grid-util/es6/locale/translation-zh.d.ts

@@ -0,0 +1,7 @@
+
+
+declare namespace translationZh {
+
+}
+
+export default translationZh;

package/lib/tr-grid-util/es6/locale/translation-zh.js

@@ -0,0 +1,51 @@
+/**
+* @namespace
+*/
+var translationZh = {
+	'sun': '周日',
+	'mon': '周一',
+	'tue': '周二',
+	'wed': '周三',
+	'thu': '周四',
+	'fri': '周五',
+	'sat': '周六',
+	'Sunday': '星期日',
+	'Monday': '星期一',
+	'Tuesday': '星期二',
+	'Wednesday': '星期三',
+	'Thursday': '星期四',
+	'Friday': '星期五',
+	'Saturday': '星期六',
+
+	'jan': '1月',
+	'feb': '2月',
+	'mar': '3月',
+	'apr': '4月',
+	'may': '5月',
+	'jun': '6月',
+	'jul': '7月',
+	'aug': '8月',
+	'sep': '9月',
+	'oct': '10月',
+	'nov': '11月',
+	'dec': '12月',
+	'January': '一月',
+	'February': '二月',
+	'March': '三月',
+	'April': '四月',
+	'May': '五月',
+	'June': '六月',
+	'July': '七月',
+	'August': '八月',
+	'September': '九月',
+	'October': '十月',
+	'November': '十一月',
+	'December': '十二月',
+
+	'am': '上午',
+	'AM': '上午',
+	'pm': '下午',
+	'PM': '下午'
+};
+
+export default translationZh;

package/lib/tr-grid-util/es6/locale/translation.d.ts

@@ -0,0 +1,11 @@
+import translationEn from "./translation-en.js";
+import translationDe from "./translation-de.js";
+import translationJa from "./translation-ja.js";
+import translationZh from "./translation-zh.js";
+import translationZhHant from "./translation-zh-hant.js";
+
+declare namespace translation {
+
+}
+
+export default translation;

package/lib/tr-grid-util/es6/locale/translation.js

@@ -0,0 +1,18 @@
+import translationEn from "./translation-en.js";
+import translationDe from "./translation-de.js";
+import translationJa from "./translation-ja.js";
+import translationZh from "./translation-zh.js";
+import translationZhHant from "./translation-zh-hant.js";
+
+/**
+* @namespace
+*/
+var translation = {
+	"en": translationEn,
+	"de": translationDe,
+	"ja": translationJa,
+	"zh": translationZh,
+	"zh-Hant": translationZhHant
+};
+
+export default translation;

package/lib/types/es6/AutoTooltip.d.ts

@@ -0,0 +1,45 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+
+declare namespace AutoTooltipPlugin {
+
+    type Options = {
+        header?: boolean,
+        title?: boolean,
+        footer?: boolean,
+        content?: boolean,
+        quickMode?: boolean
+    };
+
+    type ColumnOptions = {
+        autoTooltip?: boolean
+    };
+
+}
+
+declare class AutoTooltipPlugin extends GridPlugin {
+
+    constructor(options?: AutoTooltipPlugin.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 applyTooltip(colIndex: number, fromR?: number, toR?: number): void;
+
+    public applyTooltipToColumns(colIndices?: (number)[]): void;
+
+    public applyTooltipToAllColumns(): void;
+
+    public requestTooltipUpdate(): void;
+
+}
+
+export default AutoTooltipPlugin;
+export { AutoTooltipPlugin, AutoTooltipPlugin as AutoTooltip, AutoTooltipPlugin as AutoTooltipExtension };

package/lib/types/es6/CellSelection.d.ts

@@ -0,0 +1,67 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { MouseDownTrait } from "../../tr-grid-util/es6/MouseDownTrait.js";
+import { EventDispatcher } from "../../tr-grid-util/es6/EventDispatcher.js";
+import { isIE, cloneObject, prepareTSVContent } from "../../tr-grid-util/es6/Util.js";
+
+declare namespace CellSelectionPlugin {
+
+    type Options = {
+        mode?: string,
+        multipleSelection?: boolean,
+        autoDeselecting?: boolean,
+        tabToSelect?: boolean,
+        selectionChanged?: ((...params: any[]) => any),
+        copy?: ((...params: any[]) => any),
+        beforeMouseDown?: ((...params: any[]) => any),
+        selectableSections?: any[]
+    };
+
+}
+
+declare class CellSelectionPlugin extends GridPlugin {
+
+    constructor(options?: any);
+
+    public hasMultiTableSupport(): boolean;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public getSelectedText(): string;
+
+    public selectAll(): void;
+
+    public deselectAll(): boolean;
+
+    public getSelectionCount(): number;
+
+    public getSelectionBounds(opt_ret?: any): any;
+
+    public getLastSelectionBounds(opt_ret?: any): any;
+
+    public setSelectableSections(types?: (string|(string)[]|null)): void;
+
+    public selectSingleCell(anchor: any): void;
+
+    public selectCells(rect: any): void;
+
+    public selectNextCell(): boolean;
+
+    public selectPrevCell(): boolean;
+
+    public getAnchorInfo(): any;
+
+    public getSelectedCells(): (any)[];
+
+    public disableSelection(opt_disable?: boolean): void;
+
+    public setAutoDeselectingOnBlur(bool: boolean): void;
+
+    public getAutoDeselectingOnBlur(): boolean;
+
+}
+
+export default CellSelectionPlugin;
+export { CellSelectionPlugin, CellSelectionPlugin as CellSelection, CellSelectionPlugin as CellSelectionExtension };

package/lib/types/es6/Checkbox.d.ts

@@ -0,0 +1,69 @@
+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";
+
+declare namespace CheckboxPlugin {
+
+    type Options = {
+        rowSelection?: boolean,
+        field?: string,
+        disablingField?: string,
+        checkboxCreated?: ((...params: any[]) => any),
+        checkboxBinding?: ((...params: any[]) => any),
+        clicked?: ((...params: any[]) => any),
+        width?: number
+    };
+
+    type ColumnOptions = {
+        checkboxColumn?: boolean
+    };
+
+}
+
+declare class CheckboxPlugin extends GridPlugin {
+
+    constructor(options?: CheckboxPlugin.Options);
+
+    public getName(): string;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host: any): void;
+
+    public beforeProcessOption(optionName: string, optionVal: any): any;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public getCheckboxColumnIndex(): number;
+
+    public getDisplayColumn(): number;
+
+    public getCheckbox(sectionRef: any, rowIndex: number): Element;
+
+    public selectAll(): void;
+
+    public deselectAll(check: boolean): void;
+
+    public checkAll(checked: boolean): void;
+
+    public setAllCheckStates(checked: boolean): void;
+
+    public disableCheckbox(rowRef: number|string, disabled: boolean): void;
+
+    public enableCheckbox(rowRef: number|string): void;
+
+    public getAllCheckedIndices(sectionRef: any, state?: string): (number)[];
+
+    public getFilteredSelectedData(field?: string): any[];
+
+    public getAllSelectedData(field?: string): any[];
+
+}
+
+declare function val(gridOptions?: any): any;
+
+export default CheckboxPlugin;
+export { CheckboxPlugin, CheckboxPlugin as Checkbox, CheckboxPlugin as CheckboxExtension };