@refinitiv-ui/efx-grid 6.0.53 → 6.0.55

package/lib/core/dist/core.js

@@ -11432,7 +11432,7 @@ GroupDefinitions.getLeafDescendants = function (groupMap, groupId) {
 		groupDef = unvisitedGroups[visitedCount++];
 		visitedMap[groupDef.id] = true;
 		var chdr = groupDef.children;
-		var len = chdr.length;
+		var len = chdr ? chdr.length : 0;
 		for(var i = 0; i < len; ++i) {
 			var childId = chdr[i];
 			groupDef = groupMap[childId];
@@ -11452,44 +11452,30 @@ GroupDefinitions.getLeafDescendants = function (groupMap, groupId) {
 /** @private
 * @function
 * @param {Object} obj
-* @return {Object}
+* @return {Object} Return a new object with guaranteed children property
 */
 GroupDefinitions._cloneObject = function(obj) {
 	var newObj = cloneObject(obj);
-	if(Array.isArray(newObj.children)) {
-		newObj.children = newObj.children;
+	if(Array.isArray(newObj.children)) { // This is to prevent modification from the outside source
+		newObj.children = newObj.children.slice();
 	} else {
 		newObj.children = [];
 	}
 	return newObj;
 };
-/** @private
-* @param {Object} groupMap
-* @return {!Object}
-*/
-GroupDefinitions._cloneGroupMap = function (groupMap) {
-	var outMap = {};
-	for(var groupId in groupMap) {
-		var groupDef = groupMap[groupId];
-		var obj = GroupDefinitions._cloneObject(groupDef);
-		obj.children = groupDef.children.slice();
-		outMap[groupId] = obj;
-	}
-	return outMap;
-};
 
 /** @private
 * @function
 * @param {Array.<string>|Object} obj
 * @param {string=} groupId
-* @return {Object}
+* @return {Object} Return a new object with guaranteed children property
 */
 GroupDefinitions._toGroupDefinition = function(obj, groupId) {
 	var groupDef = null;
 	if(obj) {
 		if(Array.isArray(obj)) {
 			groupDef = {
-				children: obj
+				children: obj.slice()
 			};
 		} else {
 			groupDef = GroupDefinitions._cloneObject(obj);
@@ -11569,7 +11555,43 @@ GroupDefinitions.prototype.getGroupMap = function () {
 * @return {!Object.<string, Object>}
 */
 GroupDefinitions.prototype.cloneGroupMap = function () {
-	return GroupDefinitions._cloneGroupMap(this._groupMap);
+	var groupMap = this._groupMap;
+	var outMap = {};
+	for(var groupId in groupMap) {
+		var groupDef = groupMap[groupId];
+		var obj = GroupDefinitions._cloneObject(groupDef);
+		outMap[groupId] = obj;
+	}
+	return outMap;
+};
+/** In case of a children array has been modified outside of GroupDefinitions, this method is needed to re-create internal maps to reflect existing structure
+* @public
+*/
+GroupDefinitions.prototype.rebuildMap = function () {
+	var groupMap = this._groupMap;
+	var childToParent = this._childToParent = {};
+
+	// Create child to parent map
+	var groupIds = Object.keys(groupMap);
+	var grpCount = groupIds.length;
+	var i, groupId;
+	for(i = 0; i < grpCount; ++i) {
+		groupId = groupIds[i];
+		var chdr = groupMap[groupId].children;
+		var childCount = chdr ? chdr.length : 0;
+		for (var j = 0; j < childCount; j++) {
+			childToParent[chdr[j]] = groupId;
+		}
+	}
+
+	// Apply a parent id to group definition to make it easier to find depth
+	for(i = 0; i < grpCount; ++i) {
+		groupId = groupIds[i];
+		var parentId = childToParent[groupId];
+		if(parentId) {
+			groupMap[groupId].parentId = parentId;
+		}
+	}
 };
 
 /** Get immediate child ids of the specified group. The returned array can contain both child ids and group ids
@@ -11649,7 +11671,7 @@ GroupDefinitions.prototype.getParentIds = function(childId) {
 };
 /** @public
 * @param {string} childId
-* @param {number=} groupLevel
+* @param {number=} groupLevel Default is to retrieve immediate parent id. Use 0 to get root (topmost) group id
 * @return {string}
 */
 GroupDefinitions.prototype.getParentId = function (childId, groupLevel) {
@@ -11677,47 +11699,25 @@ GroupDefinitions.prototype.removeAllGroups = function () {
 	}
 	return false;
 };
-/** Remove all existing group definitions and replace them with the given definitions.
+/** Remove all existing group definitions and replace them with the given definitions. Note that this method does not check for circular referencing nor duplication of ids
 * @public
 * @param {Array.<Object>=} groupDefs Use null or empty array to remove all existing groups
 */
 GroupDefinitions.prototype.setGroups = function (groupDefs) {
 	// Clear existing group structure
 	var groupMap = this._groupMap = {};
-	var childToParent = this._childToParent = {};
 
 	// Create group map
-	var i;
 	var grpCount = groupDefs ? groupDefs.length : 0;
-	var groupId = "";
-	for (i = 0; i < grpCount; i++) {
+	for (var i = 0; i < grpCount; i++) {
 		var groupDef = groupDefs[i];
-		groupId = groupDef.id;
+		var groupId = groupDef.id;
 		if(groupId) {
-			groupMap[groupId] = groupDef;
+			groupMap[groupId] = GroupDefinitions._cloneObject(groupDef);
 		}
 	}
 
-	// Create child to parent map
-	var groupIds = Object.keys(groupMap);
-	grpCount = groupIds.length;
-	for(i = 0; i < grpCount; ++i) {
-		groupId = groupIds[i];
-		var children = groupMap[groupId].children;
-		var childCount = children.length;
-		for (var j = 0; j < childCount; j++) {
-			childToParent[children[j]] = groupId;
-		}
-	}
-
-	// Apply a parent id to group definition to make it easier to find depth
-	for(i = 0; i < grpCount; ++i) {
-		groupId = groupIds[i];
-		var parentId = childToParent[groupId];
-		if(parentId) {
-			groupMap[groupId].parentId = parentId;
-		}
-	}
+	this.rebuildMap();
 };
 /** Add new group definition to existing group structure. Existing group with the same id will be replaced.
 * @public
@@ -11746,11 +11746,11 @@ GroupDefinitions.prototype.removeGroup = function (groupId) {
 	}
 	return false;
 };
-/** Replace and update existing group definition. New group is added if the given id has no match. Existing group will be removed of no new definition is given.
+/** Replace and update existing group definition. A new group will be added, only if the given id has no match. Existing group will be removed of no new definition is given.
 * @public
 * @param {string} groupId
-* @param {Array.<string>|Object=} groupDef
-* @return {string} Return group Id. Return empty string if nothing has been changed.
+* @param {(Array.<string>|Object)=} groupDef
+* @return {string} Return group Id. Return empty string, if nothing has been changed
 */
 GroupDefinitions.prototype.setGroup = function (groupId, groupDef) {
 	if(!groupId) {
@@ -11771,7 +11771,7 @@ GroupDefinitions.prototype.setGroup = function (groupId, groupDef) {
 		}
 		this._groupMap[groupId] = newDef;
 
-		var chdr = newDef.children;
+		var chdr = newDef.children; // newDef is guaranteed to have children property
 		var len = chdr.length;
 		for(var i = 0; i < len; ++i) {
 			var childId = chdr[i];
@@ -11803,7 +11803,8 @@ GroupDefinitions.prototype._ungroupChildren = function(children) {
 	}
 };
 
-/** @public
+/** Check if the given child id is an immediate child of the given group
+* @public
 * @param {string} parentId Group id
 * @param {string} childId
 * @return {boolean}
@@ -11813,7 +11814,30 @@ GroupDefinitions.prototype.hasGroupChild = function (parentId, childId) {
 	if(childId && groupDef) {
 		var chdr = groupDef.children;
 		if(chdr) {
-			return chdr.indexOf(childId) >= 0;
+			return chdr.indexOf(childId) >= 0; // TODO: Use childToParent map to improve performance
+		}
+	}
+	return false;
+};
+/** Check if the specified id is contained within the given group regardless of any group level that the id is in
+* @public
+* @param {string} groupId
+* @param {string} childId
+* @return {boolean}
+*/
+GroupDefinitions.prototype.contains = function (groupId, childId) {
+	if(groupId && childId) {
+		if(groupId === childId) {
+			return true;
+		}
+		var levelLimit = 20;
+		var parentId = this._childToParent[childId];
+		while(parentId && levelLimit) { // WARNING: Circular dependency could happen
+			if(groupId === parentId) {
+				return true;
+			}
+			--levelLimit;
+			parentId = this._childToParent[parentId];
 		}
 	}
 	return false;
@@ -11880,7 +11904,7 @@ GroupDefinitions.prototype.unsetParent = function (childId) {
 	var parentDef = this._groupMap[parentId];
 	if(parentDef) {
 		var chdr = parentDef.children;
-		if(chdr.length) {
+		if(chdr && chdr.length) {
 			var at = chdr.indexOf(childId);
 			if (at >= 0) {
 				chdr.splice(at, 1); // splice is slow
@@ -11898,7 +11922,7 @@ GroupDefinitions.prototype.removeAllChildren = function(groupId) {
 	var grpDef = this._groupMap[groupId];
 	if(grpDef) {
 		var chdr = grpDef.children;
-		var len = chdr.length;
+		var len = chdr ? chdr.length : 0;
 		if(len) {
 			grpDef.children = [];
 			for(var i = 0; i < len; ++i) {
@@ -26029,7 +26053,7 @@ Core_Core.prototype._batches = null;
 * @return {string}
 */
 Core_Core.getVersion = function () {
-	return "5.1.70";
+	return "5.1.72";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -29912,18 +29936,21 @@ Core_Core.prototype.getValidColumnList = function (colIds, columnMap) {
 };
 
 /** @public
-* @description Create mapping object from an array of strings
-* @param {Array.<string>=} colIds
+* @description Create mapping object from an array of strings or column indices
+* @param {Array.<string|number>=} colRefs
 * @return {!Object} Column mapping object
 */
-Core_Core.prototype.createColumnMap = function (colIds) {
-	if(!colIds){
-		colIds = this.getColumnIds();
+Core_Core.prototype.createColumnMap = function (colRefs) {
+	if(!colRefs){
+		colRefs = this.getColumnIds();
 	}
 	var mappingObj = {};
-	var count = colIds.length;
+	var count = colRefs.length;
 	for(var i = 0; i < count; i++){
-		var colId = colIds[i];
+		var colId = colRefs[i];
+		if(typeof colId ===  "number"){
+			colId = this.getColumnId(colId);
+		}
 		if(colId){
 			mappingObj[colId] = true;
 		}
@@ -29956,7 +29983,14 @@ Core_Core.prototype.stopBatch = function (batchType) {
 	if(!batchType){
 		return false;
 	}
+	// The "columnVisibilityChanged" event is blocked while the "reset" batch operation is in progress, so this event will not be fired until the batch operation succeeds.
+	if(batchType === "reset") {
+		this._disableEvent("columnVisibilityChanged", true);
+	}
 	this._dispatch("afterBatchOperation", { batches: this._batches, batchType: batchType });
+	if(batchType === "reset") {
+		this._disableEvent("columnVisibilityChanged", false);
+	}
 
 	delete this._batches[batchType];
 	if(isEmptyObject(this._batches)){