@refinitiv-ui/efx-grid 6.0.24 → 6.0.26

package/lib/tr-grid-util/es6/GroupDefinitions.d.ts

@@ -0,0 +1,58 @@
+import { cloneObject } from "./Util.js";
+
+declare class GroupDefinitions {
+
+    constructor();
+
+    public static getGroupId(groupDef: any): string;
+
+    public static calcTreeDepth(groupMap: { [key: string]:  any }|null, groupDef: any): number;
+
+    public static getLeafDescendants(groupMap: { [key: string]:  any }|null, groupId: string): (string)[]|null;
+
+    public toString(): string;
+
+    public getGroup(groupId: string): any;
+
+    public getDefinition(groupId: string): any;
+
+    public getGroups(): (any)[];
+
+    public getGroupMap(): { [key: string]:  any };
+
+    public cloneGroupMap(): { [key: string]:  any };
+
+    public getGroupChildren(groupId: string): (string)[]|null;
+
+    public getLeafDescendants(groupId: string): (string)[]|null;
+
+    public getGroupLevel(groupId: string): number;
+
+    public getRootGroup(groupId: string): any;
+
+    public getParentGroup(childId: string): any;
+
+    public getParentIds(childId: string): (string)[]|null;
+
+    public getParentId(childId: string, groupLevel?: number|null): string;
+
+    public setGroups(groupDefs?: (any)[]|null): void;
+
+    public addGroup(groupDef: any): string;
+
+    public removeGroup(groupId: string): boolean;
+
+    public setGroup(groupId: string, groupDef?: (string)[]|any|null): string;
+
+    public addGroupChild(parentId: string, childId: string): boolean;
+
+    public removeGroupChild(childId: string): boolean;
+
+    public removeAllChildren(groupId: string): boolean;
+
+    public setGroupChildren(groupId: string, newChildList: (string)[]|null): boolean;
+
+}
+
+export default GroupDefinitions;
+export { GroupDefinitions };

package/lib/tr-grid-util/es6/GroupDefinitions.js

