@refinitiv-ui/efx-grid 6.0.4 → 6.0.6

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
 */
@@ -167,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)
@@ -205,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
@@ -271,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/rt-grid/es6/StyleLoader.d.ts

@@ -9,7 +9,7 @@ declare class StyleLoader {
 
     public static readonly styles: string;
 
-    public static applyStyle(grid: Core): void;
+    public static applyStyle(grid: Core|null): void;
 
 }
 

package/lib/tr-grid-cell-selection/es6/CellSelection.d.ts

@@ -7,14 +7,14 @@ import { isIE, cloneObject, prepareTSVContent } from "../../tr-grid-util/es6/Uti
 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[]
+        mode?: string|null,
+        multipleSelection?: boolean|null,
+        autoDeselecting?: boolean|null,
+        tabToSelect?: boolean|null,
+        selectionChanged?: ((...params: any[]) => any)|null,
+        copy?: ((...params: any[]) => any)|null,
+        beforeMouseDown?: ((...params: any[]) => any)|null,
+        selectableSections?: any[]|null
     };
 
 }
@@ -41,7 +41,7 @@ declare class CellSelectionPlugin extends GridPlugin {
 
     public getLastSelectionBounds(opt_ret?: any): any;
 
-    public setSelectableSections(types?: (string|(string)[]|null)): void;
+    public setSelectableSections(types?: (string|(string)[]|null)|null): void;
 
     public selectSingleCell(anchor: any): void;
 
@@ -53,9 +53,9 @@ declare class CellSelectionPlugin extends GridPlugin {
 
     public getAnchorInfo(): any;
 
-    public getSelectedCells(): (any[])[];
+    public getSelectedCells(): (any[])[]|null;
 
-    public disableSelection(opt_disable?: boolean): void;
+    public disableSelection(opt_disable?: boolean|null): void;
 
     public setAutoDeselectingOnBlur(bool: boolean): void;
 

package/lib/tr-grid-cell-selection/es6/CellSelection.js

@@ -623,7 +623,6 @@ CellSelectionPlugin.prototype._setScrollInterval = function (dirVectors) {
 
     var scrollToTop = isYPositive ? currentScrollTop + cellWidth : currentScrollTop - cellWidth;
     var scrollToLeft = isXPositive ? currentScrollLeft + cellHeight : currentScrollLeft - cellHeight;
-    var addCount = 1;
 
     if (dirVectors.y !== 0) {
       // updates scroll position
@@ -649,7 +648,7 @@ CellSelectionPlugin.prototype._setScrollInterval = function (dirVectors) {
         var nextTopVal = vScrollView.firstFullRow + 2;
 
         if (!!(this._prevRect && this._prevRect.top < nextTopVal) && !isEndOfVerticalScroll) {
-          tgtRect.bottom = nextTopVal + addCount;
+          tgtRect.bottom = nextTopVal + 1;
         } else {
           if (isEndOfVerticalScroll) {
             tgtRect.top = 1;
@@ -666,47 +665,33 @@ CellSelectionPlugin.prototype._setScrollInterval = function (dirVectors) {
 
       var isEndOfHorizontalScroll = this._isEndOfHorizontalScroll();
 
-      var gridWidth = this._hosts[0].getWidth();
+      var hScrollbar = this._hosts[0].getHScrollbar();
 
-      var curColumnWidth = this._hosts[0].getColumnWidth(tgtRect.right + addCount);
+      var hTrackWidth = hScrollbar.getTrackSize();
 
       if (isXPositive) {
-        var leftColumnPosition = this._hosts[0].getColumnLeft(tgtRect.right + addCount);
+        var leftPinnedWidth = 0;
 
-        var rightColPos = this._hosts[0].getColumnLeft(tgtRect.right);
+        var leftPinnedCount = this._hosts[0].getPinnedLeftColumnCount();
 
-        var rightSps = this._hosts[0].getColumnRight(tgtRect.left + 2);
+        if (leftPinnedCount) {
+          leftPinnedWidth = this._hosts[0].getContentWidth() - hScrollbar.getContentWidth();
+        }
 
-        var rightPosition = gridWidth - curColumnWidth;
+        var nextRightColEndPos = this._hosts[0].getColumnRight(tgtRect.right) - leftPinnedWidth;
 
-        if (leftColumnPosition < rightPosition) {
-          do {
-            tgtRect.right += addCount;
-          } while (this._hosts[0].getColumnLeft(tgtRect.right + addCount) < rightPosition);
-        } else {
-          if (rightColPos - cellWidth - gridWidth > 0 && leftColumnPosition > rightColPos && rightSps < gridWidth) {
-            do {
-              tgtRect.left += addCount;
-            } while (this._hosts[0].getColumnLeft(tgtRect.right + addCount) > rightColPos);
-          } else if (isEndOfHorizontalScroll) {
-            tgtRect.right = this._hosts[0].getColumnCount();
-          }
+        if (nextRightColEndPos <= hTrackWidth) {
+          tgtRect.right += 1;
+        } else if (isEndOfHorizontalScroll) {
+          tgtRect.right = this._hosts[0].getColumnCount();
         }
       } else {
-        var rightColumnPosition = this._hosts[0].getColumnRight(tgtRect.left - addCount);
-
-        var leftColPos = this._hosts[0].getColumnRight(tgtRect.left);
+        var nextLeftColEndPos = this._hosts[0].getColumnLeft(tgtRect.left - 1);
 
-        var colPos = this._hosts[0].getColumnRight(tgtRect.right - 2);
-
-        if (rightColumnPosition - curColumnWidth > 0) {
-          tgtRect.left -= addCount;
-        } else {
-          if (leftColPos - cellWidth < 0 && rightColumnPosition < leftColPos && colPos > curColumnWidth * 2) {
-            tgtRect.right -= addCount;
-          } else if (isEndOfHorizontalScroll) {
-            tgtRect.left = 0;
-          }
+        if (nextLeftColEndPos >= 0) {
+          tgtRect.left -= 1;
+        } else if (isEndOfHorizontalScroll) {
+          tgtRect.left = 0;
         }
       }
     }
@@ -732,9 +717,9 @@ CellSelectionPlugin.prototype._isEndOfVerticalScroll = function () {
 
 
 CellSelectionPlugin.prototype._isEndOfHorizontalScroll = function () {
-  var getScrollTop = this._hosts[0].getScrollLeft();
+  var hScrollbar = this._hosts[0].getHScrollbar();
 
-  return getScrollTop === 0 || getScrollTop + this._hosts[0].getWidth() > this._hosts[0].getScrollWidth();
+  return hScrollbar.isEndOfHorizontalScroll() || this._hosts[0].getScrollLeft() == 0;
 };
 /** Fire when draging was end.
 * @private

package/lib/tr-grid-checkbox/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/tr-grid-checkbox/es6/Checkbox.js

@@ -846,6 +846,7 @@ CheckboxPlugin.prototype.getAllSelectedData = function (field) {
 
 /** Alias of {@link CheckboxPlugin#getAllSelectedData}
 * @public
+* @function
 * @param {string=} field="" When field is not provided, entire rowData is returned. If field is specified, field values will be returned. Use "ROW_ID" as the field for retrieving internal row ids.
 * @return {!Array} Returns selected rows
 */

package/lib/tr-grid-column-formatting/es6/ColumnFormatting.d.ts

@@ -5,48 +5,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?: any,
-        displayStyleTab?: ColumnFormattingPlugin.DisplayStyleOption,
+        displayStyleTab?: ColumnFormattingPlugin.DisplayStyleOption|null,
         colorTextTab?: any,
-        fieldDataType?: string
+        fieldDataType?: string|null
     };
 
     type ColumnOptions = {
-        fieldDataType?: string
+        fieldDataType?: string|null
     };
 
 }
@@ -59,7 +59,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;
 
@@ -67,7 +69,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;
 
@@ -77,7 +79,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/tr-grid-column-formatting/es6/ColumnFormatting.js

@@ -222,6 +222,7 @@ ColumnFormattingPlugin.prototype.getConfigObject = function (gridOptions) {
 };
 
 /** @public
+* @function
 * @param {number} colIndex
 * @return {string}
 */

package/lib/tr-grid-column-grouping/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;
 
 }