@refinitiv-ui/efx-grid 6.0.91 → 6.0.92

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

@@ -11,10 +11,10 @@ import {ElfUtil} from "./ElfUtil.js";
 * import {Ext} from "../../node_modules/tr-grid-util/src/Ext.js";
 * import {GridPlugin} from "../../node_modules/tr-grid-util/src/GridPlugin.js";
 *
-* var SomePlugin = function() {};
+* let SomePlugin = function() {};
 * Ext.inherits(SomePlugin, GridPlugin);
 */
-var GridPlugin = function() {};
+let GridPlugin = function() {};
 Ext.inherits(GridPlugin, EventDispatcher);
 
 /** @type {Array.<tr.Grid>}
@@ -68,7 +68,7 @@ GridPlugin.prototype.unlisten = GridPlugin.prototype.removeEventListener;
 * @param {tr.CompositeGrid=} grid Composite grid control
 */
 GridPlugin.prototype.afterInit = function(elem, model, grid) {
-	var core = null;
+	let core = null;
 	if(grid && grid["getCoreGrid"]) {
 		core = grid["getCoreGrid"]();
 	}
@@ -159,10 +159,10 @@ GridPlugin.prototype.unload = function (host) {
 * @return {tr.Grid}
 */
 GridPlugin.prototype.getRelativeGrid = function (e) {
-	var targetEl = null;
+	let targetEl = null;
 	if(e.target) { // The Given object is an Event
 		targetEl = /** @type{Element} */(e.target);
-		var gridAPI = targetEl["api"];
+		let gridAPI = targetEl["api"];
 		if(gridAPI && gridAPI["getCoreGrid"]) {
 			return /** @type{tr.Grid} */(gridAPI["getCoreGrid"]());
 		}
@@ -173,8 +173,8 @@ GridPlugin.prototype.getRelativeGrid = function (e) {
 	}
 
 	if(targetEl) {
-		for(var i = this._hosts.length; --i >= 0;) {
-			var host = this._hosts[i];
+		for(let i = this._hosts.length; --i >= 0;) {
+			let host = this._hosts[i];
 			if(host.getElement().contains(targetEl)) {
 				return host;
 			}
@@ -206,7 +206,7 @@ GridPlugin.prototype.getGridApi = function (coreRef) {
 	if(coreRef == null) {
 		return this._compositeGrid || this._realTimeGrid;
 	} else {
-		var host = (typeof coreRef == "number") ? this._hosts[coreRef] : coreRef;
+		let host = (typeof coreRef == "number") ? this._hosts[coreRef] : coreRef;
 		return host ? (host._wrapper || null) : null;
 	}
 };
@@ -218,7 +218,7 @@ GridPlugin.prototype.getGridApi = function (coreRef) {
 */
 GridPlugin.prototype.getColumnName = function (colRef) {
 	if(this._compositeGrid) {
-		var colOptions = this._compositeGrid.getColumnModel(colRef);
+		let colOptions = this._compositeGrid.getColumnModel(colRef);
 		if(colOptions) {
 			if(colOptions.title) {
 				return colOptions.title;
@@ -227,8 +227,8 @@ GridPlugin.prototype.getColumnName = function (colRef) {
 			}
 		}
 	} else {
-		var colIndex = this.getColumnIndex(colRef);
-		var colDef = this._realTimeGrid.getColumnDefinition(colIndex);
+		let colIndex = this.getColumnIndex(colRef);
+		let colDef = this._realTimeGrid.getColumnDefinition(colIndex);
 		if(colDef) {
 			return colDef.getName();
 		}
@@ -245,8 +245,8 @@ GridPlugin.prototype.getColumnIndex = function (colRef) {
 		return colRef;
 	}
 	if(this._compositeGrid) {
-		var allFields = this._compositeGrid.getColumnFields();
-		var colIndex = allFields.indexOf(colRef);
+		let allFields = this._compositeGrid.getColumnFields();
+		let colIndex = allFields.indexOf(colRef);
 		if(colIndex > -1) {
 			return colIndex;
 		} else {
@@ -261,25 +261,25 @@ GridPlugin.prototype.getColumnIndex = function (colRef) {
 * @return {Array.<number>} column indices
 */
 GridPlugin.prototype.getColumnIndices = function (colRefs) {
-	var api = this.getGridApi();
+	let api = this.getGridApi();
 	if(api.getColumnIndices) {
 		return api.getColumnIndices(colRefs);
 	}
 
 	// TODO: Unify the below logics
 	if(this._compositeGrid) {
-		var allFields = this._compositeGrid.getColumnFields();
-		var columnCount = this._compositeGrid.getColumnCount();
-		var columnIndices = [];
-		var colRef;
-		for (var i = 0; i < colRefs.length; i++) {
+		let allFields = this._compositeGrid.getColumnFields();
+		let columnCount = this._compositeGrid.getColumnCount();
+		let columnIndices = [];
+		let colRef;
+		for (let i = 0; i < colRefs.length; i++) {
 			colRef = colRefs[i];
 			if(typeof colRef === 'number') { // When user pass index
 			  if(colRef >= 0 && colRef < columnCount) {
 			  	columnIndices.push(colRef);
 			  }
 			} else {
-				var columnIndex = allFields.indexOf(colRef); // Looping check column index of colRefs field
+				let columnIndex = allFields.indexOf(colRef); // Looping check column index of colRefs field
 				if(columnIndex !== -1) {
 					columnIndices.push(columnIndex);
 				}
@@ -300,7 +300,7 @@ GridPlugin.prototype.getColumnId = function (colIndex) {
 		return colIndex;
 	}
 
-	var colCount = this.getColumnCount();
+	let colCount = this.getColumnCount();
 	if(colIndex < 0 || colIndex >= colCount) { // Avoid creating undesired column definitions in Core Grid.
 		return "";
 	}
@@ -308,7 +308,7 @@ GridPlugin.prototype.getColumnId = function (colIndex) {
 	if(this._compositeGrid) {
 		return this._compositeGrid.getColumnId(colIndex);
 	} else {
-		var colDef = this._realTimeGrid.getColumnDefinition(colIndex);
+		let colDef = this._realTimeGrid.getColumnDefinition(colIndex);
 		if(colDef) {
 			return colDef.getId();
 		}
@@ -348,7 +348,7 @@ GridPlugin.prototype.getColumnFields = function () {
 */
 GridPlugin.prototype.getColumnCount = function() {
 	if(this._hosts) {
-		var g = this._hosts[0];
+		let g = this._hosts[0];
 		return g ? g.getColumnCount() : 0;
 	}
 	return 0;
@@ -360,11 +360,11 @@ GridPlugin.prototype.getColumnCount = function() {
 * @return {boolean}
 */
 GridPlugin.prototype._moveColumnById = function (srcCol, destCol) {
-	var hosts = this._hosts;
-	var len = hosts ? hosts.length : 0;
+	let hosts = this._hosts;
+	let len = hosts ? hosts.length : 0;
 	if(len) {
-		var dirty = 0;
-		for(var i = 0; i < len; ++i) {
+		let dirty = 0;
+		for(let i = 0; i < len; ++i) {
 			dirty |= hosts[i].moveColumnById(srcCol, destCol);
 		}
 		return dirty ? true : false;
@@ -378,11 +378,11 @@ GridPlugin.prototype._moveColumnById = function (srcCol, destCol) {
 * @return {boolean} Return true if there is any change, and false otherwise
 */
 GridPlugin.prototype._reorderColumns = function (colRefs, destCol) {
-	var hosts = this._hosts;
-	var len = hosts ? hosts.length : 0;
+	let hosts = this._hosts;
+	let len = hosts ? hosts.length : 0;
 	if(len) {
-		var dirty = 0;
-		for(var i = 0; i < len; ++i) {
+		let dirty = 0;
+		for(let i = 0; i < len; ++i) {
 			dirty |= hosts[i].reorderColumns(colRefs, destCol);
 		}
 		return dirty ? true : false;
@@ -434,9 +434,9 @@ GridPlugin.prototype._requestPlugin = function (host, pluginRef, configObj) {
 * @return {Promise}
 */
 GridPlugin.requestPlugin = function (ref, pluginRef, configObj, compositeGrid, realTimeGrid) {
-	var core = null;
+	let core = null;
 	if(ref) {
-		var gridWrapper = null;
+		let gridWrapper = null;
 		if(ref.nodeType === 1) { // This is an element
 			// TODO: Support delayed resolving
 			gridWrapper = ref.api; // Grid element must already be initialized and configured
@@ -461,11 +461,11 @@ GridPlugin.requestPlugin = function (ref, pluginRef, configObj, compositeGrid, r
 		return Promise.reject("Cannot find grid element");
 	}
 
-	var curPlugin = core.getPlugin(pluginRef);
+	let curPlugin = core.getPlugin(pluginRef);
 	if(curPlugin) {
 		return Promise.resolve(curPlugin);
 	} else {
-		var d = new Deferred();
+		let d = new Deferred();
 		setTimeout(GridPlugin._onPluginRequested.bind(null, {
 			grid: core,
 			pluginRef: pluginRef,
@@ -482,17 +482,17 @@ GridPlugin.requestPlugin = function (ref, pluginRef, configObj, compositeGrid, r
 * @return {Promise.<*>} Promise of plugin object
 */
 GridPlugin._onPluginRequested = function (ctx) {
-	var grid = ctx.grid;
+	let grid = ctx.grid;
 	if(!grid.getElement()) {
 		return ctx.deferred.reject("Grid has been disposed before the plugin is fully loaded: " + ctx.pluginRef);
 	}
 
-	var curPlugin = grid.getPlugin(ctx.pluginRef);
+	let curPlugin = grid.getPlugin(ctx.pluginRef);
 	if(curPlugin) {
 		return ctx.deferred.resolve(curPlugin);
 	}
 
-	var beforeInitPerformed = false;
+	let beforeInitPerformed = false;
 	if(ctx.pluginRef.beforeInit) { // WARNING: beforeInit is usually performed before the actual loading
 		beforeInitPerformed = true;
 		ctx.pluginRef.beforeInit(grid.getElement(), ctx.config, true);
@@ -552,7 +552,7 @@ GridPlugin.prototype._getColumnData = function(colIndex, grid) {
 * @return {*}
 */
 GridPlugin.prototype._getColumnOption = function(colIndex, prop, grid) {
-	var colData = this._getColumnData(colIndex, grid);
+	let colData = this._getColumnData(colIndex, grid);
 	if(colData) {
 		return colData[prop];
 	}
@@ -572,7 +572,7 @@ GridPlugin.prototype._newColumnData = function(colIndex, grid) {
 		return {};
 	}
 
-	var colData = grid.getColumnData(colIndex);
+	let colData = grid.getColumnData(colIndex);
 	if(!colData) {
 		colData = grid.setColumnData(colIndex, {});
 	}
@@ -584,7 +584,7 @@ GridPlugin.prototype._newColumnData = function(colIndex, grid) {
 * @return {string}
 */
 GridPlugin.prototype._getField = function(colIndex) {
-	var gridInst = this._compositeGrid || this._realTimeGrid;
+	let gridInst = this._compositeGrid || this._realTimeGrid;
 	if (gridInst) {
 		return gridInst.getColumnField(colIndex);
 	}
@@ -623,7 +623,7 @@ GridPlugin.prototype._getRow = function(dv, rowIndex) {
 * @return {*}
 */
 GridPlugin.prototype._getData = function(dv, rowIndex, field) {
-	var row = this._getRow(dv, rowIndex);
+	let row = this._getRow(dv, rowIndex);
 	return row ? row[field] : undefined; // eslint-disable-line
 };
 /** @protected
@@ -635,7 +635,7 @@ GridPlugin.prototype._getData = function(dv, rowIndex, field) {
 */
 GridPlugin.prototype._setData = function(dv, rowRef, field, val) {
 	if(this._realTimeGrid) {
-		var rowDef = _toRowDef(dv, rowRef);
+		let rowDef = _toRowDef(dv, rowRef);
 		if(rowDef) {
 			rowDef.setData(field, val);
 		}
@@ -655,7 +655,7 @@ GridPlugin.prototype._setData = function(dv, rowRef, field, val) {
 */
 GridPlugin.prototype._setRowData = function(dv, rowRef, rowData) {
 	if(this._realTimeGrid) {
-		var rowDef = _toRowDef(dv, rowRef);
+		let rowDef = _toRowDef(dv, rowRef);
 		if(rowDef) {
 			rowDef.setRowData(rowData);
 		}
@@ -676,7 +676,7 @@ GridPlugin.prototype._setRowData = function(dv, rowRef, rowData) {
 */
 GridPlugin.prototype._setStaticData = function(dv, rowRef, field, value) {
 	if(this._realTimeGrid) {
-		var rowDef = _toRowDef(dv, rowRef);
+		let rowDef = _toRowDef(dv, rowRef);
 		if(rowDef) {
 			rowDef.setStaticData(field, value);
 		}
@@ -702,8 +702,8 @@ GridPlugin.prototype._setColumnData = function (dv, cid, valueList, ridList) { /
 		return;
 	}
 
-	var rids = Array.isArray(ridList) ? ridList : dv.getAllRowIds(true);
-	var rowCount = rids ? rids.length : 0;
+	let rids = Array.isArray(ridList) ? ridList : dv.getAllRowIds(true);
+	let rowCount = rids ? rids.length : 0;
 	if(!rowCount) {
 		return;
 	}
@@ -716,13 +716,13 @@ GridPlugin.prototype._setColumnData = function (dv, cid, valueList, ridList) { /
 		);
 		return;
 	}
-	var vals = Array.isArray(valueList) ? valueList : rids.map(function() { return valueList; });
+	let vals = Array.isArray(valueList) ? valueList : rids.map(function() { return valueList; });
 
 	if(this._realTimeGrid) {
-		for(var i = 0; i < rowCount; ++i) {
-			var dvRowData = dv.getRowData(rids[i]);
+		for(let i = 0; i < rowCount; ++i) {
+			let dvRowData = dv.getRowData(rids[i]);
 			if(dvRowData) {
-				var rowDef = dvRowData["ROW_DEF"];
+				let rowDef = dvRowData["ROW_DEF"];
 
 				if(rowDef){
 					// WARNING: This does not trigger dataChanged and dataComposed on the DataCache
@@ -754,7 +754,7 @@ GridPlugin.prototype._activateColumnRenderer = function(colIndex, id, renderer)
 		return;
 	}
 
-	var rtGrid = this._realTimeGrid;
+	let rtGrid = this._realTimeGrid;
 	if (rtGrid) {
 		rtGrid.activateColumnRenderer(colIndex, id, renderer);
 	} else {
@@ -769,12 +769,12 @@ GridPlugin.prototype._activateColumnRenderer = function(colIndex, id, renderer)
 /** @private
 * @function
 */
-var _emptyFunc = function(){};
+let _emptyFunc = function(){};
 /** @private
 * @type {Object.<string, number>}
 * @constant
 */
-var KEY_MAP = {
+let KEY_MAP = {
 	"left": 37,
 	"right": 39,
 	"up": 38,
@@ -805,13 +805,13 @@ GridPlugin.prototype._mockMouseEvent = function(colIndex, rowIndex, context) {
 		rowIndex = 0;
 	}
 
-	var evt = context ? context : {};
+	let evt = context ? context : {};
 	evt.preventDefault = _emptyFunc;
 	evt.stopPropagation = _emptyFunc;
 
 	if (colIndex >= 0 && rowIndex >= 0) {
-		var grid = this._activeGrid || this._hosts[0];
-		var cell = grid ? grid.getCell(evt.sectionType || "content", colIndex, rowIndex) : null;
+		let grid = this._activeGrid || this._hosts[0];
+		let cell = grid ? grid.getCell(evt.sectionType || "content", colIndex, rowIndex) : null;
 		evt.target = cell ? cell.getElement() : null;
 	}
 
@@ -823,12 +823,12 @@ GridPlugin.prototype._mockMouseEvent = function(colIndex, rowIndex, context) {
 * @return {!Object}
 */
 GridPlugin.prototype._mockKeyboardEvent = function(keyCode, context) {
-	var evt = context ? context : {};
+	let evt = context ? context : {};
 	evt.preventDefault = _emptyFunc;
 	evt.stopPropagation = _emptyFunc;
 
 	if (typeof keyCode === "string") {
-		var predefinedCode = KEY_MAP[keyCode.toLowerCase()] || 0;
+		let predefinedCode = KEY_MAP[keyCode.toLowerCase()] || 0;
 		keyCode = predefinedCode ? predefinedCode : keyCode.charCodeAt(0);
 	}
 	evt.keyCode = keyCode;
@@ -851,8 +851,8 @@ GridPlugin._themeLoaders = {};
 * @param {Object} colors
 */
 GridPlugin._themeLoadSuccess = function(styleCalculator, colors) {
-	var extName = this.getName();
-	var styles = GridPlugin._staticStyles[extName] = styleCalculator(colors);
+	let extName = this.getName();
+	let styles = GridPlugin._staticStyles[extName] = styleCalculator(colors);
 	this.applyStyles(styles, extName);
 };
 
@@ -860,8 +860,8 @@ GridPlugin._themeLoadSuccess = function(styleCalculator, colors) {
 * @param {Function} styleCalculator
 */
 GridPlugin.prototype.applyStaticStyles = function(styleCalculator) {
-	var extName = this.getName();
-	var styles = GridPlugin._staticStyles[extName];
+	let extName = this.getName();
+	let styles = GridPlugin._staticStyles[extName];
 	if (!styles) {
 		if (styleCalculator) {
 			if (!GridPlugin._themeLoaders[extName]) {
@@ -885,15 +885,15 @@ GridPlugin.prototype.applyStyles = function(cssString, nameSpace, replaceable) {
 		nameSpace = this.getName();
 	}
 
-	var intNameSpace = "_style" + nameSpace;
+	let intNameSpace = "_style" + nameSpace;
 
-	var hosts = this._hosts;
-	var len = hosts.length;
+	let hosts = this._hosts;
+	let len = hosts.length;
 	if (!len) {
 		return;
 	}
 
-	var i, host;
+	let i, host;
 	if (!replaceable) {
 		for (i = 0; i < len; i++) {
 			host = hosts[i];
@@ -921,7 +921,7 @@ GridPlugin.prototype.revokeStyles = function(host, nameSpace) {
 	}
 
 	nameSpace = "_style" + nameSpace;
-	var styleTag = host[nameSpace];
+	let styleTag = host[nameSpace];
 	if (styleTag && styleTag.nodeType === 1) {
 		styleTag.parentNode.removeChild(styleTag);
 		host[nameSpace] = null;
@@ -940,17 +940,17 @@ GridPlugin.prototype.revokeStyles = function(host, nameSpace) {
 * console.log(tr.grid.SomePlugin); // tr.grid.SomePlugin is added to window scope
 * console.log(tr.SomeExtension); // tr.SomeExtension is added to window scope
 */
-var exportExtension = function(winObj, plugin) {
+let exportExtension = function(winObj, plugin) {
 	if(!winObj || !plugin) { return; }
 	if(!plugin.prototype["getName"]) { return; }
-	var pluginName = plugin.prototype["getName"]().replace(/Plugin$/, "");
+	let pluginName = plugin.prototype["getName"]().replace(/Plugin$/, "");
 	if(!pluginName) { return; }
 
-	var trNamespace = winObj["tr"]; // For supporting composite grid extension scheme
+	let trNamespace = winObj["tr"]; // For supporting composite grid extension scheme
 	if(!trNamespace) {
 		trNamespace = winObj["tr"] = {};
 	}
-	var gridNamespace = trNamespace["grid"]; // For supporting grid plugin scheme
+	let gridNamespace = trNamespace["grid"]; // For supporting grid plugin scheme
 	if(!gridNamespace) {
 		gridNamespace = trNamespace["grid"] = {};
 	}
@@ -965,8 +965,8 @@ var exportExtension = function(winObj, plugin) {
 * @param {number|string} rowRef Row index or row id
 * @return {*} RowDefinition instance
 */
-var _toRowDef = function(dv, rowRef) {
-	var dvRowData = (typeof rowRef === "number") ? dv.getRowDataAt(rowRef) : dv.getRowData(rowRef);
+let _toRowDef = function(dv, rowRef) {
+	let dvRowData = (typeof rowRef === "number") ? dv.getRowDataAt(rowRef) : dv.getRowData(rowRef);
 	if(dvRowData) {
 		return dvRowData["ROW_DEF"] || null;
 	}
@@ -979,7 +979,7 @@ var _toRowDef = function(dv, rowRef) {
 * @param {Object} dvRowData Row data from tr.DataView
 * @return {*} Data value returned from the specified row and field
 */
-var defaultDataGetter = function (field, dvRowData) {
+let defaultDataGetter = function (field, dvRowData) {
 	return dvRowData[field];
 };
 /** @public
@@ -988,8 +988,8 @@ var defaultDataGetter = function (field, dvRowData) {
 * @param {Object} dvRowData Row data from tr.DataView
 * @return {*} Data value returned from the specified row and field
 */
-var rowDefDataGetter = function (field, dvRowData) {
-	var rowData = dvRowData["ROW_DEF"].getRowData();
+let rowDefDataGetter = function (field, dvRowData) {
+	let rowData = dvRowData["ROW_DEF"].getRowData();
 	return (rowData) ? rowData[field] : null;
 };
 /** @public
@@ -997,7 +997,7 @@ var rowDefDataGetter = function (field, dvRowData) {
 * @param {Object} dvRowData
 * @return {Object} Row data Nothing is changed
 */
-var defaultRowGetter = function (dvRowData) {
+let defaultRowGetter = function (dvRowData) {
 	return dvRowData;
 };
 /** @public
@@ -1005,7 +1005,7 @@ var defaultRowGetter = function (dvRowData) {
 * @param {Object} dvRowData Row data from tr.DataView
 * @return {Object} Row data
 */
-var rowDefRowGetter = function (dvRowData) {
+let rowDefRowGetter = function (dvRowData) {
 	return dvRowData ? dvRowData["ROW_DEF"].getRowData() : null;
 };
 /** This is slower version of row getter. It is intended for ease of use.
@@ -1014,9 +1014,9 @@ var rowDefRowGetter = function (dvRowData) {
 * @param {Object} dvRowData Row data from tr.DataView
 * @return {Object} Row data
 */
-var rowGetter = function (dvRowData) {
+let rowGetter = function (dvRowData) {
 	if(dvRowData) {
-		var rowDef = dvRowData["ROW_DEF"];
+		let rowDef = dvRowData["ROW_DEF"];
 		return rowDef ? rowDef.getRowData() : dvRowData;
 	}
 	return null;
@@ -1028,11 +1028,11 @@ var rowGetter = function (dvRowData) {
 * @param {tr.DataTable} dt
 * @return {!Array.<Object>} Array of row data
 */
-var colDataGetter = function(field, dt) {
-	var rowDefs = dt.getAllRowData();
-	var rowCount = rowDefs.length;
-	var rows = new Array(rowCount);
-	for(var i = 0; i < rowCount; ++i) { // WARNING: No data checking
+let colDataGetter = function(field, dt) {
+	let rowDefs = dt.getAllRowData();
+	let rowCount = rowDefs.length;
+	let rows = new Array(rowCount);
+	for(let i = 0; i < rowCount; ++i) { // WARNING: No data checking
 		rows[i] = rowDefDataGetter(field, rowDefs[i]);
 	}
 	return rows;