@refinitiv-ui/efx-grid 6.0.80 → 6.0.81

package/lib/grid/index.js

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

package/lib/tr-grid-checkbox/es6/Checkbox.js

@@ -1394,21 +1394,21 @@ CheckboxPlugin.prototype._onCheckboxChanged = function (e, toggling) {
 			}
 		}
 
+		var checked = newState !== "unchecked";
 		if(changeRange) {
 			this.setCheckStates(changeRange, !e.altKey);
 		} else {
-			var bool = newState !== "unchecked";
 			var subGroup = dv.getGroupByRowId(rid);
 			if (subGroup) {
 				var rowMemberIds = this._getRowMemberIdsOfSubgroup(dv, subGroup);
-				this._setColumnData(dv, this._checkboxField, bool, rowMemberIds);
+				this._setColumnData(dv, this._checkboxField, checked, rowMemberIds);
 
 				// WORKAROUND: to force group move to next state from partial state
 				if (newState === 'checked' && chkbox._prevState === 'partial') {
 					chkbox._forceNewState = newState;
 				}
 			} else {
-				this._setData(dv, rowIndex, this._checkboxField, bool);
+				this._setData(dv, rowIndex, this._checkboxField, checked);
 			}
 		}
 	}
@@ -1419,7 +1419,7 @@ CheckboxPlugin.prototype._onCheckboxChanged = function (e, toggling) {
 	if (this.hasListener("clicked")) {
 		pos["checkbox"] = chkbox;
 		pos["checkState"] = newState;
-		pos["checked"] = chkbox.checked;
+		pos["checked"] = checked;
 		this._dispatch("clicked", pos);
 	}
 

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

@@ -30,7 +30,9 @@ declare namespace RowFilteringPlugin {
         lang?: string|null,
         rawDataAccessor?: ((...params: any[]) => any)|null,
         formattedDataAccessor?: ((...params: any[]) => any)|null,
-        sortLogic?: ((...params: any[]) => any)|null
+        sortLogic?: ((...params: any[]) => any)|null,
+        itemList?: any[]|null,
+        additionalItems?: any[]|null
     };
 
     type Options = {

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

@@ -89,8 +89,10 @@ The expression can take various forms:<br>
 * @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
-* @property {Function=} formattedDataAccessor In case you have custom data type for the specified field, data getter is needed to retrieve formatted value for display
-* @property {Function=} sortLogic sorting function for sort autosuggest list in filter dialog, the values for comparison are raw value not a formatted value
+* @property {Function=} formattedDataAccessor This function will be called on each raw data, allowing formatting data to be displayed on the filter item list
+* @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
 */
 
 /** @typedef {Object} RowFilteringPlugin~Options
@@ -1662,109 +1664,206 @@ RowFilteringPlugin.prototype._getDataTable = function (dv) {
   return dt;
 };
 /** @public
+* @deprecated
 * @ignore
 * @param {string} field A field name for getting raw value from row data
 * @param {Function=} formatter A formatter that takes row data, retrieves data, and modified the data for display.
 * @param {string=} fmtField A field name to be used instead of formatter for getting formatted value
 * @param {Function=} rawDataAccessor Data getter to retrieve raw value
 * @param {Function=} formattedDataAccessor Data getter to retrieve formatted value. This paramter will override formatted and fmtField parameters
-* @param {Function=} filterFuncs
+* @param {Array.<Function>=} filterFuncs
 * @param {Object=} selectedItems
 * @return {Object} Object that maps formatted value to array of raw values
 */
 
 
 RowFilteringPlugin.prototype.getUniqueValues = function (field, formatter, fmtField, rawDataAccessor, formattedDataAccessor, filterFuncs, selectedItems) {
+  var dialogConfig = {
+    rawDataAccessor: rawDataAccessor,
+    formattedDataAccessor: formattedDataAccessor
+  };
+  return this._getUniqueValues(field, dialogConfig, formatter, filterFuncs, selectedItems);
+};
+/** @private
+* @param {*} formattedVal
+* @param {*} rawVal
+* @returns {string}
+*/
+
+
+var _valueToString = function _valueToString(formattedVal, rawVal) {
+  if (typeof formattedVal === "string") {
+    return formattedVal;
+  }
+
+  if (formattedVal) {
+    if (_typeof(formattedVal) != "object") {
+      return rawVal + "";
+    } else if (formattedVal instanceof Date) {
+      return formattedVal.toLocaleString("en-GB");
+    } else {
+      // Object type cannot be converted to string
+      return "";
+    }
+  } else if (formattedVal === 0) {
+    return "0";
+  } else if (formattedVal === false) {
+    return "false";
+  }
+
+  return "";
+};
+/** @private
+* @param {Object} selectedItems
+* @param {string} formattedVal
+* @param {Object} row
+* @param {!Array.<Function>} filterFuncs A selector function that execute on each item to determine the selection
+*/
+
+
+var _collectSelectedItem = function _collectSelectedItem(selectedItems, formattedVal, row, filterFuncs) {
+  if (filterFuncs) {
+    if (!selectedItems[formattedVal]) {
+      for (var i = filterFuncs.length; --i >= 0;) {
+        if (!filterFuncs[i](row)) {
+          return;
+        }
+      }
+
+      selectedItems[formattedVal] = true;
+    }
+  }
+};
+/** @private
+* @param {Object} uniqueValues
+* @param {string} formattedVal
+* @param {*} rawVal
+*/
+
+
+var _collectUniqueValue = function _collectUniqueValue(uniqueValues, formattedVal, rawVal) {
+  var rawValues = uniqueValues[formattedVal];
+
+  if (rawValues) {
+    if (rawValues.indexOf(rawVal) < 0) {
+      // Check for unique raw values
+      rawValues.push(rawVal);
+    }
+  } else {
+    // The first unique formatted value detected
+    uniqueValues[formattedVal] = [rawVal];
+  }
+};
+/** @private
+* @param {string} field A field name for getting raw value from row data
+* @param {!Object} dialogConfig
+* @param {Function} formatter A formatter that takes row data, retrieves data, and modified the data for display.
+* @param {Array.<Function>} filterFuncs A selector function that execute on each item to determine the selection
+* @param {Object} selectedItems
+* @return {Object} Object that maps formatted value to array of raw values
+*/
+
+
+RowFilteringPlugin.prototype._getUniqueValues = function (field, dialogConfig, formatter, filterFuncs, selectedItems) {
   if (!field) {
     return null;
   }
 
-  var dvs = this._getAvailableDataViews();
-
-  var dts = dvs.map(this._getDataTable);
-  var tblCount = dts.length;
+  var rawDataAccessor = dialogConfig.rawDataAccessor || null;
+  var formattedDataAccessor = dialogConfig.formattedDataAccessor || null;
+  var userItemList = dialogConfig.itemList;
   var uniqueValues = {};
+  var formattedVal = null;
+  var rawVal = null;
 
-  for (var t = 0; t < tblCount; ++t) {
-    var rows = dts[t].getAllRowData();
-    var rowCount = rows.length;
+  if (!Array.isArray(userItemList)) {
+    userItemList = null;
 
-    for (var r = 0; r < rowCount; ++r) {
-      var row = rows[r];
+    var dvs = this._getAvailableDataViews();
 
-      if (this._rowGetter) {
-        row = this._rowGetter(row);
-      }
+    var dts = dvs.map(this._getDataTable);
+    var tblCount = dts.length;
 
-      if (this._rowTransform) {
-        row = this._rowTransform(row);
-      }
+    for (var t = 0; t < tblCount; ++t) {
+      var rows = dts[t].getAllRowData();
+      var rowCount = rows.length;
 
-      var fieldVal = row[field];
-      var rawVal = fieldVal;
+      for (var r = 0; r < rowCount; ++r) {
+        var row = rows[r];
 
-      if (rawDataAccessor) {
-        rawVal = rawDataAccessor(rawVal);
-      }
+        if (this._rowGetter) {
+          row = this._rowGetter(row);
+        }
 
-      if (!rawVal) {
-        // Only valid values are accepted
-        if (rawVal !== 0 && rawVal !== false) {
-          continue;
+        if (this._rowTransform) {
+          row = this._rowTransform(row);
         }
-      }
 
-      var formattedVal = rawVal;
+        var fieldVal = row[field];
+        rawVal = fieldVal;
 
-      if (formattedDataAccessor) {
-        formattedVal = formattedDataAccessor(fieldVal); // The function takes data value
-      } else if (formatter) {
-        formattedVal = formatter(row); // The function takes row data
-      } else if (fmtField) {
-        formattedVal = row[fmtField];
-      }
+        if (rawDataAccessor) {
+          rawVal = rawDataAccessor(rawVal);
+        }
 
-      if (typeof formattedVal != "string") {
-        if (formattedVal) {
-          if (_typeof(formattedVal) != "object") {
-            formattedVal = rawVal + "";
-          } else if (formattedVal instanceof Date) {
-            formattedVal = formattedVal.toLocaleString("en-GB");
-          } else {
-            // Object type cannot be converted to string
-            formattedVal = "";
+        if (!rawVal) {
+          // Only valid values are accepted
+          if (rawVal !== 0 && rawVal !== false) {
+            continue;
           }
-        } else if (formattedVal === 0) {
-          formattedVal = "0";
-        } else if (formattedVal === false) {
-          formattedVal = "false";
         }
-      }
 
-      if (!formattedVal) {
-        continue;
-      }
+        formattedVal = rawVal;
 
-      if (filterFuncs) {
-        if (!selectedItems[formattedVal]) {
-          selectedItems[formattedVal] = RowFilteringPlugin._getFilteredValue(row, filterFuncs);
+        if (formattedDataAccessor) {
+          formattedVal = formattedDataAccessor(fieldVal); // The function takes data value
+        } else if (formatter) {
+          formattedVal = formatter(row); // The function takes row data
         }
-      }
 
-      var rawValues = uniqueValues[formattedVal];
+        formattedVal = _valueToString(formattedVal, rawVal);
 
-      if (rawValues) {
-        if (rawValues.indexOf(rawVal) < 0) {
-          // Check for unique raw values
-          rawValues.push(rawVal);
+        if (formattedVal) {
+          _collectSelectedItem(selectedItems, formattedVal, row, filterFuncs);
+
+          _collectUniqueValue(uniqueValues, formattedVal, rawVal);
         }
-      } else {
-        // The first unique formatted value detected
-        uniqueValues[formattedVal] = [rawVal];
       }
     }
   }
 
+  var additionalItems = dialogConfig.additionalItems;
+
+  if (Array.isArray(additionalItems)) {
+    if (userItemList) {
+      userItemList = userItemList.concat(additionalItems);
+    } else {
+      userItemList = additionalItems;
+    }
+  }
+
+  var dummyRow = {};
+  var userItemCount = userItemList ? userItemList.length : 0;
+
+  for (var i = 0; i < userItemCount; ++i) {
+    rawVal = dummyRow[field] = userItemList[i];
+    formattedVal = rawVal;
+
+    if (formattedDataAccessor) {
+      formattedVal = formattedDataAccessor(rawVal);
+    } else if (formatter) {
+      formattedVal = formatter(dummyRow);
+    }
+
+    formattedVal = _valueToString(formattedVal, rawVal);
+
+    if (formattedVal) {
+      _collectSelectedItem(selectedItems, formattedVal, dummyRow, filterFuncs);
+
+      _collectUniqueValue(uniqueValues, formattedVal, rawVal);
+    }
+  }
+
   return uniqueValues;
 };
 /** @private
@@ -1792,23 +1891,6 @@ RowFilteringPlugin._createDialog = function () {
 };
 /** @private
 * @function
-* @param {Object} rowData
-* @param {!Array.<Function>} filters
-* @returns {boolean}
-*/
-
-
-RowFilteringPlugin._getFilteredValue = function (rowData, filters) {
-  for (var i = filters.length; --i >= 0;) {
-    if (!filters[i](rowData)) {
-      return false;
-    }
-  }
-
-  return true;
-};
-/** @private
-* @function
 * @param {Array} exp
 * @param {string} field
 * @param {Function} formatter
@@ -1996,8 +2078,8 @@ RowFilteringPlugin.prototype.openDialog = function (colIndex, runtimeDialogOptio
   var cfo = this._initColumnFilterOption(colIndex); // colData["rowFiltering"]["filterOption"]
 
 
-  var rawDataAccessor = cfo._rawDataAccessor = dialogConfig.rawDataAccessor || null;
-  var formattedDataAccessor = cfo._formattedDataAccessor = dialogConfig.formattedDataAccessor || null;
+  cfo._rawDataAccessor = dialogConfig.rawDataAccessor || null;
+  cfo._formattedDataAccessor = dialogConfig.formattedDataAccessor || null;
   var sortLogic = dialogConfig.sortLogic || null; // Populate data for filter dialog based on existing states
 
   var formatter = this._getFormatter(colIndex);
@@ -2025,7 +2107,9 @@ RowFilteringPlugin.prototype.openDialog = function (colIndex, runtimeDialogOptio
   }
 
   var selectedItems = {};
-  var uniqueValues = cfo.uniqueValues = this.getUniqueValues(field, formatter, "", rawDataAccessor, formattedDataAccessor, filterFuncs, selectedItems);
+
+  var uniqueValues = cfo.uniqueValues = this._getUniqueValues(field, dialogConfig, formatter, filterFuncs, selectedItems);
+
   var keys = Object.keys(uniqueValues);
 
   if (sortLogic) {
@@ -2136,6 +2220,18 @@ RowFilteringPlugin._overrideConfig = function (config, userConfig) {
     // Allow null value
     config.sortLogic = sortLogic;
   }
+
+  var itemList = userConfig["itemList"];
+
+  if (itemList != null) {
+    config.itemList = itemList;
+  }
+
+  var additionalItems = userConfig["additionalItems"];
+
+  if (additionalItems != null) {
+    config.additionalItems = additionalItems;
+  }
 };
 /** @private
 * @param {number} colIndex

package/lib/tr-grid-row-grouping/es6/RowGrouping.js

@@ -25,7 +25,7 @@ import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 * @property {(boolean|number|Array.<number>)=} indentSize Use array to define indent for each group level. Use boolean to turn on or off indentation. Use number to define incremental step.
 * @property {boolean=} colorTag If not specified, the color tag will be disabled when using extension without halo theme.
 * @property {Object=} predefinedColors Predefined color object map for color tag
-* @property {Object=} groupColors - Deprecated, the object map of group ID and predefined color.
+* @property {Object=} groupColors - The object map of group ID and predefined color.
 * @property {boolean=} defaultCollapse=false Collapsing groups by default when a group is created
 * @property {Function=} clicked=null Event handler when user clicks on arrows or cells
 * @property {Function=} groupAdded=null Event handler
@@ -1416,7 +1416,22 @@ RowGroupingPlugin.prototype._updateHeader = function (settings, firstRowIndex, l
 			indentSize = maxColWidth;
 		}
 
-		var groupColor = currentGroup.getGroupColor();
+		var groupColor;
+		if(currentGroup.getGroupColor) {
+			groupColor = currentGroup.getGroupColor();
+		} else { // Backward compatibility
+			if (this._groupColors) {
+				// TODO: Need better method to find the first level parent's group id
+				var rootGroup = currentGroup ? currentGroup : dataSource.getGroup(rowId); // Slow
+				if (curGroupLevel > 1) {
+					for (var i = curGroupLevel; i > 1; i--) {
+						rootGroup = rootGroup.getDataSource();
+					}
+				}
+				var groupId = rootGroup.getGroupId();
+				groupColor = this._groupColors[groupId];
+			}
+		}
 		arg.colorTagClass = groupColor;
 		arg.indentSize = indentSize;
 		if (groupView) {

package/lib/tr-grid-textformatting/es6/TextFormatting.d.ts

@@ -24,10 +24,7 @@ declare namespace TextFormattingPlugin {
         formatLogic?: ((...params: any[]) => any)|null
     };
 
-    type ColumnOptions = {
-        formatType?: (string|TextFormattingPlugin.FormatOptions)|null,
-        autoTextFormatting?: boolean|null
-    };
+    type ColumnOptions = TextFormattingPlugin.FormatOptions|null;
 
     type GridOptions = {
         autoTextFormatting?: boolean|null

package/lib/tr-grid-textformatting/es6/TextFormatting.js

@@ -40,10 +40,8 @@ import { DateTime } from '../../tr-grid-util/es6/DateTime.js';
 * @property {Function=} formatLogic=null If specified all default formatting will be prevented and replaced by the given function. This should be used when the column has custom rendering. The function must retrieve, format, and insert the data with the provided arguments (i.e., TextFormattingPlugin~FormatLogicArguments).
 */
 
-/** @typedef {Object} TextFormattingPlugin~ColumnOptions
+/** @typedef {TextFormattingPlugin~FormatOptions} TextFormattingPlugin~ColumnOptions
 * @description Available options that can be specified on the column configuration object
-* @property {(string|TextFormattingPlugin~FormatOptions)=} formatType Format options or a shorthand text (e.g. number, scaled, percent, and datetime).
-* @property {boolean=} autoTextFormatting=true If disabled, the extension's automatic formatting will not be triggered, including `formatLogic`
 */
 
 /** @typedef {Object} TextFormattingPlugin~GridOptions

package/lib/types/es6/RealtimeGrid/Grid.d.ts

@@ -36,6 +36,41 @@ declare namespace Grid {
         productId?: string|null
     };
 
+    type GridConfigObject = ExtensionOptions &  {
+        columns?: (ColumnDefinition.Options|string)[]|null,
+        defaultColumnOptions?: ColumnDefinition.Options|null,
+        rows?: (RowDefinition.Options)[]|null,
+        scrollbar?: boolean|null,
+        linearWheelScrolling?: boolean|null,
+        stepScroll?: boolean|null,
+        autoHideScrollbar?: boolean|null,
+        pageSize?: string|null,
+        rowHeight?: number|null,
+        headerRowHeight?: number|null,
+        rowHighlighting?: boolean|null,
+        autoLayoutUpdate?: (boolean|number)|null,
+        rowVirtualization?: boolean|null,
+        columnVirtualization?: boolean|null,
+        topFreezingCount?: (number|null|boolean)|null,
+        bottomFreezingCount?: (number|null)|null,
+        borders?: boolean|null,
+        gridlines?: boolean|null,
+        verticalLines?: boolean|null,
+        contentVerticalLines?: boolean|null,
+        horizontalLines?: boolean|null,
+        contentRightPadding?: number|null,
+        contentBottomPadding?: number|null,
+        dataConflationRate?: number|null,
+        textSelect?: boolean|null,
+        lang?: string|null,
+        formulaEngine?: boolean|null,
+        adcPollingInterval?: number|null,
+        fieldCaching?: boolean|null,
+        timeSeriesExpansion?: boolean|null,
+        childDataField?: string|null,
+        sorting?: SortableTitlePlugin.Options|null
+    };
+
     type GridOptions = ExtensionOptions & {
         columns?: (ColumnDefinition.Options|string)[]|null,
         defaultColumnOptions?: ColumnDefinition.Options|null,
@@ -130,7 +165,7 @@ declare class Grid extends EventDispatcher {
 
     public initialize(gridOption?: Grid.GridOptions|null): void;
 
-    public getConfigObject(gridOptions?: any): any;
+    public getConfigObject(gridOptions?: any): Grid.GridConfigObject;
 
     public setLocale(lang: string): void;
 

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

@@ -30,7 +30,9 @@ declare namespace RowFilteringPlugin {
         lang?: string|null,
         rawDataAccessor?: ((...params: any[]) => any)|null,
         formattedDataAccessor?: ((...params: any[]) => any)|null,
-        sortLogic?: ((...params: any[]) => any)|null
+        sortLogic?: ((...params: any[]) => any)|null,
+        itemList?: any[]|null,
+        additionalItems?: any[]|null
     };
 
     type Options = {

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

@@ -17,17 +17,13 @@ declare namespace TextFormattingPlugin {
         percentSign?: boolean|null,
         scalingUnit?: string|null,
         multiplyBy100?: boolean|null,
-        mutiplyBy100?: boolean|null,
         dateTimeFormat?: string|null,
         useUTCTime?: boolean|null,
         autoTextFormatting?: boolean|null,
         formatLogic?: ((...params: any[]) => any)|null
     };
 
-    type ColumnOptions = {
-        formatType?: (string|TextFormattingPlugin.FormatOptions)|null,
-        autoTextFormatting?: boolean|null
-    };
+    type ColumnOptions = TextFormattingPlugin.FormatOptions|null;
 
     type GridOptions = {
         autoTextFormatting?: boolean|null

package/lib/versions.json

@@ -7,7 +7,7 @@
 	"@grid/zoom": "1.0.11",
 	"tr-grid-auto-tooltip": "1.1.6",
 	"tr-grid-cell-selection": "1.0.34",
-	"tr-grid-checkbox": "1.0.62",
+	"tr-grid-checkbox": "1.0.63",
 	"tr-grid-column-fitter": "1.0.39",
 	"tr-grid-column-formatting": "0.9.35",
 	"tr-grid-column-grouping": "1.0.57",
@@ -24,14 +24,14 @@
 	"tr-grid-percent-bar": "1.0.22",
 	"tr-grid-range-bar": "2.0.6",
 	"tr-grid-row-dragging": "1.0.31",
-	"tr-grid-row-filtering": "1.0.65",
-	"tr-grid-row-grouping": "1.0.85",
+	"tr-grid-row-filtering": "1.0.66",
+	"tr-grid-row-grouping": "1.0.86",
 	"tr-grid-row-selection": "1.0.26",
 	"tr-grid-rowcoloring": "1.0.25",
-	"tr-grid-textformatting": "1.0.46",
+	"tr-grid-textformatting": "1.0.47",
 	"tr-grid-titlewrap": "1.0.20",
 	"@grid/formatters": "1.0.51",
 	"@grid/column-selection-dialog": "4.0.56",
-	"@grid/filter-dialog": "4.0.61",
+	"@grid/filter-dialog": "4.0.62",
 	"@grid/column-format-dialog": "4.0.44"
 }

package/package.json

@@ -56,7 +56,7 @@
 		"./extensions": "./lib/index.js",
 		"./window-exporter": "./lib/window-exporter.js",
 		"./grid": "./lib/grid/lib/efx-grid.js",
-		"./formatters/": "./lib/formatters/es6/",
+		"./formatters/*": "./lib/formatters/es6/*.js",
 		"./utils": "./lib/utils/index.js"
 	},
 	"peerDependencies": {
@@ -66,5 +66,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.80"
+	"version": "6.0.81"
 }