@refinitiv-ui/efx-grid 6.0.57 → 6.0.59

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

@@ -3,26 +3,43 @@ import { Ext } from "./Ext.js";
 import { ElementWrapper } from "./ElementWrapper.js";
 import { SubTable } from "./SubTable.js";
 
+/** @typedef {Object} Table~Options
+* @description Options for Table initialization
+* @property {number=} colCount=0 Number of columns
+* @property {number=} rowCount=0 Number of rows in content table (tbody)
+* @property {number=} cellWidth Default cell width of each column
+* @property {number=} cellHeight Default cell height of each row
+* @property {number=} width Total width of the table. If it is specified, it will override cellWidth
+* @property {number=} height Total height of the table. If it is specified, it will override cellHeight
+* @property {number=} header=0 Number of header rows
+* @property {number=} footer=0 Number of footer rows
+*/
 
 /** Table represents table (tag) element which can host multiple tbody, thead, tfoot elements at the same time
 * @constructor
 * @extends {ElementWrapper}
-* @param {(Element|number)=} elem Element is a place holder element (e.g. div). This should not be a table (tag) element. Column count may be placed here and if so, opt_colCount becomes row count.
-* @param {(number|Object)=} opt_colCount options
-* @param {number=} opt_rowCount
-*/
-var Table = function(elem, opt_colCount, opt_rowCount) {
+* @param {Element=} elem Element is a place holder element (e.g., div). This should not be a table (tag) element.
+* @param {Table~Options=} options
+* @example
+* var elem = document.getElementById("table_div");
+* // Create a table element with 2 columns and 3 rows inside the given element
+* var tbl = new Table(elem, {colCount: 2, rowCount: 3});
+*/
+var Table = function(elem, options) {
 	var t = this;
 
+	var colCount = 0;
+	var rowCount = 0;
 	if(elem && elem.nodeType === 1) {
 		t._elem = /** @type{Element} */(elem);
 	} else {
 		t._elem = Dom.create("div", "inline-table");
 		if(typeof elem == "number") {
-			if(typeof opt_colCount === "number") {
-				opt_rowCount = opt_colCount;
+			if(typeof options === "number") {
+				rowCount = options;
+				options = null;
 			}
-			opt_colCount = elem;
+			colCount = elem;
 			elem = null;
 		}
 	}
@@ -35,23 +52,26 @@ var Table = function(elem, opt_colCount, opt_rowCount) {
 	t._tbody = new SubTable("tbody");
 	t._subs = [t._tbody]; // tbody will always be the first item
 
-	var options = null;
-	if(opt_colCount && typeof opt_colCount !== "number") {
-		options = /** @type{Object} */(opt_colCount);
-		opt_colCount = 0;
+	var configObj = null;
+	if(options) {
+		if(typeof options == "number") {
+			colCount = options;
+		} else {
+			configObj = /** @type{Object} */(options);
+		}
 	}
-	if(opt_colCount > 0) {
-		t.addColumns(opt_colCount);
+	if(colCount > 0) {
+		t.addColumns(colCount);
 	}
-	if(opt_rowCount > 0) {
-		t.addRows(opt_rowCount);
+	if(rowCount > 0) {
+		t.addRows(rowCount);
 	}
 	t._table.appendChild(t._colgroup);
 	t._table.appendChild(t._tbody.getElement());
 
 	t.fixateTableWidth(); // By default, table should be able to overflow its container if it has a fixed size
 
-	t.init(options);
+	t.init(configObj);
 
 	t._elem.appendChild(t._table); // Append the entire table last to save some page reflow
 };
@@ -119,7 +139,7 @@ Table.prototype.setCRWH = function(col, row, width, height) {
 	this.setSize(width, height);
 };
 /** @public
-* @param {Object} options
+* @param {Table~Options} options
 */
 Table.prototype.init = function(options) {
 	if(!options) {
@@ -156,34 +176,60 @@ Table.prototype.init = function(options) {
 			this.setDefaultRowHeight((tableHeight / rowCount) | 0);
 		}
 	}
+
+	var header = options["header"];
+	if(header != null) {
+		if(header) {
+			rowCount = (typeof header === "number") ? header : 1;
+
+			this._addHeader();
+			this._thead.setRowCount(rowCount);
+		} else if(this._thead) {
+			Dom.removeParent(this._thead.getElement());
+			this._thead = null;
+		}
+	}
+
+	var footer = options["footer"];
+	if(footer != null) {
+		if(footer) {
+			rowCount = (typeof footer === "number") ? footer : 1;
+
+			this._addFooter();
+			this._tfoot.setRowCount(rowCount);
+		} else if(this._tfoot) {
+			Dom.removeParent(this._tfoot.getElement());
+			this._tfoot = null;
+		}
+	}
 };
 
 /** @public
-* @param {number=} opt_count
+* @param {number=} count=1
 * @return {Array.<Element>} Array of col elements (not td or cell)
 */
-Table.prototype.addColumns = function(opt_count) {
-	if(opt_count == null) { opt_count = 1; }
-	else if(opt_count <= 0) { return null; }
+Table.prototype.addColumns = function(count) {
+	if(count == null) { count = 1; }
+	else if(count <= 0) { return null; }
 
 	var cols = [];
 	var c;
-	for(c = opt_count; --c >= 0;) {
+	for(c = count; --c >= 0;) {
 		var col = document.createElement("col");
 		this._colgroup.appendChild(col);
 		cols[c] = col;
 	}
-	this._colCount += opt_count;
+	this._colCount += count;
 
 	if(this._defaultColumnWidth != null) {
 		var minWidth = this._defaultColumnWidth + "px";
-		for(c = opt_count; --c >= 0;) {
+		for(c = count; --c >= 0;) {
 			cols[c].style.width = minWidth;
 		}
 	}
 
 	for(var i = this._subs.length; --i >= 0;) {
-		this._subs[i].addColumns(opt_count);
+		this._subs[i].addColumns(count);
 	}
 	this._updateTableWidth();
 	return cols;
@@ -229,17 +275,17 @@ Table.prototype.setColumnCount = function(val) {
 };
 
 /** @public
-* @param {number=} opt_count
+* @param {number=} count=1
 * @return {!Array.<Element>} Array of tr (HTMLTableRowElement) elements
 */
-Table.prototype.addRows = function(opt_count) {
-	return this._tbody.addRows(opt_count);
+Table.prototype.addRows = function(count) {
+	return this._tbody.addRows(count);
 };
 /** @public
-* @param {number=} opt_count
+* @param {number=} count Number of rows to be removed. If count is not specified, all rows are removed
 */
-Table.prototype.removeRows = function(opt_count) {
-	this._tbody.removeRows(opt_count);
+Table.prototype.removeRows = function(count) {
+	this._tbody.removeRows(count);
 };
 /** @public */
 Table.prototype.removeAllRows = function() {
@@ -295,10 +341,10 @@ Table.prototype.getRows = Table.prototype.getAllRows;
 Table.prototype.getRow = function(r) { return this._tbody.getRow(r); };
 
 /** @public
-* @param {number} c1
-* @param {number} c2
-* @param {number} r1
-* @param {number} r2
+* @param {number} c1 Starting column index
+* @param {number} c2 Destination column index
+* @param {number} r1 Starting row index
+* @param {number} r2 Destination row index
 * @return {Element} Top left cell element
 */
 Table.prototype.spanBlock = function(c1, c2, r1, r2) { return this._tbody.spanBlock(c1, c2, r1, r2); };
@@ -314,37 +360,37 @@ Table.prototype.spanHorizontally = function(r, bool) {
 
 /** @public
 * @param {number|string|Array.<string|number>} val
-* @param {number=} opt_at
+* @param {number=} colIndex Column index
 */
-Table.prototype.setColMinWidths = function(val, opt_at) {
-	this._setColStyle("width", val, opt_at);
+Table.prototype.setColMinWidths = function(val, colIndex) {
+	this._setColStyle("width", val, colIndex);
 	this._updateTableWidth();
 };
 /** @public
 * @function
 * @param {number|string|Array.<string|number>} val
-* @param {number=} opt_at
+* @param {number=} colIndex Column index
 */
 Table.prototype.setColumnWidths = Table.prototype.setColMinWidths;
 /** @public
 * @param {string|Array.<string>} val
-* @param {number=} opt_at
+* @param {number=} colIndex Column index
 */
-Table.prototype.setColBackgroundColors = function(val, opt_at) {
-	this._setColStyle("background-color", val, opt_at);
+Table.prototype.setColBackgroundColors = function(val, colIndex) {
+	this._setColStyle("background-color", val, colIndex);
 };
 /** @public
 * @function
 * @param {string|Array.<string>} val
-* @param {number=} opt_at
+* @param {number=} colIndex Column index
 */
 Table.prototype.setColBGColors = Table.prototype.setColBackgroundColors; // Alias
 /** @public
 * @param {number|string|Array.<number|string>} val
-* @param {number=} opt_at
+* @param {number=} colIndex Column index
 */
-Table.prototype.setColBorders = function(val, opt_at) {
-	this._setColStyle("border", val, opt_at);
+Table.prototype.setColBorders = function(val, colIndex) {
+	this._setColStyle("border", val, colIndex);
 };
 
 /** @public
@@ -675,35 +721,35 @@ Table.prototype.getFooter = function() {
 
 
 /** @private
-* @param {Element=} opt_elem
+* @param {Element=} elem
 */
-Table.prototype._addHeader = function(opt_elem) {
+Table.prototype._addHeader = function(elem) {
 	var t = this;
 	if(!t._thead) {
-		t._thead = new SubTable((opt_elem) ? opt_elem : "thead");
+		t._thead = new SubTable(elem ? elem : "thead");
 		t._subs.push(t._thead);
 
 		t._thead.setColumnCount(t._colCount);
 		t._thead.setDefaultRowHeight(t._defaultRowHeight);
 		t._table.insertBefore(t._thead.getElement(), t._tbody.getElement());
-	} else if(opt_elem) {
-		t._thead.cloak(opt_elem);
+	} else if(elem) {
+		t._thead.cloak(elem);
 	}
 };
 /** @private
-* @param {Element=} opt_elem
+* @param {Element=} elem
 */
-Table.prototype._addFooter = function(opt_elem) {
+Table.prototype._addFooter = function(elem) {
 	var t = this;
 	if(!t._tfoot) {
-		t._tfoot = new SubTable((opt_elem) ? opt_elem : "tfoot");
+		t._tfoot = new SubTable(elem ? elem : "tfoot");
 		t._subs.push(t._tfoot);
 
 		t._tfoot.setColumnCount(t._colCount);
 		t._tfoot.setDefaultRowHeight(t._defaultRowHeight);
 		t._table.appendChild(t._tfoot.getElement());
-	} else if(opt_elem) {
-		t._tfoot.cloak(opt_elem);
+	} else if(elem) {
+		t._tfoot.cloak(elem);
 	}
 };
 
@@ -763,28 +809,7 @@ Table.prototype._updateTableWidth = function() {
 		this._table.style.width = "";
 	}
 };
-/** @private
-* @param {Array.<Array>} ary
-* @return {number}
-*/
-Table.prototype._adjustColCount = function(ary) {
-	if(this._colCount > 0) {
-		return this._colCount;
-	}
-
-	var colCount = 0;
-	var rowCount = ary.length;
-
-	for(var r = 0; r < rowCount; ++r) {
-		var cols = ary[r];
-		if(cols.length > colCount) {
-			colCount = cols.length;
-		}
-	}
 
-	this.setColumnCount(colCount);
-	return colCount;
-};
 
 export default Table;
 export { Table };

package/lib/tr-grid-util/es6/formula/AdFinSubscription.js

@@ -18,7 +18,7 @@ Ext.inherits(AdFinSubscription, EventDispatcher);
 AdFinSubscription.Request;
 
 /** call signature -> value
-* @type {Object.<string, {pending:boolean,value:*}
+* @type {Object}
 * @private
 */
 AdFinSubscription.prototype._cache = null;

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

@@ -14,7 +14,9 @@ declare namespace ColumnStackPlugin {
         fields: (string)[]|null,
         stacks: (ColumnStackPlugin.StackDefinition)[]|null,
         autoStacking?: boolean|null,
-        clicked?: ((...params: any[]) => any)|null
+        clicked?: ((...params: any[]) => any)|null,
+        menuElement?: Element|null,
+        menuItemClicked?: ((...params: any[]) => any)|null
     };
 
     type ColumnOptions = {

package/lib/types/es6/Core/grid/util/TrackLayout.d.ts

@@ -6,6 +6,8 @@ declare class TrackLayout {
 
     public hitTest(val: number): number;
 
+    public dispose(): void;
+
     public isAtDefaultSize(opt_index?: number|null): boolean;
 
     public isHomogeneous(): boolean;

package/lib/types/es6/RealtimeGrid/Grid.d.ts

@@ -183,9 +183,9 @@ declare class Grid extends EventDispatcher {
 
     public _initDuplicateRicData(rowDef: RowDefinition|null): void;
 
-    public insertRow(rowOption?: any, rowRef?: Grid.RowReference|null): any;
+    public insertRow(rowOption?: (RowDefinition.Options|string)|null, rowRef?: Grid.RowReference|null): RowDefinition|null;
 
-    public insertRows(rowOptions: (any)[]|null, rowRef?: Grid.RowReference|null, opt_fields?: (string)[]|null): void;
+    public insertRows(rowOptions: (RowDefinition.Options|string)[]|null, rowRef?: Grid.RowReference|null, opt_fields?: (string)[]|null): void;
 
     public addStaticDataRows(dataRows: any[]|null, fields?: (string)[]|null): void;
 
@@ -325,7 +325,7 @@ declare class Grid extends EventDispatcher {
 
     public logDV(opt_options?: any): void;
 
-    public replaceRow(rowRef: Grid.RowReference|null, rowOption?: any): any;
+    public replaceRow(rowRef: Grid.RowReference|null, rowOption?: (RowDefinition.Options|string)|null): RowDefinition|null;
 
     public scrollToColumn(colIndex: number, leftOfView?: boolean|null): boolean;
 

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

@@ -10,7 +10,7 @@ declare namespace TextFormattingPlugin {
         formatType?: string|null,
         type?: string|null,
         field?: string|null,
-        decimalPlaces?: number|null,
+        decimalPlaces?: (number|boolean)|null,
         precisionEnabled?: boolean|null,
         plusSign?: boolean|null,
         separator?: boolean|null,

package/lib/versions.json

@@ -1,5 +1,5 @@
 {
-	"tr-grid-util": "1.3.117",
+	"tr-grid-util": "1.3.120",
 	"tr-grid-printer": "1.0.16",
 	"@grid/column-dragging": "1.0.14",
 	"@grid/row-segmenting": "1.0.24",
@@ -13,7 +13,7 @@
 	"tr-grid-column-grouping": "1.0.54",
 	"tr-grid-column-resizing": "1.0.28",
 	"tr-grid-column-selection": "1.0.29",
-	"tr-grid-column-stack": "1.0.68",
+	"tr-grid-column-stack": "1.0.69",
 	"tr-grid-conditional-coloring": "1.0.61",
 	"tr-grid-content-wrap": "1.0.20",
 	"tr-grid-contextmenu": "1.0.39",
@@ -28,7 +28,7 @@
 	"tr-grid-row-grouping": "1.0.81",
 	"tr-grid-row-selection": "1.0.23",
 	"tr-grid-rowcoloring": "1.0.23",
-	"tr-grid-textformatting": "1.0.45",
+	"tr-grid-textformatting": "1.0.46",
 	"tr-grid-titlewrap": "1.0.19",
 	"@grid/formatters": "1.0.50",
 	"@grid/column-selection-dialog": "4.0.52",

package/package.json

@@ -66,5 +66,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.57"
+	"version": "6.0.59"
 }