@refinitiv-ui/efx-grid 6.0.66 → 6.0.68

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

@@ -8,7 +8,8 @@ import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
 /** @typedef {Object} ConditionalColoringPlugin~Options
 * @description The options can be specified by `conditionalColoring` property of the main grid's options
 * @property {Object=} predefinedColors Predefined color object map for conditional coloring
-* @property {number=} blinkingDuration=250 Blinking  duration in milliseconds
+* @property {number=} blinkingDuration=250 Blinking duration in milliseconds
+* @property {boolean=} insertionBlinking=false Blinking when a row is added to a grid
 */
 
 /** @typedef {Object} ConditionalColoringPlugin~ColumnOptions
@@ -149,6 +150,10 @@ ConditionalColoringPlugin.prototype._predefinedColors = null;
 * @private
 */
 ConditionalColoringPlugin.prototype._blinkingDuration = 250;
+/** @type {boolean}
+* @private
+*/
+ConditionalColoringPlugin.prototype._insertionBlinking = false;
 /** @type {string}
 * @private
 */
@@ -198,6 +203,10 @@ ConditionalColoringPlugin.prototype.initialize = function (host, options) {
 		if(blinkingDuration != null  && typeof blinkingDuration === "number"){
 			this._blinkingDuration = blinkingDuration;
 		}
+		var insertionBlinking = extOptions["insertionBlinking"];
+		if(insertionBlinking != null){
+			this._insertionBlinking = insertionBlinking;
+		}
 	}
 
 	if(hosts.length === 1) {
@@ -1075,6 +1084,14 @@ ConditionalColoringPlugin.prototype.setPredefinedColors = function(predefinedCol
 		}
 	}
 };
+/** @public
+* @param {boolean} blinking enable blinking on row insertion
+*/
+ConditionalColoringPlugin.prototype.setInsertionBlinking = function(blinking) {
+	if (blinking != null) {
+		this._insertionBlinking = blinking;
+	}
+};
 /** @private
 * @function
 * @return {!FilterBuilder}
@@ -1130,7 +1147,7 @@ ConditionalColoringPlugin.prototype._onSectionBinding = function (e) {
 		return; // dataRows could be empty in case of no column is presented
 	}
 
-	var c, r, cell, painter, changedCols, rowDef, rid, changedRow, changedRows;
+	var c, r, cell, painter, changedCols, rowDef, rid, changedRow, changedRows, allowBlinking, insertedRow;
 	var dataRow, insertedId, colData, blinking, bgBlinking, cachedValues, updatePrev;
 	var section = e["section"];
 	var colCount = section.getColumnCount();
@@ -1149,6 +1166,8 @@ ConditionalColoringPlugin.prototype._onSectionBinding = function (e) {
 	}
 
 	var prevDataRow, prevDataRows = host._prevDataRows;
+	var prevIds = Object.keys(prevDataRows);
+	var prevRowCount = prevIds.length;
 	for (r = fromR; r < toR; ++r) {
 		dataRow = this._rowGetter(dataRows[r]);
 		if (!dataRow) continue; // prevent from null value access when using with RowGroupingExtension
@@ -1159,14 +1178,18 @@ ConditionalColoringPlugin.prototype._onSectionBinding = function (e) {
 				// TODO: check rid from e.rids
 				rowDef = /** @type{RowDefinition} */(dataRow["ROW_DEF"]);
 				rid = rowDef ? rowDef.getRowId() : "";
