@refinitiv-ui/efx-grid 6.0.0-next.0

package/lib/tr-grid-filter-input/es6/index.d.ts

@@ -0,0 +1 @@
+export * from "./FilterInput";

package/lib/tr-grid-filter-input/es6/index.js

@@ -0,0 +1 @@
+export * from "./FilterInput";

package/lib/tr-grid-heat-map/es6/HeatMap.d.ts

@@ -0,0 +1,44 @@
+import {Ext} from '../../tr-grid-util/es6/Ext.js';
+import {GridPlugin, colDataGetter} from '../../tr-grid-util/es6/GridPlugin.js';
+import {CellPainter} from '../../tr-grid-util/es6/CellPainter.js';
+
+declare namespace HeatMapPlugin {
+
+    type ColumnOptions = {
+        field: string,
+        heatMap?: HeatMapPlugin.Heatmap
+    };
+
+    type Heatmap = {
+        midPoint?: number,
+        mode?: string
+    };
+
+}
+
+declare class HeatMapPlugin extends GridPlugin {
+
+    constructor();
+
+    public getName(): string;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host: any): void;
+
+    public config(options?: any, opt_grid?: any): void;
+
+    public getConfigObject(out_obj?: any): any;
+
+    public getColumnHeatMap(colIndex: number, grid?: any): CellPainter;
+
+    public setColumnHeatMap(colIndex: number, columnDef: any, opt_grid?: any): void;
+
+    public getColumnHeatMapOptions(colIndex: number, options?: any): any;
+
+}
+
+declare function cond(colIndex: number, options?: any): any;
+
+export default HeatMapPlugin;
+export { HeatMapPlugin, HeatMapPlugin as HeatMap, HeatMapPlugin as HeatMapExtension };

package/lib/tr-grid-heat-map/es6/HeatMap.js

