@refinitiv-ui/efx-grid 6.0.40 → 6.0.42

package/lib/core/es6/grid/Core.d.ts

@@ -405,6 +405,10 @@ declare class Core extends ElementWrapper {
 
     public getColumnGroupChildIds(groupId: string): (string)[]|null;
 
+    public getValidColumnList(colIds: (string)[]|null, columnMap?: any): (string)[];
+
+    public createColumnMap(colIds?: (string)[]|null): any;
+
     public startBatch(batchType: string): boolean;
 
     public stopBatch(batchType: string): boolean;

package/lib/core/es6/grid/Core.js

@@ -82,6 +82,7 @@ var Core = function (opt_initializer) {
 
 	_t._onMouseMove = _t._onMouseMove.bind(_t);
 	_t._onRowHightlighted = _t._onRowHightlighted.bind(_t);
+	_t._onGridClicked = _t._onGridClicked.bind(_t);
 
 	_t._onWindowResize = _t._onWindowResize.bind(_t);
 	_t._onSectionDataChanged = _t._onSectionDataChanged.bind(_t);
@@ -167,11 +168,16 @@ var Core = function (opt_initializer) {
 	_t._hscrollbar.setOtherScrollbar(_t._vscrollbar);
 	_t._vscrollbar.setOtherScrollbar(_t._hscrollbar);
 
-	if (Util.isMobile) {
+	if (Util.isMobile || Util.isTouchDevice) {
 		_t._element.addEventListener("touchmove", this._onMouseMove, false);
 	} else {
 		_t._element.addEventListener("mousemove", this._onMouseMove, false);
 	}
+
+	if(Util.isSafari){
+		_t._element.addEventListener("click", this._onGridClicked);
+	}
+
 	window.addEventListener("resize", _t._onWindowResize, false); // Should be unlistened after destroyed
 	_t._rowVirtualizer.listen("indexChanged", _t._onRowInViewChanged);
 	_t._colVirtualizer.listen("indexChanged", _t._onColInViewChanged);
@@ -556,7 +562,7 @@ Core.prototype._batches = null;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.57";
+	return "5.1.63";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -1503,16 +1509,12 @@ Core.prototype.removeColumnAt = function (index) {
 
 	if (this._hasListener("columnRemoved")) {
 		var e = {};
-		var batches = this._batches;
-		if(batches){
-			e["batches"] = batches;
-		}
 		e["atTheMiddle"] = true;
 		e["colIndex"] = index;
 		e["columns"] = "deprecated";
 		e["columnData"] = colDef["columnData"];
 		e["colId"] = colDef["id"] || "";
-		this._dispatch("columnRemoved", e);
+		this._dispatchColumnEvent("columnRemoved", e);
 	}
 
 	// Last index in view here might be different from before moving column if columns have different width.
@@ -1765,7 +1767,7 @@ Core.prototype._moveColumn = function (fromCol, destCol) {
 		e["fromColIndex"] = fromCol;
 		e["toColIndex"] = destCol;
 		e["colId"] = colId; // TODO: Id may not needed
-		this._dispatch("columnMoved", e);
+		this._dispatchColumnEvent("columnMoved", e); // add remove move
 	}
 
 	// Last index in view here might be different from before moving column if columns have different width.
@@ -1835,6 +1837,9 @@ Core.prototype.reorderColumns = function (colRefs, destCol) {
 		destId = destCol;
 	}
 
+	this.startBatch("move");
+
+	var dirty = 0;
 	if(Array.isArray(colRefs)) {
 		var srcLen = colRefs.length;
 		if(srcLen > 1) {
@@ -1877,7 +1882,6 @@ Core.prototype.reorderColumns = function (colRefs, destCol) {
 				}
 			}
 
-			var dirty = 0;
 			for(i = srcLen; --i >= 0;) {
 				srcId = srcIds[i]; // Only valid source columns are left at this point
 				srcIdx = this.getColumnIndex(srcId);
@@ -1888,17 +1892,15 @@ Core.prototype.reorderColumns = function (colRefs, destCol) {
 				dirty |= this._moveColumnByIndex(srcIdx, destIdx);
 				destId = srcId;
 			}
-			return dirty ? true : false;
 		} else {
-			return this.moveColumnById(colRefs[0], destId);
+			dirty = this.moveColumnById(colRefs[0], destId);
 		}
-	}
-
-	if(colRefs != null) {
+	} else if(colRefs != null) {
 		// colRefs will be a number or string
-		return this.moveColumnById(colRefs, destId);
+		dirty = this.moveColumnById(colRefs, destId);
 	}
-	return false;
+	this.stopBatch("move");
+	return dirty ? true : false;
 };
 
 /** @public
@@ -4415,6 +4417,53 @@ Core.prototype.getColumnGroupChildIds = function (groupId) {
 	return null;
 };
 
+/** @public
+* @description Get a list of objects with column id and column index in sorted order
+* @param {Array.<string>} colIds
+* @param {Object=} columnMap
+* @return {!Array.<string>} Return column array with corresponding order to UI
+* @example
+* core.getValidColumnList(["c1","c2","c5"]); // Get list of valid columns
+* core.getValidColumnList(["c1","c2","c5"],{ "c2":true, "c5":true }); // Get list of valid columns from specific mapping
+*/
+Core.prototype.getValidColumnList = function (colIds, columnMap) {
+	var colList = [];
+	if(!colIds){
+		return colList;
+	}
+	if(!columnMap){
+		columnMap = this.createColumnMap(colIds);
+	}
+	var colCount = this.getColumnCount();
+	for(var c = 0; c < colCount; ++c) {
+		var id = this._getColumnDef(c)["id"];
+		if(columnMap[id] != null){
+			colList.push({"index": c, "id": id});
+		}
+	}
+	return colList;
+};
+
+/** @public
+* @description Create mapping object from an array of strings
+* @param {Array.<string>=} colIds
+* @return {!Object} Column mapping object
+*/
+Core.prototype.createColumnMap = function (colIds) {
+	if(!colIds){
+		colIds = this.getColumnIds();
+	}
+	var mappingObj = {};
+	var count = colIds.length;
+	for(var i = 0; i < count; i++){
+		var colId = colIds[i];
+		if(colId){
+			mappingObj[colId] = true;
+		}
+	}
+	return mappingObj;
+};
+
 /** @public
 * @param {string} batchType
 * @return {boolean}
@@ -4452,6 +4501,17 @@ Core.prototype.stopBatch = function (batchType) {
 
 //#region Private Methods
 /** @private
+* @param {string} type
+* @param {!Object} eventArg
+*/
+Core.prototype._dispatchColumnEvent = function (type, eventArg) {
+	var batches = this._batches;
+	if(batches){
+		eventArg["batches"] = batches;
+	}
+	this._dispatch(type, eventArg);
+};
+/** @private
 */
 Core.prototype._dispatchColumnPositionChanged = function () {
 	if(this._columnPositionConflator.conflate()) {
@@ -4691,20 +4751,16 @@ Core.prototype._dispatchColumnAddedEvent = function (at, count, atTheMiddle, ctx
 	if (this._hasListener("columnAdded")) {
 		var e = {};
 		e["atTheMiddle"] = atTheMiddle;
-		var batches = this._batches;
-		if(batches){
-			e["batches"] = batches;
-		}
 		if(count === 1) {
 			e["colIndex"] = at;
 			e["context"] = ctx;
-			this._dispatch("columnAdded", e);
+			this._dispatchColumnEvent("columnAdded", e);
 		} else {
 			var ary = Array.isArray(ctx) ? ctx : [];
 			for (var i = 0; i < count; ++i) {
 				e["colIndex"] = at + i;
 				e["context"] = ary[i];
-				this._dispatch("columnAdded", e);
+				this._dispatchColumnEvent("columnAdded", e);
 			}
 		}
 	}
@@ -4846,15 +4902,11 @@ Core.prototype._removeColumn = function (num) {  // TODO: change the logic to us
 
 	if (this._hasListener("columnRemoved")) {
 		var e = {};
-		var batches = this._batches;
-		if(batches){
-			e["batches"] = batches;
-		}
 		for (var c = colCount; --c >= newCount; ) {
 			var colDef = removedCols[c - newCount];
 			e["colIndex"] = c;
 			e["columnData"] = colDef ? colDef["columnData"] : null;
-			this._dispatch("columnRemoved", e);
+			this._dispatchColumnEvent("columnRemoved", e);
 		}
 	}
 };
@@ -5251,6 +5303,18 @@ Core.prototype._onMouseMove = function () {
 	this._vscrollbar.flash();
 	this._hscrollbar.flash();
 };
+/** @private */
+Core.prototype._onGridClicked = function () {
+	// research for dragging
+	var selection = window.getSelection();
+	if(selection.toString()){
+		return;
+	}
+	var activeElem = document.activeElement;
+	if(!this._element.contains(activeElem)){
+		this.focus();
+	}
+};
 
 /** @private
 * @param {Object} e

package/lib/core/es6/grid/plugins/SortableTitlePlugin.d.ts

@@ -11,8 +11,9 @@ declare namespace SortableTitlePlugin {
     type SortOrder = "a" | "ascending" | "d" | "descending" | "n" | null|null;
 
     type InitialSort = {
-        colIndex: number,
-        field: string,
+        colIndex?: number|null,
+        colId?: string|null,
+        field?: string|null,
         sortOrder?: SortableTitlePlugin.SortOrder|null,
         order?: SortableTitlePlugin.SortOrder|null
     };

package/lib/core/es6/grid/plugins/SortableTitlePlugin.js

@@ -81,8 +81,9 @@ Ext.inherits(SortableTitlePlugin, EventDispatcher);
 
 /** The sorting object which will be used for initialSort config.
  * @typedef {Object} SortableTitlePlugin~InitialSort
- * @property {number} colIndex Index of the column
- * @property {string} field field of the column
+ * @property {number=} colIndex Index of the column
+ * @property {string=} colId column id of the column
+ * @property {string=} field field of the column
  * @property {SortableTitlePlugin~SortOrder=} sortOrder=null Set to "d" for descending order and "a" for ascending order
  * @property {SortableTitlePlugin~SortOrder=} order Alias of sortOrder
  */
@@ -740,6 +741,7 @@ SortableTitlePlugin.prototype.getSortedColumns = function () {
 		var state = this._sortStates[i];
 		arr[i] = {
 			"colIndex": colIndex,
+			"colId": this._getColumnId(colIndex),
 			"field": state["field"] || "",
 			"sortOrder": state["sortOrder"] || "n"
 		};
@@ -781,7 +783,7 @@ SortableTitlePlugin.prototype.sortColumns = function (sortOptions, opt_arg) {
 			var opt = sortOptions[i];
 			var colRef = opt["colIndex"];
 			if(colRef < 0 || colRef == null) {
-				colRef = opt["field"];
+				colRef = opt["colId"] || opt["field"];
 			}
 			var state = this._prepareSorting(
 				colRef,
@@ -1368,19 +1370,9 @@ SortableTitlePlugin.prototype._prepareSorting = function (colRef, sortOrder) {
 		return null;
 	}
 
-	var colIndex = -1;
-	var field = "";
-	var priority = -1;
-	if(typeof colRef === "number") {
-		colIndex = colRef;
-		field = this.getColumnSortingField(colIndex);
-		priority = this.getSortPriority(colIndex);
-	} else if(typeof colRef === "string") {
-		field = colRef;
-		colIndex = this._getColumnIndexByField(field);
-		var fields = this.getColumnSortingFields();
-		priority = fields.indexOf(field);
-	}
+	var colIndex = this._getColumnIndex(colRef);
+	var priority = this.getSortPriority(colIndex);
+	var field = this.getColumnSortingField(colIndex);
 
 	var curState = (priority >= 0) ? this._sortStates[priority] : null;
 	var curOrder = curState ? curState["sortOrder"] : "n";
@@ -1764,21 +1756,29 @@ SortableTitlePlugin.prototype._getColumnIndexByOptions = function (sortOptions)
 	return -1;
 };
 /** @private
-* @param {string} field
+* @param {string|number} colRef
 * @return {number}
 */
-SortableTitlePlugin.prototype._getColumnIndexByField = function (field) {
-	if(field) {
-		var host = this._hosts[0];
-		var colCount = host ? host.getColumnCount() : 0;
-		for (var c = 0; c < colCount; ++c) {
-			if(field === this.getColumnSortingField(c)) {
-				return c;
-			}
-		}
+SortableTitlePlugin.prototype._getColumnIndex = function (colRef) {
+	var host = this._hosts[0];
+	if(host && colRef != null) {
+		return host.getColumnIndex(colRef);
 	}
 	return -1;
 };
+
+/** @private
+* @param {string|number} colRef
+* @return {string} column id or empty string for not found
+*/
+SortableTitlePlugin.prototype._getColumnId = function (colRef) {
+	var host = this._hosts[0];
+	if(host && colRef != null) {
+		return host.getColumnId(colRef);
+	}
+	return "";
+};
+
 /** @private
 * @param {number} colIndex
 * @return {Object}

package/lib/core/es6/grid/util/util.js

@@ -2,23 +2,46 @@
 * @namespace
 */
 var Util = {};
+
+// TODO: move to tr-grid-util
+
 /** @const
 * @type {boolean}
 */
-Util.isIE = Util.isIE || (function () {
+Util.isIE = (function () {
 	var ua = window.navigator.userAgent;
 	return (ua.indexOf('MSIE ') > 0) || (ua.indexOf('Trident/') > 0) || (ua.indexOf('Edge/') > 0);
 }());
 /** @const
 * @type {boolean}
 */
-Util.isTouchDevice = Util.isTouchDevice || (function () {
+Util.isTouchDevice = (function () {
 	if ((navigator["maxTouchPoints"] && navigator["maxTouchPoints"] < 256) ||
 		(navigator["msMaxTouchPoints"] && navigator["msMaxTouchPoints"] < 256)) {
 		return true;
 	}
 	return false;
 }());
+/** @const
+* @type {boolean}
+*/
+Util.isSafari = (function () {
+	var rejectedExpression = /Chrome|Android|CriOS|FxiOS|EdgiOS/i;
+	var safariExpression = /Safari/i;
+	var agent = navigator.userAgent;
+	if (rejectedExpression.test(agent)) {
+		return false;
+	}
+	return safariExpression.test(agent);
+}());
+
+/** @public
+ * @type {boolean}
+ */
+Util.isMobile = (function () {
+	return /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);
+}());
+
 /** Retrieve an element from Novakit control or any object that has "getElement" method.
 * @public
 * @ignore
@@ -364,12 +387,5 @@ Util._preventDefault = function (e) {
 	e.stopPropagation();
 };
 
-/** @public
- * @type {boolean}
- */
-Util.isMobile = Util.isMobile || (function () {
-	return /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);
-}());
-
 export default Util;
 export { Util };

package/lib/grid/index.js

@@ -1,3 +1,3 @@
 import {Grid} from "./lib/efx-grid.js";
 export {Grid}
-window.EFX_GRID = { version: "6.0.40" };
+window.EFX_GRID = { version: "6.0.42" };