@@ -0,0 +1,538 @@
+import { cloneObject } from "./Util.js";
+
+/** @constructor
+*/
+var GroupDefinitions = function () {
+	this._groupMap = {};
+	this._childToParent = {};
+};
+
+/** @type {!Object.<string, Object>}
+* @description A map of group id to group defintion
+* @private
+*/
+GroupDefinitions.prototype._groupMap;
+/** @type {!Object.<string, string>}
+* @description A map of child id to parent id
+* @private
+*/
+GroupDefinitions.prototype._childToParent;
+
+
+/** @public
+* @function
+* @param {Object} groupDef
+* @return {string}
+*/
+GroupDefinitions.getGroupId = function(groupDef) {
+	if(groupDef) {
+		return groupDef.id || "";
+	}
+	return "";
+};
+/** @public
+* @param {Object.<string, Object>} groupMap
+* @param {Object} groupDef
+* @return {number} Return total number of parents. Return 0 if there is no parent.
+*/
+GroupDefinitions.calcTreeDepth = function (groupMap, groupDef) {
+	var curDepth = -1;
+	var curNode = groupDef;
+	while(curNode) { // WARNING: infinite loop could occured, if parentId is cycle back to one of the child group
+		if(++curDepth > 15) {
+			console.log("WARNING: Infinite loop detected during column group creation");
+			break;
+		}
+		var parentId = curNode.parentId;
+		curNode = groupMap[parentId];
+	}
+	return curDepth;
+};
+/** @public
+* @param {Object.<string, Object>} groupMap
+* @param {string} groupId
+* @return {Array.<string>}
+*/
+GroupDefinitions.getLeafDescendants = function (groupMap, groupId) {
+	var groupDef = groupMap[groupId];
+	if(!groupDef) {
+		return null;
+	}
+
+	var leaves = [];
+	var unvisitedGroups = [groupDef];
+	var visitedCount = 0;
+	var visitedMap = {};
+	while(visitedCount < unvisitedGroups.length) {
+		groupDef = unvisitedGroups[visitedCount++];
+		visitedMap[groupDef.id] = true;
+		var chdr = groupDef.children;
+		var len = chdr.length;
+		for(var i = 0; i < len; ++i) {
+			var childId = chdr[i];
+			groupDef = groupMap[childId];
+			if(groupDef) {
+				if(!visitedMap[groupDef.id]) { // Prevent infinite loop
+					unvisitedGroups.push(groupDef);
+				}
+			} else {
+				leaves.push(childId);
+			}
+		}
+	}
+	return leaves;
+};
+
+
+/** @private
+* @function
+* @param {Object} obj
+* @return {Object}
+*/
+GroupDefinitions._cloneObject = function(obj) {
+	var newObj = cloneObject(obj);
+	if(Array.isArray(newObj.children)) {
+		newObj.children = newObj.children;
+	} 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}
+*/
+GroupDefinitions._toGroupDefinition = function(obj, groupId) {
+	var groupDef = null;
+	if(obj) {
+		if(Array.isArray(obj)) {
+			groupDef = {
+				children: obj
+			};
+		} else {
+			groupDef = GroupDefinitions._cloneObject(obj);
+		}
+		if(groupId) {
+			if(!groupDef.id) {
+				groupDef.name = groupId;
+			}
+			groupDef.id = groupId;
+		}
+	}
+	return groupDef;
+};
+
+/** @public
+* @return {string}
+*/
+GroupDefinitions.prototype.toString = function() {
+	var groupMap = this._groupMap;
+	var lines = [];
+	lines.push("=== groupDefs ===");
+	for(var key in groupMap) {
+		var group = groupMap[key];
+		lines.push(key + ": " + JSON.stringify(group, ["id", "parentId", "children"]));
+	}
+
+	lines.push("=== childToParent ===");
+	lines.push(JSON.stringify(this._childToParent, null, 2));
+	lines.push("");
+
+	return lines.join("\n");
+};
+
+/** Get group definition object. This method can be used to check whether the given id is a group id or not (i.e., isGroupId).
+* @public
+* @param {string} groupId
+* @return {Object}
+*/
+GroupDefinitions.prototype.getGroup = function (groupId) {
+	if(groupId) {
+		return this._groupMap[groupId] || null;
+	}
+	return null;
+};
+/** @public
+* @function
+* @param {string} groupId
+* @return {Object}
+*/
+GroupDefinitions.prototype.getDefinition = GroupDefinitions.prototype.getGroup;
+/** Get array of all existing group definitions
+* @public
+* @return {!Array.<Object>}
+*/
+GroupDefinitions.prototype.getGroups = function () {
+	var groupDefs = [];
+	var groupMap = this._groupMap;
+	for(var key in groupMap) {
+		groupDefs.push(groupMap[key]);
+	}
+	return groupDefs;
+};
+/** @public
+* @return {!Object.<string, Object>}
+*/
+GroupDefinitions.prototype.getGroupMap = function () {
+	return this._groupMap; // WARNING: Allow access to private member
+};
+/** @public
+* @return {!Object.<string, Object>}
+*/
+GroupDefinitions.prototype.cloneGroupMap = function () {
+	return GroupDefinitions._cloneGroupMap(this._groupMap);
+};
+
+/** Get immediate child ids of the specified group. The returned array can contain both child ids and group ids
+* @public
+* @param {string} groupId
+* @return {Array.<string>}
+*/
+GroupDefinitions.prototype.getGroupChildren = function (groupId) {
+	var groupDef = this._groupMap[groupId];
+	return groupDef ? groupDef.children : null;
+};
+/** Get all non-group descendants of the given group id.
+* @public
+* @param {string} groupId
+* @return {Array.<string>}
+*/
+GroupDefinitions.prototype.getLeafDescendants = function (groupId) {
+	return GroupDefinitions.getLeafDescendants(this._groupMap, groupId);
+};
+/** @public
+* @param {string} groupId
+* @return {number} Return -1 if the given groupDef is null. Return 0 if there is no parent. Return 1 or more if it has a parent
+*/
+GroupDefinitions.prototype.getGroupLevel = function (groupId) {
+	return GroupDefinitions.calcTreeDepth(this._groupMap, this._groupMap[groupId]);
+};
+/** @public
+* @param {string} groupId
+* @return {Object}
+*/
+GroupDefinitions.prototype.getRootGroup = function (groupId) {
+	if (!groupId) {
+		return null;
+	}
+	var groupMap = this._groupMap;
+	var groupDef = groupMap[groupId] || null;
+	// TODO: Support column id
+	if(groupDef) {
+		while (groupDef.parentId) {
+			var parentDef = groupMap[groupDef.parentId];
+			if(parentDef) {
+				groupDef = parentDef;
+			} else {
+				break;
+			}
+		}
+	}
+	return groupDef;
+};
+/** @public
+* @param {string} childId
+* @return {Object}
+*/
+GroupDefinitions.prototype.getParentGroup = function (childId) {
+	return this.getGroup(this._childToParent[childId]);
+};
+/** @public
+* @param {string} childId
+* @return {Array.<string>}
+*/
+GroupDefinitions.prototype.getParentIds = function(childId) {
+	if (childId && typeof childId === "string") {
+		var groupId = this._childToParent[childId];
+		if (groupId) {
+			var groupIds = [groupId];
+			var group = this._groupMap[groupId];
+			while (group && group.parentId) {
+				group = this._groupMap[group.parentId];
+				if (group) {
+					groupIds.push(group.id);
+				}
+			}
+			return groupIds;
+		}
+	}
+	return null;
+};
+/** @public
+* @param {string} childId
+* @param {number=} groupLevel
+* @return {string}
+*/
+GroupDefinitions.prototype.getParentId = function (childId, groupLevel) {
+	var parentId = this._childToParent[childId];
+	if(groupLevel != null) {
+		var currentLevel = this.getGroupLevel(parentId);
+		while(currentLevel > groupLevel && parentId){
+			parentId = this._childToParent[parentId];
+			currentLevel--;
+		}
+	}
+
+	return parentId || "";
+};
+
+
+/** 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
+*/
+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++) {
+		var groupDef = groupDefs[i];
+		groupId = groupDef.id;
+		if(groupId) {
+			groupMap[groupId] = 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;
+		}
+	}
+};
+/** Add new group definition to existing group structure. Existing group with the same id will be replaced.
+* @public
+* @param {Object} groupDef Group definition object
+* @return {string} Return group ID
+*/
+GroupDefinitions.prototype.addGroup = function (groupDef) {
+	var groupId = GroupDefinitions.getGroupId(groupDef);
+	if(groupId) {
+		return this.setGroup(groupId, groupDef);
+	}
+	return groupId;
+};
+/** @public
+* @param {string} groupId
+* @return {boolean}
+*/
+GroupDefinitions.prototype.removeGroup = function (groupId) {
+	var curDef = this._groupMap[groupId];
+	if(curDef) {
+		this.removeAllChildren(groupId);
+		this.removeGroupChild(groupId);
+		delete this._groupMap[groupId];
+
+		return true;
+	}
+	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.
+* @public
+* @param {string} groupId
+* @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) {
+		return "";
+	}
+
+	if(groupDef) {
+		var newDef = GroupDefinitions._toGroupDefinition(groupDef, groupId);
+		this._ungroupChildren(newDef.children);
+
+		var curDef = this._groupMap[groupId];
+		if(curDef) { // Replace
+			this.removeAllChildren(groupId);
+		}
+		var parentDef = this._childToParent[groupId];
+		if(parentDef) {
+			newDef.parentId = parentDef.id;
+		}
+		this._groupMap[groupId] = newDef;
+
+		var chdr = newDef.children;
+		var len = chdr.length;
+		for(var i = 0; i < len; ++i) {
+			var childId = chdr[i];
+			this._childToParent[childId] = groupId;
+			var childDef = this._groupMap[childId];
+			if(childDef) {
+				childDef.parentId = groupId;
+			}
+		}
+	} else { // Remove
+		if(!this.removeGroup(groupId)) {
+			return "";
+		}
+	}
+
+	return groupId;
+};
+
+/** Remove each child from any group
+ * @private
+ * @param {Array.<string>} children
+ */
+GroupDefinitions.prototype._ungroupChildren = function(children) {
+	if (Array.isArray(children)) {
+		var len = children.length;
+		for(var i = 0; i < len; ++i) {
+			this.removeGroupChild(children[i]);
+		}
+	}
+};
+
+
+/** @public
+* @param {string} parentId Group id
+* @param {string} childId
+* @return {boolean}
+*/
+GroupDefinitions.prototype.addGroupChild = function (parentId, childId) {
+	var groupDef = this._groupMap[parentId];
+
+	if(childId && groupDef) {
+		var chdr = groupDef.children;
+		if(chdr && chdr.indexOf(childId) < 0) {
+			this.removeGroupChild(childId); // Remove previous parent
+			// Add new child to group structures
+			this._childToParent[childId] = parentId;
+			var childDef = this._groupMap[childId];
+			if(childDef) {
+				childDef.parentId = parentId;
+			}
+			chdr.push(childId);
+			return true;
+		}
+	}
+	return false;
+};
+/** Remove the given child from its own parent (i.e., unset Parent of the given child).
+* @public
+* @param {string} childId
+* @return {boolean}
+*/
+GroupDefinitions.prototype.removeGroupChild = function (childId) {
+	var parentId = this._childToParent[childId];
+	if(!parentId) {
+		return false;
+	}
+	this._childToParent[childId] = "";
+	var childDef = this._groupMap[childId];
+	if(childDef) {
+		childDef.parentId = "";
+	}
+	var parentDef = this._groupMap[parentId];
+	if(parentDef) {
+		var chdr = parentDef.children;
+		if(chdr.length) {
+			var at = chdr.indexOf(childId);
+			if (at >= 0) {
+				chdr.splice(at, 1); // splice is slow
+			}
+		}
+	}
+	return true;
+};
+/** Remove all children from the specified group
+* @public
+* @param {string} groupId
+* @return {boolean}
+*/
+GroupDefinitions.prototype.removeAllChildren = function(groupId) {
+	var grpDef = this._groupMap[groupId];
+	if(grpDef) {
+		var chdr = grpDef.children;
+		var len = chdr.length;
+		if(len) {
+			grpDef.children = [];
+			for(var i = 0; i < len; ++i) {
+				var childId = chdr[i];
+				if(this._childToParent[childId]) {
+					this._childToParent[childId] = "";
+				}
+				var childDef = this._groupMap[childId];
+				if(childDef) {
+					childDef.parentId = "";
+				}
+			}
+			return true;
+		}
+	}
+	return false;
+};
+/** Replace and update existing group definition.
+* @public
+* @param {string} groupId
+* @param {Array.<string>} newChildList If null is given, all existing children in the group will be removed
+* @return {boolean}
+*/
+GroupDefinitions.prototype.setGroupChildren = function (groupId, newChildList) {
+	var groupDef = this._groupMap[groupId];
+	if(groupDef) {
+		if(Array.isArray(newChildList)) {
+			var chdr = newChildList.slice();
+			this._ungroupChildren(chdr);
+			this.removeAllChildren(groupId);
+			groupDef.children = chdr;
+
+			var parentId = groupDef.id;
+			var len = chdr.length;
+			for(var i = 0; i < len; ++i) {
+				var childId = chdr[i];
+				this._childToParent[childId] = parentId;
+				var childDef = this._groupMap[childId];
+				if(childDef) {
+					childDef.parentId = parentId;
+				}
+			}
+
+			return true;
+		} else if(!newChildList && groupDef.children.length) {
+			this.removeAllChildren(groupId);
+			return true;
+		}
+	}
+	return false;
+};
+
+export default GroupDefinitions;
+export { GroupDefinitions };

