@refinitiv-ui/efx-grid 6.0.3 → 6.0.4

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

@@ -13,10 +13,10 @@ import SnapshotFiller from "./SnapshotFiller.js";
 import StyleLoader from "./StyleLoader.js";
 import FieldDefinition from "./FieldDefinition.js";
 import DataConnector from "./DataConnector.js";
+import RowDefSorter from "./RowDefSorter.js";
 
 import { Core } from "../../core/es6/grid/Core.js";
 import { SortableTitlePlugin } from "../../core/es6/grid/plugins/SortableTitlePlugin.js";
-import { DragAndDropTitlePlugin } from "../../core/es6/grid/plugins/DragAndDropTitlePlugin.js";
 import { DataCache } from "../../core/es6/data/DataCache.js";
 import { DataTable } from "../../core/es6/data/DataTable.js";
 import { DataView } from "../../core/es6/data/DataView.js";
@@ -71,9 +71,11 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {number=} dataConflationRate=0 set delay for data to avoid to much sorting operation when data changed
 * @property {Function=} dataComposed Handler for dataComposed event
 * @property {boolean=} autoDateConversion=false If enabled, date-time field with numeric value will be automatically converted to native date object.
-* @property {boolean=} textSelect=false If enabled, user can select text
+* @property {boolean=} textSelect=false If enabled, user can select content text by using mouse drag.
 * @property {string=} lang laguage for config localization date time, if null the default language is "en"
 * @property {Element=} scrollbarParent=null Element to be attached by grid's scrollbars, allowing them to move outside and avoid overlapping with the content.
