@refinitiv-ui/efx-grid 6.0.3 → 6.0.4

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

@@ -0,0 +1,137 @@
+/** @constructor
+*/
+var RowDefSorter = function() {
+	this._defaultSorter = this._defaultSorter.bind(this);
+	this._dataSorter = this._dataSorter.bind(this);
+	this._rowDefSorter = this._rowDefSorter.bind(this);
+
+	this._sortContext = {};
+};
+
+
+/** @type {string}
+* @private
+*/
+RowDefSorter.prototype._field = "";
+/** @type {!Object}
+* @private
+*/
+RowDefSorter.prototype._sortContext;
+/** @type {Function}
+* @private
+*/
+RowDefSorter.prototype._sortLogic = null;
+
+
+/** @public
+*/
+RowDefSorter.prototype.dispose = function() {
+	this._sortLogic = null;
+	this._sortContext = {}; // Clear any existing reference
+};
+
+/** @public
+* @param {boolean=} rowSorting=false
+* @return {Function}
+*/
+RowDefSorter.prototype.getSorter = function(rowSorting) {
+	if(this._sortLogic) {
+		return rowSorting ? this._rowDefSorter : this._dataSorter;
+	} else {
+		return this._defaultSorter;
+	}
+};
+/** @public
+* @param {Function=} func
+*/
+RowDefSorter.prototype.setSortLogic = function(func) {
+	this._sortLogic = (typeof func === "function") ? func : null;
+};
+
+
+/** @public
+* @param {string} field
+*/
+RowDefSorter.prototype.setField = function(field) {
+	if(!field) {
+		field = "";
+	}
+	this._sortContext["field"] = this._field = field;
+	this._sortContext["formattedField"] = field + "_FORMATTED";
+};
+/** @public
+* @param {string} key
+* @param {*} value
+*/
+RowDefSorter.prototype.setContext = function(key, value) {
+	this._sortContext[key] = value;
+};
+
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._defaultSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	var a = rowDefA.getData(this._field);
+	var b = rowDefB.getData(this._field);
+
+	if(a == null || a !== a) {
+		if(b == null || b !== b) {
+			return 0;
+		}
+		return 1;
+	}
+	if(b == null || b !== b) {
+		return -1;
+	}
+
+	if(a < b) {
+		return -order;
+	}
+	if(b < a) {
+		return order;
+	}
+	return 0;
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._dataSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	var a = rowDefA.getData(this._field);
+	var b = rowDefB.getData(this._field);
+	return this._sortLogic(a, b, order, this._sortContext);
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._rowDefSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	return this._sortLogic(rowDefA, rowDefB, order, this._sortContext);
+};
+
+export default RowDefSorter;

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

