@refinitiv-ui/efx-grid 6.0.42 → 6.0.43

package/lib/formatters/es6/SimpleInputFormatter.d.ts

@@ -4,7 +4,7 @@ declare class SimpleInputFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/SimpleLinkFormatter.d.ts

@@ -3,8 +3,8 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace SimpleLinkFormatter {
 
     type Options = {
-        label?: string,
-        urlField?: string
+        label?: string|null,
+        urlField?: string|null
     };
 
 }
@@ -13,7 +13,7 @@ declare class SimpleLinkFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|SimpleLinkFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|SimpleLinkFormatter.Options|any)|null): any;
 
 }
 

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

@@ -5,8 +5,8 @@ import ElfUtil from "../../tr-grid-util/es6/ElfUtil.js";
 declare namespace SimpleTickerFormatter {
 
     type Options = {
-        positiveColor?: string,
-        negativeColor?: string
+        positiveColor?: string|null,
+        negativeColor?: string|null
     };
 
 }
@@ -15,7 +15,7 @@ declare class SimpleTickerFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|SimpleTickerFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|SimpleTickerFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/SimpleToggleFormatter.d.ts

@@ -4,8 +4,8 @@ import ElfUtil from "../../tr-grid-util/es6/ElfUtil.js";
 declare namespace SimpleToggleFormatter {
 
     type Options = {
-        element1?: (string|Element),
-        element2?: (string|Element)
+        element1?: (string|Element)|null,
+        element2?: (string|Element)|null
     };
 
 }
@@ -14,7 +14,7 @@ declare class SimpleToggleFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|SimpleToggleFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|SimpleToggleFormatter.Options|any)|null): any;
 
 }
 

package/lib/formatters/es6/TextFormatter.d.ts

@@ -4,7 +4,7 @@ declare class TextFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

package/lib/grid/index.js

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

package/lib/rt-grid/dist/rt-grid.js

@@ -43994,6 +43994,7 @@ SortableTitlePlugin._proto = SortableTitlePlugin.prototype;
 * @property {boolean=} timeSeriesExpansion=true If disabled, the time series field will be treated as a normal field and not expanded.
 * @property {string=} childDataField=CHILD_VALUES The given field will be used to store children's static data, such as row color assignment.
 * @property {boolean=} topSection=true If disabled, title section will not be rendered
+* @property {SortableTitlePlugin~Options=} sorting Options for sorting
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference

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

@@ -83,7 +83,8 @@ declare namespace Grid {
         fieldCaching?: boolean|null,
         timeSeriesExpansion?: boolean|null,
         childDataField?: string|null,
-        topSection?: boolean|null
+        topSection?: boolean|null,
+        sorting?: SortableTitlePlugin.Options|null
     };
 
     type RowReference = number|string|RowDefinition|null;

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

@@ -87,6 +87,7 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {boolean=} timeSeriesExpansion=true If disabled, the time series field will be treated as a normal field and not expanded.
 * @property {string=} childDataField=CHILD_VALUES The given field will be used to store children's static data, such as row color assignment.
 * @property {boolean=} topSection=true If disabled, title section will not be rendered
+* @property {SortableTitlePlugin~Options=} sorting Options for sorting
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference

package/lib/tr-grid-column-stack/es6/ColumnStack.js

