@refinitiv-ui/efx-grid 6.0.12 → 6.0.13

package/lib/rt-grid/es6/ColumnDefinition.d.ts

@@ -41,7 +41,8 @@ declare namespace ColumnDefinition {
         keepModel?: boolean|null,
         stationary?: boolean|null,
         leftPinned?: boolean|null,
-        rightPinned?: boolean|null
+        rightPinned?: boolean|null,
+        info?: any
     };
 
 }
@@ -142,6 +143,10 @@ declare class ColumnDefinition {
 
     public clearUserModel(): void;
 
+    public setColumnInfo(obj: any): void;
+
+    public getColumnInfo(): any;
+
 }
 
 declare const COL_DEF: string;

package/lib/rt-grid/es6/ColumnDefinition.js

@@ -48,6 +48,7 @@ import Engine from "../../tr-grid-util/es6/formula/Engine.js";
 * @property {boolean=} stationary=false If enabled, the column order cannot be changed (i.e., this column and any column to its left cannot be moved)
 * @property {boolean=} leftPinned=false If enabled, the column will not be part of the scrollable area and is pinned to the left side
 * @property {boolean=} rightPinned=false If enabled, the column will not be part of the scrollable area and is pinned to the right side
+* @property {Object=} info=null Store additional information
 */
 
 /** mapping of field type to javascript type
@@ -240,6 +241,10 @@ ColumnDefinition.prototype._textSelect = false;
 * @private
 */
 ColumnDefinition.prototype._userModel = null;
+/** @type {Object}
+* @private
+*/
+ColumnDefinition.prototype._info = null;
 //#endregion Private Members
 
 
@@ -399,6 +404,11 @@ ColumnDefinition.prototype.initialize = function(columnOption) {
 		this._textSelect = val;
 	}
 
+	val = columnOption["info"];
+	if(val) {
+		this._info = val;
+	}
+
 	this._userModel = columnOption;
 };
 
