@refinitiv-ui/efx-grid 6.0.145 → 6.0.147

package/lib/core/es6/grid/Core.js

@@ -75,6 +75,7 @@ let _createHiddenInput = function () {
 	styleObj.width = styleObj.height = styleObj.padding = styleObj.border = "0";
 	hiddenInput.value = "0";
 	hiddenInput.role = "grid";
+	hiddenInput.readOnly = true;
 	return hiddenInput;
 };
 /** @private
@@ -621,7 +622,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.136";
+	return "5.1.137";
 };
 /** {@link ElementWrapper#dispose}
 * @override

package/lib/grid/index.js

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

package/lib/rt-grid/dist/rt-grid.js

@@ -3318,6 +3318,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
@@ -3481,9 +3490,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();
@@ -3735,7 +3743,8 @@ ElfUtil._profileNameRetrieved = function() {
 };
 
 /** Get theme colors from document
-* @private
+* @public
+* @ignore
 * @param {string} profileName Movement color profile name
 */
 ElfUtil._retrieveThemeColors = function(profileName) {
@@ -47206,7 +47215,7 @@ Grid_Grid.prototype._cloneChain = function(newRowDef) {
 		"subId": subId
 	};
 	for (let i = 0; i < count; i++) {
-		let childRowDef = constituents[i]; // TODO: the constituents should be sorted by CHILD_ORDER first
+		let childRowDef = constituents[i];
 		evtArg["ric"] = childRowDef.getRic();
 		evtArg["values"] = childRowDef.cloneRowData();
 		evtArg["values"]["SUB_ID"] = subId; // Imitate real-time service responses
@@ -49933,6 +49942,7 @@ let _fieldInfo = {
 	"PRCTCK_1": {type: "set", members: ["\u21e7", "B\u21e7", "\u2191", "B\u2191", "26", "1", "\"1\"", "-1", "\u21e9", "B\u21e9", "\u2193", "B\u2193", "27", "2", "\"2\""] },
 	"CF_NETCHNG": {type: "number", min: -100, max: 100},
 	"CF_VOLUME": {type: "number", min: 0, max: 1e7},
+	"CHILD_ORDER": {type: "set", ignore: true, members: [undefined]}, // eslint-disable-line
 	"RI_FLAG": {type: "set", members: ["R", "Q", "I", "_", ""]},
 	"RI_CODE": {type: "number", min: 0, max: 2},
 	"STATUS": {type: "number", min: 0, max: 6},
@@ -50097,8 +50107,12 @@ let randBoolean = function(seed) {
 * @return {*}
 */
 let randMember = function(set, seed) {
-	if(set) {
-		let index = randIndex(set.length, seed);
+	var len = set ? (set.length || 0) : 0;
+	if(len) {
+		if(len === 1) {
+			return set[0];
+		}
+		let index = randIndex(len, seed);
 		return set[index];
 	}
 	return String.fromCharCode(randInt(65, 90, seed));
@@ -51217,6 +51231,10 @@ MockSubscriptions.prototype._maxInterval = 850;
 */
 MockSubscriptions.prototype._percentageDataUpdate = 0.1; // 10% by default
 /** @private
+* @type {number}
+*/
+MockSubscriptions.prototype._percentageOrderChange = 1; // 100%
+/** @private
 * @type {boolean}
 */
 MockSubscriptions.prototype._constituentCache = false;
@@ -51249,6 +51267,11 @@ MockSubscriptions.prototype.config = function(options) {
 		this._percentageDataUpdate = num / 100;
 	}
 
+	num = options.percentageOrderChange;
+	if(typeof num === "number") {
+		this._percentageOrderChange = num / 100;
+	}
+
 	let value = options.constituentCache;
 	if(value != null) {
 		this._constituentCache = value;
@@ -51277,6 +51300,15 @@ MockSubscriptions.prototype.setPercentageDataUpdate = function(percent) {
 	}
 };
 
+/** @public
+* @param {number=} percent
+*/
+MockSubscriptions.prototype.setPercentageOrderChanged = function(percent) {
+	if(typeof percent === "number") {
+		this._percentageOrderChange = Math.round(percent / 100);
+	}
+};
+
 /** @public
 * @param {number} seed
 */
@@ -51564,7 +51596,7 @@ MockSubscriptions.prototype._addSymbol = function(ric, asChain, subId) {
 				childSub["CHILD_ORDER"] = i;
 				this._dataMap.addItem(_joinSubKeys(sub, childSub), childSub);
 			}
-		} else {
+		} else { // Duplicate chain
 			let firstSub = subs[0];
 			let constituents = firstSub["children"];
 			childCount = constituents.length;
@@ -51612,7 +51644,6 @@ MockSubscriptions.prototype._connect = function() {
 	}
 };
 
-/** @private */
 MockSubscriptions.prototype._onSubscriptionResponse = function() {
 	this._timerId = 0;
 
@@ -51630,57 +51661,66 @@ MockSubscriptions.prototype._onSubscriptionResponse = function() {
 	let numRows = this._dataGen.randInt(minRow, maxRow);
 	let fields = this._fields;
 
+	let updateCount = 0;
+	let childOrderChange;
 	for(let i = 0; i < numRows; i++) {
+		// find key to random subs (key is subId)
 		let key = keys[this._dataGen.randIndex(len)]; // WARNING: Same sub could be picked more than once
 		let subs = this._dataMap.getItems(key); // Get all subs with the same RIC
+		let subCount = subs.length;
 
-		let sub = subs[0]; // Only the first sub is need to generate data
-		let subParent = sub.parent;
-		let updatePosition = this._dataGen.randBoolean(); // Flag for change CHILD_ORDER position
+		let j;
+		let firstSub = subs[0]; // Only the first sub is need to generate data
+		let subParent = firstSub.parent;
+		let updatePosition = this._dataGen.randInt(0, 100) < this._percentageOrderChange * 100 ? true : false; // Random chance to change dynamic chain position (2% to change)
 
-		let values, j, jLen;
-		if(_isDynamicChain(key) && subParent && updatePosition) { // subParent in header of dynamic chain is behavior like a normal ric
-			// TODO: support rate of ordering is changed
+		let values = this._generateQuoteData(firstSub, fields);
+		if(_isDynamicChain(key) && subParent && updatePosition) { // subParent in header of dynamic chain behaves like a normal ric
 			let children = subParent.children;
+			let childCount = children.length;
 
-			children = _shuffleArray(children);
-			let childrenLen = children.length;
-			let subIndex = children.indexOf(sub);
-			sub["CHILD_ORDER"] = subIndex;
-
-			values = this._generateQuoteData(sub, fields);
+			children = _shuffleArray(children); // Random swap children in array
+			let newOrder = children.indexOf(firstSub);
+			firstSub["CHILD_ORDER"] = newOrder; // This is bad
+			values["CHILD_ORDER"] = newOrder;
 
-			jLen = subs.length;
-			for(j = 0; j < jLen; ++j) { // It could be same ric and it need to dispatch with same ric number
-				for (let k = 0; k < childrenLen; k++) {
-					let child = children[k];
-					if(subs[j] === child) {
-						values["CHILD_ORDER"] = child["CHILD_ORDER"];
-						this._dispatchDataChanged(subs[j], values);
-					} else {
-						let currentChild = child["CHILD_ORDER"];
-						this._dispatchDataChanged(child, {
-							X_RIC_NAME: child.ric,
-							CHILD_ORDER: currentChild
+			childOrderChange = true;
+			for(j = 0; j < subCount; ++j) { // It could be same ric and it need to dispatch with same ric number
+				this._dispatchDataChanged(subs[j], values);
+				// Update child order for all children with the same parent
+				for (let k = 0; k < childCount; k++) { // This is not correct, if there is a duplicate dynamic chain
+					if(k !== newOrder) {
+						this._dispatchDataChanged(children[k], {
+							X_RIC_NAME: children[k].ric,
+							CHILD_ORDER: k
 						});
 					}
 				}
-				this._dispatchPostUpdate({ childOrderChange: true });
 			}
-
 		} else {
-			values = this._generateQuoteData(sub, fields);
-			jLen = subs.length;
-			for(j = 0; j < jLen; ++j) { // It could be same ric and it need to dispatch with same ric number
-				let childOrder = subs[j]["CHILD_ORDER"];
+			if(subCount > 1) { // Duplicate CHILD_ORDER from the first sub for other sub with the same RIC (not entirely correct)
+				let childOrder = firstSub["CHILD_ORDER"];
 				if(childOrder != null) { // Children of chain will have a CHILD_ORDER
 					values["CHILD_ORDER"] = childOrder;
 				}
+			}
+			for(j = 0; j < subCount; ++j) { // It could be same ric and it need to dispatch with same ric number
 				this._dispatchDataChanged(subs[j], values);
+				updateCount++;
 			}
 		}
 	}
 
+	let postObj = {};
+	if(childOrderChange != null) {
+		postObj["childOrderChange"] = childOrderChange;
+	}
+	if(updateCount != null) {
+		postObj["updateCount"] = updateCount;
+	}
+
+	this._dispatchPostUpdate(postObj);
+
 	this._connect();
 };
 
@@ -51707,20 +51747,24 @@ MockSubscriptions.prototype._generateQuoteData = function(sub, fields) {
 		prefix: sub["parent"] ? sub["parent"]["ric"] : "" // prefix for constituents
 	};
 	for(let field in fields){
-		let data = this._dataGen.generateQuoteData(field, options);
+		let fInfo = this._dataGen.generateQuoteData(field, options);
+		if(fInfo.ignore) {
+			continue;
+		}
+
 		let formattedField = field + "_FORMATTED";
 		if(prevData) {
-			if(data.changeOnly) {
-				if(prevData[field] === data.value) {
+			if(fInfo.changeOnly) {
+				if(prevData[field] === fInfo.value) {
 					continue;
 				}
 			}
-			prevData[field] = data.value;
-			prevData[formattedField] = data.formattedValue;
+			prevData[field] = fInfo.value;
+			prevData[formattedField] = fInfo.formattedValue;
 		}
 
-		values[field] = data.value;
-		values[formattedField] = data.formattedValue;
+		values[field] = fInfo.value;
+		values[formattedField] = fInfo.formattedValue;
 	}
 
 	// The delay symbol for X_RIC_NAME will depend on the INDICATOR field.
@@ -52948,14 +52992,25 @@ ExpressionParser.parse = function(expression) {
 * @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}
@@ -53078,25 +53133,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 */
@@ -53107,12 +53144,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;
@@ -53133,12 +53164,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
@@ -53154,6 +53184,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() {
@@ -53221,7 +53259,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]);
 	}
@@ -53313,6 +53351,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;
@@ -53439,20 +53478,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"] || "";
 	}
@@ -53573,11 +53606,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;
@@ -53586,10 +53616,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"] || "";
 		}
@@ -53641,10 +53667,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;
 			}
 
@@ -53777,9 +53805,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;
@@ -53862,9 +53888,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
@@ -53918,10 +53943,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);
@@ -53999,7 +54021,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.
@@ -54025,32 +54048,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;
 };
 
 /**