@refinitiv-ui/efx-grid 6.0.5 → 6.0.7

package/lib/tr-grid-column-stack/es6/ColumnStack.d.ts

@@ -10,18 +10,18 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 declare namespace ColumnStackPlugin {
 
     type Options = {
-        fields: (string)[]
+        fields: (string)[]|null
     };
 
     type ColumnOptions = {
-        stackId?: string,
-        stack?: (string|StackOptions)
+        stackId?: string|null,
+        stack?: (string|StackOptions)|null
     };
 
     type StackOptions = {
         id: string,
-        spreading?: boolean,
-        collapsed?: boolean
+        spreading?: boolean|null,
+        collapsed?: boolean|null
     };
 
 }
@@ -40,13 +40,13 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getMemberIndices(colIndex: number): (number)[]|null;
 
-    public collapseGroup(colIndex: number, collapsed?: boolean): (number)[]|null;
+    public collapseGroup(colIndex: number, collapsed?: boolean|null): (number)[]|null;
 
     public expandGroup(colIndex: number): (number)[]|null;
 
-    public isColumnStackable(colIndices: (number)[]): boolean;
+    public isColumnStackable(colIndices: (number)[]|null): boolean;
 
-    public isColumnStacked(colIndices?: (number)[]): boolean;
+    public isColumnStacked(colIndices?: (number)[]|null): boolean;
 
     public isInactiveStackedColumn(colIndex: number): boolean;
 
@@ -58,21 +58,23 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public isColumnInCollection(colIndex: number): boolean;
 
+    public isInCollection(colIndex: number): boolean;
+
     public isColumnCollapsed(colIndex: number): boolean;
 
     public isColumnActive(colIndex: number): boolean;
 
     public getStackId(colIndex: number): string;
 
-    public stackColumns(colRefs?: (number|string)[], stackId?: string, options?: any): boolean;
+    public stackColumns(colRefs?: (number|string)[]|null, stackId?: string|null, options?: any): boolean;
 
-    public setStack(colRefs: (number|string)[]): boolean;
+    public setStack(colRefs?: (number|string)[]|null): boolean;
 
-    public unstackColumns(colIndices?: (number)[]): boolean;
+    public unstackColumns(colIndices?: (number)[]|null): boolean;
 
-    public removeAllStacks(enableUpdateUI?: boolean): boolean;
+    public removeAllStacks(enableUpdateUI?: boolean|null): boolean;
 
-    public swapColumn(colRef: number|Event, swappingIndex: number): boolean;
+    public swapColumn(colRef: number|Event|null, swappingIndex: number): boolean;
 
 }
 

package/lib/tr-grid-column-stack/es6/ColumnStack.js

@@ -55,6 +55,11 @@ ColumnStackPlugin.prototype._pendingStacks;
 * @private
 */
 ColumnStackPlugin.prototype._columnStack = null;
