@refinitiv-ui/efx-grid 6.0.141 → 6.0.143

package/lib/grid/index.js

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

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

@@ -20,7 +20,8 @@ declare namespace RowFilteringPlugin {
     type ColumnOptions = {
         filter?: RowFilteringPlugin.Expression|null,
         filterState?: any,
-        filterIcon?: boolean|null
+        filterIcon?: boolean|null,
+        filterDialogOptions?: RowFilteringPlugin.FilterDialogOptions|null
     };
 
     type FilterDialogOptions = {

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

@@ -74,6 +74,7 @@ The expression can take various forms:<br>
 * @property {RowFilteringPlugin~Expression=} filter An expression string or Function
 * @property {*=} filterState Context object that will be passed as the third parameter for the filter logic
 * @property {boolean=} filterIcon=true If disabled, filter icon will not be shown. This property only works with "always" mode
+* @property {RowFilteringPlugin~FilterDialogOptions=} filterDialogOptions=null Configuration for Filter Dialog, applying to column.
 */
 
 /** @typedef {Object} RowFilteringPlugin~FilterDialogOptions
@@ -614,6 +615,11 @@ RowFilteringPlugin.prototype.getConfigObject = function (gridOptions) {
 		if(!filterIcon) {
 			column.filterIcon = false;
 		}
+
+		let filterDialogOptions = colSettings.filterDialogOptions;
+		if(filterDialogOptions != null) {
+			column.filterDialogOptions = colSettings.filterDialogOptions;
+		}
 	}
 
 	let extOptions = obj.rowFiltering;
@@ -914,6 +920,11 @@ RowFilteringPlugin.prototype._setColumnOptions = function(colIndex, userObj) {
 		this._updateColumnIcon(colIndex);
 	}
 
+	let filterDialogOptions = userObj["filterDialogOptions"];
+	if(filterDialogOptions != null) {
+		colSettings.filterDialogOptions = filterDialogOptions;
+	}
+
 	return (exp != null);
 };
 /** @private
@@ -1925,11 +1936,15 @@ RowFilteringPlugin.prototype.openDialog = function(colIndex, runtimeDialogOption
 
 	let columnDialogOptions = null;
 	let colSettings = this._getUserColumnSettings(colIndex); // colData["rowFiltering"]
+	if(colSettings.filterDialogOptions) {
+		columnDialogOptions = colSettings.filterDialogOptions;
+	}
 	if(colSettings.fieldDataType){
 		// TODO: Use data type from Composite Grid (getColumnDataType) or Realtime Grid (getDataType) instead
-		columnDialogOptions = {
-			fieldDataType: colSettings.fieldDataType
-		};
+		if(!columnDialogOptions) {
+			columnDialogOptions = {};
+		}
+		columnDialogOptions.fieldDataType = colSettings.fieldDataType;
 	}
 
 	RowFilteringPlugin._overrideConfig(dialogConfig, this._dialogOptions);

package/lib/tr-grid-util/es6/CellPainter.d.ts

@@ -56,12 +56,8 @@ declare class CellPainter {
 
     public resetColoring(): void;
 
-    public resetBlinking(): void;
-
     public clearBlinking(): void;
 
-    public resetHeatMap(): void;
-
     public clearHeatMap(): boolean;
 
     public applyThemeColor(): void;
@@ -122,7 +118,7 @@ declare class CellPainter {
 
     public static getOppositeColor(hexCode: string|(number)[]|null): string;
 
-    public render(cell: any, rowData: any, min: number, max: number, changedCols?: any): void;
+    public render(cell: any, rowData: any, min: number, max: number): void;
 
     public renderHeatMap(cell: any, rowData: any, min: number, max: number): void;
 
@@ -132,8 +128,6 @@ declare class CellPainter {
 
     public flash(cell: any, blinkColor: string|null|null, rowData: any): boolean;
 
-    public _blink(scope: any, elem: Element|null, blinkColor: string, contrastColor: string): boolean;
-
     public blinkCell(cell: any, newValue: number, oldValue: number, rowData: any): boolean;
 
     public verifyBlinking(cell: any, rowData: any): void;

package/lib/tr-grid-util/es6/CellPainter.js

@@ -35,14 +35,25 @@ import { ExpressionParser } from "./ExpressionParser.js";
 * @property {string=} tickDown Color for negative tick icon
 */
 
-/** @constructor */
-
+/** @constructor
+*/
 let CellPainter = function() {
 	this._conditions = [];
 	this._scopes = [];
 
 	CellPainter._painters.push(this); // For later referencing
 };
+/** @private
+* @function
+* @param {Element} elem
+* @param {string=} targetClass
+*/
+let _removeCssClass = function(elem, targetClass) {
+	if (elem._coloringCssClass != null && elem._coloringCssClass !== targetClass) {
+		elem.classList.remove(elem._coloringCssClass);
+		elem._coloringCssClass = null;
+	}
+};
 
 /** Enum for coloring types.
 * @enum {number}
@@ -165,25 +176,7 @@ CellPainter.prototype.dispose = function() {
 /** @public */
 CellPainter.prototype.reset = function() {
 	this._setColoringType(0);
-
-	let len = this._scopes.length;
-	if(len) {
-		for(let i = 0; i < len; ++i) {
-			let scope = this._scopes[i];
-			if(CellPainter._clearBlinkTimer(scope)) {
-				scope._restorer();
-			}
-			let cell = scope["cell"];
-			if(cell) {
-				delete cell["blinking"]; // Delete cell blinking scope
-			}
-
-			scope["cell"] = null;
-		}
-		this._scopes.length = 0;
-	}
-
-	this._blinkCondition = null;
+	this.clearBlinking();
 };
 
 /** @public */
@@ -194,12 +187,6 @@ CellPainter.prototype.resetColoring = function() {
 	this._conditions.length = 0;
 };
 
-/** @public */
-CellPainter.prototype.resetBlinking = function() {
-	this._blinkCondition = null;
-	this._scopes.length = 0;
-};
-
 /** @public */
 CellPainter.prototype.clearBlinking = function() {
 	this._blinkCondition = null;
@@ -220,12 +207,11 @@ CellPainter.prototype.clearBlinking = function() {
 		this._scopes.length = 0;
 	}
 };
-
-/** @public */
-CellPainter.prototype.resetHeatMap = function() {
-	this._conditions.length = 0;
-	this._columnStats = null;
-};
+/** @public
+* @ignore
+* @function
+*/
+CellPainter.prototype.resetBlinking = CellPainter.prototype.clearBlinking;
 
 /** Return true if no one is using this painter
  * @public
@@ -241,6 +227,14 @@ CellPainter.prototype.clearHeatMap = function() {
 		return true;
 	}
 };
+/** @public
+* @ignore
+* @function
+*/
+CellPainter.prototype.resetHeatMap = function() {
+	this._conditions.length = 0;
+	this._columnStats = null;
+};
 
 /** @public */
 CellPainter.prototype.applyThemeColor = function() {
@@ -308,7 +302,7 @@ CellPainter.prototype.setConditions = function(conditions) {
 	this._conditions.length = 0; // TODO: Clear existing cell styles first
 	this._setColoringType(CellPainter.ColoringTypes.CONDITIONAL);
 
-	let len = conditions.length;
+	let len = conditions ? conditions.length : 0;
 	for (let i = 0; i < len; i++) {
 		this._addCondition(conditions[i]);
 	}
@@ -400,6 +394,7 @@ CellPainter.prototype._addColorText = function(expression, field, upClass, downC
 	condition["upClass"] = upClass;
 	condition["downClass"] = downClass;
 	condition["levelClass"] = levelClass;
+	 // TODO: Make this consistent with other type (e.g., heat map and blinking)
 
 	this._addCondition(condition);
 	return condition;
@@ -526,20 +521,14 @@ CellPainter.prototype.renderForPrinting = function(cell, rowData, min, max) {
 	}
 	let styles = this._getStyles(rowData, min, max);
 	let cssClass = styles["cssClass"]; // Can be an empty string
+
+	_removeCssClass(cell, cssClass);
 	if (cssClass != null) { // Predefined colors mode
-		if (elem._coloringCssClass && elem._coloringCssClass !== cssClass) {
-			elem.classList.remove(elem._coloringCssClass);
-			elem._coloringCssClass = null;
-		}
 		if (cssClass) {
-			elem.classList.add(cssClass);
-			elem._coloringCssClass = cssClass;
+			cell.classList.add(cssClass);
+			cell._coloringCssClass = cssClass;
 		}
 	} else {
-		if (cell._coloringCssClass) {
-			cell.classList.remove(cell._coloringCssClass);
-			cell._coloringCssClass = null;
-		}
 		cell.style.backgroundColor = styles["backgroundColor"] || "";
 		cell.style.color = styles["color"] || "";
 	}
@@ -660,11 +649,8 @@ CellPainter._cellRestorer = function(scope) {
 
 		let styles = this._getStyles(rowData, min, max);
 		let cssClass = styles["cssClass"]; // Can be an empty string
+		_removeCssClass(elem, cssClass);
 		if (cssClass != null) { // Predefined colors mode
-			if (elem._coloringCssClass && elem._coloringCssClass !== cssClass) {
-				elem.classList.remove(elem._coloringCssClass);
-				elem._coloringCssClass = null;
-			}
 			if (cssClass) {
 				elem.classList.add(cssClass);
 				elem._coloringCssClass = cssClass;
@@ -673,10 +659,6 @@ CellPainter._cellRestorer = function(scope) {
 			elem.style.backgroundColor = "";
 			elem.style.color = "";
 		} else {
-			if (elem._coloringCssClass) {
-				elem.classList.remove(elem._coloringCssClass);
-				elem._coloringCssClass = null;
-			}
 			elem.style.backgroundColor = styles["backgroundColor"] || "";
 			elem.style.color = styles["color"] || "";
 		}
@@ -728,10 +710,12 @@ CellPainter.prototype._getStyles = function(rowData, min, max) {
 					curCond["cssClass"] = curCond["upClass"];
 				} else if(ret < 0) {
 					curCond["cssClass"] = curCond["downClass"];
-				} else {
+				} else if(ret === 0) {
 					curCond["cssClass"] = curCond["levelClass"];
+				} // else case is no change in cssClass
+				if(!curCond["cssClass"]) {
+					curCond["cssClass"] = ""; // If no cssClass, remove existing one
 				}
-				curCond["cssClass"] = curCond["cssClass"] || "";
 				return curCond;
 			}
 
@@ -864,9 +848,7 @@ CellPainter.clearCellStyle = function(cell, styles) {
 		// WARNING: Scope is not removed from the this._scopes collection to speed things up
 	}
 
-	if(elem._coloringCssClass) {
-		elem.classList.remove(elem._coloringCssClass);
-	}
+	_removeCssClass(elem);
 
 	if(!styles){
 		styles = CellPainter.supportedStyles;
@@ -949,9 +931,8 @@ CellPainter.getOppositeColor = function (hexCode) {
 * @param {Object} rowData e.g. { PCTCHNG: 0.53, CF_NETCHNG: 0.75 }
 * @param {number} min
 * @param {number} max
-* @param {Object=} changedCols
 */
-CellPainter.prototype.render = function (cell, rowData, min, max, changedCols) {
+CellPainter.prototype.render = function (cell, rowData, min, max) {
 	if (min != null && min === min) { // Render heatmap
 		this._paintCell(cell, rowData, min, max);
 	} else if (this._conditions.length && this._coloringType === CellPainter.ColoringTypes.CONDITIONAL) { // Render conditional-coloring
@@ -1005,10 +986,7 @@ CellPainter.prototype._paintCell = function(cell, rowData, min, max) {
 	let elStyle = elem.style;
 
 	let cssClass = styles["cssClass"]; // Can be an empty string
-	if (elem._coloringCssClass && elem._coloringCssClass !== cssClass) {
-		elem.classList.remove(elem._coloringCssClass);
-		elem._coloringCssClass = null;
-	}
+	_removeCssClass(elem, cssClass);
 	if (cssClass != null) { // Predefined colors mode
 		if (cssClass) {
 			elem.classList.add(cssClass);
@@ -1086,7 +1064,8 @@ CellPainter.prototype.blink = function (cell, blinkSignal, rowData) {
 		contrastColor = bc["contrastLevelColor"];
 	}
 
-	return this._blink(scope, elem, blinkColor, contrastColor);
+	this._blink(scope, elem, blinkColor, contrastColor);
+	return true;
 };
 
 /** Blink cell with specific color or theme's neutral movement color.
@@ -1112,32 +1091,30 @@ CellPainter.prototype.flash = function(cell, blinkColor, rowData) {
 		blinkColor = ElfUtil.themeColors["level"];
 	}
 
-	return this._blink(scope, elem, blinkColor, CellPainter.getOppositeColor(blinkColor));
+	this._blink(scope, elem, blinkColor, CellPainter.getOppositeColor(blinkColor));
+	return true;
 };
 
-/**
-* @public
+/** @private
 * @param {Object} scope
 * @param {Element} elem
 * @param {string} blinkColor
 * @param {string} contrastColor
-* @return {boolean}
+* @return {boolean} Returns true if it is a background blinking, otherwise returns false
 */
 CellPainter.prototype._blink = function (scope, elem, blinkColor, contrastColor) {
-	let bgBlinking = true;
+	CellPainter._clearBlinkTimer(scope);
+	scope["blinkTimer"] = setTimeout(scope._restorer, this._blinkingDuration);
 
 	if (this._blinkCondition["border"]) {
 		elem.style.border = "1px solid " + blinkColor;
-		bgBlinking = false;
+		return false;
 	} else {
 		elem.style.backgroundColor = blinkColor;
 		elem.style.color = contrastColor;
 	}
 
-	CellPainter._clearBlinkTimer(scope);
-	scope["blinkTimer"] = setTimeout(scope._restorer, this._blinkingDuration);
-
-	return bgBlinking;
+	return true;
 };
 
 /**

package/lib/tr-grid-util/es6/ElfUtil.d.ts

@@ -8,6 +8,8 @@ declare namespace ElfUtil {
 
     const themeColors: { [key: string]:  string }|null;
 
+    function setElfVersion(ver: number): void;
+
     function getElfVersion(): number;
 
     function hasComponent(compName: string): number;
@@ -22,7 +24,7 @@ declare namespace ElfUtil {
 
     function isHaloTheme(themeName?: string|null): boolean;
 
-    function injectIcons(configObj: any, optElem?: Element|null): void;
+    function injectIcons(configObj: any): void;
 
     function getIconList(): (string)[];
 

package/lib/tr-grid-util/es6/ElfUtil.js

@@ -116,6 +116,15 @@ ElfUtil._icons = {
 ElfUtil._icons["halo-theme"] = ElfUtil._icons["elf-theme-halo"];
 ElfUtil._icons["solar-theme"] = ElfUtil._icons["elf-theme-solar"];
 
+
+/** Set ELF version for testing purpose
+* @public
+* @function
+* @param {number} ver
+*/
+ElfUtil.setElfVersion = function (ver) {
+	ElfUtil._elfVersion = ver;
+};
 /** Check ELF version
 * @public
 * @function
@@ -279,9 +288,8 @@ ElfUtil.isHaloTheme = function (themeName) {
 * @public
 * @function
 * @param {Object} configObj Object to mutate
-* @param {Element=} optElem Deprecated param: will no longer use anymore
 */
-ElfUtil.injectIcons = function (configObj, optElem) {
+ElfUtil.injectIcons = function (configObj) {
 	if (typeof configObj !== "object") { return; }
 
 	let theme = ElfUtil.getThemeName();
@@ -533,7 +541,8 @@ ElfUtil._profileNameRetrieved = function() {
 };
 
 /** Get theme colors from document
-* @private
+* @public
+* @ignore
 * @param {string} profileName Movement color profile name
 */
 ElfUtil._retrieveThemeColors = function(profileName) {

package/lib/tr-grid-util/es6/Icon.js

@@ -18,7 +18,8 @@ Icon.create = function(iconName, className) {
 	return icon;
 };
 
-/** @public
+/** Create a container element with an icon element in it.
+* @public
 * @function
 * @param {string=} iconName
 * @param {string=} className Class name for the containing box

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

@@ -48,7 +48,7 @@ declare class RowDefinition {
 
     public getType(): string;
 
-    public setDataSource(dataSource: DataCache|null, subs?: any): void;
+    public setDataSource(dataSource: DataCache|null, subs?: any): boolean;
 
     public getDataSource(): DataCache|null;
 

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

@@ -20,7 +20,8 @@ declare namespace RowFilteringPlugin {
     type ColumnOptions = {
         filter?: RowFilteringPlugin.Expression|null,
         filterState?: any,
-        filterIcon?: boolean|null
+        filterIcon?: boolean|null,
+        filterDialogOptions?: RowFilteringPlugin.FilterDialogOptions|null
     };
 
     type FilterDialogOptions = {

package/lib/versions.json

@@ -1,5 +1,5 @@
 {
-	"tr-grid-util": "1.3.169",
+	"tr-grid-util": "1.3.172",
 	"tr-grid-printer": "1.0.18",
 	"@grid/column-dragging": "1.0.21",
 	"@grid/row-segmenting": "2.0.1",
@@ -24,7 +24,7 @@
 	"tr-grid-percent-bar": "1.0.24",
 	"tr-grid-range-bar": "2.0.9",
 	"tr-grid-row-dragging": "1.0.38",
-	"tr-grid-row-filtering": "1.0.88",
+	"tr-grid-row-filtering": "1.0.89",
 	"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.141"
+	"version": "6.0.143"
 }