@@ -31,12 +31,14 @@ declare class RowDefinition {
 
     public getRowId(): string;
 
-    public getConfigObject(rowOptions?: RowDefinition.Options): RowDefinition.Options;
+    public getConfigObject(rowOptions?: RowDefinition.Options): RowDefinition.Options|null;
 
     public getDataId(): string;
 
     public setDataSource(dataSource: DataCache): void;
 
+    public getDataSource(): DataCache|null;
+
     public getRowData(): any;
 
     public getData(field: string): any;
@@ -57,7 +59,7 @@ declare class RowDefinition {
 
     public getDisplayText(): string;
 
-    public getLabel(): string|null;
+    public getLabel(): string|null|null;
 
     public isRowHeader(): boolean;
 
@@ -81,13 +83,13 @@ declare class RowDefinition {
 
     public addUpdate(e: any): boolean;
 
-    public getUpdates(): { [key: string]:  number };
+    public getUpdates(): { [key: string]:  number }|null;
 
     public resetUpdates(): void;
 
     public registerToView(view: DataTable, rowId?: string): void;
 
-    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[];
+    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[]|null;
 
     public collapseChain(): boolean;
 
@@ -95,15 +97,15 @@ declare class RowDefinition {
 
     public toggleChain(): boolean;
 
-    public getChildren(): (RowDefinition)[];
+    public getChildren(): (RowDefinition)[]|null;
 
     public getDescendants(ary?: (RowDefinition)[]): (RowDefinition)[];
 
-    public getAllDescendantIds(): (string)[];
+    public getAllDescendantIds(): (string)[]|null;
 
     public getChildCount(): number;
 
-    public getParent(): RowDefinition;
+    public getParent(): RowDefinition|null;
 
     public getDepthLevel(): number;
 

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

@@ -363,6 +363,12 @@ RowDefinition.prototype.setDataSource = function(dataSource) {
 	// This will work for runtime row insertion, but not for first initilization.
 	this.subscribeForUpdates();
 };
+/** @public
+* @return {DataCache} dataSource
+*/
+RowDefinition.prototype.getDataSource = function() {
+	return this._dc;
+};
 
 /** @public
 * @return {Object} rowData

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

@@ -9,9 +9,11 @@ declare class SnapshotFiller extends EventDispatcher {
 
     public addRic(ric: string): void;
 
+    public addRics(rics: (string)[]): boolean;
+
     public addField(str: string): void;
 
-    public addFields(fields: (string)[]): void;
+    public addFields(fields: (string)[]): boolean;
 
     public static isValidField(str: string): boolean;
 

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

@@ -68,6 +68,26 @@ SnapshotFiller.prototype.addRic = function (ric) {
 	}
 };
 /** @public
+* @param {Array.<string>} rics
+* @return {boolean}
+*/
+SnapshotFiller.prototype.addRics = function (rics) {
+	var len = rics ? rics.length : 0;
+	var dirty = false;
+	for(var i = 0; i < len; ++i) {
+		var ric = rics[i];
+		if (ric && !this._rics[ric]) {
+			this._rics[ric] = 1;
+			dirty = true;
+		}
+	}
+	if(dirty) {
+		this._request();
+		return true;
+	}
+	return false;
+};
+/** @public
 * @param {string} str
 */
 SnapshotFiller.prototype.addField = function (str) {
@@ -77,6 +97,7 @@ SnapshotFiller.prototype.addField = function (str) {
 };
 /** @public
 * @param {Array.<string>} fields
+* @return {boolean}
 */
 SnapshotFiller.prototype.addFields = function (fields) {
 	var len = fields.length;
@@ -86,7 +107,9 @@ SnapshotFiller.prototype.addFields = function (fields) {
 	}
 	if(dirty) {
 		this._request();
+		return true;
 	}
+	return false;
 };
 
 /** @private

package/lib/tr-grid-checkbox/es6/Checkbox.d.ts

@@ -1,7 +1,7 @@
 import {Ext} from '../../tr-grid-util/es6/Ext.js';
 import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
 import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
-import {injectCss, prettifyCss, extendObject} from "../../tr-grid-util/es6/Util.js";
+import {injectCss, prettifyCss} from "../../tr-grid-util/es6/Util.js";
 
 declare namespace CheckboxPlugin {
 
@@ -42,7 +42,7 @@ declare class CheckboxPlugin extends GridPlugin {
 
     public getDisplayColumn(): number;
 
-    public getCheckbox(sectionRef: any, rowIndex: number): Element;
+    public getCheckbox(sectionRef: any, rowIndex: number): Element|null;
 
     public selectAll(): void;
 

package/lib/tr-grid-checkbox/es6/Checkbox.js

@@ -1,7 +1,7 @@
 import {Ext} from '../../tr-grid-util/es6/Ext.js';
 import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
 import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
-import {injectCss, prettifyCss, extendObject} from "../../tr-grid-util/es6/Util.js";
+import {injectCss, prettifyCss} from "../../tr-grid-util/es6/Util.js";
 
 /** @typedef {Object} CheckboxPlugin~Options
 * @description Available options describing `checkbox` object specified in grid's option
@@ -126,9 +126,11 @@ CheckboxPlugin._styles = prettifyCss([
 	".tr-checkbox-column input[type='checkbox'], .tr-checkbox-column input+label", [
 		"cursor: pointer;"
 	],
-	".column.tr-checkbox-column .cell", [
-		"padding: 0;",
-		"text-align: center;"
+	".column.tr-checkbox-column.tr-align-left .cell", [
+		"text-align: left;"
+	],
+	".column.tr-checkbox-column.tr-align-right .cell", [
+		"text-align: right;"
 	]
 ]);
 /** @private
@@ -446,31 +448,30 @@ CheckboxPlugin.prototype.beforeInit = function(elem, config, runTime) {
 		}
 	}
 
-	var chbxCol = t._genCheckboxColumn();
-	var checkboxIdx = t._userCheckboxIdx = t._findCheckboxColumnIndexFromConfig(columns);
-
-	if (checkboxIdx >= 0) {
-		// WARNING:: User column config will be deleted here since we swap user column with our generated checkbox column
-		extendObject(columns[checkboxIdx], chbxCol);
+	t._userCheckboxIdx = t._findCheckboxColumnIndexFromConfig(columns);
+	if (t._userCheckboxIdx >= 0) {
+		t._genCheckboxColumn(columns[t._userCheckboxIdx]);
 	} else {
-		checkboxIdx = t._userCheckboxIdx = 0;
-		columns.unshift(chbxCol);
+		columns.unshift(t._genCheckboxColumn());
+		t._userCheckboxIdx = 0; // TODO: This _userCheckboxIdx has some misleading meaning
 	}
 };
 
 /** @private
-* @return {Object} checkbox column config
+* @param {Object=} userObj
+* @return {!Object} checkbox column config
 */
-CheckboxPlugin.prototype._genCheckboxColumn = function () {
-	return {
-		autoGenerated: true,
+CheckboxPlugin.prototype._genCheckboxColumn = function (userObj) {
+	var defaultObj = {
 		width: this._width,
 		sortable: false,
 		className: "tr-checkbox-column", // For rt-grid
 		classes: { "tr-checkbox-column": 1 }, // For composite grid
 		noResizing: true, // ColumnResizing Extension
 		resizable: false, // ResizableTitlePlugin
-		headerRenderer: this._onPreSectionRender, // rt-grid support
+		title: "",
+		tooltip: "",
+		// headerRenderer: CheckboxPlugin._emptyFunc, // rt-grid support
 		filterInput: { disabled: true },
 		field: this._checkboxField,
 		notRealTimeField: true, // Checkbox column is not a real-time field
@@ -482,6 +483,26 @@ CheckboxPlugin.prototype._genCheckboxColumn = function () {
 			bind: CheckboxPlugin._emptyFunc
 		}
 	};
+
+	if(userObj && !userObj.autoGenerated) {
+		if(userObj.field && this._checkboxField === "CHECK_BOX") {
+			this._checkboxField = userObj.field;
+		}
+		if(userObj.width && this._width === 34) {
+			this._width = +userObj.width;
+		}
+
+		for(var key in defaultObj) {
+			var userVal = userObj[key];
+			if(userVal == null) {
+				userObj[key] = defaultObj[key];
+			}
+		}
+		return userObj;
+	}
+
+	defaultObj.autoGenerated = true;
+	return defaultObj;
 };
 
 /** @private
@@ -615,9 +636,6 @@ CheckboxPlugin.prototype._createCheckbox = function (sectionSettings, colIndex,
 
 	cell.setContent(chkbox);
 	var sectionType = sectionSettings.getType();
-	if(sectionType == "title") {
-		cell.enableClass("no-sort");
-	}
 
 	if(!this._coralCheckboxVer) { // Workaround for UIFR theme styling
 		var lbl = document.createElement("label");

package/lib/tr-grid-column-selection/es6/ColumnSelection.js

@@ -34,6 +34,7 @@ var ColumnSelectionPlugin = function ColumnSelectionPlugin(options) {
   t._onMouseDown = t._onMouseDown.bind(t);
   t._onKeyDown = t._onKeyDown.bind(t);
   t._onColumnRemoved = t._onColumnRemoved.bind(t);
+  t._onColumnAdded = t._onColumnAdded.bind(t);
   t._onReselection = t._onReselection.bind(t);
   t._onThemeLoaded = t._onThemeLoaded.bind(t);
   t._onColumnPositionChanged = t._onColumnPositionChanged.bind(t);
@@ -93,7 +94,12 @@ ColumnSelectionPlugin.prototype._timerMenuId = 0;
 * @private
 */
 
-ColumnSelectionPlugin.prototype._pendingSelection = -1;
+ColumnSelectionPlugin.prototype._pendingSelectionOnAdded = -1;
+/** @type {Function}
+* @private
+*/
+
+ColumnSelectionPlugin.prototype._pendingSelectionOnRemoved = -1;
 /** @type {Function}
 * @private
 */
@@ -142,6 +148,7 @@ ColumnSelectionPlugin.prototype.initialize = function (host, options) {
   host.listen("mousedown", this._onMouseDown);
   host.listen("keydown", this._onKeyDown);
   host.listen("columnRemoved", this._onColumnRemoved);
+  host.listen("columnAdded", this._onColumnAdded);
   host.listen("columnPositionChanged", this._onColumnPositionChanged);
   this.config(options);
 
@@ -204,6 +211,7 @@ ColumnSelectionPlugin.prototype.unload = function (host) {
   host.unlisten("mousedown", this._onMouseDown);
   host.unlisten("keydown", this._onKeyDown);
   host.unlisten("columnRemoved", this._onColumnRemoved);
+  host.unlisten("columnAdded", this._onColumnAdded);
   host.unlisten("columnPositionChanged", this._onColumnPositionChanged);
 
   this._hosts.splice(at, 1);
@@ -458,7 +466,9 @@ ColumnSelectionPlugin.prototype.setSelectedColumn = function (colIndex, opt_sele
   }
 
   this._hasSelection = selection ? true : null;
-  this._pendingSelection = -1; // New selection happens before resolving the pending selection
+  this._pendingSelectionOnAdded = -1; // New selection happens before resolving the pending selection
+
+  this._pendingSelectionOnRemoved = -1; // New selection happens before resolving the pending selection
 
   var len = this._hosts.length;
 
@@ -867,7 +877,13 @@ ColumnSelectionPlugin.prototype._onKeyDown = function (e) {
 
 
 ColumnSelectionPlugin.prototype._onColumnRemoved = function (e) {
+  var colIndex = e.colIndex;
+
   if (this._timerId) {
+    if (this._pendingSelectionOnAdded > 0 && colIndex < this._pendingSelectionOnAdded) {
+      this._pendingSelectionOnAdded = this._pendingSelectionOnAdded - 1;
+    }
+
     return;
   } // Since column and its selection state has been removed, we have to keep track of the first selection across multiple calls
 
@@ -879,19 +895,17 @@ ColumnSelectionPlugin.prototype._onColumnRemoved = function (e) {
       // The last selection has been removed
       this._hasSelection = false;
 
-      if (this._pendingSelection < 0) {
-        var colIndex = e.colIndex;
-
+      if (this._pendingSelectionOnRemoved < 0) {
         if (colIndex >= this.getColumnCount()) {
           colIndex = this.getColumnCount() - 1;
         }
 
-        this._pendingSelection = colIndex;
+        this._pendingSelectionOnRemoved = colIndex;
       }
 
       this._timerId = setTimeout(this._onReselection, 10);
     } else {
-      this._pendingSelection = firstSel;
+      this._pendingSelectionOnRemoved = firstSel;
     }
   }
 };
@@ -900,10 +914,33 @@ ColumnSelectionPlugin.prototype._onColumnRemoved = function (e) {
 */
 
 
+ColumnSelectionPlugin.prototype._onColumnAdded = function (e) {
+  if (this._timerId) {
+    this._pendingSelectionOnAdded = e.colIndex;
+    return;
+  }
+
+  if (this._hasSelection) {
+    this.clearAllSelections();
+
+    if (this._pendingSelectionOnAdded < 0) {
+      this._pendingSelectionOnAdded = e.colIndex;
+    }
+
+    this._timerId = setTimeout(this._onReselection, 10);
+  }
+};
+/** @private
+* @param {Object} e
+*/
+
+
 ColumnSelectionPlugin.prototype._onReselection = function (e) {
   this._timerId = 0;
-  this.setSelectedColumn(this._pendingSelection, true);
-  this._pendingSelection = -1;
+  var pendingSelection = this._pendingSelectionOnAdded > -1 ? this._pendingSelectionOnAdded : this._pendingSelectionOnRemoved;
+  this.setSelectedColumn(pendingSelection, true);
+  this._pendingSelectionOnAdded = -1;
+  this._pendingSelectionOnRemoved = -1;
 
   if (!this._activeGrid) {
     this._activeGrid = this._hosts[0];

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

@@ -9,6 +9,10 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 
 declare namespace ColumnStackPlugin {
 
+    type Options = {
+        fields: (string)[]
+    };
+
     type ColumnOptions = {
         stackId?: string,
         stack?: (string|StackOptions)
@@ -34,11 +38,11 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getConfigObject(gridOptions?: any): any;
 
-    public getMemberIndices(colIndex: number): (number)[];
+    public getMemberIndices(colIndex: number): (number)[]|null;
 
-    public collapseGroup(colIndex: number, collapsed?: boolean): (number)[];
+    public collapseGroup(colIndex: number, collapsed?: boolean): (number)[]|null;
 
-    public expandGroup(colIndex: number): (number)[];
+    public expandGroup(colIndex: number): (number)[]|null;
 
     public isColumnStackable(colIndices: (number)[]): boolean;
 
@@ -60,7 +64,7 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getStackId(colIndex: number): string;
 
-    public stackColumns(colIndices?: (number)[], stackId?: string, options?: any): boolean;
+    public stackColumns(colRefs?: (number|string)[], stackId?: string, options?: any): boolean;
 
     public setStack(colRefs: (number|string)[]): boolean;