-				if (rid && !insertedId[rid]) {
+				insertedRow = insertedId[rid];
+				allowBlinking = !insertedRow || this._insertionBlinking;
+				if (rid && allowBlinking) {
 					changedCols = rowDef.getUpdates();
 				}
 			} else { // composite grid
 				changedRow = changedRows[r];
 				if (changedRow) {
 					rid = changedRow.rid;
-					if (!insertedId[rid]) {
+					insertedRow = insertedId[rid];
+					allowBlinking = !insertedRow || this._insertionBlinking;
+					if (allowBlinking) {
 						changedCols = changedRow.changed;
 					}
 				}
@@ -1195,7 +1218,7 @@ ConditionalColoringPlugin.prototype._onSectionBinding = function (e) {
 				colData = this._getColumnData(c);
 				bgBlinking = false;
 				blinking = false;
-				if (colData["blinking"] && actualUpdate) { // blinking
+				if (colData["blinking"] && actualUpdate && allowBlinking) { // blinking
 					var field = colData["blinkingField"] || this._getField(c);
 					var newValue = dataRow[field];
 					if (prevDataRow) {
@@ -1206,6 +1229,11 @@ ConditionalColoringPlugin.prototype._onSectionBinding = function (e) {
 								bgBlinking = painter.blinkCell(cell, newValue, prevValue, dataRow, dataRow);
 							}
 						}
+					} else {
+						if(prevRowCount && insertedRow){
+							blinking = true;
+							bgBlinking = painter.blinkCell(cell, newValue, newValue, dataRow, dataRow);
+						}
 					}
 
 					if (!blinking) {

package/lib/tr-grid-contextmenu/es6/ContextMenu.d.ts

@@ -49,7 +49,8 @@ declare namespace ContextMenuPlugin {
     type OnMenuEvent = {
         cell: any,
         colIndex: number,
-        columnDef: object|null,
+        field: string,
+        colId: string,
         context: ContextMenuPlugin.Context|null,
         items: object|null,
         menu: MenuEventAPI|null,

package/lib/tr-grid-contextmenu/es6/ContextMenu.js

@@ -53,7 +53,8 @@ import CellPainter from "../../tr-grid-util/es6/CellPainter.js";
 /** @typedef {Object} ContextMenuPlugin~OnMenuEvent
 * @property {Object} cell Grid cell object at the mouse clicked position
 * @property {number} colIndex Index number of the column that the mouse clicked on
-* @property {object} columnDef Column Definition of the column that the mouse clicked on
+* @property {string} field Field of the column that the mouse clicked on
+* @property {string} colId Column ID of the column that the mouse clicked on
 * @property {ContextMenuPlugin~Context} context Area of the grid that the mouse clicked on
 * @property {object} items Object reference to the menu items under items option
 * @property {MenuEventAPI} menu API for adding menu items to be rendered
@@ -128,10 +129,6 @@ ContextMenuPlugin.prototype._rsp = null;
 * @private
 */
 ContextMenuPlugin.prototype._contextMenu = null;
-/** @type {Array}
-* @private
-*/
-ContextMenuPlugin.prototype._userColumns = null;
 
 /** @public
 * @return {string}
@@ -191,7 +188,6 @@ ContextMenuPlugin.prototype.config = function (options) {
 
 	var t = this;
 
-	t._userColumns = options["columns"];
 	var contextMenu = options["contextMenu"];
 
 	if (contextMenu == null) { return; }
@@ -237,11 +233,15 @@ ContextMenuPlugin.prototype.getMenuModel = function () {
 * @return {!Object} Mouse related information
 */
 ContextMenuPlugin.prototype._configureMouseInfo = function (e) {
-	var mouseInfo = this._hosts[0].getRelativePosition(e);
+	var host = this._hosts[0];
+	var mouseInfo = host.getRelativePosition(e);
 
 	// Supply possibly needed arguments for the event handler
 	mouseInfo.context = this._contextMap[mouseInfo.sectionType] || "";
-	mouseInfo.columnDef = this._userColumns[mouseInfo.colIndex];
+	var colIndex = mouseInfo.colIndex;
+	var columnDef = mouseInfo.columnDef = {};
+	mouseInfo.field = columnDef.field = this.getColumnField(colIndex);
+	mouseInfo.colId = columnDef.id = this.getColumnId(colIndex);
 
 	if (!this._csp) {
 		this._csp = this._getPlugin("ColumnSelectionPlugin");

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

@@ -35,6 +35,7 @@ declare namespace RowFilteringPlugin {
 
     type Options = {
         emptySegmentFiltering?: boolean|null,
+        separatorFiltering?: boolean|null,
         disabledUI?: boolean|null,
         iconActivation?: string|null,
         dialogOptions?: RowFilteringPlugin.FilterDialogOptions|null,
@@ -118,6 +119,8 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public enableEmptySegmentFiltering(enabled?: boolean|null): void;
 
+    public enableSeparatorFiltering(enabled?: boolean|null): void;
+
 }
 
 declare function field(colIndex: number, exp: RowFilteringPlugin.Expression|null, ctx?: (any|string)|null): boolean;

package/lib/tr-grid-row-filtering/es6/RowFiltering.js

@@ -87,7 +87,8 @@ The expression can take various forms:<br>
 
 /** @typedef {Object} RowFilteringPlugin~Options
 * @description The options can be specified by `rowFiltering` property of the main grid's options
-* @property {boolean=} emptySegmentFiltering=false If enabled, the filter will automatically hide empty segment when all of its member are filtered out. If there is no active filter, any empty segment will not be hidden. Collapsed segment does not count as having a filter.
+* @property {boolean=} emptySegmentFiltering=false If enabled, the filter will automatically hide empty segment when all of its member are filtered out. If there is no active filter, any empty segment will not be hidden. Collapsed segment does not count as having a filter. A segment with no child is treated the same way as an empty segment.
+* @property {boolean=} separatorFiltering=false If enabled, segment separators will be filtered as if they were normal rows. Note that even if a separator row is filtered out, its child row may remain in the view and not be filtered out.
 * @property {boolean=} disabledUI=false Deprecated in favor of `iconActivation`. Set iconActivation to none instead.
 * @property {string=} iconActivation=onActiveFilter Filter icon redering behavior, can be set to `always`,`onHover`,`onActiveFilter`,or `none`
 * @property {RowFilteringPlugin~FilterDialogOptions=} dialogOptions=null Default configuration for Filter Dialog, applying to all columns.
@@ -371,6 +372,11 @@ RowFilteringPlugin.prototype.config = function (options) {
       this.enableEmptySegmentFiltering(rowFiltering["emptySegmentFiltering"] ? true : false);
     }
 
+    if (rowFiltering["separatorFiltering"] != null) {
+      // TODO: there is a chance that there is no DataView during the configuration
+      this.enableSeparatorFiltering(rowFiltering["separatorFiltering"] ? true : false);
+    }
+
     if (rowFiltering["iconActivation"]) {
       this._iconActivation = rowFiltering["iconActivation"];
 
@@ -479,6 +485,7 @@ RowFilteringPlugin.prototype.getConfigObject = function (gridOptions) {
 
     dirty = true;
   } // TODO: get emptySegmentFiltering setting from DataView
+  // TODO: get separatorFiltering setting from DataView
 
 
   if (dirty) {
@@ -2137,7 +2144,7 @@ RowFilteringPlugin.prototype._onColumnRemoved = function (e) {
     this._requestFilterRefresh();
   }
 };
-/** the filter will automatically hide empty segment when all of its member are filtered out. If there is no active filter, any empty segment will not be hidden. Collapsed segment does not count as having a filter.
+/** the filter will automatically hide empty segment when all of its member are filtered out. If there is no active filter, any empty segment will not be hidden. Collapsed segment does not count as having a filter. A segment with no child is treated the same way as an empty segment.
 * @public
 * @param {boolean=} enabled=true
 */
@@ -2151,6 +2158,20 @@ RowFilteringPlugin.prototype.enableEmptySegmentFiltering = function (enabled) {
     dv.enableEmptySegmentFiltering(enabled);
   }
 };
+/** the filter will automatically hide empty segment when all of its member are filtered out. If there is no active filter, any empty segment will not be hidden. Collapsed segment does not count as having a filter.
+* @public
+* @param {boolean=} enabled=true
+*/
+
+
+RowFilteringPlugin.prototype.enableSeparatorFiltering = function (enabled) {
+  var host = this._hosts[0];
+  var dv = host ? host.getDataSource() : null;
+
+  if (dv && dv.enableSeparatorFiltering) {
+    dv.enableSeparatorFiltering(enabled);
+  }
+};
 
 export default RowFilteringPlugin;
 export { RowFilteringPlugin, RowFilteringPlugin as RowFiltering, RowFilteringPlugin as RowFilteringExtension };

package/lib/tr-grid-row-selection/es6/RowSelection.js

@@ -556,7 +556,7 @@ RowSelectionPlugin.prototype.selectAllRows = function (activeGrid) {
 	if (this._activeGrid) {
 		var sections = this._activeGrid.getAllSections("content");
 		for (var i = sections.length; --i >= 0;) {
-			this._selectRowRange(0, sections[i].getRowCount(), sections[i]);
+			this._selectRowRange(null, null, sections[i]);
 			if (i == 0) {
 				this._anchorSection = sections[i];
 			}
@@ -626,6 +626,23 @@ RowSelectionPlugin.prototype._onClick = function (e) {
 		}
 	}
 };
+/** @public
+* @description Select a specified row as if it were clicked by a mouse. This is for testing purpose.
+* @ignore
+* @param {number} rowIndex
+* @param {Object=} mouseEvt
+*/
+RowSelectionPlugin.prototype.selectByMouse = function (rowIndex, mouseEvt) {
+	if(!mouseEvt) {
+		mouseEvt = {};
+	}
+	if(rowIndex >= 0) {
+		var grid = this._activeGrid || this._hosts[0];
+		var cell = grid ? grid.getCell("content", 0, rowIndex) : null;
+		mouseEvt.target = cell ? cell.getElement() : null;
+	}
+	this._onMouseDown(mouseEvt);
+};
 /** @private
 * @description Left click will cause single row selection <br>
 * Shift + left click will cause range selection <br>
@@ -766,7 +783,29 @@ RowSelectionPlugin.prototype._clearPendingClickIndex = function (host) {
 	host && host.unlisten("mousemove", this._onMouseMove);
 };
 
-
+/** @public
+* @description Select a specified row as if it were modified by a keyboard input. This is for testing purpose.
+* @ignore
+* @param {number} keyCode Use -1 for arrow up. Use 1 for arrow down
+* @param {Object=} keyboardEvt
+*/
+RowSelectionPlugin.prototype.selectByKey = function (keyCode, keyboardEvt) {
+	if(!keyboardEvt) {
+		keyboardEvt = {};
+	}
+	if(keyCode) {
+		if(keyCode === 1) {
+			keyboardEvt.keyCode = 40;
+		} else if(keyCode === -1) {
+			keyboardEvt.keyCode = 38;
+		} else if(typeof keyCode === "number"){
+			keyboardEvt.keyCode = keyCode;
+		}
+	}
+	keyboardEvt.preventDefault = function(){};
+	keyboardEvt.stopPropagation = function(){};
+	this._onKeyDown(keyboardEvt);
+};
 /** @private
 * @param {KeyboardEvent} e
 */
@@ -1084,20 +1123,28 @@ RowSelectionPlugin.prototype._sectionSetSelectedRow = function (section, rowInde
 
 /** @private
 * @param {Object} section ILayoutGrid
-* @param {number} rowIndex
-* @param {number} length
+* @param {number|null} rowIndex
+* @param {number|null} length
 */
-RowSelectionPlugin.prototype._sectionSelectRowRange = function (section, rowIndex, length) {
-	// set selection state to rowData when _basedOnContent === true
-	if (this._basedOnContent) {
+RowSelectionPlugin.prototype._selectRangeOnSection = function (section, rowIndex, length) {
+	if(rowIndex == null) {
+		rowIndex = 0;
+	}
+	if (this._basedOnContent) { // TODO: handle the case where section is not content section
 		var dv = (this._activeGrid) ? this._activeGrid.getDataSource() : null;
 
 		if (dv) {
-			var toRowIndex = rowIndex + length - 1;
 			var rids = dv.getVisibleRowIds(true);
+			if(length == null) {
+				length = rids.length;
+			}
+			var toRowIndex = rowIndex + length;
+			if(toRowIndex > rids.length) {
+				toRowIndex = rids.length;
+			}
 			var ridList = [];
 			var valueList = [];
-			for (var r = rowIndex; r <= toRowIndex; r++) {
+			for (var r = rowIndex; r < toRowIndex; r++) {
 				var dataRow = this._getRow(dv, r);
 				if (dataRow) {
 					ridList.push(rids[r]);
@@ -1108,6 +1155,9 @@ RowSelectionPlugin.prototype._sectionSelectRowRange = function (section, rowInde
 			this._setColumnData(dv, this._selectionField, valueList, ridList);
 		}
 	} else {
+		if(length == null) {
+			length = section.getRowCount();
+		}
 		section.selectRowRange(rowIndex, length);
 	}
 };
@@ -1222,14 +1272,15 @@ RowSelectionPlugin.prototype._clearMenuIcon = function () {
 	}
 };
 /** @private
-* @param {number} rowIndex
-* @param {number} length
+* @param {number|null} rowIndex
+* @param {number|null} length
 * @param {Object=} sectRef Grid SectionReference
 */
 RowSelectionPlugin.prototype._selectRowRange = function (rowIndex, length, sectRef) {
 	var section = this._getSection(sectRef);
-	if (!section) { return; }
-	this._sectionSelectRowRange(section, rowIndex, length);
+	if (section) {
+		this._selectRangeOnSection(section, rowIndex, length);
+	}
 };
 
 /** @private
@@ -1251,7 +1302,7 @@ RowSelectionPlugin.prototype._selectFromAnchorToTarget = function (section, rowI
 				startingRow = rowIndex;
 			}
 
-			this._sectionSelectRowRange(section, startingRow, (selectionCount * direction) + 1);
+			this._selectRangeOnSection(section, startingRow, (selectionCount * direction) + 1);
 
 			if (!this._basedOnContent && this._anchorSection.setRowAnchor) {
 				//Make sure that the anchor stays at the same position
@@ -1260,20 +1311,6 @@ RowSelectionPlugin.prototype._selectFromAnchorToTarget = function (section, rowI
 		}
 	}
 };
-/** @private
-* @param {number} fromIndex
-* @param {number} toIndex
-*/
-RowSelectionPlugin.prototype._selectSectionRange = function (fromIndex, toIndex) {
-	if (!this._activeGrid) { return; }
-	for (var i = fromIndex; i <= toIndex; i++) {
-		var settings = this._activeGrid.getSectionSettings(i);
-		if (settings.getType() === "content") {
-			var section = settings.getSection();
-			this._sectionSelectRowRange(section, 0, section.getRowCount());
-		}
-	}
-};
 
 /** @private
 * @return {boolean}

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

@@ -9,7 +9,8 @@ declare namespace ConditionalColoringPlugin {
 
     type Options = {
         predefinedColors?: any,
-        blinkingDuration?: number|null
+        blinkingDuration?: number|null,
+        insertionBlinking?: boolean|null
     };
 
     type ColumnOptions = {
@@ -81,6 +82,8 @@ declare class ConditionalColoringPlugin extends GridPlugin {
 
     public setPredefinedColors(predefinedColors: any): void;
 
+    public setInsertionBlinking(blinking: boolean): void;
+
     public getColumnPainter(colIndex: number): CellPainter|null;
 
     public applyColor(colIndex: number, cell: any, rowData?: any): void;

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

@@ -49,7 +49,8 @@ declare namespace ContextMenuPlugin {
     type OnMenuEvent = {
         cell: any,
         colIndex: number,
-        columnDef: object|null,
+        field: string,
+        colId: string,
         context: ContextMenuPlugin.Context|null,
         items: object|null,
         menu: MenuEventAPI|null,

package/lib/types/es6/Core/data/DataView.d.ts

@@ -278,6 +278,8 @@ declare class DataView extends EventDispatcher {
 
     public enableEmptySegmentFiltering(enabled?: boolean|null): void;
 
+    public enableSeparatorFiltering(enabled?: boolean|null): void;
+
     public setSegmentClassification(segmentRef: string|number|null, fields: string|(string)[]|null): boolean;
 
     public getWrapSize(): number;

package/lib/types/es6/RealtimeGrid/SnapshotFiller.d.ts

@@ -8,8 +8,16 @@ declare class SnapshotFiller extends EventDispatcher {
 
     constructor();
 
+    public static readonly _mockAdc: any;
+
     public setRTK(rtk: any): void;
 
+    public static setMockAdc(str: string, value: any): void;
+
+    public static getMockAdc(str: string): any;
+
+    public static clearMockAdc(): void;
+
     public setADCOptions(adcOptions: Grid.ADCOptions|null): void;
 
     public addRic(ric: string): void;

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

@@ -35,6 +35,7 @@ declare namespace RowFilteringPlugin {
 
     type Options = {
         emptySegmentFiltering?: boolean|null,
+        separatorFiltering?: boolean|null,
         disabledUI?: boolean|null,
         iconActivation?: string|null,
         dialogOptions?: RowFilteringPlugin.FilterDialogOptions|null,
@@ -118,6 +119,8 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public enableEmptySegmentFiltering(enabled?: boolean|null): void;
 
+    public enableSeparatorFiltering(enabled?: boolean|null): void;
+
 }
 
 declare function field(colIndex: number, exp: RowFilteringPlugin.Expression|null, ctx?: (any|string)|null): boolean;

package/lib/versions.json

@@ -10,13 +10,13 @@
 	"tr-grid-checkbox": "1.0.60",
 	"tr-grid-column-fitter": "1.0.39",
 	"tr-grid-column-formatting": "0.9.35",
-	"tr-grid-column-grouping": "1.0.55",
+	"tr-grid-column-grouping": "1.0.57",
 	"tr-grid-column-resizing": "1.0.28",
 	"tr-grid-column-selection": "1.0.29",
 	"tr-grid-column-stack": "1.0.72",
-	"tr-grid-conditional-coloring": "1.0.64",
+	"tr-grid-conditional-coloring": "1.0.65",
 	"tr-grid-content-wrap": "1.0.20",
-	"tr-grid-contextmenu": "1.0.39",
+	"tr-grid-contextmenu": "1.0.40",
 	"tr-grid-filter-input": "0.9.33",
 	"tr-grid-heat-map": "1.0.29",
 	"tr-grid-in-cell-editing": "1.0.80",
@@ -24,9 +24,9 @@
 	"tr-grid-percent-bar": "1.0.22",
 	"tr-grid-range-bar": "2.0.5",
 	"tr-grid-row-dragging": "1.0.29",
-	"tr-grid-row-filtering": "1.0.60",
+	"tr-grid-row-filtering": "1.0.61",
 	"tr-grid-row-grouping": "1.0.82",
-	"tr-grid-row-selection": "1.0.23",
+	"tr-grid-row-selection": "1.0.24",
 	"tr-grid-rowcoloring": "1.0.24",
 	"tr-grid-textformatting": "1.0.46",
 	"tr-grid-titlewrap": "1.0.19",

package/package.json

@@ -66,5 +66,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.66"
+	"version": "6.0.68"
 }