@refinitiv-ui/efx-grid 6.0.41 → 6.0.43

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.59";
+	return "5.1.64";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -4411,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}
@@ -5250,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}
@@ -1838,6 +1838,12 @@ SortableTitlePlugin.prototype._isCellSortable = function (section, colIndex, row
 	if (targetCell !== bottomCell) {
 		return false;
 	}
+	var parentCell = targetCell.getParent();
+	var classList = parentCell["classList"];
+	// "collapsed" class in column element only enable by column stack in spreading mode
+	if (classList.contains("collapsed")) { // HACK: unsortable for collapsed stack in spreading mode
+		return false;
+	}
 
 	return true; // By default all cells are sortable
 };

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/formatters/es6/CoralButtonFormatter.d.ts

@@ -3,7 +3,7 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace CoralButtonFormatter {
 
     type Options = {
-        label?: string
+        label?: string|null
     };
 
 }
@@ -12,7 +12,7 @@ declare class CoralButtonFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralButtonFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralButtonFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/CoralCheckboxFormatter.d.ts

@@ -4,7 +4,7 @@ declare class CoralCheckboxFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/CoralComboBoxFormatter.d.ts

@@ -4,9 +4,9 @@ import ElfUtil from "../../tr-grid-util/es6/ElfUtil.js";
 declare namespace CoralComboBoxFormatter {
 
     type Options = {
-        data?: any[],
-        entries?: any[],
-        items?: any[]
+        data?: any[]|null,
+        entries?: any[]|null,
+        items?: any[]|null
     };
 
 }
@@ -15,7 +15,7 @@ declare class CoralComboBoxFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralComboBoxFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralComboBoxFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/CoralIconFormatter.d.ts

@@ -3,8 +3,8 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace CoralIconFormatter {
 
     type Options = {
-        icon?: (string|any),
-        size?: (number|string)
+        icon?: (string|any)|null,
+        size?: (number|string)|null
     };
 
 }
@@ -13,7 +13,7 @@ declare class CoralIconFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralIconFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralIconFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/CoralInputFormatter.d.ts

@@ -4,7 +4,7 @@ declare class CoralInputFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/CoralRadioButtonFormatter.d.ts

@@ -3,7 +3,7 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace CoralRadioButtonFormatter {
 
     type Options = {
-        initialIndex?: number
+        initialIndex?: number|null
     };
 
 }
@@ -12,7 +12,7 @@ declare class CoralRadioButtonFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralRadioButtonFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralRadioButtonFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/CoralSelectFormatter.d.ts

@@ -4,9 +4,9 @@ import CoralItems from "../../tr-grid-util/es6/CoralItems.js";
 declare namespace CoralSelectFormatter {
 
     type Options = {
-        data?: any[],
-        entries?: any[],
-        items?: any[]
+        data?: any[]|null,
+        entries?: any[]|null,
+        items?: any[]|null
     };
 
 }
@@ -15,7 +15,7 @@ declare class CoralSelectFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralSelectFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralSelectFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/CoralToggleFormatter.d.ts

@@ -4,7 +4,7 @@ declare class CoralToggleFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/DuplexEmeraldDateTimePickerFormatter.d.ts

@@ -6,7 +6,7 @@ declare class DuplexEmeraldDateTimePickerFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFButtonFormatter.d.ts

@@ -3,7 +3,7 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace EFButtonFormatter {
 
     type Options = {
-        label?: string
+        label?: string|null
     };
 
 }
@@ -12,7 +12,7 @@ declare class EFButtonFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|EFButtonFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|EFButtonFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFCheckboxFormatter.d.ts

@@ -4,7 +4,7 @@ declare class EFCheckboxFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFComboBoxFormatter.d.ts

@@ -4,9 +4,9 @@ import CoralItems from "../../tr-grid-util/es6/CoralItems.js";
 declare namespace EFComboBoxFormatter {
 
     type Options = {
-        data?: any[],
-        entries?: any[],
-        items?: any[]
+        data?: any[]|null,
+        entries?: any[]|null,
+        items?: any[]|null
     };
 
 }
@@ -15,7 +15,7 @@ declare class EFComboBoxFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|EFComboBoxFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|EFComboBoxFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFDateTimePickerFormatter.d.ts

@@ -5,7 +5,7 @@ declare class EFDateTimePickerFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFIconFormatter.d.ts

@@ -3,8 +3,8 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace EFIconFormatter {
 
     type Options = {
-        icon?: (string|any),
-        size?: (number|string)
+        icon?: (string|any)|null,
+        size?: (number|string)|null
     };
 
 }
@@ -13,7 +13,7 @@ declare class EFIconFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|EFIconFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|EFIconFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFNumberFieldFormatter.d.ts

@@ -4,7 +4,7 @@ declare class EFNumberFieldFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFRadioButtonFormatter.d.ts

@@ -3,7 +3,7 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace EFRadioButtonFormatter {
 
     type Options = {
-        initialIndex?: number
+        initialIndex?: number|null
     };
 
 }
@@ -12,7 +12,7 @@ declare class EFRadioButtonFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|EFRadioButtonFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|EFRadioButtonFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFSelectFormatter.d.ts

@@ -4,9 +4,9 @@ import CoralItems from "../../tr-grid-util/es6/CoralItems.js";
 declare namespace EFSelectFormatter {
 
     type Options = {
-        data?: any[],
-        entries?: any[],
-        items?: any[]
+        data?: any[]|null,
+        entries?: any[]|null,
+        items?: any[]|null
     };
 
 }
@@ -15,7 +15,7 @@ declare class EFSelectFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|EFSelectFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|EFSelectFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFTextFieldFormatter.d.ts

@@ -4,7 +4,7 @@ declare class EFTextFieldFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EFToggleFormatter.d.ts

@@ -4,7 +4,7 @@ declare class EFToggleFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/EmeraldDateTimePickerFormatter.d.ts

@@ -5,7 +5,7 @@ declare class EmeraldDateTimePickerFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/FormatterBuilder.d.ts

@@ -3,9 +3,13 @@
 declare namespace FormatterBuilder {
 
     type Options = {
+        field?: string|null,
         attributes?: any,
         styles?: any,
-        events?: any
+        events?: any,
+        changeHandler?: ((...params: any[]) => any)|null,
+        changeHandlers?: (((...params: any[]) => any))[]|null,
+        onElementRendered?: ((...params: any[]) => any)|null
     };
 
 }
@@ -14,7 +18,7 @@ declare class FormatterBuilder {
 
     constructor(options?: any);
 
-    public static create(userOptions?: FormatterBuilder.Options, defaultOpt?: FormatterBuilder.Options): any;
+    public static create(userOptions?: FormatterBuilder.Options|null, defaultOpt?: FormatterBuilder.Options|null): any;
 
 }