@refinitiv-ui/efx-grid 6.0.36 → 6.0.37

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

@@ -13195,9 +13195,10 @@ DataTable._proto = DataTable.prototype;
 * @property {Array.<string>=} fields=null Field that corresponds to the given static values
 * @property {boolean=} asChain=false The given ric will be treated as a chain
 * @property {string=} chainRic="" RIC to be used for chain request (overiding ric property)
-* @property {boolean=} collapsed=false Chain is expanded by default
+* @property {boolean=} collapsed=true Chain is collapsed by default
 * @property {(string|null)=} label=null
 * @property {boolean=} hidden=true When this row is hidden
+* @pro // realTime
 */
 
 /** @typedef {Object} RowDefinition~RowTypes
@@ -13273,18 +13274,18 @@ RowDefinition.prototype._ric = ""; // Contains no 0#
 * @private
 */
 RowDefinition.prototype._permId = "";
-/** @type {string}
-* @private
-*/
-RowDefinition.prototype._displayText = "";
 /** @type {string|null}
 * @private
 */
 RowDefinition.prototype._label = null; // Label overrides _ric and _displayText
+/** @type {boolean|null}
+* @private
+*/
+RowDefinition.prototype._isChain = null;
 /** @type {boolean}
 * @private
 */
-RowDefinition.prototype._isChain = false;
+RowDefinition.prototype._realTime = true;
 
 /** @type {string}
 * @private
@@ -13308,10 +13309,10 @@ RowDefinition.prototype._view = null;
 */
 RowDefinition.prototype._subId = "";
 
-/** @type {boolean}
+/** @type {boolean|null}
 * @private
 */
-RowDefinition.prototype._expanded = false;
+RowDefinition.prototype._expanded = null;
 /** @type {boolean}
 * @private
 */
@@ -13399,18 +13400,19 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 		return;
 	}
 
-	var val = rowOptions["ric"];
+	var val = rowOptions["permId"];
 	if(val != null) {
-		this._ric = val;
+		this._permId = val;
 	}
-	val = rowOptions["permId"];
+	val = rowOptions["ric"];
 	if(val != null) {
-		this._permId = val;
+		this._ric = val;
 	}