@@ -0,0 +1,394 @@
+import {Ext} from '../../tr-grid-util/es6/Ext.js';
+import {GridPlugin, colDataGetter} from '../../tr-grid-util/es6/GridPlugin.js';
+import {CellPainter} from '../../tr-grid-util/es6/CellPainter.js';
+
+/** @typedef {Object} HeatMapPlugin~ColumnOptions
+* @description Extension column options that can be specified on each individual grid's column option:
+* @property {string} field Field used by the heat map
+* @property {HeatMapPlugin~Heatmap=} heatMap=null Heat map options
+*/
+
+/** @typedef {boolean|Object} HeatMapPlugin~Heatmap
+* @description Available options describing `heatmap` object
+* @property {number=} midPoint=0 Middle point between values representing up and down colors
+* @property {string=} mode="cell" In cell mode, heat map color will be applied to the entire cell
+*/
+
+/** @constructor
+* @extends {GridPlugin}
+*/
+var HeatMapPlugin = function () {
+	this._onSectionBinding = this._onSectionBinding.bind(this);
+	this._onColumnAdded = this._onColumnAdded.bind(this);
+	this._onColumnRemoved = this._onColumnRemoved.bind(this);
+	this._onThemeLoaded = this._onThemeLoaded.bind(this);
+
+	this._hosts = [];
+};
+Ext.inherits(HeatMapPlugin, GridPlugin);
+
+/** @type {number}
+* @private
+*/
+HeatMapPlugin._runningId = 0;
+/** @type {boolean}
+* @private
+*/
+HeatMapPlugin._themeLoaded = false;
+/** @type {boolean}
+* @private
+*/
+HeatMapPlugin.prototype._themeLoading = false;
+
+/** @public
+* @return {string}
+*/
+HeatMapPlugin.prototype.getName = function () {
+	return "HeatMapPlugin"; // Read Only
+};
+
+/**
+* @override
+* @return {boolean}
+*/
+HeatMapPlugin.prototype.hasMultiTableSupport = function() {
+	return true;
+};
+
+/** @public
+* @param {Object} host core grid object
+* @param {Object=} options
+*/
+HeatMapPlugin.prototype.initialize = function (host, options) {
+	if(this._hosts.indexOf(host) >= 0) { return; }
+
+	this._hosts.push(host);
+
+	this.config(options, host);
+
+	host.listen("postSectionDataBinding", this._onSectionBinding);
+	host.listen("columnAdded", this._onColumnAdded);
+	host.listen("columnRemoved", this._onColumnRemoved);
+
+	if(!HeatMapPlugin._themeLoaded && !this._themeLoading) {
+		this._themeLoading = true;
+		CellPainter.loadThemeColors().then(this._onThemeLoaded);
+	}
+};
+/** @private
+*/
+HeatMapPlugin.prototype._afterInit = function () {
+	if(this._realTimeGrid) {
+		var colStats, painter;
+		var colCount = this.getColumnCount();
+		for(var c = 0; c < colCount; c++) {
+			painter = this.getColumnHeatMap(c);
+			if(painter) {
+				colStats = painter.getColumnStats();
+				if(colStats) {
+					colStats.setColumnDataGetter(colDataGetter);
+				}
+			}
+		}
+	}
+};
+/** @public
+* @param {Object} host core grid object
+*/
+HeatMapPlugin.prototype.unload = function (host) {
+	var at = this._hosts.indexOf(host);
+	if(at < 0) { return; }
+
+	this._hosts.splice(at, 1);
+
+	host.unlisten("postSectionDataBinding", this._onSectionBinding);
+	host.unlisten("columnAdded", this._onColumnAdded);
+	host.unlisten("columnRemoved", this._onColumnRemoved);
+
+	this._dispose();
+};
+
+/** @public
+* @param {Object=} options
+* @param {Object=} opt_grid core grid object
+*/
+HeatMapPlugin.prototype.config = function (options, opt_grid) {
+	if(!options) { return; }
+
+	var columns = options["columns"];
+	if(!columns) { return; }
+
+	var len = columns.length;
+	for(var i = 0; i < len; ++i) {
+		var column = columns[i];
+		this.setColumnHeatMap(i, column, opt_grid);
+	}
+};
+
+/** Get a current state of grid and extension config
+ * @public
+ * @param {Object=} out_obj
+ * @returns {!Object}
+ */
+HeatMapPlugin.prototype.getConfigObject = function (out_obj) {
+	var obj = out_obj || {};
+
+	var columns = obj.columns;
+	if (!columns) {
+		columns = obj.columns = [];
+	}
+
+	var len = this.getColumnCount();
+	for(var i = 0; i < len; ++i) {
+		var col = columns[i];
+		if (!col) {
+			col = columns[i] = {};
+		}
+
+		var heatMap = col.heatMap = {};
+
+		var opt = this.getColumnHeatMap(i);
+
+		if (!opt) { continue; }
+		if (opt.midPoint != null) {
+			heatMap.midPoint = opt.midPoint;
+		}
+		if (opt.mode != null) {
+			heatMap.mode = opt.mode;
+		}
+	}
+
+	return obj;
+};
+
+/** @public
+* @param {number} colIndex
+* @param {Object=} grid core grid object
+* @return {CellPainter}
+*/
+HeatMapPlugin.prototype.getColumnHeatMap = function (colIndex, grid) {
+	var painter = this._getColumnOption(colIndex, "painter", grid);
+	if(painter && painter.getColoringType() === CellPainter.ColoringTypes.HEATMAP) {
+		return /** @type{CellPainter} */painter;
+	}
+	return null;
+};
+
+/** @public
+* @param {number} colIndex
+* @param {Object} columnDef
+* @param {Object=} opt_grid core grid object
+* @example
+* plugin.setColumnHeatMap(1, {
+*   "field": "CF_LAST"
+*   "heatMap": {
+*     "midPoint": 0, // optional number
+*     "mode": "cell" // optional string (cell|text)
+*   }
+* });
+*/
+HeatMapPlugin.prototype.setColumnHeatMap = function (colIndex, columnDef, opt_grid) {
+	var hmMode = "";
+	var midPoint = 0;
+	var field = columnDef ? /** @type{string} */(columnDef["field"]) : "";
+	var hmOptions = field ? columnDef["heatMap"] || columnDef["heatmap"] : null;
+	if(hmOptions) {
+		var userMode = hmOptions["mode"] || hmOptions["type"];
+		hmMode = (typeof userMode == "string") ? userMode : "cell";
+
+		var userMidPoint = /** @type{number} */(hmOptions["midPoint"]);
+		if(typeof userMidPoint != "number") {
+			userMidPoint = +userMidPoint;
+		}
+		midPoint = (userMidPoint) ? userMidPoint : 0;
+	}
+	if(opt_grid) {
+		this._setColumnHeatMap(opt_grid, colIndex, hmMode, midPoint, field);
+	} else {
+		for(var i = this._hosts.length; --i >= 0;) {
+			this._setColumnHeatMap(this._hosts[i], colIndex, hmMode, midPoint, field);
+		}
+	}
+};
+/** @private
+* @param {Object} grid core grid object
+* @param {number} colIndex
+* @param {string} hmMode
+* @param {number} midPoint
+* @param {string} field
+*/
+HeatMapPlugin.prototype._setColumnHeatMap = function (grid, colIndex, hmMode, midPoint, field) {
+	var dv = grid.getDataSource();
+	if(!dv) {
+		console.log("Heat map requires a data source");
+		return;
+	}
+
+	var colData = this._newColumnData(colIndex);
+	var painter = /** @type{CellPainter} */(colData["painter"]);
+
+	var cond, sect, rowCount, r, cell;
+	if(hmMode && field) { // Update or create new painter for heatmap
+		if(painter) {
+			// Clear currrent style, blinking and existing styles related to blinking
+			sect = grid.getSection("content");
+			rowCount = sect.getRowCount();
+			for (r = 0; r < rowCount; ++r) {
+				cell = sect.getCell(colIndex, r, false);
+				if(cell) {
+					CellPainter.clearCellStyle(cell, CellPainter.bgStyles);
+				}
+			}
+
+			cond = painter.getConditions()[0];
+			if(cond) {
+				dv.enableColumnStats(cond.field, false, cond.refId);
+			}
+			painter.resetHeatMap(); // Release any used memory
+		} else {
+			painter = colData["painter"] = new CellPainter();
+		}
+
+		painter["midPoint"] = midPoint; // For saving
+		painter["mode"] = hmMode;
+
+		cond = painter.addHeatmapWithTheme(field, midPoint, (hmMode === "text"));
+		cond.refId = "_hm" + HeatMapPlugin._runningId++;
+
+		var colStats = dv.enableColumnStats(field, true, cond.refId);
+		if(this._initializedGrid && this._realTimeGrid) {
+			colStats.setColumnDataGetter(colDataGetter);
+		}
+		painter.setColumnStats(colStats);
+
+		grid.enableColumnClass(colIndex, "heat-map", true);
+		grid["requestRowRefresh"]();
+	} else {
+		if(painter) {
+			if(this._clearPainter(colData, grid)) {
+				// Clear existing heatmap styles
+				grid.enableColumnClass(colIndex, "heat-map", false);
+				sect = grid.getSection("content");
+				rowCount = sect.getRowCount();
+				for(r = 0; r < rowCount; ++r) {
+					cell = sect.getCell(colIndex, r, false);
+					if(cell) {
+						cell.setStyle("color", "");
+						cell.setStyle("backgroundColor", "");
+					}
+				}
+			}
+		}
+	}
+};
+/** @public
+* @param {number} colIndex
+* @param {Object=} options
+* @return {!Object}
+* @example
+* var obj = {
+*  "heatMap": {
+*    "midPoint": 0, // optional number
+*    "mode": "cell", // optional string
+*  }
+* };
+*/
+HeatMapPlugin.prototype.getColumnHeatMapOptions = function(colIndex, options) {
+	if(!options) { options = {}; }
+
+	var hm = this.getColumnHeatMap(colIndex);
+	if(hm) {
+		options["midPoint"] = hm["midPoint"];
+		options["mode"] = hm["mode"];
+	}
+	return options;
+};
+
+/** @private
+* @param {Object} colData
+* @param {Object=} grid core grid object
+* @return {boolean}
+*/
+HeatMapPlugin.prototype._clearPainter = function (colData, grid) {
+	if(colData) {
+		var painter = colData["painter"];
+		if(painter && painter.getColoringType() === CellPainter.ColoringTypes.HEATMAP) {
+			var cond = painter.getConditions()[0];
+			if(cond) {
+				var dv = grid.getDataSource();
+				dv.enableColumnStats(cond.field, false, cond.refId);
+			}
+			if(painter.clearHeatMap()) {
+				colData["painter"] = null;
+			}
+			return true;
+		}
+	}
+	return false;
+};
+/** @private */
+HeatMapPlugin.prototype._onThemeLoaded = function () {
+	HeatMapPlugin._themeLoaded = true;
+
+	for(var i = this._hosts.length; --i >= 0;) {
+		this._hosts[i].requestRowRefresh();
+	}
+};
+/** @private
+* @param {Object} e
+*/
+HeatMapPlugin.prototype._onSectionBinding = function (e) {
+	if(!HeatMapPlugin._themeLoaded) {
+		return;
+	}
+
+	var grid = e["sender"];
+	var section = e["section"];
+	var dataRows = /** @type{Array.<Object>} */(e["dataRows"]);
+	var colCount = section.getColumnCount();
+	var fromR = /** @type{number} */(e["fromRowIndex"]);
+	var toR = /** @type{number} */(e["toRowIndex"]);
+
+	for (var c = 0; c < colCount; ++c) {
+		var painter = this.getColumnHeatMap(c, grid);
+		if(painter) {
+			var columnStats = painter.getColumnStats();
+			var min = columnStats.getMin();
+			var max = columnStats.getMax();
+			for (var r = fromR; r < toR; ++r) {
+				var cell = section.getCell(c, r, false);
+				if(cell) {
+					painter.renderHeatMap(cell, this._getRowData(dataRows[r]), min, max);
+				}
+			}
+		}
+	}
+};
+/** @private
+* @param {Object} e
+*/
+HeatMapPlugin.prototype._onColumnAdded = function(e) {
+	if(e.context) {
+		this.setColumnHeatMap(e.colIndex, e.context, e.sender);
+		if(this._realTimeGrid) {
+			var painter = this.getColumnHeatMap(e.colIndex);
+			if(painter) {
+				var colStats = painter.getColumnStats();
+				if(colStats) {
+					colStats.setColumnDataGetter(colDataGetter);
+				}
+			}
+		}
+	}
+};
+/** @private
+* @param {Object} e
+*/
+HeatMapPlugin.prototype._onColumnRemoved = function(e) {
+	this._clearPainter(e.columnData, e.sender);
+};
+
+
+
+export default HeatMapPlugin;
+export { HeatMapPlugin, HeatMapPlugin as HeatMap, HeatMapPlugin as HeatMapExtension };

