@refinitiv-ui/efx-grid 6.0.47 → 6.0.49

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

@@ -31,6 +31,7 @@ import VirtualizedLayoutGrid from "./VirtualizedLayoutGrid.js";
 * @property {string} rowId
 * @property {number} rowIndex
 */
+/** @event Core#beforeContentBinding */
 /** @event Core#postSectionDataBinding */
 /** @event Core#rowHighlighted */
 
@@ -81,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);
@@ -166,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);
@@ -193,6 +200,7 @@ var Core = function (opt_initializer) {
 		"postDataSourceChanged",
 		"preSectionRender",
 		"postSectionRender",
+		"beforeContentBinding",
 		"preSectionDataBinding",
 		"postSectionDataBinding",
 		"rowExpansionBinding",
@@ -554,7 +562,7 @@ Core.prototype._batches = null;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.66";
+	return "5.1.67";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -1356,6 +1364,7 @@ Core.prototype.getColumnCount = function () {
 * @fires Core#columnAdded
 * @fires Core#preSectionRender
 * @fires Core#columnRender
+* @fires Core#beforeContentBinding
 * @fires Core#preSectionDataBinding
 * @fires Core#columnDataBinding
 * @fires Core#postSectionDataBinding
@@ -1383,6 +1392,7 @@ Core.prototype.setColumnCount = function(num) {
 * @fires Core#columnAdded
 * @fires Core#preSectionRender
 * @fires Core#columnRender
+* @fires Core#beforeContentBinding
 * @fires Core#preSectionDataBinding
 * @fires Core#columnDataBinding
 * @fires Core#postSectionDataBinding
@@ -1499,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.
@@ -1761,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.
@@ -1831,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) {
@@ -1873,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);
@@ -1884,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
@@ -2001,6 +2007,7 @@ Core.prototype._deserializeColumn = function (index, jsonObj) {
 * @param {number=} opt_num Default is one row
 * @fires Core#preSectionRender
 * @fires Core#columnRender
+* @fires Core#beforeContentBinding
 * @fires Core#preSectionDataBinding
 * @fires Core#columnDataBinding
 * @fires Core#postSectionDataBinding
@@ -3804,6 +3811,7 @@ Core.prototype.synchronizeHScrollbar = function (subGrid) {
 * @param {number=} fromRowIndex INCLUSIVE If the value is undefined, the first row index will be used
 * @param {number=} lastRowIndex INCLUSIVE If the value is undefined, the last row index will be used
 * @param {Object=} userParam Addtional parameters to be fired with the event
+* @fires Core#beforeContentBinding
 * @fires Core#preSectionDataBinding
 * @fires Core#columnDataBinding
 * @fires Core#postSectionDataBinding
@@ -4409,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}
@@ -4446,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()) {
@@ -4685,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);
 			}
 		}
 	}
@@ -4840,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);
 		}
 	}
 };
@@ -4881,6 +4939,9 @@ Core.prototype._onSectionDataChanged = function (e) {
 		rowDataCollection = dataView.getMultipleRowData(rids, fromR, toR);
 		e["dataRows"] = rowDataCollection;
 	}
+	if(e["sectionType"] === "content"){
+		this._dispatch("beforeContentBinding", e);
+	}
 	this._dispatch("preSectionDataBinding", e);
 
 	var dataMap = this.getDataColumnMap();
@@ -4895,9 +4956,13 @@ Core.prototype._onSectionDataChanged = function (e) {
 				for (var r = fromR; r < toR; ++r) {
 					if(hasDataView) {
 						var rowData = rowDataCollection[r];
+						if(!rowData) { // This is a header row
+							continue;
+						}
+
 						e["rowData"] = rowData;
 						e["rowId"] = rids[r];
-						e["dataValue"] = rowData ? rowData[cid] : null;
+						e["dataValue"] = rowData[cid];
 					}
 					e["rowIndex"] = r;
 					e["cell"] = section["getCell"](c, r, false); // Accessing cell by using bracket allows extenal object to mock Section
@@ -5238,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/grid/index.js

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

package/lib/types/es6/Core/data/DataView.d.ts

@@ -276,8 +276,6 @@ declare class DataView extends EventDispatcher {
 
     public sortSegments(compare: ((...params: any[]) => any)|null): void;
 
-    public enableEmptySegmentFiltering(enabled?: boolean|null): void;
-
     public setSegmentClassification(segmentRef: string|number|null, fields: string|(string)[]|null): boolean;
 
     public getWrapSize(): number;

package/lib/types/es6/Core/data/Segment.d.ts

@@ -27,8 +27,6 @@ declare class Segment extends EventDispatcher {
 
     public getChildIds(): (string)[];
 
-    public getChildren(): any;
-
     public getChildCount(): number;
 
     public getClassification(): (string)[]|null;

package/lib/types/es6/Core/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/package.json

@@ -66,5 +66,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.47"
+	"version": "6.0.49"
 }