@refinitiv-ui/efx-grid 6.0.37 → 6.0.39

package/lib/core/dist/core.js

@@ -3667,18 +3667,18 @@ TrackLayout.prototype.showLane = function (index, opt_val) {
 };
 /** @public
 * @param {number} index
-* @param {boolean=} opt_hidden
-* @param {number=} opt_bitIndex
+* @param {boolean=} hidden
+* @param {number=} bitIndex
 * @return {boolean}
 */
-TrackLayout.prototype.hideLane = function (index, opt_hidden, opt_bitIndex) {
+TrackLayout.prototype.hideLane = function (index, hidden, bitIndex) {
 	if (index < 0 || index >= this._laneCount) { return false; }
 
 	var col = this._newColumn(index);
 	var prevVis = !col.invisibility;
 
-	var bit = (opt_bitIndex != null) ? this._bits[opt_bitIndex] : 1;
-	if(opt_hidden !== false) {
+	var bit = (bitIndex != null) ? this._bits[bitIndex] : 1;
+	if(hidden !== false) {
 		col.invisibility |= bit; // Add invisibility bit
 	} else {
 		col.invisibility &= ~bit; // Remove invisibility bit
@@ -3689,6 +3689,24 @@ TrackLayout.prototype.hideLane = function (index, opt_hidden, opt_bitIndex) {
 	}
 	return false;
 };
+/** Return true if the lane does not exist nor is not hidden. Return false only if the lane is hidden by the specified bit
+* @public
+* @param {number} index
+* @param {number=} bitIndex
+* @return {boolean}
+*/
+TrackLayout.prototype.getLaneVisibilityBit = function (index, bitIndex) {
+	if (index >= 0 && index < this._laneCount) {
+		var col = this._cols[index];
+		if(col) {
+			var bit = (bitIndex != null) ? this._bits[bitIndex] : 1;
+			if(col.invisibility & bit) {
+				return false;
+			}
+		}
+	}
+	return true;
+};
 /** @public
 * @param {boolean=} opt_shown
 */
@@ -11631,6 +11649,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>}
 */
@@ -11737,7 +11762,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
@@ -11882,9 +11918,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) {
@@ -11897,7 +11934,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;
 		}
 	}
@@ -12006,6 +12047,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
@@ -12022,6 +12075,7 @@ GroupDefinitions.prototype.setGroupName = function (groupId, groupName) {
 
 	return false;
 };
+
 /* harmony default export */ const es6_GroupDefinitions = ((/* unused pure expression or super */ null && (GroupDefinitions)));
 
 
