@refinitiv-ui/efx-grid 6.0.106 → 6.0.107

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

@@ -259,7 +259,7 @@ FieldDefinition.setSynapseConfig = function (config) {
 * @param {boolean} disabled=true if disable it, time series will not be expand
 */
 FieldDefinition.disableTimeSeriesExpansion = function(disabled) {
-	FieldDefinition._timeSeriesExpansion = disabled != false ? false : true;
+	FieldDefinition._timeSeriesExpansion = disabled === false;
 };
 
 /** @public

package/lib/tr-grid-in-cell-editing/es6/InCellEditing.js

@@ -119,17 +119,18 @@ import { CoralItems } from "../../tr-grid-util/es6/CoralItems.js";
 * @property {Object} grid core grid instance
 * @property {number} rowIndex row index that editor placed.
 * @property {number} rowId row id, It's better to use row id as a reference to collect data.
-* @property {object} fieldValue object that contain text in each field
+* @property {Object} fieldValues Object that contains text in each field
+* @property {Object} fieldValue Alias to fieldValues
 * @property {boolean=} cancel Set to true to cancel the commit operation.
 * @example
 * let cep = new InCellEditingPlugin();
 * cep.listen("beforeRowCommit", function(e) {
-*		let fieldValue = e.fieldValue;
-*		for(let field in fieldValue) {
-*			if(!fieldValue.hasOwnProperty(field)) continue;
-*			let value = fieldValue[field];
+*		let fieldValues = e.fieldValues;
+*		for(let field in fieldValues) {
+*			if(!fieldValues.hasOwnProperty(field)) continue;
+*			let value = fieldValues[field];
 *			if(checkValid(value)) { // check value is valid
-*				fieldValue[field] = value + "foo bar"; // modify text
+*				fieldValues[field] = value + "foo bar"; // modify text
 *			} else {
 *				e.cancel = true; // if not valid maybe cancel commit
 *				break;
@@ -138,13 +139,30 @@ import { CoralItems } from "../../tr-grid-util/es6/CoralItems.js";
 * });
 */
 
+/** @event InCellEditingPlugin#rowEditorOpened
+* @description Fired after the opening of text editor in row editing mode
+* @type {Object}
+* @property {number} rowIndex
+* @property {string} rowId
+* @property {Object} grid Core grid instance
+* @property {Array.<string>} fields
+* @property {Array} cells Array of Cell instances
+* @property {Array.<Element>} inputs Array of input elements
+* @property {Array} initialValues Array of data retrieved from Grid corresponding to the cells/inputs
+* @property {Object} fieldValues Object that contains text in each field
+*/
 /** @event InCellEditingPlugin#rowEditorClosed
 * @description Fired after the text editor has been closed and all operations are done. This is useful to clean up left over resource and get result text entered.
 * @type {Object}
-* @property {number} rowIndex index of row
+* @property {number} rowIndex
+* @property {string} rowId
+* @property {Object} grid Core grid instance
+* @property {Array.<string>} fields
+* @property {Array} cells Array of Cell instances
+* @property {Array.<Element>} inputs Array of input elements
+* @property {Object} fieldValues Object that contains text in each field
+* @property {Object} fieldValue Alias to fieldValues
 * @property {boolean} committed Indicates whether the commit operation has been done or not.
-* @property {Object} grid grid instance
-* @property {Object} fieldValue object that contain text in each field
 */
 
 /** @event InCellEditingPlugin#keyUp
@@ -595,9 +613,19 @@ InCellEditingPlugin.prototype.initialize = function (host, options) {
 
 	this._hosts.push(host);
 
+	let elemMap = InCellEditingPlugin._uiElementTypesMap;
 	if(ElfUtil.getElfVersion() < 4) {
 		// ef-input available in elf version < 4
-		InCellEditingPlugin._uiElementTypesMap["number"] = "ef-input";
+		elemMap["number"] = "ef-input";
+	}
+	if(ElfUtil.getElfVersion() >= 6) {
+		elemMap["number"] = "ef-number-field";
+		elemMap["select"] = "ef-select";
+		elemMap["dropdown"] = "ef-select";
+		elemMap["date"] = "ef-datetime-picker";
+		elemMap["checkbox"] = "ef-checkbox";
+		elemMap["boolean"] = "ef-checkbox";
+		elemMap["combobox"] = "ef-combo-box";
 	}
 
 	if(ElfUtil.isHaloTheme()) {
@@ -732,6 +760,7 @@ InCellEditingPlugin.prototype.config = function(options) {
 	t.addListener(pluginOption, "beforeCommit");
 	t.addListener(pluginOption, "editorClosed");
 	t.addListener(pluginOption, "keyUp");
+	t.addListener(pluginOption, "rowEditorOpened");
 	t.addListener(pluginOption, "beforeRowCommit");
 	t.addListener(pluginOption, "rowEditorClosed");
 };
@@ -1536,14 +1565,16 @@ InCellEditingPlugin.prototype._openEditor = function (e, host, arg) {
 * @public
 * @param {number} rowIndex
 * @param {Object=} grid core grid object
+* @fires InCellEditingPlugin#rowEditorOpened
 */
 InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 	let t = this;
 	grid = grid || t._hosts[0];
-	// if open same row we will do nothing
-	if(t._getRowIndex(t._activeRowId) === rowIndex || !grid || t._readonly) { return; }
 
-	// close all open editor
+	if(t._getRowIndex(t._activeRowId) === rowIndex || !grid || t._readonly) {
+		return;
+	}
+
 	t.closeRowEditor(false, grid);
 	t._commitText(false);
 
@@ -1551,7 +1582,7 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 	let sectionType = "content";
 	let section = grid.getSection(sectionType);
 	let dataSource = grid.getDataSource();
-	let lastIndex = (section.getColumnCount() || 0) - 1;
+	let colCount = section.getColumnCount();
 	let isBottom = (rowIndex + 1) >= section.getRowCount();
 	let sectionBGColor = (this._elfVersion || t._inlineStyling) ? section.getComputedStyle().backgroundColor : null;
 	let rowH = section.getRowHeight(rowIndex);
@@ -1565,25 +1596,36 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 		parentElement = grid.getElement().parentElement;
 	}
 
