@refinitiv-ui/efx-grid 6.0.68 → 6.0.70

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

@@ -73,7 +73,6 @@ declare namespace Grid {
         contentRightPadding?: number|null,
         contentBottomPadding?: number|null,
         dataConflationRate?: number|null,
-        dataComposed?: ((...params: any[]) => any)|null,
         autoDateConversion?: boolean|null,
         textSelect?: boolean|null,
         lang?: string|null,
@@ -84,7 +83,11 @@ declare namespace Grid {
         timeSeriesExpansion?: boolean|null,
         childDataField?: string|null,
         topSection?: boolean|null,
-        sorting?: SortableTitlePlugin.Options|null
+        sorting?: SortableTitlePlugin.Options|null,
+        dataComposed?: ((...params: any[]) => any)|null,
+        beforeContentBinding?: ((...params: any[]) => any)|null,
+        firstRendered?: ((...params: any[]) => any)|null,
+        afterContentBinding?: ((...params: any[]) => any)|null
     };
 
     type RowReference = number|string|RowDefinition|null;

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

@@ -76,7 +76,6 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {number=} contentRightPadding=0 Padding that is added next to the right most column. The padding is still a part of scrollable content.
 * @property {number=} contentBottomPadding=0 Padding that is added below the last section. The padding is still a part of scrollable content.
 * @property {number=} dataConflationRate=0 set delay for data to avoid to much sorting operation when data changed
-* @property {Function=} dataComposed Handler for dataComposed event
 * @property {boolean=} autoDateConversion=false If enabled, date-time field with numeric value will be automatically converted to native date object.
 * @property {boolean=} textSelect=false If enabled, user can select content text by using mouse drag.
 * @property {string=} lang laguage for config localization date time, if null the default language is "en"
@@ -88,6 +87,10 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {string=} childDataField=CHILD_VALUES The given field will be used to store children's static data, such as row color assignment.
 * @property {boolean=} topSection=true If disabled, title section will not be rendered
 * @property {SortableTitlePlugin~Options=} sorting Options for sorting
+* @property {Function=} dataComposed Handler for dataComposed event
+* @property {Function=} beforeContentBinding Handler for beforeContentBinding event
+* @property {Function=} firstRendered Handler for firstRendered event
+* @property {Function=} afterContentBinding Handler for afterContentBinding event
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference
@@ -158,6 +161,16 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @description Trigger before content binding.
 */
 
+/** @event Grid#firstRendered
+* @property {Object} e Event of firstRendered
+* @description This event is triggered when the content is rendered for the first time.
+*/
+
+/** @event Grid#afterContentBinding
+* @property {Object} e Event of afterContentBinding
+* @description Trigger after content binding.
+*/
+
 /** @event Grid#beforeRowRemoved
 * @description Fired only when a row will be removed through Grid's API and before occurring of the actual removal
 */
@@ -312,7 +325,6 @@ var Grid = function(placeholder, config) {
 	t.updateColumnTitle = t.updateColumnTitle.bind(t);
 	t._populateTimeSeriesChildren = t._populateTimeSeriesChildren.bind(t);
 
-	t._onBeforeContentBinding = t._onBeforeContentBinding.bind(t);
 	t._onPostSectionDataBinding = t._onPostSectionDataBinding.bind(t);
 	t._asyncClearDataUpdates = t._asyncClearDataUpdates.bind(t);
 	t._clearDataUpdates = t._clearDataUpdates.bind(t);
@@ -405,9 +417,11 @@ var Grid = function(placeholder, config) {
 		t._grid.loadPlugin(t._stp, config);
 	}
 
-	t._grid.listen("beforeContentBinding", t._onBeforeContentBinding);
+	t._grid.listen("beforeContentBinding", t._dispatch.bind(t, "beforeContentBinding"));
 	t._grid.listen("preSectionRender", t._onColumnHeaderBinding);
 	t._grid.listen("postSectionDataBinding", t._onPostSectionDataBinding);
+	t._grid.listen("firstRendered", t._dispatch.bind(t, "firstRendered"));
+	t._grid.listen("afterContentBinding", t._dispatch.bind(t, "afterContentBinding"));
 
 	t._grid.enableRowHighlighting(true);
 
@@ -815,6 +829,7 @@ Grid.prototype.initialize = function(gridOption) {
 	var t = this; // For minimizing file size
 	t._initializing = true;
 	var grid = t._grid; // core grid
+	grid.resetInternalState();
 	gridOption = grid.normalizeConfig(gridOption);
 
 	var exts = gridOption["plugins"] || gridOption["extensions"];
@@ -921,10 +936,10 @@ Grid.prototype.initialize = function(gridOption) {
 		t.listen("rowExpansionBinding", rowExpansionBinding);
 	}
 
-	var dataComposedHandler = gridOption["dataComposed"];
-	if(typeof dataComposedHandler === "function") {
-		t.listen("dataComposed", dataComposedHandler);
-	}
+	this.addListener(gridOption, "dataComposed");
+	this.addListener(gridOption, "beforeContentBinding");
+	this.addListener(gridOption, "firstRendered");
+	this.addListener(gridOption, "afterContentBinding");
 
 	if(gridOption["autoDateConversion"]) {
 		t._autoDateConversion = true;
@@ -2580,7 +2595,6 @@ Grid.prototype.removeAllRows = function() {
 
 	// TODO: This logic should also be in the core grid
 	this._grid.getVScrollbar().setScrollTop(0);
-	this._grid.getHScrollbar().setScrollLeft(0);
 };
 /** WARNING: This does not remove data stored in the data cache
 * @private
@@ -3538,13 +3552,6 @@ Grid.prototype._mainSorter = function (rowDefA, rowDefB, order) {
 	return this._columnSorter(rowDefA, rowDefB, order);
 };
 
-/** @private
-* @param {Object} e
-*/
-Grid.prototype._onBeforeContentBinding = function(e) {
-	this._dispatch("beforeContentBinding", e);
-};
-
 /** @private
 * @param {Object} e
 */

package/lib/tr-grid-column-selection/es6/ColumnSelection.js

@@ -1392,6 +1392,38 @@ ColumnSelectionPlugin.prototype.dispatchSelectionChanged = function () {
     "grid": this._activeGrid
   });
 };
+/** @public
+* @description Select a specified column by a simulated mouse click input. This is for testing purpose.
+* @ignore
+* @param {number} colIndex
+* @param {Object=} mouseEvt
+*/
+
+
+ColumnSelectionPlugin.prototype.selectByMouse = function (colIndex, mouseEvt) {
+  if (!mouseEvt) {
+    mouseEvt = {};
+  }
+
+  mouseEvt.sectionType = "title";
+
+  var eventObj = this._mockMouseEvent(colIndex, 0, mouseEvt);
+
+  this._onClick(eventObj);
+};
+/** @public
+* @description Select a specified column by a keyboard input. This is for testing purpose.
+* @ignore
+* @param {number|string} keyCode Use key code number or "left" ,"right" or "tab" string
+* @param {Object=} keyboardEvt
+*/
+
+
+ColumnSelectionPlugin.prototype.selectByKey = function (keyCode, keyboardEvt) {
+  var eventObj = this._mockKeyboardEvent(keyCode, keyboardEvt);
+
+  this._onKeyDown(eventObj);
+};
 
 export default ColumnSelectionPlugin;
 export { ColumnSelectionPlugin, ColumnSelectionPlugin as ColumnSelection, ColumnSelectionPlugin as ColumnSelectionExtension };

package/lib/tr-grid-conditional-coloring/es6/ConditionalColoring.js

@@ -299,14 +299,23 @@ ConditionalColoringPlugin.prototype.config = function (options) {
 ConditionalColoringPlugin.prototype.getConfigObject = function (gridOptions) {
 	var obj = gridOptions || {};
 
+	var extOptions = obj["conditionalColoring"];
+	if(!extOptions) {
+		extOptions = obj["conditionalColoring"] = {};
+	}
+
 	if(this._predefinedColors != null) {
-		var extOptions = obj["conditionalColoring"];
-		if(!extOptions) {
-			extOptions = obj["conditionalColoring"] = {};
-		}
 		extOptions["predefinedColors"] = this._predefinedColors;
 	}
 
+	if(this._blinkingDuration !== 250) {
+		extOptions["blinkingDuration"] = this._blinkingDuration;
+	}
+
+	if(this._insertionBlinking !== false) {
+		extOptions["insertionBlinking"] = this._insertionBlinking;
+	}
+
 	var columns = obj.columns;
 	if (!columns) {
 		columns = obj.columns = [];

package/lib/tr-grid-printer/es6/CellWriter.d.ts

@@ -8,7 +8,7 @@ declare class CellWriter extends ElementWrapper {
 
     public getContent(): Node|null|null;
 
-    public setContent(content: any, opt_tooltip?: boolean): Element|null;
+    public setContent(content: any, opt_tooltip?: boolean|null): Element|null;
 
     public setTooltip(str: string): void;
 
@@ -20,7 +20,7 @@ declare class CellWriter extends ElementWrapper {
 
     public removeIcon(n: any): void;
 
-    public updateIcon(elem: Element): void;
+    public updateIcon(elem: Element|null): void;
 
     public unlisten(): void;
 
@@ -36,13 +36,13 @@ declare class CellWriter extends ElementWrapper {
 
     public enableClass(str: string, bool: boolean): void;
 
-    public insertFloatingIcon(elem: Element, order: number): void;
+    public insertFloatingIcon(elem: Element|null, order: number): void;
 
-    public removeFloatingIcon(elemRef: string|Element, order: number): void;
+    public removeFloatingIcon(elemRef: string|Element|null, order: number): void;
 
     public getSection(): null;
 
-    public cloak(elem: Element): void;
+    public cloak(elem: Element|null): void;
 
 }
 

package/lib/tr-grid-printer/es6/CellWriter.js

@@ -10,16 +10,16 @@ var CellWriter = function () {
 };
 Ext.inherits(CellWriter, ElementWrapper);
 
-/** @type
-* @private
+/** @private
+* @type {Element}
 */
 CellWriter.prototype._flexRow = null;
-/** @type
-* @private
+/** @private
+* @type {Element}
 */
 CellWriter.prototype._floatingPanel = null;
-/** @type
-* @private
+/** @private
+* @type {Element}
 */
 CellWriter.prototype._frontPanel = null;
 

package/lib/tr-grid-printer/es6/GridPrinter.d.ts

@@ -7,13 +7,13 @@ import { SectionWriter } from "./SectionWriter.js";
 
 declare namespace GridPrinter {
 
-    function setPrintOptions(options: GridPrinter.Options): void;
+    function setPrintOptions(options: GridPrinter.Options|null): void;
 
-    function observe(iFrameElement?: HTMLIFrameElement): void;
+    function observe(iFrameElement?: HTMLIFrameElement|null): void;
 
     function unobserve(): void;
 
-    function enableDebugMode(bool?: boolean): void;
+    function enableDebugMode(bool?: boolean|null): void;
 
     function getPreFlightInfo(grid: any, options?: any): any;
 
@@ -22,11 +22,12 @@ declare namespace GridPrinter {
     function print(grid: any): void;
 
     type Options = {
-        pageWidth?: number,
-        pageHeight?: number,
-        primaryColumn?: number
+        pageWidth?: number|null,
+        pageHeight?: number|null,
+        primaryColumn?: number|null
     };
 
 }
 
+export default GridPrinter;
 export { GridPrinter };

package/lib/tr-grid-printer/es6/GridPrinter.js

@@ -134,7 +134,7 @@ var _getCoreGrid = function (grid) {
 	return core;
 };
 
-/** @namespaces
+/** @namespace
 */
 var GridPrinter = {};
 /** @private
@@ -647,7 +647,7 @@ GridPrinter._applyCss = function () {
 };
 
 /** @public
-* @param {*} grid grid element, currently supports atlas-blotter, ef-grid, tr.CompositeGrid, rt.Grid and Core
+* @param {*} grid grid element, currently supports efx-grid, atlas-blotter, ef-grid, tr.CompositeGrid, rt.Grid and Core
 */
 GridPrinter.print = function (grid) {
 	var core = null;
@@ -771,4 +771,6 @@ GridPrinter._onAfterPrint = function (e) {
 GridPrinter.Options;
 
 
+
+export default GridPrinter;
 export { GridPrinter };

package/lib/tr-grid-printer/es6/PrintTrait.d.ts

@@ -9,7 +9,7 @@ declare class PrintTrait {
 
     public static calculateEnvironment(): any;
 
-    public observe(iframeElement?: HTMLIFrameElement): void;
+    public observe(iframeElement?: HTMLIFrameElement|null): void;
 
     public unobserve(): void;
 

package/lib/tr-grid-printer/es6/SectionWriter.d.ts

@@ -29,7 +29,7 @@ declare class SectionWriter extends ElementWrapper {
 
     public enableRowClass(rowIndex: number, className: string, enabled: boolean): void;
 
-    public stretchCell(colIndex: number, rowIndex: number, opt_stretching?: boolean, opt_noLeftStretching?: boolean): void;
+    public stretchCell(colIndex: number, rowIndex: number, opt_stretching?: boolean|null, opt_noLeftStretching?: boolean|null): void;
 
     public hasCellSpan(): boolean;
 

package/lib/tr-grid-row-dragging/es6/RowDragging.js

@@ -465,6 +465,7 @@ RowDraggingPlugin.prototype.getConfigObject = function (out_obj) {
 	if(!extOptions) {
 		extOptions = obj.rowDragging = {};
 	}
+	// TODO: should not assign the config object if it's a default value
 	extOptions.dragBox = this._dragBoxEnabled;
 	extOptions.mouseInput = this._mouseInput;
 	extOptions.autoScroll = this._autoScroll;
@@ -474,6 +475,70 @@ RowDraggingPlugin.prototype.getConfigObject = function (out_obj) {
 	return obj;
 };
 
+/** Drag start to simulate "dragStart" event for testing purpose
+* @ignore
+* @param {number} rowIndex
+* @param {*=} mouseEvt
+*/
+RowDraggingPlugin.prototype.dragStart = function (rowIndex, mouseEvt) {
+	// dragstart event
+	if(!mouseEvt) {
+		mouseEvt = {};
+	}
+	mouseEvt["type"] = "dragstart";
+	var core = this._hosts[0];
+	var cell = core ? core.getCell("content", 0, rowIndex) : null;
+	mouseEvt.target = cell ? cell.getElement() : null;
+	this._onMouseDown(mouseEvt);
+	this.startDrag(mouseEvt);
+};
+
+/** Move mouse to drag cell for testing purpose
+* @public
+* @ignore
+* @param {number} rowIndex
+* @param {*=} mouseEvt
+*/
+RowDraggingPlugin.prototype.dragMove = function (rowIndex, mouseEvt) {
+	// mousemove, touchmove event
+	if(!mouseEvt) {
+		mouseEvt = {};
+	}
+	mouseEvt["type"] = "mousemove";
+	mouseEvt["which"] = 1; // Simulation of mouse down and move
+	var core = this._hosts[0];
+	var cell = core ? core.getCell("content", 0, rowIndex) : null;
+	var cellRelativePosition = core.getRelativePosition(cell); // get relative position of cell only when dragging for calculate dragBox
+
+	mouseEvt.clientX = cellRelativePosition.x;
+	mouseEvt.pageY = cellRelativePosition.y;
+	mouseEvt.target = cell ? cell.getElement() : null;
+	mouseEvt.stopPropagation = function() {};
+	mouseEvt.preventDefault = function() {};
+	this._onMouseMove(mouseEvt);
+
+};
+
+/** Mouse up to end of drag for testing purpose
+* @public
+* @ignore
+* @param {number} rowIndex
+* @param {*=} mouseEvt
+*/
+RowDraggingPlugin.prototype.dragEnd = function (rowIndex, mouseEvt) {
+	// mouseup, touchend, touchcancel event
+	if(!mouseEvt) {
+		mouseEvt = {};
+	}
+	mouseEvt["type"] = "mouseup";
+	var core = this._hosts[0];
+	var cell = core ? core.getCell("content", 0, rowIndex) : null;
+	mouseEvt.target = cell ? cell.getElement() : null;
+	mouseEvt.stopPropagation = function() {};
+	mouseEvt.preventDefault = function() {};
+	this._onDragEnd(mouseEvt);
+};
+
 /** @public
 * @param {*=} startRef
 */

package/lib/tr-grid-row-filtering/es6/RowFiltering.d.ts

@@ -113,7 +113,7 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public getColumnFilterStates(): any[];
 
-    public getUniqueValues(field: string, formatter?: ((...params: any[]) => any)|null, fmtField?: string|null, rawDataAccessor?: ((...params: any[]) => any)|null, formattedDataAccessor?: ((...params: any[]) => any)|null): any;
+    public getUniqueValues(field: string, formatter?: ((...params: any[]) => any)|null, fmtField?: string|null, rawDataAccessor?: ((...params: any[]) => any)|null, formattedDataAccessor?: ((...params: any[]) => any)|null, filterFuncs?: ((...params: any[]) => any)|null, selectedItems?: any): any;
 
     public openDialog(colIndex: number, runtimeDialogOptions?: RowFilteringPlugin.FilterDialogOptions|null): void;
 
@@ -123,7 +123,7 @@ declare class RowFilteringPlugin extends GridPlugin {
 
 }
 
-declare function field(colIndex: number, exp: RowFilteringPlugin.Expression|null, ctx?: (any|string)|null): boolean;
+declare function colSettings(colIndex: number, exp: RowFilteringPlugin.Expression|null, ctx?: (any|string)|null): boolean;
 
 declare function crf(enabled?: boolean|null): void;