@@ -25398,6 +25452,7 @@ var Core_Core = function (opt_initializer) {
 	_t._onVScroll = _t._onVScroll.bind(_t);
 	_t._onHScroll = _t._onHScroll.bind(_t);
 	_t._onSyncVScroll = _t._onSyncVScroll.bind(_t);
+	_t._onSyncHScroll = _t._onSyncHScroll.bind(_t);
 	_t.updateLayout = _t.updateLayout.bind(_t);
 	_t._onRowRefresh = _t._onRowRefresh.bind(_t);
 	_t._onVScrollEnabled = _t._onVScrollEnabled.bind(_t);
@@ -25510,7 +25565,8 @@ var Core_Core = function (opt_initializer) {
 		"rowPositionChanged",
 		"beforeColumnBoundUpdate",
 		"beforeBatchOperation",
-		"afterBatchOperation"
+		"afterBatchOperation",
+		"pinningChanged"
 	);
 
 	// For debugging in advanced optimization mode
@@ -25859,7 +25915,7 @@ Core_Core.prototype._batches = null;
 * @return {string}
 */
 Core_Core.getVersion = function () {
-	return "5.1.50";
+	return "5.1.55";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -25901,6 +25957,12 @@ Core_Core.prototype.dispose = function () {
 		mainScrolbar.unlisten("scroll", this._onSyncVScroll);
 		this._vscrollbar._mainScrollbar = null;
 	}
+	mainScrolbar = this._hscrollbar._mainScrollbar;
+	if(mainScrolbar) {
+		mainScrolbar.unlisten("scroll", this._onSyncHScroll);
+		this._hscrollbar._mainScrollbar = null;
+	}
+
 	this._vscrollbar.dispose();
 	this._hscrollbar.dispose();
 	this._rowHeightConflator.dispose();
@@ -28214,10 +28276,14 @@ Core_Core.prototype.freezeColumn = function (frozenColIndex, numRightColumn) {
 	var colCount = this.getColumnCount();
 	var leftPinnedCount = 0;
 	var rightPinnedCount = 0;
+	var dirty = false;
 	if (frozenColIndex || frozenColIndex === 0) {
 		this._hScrollbarEnabled = true;
 		leftPinnedCount = (frozenColIndex >= 0) ? frozenColIndex + 1 : 0;
-		this._pinnedLeftColumnCount = leftPinnedCount; // This variable is used for caching
+		if (this._pinnedLeftColumnCount !== leftPinnedCount) {
+			dirty = true;
+			this._pinnedLeftColumnCount = leftPinnedCount; // This variable is used for caching
+		}
 
 		for (i = 0; i < colCount; ++i) {
 			colDef = this._getColumnDef(i);
@@ -28228,7 +28294,10 @@ Core_Core.prototype.freezeColumn = function (frozenColIndex, numRightColumn) {
 	}
 	if(numRightColumn != null) {
 		rightPinnedCount = numRightColumn > 0 ? numRightColumn : 0;
-		this._pinnedRightColumnCount = rightPinnedCount; // This variable is used for caching
+		if (this._pinnedRightColumnCount !== rightPinnedCount) {
+			dirty = true;
+			this._pinnedRightColumnCount = rightPinnedCount; // This variable is used for caching
+		}
 
 		for (i = colCount; --i >= 0;) {
 			colDef = this._getColumnDef(i);
@@ -28239,6 +28308,12 @@ Core_Core.prototype.freezeColumn = function (frozenColIndex, numRightColumn) {
 	this._onColumnCountChanged(); // Activate horizontal scrollbar and column virtualization
 	this._updateScrollbarWidth(true, true);
 	this._updateColumnSeparators();
+
+	if (dirty) {
+		if (!this._isEventDispatching("pinningChanged")) {
+			this._dispatch("pinningChanged", {});
+		}
+	}
 };
 
 /** @private
@@ -29063,6 +29138,26 @@ Core_Core.prototype.synchronizeVScrollbar = function (subGrid) {
 	this._vscrollbar.listen("scroll", subGrid._onSyncVScroll);
 };
 
+/** Synchronize two horizontal scrollbars of two grid, by hiding its scrollbar and using the one from the given grid
+* @public
+* @param {Core} subGrid
+*/
+Core_Core.prototype.synchronizeHScrollbar = function (subGrid) {
+	subGrid.unlisten("mousemove", subGrid._onMouseMove);
+	subGrid.listen("mousemove", this._onMouseMove);
+
+	var hscrollbar = subGrid.getHScrollbar();
+	hscrollbar._mainScrollbar = this._hscrollbar; // HACK
+
+	hscrollbar.setStyle("visibility", "hidden");
+	hscrollbar.setStyle("pointerEvents", "none");
+	hscrollbar.disableMouseWheel(); // Disable sub-grid wheel behavior
+	hscrollbar.attachToExternalElement(this._hscrollbar.getParent()); // MouseWheel event is still available on the main
+
+	// TODO: Check if we need to re-append this._hscrollbar to move it to the front over other grid elements.
+	this._hscrollbar.listen("scroll", subGrid._onSyncHScroll);
+};
+
 /** Fires data binding event without actual change in the data source. <br>
 * This will force visual elements to be re-rendered with the latest data in the data source.
 * @public
@@ -29205,7 +29300,7 @@ Core_Core.prototype.getHorizontalLayout = function () {
 * @ignore
 * @param {number} colIndex
 * @param {boolean} bool
-* @param {number} flag Default is 0
+* @param {number} flag
 * @return {boolean}
 */
 Core_Core.prototype.setColumnVisibility = function (colIndex, bool, flag) {
@@ -29225,6 +29320,16 @@ Core_Core.prototype.setColumnVisibility = function (colIndex, bool, flag) {
 	}
 	return false;
 };
+/** Get visibility state for the specified flag. This is for internal use only
+* @public
+* @ignore
+* @param {number} colIndex
+* @param {number=} flag
+* @return {boolean}
+*/
+Core_Core.prototype.getColumnVisibility = function (colIndex, flag) {
+	return this._layoutX.getLaneVisibilityBit(colIndex, flag);
+};
 
 /** @public
 * @param {number} size
@@ -30718,6 +30823,12 @@ Core_Core.prototype._onSyncVScroll = function (e) {
 	this._vscrollbar.setScrollTop(e.scrollTop);
 };
 /** @private
+* @param {Object} e
+*/
+Core_Core.prototype._onSyncHScroll = function (e) {
+	this._hscrollbar.setScrollLeft(e.scrollLeft);
+};
+/** @private
 * @return {number} index of footer section
 */
 Core_Core.prototype._getFooterStartIndex = function () {
@@ -31170,6 +31281,7 @@ es6_Ext.inherits(SortableTitlePlugin, event_EventDispatcher);
 /** The sorting object which will be used for initialSort config.
  * @typedef {Object} SortableTitlePlugin~InitialSort
  * @property {number} colIndex Index of the column
+ * @property {string} field field of the column
  * @property {SortableTitlePlugin~SortOrder=} sortOrder=null Set to "d" for descending order and "a" for ascending order
  * @property {SortableTitlePlugin~SortOrder=} order Alias of sortOrder
  */
@@ -31179,6 +31291,8 @@ SortableTitlePlugin.InitialSort;
  * @typedef {Object} SortableTitlePlugin~ColumnOptions
  * @property {boolean=} sortable=false If enable, the column can be sorted by user click
  * @property {string=} sortBy Field to be used for sorting. If defined, user can click at the header section to sort the column
+ * @property {string=} sort="" Deprecated Alias to `sortOrder`
+ * @property {string=} sortOrder="" The column can be sorted in ascending and descending order by specifying the order "a", "d". This option will sort the column when it is initialized or inserted at runtime.
  * @property {DataTable.SortLogic=} sortLogic=null Custom compare function for sorting
  * @property {DataTable.SortLogic=} sortingLogic Alias to `sortLogic`
  * @property {DataTable.SortLogic=} sorter Alias to `sortLogic`
@@ -31383,7 +31497,7 @@ SortableTitlePlugin.prototype.afterInit = function () {
 	// Set logic to the data source, since the data source not available during the initialization
 	t.setSortLogics(t._sortLogic);
 
-	var userInput = t._initialSort;
+	var userInput = t._initialSort; // This will be passed from the user when they want to start with initialize sort
 	if (userInput != null) {
 		if(Array.isArray(userInput)) {
 			if(t._maxCount === 1) { // TODO: max count could be part of sortColumns method
@@ -31532,14 +31646,32 @@ SortableTitlePlugin.prototype.getConfigObject = function (gridOptions) {
 
 	if (!host) return obj;
 
-	var len = host.getColumnCount();
-	var col, opt, field;
-	for(var i = 0; i < len; ++i) {
+	var sortedColumns = this.getSortedColumns();
+	var col, i, len;
+	// Multiple column sorting cannot retain the sort order in the column option.
+	if(this._maxCount === 1 && sortedColumns != null) {
+		// assign sorting state to each columns
+		len = sortedColumns.length;
+		for (i = 0; i < len; i++) {
+			var sortedColumn = sortedColumns[i];
+			var colIndex = sortedColumn["colIndex"];
+			col = columns[colIndex];
+			if (!col) {
+				col = columns[colIndex] = {};
+			}
+			col["sortOrder"] = sortedColumn["sortOrder"];
+		}
+	}
+
+	len = host.getColumnCount();
+	var opt, field;
+	for(i = 0; i < len; ++i) {
 		col = columns[i];
 		if (!col) {
 			col = columns[i] = {};
 		}
 
+		// TODO: We should get the state from the core, instead of getting the sort options.
 		opt = this._getSortOptions(i);
 
 		if (!opt) { continue; }
@@ -31553,7 +31685,7 @@ SortableTitlePlugin.prototype.getConfigObject = function (gridOptions) {
 		}
 		field = opt["field"];
 		if (field) {
-			if(col["field"] !== field) {
+			if(col["field"] != null && col["field"] !== field) { // Core does not have field properties, so when you try to call getConfigObject in Core, it will return sortBy too.
 				col["sortBy"] = field;
 			} // else The default value is an empty sortBy, which refers to the same column field by default.
 
@@ -31569,7 +31701,7 @@ SortableTitlePlugin.prototype.getConfigObject = function (gridOptions) {
 		extOptions = obj["sorting"] = {};
 	}
 
-	var val = this.getSortedColumns();
+	var val = sortedColumns;
 	if(val != null) {
 		extOptions["initialSort"] = val;
 	}
@@ -32076,7 +32208,14 @@ SortableTitlePlugin.prototype.disableTwoStateSorting = function (disabled) {
 * @param {boolean=} bool=true, if set to false it will be unfreeze indicator
 */
 SortableTitlePlugin.prototype.freezeIndicator = function (bool) {
+	var prevState = this._frozenIndicator;
 	this._frozenIndicator = bool !== false;
+	if(prevState && !this._frozenIndicator) { // from frozen to unfrozen, update the ui
+		for (var i = this._hosts.length; --i >= 0;) {
+			this._updateSortableIndicator(i);
+		}
+	}
+
 };
 /** @public
 * @param {boolean=} disabled
@@ -32152,7 +32291,7 @@ SortableTitlePlugin.prototype._initialSortByColumnField = function (options) {
 	var colCount = columns ?  columns.length : 0;
 	for (var i = 0; i < colCount; i++) {
 		var column = columns[i];
-		var sortOrder = column["defaultSort"] || column["sort"]; // composite and rt grid option for default sort order
+		var sortOrder = column["defaultSort"]; // composite and rt grid option for default sort order
 		if (sortOrder) {
 			// TODO: Support multi-column sorting
 			return {
@@ -32582,6 +32721,12 @@ SortableTitlePlugin.prototype._onColumnAdded = function (e) {
 	} else {
 		t.disableColumnSorting(colIndex, true);
 	}
+
+	var sortOrder = column["sortOrder"] || column["sort"];
+	if(sortOrder != null) {
+		t.clearSortState(); // clear previous sorting state
+		t.sortColumn(colIndex, sortOrder);
+	}
 };
 
 /** @private