@refinitiv-ui/efx-grid 6.0.32 → 6.0.34

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

@@ -237,25 +237,17 @@ CellPainter.prototype.clearHeatMap = function() {
 /** @public */
 CellPainter.prototype.applyThemeColor = function() {
 	var colors = ElfUtil.getColors();
-	var cond = this._conditions[0]; // Heatmap, color text condition must be the first
-	if(cond) {
-		if(this._coloringType === CellPainter.ColoringTypes.HEATMAP) { // Heatmap uses grid color to blend the result color
+	if(this._coloringType === CellPainter.ColoringTypes.HEATMAP) { // Heatmap uses grid color to blend the result color
+		var cond = this._conditions[0]; // Heatmap, color text condition must be the first
+		if(cond) {
 			if(cond["textMode"]) {
 				cond["baseColor"] = colors["baseText"];
 			} else {
 				cond["baseColor"] = colors["baseGrid"];
 			}
-		}
-		if(cond["useThemeColor"]) { // Only heatmap and colorText painters use theme color
-			if(this._coloringType === CellPainter.ColoringTypes.HEATMAP || this._coloringType === CellPainter.ColoringTypes.TEXT) {
-				var up, down;
-				if(this._coloringType === CellPainter.ColoringTypes.TEXT && cond["field"] === "CF_TICK") {
-					up = colors["tickUp"];
-					down = colors["tickDown"];
-				} else {
-					up = colors["up"];
-					down = colors["down"];
-				}
+			if(cond["useThemeColor"]) {
+				var up = colors["up"];
+				var down = colors["down"];
 				var level = (colors["level"] === colors["baseText"]) ? "" : colors["level"];
 				CellPainter._setUpDownColors(cond, up, down, level);
 			}
@@ -374,34 +366,36 @@ CellPainter.prototype.addHeatmapWithTheme = function(field, midPoint, opt_textMo
 /** @private
 * @param {Function} expression
 * @param {string} field
-* @param {string} upColor
-* @param {string} downColor
-* @param {string} levelColor
+* @param {string=} upClass CSS class name
+* @param {string=} downClass CSS class name
+* @param {string=} levelClass CSS class name
 * @return {!Object}
 */
-CellPainter.prototype._addColorText = function(expression, field, upColor, downColor, levelColor) {
+CellPainter.prototype._addColorText = function(expression, field, upClass, downClass, levelClass) {
 	this._setColoringType(CellPainter.ColoringTypes.TEXT);
 
 	var condition = {};
 	condition["field"] = field;
 	condition["expression"] = expression.bind(null, field);
-	CellPainter._setUpDownColors(condition, upColor, downColor, levelColor);
+	condition["upClass"] = upClass;
+	condition["downClass"] = downClass;
+	condition["levelClass"] = levelClass;
 
 	this._addCondition(condition);
 	return condition;
 };
 /** @public
 * @param {string} field
-* @param {string} upColor
-* @param {string} downColor
-* @param {string} levelColor
+* @param {string=} upClass CSS class name
+* @param {string=} downClass CSS class name
+* @param {string=} levelClass CSS class name
 * @return {!Object}
 */
-CellPainter.prototype.addColorText = function(field, upColor, downColor, levelColor) {
+CellPainter.prototype.addColorText = function(field, upClass, downClass, levelClass) {
 	return this._addColorText(
 		TickFields[field] ? CellPainter._tickColorTextCondition : CellPainter._colorTextCondition,
 		field,
-		upColor, downColor, levelColor
+		upClass, downClass, levelClass
 	);
 };
 /** @public
@@ -409,14 +403,7 @@ CellPainter.prototype.addColorText = function(field, upColor, downColor, levelCo
 * @return {!Object}
 */
 CellPainter.prototype.addColorTextWithTheme = function(field) {
-	var colors = ElfUtil.themeColors;
-	var condition = this.addColorText(field,
-		colors["up"],
-		colors["down"],
-		(colors["level"] === colors["baseText"]) ? "" : colors["level"]
-	);
-
-	condition["useThemeColor"] = true;
+	var condition = this.addColorText(field, "positive", "negative", "neutral");
 	return condition;
 };
 /** @public
@@ -518,14 +505,16 @@ CellPainter.prototype.renderForPrinting = function(cell, rowData, min, max) {
 		return;
 	}
 	var styles = this._getStyles(rowData, min, max);
-	var cssClass = styles["cssClass"];
-	if (cssClass) {
-		if (cell._coloringCssClass !== cssClass) {
-			cell.classList.remove(cell._coloringCssClass);
-			cell._coloringCssClass = null;
+	var cssClass = styles["cssClass"]; // Can be an empty string
+	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);
@@ -658,14 +647,17 @@ CellPainter._cellRestorer = function(scope) {
 		}
 
 		var styles = this._getStyles(rowData, min, max);
-		var cssClass = styles["cssClass"];
-		if (cssClass) {
+		var cssClass = styles["cssClass"]; // Can be an empty string
+		if (cssClass != null) { // Predefined colors mode
 			if (elem._coloringCssClass && elem._coloringCssClass !== cssClass) {
 				elem.classList.remove(elem._coloringCssClass);
 				elem._coloringCssClass = null;
 			}
-			elem.classList.add(cssClass);
-			elem._coloringCssClass = cssClass;
+			if (cssClass) {
+				elem.classList.add(cssClass);
+				elem._coloringCssClass = cssClass;
+			}
+			// Remove blinking color
 			elem.style.backgroundColor = "";
 			elem.style.color = "";
 		} else {
@@ -720,13 +712,14 @@ CellPainter.prototype._getStyles = function(rowData, min, max) {
 				}
 			} else if(this._coloringType === CellPainter.ColoringTypes.TEXT) {
 				if(ret > 0) {
-					CellPainter._colorObj["color"] = curCond["upColor"];
+					curCond["cssClass"] = curCond["upClass"];
 				} else if(ret < 0) {
-					CellPainter._colorObj["color"] = curCond["downColor"];
+					curCond["cssClass"] = curCond["downClass"];
 				} else {
-					CellPainter._colorObj["color"] = this._levelColorDisabled ? "" : curCond["levelColor"];
+					curCond["cssClass"] = this._levelColorDisabled ? "" : curCond["levelClass"];
 				}
-				return CellPainter._colorObj;
+				curCond["cssClass"] = curCond["cssClass"] || "";
+				return curCond;
 			}
 
 			// Expected return value is {
@@ -902,6 +895,10 @@ 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);
+	}
+
 	styles = styles || CellPainter.supportedStyles;
 	for(var i = styles.length; --i >= 0;) {
 		elem.style[styles[i]] = "";  // WARNING: Very slow
@@ -915,22 +912,24 @@ CellPainter.clearCellStyle = function(cell, styles) {
 * @param {boolean=} withContrast
 */
 CellPainter._setUpDownColors = function(scp, upColor, downColor, levelColor, withContrast) {
+	scp["upColor"] = upColor;
 	if(upColor != null) {
-		scp["upColor"] = upColor;
 		if(withContrast) {
 			scp["contrastUpColor"] = CellPainter.getOppositeColor(upColor);
 		}
 		//scp["rgbUp"] = CellPainter.hex2Rgb(upColor);
 	}
+
+	scp["downColor"] = downColor;
 	if(downColor != null) {
-		scp["downColor"] = downColor;
 		if(withContrast) {
 			scp["contrastDownColor"] = CellPainter.getOppositeColor(downColor);
 		}
 		//scp["rgbDown"] = CellPainter.hex2Rgb(downColor);
 	}
+
+	scp["levelColor"] = levelColor;
 	if(levelColor != null) {
-		scp["levelColor"] = levelColor;
 		if(withContrast) {
 			scp["contrastLevelColor"] = CellPainter.getOppositeColor(levelColor);
 		}
@@ -1024,14 +1023,16 @@ CellPainter.prototype._paintCell = function(cell, rowData, min, max) {
 	}
 
 	var styles = this._getStyles(rowData, min, max);
-	var cssClass = styles["cssClass"];
-	if (cssClass) {
-		if (elem._coloringCssClass !== cssClass) {
+	var cssClass = styles["cssClass"]; // Can be an empty string
+	if (cssClass != null) { // Predefined colors mode
+		if (elem._coloringCssClass && elem._coloringCssClass !== cssClass) {
 			elem.classList.remove(elem._coloringCssClass);
 			elem._coloringCssClass = null;
 		}
-		elem.classList.add(cssClass);
-		elem._coloringCssClass = cssClass;
+		if (cssClass) {
+			elem.classList.add(cssClass);
+			elem._coloringCssClass = cssClass;
+		}
 	} else {
 		if (elem._coloringCssClass) {
 			elem.classList.remove(elem._coloringCssClass);

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

@@ -189,8 +189,12 @@ FieldFormatter.prototype.getOptions = function(options) { // serialize
 	options["field"] = this._field;
 	options["formatType"] = this._userFormatType ? this._userFormatType : this._formatType; // WARNING: Beware of case sensitivity
 	if(toDateTimeType(options["formatType"]) == DATE_TIME){
-		options["dateTimeFormat"] = this._dateTimeFormat;
-		options["useUTCTime"] = (this._timeZone == "GMT");
+		if(this._dateTimeFormat !== "") {
+			options["dateTimeFormat"] = this._dateTimeFormat;
+		}
+		if(this._timeZone !== "GMT") {
+			options["useUTCTime"] = false;
+		} // useUTCTime by default, otherwise is use local
 	}
 	return options;
 };

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

@@ -56,6 +56,8 @@ declare class GroupDefinitions {
 
     public setGroupChildren(groupId: string, newChildList: (string)[]|null): boolean;
 
+    public setGroupName(groupId: string, groupName: string): boolean;
+
 }
 
 export default GroupDefinitions;

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

@@ -562,6 +562,21 @@ GroupDefinitions.prototype.setGroupChildren = function (groupId, newChildList) {
 	}
 	return false;
 };
+/** @public
+* @param {string} groupId
+* @param {string} groupName
+* @return {boolean}
+*/
+GroupDefinitions.prototype.setGroupName = function (groupId, groupName) {
+	var groupDef = this._groupMap[groupId];
+	if(groupDef) {
+		if(groupDef.name !== groupName) {
+			groupDef.name = groupName;
+			return true;
+		}
+	}
 
+	return false;
+};
 export default GroupDefinitions;
 export { GroupDefinitions };

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

@@ -242,25 +242,37 @@ NumberFormatter.prototype.getOptions = function(options) { // serialize
 
 	var formatType = options["formatType"];
 
-	options["precisionEnabled"] = this._precisionEnabled;
-	options["decimalPlaces"] = this._precision;
-	options["plusSign"] = this._plusSignEnabled;
-	options["separator"] = this._separatorEnabled;
+	if(this._precisionEnabled !== true) {
+		options["precisionEnabled"] = this._precisionEnabled; // Default in init
+	}
+
+	if(this._precision !== 2) {
+		options["decimalPlaces"] = this._precision;
+	}
+
+	if(this._plusSignEnabled !== false) {
+		options["plusSign"] = this._plusSignEnabled;
+	}
+
+	if(this._separatorEnabled !== false) {
+		options["separator"] = this._separatorEnabled;
+	}
 
 	if(formatType === "scaled" || formatType === "scaledvalue") {
 		var su = "";
 		if(this._scaler == "b") {
 			su = "billion";
-		} else if(this._scaler == "m") {
-			su = "million";
-		}
-		options["scalingUnit"] = su;
+			options["scalingUnit"] = su;
+		} // We didn't return default value (million) for clean up getConfigObject
 	}
 
 	if(formatType === "percent") {
-		options["percentSign"] = this._percentSignEnabled;
-		options["mutiplyBy100"] = this._multiplyBy100Enabled;
-		options["multiplyBy100"] = this._multiplyBy100Enabled;
+		if(this._percentSignEnabled !== true) {
+			options["percentSign"] = this._percentSignEnabled;
+		}
+		if(this._multiplyBy100Enabled !== false) {
+			options["multiplyBy100"] = this._multiplyBy100Enabled;
+		}
 	}
 	return options;
 };

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

@@ -18,10 +18,14 @@ declare function extendObject(obj: any, extender?: any, limiters?: (string)[]|nu
 
 declare function cloneObject(obj: any, limiters?: (string)[]|null): any;
 
+declare function isEmptyObject(obj: any): boolean;
+
 declare function arrayToObject(data?: any[]|null, fields?: (string)[]|null): any|null|null;
 
 declare function extendProperty(obj: any, extender: any, propName: string): void;
 
+declare function deepEqual(obj1: any, obj2: any): boolean;
+
 declare function extendArrayProperty(obj: any, propName: string, ary: any): any[]|null;
 
 declare function parseCondition(expression: string|((...params: any[]) => any)|null): ((...params: any[]) => any)|null;
@@ -49,6 +53,8 @@ export {
 	Util,
 	extendObject,
 	cloneObject,
+	isEmptyObject,
+	deepEqual,
 	arrayToObject,
 	extendProperty,
 	extendArrayProperty,

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

@@ -138,6 +138,20 @@ var extendObject = function (obj, extender, limiters) {
 var cloneObject = function (obj, limiters) {
 	return extendObject({}, obj, limiters);
 };
+
+/** Check empty object
+* @public
+* @function
+* @param {Object} obj
+* @return {boolean}=true, if the obj is empty
+*/
+var isEmptyObject = function (obj) {
+	for (var key in obj) {
+		return false;
+	}
+	return true;
+};
+
 /** @public
 * @param {Array=} data
 * @param {Array.<string>=} fields In case of the given data is an array, this param will be used for mapping index to field
@@ -186,6 +200,58 @@ var extendProperty = function (obj, extender, propName) {
 		}
 	}
 };
+
+
+/** Compare the values of obj1 and obj2. if they are the same object or have the same value, the result will be true. Otherwise, it will return false.
+* @public
+* @param {*} obj1
+* @param {*} obj2
+* @return {boolean}
+*/
+var deepEqual = function (obj1, obj2) {
+
+	if(obj1 === obj2) {
+		return true;
+	}
+
+	if (typeof obj1 !== typeof obj2) {
+		return false;
+	}
+
+	if (typeof obj1 === "object") {
+
+		// We need to split array and object for performance reason
+		if(Array.isArray(obj1)) {
+			if(obj1.length !== obj2.length) {
+				return false;
+			}
+
+			for (var i = 0; i < obj1.length; i++) {
+				if (!deepEqual(obj1[i], obj2[i])) { // The array may not be a match if the elements are not sorted, so it will not be considered equal if there is a mismatch.
+					return false;
+				}
+			}
+
+		} else {
+
+			if (Object.keys(obj1).length !== Object.keys(obj2).length) {
+				return false;
+			}
+
+			for (var key in obj1) {
+				if (!deepEqual(obj1[key], obj2[key])) {
+					return false;
+				}
+			}
+		}
+
+
+		return true;
+	}
+
+	return false;
+
+};
 /** Array.push() is much faster than Array.concat(). The downside is the parameters must be an array, whereas concat() has no such requirement. <br>
 * This method excels in extending known array property in an object.
 * @public
@@ -512,6 +578,8 @@ export {
 	Util,
 	extendObject,
 	cloneObject,
+	isEmptyObject,
+	deepEqual,
 	arrayToObject,
 	extendProperty,
 	extendArrayProperty,

package/lib/tr-grid-util/es6/jet/CollectionDict.d.ts

@@ -18,7 +18,7 @@ declare class CollectionDict {
 
     public getAllItems(): any[]|null;
 
-    public getItemCount(): number;
+    public getItemCount(key?: string|null): number;
 
     public getAllKeys(): (string)[];
 

package/lib/tr-grid-util/es6/jet/CollectionDict.js

@@ -1,4 +1,6 @@
-/** @constructor */
+/** @description CollectionDict stores a collection (Array) of any value using a text (string) as a key for accessing the collection.
+* @constructor
+*/
 var CollectionDict = function() {
 	this._dict = {};
 };
@@ -125,9 +127,17 @@ CollectionDict.prototype.getAllItems = function() {
 	return null;
 };
 /** @public
+* @param {string=} key
 * @return {number}
 */
-CollectionDict.prototype.getItemCount = function() {
+CollectionDict.prototype.getItemCount = function(key) {
+	if(key) {
+		var items = this._dict[key] || null;
+		if(items) {
+			return items.length;
+		}
+		return 0;
+	}
 	return this._count;
 };
 /** @public