@refinitiv-ui/efx-grid 6.0.4 → 6.0.6

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

@@ -14,13 +14,33 @@ var _joinSubKeys = function(subA, subB) {
 var MockQuotes2 = function() {
 
 };
+/** @private
+* @type {*}
+*/
+MockQuotes2.prototype._lastSub = null;
+/** @private
+* @type {Object}
+*/
+MockQuotes2.prototype._configObj = null;
 
+/** @public
+* @param {Object=} options
+*/
+MockQuotes2.prototype.config = function(options) {
+	if(options) {
+		this._configObj = options;
+	}
+	if(this._lastSub && this._configObj) {
+		this._lastSub.config(this._configObj);
+	}
+};
 /** @public
 * @param {Object=} options
 * @return {MockSubscriptions}
 */
 MockQuotes2.prototype.create = function(options) {
-	return new MockSubscriptions(options);
+	this._lastSub = new MockSubscriptions(options || this._configObj);
+	return this._lastSub;
 };
 
 /** @public
@@ -30,30 +50,40 @@ MockQuotes2.prototype.isSkipHeaderSupported = function() {
 	return true;
 };
 
+/** @public
+* @param {number=} min
+* @param {number=} max
+*/
+MockQuotes2.prototype.setUpdateInterval = function(min, max) {
+	if(this._lastSub) {
+		this._lastSub.setUpdateInterval(min, max);
+	} else {
+		if(!this._configObj) {
+			this._configObj = {};
+		}
+		this._configObj.minInterval = min;
+		this._configObj.maxInterval = max;
+	}
+};
+/** @public
+* @param {number=} percent
+*/
+MockQuotes2.prototype.setPercentageDataUpdate = function(percent) {
+	if(this._lastSub) {
+		this._lastSub.setPercentageDataUpdate(percent);
+	} else {
+		if(!this._configObj) {
+			this._configObj = {};
+		}
+		this._configObj.percentageDataUpdate = percent;
+	}
+};
+
 
 /** @constructor
 * @param {Object=} options
 */
 var MockSubscriptions = function(options) {
-	if(options) {
-		if(typeof options.minInterval === "number") {
-			this._minInterval = options.minInterval;
-			if(this._minInterval > this._maxInterval) {
-				this._maxInterval = this._minInterval;
-			}
-		}
-
-		if(typeof options.maxInterval === "number") {
-			this._maxInterval = options.maxInterval;
-			if(this._minInterval > this._maxInterval) {
-				this._minInterval = this._maxInterval;
-			}
-		}
-
-		if(typeof options.percentageDataUpdate === "number") {
-			this._percentageDataUpdate = options.percentageDataUpdate / 100;
-		}
-	}
 	this._onSubscriptionResponse = this._onSubscriptionResponse.bind(this);
 
 	this._subMap = {};
@@ -61,21 +91,51 @@ var MockSubscriptions = function(options) {
 	this._fields = {};
 	this._events = {};
 	this._dataGen = new DataGenerator();
+
+	this.config(options);
 };
 
-/* @private
+/** @private
 * @type {number}
 */
 MockSubscriptions.prototype._minInterval = 750;
-/* @private
+/** @private
 * @type {number}
 */
 MockSubscriptions.prototype._maxInterval = 850;
-/* @private
-* @type {float}
+/** @private
+* @type {number}
 */
 MockSubscriptions.prototype._percentageDataUpdate = 0.1; // 10% by default
 
+/** @public
+* @param {Object=} options
+*/
+MockSubscriptions.prototype.config = function(options) {
+	if(!options) {
+		return;
+	}
+	var num = options.minInterval;
+	if(typeof num === "number") {
+		this._minInterval = num;
+		if(this._minInterval > this._maxInterval) {
+			this._maxInterval = this._minInterval;
+		}
+	}
+
+	num = options.maxInterval;
+	if(typeof num === "number") {
+		this._maxInterval = num;
+		if(this._minInterval > this._maxInterval) {
+			this._minInterval = this._maxInterval;
+		}
+	}
+
+	num = options.percentageDataUpdate;
+	if(typeof num === "number") {
+		this._percentageDataUpdate = num / 100;
+	}
+};
 /** @public
 * @param {number=} min
 * @param {number=} max

package/lib/tr-grid-util/es6/jet/MockRTK.d.ts

@@ -1,8 +1,48 @@
-import { DataGrid, setInvalidFields } from "./mockDataAPI.js";
+import { DataGrid, Adc, setInvalidFields } from "./mockDataAPI.js";
 import { MockQuotes2 } from "./MockQuotes2.js";
 import { cloneObject } from "../Util.js";
 
-declare function init(opt_obj?: any): MockRTK|null;
+declare class MockRTKData {
+
+    constructor();
+
+    public static readonly DataGrid: any;
+
+    public static readonly Adc: any;
+
+    public static readonly Data: any;
+
+    public static request(payload: any): any;
+
+    public static request(payload: any): any;
+
+    public static setInvalidFields(payload: any): any;
+
+}
+
+declare class MockRTK {
+
+    constructor();
+
+    public static readonly DataGrid: any;
+
+    public static readonly Adc: any;
+
+    public static readonly Quotes: MockQuotes2|null;
+
+    public static readonly Data: any;
+
+    public static request(payload: any): any;
+
+    public static request(payload: any): any;
+
+    public static setInvalidFields(payload: any): any;
+
+    public static init(options?: any): MockRTK|null;
+
+    public static ready(options?: any): MockRTK|null;
+
+}
 
 export default MockRTK;
 export { MockRTK };

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

@@ -1,43 +1,82 @@
-import { DataGrid, setInvalidFields } from "./mockDataAPI.js";
+import { DataGrid, Adc, setInvalidFields } from "./mockDataAPI.js";
 import { MockQuotes2 } from "./MockQuotes2.js";
 import { cloneObject } from "../Util.js";
 
-var RTKDataGrid = cloneObject(DataGrid);
+/** @constructor */
+var MockRTKData = {};
 
+/** @type {Object}
+* @public
+*/
+MockRTKData.DataGrid = cloneObject(DataGrid);
 /** @public
 * @param {Object} payload
 * @return {*}
 */
-RTKDataGrid.request = function (payload) {
+MockRTKData.DataGrid.request = function (payload) {
 	var p = DataGrid.request(payload);
 	return p.then(function (res) {
 		return JSON.parse(res);
 	});
 };
 
-var MockRTK = {
-	Quotes: new MockQuotes2(),
-	Data: {
-		DataGrid: RTKDataGrid,
-		setInvalidFields: setInvalidFields
-	},
-	init: init,
-	ready: function () {
-		return this.init();
-	}
+/** @type {Object}
+* @public
+*/
+MockRTKData.Adc = cloneObject(Adc);
+/** @public
+* @param {Object} payload
+* @return {*}
+*/
+MockRTKData.Adc.request = function (payload) {
+	var p = Adc.request(payload);
+	return p.then(function (res) {
+		return JSON.parse(res);
+	});
 };
 
 /** @public
-* @param {Object=} opt_obj
+* @function
+* @param {Object} payload
+* @return {*}
+*/
+MockRTKData.setInvalidFields = setInvalidFields;
+
+
+/** @constructor */
+var MockRTK = {};
+
+/** @type {MockQuotes2}
+* @public
+*/
+MockRTK.Quotes = new MockQuotes2();
+/** @type {Object}
+* @public
+*/
+MockRTK.Data = MockRTKData;
+
+/** @public
+* @param {Object=} options
 * @return {MockRTK}
 */
-function init(opt_obj) {
+MockRTK.init = function (options) {
+	if(options) {
+		MockRTK.Quotes.config(options);
+	}
+
 	return new Promise(function (resolve, reject) {
 		setTimeout(function(){
 			resolve(MockRTK);
 		}, 300);
 	});
-}
+};
+/** @public
+* @param {Object=} options
+* @return {MockRTK}
+*/
+MockRTK.ready = function (options) {
+	return MockRTK.init(options);
+};
 
 export default MockRTK;
 export { MockRTK };

package/lib/tr-grid-util/es6/jet/mockDataAPI.d.ts

@@ -4,8 +4,8 @@ declare namespace DataGrid {
 
 }
 
-declare function setInvalidFields(fields: (string)[]|string): void;
+declare function setInvalidFields(fields: (string)[]|string|null): void;
 
 declare function mockDataAPI(dataType: string): Promise<any>|null;
 
-export { mockDataAPI, DataGrid, setInvalidFields };
+export { mockDataAPI, DataGrid, Adc, setInvalidFields };

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

@@ -31,6 +31,11 @@ var dataGen = new DataGenerator();
 */
 var DataGrid = {};
 
+/** @private
+* @namespace
+*/
+var Adc = {};
+
 /** @private
 * @function
 * @param {Object} payload
@@ -109,6 +114,97 @@ DataGrid.request = function (payload, mockResponse) {
 	}));
 };
 
+/** @private
+* @function
+* @param {Object} payload
+* @param {Object=} mockResponse
+* @return {Promise}
+*/
+Adc.request = function (payload, mockResponse) {
+	if (mockResponse) {
+		return Promise.resolve(JSON.stringify(mockResponse));
+	}
+
+	var i, f, len, row;
+	var identifiers = payload.identifiers;
+	var formula = payload.formula.split(",");
+	var 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;
+	for (i = 0; i < formula.length; i++) {
+		f = formula[i];
+		if (!invalidDict[f]) {
+			fields.push(f);
+		}
+	}
+
+	// build row header
+	var rows = [];
+	rows[0] = [{
+		"h": true,
+		"i": "instrument",
+		"v": "Instrument"
+	}];
+	for (i = 0; i < fields.length; i++) {
+		f = fields[i];
+		rows[0].push({
+			"h": true,
+			"r": f.toUpperCase()
+			// "v": "Price Close", // Doesn't use
+			// "p": "I_TRP_PH_PriceClose" // Doesn't use this property
+		});
+	}
+
+	// build data
+	var rowMap = {};
+
+	len = identifiers.length;
+	var rowData = dataGen.generate(fields, len);
+	for (i = 0; i < len; ++i) {
+		var inst = identifiers[i];
+		row = rowMap[inst];
+		if (!row) {
+			row = rowMap[inst] = rowData[i];
+			row.unshift(inst); // prepend instrument on each row
+		}
+		rows.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 (rows.length > 0) {
+		var chance = dataGen.randInt(1, 10);
+		if (chance <= 3) { // chance 30%
+			var pos = dataGen.randInt(0, rows.length - 1); // random row pos
+			row = rows[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
+			}
+			rows.splice(pos + 1, 0, mockupRow);
+		}
+	}
+
+	/*
+	response type is :
+	{
+		cols: number,
+		faults: Array<obj>,
+		rows: Array<obj>,
+		status: string
+	}
+	Currently, we use only the rows property for cache ADC data
+	*/
+	return Promise.resolve(JSON.stringify({
+		rows: rows
+		// TODO : supports faults property
+	}));
+};
+
 /** @public
 * @function
 * @param {string} dataType
@@ -117,6 +213,8 @@ DataGrid.request = function (payload, mockResponse) {
 var mockDataAPI = function (dataType) {
 	if (dataType === "datagrid") {
 		return Promise.resolve(DataGrid);
+	}  else if(dataType === "adc") {
+		return Promise.resolve(Adc);
 	} else {
 		return Promise.reject(dataType + " is not supported.");
 	}
@@ -128,4 +226,4 @@ var mockDataAPI = function (dataType) {
 */
 mockDataAPI.setInvalidFields = setInvalidFields;
 
-export { mockDataAPI, DataGrid, setInvalidFields };
+export { mockDataAPI, DataGrid, Adc, setInvalidFields };

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

@@ -6,25 +6,25 @@ import {injectCss, prettifyCss} 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,
-        topCheckboxHandler?: boolean
+        rowSelection?: boolean|null,
+        field?: string|null,
+        disablingField?: string|null,
+        checkboxCreated?: ((...params: any[]) => any)|null,
+        checkboxBinding?: ((...params: any[]) => any)|null,
+        clicked?: ((...params: any[]) => any)|null,
+        width?: number|null,
+        topCheckboxHandler?: boolean|null
     };
 
     type ColumnOptions = {
-        checkboxColumn?: boolean
+        checkboxColumn?: boolean|null
     };
 
 }
 
 declare class CheckboxPlugin extends GridPlugin {
 
-    constructor(options?: CheckboxPlugin.Options);
+    constructor(options?: CheckboxPlugin.Options|null);
 
     public getName(): string;
 
@@ -52,17 +52,19 @@ declare class CheckboxPlugin extends GridPlugin {
 
     public setAllCheckStates(checked: boolean): void;
 
-    public selectAllPages(checked?: boolean): void;
+    public selectAllPages(checked?: boolean|null): void;
 
-    public disableCheckbox(rowRef: number|string, disabled: boolean): void;
+    public disableCheckbox(rowRef: number|string|null, disabled: boolean): void;
 
-    public enableCheckbox(rowRef: number|string): void;
+    public enableCheckbox(rowRef: number|string|null): void;
 
-    public getAllCheckedIndices(sectionRef: any, state?: string): (number)[];
+    public getAllCheckedIndices(sectionRef: any, state?: string|null): (number)[];
 
-    public getFilteredSelectedData(field?: string): any[];
+    public getFilteredSelectedData(field?: string|null): any[];
 
-    public getAllSelectedData(field?: string): any[];
+    public getAllSelectedData(field?: string|null): any[];
+
+    public getSelectedRowData(field?: string|null): any[];
 
 }
 

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

@@ -6,48 +6,48 @@ import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
 declare namespace ColumnFormattingPlugin {
 
     type HeatmapOption = {
-        midPoint?: string,
-        mode?: string
+        midPoint?: string|null,
+        mode?: string|null
     };
 
     type ConditionalColorOption = {
-        conditions?: (any)[],
-        field?: string
+        conditions?: (any)[]|null,
+        field?: string|null
     };
 
     type BarOption = {
-        useMovementColor?: boolean,
-        showValues?: boolean,
-        alignment?: string,
-        field?: string,
-        textHidden?: boolean,
-        textWidth?: (number|string),
-        barColor?: string,
-        padding?: number,
-        percentageLabel?: boolean,
-        autoTextSizing?: boolean,
-        autoFitting?: boolean,
-        zeroValueHidden?: boolean
+        useMovementColor?: boolean|null,
+        showValues?: boolean|null,
+        alignment?: string|null,
+        field?: string|null,
+        textHidden?: boolean|null,
+        textWidth?: (number|string)|null,
+        barColor?: string|null,
+        padding?: number|null,
+        percentageLabel?: boolean|null,
+        autoTextSizing?: boolean|null,
+        autoFitting?: boolean|null,
+        zeroValueHidden?: boolean|null
     };
 
     type DisplayStyleOption = {
-        alignment?: string,
-        mode?: string,
-        bar?: ColumnFormattingPlugin.BarOption,
-        conditionalColor?: ColumnFormattingPlugin.ConditionalColorOption,
-        heatmap?: ColumnFormattingPlugin.HeatmapOption,
+        alignment?: string|null,
+        mode?: string|null,
+        bar?: ColumnFormattingPlugin.BarOption|null,
+        conditionalColor?: ColumnFormattingPlugin.ConditionalColorOption|null,
+        heatmap?: ColumnFormattingPlugin.HeatmapOption|null,
         general?: any
     };
 
     type ColumnFormatOptions = {
         valueFormatTab?: TextFormatting.FormatOptions,
-        displayStyleTab?: ColumnFormattingPlugin.DisplayStyleOption,
+        displayStyleTab?: ColumnFormattingPlugin.DisplayStyleOption|null,
         colorTextTab?: any,
-        fieldDataType?: string
+        fieldDataType?: string|null
     };
 
     type ColumnOptions = {
-        fieldDataType?: string
+        fieldDataType?: string|null
     };
 
 }
@@ -60,7 +60,9 @@ declare class ColumnFormattingPlugin extends GridPlugin {
 
     public getConfigObject(gridOptions?: any): any;
 
-    public getFieldList(): (string)[];
+    public getField(colIndex: number): string;
+
+    public getFieldList(): (string)[]|null;
 
     public getColumnCount(): number;
 
@@ -68,7 +70,7 @@ declare class ColumnFormattingPlugin extends GridPlugin {
 
     public getColumnFormatOptions(colIndex: number): ColumnFormattingPlugin.ColumnFormatOptions;
 
-    public setColumnFormatOptions(colIndex: number, options?: ColumnFormattingPlugin.ColumnFormatOptions): void;
+    public setColumnFormatOptions(colIndex: number, options?: ColumnFormattingPlugin.ColumnFormatOptions|null): void;
 
     public setColumnAlignment(colIndex: number, align: string): void;
 
@@ -78,7 +80,7 @@ declare class ColumnFormattingPlugin extends GridPlugin {
 
     public isColumnHidden(colIndex: number): boolean;
 
-    public hideColumn(colIndex: number, opt_bool?: boolean): void;
+    public hideColumn(colIndex: number, opt_bool?: boolean|null): void;
 
     public showAllColumns(): void;
 

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

@@ -4,24 +4,24 @@ import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 
 declare namespace ColumnGroupingPlugin {
 
-    type Options = (ColumnGroupingPlugin.GroupDefinition)[];
+    type Options = (ColumnGroupingPlugin.GroupDefinition)[]|null;
 
-    type GroupDefinitions = (ColumnGroupingPlugin.GroupDefinition)[];
+    type GroupDefinitions = (ColumnGroupingPlugin.GroupDefinition)[]|null;
 
     type GroupDefinition = {
         id: string,
         name: string,
-        tooltip?: (boolean|string),
-        children: (string)[],
-        alignment?: string,
-        render?: ((...params: any[]) => any)
+        tooltip?: (boolean|string)|null,
+        children: (string)[]|null,
+        alignment?: string|null,
+        render?: ((...params: any[]) => any)|null
     };
 
 }
 
 declare class ColumnGroupingPlugin extends GridPlugin {
 
-    constructor(options?: ColumnGroupingPlugin.Options);
+    constructor(options?: ColumnGroupingPlugin.Options|null);
 
     public beforeProcessOption(optionName: string, optionValue: any): any;
 
@@ -37,23 +37,37 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public addColumnToGroup(column: any, groupId: string, colIndex: number): void;
 
-    public addGroup(groupDef: ColumnGroupingPlugin.GroupDefinition): boolean;
+    public addGroup(groupDef: ColumnGroupingPlugin.GroupDefinition|null): boolean;
 
-    public addColumnGrouping(groupDef: ColumnGroupingPlugin.GroupDefinition): void;
+    public addColumnGrouping(groupDef: ColumnGroupingPlugin.GroupDefinition|null): void;
 
     public removeGroup(groupId: string): any;
 
-    public setGroupDefinitions(groupDefs: ColumnGroupingPlugin.GroupDefinitions): void;
+    public setGroupDefinitions(groupDefs: ColumnGroupingPlugin.GroupDefinitions|null): void;
 
     public getGroupDefinitions(): ColumnGroupingPlugin.GroupDefinitions;
 
-    public setGroupDefinition(groupId: string, newDef: ColumnGroupingPlugin.GroupDefinition): void;
+    public setGroupDefinition(groupId: string, newDef: ColumnGroupingPlugin.GroupDefinition|null): void;
 
-    public getGroupDefinition(groupId: number): ColumnGroupingPlugin.GroupDefinition;
+    public getGroupDefinition(groupId: string): ColumnGroupingPlugin.GroupDefinition|null;
 
-    public setGroupChildren(groupId: string, newChildList: (string)[]): void;
+    public setGroupChildren(groupId: string, newChildList: (string)[]|null): void;
 
-    public getGroupChildren(groupId: number): ColumnGroupingPlugin.GroupDefinition;
+    public getGroupChildren(groupId: string): (string)[]|null;
+
+    public getChildColumnIndices(groupId: string): (number)[]|null;
+
+    public getGroupIds(colRef: string|number|null): (string)[]|null;
+
+    public getMaxGroupLevel(): number;
+
+    public getGroupLevel(groupId: string): number;
+
+    public getCellInfo(e: Element|Event|MouseEvent|null): any;
+
+    public moveColumnIntoGroup(from: number|string|null, to: number, groupId: string): void;
+
+    public setColumnParent(columnIndex: number|string|null, groupId: string): void;
 
 }
 

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

@@ -50,11 +50,11 @@ declare class ColumnResizingPlugin extends GridPlugin {
 
     public setAllColumnWidths(colWidth: number, scalability?: boolean): boolean;
 
-    public getColumnWidths(): (number)[];
+    public getColumnWidths(): (number)[]|null;
 
     public resetAllColumnsToDefaultWidth(): boolean;
 
-    public getColumnSizeStates(): (any)[];
+    public getColumnSizeStates(): (any)[]|null;
 
     public setColumnSizeStates(columns: (any)[]|string): void;