@refinitiv-ui/efx-grid 6.0.130 → 6.0.132

package/lib/grid/index.js

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

package/lib/tr-grid-auto-tooltip/es6/AutoTooltip.js

@@ -2,7 +2,10 @@ import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 
-var isSafari = navigator.vendor &&
+/** @private
+* @type {boolean}
+*/
+let isSafari = navigator.vendor &&
 	navigator.vendor.indexOf('Apple') > -1 &&
 	navigator.userAgent &&
 	navigator.userAgent.indexOf('CriOS') == -1 &&
@@ -26,7 +29,7 @@ var isSafari = navigator.vendor &&
 * @param {AutoTooltipPlugin~Options=} options
 * @extends {GridPlugin}
 */
-var AutoTooltipPlugin = function (options) {
+let AutoTooltipPlugin = function (options) {
 	this.applyTooltipToAllColumns = this.applyTooltipToAllColumns.bind(this);
 	this._onPreSectionDataBinding = this._onPreSectionDataBinding.bind(this);
 	this._onPostSectionDataBinding = this._onPostSectionDataBinding.bind(this);
@@ -62,7 +65,7 @@ AutoTooltipPlugin._isColumnVisible = function(column) {
 		return false;
 	}
 
-	var colElem = column.getElement();
+	let colElem = column.getElement();
 	if(!colElem) {
 		return false;
 	}
@@ -75,7 +78,7 @@ AutoTooltipPlugin._isColumnVisible = function(column) {
 * @return {boolean}
 */
 AutoTooltipPlugin._isUpdateRequired = function(hosts) {
-	var len = hosts.length;
+	let len = hosts.length;
 	if(len <= 0 || isSafari) {
 		return false;
 	}
@@ -147,7 +150,7 @@ AutoTooltipPlugin.prototype.initialize = function (host, options) {
 * @param {Object} host core grid
 */
 AutoTooltipPlugin.prototype.unload = function (host) {
-	var at = this._hosts.indexOf(host);
+	let at = this._hosts.indexOf(host);
 	if (at < 0) { return; }
 	this._hosts.splice(at, 1);
 
@@ -170,10 +173,10 @@ AutoTooltipPlugin.prototype.unload = function (host) {
 AutoTooltipPlugin.prototype.config = function (options) {
 	if (!options) { return; }
 
-	var extOptions = options.autoTooltip;
+	let extOptions = options.autoTooltip;
 	if(extOptions) {
 		// header is alias of title
-		var val = extOptions["title"] || extOptions["header"];
+		let val = extOptions["title"] || extOptions["header"];
 		if (val != null) {
 			this._title = val ? true : false;
 		}
@@ -189,10 +192,10 @@ AutoTooltipPlugin.prototype.config = function (options) {
 	}
 
 	// Retrive auto tooltip data from columns
-	var columns = options["columns"];
+	let columns = options["columns"];
 	if (columns) {
-		var len = columns.length;
-		for (var c = 0; c < len; ++c) {
+		let len = columns.length;
+		for (let c = 0; c < len; ++c) {
 			this._configColumn(c, columns[c]);
 		}
 	}
@@ -203,27 +206,27 @@ AutoTooltipPlugin.prototype.config = function (options) {
 * @return {!Object}
 */
 AutoTooltipPlugin.prototype.getConfigObject = function (gridOptions) {
-	var obj = gridOptions || {};
+	let obj = gridOptions || {};
 
-	var columns = obj.columns;
+	let columns = obj.columns;
 	if(!columns) {
 		columns = obj.columns = [];
 	}
 
-	var len = this.getColumnCount();
-	for(var i = 0; i < len; ++i) {
-		var column = columns[i];
+	let len = this.getColumnCount();
+	for(let i = 0; i < len; ++i) {
+		let column = columns[i];
 		if(!column) {
 			column = columns[i] = {};
 		}
 
-		var colOptions = this._getColumnOption(i, "autoTooltip");
+		let colOptions = this._getColumnOption(i, "autoTooltip");
 		if(colOptions === true) {
 			column.autoTooltip = true;
 		}
 	}
 
-	var extOptions = obj.autoTooltip;
+	let extOptions = obj.autoTooltip;
 	if(!extOptions) {
 		extOptions = obj.autoTooltip = {};
 	}
@@ -249,7 +252,7 @@ AutoTooltipPlugin.prototype.getConfigObject = function (gridOptions) {
 */
 AutoTooltipPlugin.prototype._configColumn = function(colIndex, columnConfig) {
 	if(columnConfig) {
-		var val = columnConfig["autoTooltip"];
+		let val = columnConfig["autoTooltip"];
 		if (val != null) {
 			this._newColumnData(colIndex)["autoTooltip"] = val ? true : false;
 		}
@@ -263,22 +266,22 @@ AutoTooltipPlugin.prototype._configColumn = function(colIndex, columnConfig) {
 * @param {number=} toR End row index
 */
 AutoTooltipPlugin.prototype.applyTooltip = function (colIndex, fromR, toR) {
-	var hosts = this._hosts;
+	let hosts = this._hosts;
 	if(!AutoTooltipPlugin._isUpdateRequired(hosts)) {
 		return;
 	}
 
-	for (var i = 0; i < hosts.length; ++i) {
-		var host = this._hosts[i];
+	for (let i = 0; i < hosts.length; ++i) {
+		let host = this._hosts[i];
 		if (this._title) {
-			var titles = host.getAllSections("title");
-			for (var t = titles.length; --t >= 0;) {
+			let titles = host.getAllSections("title");
+			for (let t = titles.length; --t >= 0;) {
 				this._updateNonContentSection(titles[t], colIndex);
 			}
 		}
 		if (this._footer) {
-			var footers = host.getAllSections("footer");
-			for (var j = footers.length; --j >= 0;) {
+			let footers = host.getAllSections("footer");
+			for (let j = footers.length; --j >= 0;) {
 				this._updateNonContentSection(footers[j], colIndex);
 			}
 		}
@@ -294,10 +297,10 @@ AutoTooltipPlugin.prototype.applyTooltip = function (colIndex, fromR, toR) {
 * @param {Array.<number>=} colIndices Column indices
 */
 AutoTooltipPlugin.prototype.applyTooltipToColumns = function (colIndices) {
-	var host = this._hosts ? this._hosts[0] : null;
+	let host = this._hosts ? this._hosts[0] : null;
 	if (host && host.getElement()) {
-		var len = colIndices ? colIndices.length : 0;
-		for (var i = 0; i < len; ++i) {
+		let len = colIndices ? colIndices.length : 0;
+		for (let i = 0; i < len; ++i) {
 			this.applyTooltip(colIndices[i]);
 		}
 	}
@@ -308,8 +311,8 @@ AutoTooltipPlugin.prototype.applyTooltipToColumns = function (colIndices) {
 */
 AutoTooltipPlugin.prototype.applyTooltipToAllColumns = function () {
 	this._applyTimer = 0;
-	var colCount = this.getColumnCount();
-	for (var c = 0; c < colCount; ++c) {
+	let colCount = this.getColumnCount();
+	for (let c = 0; c < colCount; ++c) {
 		this.applyTooltip(c);
 	}
 };
@@ -343,17 +346,17 @@ AutoTooltipPlugin.prototype._requestNonContentSectionUpdate = function () {
 		return;
 	}
 
-	var hosts = this._hosts;
+	let hosts = this._hosts;
 	if(!AutoTooltipPlugin._isUpdateRequired(hosts)) {
 		return;
 	}
 
 	this._nonContentSectionUpdated = true;
 
-	var colCount = this.getColumnCount();
-	var sections, s, c;
-	for(var i = 0; i < hosts.length; ++i) {
-		var host = hosts[i];
+	let colCount = this.getColumnCount();
+	let sections, s, c;
+	for(let i = 0; i < hosts.length; ++i) {
+		let host = hosts[i];
 
 		sections = host.getAllSections("title");
 		for(s = 0; s < sections.length; s++) {
@@ -379,15 +382,15 @@ AutoTooltipPlugin.prototype._requestContentSectionUpdate = function () {
 		return;
 	}
 
-	var hosts = this._hosts;
+	let hosts = this._hosts;
 	if(!AutoTooltipPlugin._isUpdateRequired(hosts)) {
 		return;
 	}
 
-	var colCount = this.getColumnCount();
-	for(var i = 0; i < hosts.length; ++i) {
-		var section = hosts[i].getSection("content");
-		for(var c = 0; c < colCount; c++) {
+	let colCount = this.getColumnCount();
+	for(let i = 0; i < hosts.length; ++i) {
+		let section = hosts[i].getSection("content");
+		for(let c = 0; c < colCount; c++) {
 			if(this._isTooltipCandidate(c)) {
 				this._updateContentSection(section, c);
 			}
@@ -404,20 +407,20 @@ AutoTooltipPlugin.prototype._requestContentSectionUpdate = function () {
 AutoTooltipPlugin.prototype._updateNonContentSection = function (section, colIndex) {
 	if(!section) { return false; }
 
-	var column = section.getColumn(colIndex);
+	let column = section.getColumn(colIndex);
 	if(!AutoTooltipPlugin._isColumnVisible(column)) {
 		return false;
 	}
 
-	var rowCount = section.getRowCount();
-	for(var r = 0; r < rowCount; ++r) {
-		var cell = section.getCell(colIndex, r, false); // Ignore cell span
+	let rowCount = section.getRowCount();
+	for(let r = 0; r < rowCount; ++r) {
+		let cell = section.getCell(colIndex, r, false); // Ignore cell span
 		if(!cell || !cell.isVisible()) { return false; }
 
-		var elem = cell.getContent();
+		let elem = cell.getContent();
 		if(!elem) { return false; }
 
-		var tooltipInfo = cell.getTooltipInfo();
+		let tooltipInfo = cell.getTooltipInfo();
 		if(tooltipInfo) {
 			if(tooltipInfo["userTooltip"] != null ||
 				tooltipInfo["groupHeaderDefault"] != null ||
@@ -430,11 +433,11 @@ AutoTooltipPlugin.prototype._updateNonContentSection = function (section, colInd
 		}
 
 		// Set tooltip only if text's length is longer than column width.
-		var sw = elem.scrollWidth;
+		let sw = elem.scrollWidth;
 		if(sw && sw > elem.offsetWidth) {
 			cell.setTooltipInfo("clippedText", true);
 
-			var tooltip = cell.getTextContent();
+			let tooltip = cell.getTextContent();
 			cell.setTooltipInfo("clippedTextTooltip", tooltip);
 			cell.setAttribute("ef-title", tooltip);
 		} else {
@@ -471,7 +474,7 @@ AutoTooltipPlugin.prototype._updateContentSection = function (section, colIndex,
 		return false;
 	}
 
-	var columnObj = section.getColumn(colIndex);
+	let columnObj = section.getColumn(colIndex);
 	if (!columnObj) {
 		return false;
 	}
@@ -480,24 +483,24 @@ AutoTooltipPlugin.prototype._updateContentSection = function (section, colIndex,
 		return false;
 	}
 
-	var colElem = columnObj.getElement();
+	let colElem = columnObj.getElement();
 	if (!colElem) {
 		return false;
 	}
 
-	for (var r = fromR; r < toR; ++r) {
-		var cell = section.getCell(colIndex, r, false); // Ignore cell span
+	for (let r = fromR; r < toR; ++r) {
+		let cell = section.getCell(colIndex, r, false); // Ignore cell span
 		if (cell && cell.isVisible()) {
 
 			if (cell._userDefinedTooltip == null) {
-				var tooltipProp = cell.getTooltip() || cell.getAttribute('ef-title');
+				let tooltipProp = cell.getTooltip() || cell.getAttribute('ef-title');
 				cell._userDefinedTooltip = tooltipProp || '';
 			}
 
-			var elem = cell.getContent();
-			var tooltip = "";
+			let elem = cell.getContent();
+			let tooltip = "";
 			if (elem) {
-				var sw = elem.scrollWidth;
+				let sw = elem.scrollWidth;
 
 				// Set tooltip only if text's length is longer than column width.
 				if (sw && sw > elem.offsetWidth) {
@@ -533,8 +536,8 @@ AutoTooltipPlugin.prototype._clearTooltipCache = function (section, colIndex, fr
 		return;
 	}
 
-	for (var rowIndex = fromRowIndex; rowIndex < toRowIndex; rowIndex++) {
-		var cell = section.getCell(colIndex, rowIndex);
+	for (let rowIndex = fromRowIndex; rowIndex < toRowIndex; rowIndex++) {
+		let cell = section.getCell(colIndex, rowIndex);
 		// if isDataChange = true
 		if (isDataChange || (cell && cell._userDefinedTooltip != null)) {
 			cell._userDefinedTooltip = null;
@@ -549,7 +552,7 @@ AutoTooltipPlugin.prototype._clearTooltipCache = function (section, colIndex, fr
 			if (cell._previousPos === rowIndex + '-' + colIndex
 				&& !isDataChange // in case isDataChange be true then we need to clear all tooltip cache in else block
 			) {
-				var tooltip = cell.getTooltip() || cell.getAttribute('ef-title');
+				let tooltip = cell.getTooltip() || cell.getAttribute('ef-title');
 				if (tooltip) {
 					cell.removeAttribute('ef-title');
 					cell.setTooltip(tooltip);
@@ -565,27 +568,27 @@ AutoTooltipPlugin.prototype._clearTooltipCache = function (section, colIndex, fr
 };
 
 /** @private
-* @param {Event} e event from preSectionDataBinding
+* @param {Object} e event from preSectionDataBinding
 */
 AutoTooltipPlugin.prototype._onPreSectionDataBinding = function (e) {
 	if (e && e.sectionType === "content") {
-		var colCount = this.getColumnCount();
-		var isDataChange = e.actualUpdate === true;
-		for (var c = 0; c < colCount; ++c) {
+		let colCount = this.getColumnCount();
+		let isDataChange = e.actualUpdate === true;
+		for (let c = 0; c < colCount; ++c) {
 			this._clearTooltipCache(e.section, c, e.fromRowIndex, e.toRowIndex, isDataChange);
 		}
 	}
 };
 
 /** @private
-* @param {Event} e event from preSectionDataBinding
+* @param {Object} e event from preSectionDataBinding
 */
 AutoTooltipPlugin.prototype._onPostSectionDataBinding = function (e) {
 	this._requestAllSectionsUpdate();
 };
 
 /** @private
-* @param {Event|Element} e
+* @param {Object} e
 */
 AutoTooltipPlugin.prototype._onColumnAdded = function(e) {
 	if(e.context && e.colIndex != null) {
@@ -601,7 +604,7 @@ AutoTooltipPlugin.prototype._onColumnAdded = function(e) {
 * @return {boolean}
 */
 AutoTooltipPlugin.prototype._isTooltipCandidate = function (colIndex) {
-	var bool = this._getColumnOption(colIndex, "autoTooltip");
+	let bool = this._getColumnOption(colIndex, "autoTooltip");
 	if(bool != null) {
 		return bool ? true : false;
 	}

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.d.ts

@@ -1,11 +1,14 @@
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
-import { cloneObject, injectCss, prettifyCss, deepEqual } from "../../tr-grid-util/es6/Util.js";
+import { cloneObject, injectCss, prettifyCss, deepEqual, isEmptyObject } from "../../tr-grid-util/es6/Util.js";
 
 declare namespace ColumnGroupingPlugin {
 
-    type Options = (ColumnGroupingPlugin.GroupDefinition)[]|null;
+    type Options = {
+        groupDefinitions: ColumnGroupingPlugin.GroupDefinitions|null,
+        minChildCount?: number|null
+    };
 
     type GroupDefinitions = (ColumnGroupingPlugin.GroupDefinition)[]|null;
 

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.js

@@ -1,10 +1,12 @@
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
-import { cloneObject, injectCss, prettifyCss, deepEqual } from "../../tr-grid-util/es6/Util.js";
+import { cloneObject, injectCss, prettifyCss, deepEqual, isEmptyObject } from "../../tr-grid-util/es6/Util.js";
 
-/** @typedef {Array<ColumnGroupingPlugin~GroupDefinition>} ColumnGroupingPlugin~Options
+/** @typedef {Object} ColumnGroupingPlugin~Options
 * @description This options can be specified by `columnGrouping` property of the main grid's options or extension options.
+* @property {ColumnGroupingPlugin~GroupDefinitions} groupDefinitions A collection of group definition objects
+* @property {number=} minChildCount=2 The minimum number of child columns required for group to be visible
 */
 
 /** @typedef {Array<ColumnGroupingPlugin~GroupDefinition>} ColumnGroupingPlugin~GroupDefinitions
@@ -89,6 +91,10 @@ ColumnGroupingPlugin.prototype._legacyColumnGroups = null;
 * @private
 */
 ColumnGroupingPlugin.prototype._selectedColMap;
+/** @type {number}
+* @private
+*/
+ColumnGroupingPlugin.prototype._minChildCount = 2;
 
 /** @private
 * @param {number} a
@@ -334,7 +340,17 @@ ColumnGroupingPlugin.prototype.config = function (options) {
 	let extOptions = options["columnGrouping"];
 	let groupDefs = null;
 	if(Array.isArray(extOptions)) {
-		groupDefs = extOptions.filter(ColumnGroupingPlugin._hasGroupId);
+		groupDefs = extOptions;
+	} else if(typeof extOptions === "object") {
+		groupDefs = extOptions["groupDefinitions"];
+		let minChildCount = extOptions["minChildCount"];
+		if(typeof minChildCount === "number" && minChildCount > 0) {
+			this._minChildCount = minChildCount;
+		}
+	}
+
+	if(groupDefs) {
+		groupDefs = groupDefs.filter(ColumnGroupingPlugin._hasGroupId);
 		groupDefs = groupDefs.map(ColumnGroupingPlugin._cloneObject);
 	}
 
@@ -355,11 +371,26 @@ ColumnGroupingPlugin.prototype.config = function (options) {
 ColumnGroupingPlugin.prototype.getConfigObject = function (gridOptions) {
 	let obj = gridOptions || {};
 
+	let extOptions = {};
+
 	// TODO: Handle legacyRender method that has been migrated
 	let groupDefs = this.getGroupDefinitions();
 	groupDefs = groupDefs.filter(ColumnGroupingPlugin._isNotTimeSeriesGroup);
 	if(groupDefs.length) {
-		obj.columnGrouping = groupDefs;
+		extOptions.groupDefinitions = groupDefs;
+	}
+
+	if(this._minChildCount !== 2) {
+		extOptions.minChildCount = this._minChildCount;
+	}
+
+	if(!isEmptyObject(extOptions)) {
+		let extUserOptions = obj.columnGrouping;
+		if(extUserOptions != null && typeof extUserOptions === "object") {
+			Object.assign(extUserOptions, extOptions);
+		} else {
+			obj.columnGrouping = extOptions;
+		}
 	}
 
 	return obj;
@@ -669,6 +700,7 @@ ColumnGroupingPlugin.prototype._verifySingleChild = function(groupMap) {
 		validIds[groupIds[i]] = 1;
 	}
 
+	let minChildCount = this._minChildCount;
 	let removable = true;
 	while(removable){
 		removable = false;
@@ -689,7 +721,7 @@ ColumnGroupingPlugin.prototype._verifySingleChild = function(groupMap) {
 				}
 			}
 
-			if(validChildren.length < 2) {
+			if(validChildren.length < minChildCount) {
 				delete groupMap[groupId];
 				validIds[groupId] = 0;
 				removable = true;

package/lib/tr-grid-range-bar/es6/LEDGuage.d.ts

@@ -0,0 +1,39 @@
+
+
+declare namespace LEDGuage {
+
+    type RangeValues = {
+        low?: number|null,
+        last?: number|null,
+        high?: number|null,
+        close?: number|null,
+        vwap?: number|null,
+        tick?: number|null
+    };
+
+}
+
+declare class LEDGuage {
+
+    constructor();
+
+    public static createElementWithText(text?: string|null): Element|null;
+
+    public setPriceGraph(priceGraph?: boolean|null): void;
+
+    public setRangeValue(rangeBarData: LEDGuage.RangeValues|null): void;
+
+    public isNoRangeValue(): boolean;
+
+    public isHighLowEqual(): boolean;
+
+    public isInvalidRangeValue(): boolean;
+
+    public getEqualRangeElement(): Element|null;
+
+    public getLEDGuageElement(): Element|null;
+
+}
+
+export default LEDGuage;
+export { LEDGuage };