@refinitiv-ui/efx-grid 6.1.17 → 6.1.19

package/lib/grid/index.js

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

package/lib/tr-grid-heat-map/es6/HeatMap.d.ts

@@ -11,8 +11,10 @@ declare namespace HeatMapPlugin {
     };
 
     type HeatMap = {
+        mode?: string|null,
         midPoint?: number|null,
-        mode?: string|null
+        min?: number|null,
+        max?: number|null
     };
 
 }
@@ -35,11 +37,13 @@ declare class HeatMapPlugin extends GridPlugin {
 
     public setColumnHeatMap(colIndex: number, columnDef: any, opt_grid?: any): void;
 
+    public _getColumnHeatMapOptions(hm: any, options?: any): boolean;
+
     public getColumnHeatMapOptions(colIndex: number, options?: any): any;
 
 }
 
-declare function cond(colIndex: number, options?: any): any;
+declare function hmMode(hm: any, options?: any): boolean;
 
 export default HeatMapPlugin;
 export { HeatMapPlugin, HeatMapPlugin as HeatMap, HeatMapPlugin as HeatMapExtension };

package/lib/tr-grid-heat-map/es6/HeatMap.js

@@ -11,8 +11,10 @@ import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
 
 /** @typedef {Object} HeatMapPlugin~HeatMap
 * @description Available options describing `heatMap` object
-* @property {number=} midPoint=0 Middle point between values representing up and down colors
 * @property {string=} mode="cell" In cell mode, heat map color will be applied to the entire cell
+* @property {number=} midPoint=0 Middle point between values representing up and down colors
+* @property {number=} min Minimum value in the data range; values at or below this will use the lowest intensity color
+* @property {number=} max Maximum value in the data range; values at or above this will use the highest intensity color
 */
 
 /** @constructor
@@ -145,26 +147,15 @@ HeatMapPlugin.prototype.getConfigObject = function (out_obj) {
 		}
 
 
-		let opt = this.getColumnHeatMap(i);
-
-		if (!opt) { // We are only interested in the columns that have heat map informations
-			continue;
-		}
+		let hm = this.getColumnHeatMap(i);
 
-		// default value of midPoint and mode
-		if(opt.midPoint === 0 && opt.mode === "cell") {
-			col.heatMap = true;
+		if (!hm) { // We are only interested in the columns that have heat map informations
 			continue;
 		}
 
-		let heatMap = col.heatMap = {};
-
-		if (opt.midPoint != null) {
-			heatMap.midPoint = opt.midPoint;
-		}
-
-		if (opt.mode != null) {
-			heatMap.mode = opt.mode;
+		let heatMap = col["heatMap"] = {};
+		if(this._getColumnHeatMapOptions(hm, heatMap)) {
+			col["heatMap"] = true; // All settings are at their default value
 		}
 	}
 
@@ -183,7 +174,23 @@ HeatMapPlugin.prototype.getColumnHeatMap = function (colIndex, grid) {
 	}
 	return null;
 };
-
+/** @private
+* @param {number|string} val
+* @param {*} defaultVal
+* @returns {*}
+*/
+HeatMapPlugin._toNumber = function (val, defaultVal) {
+	if(val != null) {
+		if(typeof val != "number") {
+			val = +val;
+			if(val !== val) { // NaN checking
+				return defaultVal;
+			}
+		}
+		return val;
+	}
+	return defaultVal;
+};
 /** @public
 * @param {number} colIndex
 * @param {Object} columnDef
@@ -192,42 +199,43 @@ HeatMapPlugin.prototype.getColumnHeatMap = function (colIndex, grid) {
 * plugin.setColumnHeatMap(1, {
 *   "field": "CF_LAST",
 *   "heatMap": {
-*     "midPoint": 0, // optional number
 *     "mode": "cell" // optional string (cell|text)
+*     "midPoint": 0, // optional number
+*     "min": -100, // optional number
+*     "max": 100 // optional number
 *   }
 * });
 */
 HeatMapPlugin.prototype.setColumnHeatMap = function (colIndex, columnDef, opt_grid) {
-	let hmMode = "";
-	let midPoint = 0;
+	const hmOptions = {};
 	let field = columnDef ? /** @type{string} */(columnDef["field"]) : "";
-	let hmOptions = field ? columnDef["heatMap"] || columnDef["heatmap"] : null;
-	if(hmOptions) {
-		let userMode = hmOptions["mode"] || hmOptions["type"];
-		hmMode = (typeof userMode == "string") ? userMode : "cell";
-
-		let userMidPoint = /** @type{number} */(hmOptions["midPoint"]);
-		if(typeof userMidPoint != "number") {
-			userMidPoint = +userMidPoint;
+	if(field) {
+		let userHeatMap = columnDef["heatMap"] || columnDef["heatmap"];
+		if(userHeatMap) {
+			let userMode = userHeatMap["mode"] || userHeatMap["type"];
+			hmOptions["mode"] = (typeof userMode == "string") ? userMode : "cell";
+
+			hmOptions["midPoint"] = HeatMapPlugin._toNumber(userHeatMap["midPoint"], 0);
+			hmOptions["min"] = HeatMapPlugin._toNumber(userHeatMap["min"], null);
+			hmOptions["max"] = HeatMapPlugin._toNumber(userHeatMap["max"], null);
 		}
-		midPoint = (userMidPoint) ? userMidPoint : 0;
 	}
+
 	if(opt_grid) {
-		this._setColumnHeatMap(opt_grid, colIndex, hmMode, midPoint, field);
+		this._setColumnHeatMap(opt_grid, colIndex, field, hmOptions);
 	} else {
 		for(let i = this._hosts.length; --i >= 0;) {
-			this._setColumnHeatMap(this._hosts[i], colIndex, hmMode, midPoint, field);
+			this._setColumnHeatMap(this._hosts[i], colIndex, field, hmOptions);
 		}
 	}
 };
 /** @private
 * @param {Object} grid core grid object
 * @param {number} colIndex
-* @param {string} hmMode
-* @param {number} midPoint
 * @param {string} field
+* @param {!Object} hmOptions
 */
-HeatMapPlugin.prototype._setColumnHeatMap = function (grid, colIndex, hmMode, midPoint, field) {
+HeatMapPlugin.prototype._setColumnHeatMap = function (grid, colIndex, field, hmOptions) {
 	let dv = grid.getDataSource();
 	if(!dv) {
 		return;
@@ -236,6 +244,7 @@ HeatMapPlugin.prototype._setColumnHeatMap = function (grid, colIndex, hmMode, mi
 	let colData = this._newColumnData(colIndex);
 	let painter = /** @type{CellPainter} */(colData["painter"]);
 
+	const hmMode = hmOptions["mode"]; // No mode means no heat map for the column
 	let cond, sect, rowCount, r, cell;
 	if(hmMode && field) { // Update or create new painter for heatMap
 		if(painter) {
@@ -258,10 +267,10 @@ HeatMapPlugin.prototype._setColumnHeatMap = function (grid, colIndex, hmMode, mi
 			painter = colData["painter"] = new CellPainter();
 		}
 
-		painter["midPoint"] = midPoint; // For saving
-		painter["mode"] = hmMode;
+		// Serialize user settings
+		this._getColumnHeatMapOptions(hmOptions, painter);
 
-		cond = painter.addHeatmapWithTheme(field, midPoint, (hmMode === "text"));
+		cond = painter.addHeatmapWithTheme(field, painter["midPoint"] || 0, (hmMode === "text"));
 		cond.refId = "_hm" + HeatMapPlugin._runningId++;
 
 		let colStats = dv.enableColumnStats(field, true, cond.refId);
@@ -272,44 +281,63 @@ HeatMapPlugin.prototype._setColumnHeatMap = function (grid, colIndex, hmMode, mi
 
 		grid.enableColumnClass(colIndex, "heat-map", true);
 		grid["requestRowRefresh"]();
-	} else {
-		if(painter) {
-			if(this._clearPainter(colData, grid)) {
-				// Clear existing heatMap styles
-				grid.enableColumnClass(colIndex, "heat-map", false);
-				sect = grid.getSection("content");
-				rowCount = sect.getRowCount();
-				for(r = 0; r < rowCount; ++r) {
-					cell = sect.getCell(colIndex, r, false);
-					if(cell) {
-						cell.setStyle("color", "");
-						cell.setStyle("backgroundColor", "");
-					}
+	} else if(painter) {
+		if(this._clearPainter(colData, grid)) {
+			// Clear existing heatMap styles
+			grid.enableColumnClass(colIndex, "heat-map", false);
+			sect = grid.getSection("content");
+			rowCount = sect.getRowCount();
+			for(r = 0; r < rowCount; ++r) {
+				cell = sect.getCell(colIndex, r, false);
+				if(cell) {
+					cell.setStyle("color", "");
+					cell.setStyle("backgroundColor", "");
 				}
 			}
 		}
 	}
 };
 /** @public
+* @param {!Object} hm HeatMap configuration object
+* @param {Object=} options
+* @return {boolean} Returns true if all settings are at their default value
+*/
+HeatMapPlugin.prototype._getColumnHeatMapOptions = function(hm, options) {
+	if(hm) {
+		let isDefault = true;
+		if(!options) { options = {}; }
+		let val = hm["midPoint"];
+		if(val != null && val !== 0) {
+			options["midPoint"] = val;
+			isDefault = false;
+		}
+		val = hm["mode"];
+		if(val != null && val !== "cell") {
+			options["mode"] = val;
+			isDefault = false;
+		}
+		val = hm["min"];
+		if(val != null) {
+			options["min"] = val;
+			isDefault = false;
+		}
+		val = hm["max"];
+		if(val != null) {
+			options["max"] = val;
+			isDefault = false;
+		}
+		return isDefault;
+	}
+	return false;
+};
+/** @public
 * @param {number} colIndex
 * @param {Object=} options
 * @return {!Object}
-* @example
-* var obj = {
-*  "heatMap": {
-*    "midPoint": 0, // optional number
-*    "mode": "cell", // optional string
-*  }
-* };
 */
 HeatMapPlugin.prototype.getColumnHeatMapOptions = function(colIndex, options) {
 	if(!options) { options = {}; }
-
-	let hm = this.getColumnHeatMap(colIndex);
-	if(hm) {
-		options["midPoint"] = hm["midPoint"];
-		options["mode"] = hm["mode"];
-	}
+	this._getColumnHeatMapOptions(this.getColumnHeatMap(colIndex), options);
 	return options;
 };
 
@@ -360,8 +388,8 @@ HeatMapPlugin.prototype._onSectionBinding = function (e) {
 		let painter = this.getColumnHeatMap(c, grid);
 		if(painter) {
 			let columnStats = painter.getColumnStats();
-			let min = columnStats.getMin();
-			let max = columnStats.getMax();
+			let min = painter["min"] != null ? painter["min"] : columnStats.getMin();
+			let max = painter["max"] != null ? painter["max"] : columnStats.getMax();
 			for (let r = fromR; r < toR; ++r) {
 				let cell = section.getCell(c, r, false);
 				if(cell) {

package/lib/tr-grid-row-grouping/es6/RowGrouping.js

@@ -1305,11 +1305,9 @@ RowGroupingPlugin.prototype._updateDisplayColumn = function () {
 */
 RowGroupingPlugin.prototype._getColumnSizeLimit = function (section) {
 	if (!this._headerSpanning && section) {
-		let cell = section.getCell(this._headerColumn, 0, false);
-		if(cell) {
-			let sizeLimit = cell.getWidth() - 27; // Ensure padding will subtract icon width (25px for halo, 27px for solar)
-			return sizeLimit > 0 ? sizeLimit : 0;
-		}
+		const columnWidth = section.getColumnWidth(this._headerColumn);
+		let sizeLimit = columnWidth - 27; // Ensure padding will subtract icon width (25px for halo, 27px for solar)
+		return sizeLimit > 0 ? sizeLimit : 0;
 	}
 	return -1; // Negative value means no limit
 };

package/lib/versions.json

@@ -18,14 +18,14 @@
 	"tr-grid-content-wrap": "1.0.20",
 	"tr-grid-contextmenu": "1.0.44",
 	"tr-grid-filter-input": "0.9.43",
-	"tr-grid-heat-map": "1.0.30",
+	"tr-grid-heat-map": "1.0.33",
 	"tr-grid-in-cell-editing": "1.0.94",
 	"tr-grid-pagination": "1.0.24",
 	"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.90",
-	"tr-grid-row-grouping": "1.0.89",
+	"tr-grid-row-grouping": "1.0.91",
 	"tr-grid-row-selection": "1.0.33",
 	"tr-grid-rowcoloring": "1.0.26",
 	"tr-grid-textformatting": "1.0.49",

package/package.json

@@ -77,5 +77,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.1.17"
+	"version": "6.1.19"
 }