@@ -50,13 +50,15 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 /** @event ColumnStackPlugin#clicked
 * @description Fired when user clicks on stack/expanding icon
 * @type {Object}
-* @property {number} colIndex
-* @property {number} rowIndex
+* @property {number} colIndex The column index that was clicked
+* @property {number} rowIndex The row index that was clicked
 * @property {Array.<Object>} menuData Data for populating context menu
-* @property {number} activeIndex
-* @property {Array.<number>} columnIndices
-* @property {number} activeColIndex
+* @property {number} activeIndex The index of the item in the menuData that corresponds to the active column
+* @property {Array.<number>} columnIndices Members column index
+* @property {number} activeColIndex The column index that is currently active
 * @property {Event} event Native event argument from click event
+* @property {boolean} spreading True if the column being clicked is a member of the collapsing group
+* @property {boolean} collapsed True If the clicked group is collapsed
 */
 
 /** @private
@@ -259,10 +261,14 @@ ColumnStackPlugin._styles = prettifyCss([
 		"margin: 0;",
 		"justify-content: center;"
 	],
-	".tr-grid .collapsed .cell.grouping .front-panel, " +
-	".tr-grid .collapsed .cell.grouping .floating-panel *:not(.stack-icon)", [
+	".tr-grid .collapsed .cell.grouping .front-panel," +
+	".tr-grid .collapsed .cell.grouping .floating-panel *:not(.stack-icon)," +
+	".tr-grid .collapsed .cell.grouping .sort-symbol", [ // V3 Hide arrow sorting in collapse state in speading mode
 		"display: none;"
 	],
+	".floating-panel .stack-icon", [
+		"cursor: pointer;" // change the mouse cursor on the collapsed stack icon to allow for expansion but disallow sorting
+	],
 	".tr-grid .collapsed .cell.grouping .floating-panel .stack-icon", [
 		"margin-left: 0;"
 	],
@@ -1585,27 +1591,31 @@ ColumnStackPlugin.prototype._onStackButtonClicked = function(e) {
 
 	e.stopPropagation();
 
-	if(colData.spreading) {
-		this.collapseGroup(colIndex, !colData.collapsed);
-		return;
-	}
-
 	var children = colData.children;
-	var activeIndex = children.indexOf(colData.activeColumn);
-
-	var len = children.length;
 	var colIndices = this.getColumnIndices(children);
-	var menuData = new Array(len);
-	for(var i = len; --i >= 0;) {
-		menuData[i] = {
-			value: i,
-			selected: i === activeIndex,
-			label: this.getColumnName(colIndices[i]),
-			field: this.getColumnField(colIndices[i])
-		};
+	if(colData.spreading) {
+		var collapsed = !colData.collapsed;
+		this.collapseGroup(colIndex, collapsed);
+		pos["menuData"] = null;
+		pos["activeIndex"] = -1;
+		pos["collapsed"] = collapsed;
+	} else {
+		var activeIndex = children.indexOf(colData.activeColumn);
+		var len = children.length;
+		var menuData = new Array(len);
+		for(var i = len; --i >= 0;) {
+			menuData[i] = {
+				value: i,
+				selected: i === activeIndex,
+				label: this.getColumnName(colIndices[i]),
+				field: this.getColumnField(colIndices[i])
+			};
+		}
+		pos["menuData"] = menuData;
+		pos["activeIndex"] = activeIndex;
+		pos["collapsed"] = false;
 	}
-	pos["menuData"] = menuData;
-	pos["activeIndex"] = activeIndex;
+	pos["spreading"] = colData.spreading;
 	pos["columnIndices"] = colIndices;
 	pos["activeColIndex"] = this.getColumnIndex(colData.activeColumn);
 	pos["event"] = e;

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

@@ -7,30 +7,30 @@ import { CoralItems } from '../../tr-grid-util/es6/CoralItems.js';
 declare namespace FilterInputPlugin {
 
     type GridColumn = {
-        filterInput?: FilterInputPlugin.ColumnOptions
+        filterInput?: FilterInputPlugin.ColumnOptions|null
     };
 
     type ColumnOptions = {
-        defaultLogic?: ((...params: any[]) => any),
-        filterLogic?: ((...params: any[]) => any),
-        disabled?: boolean,
-        placeholder?: string,
-        type?: string,
-        entries?: any[],
+        defaultLogic?: ((...params: any[]) => any)|null,
+        filterLogic?: ((...params: any[]) => any)|null,
+        disabled?: boolean|null,
+        placeholder?: string|null,
+        type?: string|null,
+        entries?: any[]|null,
         defaultValue?: any,
-        trigger?: string
+        trigger?: string|null
     };
 
     type Options = {
-        inputCreated?: ((...params: any[]) => any),
-        trigger?: string
+        inputCreated?: ((...params: any[]) => any)|null,
+        trigger?: string|null
     };
 
 }
 
 declare class FilterInputPlugin extends GridPlugin {
 
-    constructor(options?: FilterInputPlugin.Options);
+    constructor(options?: FilterInputPlugin.Options|null);
 
     public getName(): string;
 
@@ -42,17 +42,17 @@ declare class FilterInputPlugin extends GridPlugin {
 
     public getConfigObject(out_obj?: any): any;
 
-    public getColumnInput(colIndex: number): Element;
+    public getColumnInput(colIndex: number): Element|null;
 
-    public removeColumnFilters(colIndex?: (null|number)): void;
+    public removeColumnFilters(colIndex?: (null|number)|null): void;
 
-    public removeColumnFilter(colIndex?: (null|number)): void;
+    public removeColumnFilter(colIndex?: (null|number)|null): void;
 
-    public refresh(delayMs?: number): void;
+    public refresh(delayMs?: number|null): void;
 
-    public setFilterLogic(colIndex: number, func: ((...params: any[]) => any), ctx?: any): void;
+    public setFilterLogic(colIndex: number, func: ((...params: any[]) => any)|null, ctx?: any): void;
 
-    public filterColumn(colIndex: number, text: string): void;
+    public filterColumn(colIndex: number, text: string, textMap?: any): void;
 
 }
 

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

@@ -14,7 +14,7 @@ import { CoralItems } from '../../tr-grid-util/es6/CoralItems.js';
 * @property {Function=} filterLogic=null Alias to `defaultLogic`
 * @property {boolean=} disabled=false Disable UI
 * @property {string=} placeholder="" Placeholder text inside the input
-* @property {string=} type="text" Type of UI. Available types are "number", "select", "dropdown", "date"
+* @property {string=} type="text" Type of UI. Available types are "number", "multiselect" ,"select", "dropdown", "date"
 * @property {Array=} entries Entries of dropdown filters when type is "select"
 * @property {*=} defaultValue Default value of input filter
 * @property {string=} trigger="keyup" Available types of trigger are `false | ""` (no trigger) , `"keyup"` (default) , `"enter"` (on enter key *only available for text type)
@@ -465,12 +465,20 @@ FilterInputPlugin.prototype._createColumnInputs = function (section, host) {
     var defaultValue = colOpt.defaultValue;
 
     if (defaultValue) {
-      if (colOpt.type == "date") {
+      var type = colOpt.type.toLowerCase();
+
+      if (type == "date") {
         var dateObj = ElfDate.from(defaultValue);
         defaultValue = dateObj ? dateObj.toDateString().substr(4) : "";
       }
 
-      this.filterColumn(c, defaultValue);
+      if (type == "multiselect") {
+        var textMap = FilterInputPlugin._createMapObject(defaultValue);
+
+        this.filterColumn(c, "", textMap);
+      } else {
+        this.filterColumn(c, defaultValue);
+      }
     }
   }
 };
@@ -482,6 +490,7 @@ FilterInputPlugin.prototype._createColumnInputs = function (section, host) {
 FilterInputPlugin._uiMap = {
   number: "ef-input",
   select: "ef-select",
+  multiselect: "ef-combo-box",
   dropdown: "ef-select",
   date: "ef-datetime-picker"
 };
@@ -492,6 +501,11 @@ FilterInputPlugin._uiMap = {
 
 FilterInputPlugin.prototype._createFilterUI = function (colOpt) {
   var elemType = colOpt.type;
+
+  if (elemType) {
+    elemType = elemType.toLowerCase();
+  }
+
   var defaultValue = colOpt.defaultValue;
   var elemTrigger = colOpt.trigger != null ? colOpt.trigger : this._inputTrigger;
   var uiTag = FilterInputPlugin._uiMap[elemType] || "input";
@@ -520,10 +534,6 @@ FilterInputPlugin.prototype._createFilterUI = function (colOpt) {
   elem.addEventListener("keydown", FilterInputPlugin._stopPropagation, false);
   elem.addEventListener("click", FilterInputPlugin._stopPropagation, false);
 
-  if (defaultValue) {
-    elem.value = colOpt.defaultValue;
-  }
-
   switch (uiTag) {
     case "ef-input":
       elem.setAttribute("type", "number");
@@ -551,6 +561,17 @@ FilterInputPlugin.prototype._createFilterUI = function (colOpt) {
 
       break;
 
+    case "ef-combo-box":
+      elem.multiple = true;
+      elem.data = CoralItems.create(colOpt.entries);
+      elem.addEventListener("opened-changed", this._onOpenedChanged, false);
+
+      if (elemTrigger != false && elemTrigger != "") {
+        elem.addEventListener("value-changed", this._onInputChanged, false);
+      }
+
+      break;
+
     case "ef-datetime-picker":
       if (elemTrigger != false && elemTrigger != "") {
         elem.addEventListener("value-changed", this._onDateChanged, false);
@@ -593,6 +614,14 @@ FilterInputPlugin.prototype._createFilterUI = function (colOpt) {
       break;
   }
 
+  if (defaultValue) {
+    if (elemType === "multiselect") {
+      elem.values = defaultValue;
+    } else {
+      elem.value = defaultValue;
+    }
+  }
+
   return elem;
 };
 /** @private
@@ -660,17 +689,25 @@ FilterInputPlugin.prototype._retrieveColumnOption = function (colIndex, colDef)
       var type = filterOption["type"];
 
       if (typeof type == "string") {
+        type = type.toLowerCase();
         option["type"] = type;
+
+        if (type == "multiselect") {
+          option._comparingLogic = FilterInputPlugin._multiSelectionFilter;
+        }
       }
 
       var entries = filterOption["entries"];
 
       if (Array.isArray(entries)) {
         // Add Clear filter option
-        entries.push({
-          label: 'No Filter',
-          value: 'No Filter'
-        });
+        if (type === "select") {
+          entries.push({
+            label: 'No Filter',
+            value: 'No Filter'
+          });
+        }
+
         option["entries"] = entries;
       }
 
@@ -713,11 +750,12 @@ FilterInputPlugin.prototype.updateUI = function (colIndex, text) {
 /** @private
 * @param {number} colIndex
 * @param {string} text
+* @param {Object=} textMap
 * @return {Object} Column option
 */
 
 