-	// loop for all column
-	for(let columnIndex = 0; columnIndex <= lastIndex; columnIndex++) {
-		// ignore column that can't edit
-		if(!t.isColumnEditable(columnIndex)) { continue; }
-		let cell = section.getCell(columnIndex, rowIndex);
+	let arg = {
+		"rowIndex": rowIndex,
+		"rowId": "",
+		"grid": grid,
+		"fields": [],
+		"cells": [],
+		"inputs": [],
+		"initialValues": [],
+		"fieldValues": {}
+	};
+	for(let colIndex = 0; colIndex < colCount; colIndex++) {
+		if(!t.isColumnEditable(colIndex)) {
+			continue;
+		}
+		let cell = section.getCell(colIndex, rowIndex);
 		if(!cell || cell.hasClass("no-editing")) {
 			continue;
-		} // all verify is done
+		}
 
-		// create editor, popup, inputElement
-		let inCellCache = t._createContentEditor(columnIndex, grid);
+		arg["cells"][colIndex] = cell;
+		let field = t._getField(colIndex);
+		arg["fields"][colIndex] = field;
+
+		let inCellCache = t._createContentEditor(colIndex, grid);
+		inCellCache.field = field; // The field may be changed at runtime
 
-		let content = cell.getContent();
-		let field = t._getField(columnIndex);
-		let sourceContent = t._getSourceContent(dataSource, rowIndex, field, content, sectionType);
 		let inputElement = inCellCache["inputElement"];
-		let editor = inCellCache["editor"];
 		let balloonPopup = inCellCache["balloonPopup"];
 
+		arg["inputs"][colIndex] = inputElement;
 		if(!firstInput) {
 			firstInput = inputElement;
 			firstPopup = balloonPopup;
@@ -1592,6 +1634,10 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 			balloonPopup.enableUIBlocking(false);
 		}
 
+		let content = cell.getContent();
+		let sourceContent = t._getSourceContent(dataSource, rowIndex, field, content, sectionType);
+		arg["initialValues"][colIndex] = sourceContent;
+		arg["fieldValues"][field] = sourceContent;
 		t._setText(sourceContent, inputElement); // WARNING: value-changed event from ELF v3 component may be triggered due to their design flaw
 
 		if(isBottom) {
@@ -1600,15 +1646,15 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 			inputElement.classList.remove("bottom");
 		}
 
+		let editor = inCellCache["editor"];
 		let editorStyle = editor.style;
 		if(sectionBGColor) {
 			editorStyle.backgroundColor = sectionBGColor;
 		}
 		editorStyle.height = rowH + "px";
 
-		// this is different from single edit mode
-		// row edit mode not support balloon mode
-		let width = section.getCellWidth(columnIndex, rowIndex);
+		// row editing mode does not support balloon mode
+		let width = section.getCellWidth(colIndex, rowIndex);
 		editorStyle.width = width + "px";
 		editor.classList.remove("balloon");
 
@@ -1618,12 +1664,10 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 		balloonPopup.show(true, parentElement);
 
 		this._updateEditorPopup(inCellCache, cell, grid);
-
-		// this._updateEditorLayout(inputElement); // Adjust sizes after append to the DOM
 	}
 
