@refinitiv-ui/efx-grid 6.0.151 → 6.0.153

package/lib/grid/index.js

@@ -1,3 +1,3 @@
 import {Grid} from "./lib/efx-grid.js";
 export {Grid}
-window.EFX_GRID = { version: "6.0.151" };
+window.EFX_GRID = { version: "6.0.153" };

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

@@ -61,7 +61,8 @@ declare namespace RowFilteringPlugin {
         filterChanged?: ((...params: any[]) => any)|null,
         beforeDialogOpened?: ((...params: any[]) => any)|null,
         dialogCommitted?: ((...params: any[]) => any)|null,
-        refreshed?: ((...params: any[]) => any)|null
+        refreshed?: ((...params: any[]) => any)|null,
+        activeIconState?: boolean|null
     };
 
 }
@@ -120,6 +121,10 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public getColumnFilterIcons(colIndex: number): (Element)[]|null;
 
+    public setColumnFilterIconState(colIndex: number, active: boolean): void;
+
+    public getColumnFilterIconState(colIndex: number): boolean;
+
     public updateAllColumnIcons(): void;
 
     public addDataView(dv: any): void;

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

@@ -118,6 +118,7 @@ The expression can take various forms:<br>
 * @property {Function=} beforeDialogOpened=null Event handler dispatched before dialog opening.
 * @property {Function=} dialogCommitted=null Event handler dispatched whenever the new settings from dialog are applied.
 * @property {Function=} refreshed=null Event handler dispatched after new filter is applied to grid's data view.
+* @property {boolean=} activeIconState=true If disabled, filter icon won't be automatically changed its state when filter in a column is changed.
 */
 
 /** @private
@@ -336,12 +337,15 @@ RowFilteringPlugin._filterBuilder = null;
 * @private
 */
 RowFilteringPlugin._dialogTagName; // intentionally left undefined
-
 /** Array of DataView objects
 * @type {!Array.<Object>}
 * @private
 */
 RowFilteringPlugin.prototype._dvs;
+/** @type {boolean}
+* @private
+*/
+RowFilteringPlugin.prototype._activeIconState = true;
 
 
 /** @public
@@ -552,6 +556,9 @@ RowFilteringPlugin.prototype.config = function (options) {
 		if(rowFiltering["dialogOptions"]){
 			this._dialogOptions = rowFiltering["dialogOptions"];
 		}
+		if(rowFiltering["activeIconState"] != null){
+			this._activeIconState = !!rowFiltering["activeIconState"];
+		}
 		if(rowFiltering["clicked"]) {
 			rowFiltering["click"] = rowFiltering["clicked"];
 		}
@@ -635,6 +642,10 @@ RowFilteringPlugin.prototype.getConfigObject = function (gridOptions) {
 		extOptions.dialogOptions = this._dialogOptions; // TODO: dialogOptions should not contain any function
 		dirty = true;
 	}
+	if(!this._activeIconState) {
+		extOptions.activeIconState = false;
+		dirty = true;
+	}
 	// TODO: get emptySegmentFiltering setting from DataView
 	// TODO: get separatorFiltering setting from DataView
 	if(dirty) {
@@ -1211,26 +1222,74 @@ RowFilteringPlugin.prototype.setFilterExpressions = function(filterExps) {
 RowFilteringPlugin.prototype.hasColumnFilter = function() {
 	return (this._columnFilters.length > 0);
 };
-/** @public
+
+/** @private
 * @param {number} colIndex
-* @return {Array.<Element>} icons
+* @return {Array.<Element>} Bottom cells from title section of all grids
 */