-	if(this._ric || this._permId){
-		this.setContent(this._ric, this._permId); // this._dataId is modified
+	val = rowOptions["label"];
+	// eslint-disable-next-line no-undefined
+	if(val !== undefined) { // Empty string and null are allowed
+		this._label = val;
 	}
-
 	val = rowOptions["chainRic"];
 	if(val != null) {
 		this._chainRic = val;
@@ -13422,26 +13424,40 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	}
 
 	val = rowOptions["asChain"];
-	if(val) {
-		this._isChain = true;
-		this._expanded = !rowOptions["collapsed"];
-	} else if(this._isChain) {
-		var collapsed = rowOptions["collapsed"];
-		if(collapsed != null) {
-			this._expanded = !collapsed;
-		}
+	if(val !== null) {
+		this._isChain = val;
 	}
 
-	val = rowOptions["label"];
-	// eslint-disable-next-line no-undefined
-	if(val !== undefined) { // Empty string and null are allowed
-		this._label = val;
+	val = rowOptions["realTime"];
+	if(val != null) {
+		this._realTime = val;
 	}
 
+	val = rowOptions["collapsed"];
+	if(val != null){
+		this._expanded = !val;
+	}
 	val = rowOptions["keepModel"];
 	if(val) {
 		this._userModel = rowOptions;
 	}
+
+	var expanded = this._expanded;
+	var symbol = this._ric || this._chainRic;
+	var asChain = rowOptions["asChain"] || !!this._chainRic;
+	if(this._ric && this._ric.indexOf("0#") >= 0){
+		asChain = true;
+		expanded = true;
+	}
+	if(rowOptions["asChain"] === false){
+		asChain = false;
+	}
+	if(rowOptions["collapsed"] === true){
+		expanded = false;
+	}
+	if(symbol || this._permId){
+		this.setContent(symbol, this._permId, asChain, expanded); // this._dataId is modified
+	}
 };
 /** @private
 * @param {!Object} rowOptions
@@ -13451,7 +13467,6 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 	var 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._displayText = this._ric = /** @type{string} */(rowOptions["ric"]);
 
 		this._dc = parentDef._dc; // Parent chain must have data cache
 		if(this._dc) {
@@ -13470,9 +13485,12 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 /** @public
 * @param {string} userInput RIC
 * @param {string=} permId=null Organization PermId, which use for getting ADC data for private  company
+* @param {boolean=} asChain
+* @param {boolean=} expanded
+* @param {boolean=} realTime
 * @return {boolean} True if there is any change otherwise false
 */
-RowDefinition.prototype.setContent = function(userInput, permId) {
+RowDefinition.prototype.setContent = function(userInput, permId, asChain, expanded) {
 	if(this._autoGenerated) { // AutoGenerated RowDefinition cannot be changed by user input
 		return false;
 	}
@@ -13486,10 +13504,7 @@ RowDefinition.prototype.setContent = function(userInput, permId) {
 	var dirty = (this._userInput !== userInput);
 	if(this._permId !== permId){
 		this._permId = permId || "";
-		if(!userInput){
-			this._displayText = this._permId;
-			dirty = true;
-		}
+		dirty = true;
 	}
 	if(!dirty) {
 		return false;
@@ -13498,34 +13513,44 @@ RowDefinition.prototype.setContent = function(userInput, permId) {
 	this.unsubscribeForUpdates();
 	this.resetUpdates(); // Remove all previous data updates because a new content is just entered
 
+	// TODO: handle changing between chain and ric row
 	this._userInput = userInput;
 	if(this._userInput.charAt(0) === "'") { // This is a row header
-		this._displayText = this._userInput.substr(1);
 		this._ric = this._chainRic = ""; // No ric for realtime request
 	} else {
 		if(this._userInput.indexOf("0#") >= 0) {
-			this._ric = this._userInput.replace("0#", "");
-			this._isChain = this._expanded = true; // Only chain can be expanded by 0# TODO: RIC with 0# is not necessarily a chain
-			this._chainRic = this._userInput;
-			if(this._view) {
-				this._view.setSegmentSeparator(this._rowId);
-				this.expandChain();
+			if(asChain === false){
+				this._ric = this._userInput;
+			} else {
+				this._ric = expanded ? this._userInput.replace("0#", "") : this._userInput;
+				this._expanded = expanded;
+				this._isChain = true; // Only chain can be expanded by 0#
+				this._chainRic = this._userInput;
+				if(this._view) {
+					this._view.setSegmentSeparator(this._rowId);
+					this.expandChain();
+				}
 			}
 		} else {
 			this._ric = this._userInput;
-			this._chainRic = "";
+			if(asChain){
+				this._isChain = true;
+			}
 		}
-		this._displayText = this._ric; // No 0#
 	}
 
 	this._dataId = this._rowId + this.getSymbol(); // JET/RTK will generate data id to be rowId (given from this rowDef) + ric;
 
-	// This will work for runtime ric modification, but not for first initilization.
+
 	if(!this.subscribeForUpdates()) {
-		// Avoid losing the ROW_DEF pointer.
-		var rowData = {};
-		rowData[ROW_DEF] = this; // Enable tracking back and updating data
-		this.setRowData(rowData);
+		if(this._dc) {
+			// This will work for runtime ric modification, but not for first initilization.
+			// Avoid losing the ROW_DEF pointer.
+			var rowData = {};
+			rowData[ROW_DEF] = this; // Enable tracking back and updating data
+			rowData["X_RIC_NAME"] = this.getDisplayText();
+			this.setRowData(rowData);
+		}
 	}
 	return true;
 };
@@ -13546,6 +13571,16 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["ric"] = val;
 	}
 
+	// The user passed a single quote (') case
+	if(!this._ric && this._userInput.charAt(0) === "'") {
+		obj["ric"] = this._userInput;
+	}
+
+	val = this._realTime;
+	if(val !== true) {
+		obj["realTime"] = val;
+	}
+
 	val = this._permId;
 	if(val) {
 		obj["permId"] = val;
@@ -13567,12 +13602,12 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 	}
 
 	val = this._isChain;
-	if(val) {
+	if(val != null) {
 		obj["asChain"] = val;
 	}
 
 	val = this._expanded;
-	if(val) {
+	if(val != null) {
 		obj["collapsed"] = !val;
 	}
 
@@ -13670,6 +13705,7 @@ RowDefinition.prototype.setDataSource = function(dataSource) {
 	if(!rowData) {
 		rowData = {};
 		rowData[ROW_DEF] = this; // Enable tracking back and updating data
+		rowData["X_RIC_NAME"] = this.getDisplayText();
 		this.setRowData(rowData); // TODO: This will dispatch dataChanged event and caused update to be added, which should not happen
 	}
 
@@ -13812,7 +13848,16 @@ RowDefinition.prototype.getDisplayText = function() {
 	if(this._label != null) { // Empty string is allowed
 		return this._label;
 	}
-	return this._displayText;
+
+	if(this._ric) {
+		return this._ric;
+	}
+
+	if(this._permId) {
+		return this._permId;
+	}
+
+	return this._userInput;
 };
 /** @public
 * @return {string|null}
@@ -13876,13 +13921,18 @@ RowDefinition.prototype.isRealTimeRow = function() {
 	if(!this.getRic()) { // Empty row
 		return false;
 	}
-	if(this.isRowHeader()) {
+	if(!this._realTime) {
 		return false;
 	}
+
 	if(this._autoGenerated) { // Constituents in chain are not real-time row
 		return false;
 	}
 
+	if(this.isRowHeader()) {
+		return false;
+	}
+
 	return true;
 };
 
@@ -13911,7 +13961,7 @@ RowDefinition.prototype.subscribeForUpdates = function() {
 	if(prevRowData) {
 		this._dc.setRowData(this._dataId, prevRowData); // TODO: We may need to create a new object instead of prevRowData for data correctness
 	} else {
-		this._dc.setRowData(this._dataId, {"X_RIC_NAME": this.getSymbol(), "ROW_DEF": this}); // Trigger data update immediately
+		this._dc.setRowData(this._dataId, {"X_RIC_NAME": this.getDisplayText(), "ROW_DEF": this}); // Trigger data update immediately
 	}
 	return true;
 };
@@ -14372,40 +14422,6 @@ var SYNAPSE_URL =
 	+ 'hits=1' // search only 1 result
 	+ '&profile=' + encodeURIComponent('Field Selector');
 
-/** @function
-* @private
-* @param {Object} e
-*/
-function xRicNameRenderer(e) {
-	e.cell.setContent(e.rowDef.getDisplayText());
-}
-/** @function
-* @private
-* @param {RowDefinition} rowA
-* @param {RowDefinition} rowB
-* @param {number} order
-* @returns {number}
-*/
-function xRicNameSorter(rowA, rowB, order) {
-	var A = rowA.getDisplayText();
-	var B = rowB.getDisplayText();
-	if(A === B) {
-		return 0;
-	}
-	if(!A) {
-		return 1;
-	}
-	if(!B) {
-		return -1;
-	}
-	if(A < B) {
-		return -order;
-	}
-
-	return order;
-}
-
-
 /* @namespace */
 var FieldDefinition = {};
 
@@ -14413,13 +14429,6 @@ var FieldDefinition = {};
 * @private
 */
 FieldDefinition._defs = {
-	"X_RIC_NAME": {
-		name: "RIC",
-		IsRealtimeField: false,
-		width: 100,
-		binding: xRicNameRenderer,
-		sortLogic: xRicNameSorter
-	},
 	"CF_NAME": {
 		name: "Name",
 		rank: 2800003,
@@ -16814,6 +16823,13 @@ GroupDefinitions.prototype.getGroups = function () {
 	}
 	return groupDefs;
 };
+/** Get array of all existing group ids
+* @public
+* @return {!Array.<string>}
+*/
+GroupDefinitions.prototype.getGroupIds = function () {
+	return Object.keys(this._groupMap);
+};
 /** @public
 * @return {!Object.<string, Object>}
 */
@@ -16920,7 +16936,18 @@ GroupDefinitions.prototype.getParentId = function (childId, groupLevel) {
 	return parentId || "";
 };
 
-
+/** Remove all existing group definitions
+* @public
+* @return {boolean}
+*/
+GroupDefinitions.prototype.removeAllGroups = function () {
+	for(var groupId in this._groupMap) { // eslint-disable-line
+		this._groupMap = {};
+		this._childToParent = {};
+		return true;
+	}
+	return false;
+};
 /** Remove all existing group definitions and replace them with the given definitions.
 * @public
 * @param {Array.<Object>=} groupDefs Use null or empty array to remove all existing groups
@@ -17065,9 +17092,10 @@ GroupDefinitions.prototype.hasGroupChild = function (parentId, childId) {
 /** @public
 * @param {string} parentId Group id
 * @param {string} childId
+* @param {number=} position
 * @return {boolean}
 */
-GroupDefinitions.prototype.addGroupChild = function (parentId, childId) {
+GroupDefinitions.prototype.addGroupChild = function (parentId, childId, position) {
 	var groupDef = this._groupMap[parentId];
 
 	if(childId && groupDef) {
@@ -17080,7 +17108,11 @@ GroupDefinitions.prototype.addGroupChild = function (parentId, childId) {
 			if(childDef) {
 				childDef.parentId = parentId;
 			}
-			chdr.push(childId);
+			if(position != null && position >= 0) {
+				chdr.splice(position, 0, childId);
+			} else {
+				chdr.push(childId);
+			}
 			return true;
 		}
 	}
@@ -17189,6 +17221,18 @@ GroupDefinitions.prototype.setGroupChildren = function (groupId, newChildList) {
 	}
 	return false;
 };
+
+/** @public
+* @param {string} groupId
+* @return {string}
+*/
+GroupDefinitions.prototype.getGroupName = function (groupId) {
+	var groupDef = this._groupMap[groupId];
+	if(groupDef) {
+		return groupDef.name || "";
+	}
+	return "";
+};
 /** @public
 * @param {string} groupId
 * @param {string} groupName
@@ -17205,6 +17249,7 @@ GroupDefinitions.prototype.setGroupName = function (groupId, groupName) {
 
 	return false;
 };
+
 /* harmony default export */ var es6_GroupDefinitions = (GroupDefinitions);
 
 
@@ -20366,6 +20411,10 @@ ILayoutGrid.prototype.calculateColumnBounds = function (lftIdx, rgtIdx, outPosit
 * @param {number=} topPx Top position of bound
 */
 ILayoutGrid.prototype.updateColumnBounds = function (posAry, noBorderAry, topPx) {};
+/** @public
+* @ignore
+*/
+ILayoutGrid.prototype.updateColumnSeparators = function () {};
 
 /* harmony default export */ var grid_ILayoutGrid = (ILayoutGrid);
 
@@ -24355,7 +24404,14 @@ LayoutGrid.prototype._colSelDirty = false;
 * @private
 */
 LayoutGrid.prototype._hscrollbar = null;
-
+/** @type {Element}
+* @private
+*/
+LayoutGrid.prototype._leftColumnSeparator = null;
+/** @type {Element}
+* @private
+*/
+LayoutGrid.prototype._rightColumnSeparator = null;
 
 /**
  * {@link ElementWrapper#dispose}
@@ -26322,8 +26378,7 @@ LayoutGrid.prototype.selectColumn = function (colIndex, selected) {
 
 		var boundLayer = this._boundLayer;
 		if(!boundLayer) {
-			boundLayer = this._boundLayer = document.createElement("div");
-			boundLayer.className = "cover-layer";
+			this._initBoundLayer();
 			this._updateLayers();
 		}
 	}
@@ -26495,6 +26550,92 @@ LayoutGrid.prototype.updateColumnBounds = function (posAry, noBorderAry, topPx)
 	}
 };
 
+/** @public
+*/
+LayoutGrid.prototype.updateColumnSeparators = function () {
+	var pinnedLeftCount = this._hscrollbar.getPinnedLeftColumnCount();
+	var pinnedRightCount = this._hscrollbar.getPinnedRightColumnCount();
+	if ((pinnedLeftCount || pinnedRightCount) && !this._boundLayer) {
+		this._initBoundLayer();
+	}
+
+	var isScrollbarActive = false;
+	if(this._hscrollbar) {
+		isScrollbarActive = this._hscrollbar.isActive();
+	}
+
+	var boundLayer = this._boundLayer;
+
+	var colSeparator = this._leftColumnSeparator;
+	if (isScrollbarActive && pinnedLeftCount) {
+		if (!colSeparator) {
+			colSeparator = this._leftColumnSeparator = this._createColumnSeparator();
+		}
+		if (!colSeparator.parentNode) {
+			if (boundLayer.children.length) {
+				boundLayer.insertBefore(colSeparator, boundLayer.children[0]);
+			} else {
+				boundLayer.appendChild(colSeparator);
+			}
+		}
+
+		var rightPos = this._trackX.getLaneStart(pinnedLeftCount);
+		colSeparator.style.left = (rightPos - 1) + "px";
+		colSeparator.style.height = this._trackY.getTrackSize() + "px";
+	} else {
+		if (colSeparator && colSeparator.parentNode) {
+			this._boundLayer.removeChild(colSeparator);
+		}
+	}
+
+	colSeparator = this._rightColumnSeparator;
+	if (isScrollbarActive && pinnedRightCount) {
+		if (!colSeparator) {
+			colSeparator = this._rightColumnSeparator = this._createColumnSeparator();
+		}
+
+		if (!colSeparator.parentNode) {
+			if (boundLayer.children.length) {
+				boundLayer.insertBefore(colSeparator, boundLayer.children[0]);
+			} else {
+				boundLayer.appendChild(colSeparator);
+			}
+		}
+		var colCount = this.getColumnCount();
+		var colWidth = this._trackX.getLaneEnd(colCount - 1) - this._trackX.getLaneStart(colCount - pinnedRightCount);
+		var viewSize = this._getViewSize();
+
+		colSeparator.style.left = (viewSize - colWidth - this._rightSpaceSize) + "px";
+		colSeparator.style.height = this._trackY.getTrackSize() + "px";
+	} else {
+		if (colSeparator && colSeparator.parentNode) {
+			this._boundLayer.removeChild(colSeparator);
+		}
+	}
+};
+
+/** @private
+* @return {Element}
+*/
+LayoutGrid.prototype._createColumnSeparator = function() {
+	var colSeparator = document.createElement("div");
+	colSeparator.classList.add("column-separator");
+	return colSeparator;
+};
+
+/** @private
+* @return {Element}
+*/
+LayoutGrid.prototype._initBoundLayer = function () {
+	var boundLayer = this._boundLayer;
+	if(!boundLayer) {
+		boundLayer = this._boundLayer = document.createElement("div");
+		boundLayer.className = "cover-layer";
+		this._element.appendChild(boundLayer);
+	}
+	return boundLayer;
+};
+
 /**
  * @private
  * @param {number} indexX
@@ -35014,6 +35155,12 @@ VirtualizedLayoutGrid.prototype.updateColumnBounds = function (posAry, noBorderA
 	this._grid.updateColumnBounds(posAry, noBorderAry, topPx);
 	this._updateRowBounds();
 };
+/** @public
+* @ignore
+*/
+VirtualizedLayoutGrid.prototype.updateColumnSeparators = function () {
+	this._grid.updateColumnSeparators();
+};
 /** @private
 */
 VirtualizedLayoutGrid.prototype._initBoundLayer = function () {
@@ -35779,7 +35926,7 @@ Core.prototype._batches = null;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.49";
+	return "5.1.50";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -36992,6 +37139,7 @@ Core.prototype._moveColumn = function (fromCol, destCol) {
 		}
 	}
 	this._updateColumnBounds();
+	this._updateColumnSeparators();
 	return true;
 };
 
@@ -37322,6 +37470,7 @@ Core.prototype.setDefaultRowHeight = function (val, opt_includeTitle) {
 		this._syncRowHeights();
 		this._rowHeightSync = true;
 		this.setRowScrollingStep(this._rowScrollingStep);
+		this._updateColumnSeparators();
 	}
 };
 
@@ -38156,6 +38305,7 @@ Core.prototype.freezeColumn = function (frozenColIndex, numRightColumn) {
 
 	this._onColumnCountChanged(); // Activate horizontal scrollbar and column virtualization
 	this._updateScrollbarWidth(true, true);
+	this._updateColumnSeparators();
 };
 
 /** @private
@@ -39397,6 +39547,21 @@ Core.prototype._updateColumnBounds = function () {
 		section.updateColumnBounds(posAry, noBorderAry);
 	}
 };
+/* @private
+*/
+Core.prototype._updateColumnSeparators = function() {
+	var sectCount = this._settings.length;
+	if(!sectCount) {
+		return;
+	}
+
+	for(var i = 0; i < sectCount; i++) {
+		var section = this._settings[i].getSection();
+		if (section) {
+			section.updateColumnSeparators();
+		}
+	}
+};
 
 /** @public
 * @param {number} startColIndex INCLUSIVE
@@ -40466,6 +40631,8 @@ Core.prototype._onRowCountChanged = function (e) {
 	if(!forceUpdate) {
 		this._updateVScrollbar(); // Asynchronous
 	}
+
+	this._updateColumnSeparators();
 	if(prevRowCount < newRowCount) {
 		this._dispatch("rowAdded", e);
 	} else if(prevRowCount > newRowCount) {
@@ -40523,7 +40690,7 @@ Core.prototype._onRowHeightChanged = function (e) {
 				minSectionIndex >= this._startVScrollbarIndex);
 		}
 	}
-
+	this._updateColumnSeparators();
 	this._dispatchRowPositionChanged();
 };
 /** @private
@@ -40588,6 +40755,7 @@ Core.prototype._onColumnCountChanged = function () {
 	var pinnedRight = this._countPinnedRightColumns();
 
 	this._updateColumnBounds();
+	this._updateColumnSeparators();
 
 	if (this._hScrollbarEnabled && pinnedLeft + pinnedRight < this.getColumnCount()) {
 		this._hscrollbar.enable();
@@ -40869,6 +41037,7 @@ Core.prototype._syncLayoutToColumns = function (from, to, opt_forceDispatching)
 	var paneChanged = forceUpdate || (from < this.getHScrollStartIndex()) || (to > this.getFirstPinnedRightIndex());
 	this._updateScrollbarWidth(paneChanged, true /* contentChanged */);
 	this._updateColumnBounds();
+	this._updateColumnSeparators();
 	this._dispatchColumnPositionChanged();
 
 	if (dirty || opt_forceDispatching) {
@@ -40964,6 +41133,7 @@ Core.prototype._updateLayout = function () {
 		var section = this._settings[s].getSection();
 		section.updateLayout(); // Notify section about forced recalculation of the layout
 	}
+	this._updateColumnSeparators();
 };
 
 /** @private */
@@ -49573,6 +49743,13 @@ MockSubscriptions.prototype._generateQuoteData = function(sub, fields) {
 		values[field] = data.value;
 		values[formattedField] = data.formattedValue;
 	}
+
+	// The delay symbol for X_RIC_NAME will depend on the INDICATOR field.
+	if(values["X_RIC_NAME"] != null && values["INDICATOR"] != null) {
+		if(values["INDICATOR"] > 0) {
+			values["X_RIC_NAME"] = "/" + values["X_RIC_NAME"];
+		}
+	}
 	return values;
 };