@refinitiv-ui/efx-grid 6.0.86 → 6.0.88

package/lib/rt-grid/es6/RowDefinition.js

@@ -16,6 +16,7 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @property {(string|null)=} label=null
 * @property {boolean=} hidden=true When this row is hidden
 * @property {boolean=} realTime=true Realtime row, able to request for JET/RTK
+* @property {Object=} info=null For storing any additional information to the row
 */
 
 /** @typedef {Object} RowDefinition~RowTypes
@@ -31,13 +32,13 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @public
 * @const
 */
-var ROW_DEF = "ROW_DEF";
+const ROW_DEF = "ROW_DEF";
 
 /** @type {!RowDefinition~RowTypes}
 * @public
 * @const
 */
-var ROW_TYPES = {
+const ROW_TYPES = {
 	CONTENT: "CONTENT",
 	CHAIN: "CHAIN",
 	CONSTITUENT: "CONSTITUENT",
@@ -49,7 +50,7 @@ var ROW_TYPES = {
 /** @constructor
 * @param {RowDefinition~Options=} rowOptions
 */
-var RowDefinition = function(rowOptions) {
+let RowDefinition = function(rowOptions) {
 	this._changes = {};
 	if(rowOptions && rowOptions["segmentId"]) { // This row will be classification header row
 		this._dataId = this._rowId = rowOptions["segmentId"];
@@ -116,7 +117,7 @@ RowDefinition.prototype._dataId = ""; // Data id can be different from rowId for
 * @private
 */
 RowDefinition.prototype._dc = null;
-/** @type {DataTable}
+/** @type {DataView}
 * @private
 */
 RowDefinition.prototype._view = null;
@@ -172,6 +173,11 @@ RowDefinition.prototype._depthLevel = 0;
 * @private
 */
 RowDefinition.prototype._userModel = null;
+/** @type {Object}
+* @private
+*/
+RowDefinition.prototype._info = null;
+
 //#endregion Private Members
 
 /** @public
@@ -191,7 +197,7 @@ RowDefinition.prototype.dispose = function() {
 	this._depthLevel = 0;
 	this.unsubscribeForUpdates();
 	if(this._dc) {
-		var rowData = this.getRowData();
+		let rowData = this.getRowData();
 		if(rowData) {
 			rowData[ROW_DEF] = null;
 		}
@@ -217,9 +223,9 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 		return;
 	}
 
-	var extractedOptions = RowDefinition.extractRowOptions(rowOptions);
+	let extractedOptions = RowDefinition.extractRowOptions(rowOptions);
 
-	var val = rowOptions["permId"];
+	let val = rowOptions["permId"];
 	if(val != null) {
 		this._permId = val;
 	}
@@ -248,7 +254,7 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	}
 
 	val = rowOptions["collapsed"];
-	var collapsed = extractedOptions["collapsed"];
+	let collapsed = extractedOptions["collapsed"];
 	if(val != null || !collapsed){
 		this._expanded = !collapsed;
 	}
@@ -256,8 +262,12 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	if(val) {
 		this._userModel = rowOptions;
 	}
+	val = rowOptions["info"];
+	if(val) {
+		this._info = val;
+	}
 
-	var symbol = this._ric || this._chainRic;
+	let symbol = this._ric || this._chainRic;
 	if(symbol || this._permId){
 		this.setContent(symbol, extractedOptions); // this._dataId is modified
 	}
@@ -273,19 +283,19 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 */
 RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 	this._autoGenerated = true;
-	var parentDef = /** @type{RowDefinition} */(rowOptions["parent"]);
+	let parentDef = /** @type{RowDefinition} */(rowOptions["parent"]);
 	if(this.setParent(parentDef)) {
 		this._dataId = /** @type{string} */(rowOptions["dataId"]); // Constituent will have the same subId as its parent but with different ric
 		this._ric = /** @type{string} */(rowOptions["ric"]);
 		this._dc = parentDef._dc; // Parent chain must have data cache
 		if(this._dc) {
-			var rowData = this.getRowData(); // Do not trigger any data update
+			let rowData = this.getRowData(); // Do not trigger any data update
 			if(rowData) { // Row data from data cache must exist beforehand
 				rowData[ROW_DEF] = this;  // This is for easy referencing from data streaming, also for preventing duplication
 			}
 		}
 	}
-	var val = rowOptions["values"];
+	let val = rowOptions["values"];
 	// eslint-disable-next-line no-undefined
 	if(val !== undefined) {
 		this.setStaticRowData(val, rowOptions["fields"]);
@@ -308,8 +318,8 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 		userInput += "";
 	}
 
-	var dirty = (this._userInput !== userInput);
-	var permId = extractedOptions["permId"];
+	let dirty = (this._userInput !== userInput);
+	let permId = extractedOptions["permId"];
 	if(this._permId !== permId){
 		this._permId = permId || "";
 		dirty = true;
@@ -327,9 +337,9 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 	if(this._userInput.charAt(0) === "'") { // This is a row header
 		this._ric = this._chainRic = ""; // No ric for realtime request
 	} else {
-		var asChain = extractedOptions["asChain"];
-		var expanded = !extractedOptions["collapsed"];
-		var chainRic = extractedOptions["chainRic"];
+		let asChain = extractedOptions["asChain"];
+		let expanded = !extractedOptions["collapsed"];
+		let chainRic = extractedOptions["chainRic"];
 		if(asChain === true){
 			this._ric = expanded === false ? this._userInput : this._userInput.replace("0#", "");
 			this._expanded = expanded; // Only chain can be expanded by 0#
@@ -342,8 +352,8 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 
 	if(this._view) {
 		if(this._isChain){
-			var rid = this.getRowId();
-			var segmentId = this._view.getSegmentParentRowId(rid);
+			let rid = this.getRowId();
+			let segmentId = this._view.getSegmentParentRowId(rid);
 			if(segmentId){
 				this._view.removeSegmentChild(segmentId, rid);
 			}
@@ -363,7 +373,7 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 		if(this._dc) {
 			// This will work for runtime ric modification, but not for first initilization.
 			// Avoid losing the ROW_DEF pointer.
-			var rowData = {};
+			let rowData = {};
 			rowData[ROW_DEF] = this; // Enable tracking back and updating data
 			rowData["X_RIC_NAME"] = this.getDisplayText();
 			this.setRowData(rowData);
@@ -382,8 +392,8 @@ RowDefinition.prototype.getRowId = function() {
 * @return {RowDefinition~Options}
 */
 RowDefinition.prototype.getConfigObject = function(rowOptions) {
-	var obj = rowOptions || {};
-	var val = this._ric;
+	let obj = rowOptions || {};
+	let val = this._ric;
 	if(val) {
 		obj["ric"] = val;
 	}
@@ -394,8 +404,8 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 	}
 
 	val = this._realTime;
-	if(val !== true) {
-		obj["realTime"] = val;
+	if(!val) {
+		obj["realTime"] = false;
 	}
 
 	val = this._permId;
@@ -415,7 +425,7 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 
 	val = this._userModel;
 	if(val) {
-		obj["keepModel"] = obj;
+		obj["keepModel"] = obj; // This is bad
 	}
 
 	val = this._isChain;
@@ -434,6 +444,11 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["hidden"] = val;
 	}
 
+	val = this._info;
+	if(val) {
+		obj["info"] = this._info;
+	}
+
 	val = this._getStaticRowData();
 	if(val) {
 		obj["values"] = val;
@@ -441,15 +456,15 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 
 	// obtain the static values of constituent rows
 	if(this.isChain()) {
-		var children = this.getChildren();
+		let children = this.getChildren();
 		if(children) {
-			var childValues = val ? val[RowDefinition._childDataField] : {};
+			let childValues = val ? val[RowDefinition._childDataField] : {};
 			if(!childValues) {
 				childValues = {};
 			}
-			var dirty = false;
-			var len = children.length;
-			var i, rowDef, staticValues;
+			let dirty = false;
+			let len = children.length;
+			let i, rowDef, staticValues;
 			for(i = 0; i < len; i++) {
 				rowDef = children[i];
 				staticValues = rowDef._getStaticRowData();
@@ -486,11 +501,11 @@ RowDefinition.prototype.getType = function() {
 	} else if(this._parent) {
 		return ROW_TYPES.CONSTITUENT;
 	} else {
-		var dv = this._view;
+		let dv = this._view;
 		if(dv) {
-			var rid = this.getRowId();
-			var separator = dv.isSegmentSeparator(rid);
-			var level = dv.getSegmentLevel(rid);
+			let rid = this.getRowId();
+			let separator = dv.isSegmentSeparator(rid);
+			let level = dv.getSegmentLevel(rid);
 			if(separator) {
 				if(level === 1) {
 					return ROW_TYPES.GROUP_HEADER;
@@ -518,7 +533,7 @@ RowDefinition.prototype.setDataSource = function(dataSource) {
 		return;
 	}
 
-	var rowData = this.getRowData();
+	let rowData = this.getRowData();
 	if(!rowData) {
 		rowData = {};
 		rowData[ROW_DEF] = this; // Enable tracking back and updating data
@@ -624,7 +639,7 @@ RowDefinition.prototype.setData = function(field, value) {
 */
 RowDefinition.prototype._clearStaticData = function() {
 	if(this._staticValues) {
-		for(var key in this._staticValues) {
+		for(let key in this._staticValues) {
 			this._staticValues[key] = null;
 		}
 		if(this._dc) {
@@ -761,19 +776,19 @@ RowDefinition.prototype.subscribeForUpdates = function() {
 		return false;
 	}
 
-	var subs = this._dc ? this._dc.getSubscriptions() : null;
+	let subs = this._dc ? this._dc.getSubscriptions() : null;
 	if(!subs) {
 		return false;
 	}
 	// TODO: Check if the same subscription is being made.
-	var prevRowData = this.unsubscribeForUpdates();
+	let prevRowData = this.unsubscribeForUpdates();
 
 	if(this.isChain()) {
-		var symbol = this._chainRic;
+		let symbol = this._chainRic;
 		if(!symbol){
 			symbol = this._ric;
 			if(symbol.indexOf("0#") < 0){
-				var count = (symbol.match(/\./g) || []).length;
+				let count = (symbol.match(/\./g) || []).length;
 				if(count < 2){
 					symbol = "0#" + symbol;
 				}
@@ -799,8 +814,8 @@ RowDefinition.prototype.unsubscribeForUpdates = function() {
 		return;
 	}
 
-	var subs = this._dc.getSubscriptions();
-	var prevRowData = this.getRowData();
+	let subs = this._dc.getSubscriptions();
+	let prevRowData = this.getRowData();
 
 	subs["removeSubscription"](this._subId);
 	this._subId = "";
@@ -825,10 +840,10 @@ RowDefinition.prototype.isSubscribing = function() {
 */
 RowDefinition.prototype.addUpdate = function(e) {
 	if(e) {
-		var changes = e["changes"];
+		let changes = e["changes"];
 		if(changes) {
-			var dirty = 0;
-			for(var field in changes) {
+			let dirty = 0;
+			for(let field in changes) {
 				this._changes[field] = dirty = 1;
 			}
 			if(dirty) {
@@ -865,7 +880,7 @@ RowDefinition.prototype.registerToView = function(view, rowId) {
 	}
 	this._view = view;
 
-	var rowData = null;
+	let rowData = null;
 	if(this._subSegment) {
 		rowData = this._view.getRowData(this.getRowId());
 		if(rowData) {
@@ -877,7 +892,7 @@ RowDefinition.prototype.registerToView = function(view, rowId) {
 	rowData = {};
 	rowData[ROW_DEF] = this;
 
-	var newRowId = this._view.insertRow(rowId, rowData, this.getRowId());
+	let newRowId = this._view.insertRow(rowId, rowData, this.getRowId());
 	this._rowId = newRowId; // In case there is some duplicate row id.
 
 	if(this._isChain) {
@@ -908,7 +923,7 @@ RowDefinition.prototype._deregisterFromView = function(rowIds) {
 * @param {RowDefinition} rowDef
 * @return {Array.<string>}
 * @example
-* var rowIds = descendants.reduce(RowDefinition.deregisterFromView, []);
+* let rowIds = descendants.reduce(RowDefinition.deregisterFromView, []);
 */
 RowDefinition.deregisterFromView = function(rowIds, rowDef) {
 	rowDef._deregisterFromView(rowIds);
@@ -923,7 +938,7 @@ RowDefinition.prototype._getChildStaticRowData = function(ric) {
 		return null;
 	}
 
-	var childValues = this._staticValues[RowDefinition._childDataField];
+	let childValues = this._staticValues[RowDefinition._childDataField];
 	if(!childValues) {
 		return null;
 	}
@@ -943,9 +958,9 @@ RowDefinition.prototype.addConstituent = function(ric) {
 		return null;
 	}
 
-	var childDef = null;
+	let childDef = null;
 	if(this._children) {
-		for(var i = this._children.length; --i >= 0;) {
+		for(let i = this._children.length; --i >= 0;) {
 			if(this._children[i]._ric === ric) {
 				childDef = this._children[i]; // Constituent has already been added
 				break;
@@ -955,16 +970,16 @@ RowDefinition.prototype.addConstituent = function(ric) {
 		this._children = [];
 	}
 
-	var newChild = !childDef;
+	let newChild = !childDef;
 	if(newChild) {
-		var rowOptions = {
+		let rowOptions = {
 			"asConstituent": true,
 			"dataId": this._subId + ric,
 			"ric": ric,
 			"parent": this
 		};
 
-		var staticData = this._getChildStaticRowData(ric);
+		let staticData = this._getChildStaticRowData(ric);
 		if(staticData) {
 			rowOptions["values"] = staticData;
 		}
@@ -973,11 +988,11 @@ RowDefinition.prototype.addConstituent = function(ric) {
 	}
 
 	if(this._view) {
-		var rowId = this.getRowId();
+		let rowId = this.getRowId();
 		// WARNING: insert position, we prioritize using CHILD_ORDER (From server) in dc first. If it does not exist, the last row of the segment will be pushed
-		var childOrder = childDef.getData("CHILD_ORDER");
-		var parentIndex =  this._view.getRowIndex(rowId);
-		var position =  parentIndex + this.getChildCount(); // push the last position
+		let childOrder = childDef.getData("CHILD_ORDER");
+		let parentIndex =  this._view.getRowIndex(rowId);
+		let position =  parentIndex + this.getChildCount(); // push the last position
 		if(childOrder != null) {
 			// Warning: We need to carry a value of 1 because the CHILD_ORDER starts with 0, and it will be added to the parentIndex. In case the parent rowIndex is not included.
 			position = parentIndex + childOrder + 1; // insert between segment
@@ -1019,19 +1034,19 @@ RowDefinition.prototype.unlinkChain = function() {
 	}
 
 	if(this.isChainExpanded()) {
-		var rowDefs = this.getDescendants();
-		var len = rowDefs.length;
-		for(var i = 0; i < len; i++) {
+		let rowDefs = this.getDescendants();
+		let len = rowDefs.length;
+		for(let i = 0; i < len; i++) {
 			rowDefs[i]._toRealTimeRow();
 		}
 	}
 
 	this.unsubscribeForUpdates();
 
-	var view = this._view;
+	let view = this._view;
 	if(view) {
-		var rid = this.getRowId();
-		var segment = view.getSegment(rid);
+		let rid = this.getRowId();
+		let segment = view.getSegment(rid);
 		if(segment) {
 			segment.setClassification(null);
 		}
@@ -1114,10 +1129,10 @@ RowDefinition.prototype.getDescendants = function(ary) {
 		ary = [];
 	}
 	if(this._children) {
-		var chdr = this._children;
-		var len = chdr.length;
-		for(var i = 0; i < len; ++i) {
-			var ch = chdr[i];
+		let chdr = this._children;
+		let len = chdr.length;
+		for(let i = 0; i < len; ++i) {
+			let ch = chdr[i];
 			ary.push(ch);
 			ch.getDescendants(ary);
 		}
@@ -1129,7 +1144,7 @@ RowDefinition.prototype.getDescendants = function(ary) {
 * @return {Array.<string>} Null if there is no row Id
 */
 RowDefinition.prototype.getAllDescendantIds = function() {
-	var descendants = this.getDescendants();
+	let descendants = this.getDescendants();
 	if(descendants.length) {
 		return descendants.map(RowDefinition.toRowId);
 	} else {
@@ -1158,7 +1173,7 @@ RowDefinition.prototype.setParent = function(parentDef) {
 		return false;
 	}
 	if(this._parent) { // Release from previous parent
-		var at = this._parent._children.lastIndexOf(this);
+		let at = this._parent._children.lastIndexOf(this);
 		if(at >= 0) {
 			this._parent._children.splice(at, 1);
 		}
@@ -1210,12 +1225,26 @@ RowDefinition.prototype.setGroupOrder = function(num) {
 };
 
 /** @public
+* @ignore
 * @return {Object}
 */
 RowDefinition.prototype.getUserModel = function() {
 	return this._userModel;
 };
 
+/** @public
+* @param {Object} obj
+*/
+RowDefinition.prototype.setRowInfo = function(obj) {
+	this._info = obj;
+};
+/** @public
+* @return {Object}
+*/
+RowDefinition.prototype.getRowInfo = function() {
+	return this._info;
+};
+
 /** For mapping row Id by Array.map()
 * @public
 * @function
@@ -1233,15 +1262,15 @@ RowDefinition.toRowId = function(rowDef) {
 * @return {RowDefinition~Options}
 */
 RowDefinition.extractRowOptions = function(rowOptions) {
-	var ric = rowOptions["ric"];
-	var permId = rowOptions["permId"];
-	var chainRic = rowOptions["chainRic"];
-	var collapsed = rowOptions["collapsed"];
-	var asChain = rowOptions["asChain"];
+	let ric = rowOptions["ric"];
+	let permId = rowOptions["permId"];
+	let chainRic = rowOptions["chainRic"];
+	let collapsed = rowOptions["collapsed"];
+	let asChain = rowOptions["asChain"];
 	if(asChain == null && chainRic){
 		asChain = true;
 	}
-	var expanded = null;
+	let expanded = null;
 	if(ric && ric.indexOf("0#") >= 0){
 		if(asChain == null){
 			asChain = true;
@@ -1249,7 +1278,7 @@ RowDefinition.extractRowOptions = function(rowOptions) {
 		expanded = true;
 	}
 
-	var extractedOptions = {};
+	let extractedOptions = {};
 	if(collapsed == null) {
 		extractedOptions["collapsed"] = !expanded;
 	} else {