-RowFilteringPlugin.prototype.getColumnFilterIcons = function(colIndex) {
-	let icons = [];
+RowFilteringPlugin.prototype._getBottomTitleCells = function(colIndex) {
+	var cells = [];
 	for(let i = this._hosts.length; --i >= 0;) {
 		let host = this._hosts[i];
 		let tsect = host.getSection("title");
-		if(!tsect) {
-			continue;
+		if(tsect) {
+			let rowCount = tsect.getRowCount();
+			let cell = tsect.getCell(colIndex, rowCount - 1, true); // Get bottom cell
+			if(cell) {
+				cells.push(cell);
+			}
 		}
-		let rCount = tsect.getRowCount();
-		let cell = tsect.getCell(colIndex, rCount - 1, true); // Get bottom cell
-		if(cell && cell._filterIcon) {
+	}
+	return cells;
+};
+/** @public
+* @param {number} colIndex
+* @return {Array.<Element>} icons
+*/
+RowFilteringPlugin.prototype.getColumnFilterIcons = function(colIndex) {
+	let icons = [];
+	let cells = this._getBottomTitleCells(colIndex);
+	let len = cells.length;
+	for(let i = 0; i < len; ++i) {
+		let cell = cells[i];
+		if(cell._filterIcon) {
 			icons.push(cell._filterIcon);
 		}
 	}
 	return icons;
 };
+/** Change specified filter icon state regardless of existing filter in the column. This method does NOT change the visibility of the icon.
+* @public
+* @param {number} colIndex
+* @param {boolean} active
+*/
+RowFilteringPlugin.prototype.setColumnFilterIconState = function(colIndex, active) {
+	let cells = this._getBottomTitleCells(colIndex);
+	let len = cells.length;
+	for(let i = 0; i < len; ++i) {
+		let cell = cells[i];
+		if(cell._filterIcon) {
+			cell.enableClass("active-filter", active);
+		}
+	}
+};
+/** @public
+* @param {number} colIndex
+* @returns {boolean} active
+*/
+RowFilteringPlugin.prototype.getColumnFilterIconState = function(colIndex) {
+	let cells = this._getBottomTitleCells(colIndex);
+	let len = cells.length;
+	for(let i = 0; i < len; ++i) {
+		let cell = cells[i];
+		if(cell._filterIcon) {
+			if(cell.hasClass("active-filter")) {
+				return true;
+			}
+		}
+	}
+	return false;
+};
 /** @public */
 RowFilteringPlugin.prototype.updateAllColumnIcons = function() {
 	if(this._uiTimerId) {
@@ -1451,16 +1510,20 @@ RowFilteringPlugin.prototype._updateColumnIcon = function(colIndex) {
 				cell.insertFloatingIcon(filterIcon, 10);
 				cell._filterIcon = filterIcon;
 			}
-			if(hasFilter){
-				cell.enableClass("active-filter", true);
-			}else{
-				cell.enableClass("active-filter", false);
+			if(this._activeIconState) {
+				if(hasFilter){
+					cell.enableClass("active-filter", true);
+				}else{
+					cell.enableClass("active-filter", false);
+				}
 			}
 		} else {
 			if(cell._filterIcon) {
 				cell.removeFloatingIcon(cell._filterIcon);
 				cell._filterIcon = null;
-				cell.enableClass("active-filter", false);
+				if(this._activeIconState) {
+					cell.enableClass("active-filter", false);
+				}
 			}
 		}
 	}

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

@@ -61,7 +61,8 @@ declare namespace RowFilteringPlugin {
         filterChanged?: ((...params: any[]) => any)|null,
         beforeDialogOpened?: ((...params: any[]) => any)|null,
         dialogCommitted?: ((...params: any[]) => any)|null,
-        refreshed?: ((...params: any[]) => any)|null
+        refreshed?: ((...params: any[]) => any)|null,
+        activeIconState?: boolean|null
     };
 
 }
@@ -120,6 +121,10 @@ declare class RowFilteringPlugin extends GridPlugin {
 
     public getColumnFilterIcons(colIndex: number): (Element)[]|null;
 
+    public setColumnFilterIconState(colIndex: number, active: boolean): void;
+
+    public getColumnFilterIconState(colIndex: number): boolean;
+
     public updateAllColumnIcons(): void;
 
     public addDataView(dv: any): void;

package/lib/versions.json

@@ -24,7 +24,7 @@
 	"tr-grid-percent-bar": "1.0.24",
 	"tr-grid-range-bar": "2.0.9",
 	"tr-grid-row-dragging": "1.0.39",
-	"tr-grid-row-filtering": "1.0.89",
+	"tr-grid-row-filtering": "1.0.90",
 	"tr-grid-row-grouping": "1.0.88",
 	"tr-grid-row-selection": "1.0.33",
 	"tr-grid-rowcoloring": "1.0.26",

package/package.json

@@ -69,5 +69,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.151"
+	"version": "6.0.153"
 }