@@ -674,6 +684,10 @@ ColumnDefinition.prototype.getClasses = function() {
 ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 	var obj = colOptions || {};
 
+	if(this._info){
+		obj["info"] = this._info;
+	}
+
 	if(this._field !== "" && !this._field.match(/^COLUMN_/)) {
 		obj["field"] = this._field;
 	}
@@ -1012,5 +1026,20 @@ ColumnDefinition.prototype.clearUserModel = function() {
 	this._userModel = null;
 };
 
+/** @public
+* @param {Object} obj
+*/
+ColumnDefinition.prototype.setColumnInfo = function(obj) {
+	this._info = obj;
+};
+
+/** @public
+* @return {Object}
+*/
+ColumnDefinition.prototype.getColumnInfo = function() {
+	return this._info;
+};
+
+
 export {ColumnDefinition, COL_DEF};
 export default ColumnDefinition;

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

@@ -10,12 +10,13 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 declare namespace ColumnStackPlugin {
 
     type Options = {
-        fields: (string)[]|null
+        fields: (string)[]|null,
+        stacks: (ColumnStackPlugin.StackDefinition)[]|null
     };
 
     type ColumnOptions = {
         stackId?: string|null,
-        stack?: (string|StackOptions)|null
+        stack?: (string|ColumnStackPlugin.StackOptions)|null
     };
 
     type StackOptions = {
@@ -24,6 +25,14 @@ declare namespace ColumnStackPlugin {
         collapsed?: boolean|null
     };
 
+    type StackDefinition = {
+        id: string,
+        spreading?: boolean|null,
+        collapsed?: boolean|null,
+        children: (string)[]|null,
+        name?: string|null
+    };
+
 }
 
 declare class ColumnStackPlugin extends GridPlugin {
@@ -90,6 +99,10 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public reorderStackColumns(colRefs: (number|string)[]|null, stackId: string): void;
 
+    public setStackName(stackId: string, name: string): void;
+
+    public getStackName(stackId: string): string;
+
 }
 
 export default ColumnStackPlugin;

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

@@ -10,12 +10,13 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 /** @typedef {Object} ColumnStackPlugin~Options
 * @description Available options describing `columnStack` object specified in grid's option
 * @property {Array.<string>} fields Fields for stacking. The minimum is 2 fields.
+* @property {Array.<ColumnStackPlugin~StackDefinition>} stacks List of stacking configuration
 */
 
 /** @typedef {Object} ColumnStackPlugin~ColumnOptions
 * @description Extension column options that can be specified on each individual grid's column option.
 * @property {string=} stackId Group ID
-* @property {(string|StackOptions)=} stack Group ID or StackOptions object
+* @property {(string|ColumnStackPlugin~StackOptions)=} stack Group ID or StackOptions object
 */
 
 /** @typedef {Object} ColumnStackPlugin~StackOptions
@@ -25,6 +26,15 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 * @property {boolean=} collapsed=true If disabled, this group will be expanded at the first time
 */
 
+/** @typedef {Object} ColumnStackPlugin~StackDefinition
+* @description Available options for setting stack
+* @property {string} id Group ID
+* @property {boolean=} spreading=false If specified true, this group will be running in collapsing mode
+* @property {boolean=} collapsed=true If disabled, this group will be expanded at the first time
+* @property {Array.<string>} children Children column ID
+* @property {string=} name="" Name defined for specific stack
+*/
+
 /** @constructor
 * @extends {GridPlugin}
 */
@@ -185,7 +195,9 @@ ColumnStackPlugin.prototype.config = function (options) {
 	if(!options) { return; }
 
 	var columns = options["columns"];
-	if(!columns) { return; }
+	if(!columns) {
+		columns = [];
+	}
 
 	var i, len = columns.length;
 	for(i = 0; i < len; ++i) {
@@ -203,6 +215,19 @@ ColumnStackPlugin.prototype.config = function (options) {
 				spreading: columnStack.spreading === true,
 				collapsed: columnStack.collapsed !== false
 			};
+		} else if (columnStack.stacks && columnStack.stacks.length) {
+			var stackLen = columnStack.stacks.length;
+			for(i = 0; i < stackLen; i++){
+				var stackConfig = columnStack.stacks[i];
+				sid = stackConfig.id || this._generateStackId();
+				if(stackConfig.collapsed == null){
+					stackConfig.collapsed = true;
+				}
+				if(stackConfig.spreading == null){
+					stackConfig.spreading = false;
+				}
+				stacks[sid] = stackConfig;
+			}
 		}
 	} else {
 		var column, stackOpt;
@@ -231,6 +256,7 @@ ColumnStackPlugin.prototype.config = function (options) {
 	}
 
 	if(this._initializedGrid) {
+		this.removeAllStacks(false);
 		for(sid in stacks) {
 			this.stackColumns(stacks[sid].colRefs, sid, stacks[sid]);
 		}
@@ -250,27 +276,32 @@ ColumnStackPlugin.prototype.getConfigObject = function (gridOptions) {
 	if (this._columnStack != null) {
 		obj.columnStack = this._columnStack;
 	} else {
-		var columns = obj.columns;
-		if (!columns) {
-			columns = obj.columns = [];
-		}
-
-		var len = this.getColumnCount();
-		for (var i = 0; i < len; ++i) {
-			var column = columns[i];
-			if (!column) {
-				column = columns[i] = {};
-			}
-
-			var stackOpt = this._getColumnStackOptions(i);
-			if (!stackOpt) continue;
-
-			column.stack = {
-				id: stackOpt.stackId,
-				spreading: stackOpt.spreading,
-				collapsed: stackOpt.collapsed
+		var stacks = this._stacks;
+		var stackOptions = [];
+
+		for (var stackKey in stacks) {
+			var stackOption = stacks[stackKey];
+			var stackConfigObj = {
+				id: stackOption.stackId,
+				children: this.getStackMemberIds(stackOption.stackId)
 			};
+			var name = stackOption.name;
+			var collapsed = stackOption.collapsed;
+			var spreading = stackOption.spreading;
+			if (name) {
+				stackConfigObj.name = name;
+			}
+			if (collapsed !== true) {
+				stackConfigObj.collapsed = collapsed;
+			}
+			if (spreading !== false) {
+				stackConfigObj.spreading = spreading;
+			}
+			stackOptions.push(stackConfigObj);
 		}
+
+		obj.columnStack = {};
+		obj.columnStack.stacks = stackOptions;
 	}
 
 	return obj;
@@ -280,6 +311,7 @@ ColumnStackPlugin.prototype.getConfigObject = function (gridOptions) {
 */
 ColumnStackPlugin.prototype._afterInit = function () {
 	if(this._pendingStacks) {
+		this.removeAllStacks(false);
 		for(var sid in this._pendingStacks) {
 			var stackOpt = this._pendingStacks[sid];
 			this.stackColumns(stackOpt.colRefs, sid, stackOpt);
@@ -776,6 +808,10 @@ ColumnStackPlugin.prototype.getStackId = function(colIndex) {
 * @return {boolean} Return true if all of the given columns is stacked together
 */
 ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, sort) {
+	if(options.children && options.children.length > 1) {
+		colRefs = this.getColumnIndicesByColumnIds(options.children);
+	}
+
 	if(!colRefs) {
 		colRefs = this._getSelectedColumns();
 	}
@@ -815,6 +851,7 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, s
 	// Collecting data
 	var stack = {};
 	stack.stackId = sid;
+	stack.name = options.name || "";
 	stack.spreading = options.spreading === true;
 	if(stack.spreading) {
 		activeIndex = colRefs[len - 1];
@@ -845,6 +882,7 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, s
 			csp.selectSingleColumn(activeIndex);
 		}
 	}
+
 	this._stacks[sid] = stack;
 
 	var cfp = this._getPlugin("ColumnFilterPlugin");
@@ -1606,6 +1644,36 @@ ColumnStackPlugin.prototype.reorderStackColumns = function(colRefs, stackId) {
 
 };
 
+/** @public
+* @description Set stack name to a stack
+* @param {string} stackId
+* @param {string} name
+*/
+ColumnStackPlugin.prototype.setStackName = function(stackId, name) {
+	if(stackId !== null) {
+		var stack = this._stacks[stackId];
+		if(stack){
+			stack.name = name;
+		}
+	}
+};
+
+/** @public
+* @description Get stack name from specific stack
+* @param {string} stackId
+* @return {string} Stack name
+*/
+ColumnStackPlugin.prototype.getStackName = function(stackId) {
+	var stackName  = "";
+	if(stackId !== null) {
+		var stack = this._stacks[stackId];
+		if(stack){
+			stackName = stack.name;
+		}
+	}
+	return stackName;
+};
+
 
 export default ColumnStackPlugin;
 export { ColumnStackPlugin, ColumnStackPlugin as ColumnStack, ColumnStackPlugin as ColumnStackExtension };

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

@@ -10,12 +10,13 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 declare namespace ColumnStackPlugin {
 
     type Options = {
-        fields: (string)[]|null
+        fields: (string)[]|null,
+        stacks: (ColumnStackPlugin.StackDefinition)[]|null
     };
 
     type ColumnOptions = {
         stackId?: string|null,
-        stack?: (string|StackOptions)|null
+        stack?: (string|ColumnStackPlugin.StackOptions)|null
     };
 
     type StackOptions = {
@@ -24,6 +25,14 @@ declare namespace ColumnStackPlugin {
         collapsed?: boolean|null
     };
 
+    type StackDefinition = {
+        id: string,
+        spreading?: boolean|null,
+        collapsed?: boolean|null,
+        children: (string)[]|null,
+        name?: string|null
+    };
+
 }
 
 declare class ColumnStackPlugin extends GridPlugin {
@@ -90,6 +99,10 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public reorderStackColumns(colRefs: (number|string)[]|null, stackId: string): void;
 
+    public setStackName(stackId: string, name: string): void;
+
+    public getStackName(stackId: string): string;
+
 }
 
 export default ColumnStackPlugin;

package/lib/versions.json

@@ -12,7 +12,7 @@
 	"tr-grid-column-grouping": "1.0.24",
 	"tr-grid-column-resizing": "1.0.26",
 	"tr-grid-column-selection": "1.0.25",
-	"tr-grid-column-stack": "1.0.41",
+	"tr-grid-column-stack": "1.0.42",
 	"tr-grid-conditional-coloring": "1.0.57",
 	"tr-grid-content-wrap": "1.0.19",
 	"tr-grid-contextmenu": "1.0.38",

package/package.json

@@ -45,5 +45,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.12"
+	"version": "6.0.13"
 }