+/** @type {boolean}
+* @private
+*/
+ColumnStackPlugin.prototype._updating = false;
+
 
 /** @type {number}
 * @private
@@ -128,6 +133,7 @@ ColumnStackPlugin.prototype.unload = function (host) {
 
 	if(this._hosts.length <= 0) {
 		this._conflator.reset();
+		this._stacks = {};
 	}
 	this._dispose();
 };
@@ -396,84 +402,103 @@ ColumnStackPlugin.prototype._isIconAvailable = function() {
 		(ElfUtil.hasTheme("elf-theme-solar") ||
 		ElfUtil.hasTheme("elf-theme-luna"));
 };
+/** @private
+* @param {number} colIndex
+* @param {Object} colData
+*/
+ColumnStackPlugin.prototype._updateIcon = function(colIndex, colData) {
+	var stackRefs = (colData) ? colData.stackRefs : null;
+	var spreading = (colData) ? colData.spreading : false;
+	var gridCount = this._hosts.length;
+	for(var g = 0; g < gridCount; ++g) {
+		var host = this._hosts[g];
+		var tSect = host.getSection("title");
+		var rowCount = tSect.getRowCount();
+		var cell = tSect.getCell(colIndex, rowCount - 1, true);
+		if(!cell) { continue; }
+
+		var stackIcon = cell._stackIcon;
+		if(stackRefs) {
+			if(!stackIcon && this.isActiveStackedColumn(colIndex)) {
+				if(spreading) {
+					cell.addClass("grouping");
+					if(this._expandIconName) {
+						if(colData.collapsed) {
+							stackIcon = Icon.create(this._expandIconName);
+						} else {
+							stackIcon = Icon.create(this._collapseIconName);
+						}
+					} else {
+						if(colData.collapsed) {
+							stackIcon = Dom.text(">");
+						} else {
+							stackIcon = Dom.text("<");
+						}
+					}
+				} else {
+					cell.addClass("stacking");
+					if(this._stackIconName) {
+						stackIcon = Icon.create(this._stackIconName);
+					} else {
+						stackIcon = Dom.text("\u2261");
+						stackIcon.style.fontSize = "1.3em";
+					}
+				}
+				stackIcon.className = "stack-icon";
+				stackIcon.addEventListener("click", this._onStackButtonClicked, false);
+				stackIcon.addEventListener("dblclick", preventDefault, false);
+				stackIcon.addEventListener("mousedown", preventDefault, false);
+				stackIcon.addEventListener("keydown", preventDefault, false);
+
+				cell.insertFloatingIcon(stackIcon, 20);
+				cell._stackIcon = stackIcon;
+
+				this._dispatch("iconCreated", {"icon": stackIcon, "colIndex": colIndex, "grid": host, "cell": cell});
+			} else if(stackIcon && this.isInactiveStackedColumn(colIndex)) {
+				cell.removeFloatingIcon(cell._stackIcon);
+				cell._stackIcon = null;
+			}
+		} else if(stackIcon) {
+			cell.removeFloatingIcon(cell._stackIcon);
+			cell._stackIcon = null;
+
+			// Do not know the previous stacking mode so it needs to remove all the classes here.
+			cell.removeClass("grouping");
+			cell.removeClass("stacking");
+		}
+	}
+};
 /** @private */
 ColumnStackPlugin.prototype._updateUI = function() {
+	if(this._updating) { // Avoid infinite loop
+		return;
+	}
 	if(this._conflator.conflate()) {
 		return;
 	}
 
+	this._updating = true;
 	var colCount = this._getColumnCount();
 	var gridCount = this._hosts.length;
+	var colData, spreading;
 	for(var c = 0; c < colCount; ++c) {
-		var colData = this._getColumnStackOptions(c);
-		var stackRefs = (colData) ? colData.stackRefs : null;
-		var spreading = (colData) ? colData.spreading : false;
+		colData = this._getColumnStackOptions(c);
+		spreading = (colData) ? colData.spreading : false;
 		for(var g = 0; g < gridCount; ++g) {
 			var host = this._hosts[g];
 			host.enableColumnClass(c, "grouped", spreading === true);
-			var tSect = host.getSection("title");
-			var rowCount = tSect.getRowCount();
-			var cell = tSect.getCell(c, rowCount - 1, true);
-			if(!cell) { continue; }
-
-			var stackIcon = cell._stackIcon;
-			if(stackRefs) {
-				if(!stackIcon && this.isActiveStackedColumn(c)) {
-					if(spreading) {
-						cell.addClass("grouping");
-						if(this._expandIconName) {
-							if(colData.collapsed) {
-								stackIcon = Icon.create(this._expandIconName);
-							} else {
-								stackIcon = Icon.create(this._collapseIconName);
-							}
-						} else {
-							if(colData.collapsed) {
-								stackIcon = Dom.text(">");
-							} else {
-								stackIcon = Dom.text("<");
-							}
-						}
-					} else {
-						cell.addClass("stacking");
-						if(this._stackIconName) {
-							stackIcon = Icon.create(this._stackIconName);
-						} else {
-							stackIcon = Dom.text("\u2261");
-							stackIcon.style.fontSize = "1.3em";
-						}
-					}
-					stackIcon.className = "stack-icon";
-					stackIcon.addEventListener("click", this._onStackButtonClicked, false);
-					stackIcon.addEventListener("dblclick", preventDefault, false);
-					stackIcon.addEventListener("mousedown", preventDefault, false);
-					stackIcon.addEventListener("keydown", preventDefault, false);
-
-					cell.insertFloatingIcon(stackIcon, 20);
-					cell._stackIcon = stackIcon;
-
-					this._dispatch("iconCreated", {"icon": stackIcon, "colIndex": c, "grid": host, "cell": cell});
-				} else if(stackIcon && this.isInactiveStackedColumn(c)) {
-					cell.removeFloatingIcon(cell._stackIcon);
-					cell._stackIcon = null;
-				}
-			} else if(stackIcon) {
-				cell.removeFloatingIcon(cell._stackIcon);
-				cell._stackIcon = null;
-
-				// Do not know the previous stacking mode so it needs to remove all the classes here.
-				cell.removeClass("grouping");
-				cell.removeClass("stacking");
-			}
 		}
+
+		this._updateIcon(c, colData);
 		if(colData) {
-			if(spreading) {
+			if(colData.spreading) {
 				this._collapseMember(c, colData.collapsed);
 			} else {
 				this._setColumnVisibility(c, this.isActiveStackedColumn(c)); // a little slow
 			}
 		}
 	}
+	this._updating = false;
 };
 /** @private
 * @param {number} colIndex
@@ -692,7 +717,7 @@ ColumnStackPlugin.prototype.isColumnInCollection = function(colIndex) {
 };
 /** Alias of isColumnInCollection
 * @public
-* @type {function}
+* @function
 * @param {number} colIndex
 * @return {boolean}
 */
@@ -826,12 +851,12 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options) {
 };
 
 /** @public
-* @description Remove all stacking from the grid and replace it with a new one.
-*   The stacked fields are kept persistently in Grid.
-*   While adding columns Grid will try to restore stacking
-*   if there are at least 2 visible columns which are corresponding to the kept fields.
-* @param {Array.<number|string>} colRefs Names of fields or column indices
-* @return {boolean} true if the stack has been modified
+* @description Replace all of the stacking in the Grid with a new one.
+*  Grid stores the stacked fields indefinitely.
+*  When adding columns, Grid will attempt to restore stacking
+*  if there are at least two visible columns that match to the retained fields.
+* @param {Array.<number|string>=} colRefs Field names or column indices
+* @return {boolean} If the stack has been updated, return true.
 */
 ColumnStackPlugin.prototype.setStack = function(colRefs) {
 	// Keep state
@@ -1074,11 +1099,12 @@ ColumnStackPlugin.prototype.swapColumn = function(colRef, swappingIndex) {
 	colData.stackRefs.unshift(newActiveColumn); // Move data to front
 	var prevActiveColumnIndex = this._getColumnIndex(colData.activeColumn);
 	var newActiveColumnIndex = this._getColumnIndex(newActiveColumn);
-	this._moveColumn(newActiveColumnIndex, prevActiveColumnIndex); // Move UI to front
-
-	this._setColumnVisibility(prevActiveColumnIndex, false); // Hide current active column
 	colData.activeColumn = newActiveColumn; // Change active column
+
 	this._setColumnVisibility(newActiveColumnIndex, true);
+	this._setColumnVisibility(prevActiveColumnIndex, false); // Hide current active column
+
+	this._moveColumn(newActiveColumnIndex, prevActiveColumnIndex); // Move UI to front
 
 	var csp = this._getPlugin("ColumnSelectionPlugin");
 	if(csp && csp.isEnabled()) {
@@ -1089,10 +1115,8 @@ ColumnStackPlugin.prototype.swapColumn = function(colRef, swappingIndex) {
 		cfp["refresh"]();
 	}
 
-	this._updateUI();
-	// this._hosts.forEach(function(host){
-	// host.updateLayout();
-	// });
+	colData = this._getColumnStackOptions(prevActiveColumnIndex);
+	this._updateIcon(prevActiveColumnIndex, colData);
 
 	return true;
 };

package/lib/tr-grid-conditional-coloring/es6/ConditionalColoring.d.ts

@@ -15,6 +15,13 @@ declare namespace ConditionalColoringPlugin {
         field?: string
     };
 
+    type ConditionalColoringOptions = {
+        conditions?: (ConditionalColoringPlugin.Condition)[],
+        colorText?: (string|boolean),
+        tickColor?: (string|boolean),
+        field?: string
+    };
+
     type Condition = {
         expression?: (string|((...params: any[]) => any)),
         backgroundColor?: string,
@@ -47,11 +54,13 @@ declare class ConditionalColoringPlugin extends GridPlugin {
 
     public getConfigObject(gridOptions?: any): any;
 
+    public getColumnColoring(colIndex: number, options?: any): ConditionalColoringPlugin.ColumnOptions;
+
     public setColumnColoring(colIndex: number, columnOptions?: (ConditionalColoringPlugin.ColumnOptions|null)): void;
 
-    public setColumnBlinking(colIndex: number, blinkingOptions?: (boolean|ConditionalColoringPlugin.Blinking), field?: string): void;
+    public setConditionalColoring(colIndex: number, coloringOptions?: (ConditionalColoringPlugin.ConditionalColoringOptions|null)): void;
 
-    public getColumnColoring(colIndex: number, out_obj?: any): any;
+    public setColumnBlinking(colIndex: number, blinkingOptions?: (boolean|ConditionalColoringPlugin.Blinking), field?: string): void;
 
     public blinkRow(rowIndex: number, blinkSignal: number, host?: any): void;