package/lib/tr-grid-heat-map/es6/index.d.ts

@@ -0,0 +1 @@
+export * from "./HeatMap";

package/lib/tr-grid-heat-map/es6/index.js

@@ -0,0 +1 @@
+export * from "./HeatMap";

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

@@ -0,0 +1,129 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { Dom } from "../../tr-grid-util/es6/Dom.js";
+import { Popup } from "../../tr-grid-util/es6/Popup.js";
+import { ElfUtil } from "../../tr-grid-util/es6/ElfUtil.js";
+import { isTouchDevice } from "../../tr-grid-util/es6/Util.js";
+import { ElfDate } from "../../tr-grid-util/es6/ElfDate.js";
+import { CoralItems } from "../../tr-grid-util/es6/CoralItems.js";
+
+declare namespace InCellEditingPlugin {
+
+    type Options = {
+        balloonMode?: boolean,
+        editableTitle?: boolean,
+        editableContent?: boolean,
+        autoCommitText?: boolean,
+        dataBinding?: boolean,
+        popupElement?: Element,
+        doubleClick?: boolean,
+        tabToMove?: boolean,
+        contentSource?: boolean,
+        inlineStyling?: boolean,
+        disablingScroll?: boolean,
+        preEditorOpening?: ((...params: any[]) => any),
+        editorOpened?: ((...params: any[]) => any),
+        beforeCommit?: ((...params: any[]) => any),
+        editorClosed?: ((...params: any[]) => any),
+        keyUp?: ((...params: any[]) => any),
+        beforeRowCommit?: ((...params: any[]) => any),
+        rowEditorClosed?: ((...params: any[]) => any),
+        uiBlocking?: boolean
+    };
+
+    type Cache = {
+        editor: Element,
+        balloonPopup: Element,
+        inputElement: Element
+    };
+
+    type EditorOptions = {
+        type?: string,
+        entries?: any[]
+    };
+
+    type ColumnOptions = {
+        editableContent?: boolean,
+        inCellEditing?: InCellEditingPlugin.EditorOptions
+    };
+
+}
+
+declare class InCellEditingPlugin extends GridPlugin {
+
+    constructor(options?: InCellEditingPlugin.Options);
+
+    public initialize(host: any, options: any): void;
+
+    public beforeProcessOption(optionName: string, optionVal: any): any;
+
+    public config(options?: any): void;
+
+    public getConfigObject(out_obj?: any): any;
+
+    public openEditor(colIndex: number, rowIndex: number, sectionRef?: any, grid?: any): void;
+
+    public closeCellEditor(opt_forceCommit?: boolean): void;
+
+    public enableBalloonMode(opt_enabled?: boolean): void;
+
+    public enableTitleEditing(opt_enabled?: boolean): void;
+
+    public disableTitleEditing(opt_disabled?: boolean): void;
+
+    public disableCellEditing(cell: any, opt_disabled?: boolean): void;
+
+    public disableDataBinding(opt_disabled?: boolean): void;
+
+    public disableDblClick(opt_disabled?: boolean): void;
+
+    public isEditing(): boolean;
+
+    public getTextBox(columnIndex?: number, grid?: any): Element;
+
+    public getInitialText(): string;
+
+    public _getRowIndex(rowId: string): number;
+
+    public _getRowId(rowIndex: number): string;
+
+    public getActiveGrid(): any|null;
+
+    public getActiveColIndex(): number;
+
+    public getActiveRowIndex(): number;
+
+    public getInputElementPosition(): any;
+
+    public enableAutoCommitText(opt_enable?: boolean): void;
+
+    public isColumnEditable(colIndex: number): boolean;
+
+    public openRowEditor(rowIndex: number, grid?: any): void;
+
+    public closeRowEditor(isCommit?: boolean): void;
+
+    public toggleRowEditor(rowIndex: number, isCommit?: boolean, grid?: any): void;
+
+    public setPopupElement(elm: Element): void;
+
+    public setText(content: any): void;
+
+    public getText(): string;
+
+    public getValue(): any;
+
+    public clearText(): void;
+
+    public appendText(word: string): void;
+
+    public commitText(word?: string): void;
+
+    public getBalloonPopup(): Popup|null;
+
+    public setDisablingScroll(disabled?: boolean): boolean;
+
+}
+
+export default InCellEditingPlugin;
+export { InCellEditingPlugin, InCellEditingPlugin as InCellEditing, InCellEditingPlugin as InCellEditingExtension };