-	// if firstInput not undefined that mean at lease one popup is open
 	if(firstInput) {
+		// At least one cell is valid for editing
 		firstPopup.addEventListener("hidden", t._onPopupHide);
 		t._lastActiveGrid = grid;
 		t._editing = true; // Editing state cannot be false until a text has been committed or cancelled
@@ -1633,6 +1677,9 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 		if(t._disablingScroll) {
 			t._freezeScrolling(grid, true);
 		}
+
+		arg["rowId"] = t._activeRowId;
+		t._dispatch("rowEditorOpened", arg);
 	}
 };
 
@@ -1645,7 +1692,6 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 InCellEditingPlugin.prototype.closeRowEditor = function (isCommit) {
 	let t = this;
 	let grid = t._lastActiveGrid;
-	// if no row active then do nothing
 	if(!t._activeRowId || !grid) { return; }
 
 	let rowId = t._activeRowId;
@@ -1657,81 +1703,74 @@ InCellEditingPlugin.prototype.closeRowEditor = function (isCommit) {
 	}
 
 	let section = grid.getSection("content");
-	let columnLength = grid.getColumnCount();
-	let fieldValue = {};
+	let colCount = grid.getColumnCount();
+	let fieldValues = {};
 	let inCellCaches = [];
 	let inCellCache;
+	let arg = {
+		"rowIndex": rowIndex,
+		"rowId": t._activeRowId,
+		"grid": grid,
+		"fields": [],
+		"cells": [],
+		"inputs": [],
+		// "initialValues": [],
+		"fieldValues": fieldValues,
+		"fieldValue": fieldValues, // Add alias for backward compatability
+		"cancel": false
+	};
 
-	// in this section we just prepare data
-	for(let columnIndex = 0; columnIndex < columnLength; columnIndex++) {
-		let columnData = t._getColumnData(columnIndex, grid);
+	for(let colIndex = 0; colIndex < colCount; colIndex++) {
+		let columnData = t._getColumnData(colIndex, grid);
 		inCellCache = columnData && columnData["inCellCache"];
 
-		// if not have inCellCache then this column not have editor
-		if(!inCellCache) { continue; }
+		if(inCellCache) {
+			inCellCache.columnIndex = colIndex;
+			inCellCaches.push(inCellCache);
 
-		inCellCache.columnIndex = columnIndex;
-		inCellCaches.push(inCellCache);
+			arg["fields"][colIndex] = inCellCache.field;
+			arg["cells"][colIndex] = section.getCell(colIndex, rowIndex);
+			arg["inputs"][colIndex] = inCellCache["inputElement"];
 
-		if(isCommit) {
-			let field = t._getField(columnIndex);
-			inCellCache.field = field;
-			fieldValue[field] = this._getValue(inCellCache["inputElement"]);
+			if(isCommit) {
+				fieldValues[inCellCache.field] = this._getValue(inCellCache["inputElement"]);
+			}
 		}
 	}
 
-	let length = inCellCaches.length;
-	let i, e;
-
-	// dispatch event beforeRowCommit
 	if(isCommit) {
-		if(t.hasListener("beforeRowCommit")) {
-			e = {
-				grid: grid,
-				rowIndex: rowIndex,
-				fieldValue: fieldValue,
-				cancel: false,
-				rowId: t._activeRowId
-			};
-			t._dispatch("beforeRowCommit", e);
-			// e.cancel = true mean user want to cancel closeRowEditor operation
-			isCommit = !e.cancel;
-		}
+		t._dispatch("beforeRowCommit", arg);
+		// arg.cancel = true mean user want to cancel closeRowEditor operation
+		isCommit = !arg.cancel;
+	}
 
-		if(isCommit) {
-			let dataSource = grid.getDataSource();
-			for(i = 0; i < length; i++) {
-				inCellCache = inCellCaches[i];
-				let value = fieldValue[inCellCache.field];
-				// set data to datasource
-				if(dataSource) {
-					// only use value from fieldValue
-					// because fieldValue maybe mutate from beforeRowCommit event
-					t._setData(dataSource, rowIndex, inCellCache.field, value);
-				}
+	let i;
+	let editorCount = inCellCaches.length;
+	if(isCommit) {
+		let dataSource = grid.getDataSource();
+		for(i = 0; i < editorCount; i++) {
+			inCellCache = inCellCaches[i];
+			let value = fieldValues[inCellCache.field];
+			// set data to datasource
+			if(dataSource) {
+				// Only use value from fieldValues because fieldValues maybe mutate from beforeRowCommit event
+				t._setData(dataSource, rowIndex, inCellCache.field, value);
+			}
 
-				// set value to ui if content is a build in text
-				let cell = section.getCell(inCellCache.columnIndex, rowIndex);
-				let content = cell.getContent();
-				if(content && content.classList.contains("text")) {
-					cell.setContent(value);
-				}
+			// set value to ui if content is a build in text
+			let cell = arg["cells"][inCellCache.columnIndex];
+			let content = cell.getContent();
+			if(content && content.classList.contains("text")) {
+				cell.setContent(value);
 			}
 		}
 	}
 
-	if(t.hasListener("rowEditorClosed")) {
-		e = {
-			grid: grid,
-			rowIndex: rowIndex,
-			fieldValue: fieldValue,
-			committed: isCommit
-		};
-		t._dispatch("rowEditorClosed", e);
-	}
+	arg["committed"] = isCommit;
+	t._dispatch("rowEditorClosed", arg);
 
 	// hide editor by remove popup from dom
-	for(i = 0; i < length; i++) {
+	for(i = 0; i < editorCount; i++) {
 		let popup = inCellCaches[i].balloonPopup;
 		popup.removeEventListener("hidden", t._onPopupHide); // remove event every popup to make sure nothing left
 		popup.hide();

package/lib/tr-grid-row-filtering/es6/RowFiltering.d.ts

@@ -26,6 +26,7 @@ declare namespace RowFilteringPlugin {
     type FilterDialogOptions = {
         sortUI?: boolean|null,
         filterUI?: boolean|null,
+        advancedFilter?: boolean|null,
         fieldDataType?: string|null,
         lang?: string|null,
         rawDataAccessor?: ((...params: any[]) => any)|null,
@@ -33,6 +34,7 @@ declare namespace RowFilteringPlugin {
         sortLogic?: ((...params: any[]) => any)|null,
         itemList?: any[]|null,
         additionalItems?: any[]|null,
+        compactMode?: boolean|null,
         blankValues?: (boolean|string)|null
     };
 

package/lib/tr-grid-row-filtering/es6/RowFiltering.js

@@ -80,6 +80,7 @@ The expression can take various forms:<br>
 * @description Options that specify UIs of filter dialog
 * @property {boolean=} sortUI=true show/hide sort UI
 * @property {boolean=} filterUI=true show/hide filter UI
+* @property {boolean=} advancedFilter=true show advaced filter tab
 * @property {string=} fieldDataType data type of column
 * @property {string=} lang dialog language
 * @property {Function=} rawDataAccessor In case you have custom data type for the specified field, data getter is needed to retrieve raw value for filtering
@@ -87,6 +88,7 @@ The expression can take various forms:<br>
 * @property {Function=} sortLogic This function for sorting filter item list in the dialog. The comparison will perform on raw values, and not formatted values
 * @property {Array=} itemList Item list to be shown in the dialog. If this is not specified, the list will be collected from existing data on the grid
 * @property {Array=} additionalItems Additional items to be put on the itemList
+* @property {boolean=} compactMode=false force compact mode in dialog
 * @property {(boolean|string)=} blankValues Display a "(Blanks)" item in the filter dialog to represent an empty value. If a string is passed, it will be used as the label for the blank item
 */
 
@@ -1813,6 +1815,8 @@ RowFilteringPlugin.prototype.openDialog = function(colIndex, runtimeDialogOption
 	let dialogConfig = { // default config
 		sortUI: true,
 		filterUI: true,
+		advancedFilter: true,
+		compactMode: false,
 		fieldDataType: "",
 		lang: "",
 		rawDataAccessor: null,
@@ -1974,6 +1978,16 @@ RowFilteringPlugin._overrideConfig = function(config, userConfig) {
 		config.filterUI = filterUI;
 	}
 
+	let advancedFilter = userConfig["advancedFilter"];
+	if (advancedFilter != null) {
+	  config.advancedFilter = advancedFilter;
+	}
+
+	let compactMode = userConfig["compactMode"];
+	if (compactMode != null) {
+	  config.compactMode = compactMode;
+	}
+
 	let fieldDataType = userConfig["fieldDataType"];
 	if(fieldDataType != null) {
 		config.fieldDataType = fieldDataType;

package/lib/types/es6/SimpleTickerFormatter.d.ts

@@ -19,7 +19,5 @@ declare class SimpleTickerFormatter {
 
 }
 
-declare function onContextCreated(): void;
-
 export default SimpleTickerFormatter;
 export { SimpleTickerFormatter };

package/lib/versions.json

@@ -19,12 +19,12 @@
 	"tr-grid-contextmenu": "1.0.41",
 	"tr-grid-filter-input": "0.9.39",
 	"tr-grid-heat-map": "1.0.29",
-	"tr-grid-in-cell-editing": "1.0.86",
+	"tr-grid-in-cell-editing": "1.0.87",
 	"tr-grid-pagination": "1.0.24",
 	"tr-grid-percent-bar": "1.0.24",
 	"tr-grid-range-bar": "2.0.8",
 	"tr-grid-row-dragging": "1.0.35",
-	"tr-grid-row-filtering": "1.0.76",
+	"tr-grid-row-filtering": "1.0.77",
 	"tr-grid-row-grouping": "1.0.88",
 	"tr-grid-row-selection": "1.0.30",
 	"tr-grid-rowcoloring": "1.0.25",
@@ -32,6 +32,6 @@
 	"tr-grid-titlewrap": "1.0.22",
 	"@grid/formatters": "1.0.53",
 	"@grid/column-selection-dialog": "4.0.57",
-	"@grid/filter-dialog": "4.0.64",
+	"@grid/filter-dialog": "4.0.65",
 	"@grid/column-format-dialog": "4.0.45"
 }

package/package.json

@@ -67,5 +67,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.106"
+	"version": "6.0.107"
 }