@refinitiv-ui/efx-grid 6.0.21 → 6.0.22

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

@@ -528,7 +528,7 @@ Core.prototype._rowHeightTimerId = 0;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.31";
+	return "5.1.32";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -2880,6 +2880,13 @@ Core.prototype.freezeLayout = function (opt_bool) {
 	if (prevState !== opt_bool) {
 		this._frozenLayout = opt_bool;
 
+		var stp = this.getPlugin("SortableTitlePlugin");
+		if(this._frozenLayout) {
+			if(stp) {
+				stp.freezeIndicator(true);
+			}
+		}
+
 		if (!this._frozenLayout) {
 			// Width has not yet changed so we need to disable it first
 			this._disableEvent("widthChanged");
@@ -2908,6 +2915,9 @@ Core.prototype.freezeLayout = function (opt_bool) {
 			if(!viewChanged) { // Always update virtualizer
 				this._rowVirtualizer.update(true); // Force section activation
 			}
+			if(stp) {
+				stp.freezeIndicator(false);
+			}
 		}
 		this._rowHeightSync = true;
 	}

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

@@ -1612,6 +1612,7 @@ LayoutGrid.prototype.setFrozenLayout = function (bool) {
 	if (this._frozenLayout !== bool) {
 		this._frozenLayout = bool;
 
+		this._cellSpans.freezeMapping(this._frozenLayout);
 		if (!this._frozenLayout) {
 			this._syncLayoutToColumns(0);
 			this._syncLayoutToRows(0, this._rowCount);

package/lib/core/es6/grid/components/CellSpans.d.ts

@@ -6,6 +6,8 @@ declare class CellSpans {
 
     public removeColumn(at: number): boolean;
 
+    public freezeMapping(bool?: boolean|null): void;
+
     public shiftColumn(from: number, amount: number): boolean;
 
     public removeSpan(indexX: number, indexY: number): CellSpan|null;

package/lib/core/es6/grid/components/CellSpans.js

@@ -20,6 +20,33 @@ CellSpans.prototype.removeColumn = function (at) { // Use when a column is remov
 	}
 	return dirty;
 };
+/** @public
+* @param {boolean=} bool
+*/
+CellSpans.prototype.freezeMapping = function (bool) {
+	this._frozenMapping = bool !== false;
+	if(!this._frozenMapping) {
+		this._mapCellSpans();
+	}
+};
+
+
+/** @private
+*/
+CellSpans.prototype._mapCellSpans = function () {
+	var cellSpans = this._spans;
+	this._spans = [];
+	this._occupiedMap = {};
+	var i, cellSpan;
+	for(i = cellSpans.length; --i >= 0;) {
+		cellSpan = cellSpans[i];
+		if(cellSpan.indexX >= 0) {
+			cellSpan.register(this._spans, this._occupiedMap);
+		}
+	}
+};
+
+
 /** @public
 * @param {number} from
 * @param {number} amount This can be negative number
@@ -36,18 +63,10 @@ CellSpans.prototype.shiftColumn = function (from, amount) { // Use when a column
 			cellSpan.indexX += amount;
 		}
 	}
-	if(!dirty) { return false; }
+	if(!dirty || this._frozenMapping) { return false; }
 
 	// Re-registers all cellspans. Some of the cellspans may be lost due to shifting
-	var cellSpans = this._spans;
-	this._spans = [];
-	this._occupiedMap = {};
-	for(i = cellSpans.length; --i >= 0;) {
-		cellSpan = cellSpans[i];
-		if(cellSpan.indexX >= 0) {
-			cellSpan.register(this._spans, this._occupiedMap);
-		}
-	}
+	this._mapCellSpans();
 	return true;
 };
 /** @public
@@ -336,6 +355,12 @@ CellSpans.prototype._spans;
 */
 CellSpans.prototype._occupiedMap;
 
+/**
+* @private
+* @type {boolean}
+*/
+CellSpans.prototype._frozenMapping = false;
+
 export default CellSpans;
 export { CellSpans };
 

package/lib/core/es6/grid/plugins/SortableTitlePlugin.d.ts

@@ -110,6 +110,8 @@ declare class SortableTitlePlugin extends EventDispatcher {
 
     public disableTwoStateSorting(disabled?: boolean|null): void;
 
+    public freezeIndicator(bool?: boolean|null): void;
+
     public disableSortSymbols(disabled?: boolean|null): void;
 
     public disableDataSorting(disabled?: boolean|null): void;

package/lib/core/es6/grid/plugins/SortableTitlePlugin.js

@@ -192,6 +192,10 @@ SortableTitlePlugin.prototype._userManagedLogic = false;
 * @type {boolean}
 */
 SortableTitlePlugin.prototype._disabled = false;
+/** @private
+* @type {boolean}
+*/
+SortableTitlePlugin.prototype._frozenIndicator = false;
 /** Since DataView in real-time grid has only one ROW_DEF column, we need to re-map sorting field to sort correctly.
 * @private
 * @type {boolean}
@@ -750,8 +754,9 @@ SortableTitlePlugin.prototype.sortColumns = function (sortOptions, opt_arg) {
 * @param {Object=} opt_arg Event argument to be sent with preDataSorting event
 */
 SortableTitlePlugin.prototype.clearSortState = function (opt_arg) {
-	this._popSortState(0, opt_arg);
-	this.updateSortSymbols();
+	if(this._popSortState(0, opt_arg)) {
+		this.updateSortSymbols();
+	}
 };
 /** @description Perform sorting with the same parameter.
 * @public
@@ -956,6 +961,12 @@ SortableTitlePlugin.prototype.disableTwoStateSorting = function (disabled) {
 
 };
 /** @public
+* @param {boolean=} bool=true, if set to false it will be unfreeze indicator
+*/
+SortableTitlePlugin.prototype.freezeIndicator = function (bool) {
+	this._frozenIndicator = bool !== false;
+};
+/** @public
 * @param {boolean=} disabled
 */
 SortableTitlePlugin.prototype.disableSortSymbols = function (disabled) {
@@ -1568,7 +1579,7 @@ SortableTitlePlugin.prototype._clearSortSymbols = function (state) {
 SortableTitlePlugin.prototype._updateSortableIndicator = function (hostIndex) {
 	var t = this;
 	var host = t._hosts[hostIndex];
-	if (!host) { return; }
+	if (!host || this._frozenIndicator) { return; }
 
 	var section = host.getSection("title");
 	if (section == null) { return; }

package/lib/grid/index.js

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

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

@@ -13094,6 +13094,10 @@ var RowDefinition = function(rowOptions) {
 * @private
 */
 RowDefinition._runningId = 0;
+/** @type {string}
+* @private
+*/
+RowDefinition._childDataField = "CHILD_VALUES";
 //#region Private Members
 /** @type {string}
 * @private
@@ -13284,7 +13288,11 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 			}
 		}
 	}
-	// TODO: Allow constituent to have predefined static values
+	var val = rowOptions["values"];
+	// eslint-disable-next-line no-undefined
+	if(val !== undefined) {
+		this.setStaticRowData(val, rowOptions["fields"]);
+	}
 };
 /** @public
 * @param {string} userInput
@@ -13356,11 +13364,6 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["ric"] = val;
 	}
 
-	val = this._staticValues;
-	if(val) {
-		obj["values"] = Object(Util["b" /* cloneObject */])(val);
-	}
-
 	val = this._chainRic;
 	if(val) {
 		obj["chainRic"] = val;
@@ -13392,6 +13395,40 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["hidden"] = val;
 	}
 
+	val = this._getStaticRowData();
+	if(val) {
+		obj["values"] = val;
+	}
+
+	// obtain the static values of constituent rows
+	if(this.isChain()) {
+		var children = this.getChildren();
+		if(children) {
+			var childValues = val ? val[RowDefinition._childDataField] : {};
+			if(!childValues) {
+				childValues = {};
+			}
+			var dirty = false;
+			var len = children.length;
+			var i, rowDef, staticValues;
+			for(i = 0; i < len; i++) {
+				rowDef = children[i];
+				staticValues = rowDef._getStaticRowData();
+				if(staticValues) {
+					dirty = true;
+					childValues[rowDef.getRic()] = staticValues;
+				}
+			}
+
+			if(dirty) {
+				if(!obj["values"]) {
+					obj["values"] = {};
+				}
+				obj["values"][RowDefinition._childDataField] = childValues;
+			}
+		}
+	}
+
 	return obj;
 };
 /** Since an index chain (e.g. .FTSE) can automatically produce rows for its constituent, we need to separate rowId and dataId, so that the constituents still use the same data Id as that of its parent.
@@ -13466,6 +13503,12 @@ RowDefinition.prototype.setStaticRowData = function(data, opt_fields) {
 	}
 };
 /** @public
+* @return {Object.<string, *>}
+*/
+RowDefinition.prototype._getStaticRowData = function() {
+	return this._staticValues ? Object(Util["b" /* cloneObject */])(this._staticValues) : null;
+};
+/** @public
 * @param {Object.<string, *>|Array} data
 * @param {Array.<string>=} opt_fields In case of the given data is an array, this param will be used for mapping index to field
 */
@@ -13766,6 +13809,22 @@ RowDefinition.deregisterFromView = function(rowIds, rowDef) {
 	rowDef._deregisterFromView(rowIds);
 	return rowIds;
 };
+/** @private
+* @param {string} ric
+* @return {Object}
+*/
+RowDefinition.prototype._getChildStaticRowData = function(ric) {
+	if(!this._staticValues) {
+		return null;
+	}
+
+	var childValues = this._staticValues[RowDefinition._childDataField];
+	if(!childValues) {
+		return null;
+	}
+
+	return childValues[ric] || null;
+};
 /** @public
 * @ignore
 * @param {string} ric
@@ -13793,12 +13852,19 @@ RowDefinition.prototype.addConstituent = function(ric) {
 
 	var newChild = !childDef;
 	if(newChild) {
-		childDef = new RowDefinition({
+		var rowOptions = {
 			"asConstituent": true,
 			"dataId": this._subId + ric,
 			"ric": ric,
 			"parent": this
-		});
+		};
+
+		var staticData = this._getChildStaticRowData(ric);
+		if(staticData) {
+			rowOptions["values"] = staticData;
+		}
+
+		childDef = new RowDefinition(rowOptions);
 	}
 
 	if(this._view) {
@@ -20516,6 +20582,33 @@ CellSpans.prototype.removeColumn = function (at) { // Use when a column is remov
 	}
 	return dirty;
 };
+/** @public
+* @param {boolean=} bool
+*/
+CellSpans.prototype.freezeMapping = function (bool) {
+	this._frozenMapping = bool !== false;
+	if(!this._frozenMapping) {
+		this._mapCellSpans();
+	}
+};
+
+
+/** @private
+*/
+CellSpans.prototype._mapCellSpans = function () {
+	var cellSpans = this._spans;
+	this._spans = [];
+	this._occupiedMap = {};
+	var i, cellSpan;
+	for(i = cellSpans.length; --i >= 0;) {
+		cellSpan = cellSpans[i];
+		if(cellSpan.indexX >= 0) {
+			cellSpan.register(this._spans, this._occupiedMap);
+		}
+	}
+};
+
+
 /** @public
 * @param {number} from
 * @param {number} amount This can be negative number
@@ -20532,18 +20625,10 @@ CellSpans.prototype.shiftColumn = function (from, amount) { // Use when a column
 			cellSpan.indexX += amount;
 		}
 	}
-	if(!dirty) { return false; }
+	if(!dirty || this._frozenMapping) { return false; }
 
 	// Re-registers all cellspans. Some of the cellspans may be lost due to shifting
-	var cellSpans = this._spans;
-	this._spans = [];
-	this._occupiedMap = {};
-	for(i = cellSpans.length; --i >= 0;) {
-		cellSpan = cellSpans[i];
-		if(cellSpan.indexX >= 0) {
-			cellSpan.register(this._spans, this._occupiedMap);
-		}
-	}
+	this._mapCellSpans();
 	return true;
 };
 /** @public
@@ -20832,6 +20917,12 @@ CellSpans.prototype._spans;
 */
 CellSpans.prototype._occupiedMap;
 
+/**
+* @private
+* @type {boolean}
+*/
+CellSpans.prototype._frozenMapping = false;
+
 /* harmony default export */ var components_CellSpans = (CellSpans);
 
 
@@ -24585,6 +24676,7 @@ LayoutGrid.prototype.setFrozenLayout = function (bool) {
 	if (this._frozenLayout !== bool) {
 		this._frozenLayout = bool;
 
+		this._cellSpans.freezeMapping(this._frozenLayout);
 		if (!this._frozenLayout) {
 			this._syncLayoutToColumns(0);
 			this._syncLayoutToRows(0, this._rowCount);
@@ -29299,6 +29391,20 @@ DataView.prototype.isCollapsed = function() {
 DataView.prototype.enableContentAsHeader = function(bool) {
 	this._shared.contentAsHeader = bool !== false;
 };
+/** set default collapse when new groups added
+* @public
+* @param {boolean=} collapse=false, if enable it, it will be set collapsing by default
+*/
+DataView.prototype.setDefaultCollapse = function(collapse) {
+	this._shared.defaultCollapse = !!collapse;
+};
+/** get default collapse when new groups added
+* @public
+* @return {boolean}
+*/
+DataView.prototype.getDefaultCollapse = function() {
+	return !!this._shared.defaultCollapse; // it can be null, convert to boolean
+};
 /** @private
 * @return {?Array.<string>}
 */
@@ -31217,6 +31323,10 @@ DataView.prototype._addGroup = function (value) {
 		}
 	}
 	member = new DataView();
+	var collapsed = this._shared.defaultCollapse;
+	if(collapsed != null) {
+		member._collapsed = collapsed;
+	}
 	member._groupId = groupId;
 	if(typeof value == "string") { // TODO: Raw value should not always be a string
 		if(value == "null") {
@@ -34529,7 +34639,7 @@ Core.prototype._rowHeightTimerId = 0;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.30";
+	return "5.1.32";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -36881,6 +36991,13 @@ Core.prototype.freezeLayout = function (opt_bool) {
 	if (prevState !== opt_bool) {
 		this._frozenLayout = opt_bool;
 
+		var stp = this.getPlugin("SortableTitlePlugin");
+		if(this._frozenLayout) {
+			if(stp) {
+				stp.freezeIndicator(true);
+			}
+		}
+
 		if (!this._frozenLayout) {
 			// Width has not yet changed so we need to disable it first
 			this._disableEvent("widthChanged");
@@ -36909,6 +37026,9 @@ Core.prototype.freezeLayout = function (opt_bool) {
 			if(!viewChanged) { // Always update virtualizer
 				this._rowVirtualizer.update(true); // Force section activation
 			}
+			if(stp) {
+				stp.freezeIndicator(false);
+			}
 		}
 		this._rowHeightSync = true;
 	}
@@ -39479,6 +39599,7 @@ ReferenceCounter.prototype.getSession = function() {
 		} else if(val < 0) {
 			removedEntries.push(key);
 		}
+		// else {} // when val 0 do nothing, doesn't change anything
 	}
 	return {
 		newEntries: newEntries.filter(Boolean),
@@ -39507,9 +39628,15 @@ ReferenceCounter.prototype.addReference = function(key, referer) {
 
 		if(this._counter[key]) {
 			++this._counter[key];
+			// The session will not change when a field already exists and a counter is attempted to be added
 		} else {
 			this._counter[key] = 1;
-			this._session[key] = 1;
+			if(this._session[key] === -1) {
+				this._session[key] = 0;
+			} else {
+				this._session[key] = 1;
+			}
+
 			return true;
 		}
 	}
@@ -39559,7 +39686,11 @@ ReferenceCounter.prototype.removeReference = function(key, referer, count) {
 	val -= count;
 	if(!val || val < 0) {
 		delete this._counter[key];
-		this._session[key] = -1;
+		if(this._session[key] === 1) {
+			this._session[key] = 0;
+		} else {
+			this._session[key] = -1;
+		}
 		return true;
 	}
 
@@ -40252,6 +40383,10 @@ SortableTitlePlugin.prototype._userManagedLogic = false;
 * @type {boolean}
 */
 SortableTitlePlugin.prototype._disabled = false;
+/** @private
+* @type {boolean}
+*/
+SortableTitlePlugin.prototype._frozenIndicator = false;
 /** Since DataView in real-time grid has only one ROW_DEF column, we need to re-map sorting field to sort correctly.
 * @private
 * @type {boolean}
@@ -40810,8 +40945,9 @@ SortableTitlePlugin.prototype.sortColumns = function (sortOptions, opt_arg) {
 * @param {Object=} opt_arg Event argument to be sent with preDataSorting event
 */
 SortableTitlePlugin.prototype.clearSortState = function (opt_arg) {
-	this._popSortState(0, opt_arg);
-	this.updateSortSymbols();
+	if(this._popSortState(0, opt_arg)) {
+		this.updateSortSymbols();
+	}
 };
 /** @description Perform sorting with the same parameter.
 * @public
@@ -41016,6 +41152,12 @@ SortableTitlePlugin.prototype.disableTwoStateSorting = function (disabled) {
 
 };
 /** @public
+* @param {boolean=} bool=true, if set to false it will be unfreeze indicator
+*/
+SortableTitlePlugin.prototype.freezeIndicator = function (bool) {
+	this._frozenIndicator = bool !== false;
+};
+/** @public
 * @param {boolean=} disabled
 */
 SortableTitlePlugin.prototype.disableSortSymbols = function (disabled) {
@@ -41628,7 +41770,7 @@ SortableTitlePlugin.prototype._clearSortSymbols = function (state) {
 SortableTitlePlugin.prototype._updateSortableIndicator = function (hostIndex) {
 	var t = this;
 	var host = t._hosts[hostIndex];
-	if (!host) { return; }
+	if (!host || this._frozenIndicator) { return; }
 
 	var section = host.getSection("title");
 	if (section == null) { return; }
@@ -41916,6 +42058,7 @@ SortableTitlePlugin._proto = SortableTitlePlugin.prototype;
 * @property {boolean=} formulaEngine=false If enabled, field with leading equal sign will be treated as a formula and rows will be filled with the calculated values.
 * @property {number=} adcPollingInterval=0 Length of polling interval for refreshing ADC data in milliseconds. The default value (0) means no polling.
 * @property {boolean=} fieldCaching=false If enabled, field definition will be caching internal mechanism
+* @property {string=} childDataField=CHILD_VALUES The given field will be used to store children's static data, such as row color assignment.
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference
@@ -42378,6 +42521,10 @@ Grid.prototype._pollingEnabled = true;
 * @private
 */
 Grid.prototype._fieldCaching = false;
+/** @type {string}
+* @private
+*/
+Grid.prototype._childDataField = "";
 
 
 /** @public
@@ -42792,6 +42939,9 @@ Grid.prototype.initialize = function(gridOption) {
 	}
 
 	// Row operations
+	if(gridOption["childDataField"] != null) {
+		this._childDataField = RowDefinition._childDataField = gridOption["childDataField"];
+	}
 	var rows = gridOption["rows"];
 	if(!rows) {
 		rows = gridOption["rics"] || null; // Make "rics" an alias to "rows"
@@ -42947,6 +43097,10 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 		obj["fieldCaching"] = this._fieldCaching;
 	}
 
+	if(this._childDataField) {
+		obj["childDataField"] = this._childDataField;
+	}
+
 	// get all rows config
 	var rowDefs = this.getAllRowDefinitions();
 	var rows = obj["rows"] = [];
@@ -43084,9 +43238,8 @@ Grid.prototype._onFieldAdded = function(e) {
 
 	// JET
 	if (this._subs) {
-		var colDefs = this.getColumnDefinitions();
-		var fields = colDefs.reduce(ColumnDefinition.getRealTimeFields, []);
-		this._subs["addFields"](fields);
+		var realtimeFields = addedFields.filter(ColumnDefinition.isRealTimeField);
+		this._subs["addFields"](realtimeFields);
 	}
 
 	this._dispatch(e.type, e);
@@ -43097,6 +43250,7 @@ Grid.prototype._onFieldAdded = function(e) {
 Grid.prototype._onFieldRemoved = function(e) {
 	var removedFields = e.removedFields;
 
+	// TODO: ADC fields have an interval load. Currently, we only keep the field but do not delete it.
 	// JET
 	if(this._subs) {
 		this._subs["removeFields"](removedFields);
@@ -43350,15 +43504,7 @@ Grid.prototype._onFieldLoadedError = function (err) {
  * @param {string} referrer
  */
 Grid.prototype._onFieldLoaded = function (field, referrer) {
-	// async process, the field can be remove before column added
-	var colIndex = this.getColumnIndex(field);
-	if(colIndex > -1) {
-		var colDef = this._getColumnDefinition(field);
-		if(colDef.isTimeSeriesField()) {
-			this._insertTimeSeriesChildren(colDef);
-		}
-		this._connector.addFields(field, referrer);
-	}
+	this._connector.addFields(field, referrer);
 };
 
 /**
@@ -43677,6 +43823,62 @@ Grid.prototype.moveColumnById = function (srcCol, destCol) {
 	return this.moveColumn(srcIndex, destIndex);
 };
 
+/** @public
+* @param {number|string|Array.<number|string>} colRefs List of column index or column id to be moved
+* @param {number|string} destCol Destination position where the moved columns will be placed BEFORE the specified position. This can be column id or index
+* @return {boolean} Return true if there is any change, and false otherwise
+*/
+Grid.prototype.reorderColumns = function (colRefs, destCol) {
+	var destId = (typeof destCol === "number") ? this.getColumnId(destCol) : destCol;
+
+	if(Array.isArray(colRefs)) {
+		var srcLen = colRefs.length;
+		if(srcLen > 1) {
+			var colIds = this.getColumnIds();
+			var srcIds = [];
+			var invalidDest = false;
+			var i;
+			for(i = 0; i < srcLen; ++i) {
+				var colRef = colRefs[i];
+				var srcId = (typeof colRef === "number") ? colIds[colRef] : colRef;
+				if(srcId) {
+					srcIds.push(srcId);
+					if(destId === srcId) {
+						invalidDest = true; // Destination must not exist in source columns
+					}
+				}
+			}
+			srcLen = srcIds.length;
+			if(invalidDest) { // Find the next valid destination where it is not contained in the source columns
+				var colCount = colIds.length;
+				var destIdx = this.getColumnIndex(destId);
+				if(destIdx >= 0) {
+					while(++destIdx < colCount) {
+						destId = colIds[destIdx];
+						if(srcIds.indexOf(destId) < 0) {
+							break;
+						}
+					}
+				}
+				if(destIdx < 0 || destIdx >= colCount) {
+					destId = "";
+				}
+			}
+
+			var dirty = 0;
+			for(i = 0; i < srcLen; ++i) {
+				dirty |= this.moveColumnById(srcIds[i], destId);
+			}
+			// TODO: Handle the case where all columns stay in the same place
+			return dirty ? true : false;
+		} else {
+			return this.moveColumnById(colRefs[0], destId);
+		}
+	}
+
+	// colRefs will be a number or string
+	return this.moveColumnById(colRefs, destId);
+};
 
 /** The hidden column still occupies the same index.
 * @public
@@ -44867,7 +45069,7 @@ Grid.prototype.unpinColumn = function(colRef, dest) {
 		var len = ary.length;
 
 		var dirty = 0;
-		for(var i = 0; i < len; ++i) {
+		for(var i = len; --i >= 0;) { // WARNING: unpinning is done in reversed order
 			dirty |= this._unpinColumn(ary[i], dest);
 		}
 		return dirty ? true : false;