package/lib/tr-grid-util/es6/Popup.js

@@ -647,7 +647,7 @@ Popup.prototype.updatePosition = function () {
 			if ((y + eh > bb) && (py + aw - eh > sy)) {
 				y = py + aw - eh;
 			}
-		} else { // bottom
+		} else { // under, bottom, or etc.
 			x = px;
 			y = py + ah;
 			// Re-position, if the popup exceeds the bounds

package/lib/tr-grid-util/es6/index.d.ts

@@ -30,6 +30,7 @@ import {Table} from "./Table.js";
 import {ExpanderIcon} from "./ExpanderIcon.js";
 import ElementObserver from "./ElementObserver.js";
 import MultiTableManager from "./MultiTableManager.js";
+import GroupDefinitions from "./GroupDefinitions.js";
 
 export {
 GridPlugin
@@ -60,4 +61,5 @@ GridPlugin
 , ExpanderIcon
 , ElementObserver
 , MultiTableManager
+, GroupDefinitions
 };

package/lib/tr-grid-util/es6/index.js

@@ -31,6 +31,7 @@ import {Table} from "./Table.js";
 import {ExpanderIcon} from "./ExpanderIcon.js";
 import ElementObserver from "./ElementObserver.js";
 import MultiTableManager from "./MultiTableManager.js";
+import GroupDefinitions from "./GroupDefinitions.js";
 
 var tr = window["tr"];
 if(!tr) {
@@ -65,6 +66,7 @@ tr.Table = Table;
 tr.ExpanderIcon = ExpanderIcon;
 tr.ElementObserver = ElementObserver;
 tr.MultiTableManager = MultiTableManager;
+tr.GroupDefinitions = GroupDefinitions;
 
 export {
 GridPlugin
@@ -95,5 +97,6 @@ GridPlugin
 , ExpanderIcon
 , ElementObserver
 , MultiTableManager
+, GroupDefinitions
 };
 

package/lib/types/es6/ColumnGrouping.d.ts

@@ -1,6 +1,7 @@
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { cloneObject } from "../../tr-grid-util/es6/Util.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
 import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 
 declare namespace ColumnGroupingPlugin {
@@ -42,7 +43,7 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public addColumnGrouping(groupDef: ColumnGroupingPlugin.GroupDefinition|null): void;
 
-    public removeGroup(groupId: string): ColumnGroupingPlugin.GroupDefinition|null;
+    public removeGroup(groupId: string): boolean;
 
     public getGroupDefinition(groupId: string): ColumnGroupingPlugin.GroupDefinition|null;
 
@@ -52,7 +53,7 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public setGroupDefinitions(groupDefs: ColumnGroupingPlugin.GroupDefinitions|null): void;
 
-    public setGroupChildren(groupId: string, newChildList: (string)[]|null): void;
+    public setGroupChildren(groupId: string, newChildList: (string)[]|null): boolean;
 
     public getGroupChildren(groupId: string): (string)[]|null;