+* @property {boolean=} formulaEngine=false If enabled, field with leading equal sign will be treated as a formula and rows will be filled with the calculated values.
+* @property {number=} adcPollingInterval=0 Length of polling interval for refreshing ADC data in milliseconds. The default value (0) means no polling.
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference
@@ -259,6 +261,7 @@ var Grid = function(placeholder, config) {
 	t._onFieldLoadedError = t._onFieldLoadedError.bind(t);
 
 	t._snapshotFillerDataChanged = t._snapshotFillerDataChanged.bind(t);
+	t._onPollingInterval = t._onPollingInterval.bind(t);
 
 	t._streamingConflator = new Conflator(50, t._updateStreamingData);
 	t._formulaConflator = new Conflator(300, t._onFormulaDataChanged);
@@ -272,6 +275,12 @@ var Grid = function(placeholder, config) {
 	t._grid = new Core();
 	t._grid._wrapper = this; // For back referencing
 
+	t._sorter = new RowDefSorter();
+	t._sorter.setContext("grid", this);
+	t._sorter.setContext("core", t._grid); // TODO: Handle multiple core grids
+
+	t._dateTimeUtil = DateTime;
+
 	t._grid.listen("columnAdded", t._onColumnAdded); // Columns could be added by some plugins
 
 	if(config) {
@@ -283,20 +292,15 @@ var Grid = function(placeholder, config) {
 
 			var core = t._mainGrid.getCoreGrid();
 			t._stp = core.getPlugin("SortableTitlePlugin");
-			t._dtp = core.getPlugin("DragAndDropTitlePlugin");
 		}
 		if(config["SortableTitle"]) { // Exception for built-in plugin
 			t._stp = config["SortableTitle"];
 		}
-		if(config["DragAndDropTitle"]) { // Exception for built-in plugin
-			t._dtp = config["DragAndDropTitle"];
-		}
 	}
 	if(!t._sharedDataSource) {
 		t._dc = new DataCache();
 		t._dc.listen("dataChanged", t._onDataChanged);
 		t._dc.listen("dataComposed", t._onDataComposed);
-		t._dc.listen("dataComposed", t._recalculateFormulas); // This will be called after _onDataComposed
 
 		t._dt = new DataTable();
 		t._dt.setSortingLogic(/** @type{Function} */(t._mainSorter));
@@ -307,7 +311,7 @@ var Grid = function(placeholder, config) {
 	t._grid.setDataSource(t._dv); // Avoid triggering sorting
 
 	if(t._stp) {
-		this._sharedSorter = true;
+		t._sharedSorter = true;
 		t._stp.listen("preDataSorting", t._onPreDataSorting);
 		t._grid.loadPlugin(t._stp); // The plugin instance is shared and don't need to be reconfigured.
 	} else { // Create built-in plugin
@@ -324,10 +328,6 @@ var Grid = function(placeholder, config) {
 		// beforeInit is not called.
 		t._grid.loadPlugin(t._stp, config);
 	}
-	if(!t._dtp) { // Create built-in plugin
-		t._dtp = new DragAndDropTitlePlugin();
-	}
-	t._grid.loadPlugin(t._dtp);
 
 	t._grid.listen("preSectionRender", t._onColumnHeaderBinding);
 	t._grid.listen("postSectionDataBinding", t._onPostSectionDataBinding);
@@ -347,10 +347,6 @@ var Grid = function(placeholder, config) {
 	t._connector.addEventListener("fieldAdded", t._onFieldAdded.bind(t));
 	t._connector.addEventListener("fieldRemoved", t._onFieldRemoved.bind(t));
 
-	t._fnEngine = new Engine();
-	t._fnEngine.addEventListener("dataChanged", t._onFormulaDataChanged);
-	t._fnEngine.addEventListener("dataRequired", t._onFormulaDataRequired);
-
 	t.initialize(config);
 	t.initSubscription();
 
@@ -404,10 +400,6 @@ Grid.prototype._subs = null;
  * @private
  */
 Grid.prototype._stp = null;
-/** @type {DragAndDropTitlePlugin}
-* @private
-*/
-Grid.prototype._dtp = null;
 /** @type {Function}
  * @private
  */
@@ -425,6 +417,10 @@ Grid.prototype._snapshot = null;
 * @type {DataConnector}
 */
 Grid.prototype._connector = null;
+/** @private
+* @type {RowDefSorter}
+*/
+Grid.prototype._sorter = null;
 
 /** @private
 * @type {Engine}
@@ -444,10 +440,6 @@ Grid.prototype._chainMembers = null;
 */
 Grid.prototype._chainConflator = null;
 /** @private
-* @type {boolean}
-*/
-Grid.prototype._hasGroup = false;
-/** @private
 * @type {number}
 */
 Grid.prototype._clientWidth = NaN;
@@ -476,15 +468,34 @@ Grid.prototype._autoDateConversion = false;
 * @type {boolean}
 */
 Grid.prototype._textSelect = false;
-/** @private
-* @type {string}
+/** @type {string}
+* @private
 */
 Grid.prototype._lang = null;
-/**
+/** @type {Object}
+* @private
+*/
+Grid.prototype._dateTimeUtil = null;
+/** @type {boolean}
 * @private
-* @type {boolean}
 */
 Grid.prototype._initializing = false;
+/** @type {number}
+* @private
+*/
+Grid.prototype._pollingInterval = 0;
+/** @type {number}
+* @private
+*/
+Grid.prototype._pollingTimerId = 0;
+/** @type {number}
+* @private
+*/
+Grid.prototype._lastPollingRequest = 0;
+/** @type {boolean}
+* @private
+*/
+Grid.prototype._pollingEnabled = true;
 
 
 /** @public
@@ -495,8 +506,13 @@ Grid.prototype.dispose = function() {
 		clearInterval(this._autoLayoutTimer);
 		this._autoLayoutTimer = 0;
 	}
+	if(this._pollingTimerId) {
+		clearTimeout(this._pollingTimerId);
+		this._pollingTimerId = 0;
+	}
 	this.removeAllColumns(); // Some conflators are reset
 	this.removeAllRows(); // Some conflators are reset
+	this._sorter.dispose();
 	this._grid.dispose();
 	this._connector.reset();
 
@@ -722,6 +738,12 @@ Grid.prototype.initialize = function(gridOption) {
 		StyleLoader.chainIcon = gridOption["icons"]["rowGrouping"]["expander"];
 	}
 
+	if(gridOption["formulaEngine"]) {
+		t._fnEngine = new Engine();
+		t._fnEngine.addEventListener("dataChanged", t._onFormulaDataChanged);
+		t._fnEngine.addEventListener("dataRequired", t._onFormulaDataRequired);
+	}
+
 	var borders = gridOption["borders"];
 	if (borders != null) {
 		grid.toggleBorders(borders);
@@ -752,14 +774,6 @@ Grid.prototype.initialize = function(gridOption) {
 		grid.getSection("title").setDefaultRowHeight(hRowHeight);
 	}
 
-	var noColumnDragging = gridOption["noColumnDragging"];
-	if (noColumnDragging == null && gridOption["columnReorder"] != null) {
-		noColumnDragging = !gridOption["columnReorder"];
-	}
-	if (noColumnDragging) {
-		t._dtp.disable();
-	}
-
 	var val = gridOption["autoLayoutUpdate"];
 	if(!t._autoLayoutTimer && val) {
 		if(val !== "0" && val !== "false") { // HACK: Temporarily support incorrect data type
@@ -799,6 +813,10 @@ Grid.prototype.initialize = function(gridOption) {
 	if(gridOption["scrollbarParent"] != null) {
 		t._setScrollbarParent(gridOption["scrollbarParent"]);
 	}
+	var pollingInterval = gridOption["adcPollingInterval"];
+	if(pollingInterval != null) {
+		t._pollingInterval = pollingInterval ? +pollingInterval : 0;
+	}
 
 	// Column operations
 	t.setColumns(cols);
@@ -873,7 +891,7 @@ Grid.prototype.initialize = function(gridOption) {
 	var lang = gridOption["lang"];
 	if(lang != null) {
 		t._lang = lang;
-		DateTime.setLocale(lang);
+		t._dateTimeUtil.setLocale(lang);
 	}
 
 	// Row operations
@@ -1013,13 +1031,19 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 		obj["autoDateConversion"] = true;
 	}
 
-	if (this._textSelect) {
+	if(this._textSelect) {
 		obj["textSelect"] = true;
 	}
 
-	if (this._lang) {
+	if(this._lang) {
 		obj["lang"] = this._lang;
 	}
+	if(this._fnEngine) {
+		obj["formulaEngine"] = true;
+	}
+	if(this._pollingInterval) {
+		obj["adcPollingInterval"] = this._pollingInterval;
+	}
 
 	// get all rows config
 	var rowDefs = this.getAllRowDefinitions();
@@ -1055,7 +1079,6 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	}
 
 	// TODO: The following states need to be retrieved
-	// noColumnDragging
 	// rowHighlighting
 	// columnVirtualization
 	// topFreezingCount, bottomFreezingCount
@@ -1066,6 +1089,27 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	return obj;
 };
 
+/** @public
+* @ignore
+* @param {Object} dateTimeUtil
+*/
+Grid.prototype.setDateTimeUtil = function(dateTimeUtil) {
+	if(this._dateTimeUtil !== dateTimeUtil) {
+		this._dateTimeUtil = dateTimeUtil;
+		this._dateTimeUtil.setLocale(this._lang);
+	}
+};
+/** @public
+* @param {string} lang
+*/
+Grid.prototype.setLocale = function(lang) {
+	if(lang && this._lang !== lang) {
+		this._lang = lang;
+		this._dateTimeUtil.setLocale(lang);
+		this._grid.requestRowRefresh();
+	}
+};
+
 /** @private
 * @param {Object} defaultCol
 * @param {Array.<Object>} userColumns
@@ -1171,10 +1215,6 @@ Grid.prototype._onFieldRemoved = function(e) {
 * @param {number=} idx
 */
 Grid.prototype.insertColumn = function (columnOption, idx) {
-	if (typeof columnOption === "string") {
-		columnOption = { field: columnOption };
-	}
-
 	var colCount = this.getColumnCount();
 	if(idx == null || idx > colCount) {
 		idx = colCount;
@@ -1182,16 +1222,26 @@ Grid.prototype.insertColumn = function (columnOption, idx) {
 
 	// no need to merge defaultColumn during initialize process
 	// because columnOption already mutate by initialize function
-	var userOptions = (this._initializing) ? {} : cloneObject(this._defaultColumnOptions);
-	Grid._objectAssign(userOptions, columnOption);
-	userOptions["formulaEngine"] = this._fnEngine; // Adding extra option
+	var configObj = (this._initializing) ? {} : cloneObject(this._defaultColumnOptions);
+
+	if (typeof columnOption === "string") {
+		configObj["field"] = columnOption;
+	} else { // columnOption is assumed to be an object
+		for (var key in columnOption) {
+			configObj[key] = columnOption[key];
+		}
+	}
+
+	if(this._fnEngine) {
+		configObj["formulaEngine"] = this._fnEngine; // Adding extra option
+	}
 
-	var colDef = new ColumnDefinition(userOptions, this);
-	userOptions[COL_DEF] = colDef;
+	var colDef = new ColumnDefinition(configObj, this);
+	configObj[COL_DEF] = colDef;
 
 	// WARNING: width is processed twice by tr-grid and rt-grid
 	// Inserting column also initializes prefined formatter
-	this._grid.insertColumn(idx, userOptions); // columnAdded is fired
+	this._grid.insertColumn(idx, configObj); // columnAdded is fired
 };
 
 
@@ -1659,6 +1709,11 @@ Grid.prototype.removeDataFields = function(fieldRef, referrer) {
 * @param {string=} opt_order This can be "ascending", "descending", "none", "noOrder", or "originalOrder"
 */
 Grid.prototype.sortColumn = function(colRef, opt_order) {
+	if(typeof colRef === "string") {
+		this._stp.sortColumn(colRef, opt_order); // Allow sorting by field
+		return;
+	}
+
 	var colIndex = this.getColumnIndex(colRef);
 	if(colIndex < 0) {
 		this._stp.sortColumn(this.getSortedColumnIndex(), "n"); // reset current sorting
@@ -1759,9 +1814,9 @@ Grid.prototype.setColumnSorter = function(colRef, func) {
 	if(colDef) {
 		colDef.setSorter(func);
 
-		var sortedColumn = this.getSortedColumnIndex();
+		var sortedColumn = this.getSortedColumnIndex(); // TODO: Support multi-column sorting
 		if(sortedColumn === colIndex) {
-			this._columnSorter = colDef.getSorter();
+			this._stp.refresh();
 		}
 	}
 };
@@ -1803,9 +1858,6 @@ Grid.prototype.insertRow = function(rowOption, rowRef) {
 	var rowDef = new RowDefinition(rowOption);
 	rowDef.setDataSource(this._dc); // This could also subscribe chain index/ric to JET/RTK
 	this._initDuplicateRicData(rowDef);
-	if(rowDef.isFixedPosition()) {
-		this._hasGroup = true; // HACK: This is temporary solution
-	}
 
 	rowDef.registerToView(this._dv, this._getRowId(rowRef));
 	if(rowOption && rowOption["hidden"]) {
@@ -1850,7 +1902,6 @@ Grid.prototype.insertRows = function(rowOptions, rowRef, opt_fields) {
 		}
 		this.insertRow(rowOption, rowId); // Note that data view is being frozen, so only using row id will work properly
 	}
-	this._updateGroupOrder(); // TODO: Update group order for all scenarios
 	this._dt.freeze(prevState);
 };
 /** Add multiple rows without `ric` property in {@link RowDefinition}
@@ -2623,7 +2674,7 @@ Grid.prototype.updateColumnTitle = function() {
 * @return {boolean}
 */
 Grid.prototype.isSorting = function() {
-	return this.getSortedColumnIndex() >= 0;
+	return this._stp.isSorting();
 };
 /** @public
 * @return {number}
@@ -2640,7 +2691,7 @@ Grid.prototype.getSortOrder = function() {
 /** @public
 */
 Grid.prototype.clearSort = function() {
-	this._stp.clearSortState();
+	this._stp.clearSortState(); // WARNING: No event is dispatched
 };
 
 /** @private
@@ -2738,43 +2789,38 @@ Grid.prototype._updateStreamingData = function() {
 		this._dt.dispatchGlobalChange();
 	}
 };
+
 /** @private
+* @param {Object} e
 */
-Grid.prototype._updateGroupOrder = function() {
-	if(!this._hasGroup) { return; }
-	// TODO: Perform re-indexing of the data table, so that both data table and data view has the same index
-	// if(this.isSorting()) {
-	// this._dt.sortOnce(ROW_DEF, this.getSortOrder());
-	// }
-	var rowCount = this._dt.getRowCount();
-	var groupOrder = 0;
-	var dirty = 0;
-	var prevParent = null;
-	var prevFixedState = false;
-	for(var i = 0; i < rowCount; ++i) {
-		var rowDef = this._dt.getDataAt(i, ROW_DEF);
-		var curParent = rowDef.getParent();
-		var curFixedState = rowDef.isFixedPosition();
-		if(curFixedState || curFixedState !== prevFixedState || curParent !== prevParent) {
-			++groupOrder;
+Grid.prototype._onPreDataSorting = function (e) {
+	var field = "";
+	var rowSorting = false;
+	var sortLogic = null;
+
+	var states = this._stp.getSortingStates(); // WARNING: Use of deprecated function
+	var state = states ? states[0] : null; // TODO: Support multi-column sorting
+
+	if(state) {
+		field = state["field"] || "";
+		var colIndex = this._stp.getSortedColumnIndex(0);
+		var colDef = (colIndex >= 0) ? this.getColumnDefinition(colIndex) : null;
+		this._sorter.setContext("colIndex", colIndex);
+		this._sorter.setContext("colDef", colDef);
+
+		if(colDef) {
+			field = colDef.getField(); // WARNING: Field and logic could be out of sync
+			sortLogic = colDef.getSorter();
+			rowSorting = colDef.isRowSorting();
 		}
-		prevParent = curParent;
-		prevFixedState = curFixedState;
-		dirty |= rowDef.setGroupOrder(groupOrder);
 	}
-	if(dirty && this.isSorting()){
-		this._stp.refresh();
+	if(!sortLogic && field) {
+		sortLogic = state["sortLogic"];
 	}
-};
 
-/** @private
-* @param {Object} e
-*/
-Grid.prototype._onPreDataSorting = function (e) {
-	// TODO: Support multi-column sorting
-	var colIndex = this._stp.getSortedColumnIndex();
-	var colDef = (colIndex >= 0) ? this.getColumnDefinition(colIndex) : null;
-	this._columnSorter = (colDef) ? colDef._prepareSortContext(colIndex) : null;
+	this._sorter.setField(field);
+	this._sorter.setSortLogic(sortLogic);
+	this._columnSorter = this._sorter.getSorter(rowSorting);
 };
 /** @private
 * @param {RowDefinition} rowDefA
@@ -2934,6 +2980,9 @@ Grid.prototype._onDataComposed = function(e) {
 	if(!rowDef) {
 		return;
 	}
+	if(!rowDef.getDataSource()) {
+		return; // Somehow, rowDef is invalid and doesn't have data source
+	}
 
 	if(this._autoDateConversion) { // auto data conversion
 		var field, value, dataType, colDef;
@@ -2959,13 +3008,17 @@ Grid.prototype._onDataComposed = function(e) {
 		e["rowDef"] = rowDef;
 		this._dispatch("dataComposed", e);
 	}
+
+	this._recalculateFormulas(e);
 };
 
 /** @private
 * @param {Object=} e
 */
 Grid.prototype._recalculateFormulas = function(e) {
-	if(this._fnEngine.getFormulaCount() <= 0) { return; }
+	if(!this._fnEngine || this._fnEngine.getFormulaCount() <= 0) {
+		return;
+	}
 
 	if(e && e["rid"]) {
 		this._fnEngine.calculate(/** @type{Object.<string, *>} */ (e["rowData"]), /** @type{Object.<string, *>} */ (e["changes"]));
@@ -2989,6 +3042,64 @@ Grid.prototype._snapshotFillerDataChanged = function (e) {
 	for (var ric in data) {
 		this.setRicData(ric, data[ric]);
 	}
+	if(!this._lastPollingRequest) { // This is the first time we receive successful ADC response
+		this._lastPollingRequest = 1; // Allow polling to be started
+	}
+	this._startPolling();
+};
+/** @private
+*/
+Grid.prototype._startPolling = function () {
+	if(this._pollingEnabled && this._pollingInterval) {
+		if(this._lastPollingRequest && !this._pollingTimerId) {
+			var now = new Date();
+			this._lastPollingRequest = now.getTime();
+			this._pollingTimerId = setTimeout(this._onPollingInterval, this._pollingInterval);
+		}
+	}
+};
+/** @private
+*/
+Grid.prototype._onPollingInterval = function () {
+	this._pollingTimerId = 0;
+	if(this._pollingEnabled && this._pollingInterval) {
+		this.refreshADCData();
+		this._startPolling();
+	}
+};
+/** @public
+* @param {boolean=} activated=true
+*/
+Grid.prototype.activateADCPolling = function (activated) {
+	if(activated !== false) {
+		this._pollingEnabled = true;
+		// Make immediate request after re-activation if it has been a long time
+		var now = new Date();
+		if(this._lastPollingRequest) {
+			var diff = now.getTime() - this._lastPollingRequest;
+			if(diff > this._pollingInterval) {
+				this.refreshADCData();
+			}
+		}
+		this._startPolling();
+	} else {
+		this._pollingEnabled = false;
+	}
+};
+/** Force re-requesting ADC data to immediately update the data
+* @public
+* @return {boolean} Return true, if a request has been made
+*/
+Grid.prototype.refreshADCData = function () {
+	var dirty = this._snapshot.addFields(this._connector.getAllFields());
+	if(dirty) {
+		dirty = this._snapshot.addRics(this._connector.getAllRics());
+		if(dirty) {
+			return true;
+		}
+	}
+	this._lastPollingRequest = 0; // No ADC field or RIC detected. Prevent polling from continuing
+	return false;
 };
 
 /** @private
@@ -3047,16 +3158,5 @@ Grid.prototype._logData = function(rowDefs, options) {
 	console.table(tbl); // eslint-disable-line
 };
 
-/** @private
- * @function
- * @param {Object} to
- * @param {Object} from
- */
-Grid._objectAssign = function (to, from) {
-	for (var key in from) {
-		to[key] = from[key];
-	}
-};
-
 export { Grid };
 export default Grid;

package/lib/rt-grid/es6/RowDefSorter.d.ts

@@ -0,0 +1,19 @@
+
+
+declare class RowDefSorter {
+
+    constructor();
+
+    public dispose(): void;
+
+    public getSorter(rowSorting?: boolean): ((...params: any[]) => any)|null;
+
+    public setSortLogic(func?: ((...params: any[]) => any)): void;
+
+    public setField(field: string): void;
+
+    public setContext(key: string, value: any): void;
+
+}
+
+export default RowDefSorter;