-FilterInputPlugin.prototype._updateColumnOption = function (colIndex, text) {
+FilterInputPlugin.prototype._updateColumnOption = function (colIndex, text, textMap) {
   var option = this._getExtColumnOption(colIndex);
 
   if (!option) {
@@ -736,6 +774,12 @@ FilterInputPlugin.prototype._updateColumnOption = function (colIndex, text) {
     arg.inputText = option.inputText = inputText;
     arg.lowerCasedText = inputText.toLowerCase();
     arg.colIndex = colIndex;
+
+    if (textMap && !Object.keys(textMap).length) {
+      textMap = null;
+    }
+
+    arg.textMap = option.textMap = textMap;
   }
 
   return option;
@@ -830,6 +874,7 @@ FilterInputPlugin.prototype.setFilterLogic = function (colIndex, func, ctx) {
   var option = this._newExtColumnOption(colIndex);
 
   var inputText = option.inputText;
+  var textMap = option.textMap;
 
   if (func) {
     if (ctx != null) {
@@ -841,19 +886,20 @@ FilterInputPlugin.prototype.setFilterLogic = function (colIndex, func, ctx) {
 
   option._comparingLogic = func;
 
-  if (inputText) {
-    this.filterColumn(colIndex, inputText);
+  if (inputText || textMap) {
+    this.filterColumn(colIndex, inputText, textMap);
   }
 };
 /** Force filtering for a single column by changing filtering text
 * @public
 * @param {number} colIndex
 * @param {string} text
+* @param {Object=} textMap
 */
 
 
-FilterInputPlugin.prototype.filterColumn = function (colIndex, text) {
-  var option = this._updateColumnOption(colIndex, text);
+FilterInputPlugin.prototype.filterColumn = function (colIndex, text, textMap) {
+  var option = this._updateColumnOption(colIndex, text, textMap);
 
   if (!option) {
     return;
@@ -879,7 +925,9 @@ FilterInputPlugin.prototype._setColumnFilter = function (colIndex, filterOptions
       proc.removeColumnFilters(colIndex); // TODO: this is slow
     }
 
-    if (filterOptions._comparingLogic && filterOptions.inputText) {
+    var hasFilterContent = filterOptions.inputText || filterOptions.textMap;
+
+    if (filterOptions._comparingLogic && hasFilterContent) {
       var columnFilter = filterOptions._columnFilter;
 
       if (!columnFilter) {
@@ -911,13 +959,17 @@ FilterInputPlugin.prototype._onInputChanged = function (e) {
   var colIndex = pos.colIndex;
   var input =
   /** @type{Element} */
-  e.currentTarget; // If selected No Filter option - remove select filter
-
-  if (input.value === "No Filter" && input.tagName.indexOf("SELECT") >= 0) {
-    input.value = null;
+  e.currentTarget;
+  var filterValue = input.value;
+  var textMap; // If selected No Filter option - remove select filter
+
+  if (filterValue === "No Filter" && input.tagName.indexOf("SELECT") >= 0) {
+    filterValue = null;
+  } else if (input.tagName.indexOf("COMBO-BOX") >= 0) {
+    textMap = FilterInputPlugin._createMapObject(input.values);
   }
 
-  this.filterColumn(colIndex, input.value);
+  this.filterColumn(colIndex, filterValue, textMap);
 };
 /** @private
 * @param {Object=} e
@@ -969,6 +1021,49 @@ FilterInputPlugin._compareRow = function (filterOptions, rowData, rid) {
 FilterInputPlugin._rtCompareRow = function (filterOptions, rowData, rid) {
   return filterOptions._comparingLogic(filterOptions._filterArguments, rowData["ROW_DEF"].getRowData());
 };
+/** @private
+* @function
+* @param {Array<string>} ary
+* @return {Object}
+*/
+
+
+FilterInputPlugin._createMapObject = function (ary) {
+  var textMap = {};
+
+  if (ary) {
+    var count = ary.length;
+
+    for (var i = 0; i < count; i++) {
+      var str = ary[i].toLowerCase();
+      textMap[str] = true;
+    }
+  }
+
+  return textMap;
+};
+/** @private
+* @function
+* @param {Object} data
+* @return {string}
+*/
+
+
+FilterInputPlugin._transformToLowercaseString = function (data) {
+  var dataStr = "";
+
+  if (typeof data != "string") {
+    if (data instanceof Date) {
+      dataStr = data.toDateString().toLowerCase();
+    } else {
+      dataStr = (data + "").toLocaleLowerCase;
+    }
+  } else if (data) {
+    dataStr = data.toLowerCase();
+  }
+
+  return dataStr;
+};
 /** Default Filter Logic
 * @private
 * @function
@@ -986,17 +1081,7 @@ FilterInputPlugin._containingFilter = function (e, rowData) {
     var data = rowData[e.field];
 
     if (data != null) {
-      var dataStr;
-
-      if (typeof data != "string") {
-        if (data instanceof Date) {
-          dataStr = data.toDateString().toLowerCase();
-        } else {
-          dataStr = data + "";
-        }
-      } else if (data) {
-        dataStr = data.toLowerCase();
-      }
+      var dataStr = FilterInputPlugin._transformToLowercaseString(data);
 
       if (dataStr) {
         if (eventType === "number") {
@@ -1014,6 +1099,34 @@ FilterInputPlugin._containingFilter = function (e, rowData) {
 
   return true;
 };
+/** Filter Logic for multi selection input
+* @private
+* @function
+* @param {Object} e Filter argument
+* @param {Object} rowData
+* @return {boolean}
+*/
+
+
+FilterInputPlugin._multiSelectionFilter = function (e, rowData) {
+  var inputMap = e.textMap;
+
+  if (inputMap) {
+    var data = rowData[e.field];
+
+    if (data != null) {
+      var dataStr = FilterInputPlugin._transformToLowercaseString(data);
+
+      if (dataStr) {
+        return inputMap[dataStr] ? true : false;
+      }
+    }
+
+    return false;
+  }
+
+  return true;
+};
 
 export default FilterInputPlugin;
 export { FilterInputPlugin, FilterInputPlugin as FilterInput, FilterInputPlugin as FilterInputExtension };

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

@@ -3,7 +3,7 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace CoralButtonFormatter {
 
     type Options = {
-        label?: string
+        label?: string|null
     };
 
 }
@@ -12,7 +12,7 @@ declare class CoralButtonFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralButtonFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralButtonFormatter.Options|any)|null): any;
 
 }
 

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

@@ -4,7 +4,7 @@ declare class CoralCheckboxFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }
 

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

@@ -4,9 +4,9 @@ import ElfUtil from "../../tr-grid-util/es6/ElfUtil.js";
 declare namespace CoralComboBoxFormatter {
 
     type Options = {
-        data?: any[],
-        entries?: any[],
-        items?: any[]
+        data?: any[]|null,
+        entries?: any[]|null,
+        items?: any[]|null
     };
 
 }
@@ -15,7 +15,7 @@ declare class CoralComboBoxFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralComboBoxFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralComboBoxFormatter.Options|any)|null): any;
 
 }
 

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

@@ -3,8 +3,8 @@ import FormatterBuilder from "./FormatterBuilder.js";
 declare namespace CoralIconFormatter {
 
     type Options = {
-        icon?: (string|any),
-        size?: (number|string)
+        icon?: (string|any)|null,
+        size?: (number|string)|null
     };
 
 }
@@ -13,7 +13,7 @@ declare class CoralIconFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|CoralIconFormatter.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|CoralIconFormatter.Options|any)|null): any;
 
 }
 

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

@@ -4,7 +4,7 @@ declare class CoralInputFormatter {
 
     constructor(options?: any);
 
-    public static create(options?: (FormatterBuilder.Options|any)): any;
+    public static create(options?: (FormatterBuilder.Options|any)|null): any;
 
 }