@itwin/components-react 4.0.0-dev.3 → 4.0.0-dev.6

package/lib/esm/components-react/table/columnfiltering/DataGridFilterParser.js

@@ -0,0 +1,189 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module Table
+ */
+import { Logger } from "@itwin/core-bentley";
+import { Timer } from "@itwin/core-react";
+import { UiComponents } from "../../UiComponents";
+import { FilterRenderer } from "../TableDataProvider";
+import { FilterCompositionLogicalOperator, FilterOperator } from "./ColumnFiltering";
+/** ReactDataGrid NumericFilter type
+ * @internal
+ */
+export var NumericFilterType;
+(function (NumericFilterType) {
+    NumericFilterType[NumericFilterType["ExactMatch"] = 1] = "ExactMatch";
+    NumericFilterType[NumericFilterType["Range"] = 2] = "Range";
+    NumericFilterType[NumericFilterType["GreaterThan"] = 3] = "GreaterThan";
+    NumericFilterType[NumericFilterType["LessThan"] = 4] = "LessThan";
+})(NumericFilterType || (NumericFilterType = {}));
+/** @internal */
+export const FILTER_PARSER_TIMER_TIMEOUT = 250;
+/** ReactDataGrid Filter Parser
+ * @internal
+ */
+export class DataGridFilterParser {
+    static get timerTimeout() { return DataGridFilterParser._timerTimeout; }
+    static set timerTimeout(v) { DataGridFilterParser._timerTimeout = v; }
+    static async handleFilterChange(filter, filterDescriptor, columnDescription, onApplyFilter) {
+        filterDescriptor.clear();
+        if (columnDescription.filterRenderer !== undefined) {
+            switch (columnDescription.filterRenderer) {
+                case FilterRenderer.MultiSelect:
+                    await DataGridFilterParser.parseMultiSelect(filter, filterDescriptor, onApplyFilter);
+                    break;
+                case FilterRenderer.MultiValue:
+                    await DataGridFilterParser.parseMultiValue(filter, filterDescriptor, onApplyFilter);
+                    break;
+                case FilterRenderer.SingleSelect:
+                    await DataGridFilterParser.parseSingleSelect(filter, filterDescriptor, onApplyFilter);
+                    break;
+                case FilterRenderer.Numeric:
+                    await DataGridFilterParser.parseNumeric(filter, filterDescriptor, onApplyFilter);
+                    break;
+                case FilterRenderer.Text:
+                    await DataGridFilterParser.parseText(filter, filterDescriptor, onApplyFilter);
+                    break;
+            }
+        }
+        else {
+            await DataGridFilterParser.parseText(filter, filterDescriptor, onApplyFilter);
+        }
+    }
+    static async parseMultiSelect(filter, filterDescriptor, onApplyFilter) {
+        /*
+        MultiSelect filters
+        0: {value: "Title 1", label: "Title 1"}
+        1: {value: "Title 100", label: "Title 100"}
+        2: {value: "Title 10000", label: "Title 10000"}
+        length: 3
+        */
+        // istanbul ignore else
+        if (filter.filterTerm) {
+            const filterData = filter.filterTerm;
+            if (filterData.length) {
+                filterData.forEach((distinctValue) => {
+                    filterDescriptor.distinctFilter.addDistinctValue(distinctValue.value);
+                });
+            }
+        }
+        await onApplyFilter();
+    }
+    static async parseMultiValue(filter, filterDescriptor, onApplyFilter) {
+        /*
+        MultiValue filters
+          distinctValues
+            length: 3
+            0: {value: "Title 1", label: "Title 1"}
+            1: {value: "Title 100", label: "Title 100"}
+            2: {value: "Title 10000", label: "Title 10000"}
+          fieldValues
+            length: 1
+            0: {value: any, operator: FilterOperator, isCaseSensitive?: boolean}
+          logicalOperator: FilterCompositionLogicalOperator
+        */
+        // istanbul ignore else
+        if (filter.filterTerm) {
+            const filterData = filter.filterTerm;
+            if (filterData.distinctValues.length) {
+                filterData.distinctValues.forEach((distinctValue) => {
+                    filterDescriptor.distinctFilter.addDistinctValue(distinctValue.value);
+                });
+            }
+            if (filterData.fieldValues.length) {
+                filterData.fieldValues.forEach((fieldData) => {
+                    filterDescriptor.fieldFilter.addFieldValue(fieldData.fieldValue, fieldData.operator, fieldData.isCaseSensitive);
+                });
+                filterDescriptor.fieldFilter.logicalOperator = filterData.fieldLogicalOperator;
+            }
+        }
+        await onApplyFilter();
+    }
+    static async parseSingleSelect(filter, filterDescriptor, onApplyFilter) {
+        /*
+        SingleSelect filters
+        filter.filterTerm: {value: 1, label: "Red"}
+        */
+        // istanbul ignore else
+        if (filter.filterTerm) {
+            const filterData = filter.filterTerm;
+            filterDescriptor.distinctFilter.addDistinctValue(filterData.value);
+        }
+        await onApplyFilter();
+    }
+    static async parseNumeric(filter, filterDescriptor, onApplyFilter) {
+        /*
+        NumericFilter
+        0: {type: 2, begin: 1, end: 10} // range
+        1: {type: 1, value: 15} // Exact match
+        2: {type: 3, value: 30} // > 30
+        3: {type: 4, value: 5}  // < 5
+        length: 4
+        */
+        if (filter.filterTerm) {
+            this._numericTimer.setOnExecute(async () => {
+                const filterData = filter.filterTerm;
+                if (filterData.length) {
+                    filterDescriptor.fieldFilter.logicalOperator = FilterCompositionLogicalOperator.Or;
+                    filterData.forEach((numericFilterData) => {
+                        switch (numericFilterData.type) {
+                            case NumericFilterType.ExactMatch:
+                                const exactMatchData = numericFilterData;
+                                filterDescriptor.fieldFilter.addFieldValue(exactMatchData.value, FilterOperator.IsEqualTo);
+                                break;
+                            case NumericFilterType.GreaterThan:
+                                const greaterThanData = numericFilterData;
+                                filterDescriptor.fieldFilter.addFieldValue(greaterThanData.value, FilterOperator.IsGreaterThan);
+                                break;
+                            case NumericFilterType.LessThan:
+                                const lessThanData = numericFilterData;
+                                filterDescriptor.fieldFilter.addFieldValue(lessThanData.value, FilterOperator.IsLessThan);
+                                break;
+                            case NumericFilterType.Range:
+                                const rangeData = numericFilterData;
+                                filterDescriptor.fieldFilter.addFieldValue(rangeData, FilterOperator.Range);
+                                break;
+                            default:
+                                Logger.logError(UiComponents.loggerCategory(this), `parseNumeric: Unknown numeric filter data type - ${numericFilterData.type}`);
+                                break;
+                        }
+                    });
+                    await onApplyFilter();
+                }
+            });
+            this._numericTimer.delay = DataGridFilterParser._timerTimeout;
+            this._numericTimer.start();
+        }
+        else {
+            this._numericTimer.stop();
+            await onApplyFilter();
+        }
+    }
+    static async parseText(filter, filterDescriptor, onApplyFilter) {
+        /*
+        Input filter
+        filter.filterTerm: 1000
+        */
+        if (filter.filterTerm) {
+            this._textTimer.setOnExecute(async () => {
+                const filterData = filter.filterTerm;
+                filterDescriptor.fieldFilter.addFieldValue(filterData, FilterOperator.Contains, false);
+                await onApplyFilter();
+            });
+            this._textTimer.delay = DataGridFilterParser._timerTimeout;
+            this._textTimer.start();
+        }
+        else {
+            this._textTimer.stop();
+            await onApplyFilter();
+        }
+    }
+}
+DataGridFilterParser._timerTimeout = FILTER_PARSER_TIMER_TIMEOUT;
+DataGridFilterParser._textTimer = new Timer(DataGridFilterParser._timerTimeout);
+DataGridFilterParser._numericTimer = new Timer(DataGridFilterParser._timerTimeout);
+//# sourceMappingURL=DataGridFilterParser.js.map

package/lib/esm/components-react/table/columnfiltering/DataGridFilterParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataGridFilterParser.js","sourceRoot":"","sources":["../../../../../src/components-react/table/columnfiltering/DataGridFilterParser.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAqB,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAA0B,gCAAgC,EAAE,cAAc,EAAsB,MAAM,mBAAmB,CAAC;AAOjI;;GAEG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,qEAAc,CAAA;IACd,2DAAS,CAAA;IACT,uEAAe,CAAA;IACf,iEAAY,CAAA;AACd,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA2DD,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAKxB,MAAM,KAAK,YAAY,KAAa,OAAO,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC;IAChF,MAAM,KAAK,YAAY,CAAC,CAAS,IAAI,oBAAoB,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC;IAE9E,MAAM,CAAC,KAAK,CAAC,kBAAkB,CACpC,MAA2B,EAC3B,gBAAwC,EACxC,iBAAoC,EACpC,aAAkC;QAGlC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAEzB,IAAI,iBAAiB,CAAC,cAAc,KAAK,SAAS,EAAE;YAClD,QAAQ,iBAAiB,CAAC,cAAc,EAAE;gBACxC,KAAK,cAAc,CAAC,WAAW;oBAC7B,MAAM,oBAAoB,CAAC,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC;oBACrF,MAAM;gBACR,KAAK,cAAc,CAAC,UAAU;oBAC5B,MAAM,oBAAoB,CAAC,eAAe,CAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC;oBACpF,MAAM;gBACR,KAAK,cAAc,CAAC,YAAY;oBAC9B,MAAM,oBAAoB,CAAC,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC;oBACtF,MAAM;gBACR,KAAK,cAAc,CAAC,OAAO;oBACzB,MAAM,oBAAoB,CAAC,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC;oBACjF,MAAM;gBACR,KAAK,cAAc,CAAC,IAAI;oBACtB,MAAM,oBAAoB,CAAC,SAAS,CAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC;oBAC9E,MAAM;aACT;SACF;aAAM;YACL,MAAM,oBAAoB,CAAC,SAAS,CAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC;SAC/E;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAA2B,EAAE,gBAAwC,EAAE,aAAkC;QAC7I;;;;;;UAME;QACF,uBAAuB;QACvB,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,UAA6C,CAAC;YACxE,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,UAAU,CAAC,OAAO,CAAC,CAAC,aAAiC,EAAE,EAAE;oBACvD,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBACxE,CAAC,CAAC,CAAC;aACJ;SACF;QACD,MAAM,aAAa,EAAE,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAA2B,EAAE,gBAAwC,EAAE,aAAkC;QAC5I;;;;;;;;;;;UAWE;QACF,uBAAuB;QACvB,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,UAA6C,CAAC;YACxE,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE;gBACpC,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,aAAiC,EAAE,EAAE;oBACtE,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBACxE,CAAC,CAAC,CAAC;aACJ;YACD,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,EAAE;gBACjC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,SAA0B,EAAE,EAAE;oBAC5D,gBAAgB,CAAC,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;gBAClH,CAAC,CAAC,CAAC;gBACH,gBAAgB,CAAC,WAAW,CAAC,eAAe,GAAG,UAAU,CAAC,oBAAoB,CAAC;aAChF;SACF;QACD,MAAM,aAAa,EAAE,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,MAA2B,EAAE,gBAAwC,EAAE,aAAkC;QAC9I;;;UAGE;QACF,uBAAuB;QACvB,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,UAA2C,CAAC;YACtE,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SACpE;QACD,MAAM,aAAa,EAAE,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAA2B,EAAE,gBAAwC,EAAE,aAAkC;QACzI;;;;;;;UAOE;QACF,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;gBACzC,MAAM,UAAU,GAAG,MAAM,CAAC,UAA4C,CAAC;gBACvE,IAAI,UAAU,CAAC,MAAM,EAAE;oBACrB,gBAAgB,CAAC,WAAW,CAAC,eAAe,GAAG,gCAAgC,CAAC,EAAE,CAAC;oBAEnF,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAoC,EAAE,EAAE;wBAC1D,QAAQ,iBAAiB,CAAC,IAAI,EAAE;4BAC9B,KAAK,iBAAiB,CAAC,UAAU;gCAC/B,MAAM,cAAc,GAAG,iBAAqD,CAAC;gCAC7E,gBAAgB,CAAC,WAAW,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;gCAC3F,MAAM;4BACR,KAAK,iBAAiB,CAAC,WAAW;gCAChC,MAAM,eAAe,GAAG,iBAAsD,CAAC;gCAC/E,gBAAgB,CAAC,WAAW,CAAC,aAAa,CAAC,eAAe,CAAC,KAAK,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC;gCAChG,MAAM;4BACR,KAAK,iBAAiB,CAAC,QAAQ;gCAC7B,MAAM,YAAY,GAAG,iBAAmD,CAAC;gCACzE,gBAAgB,CAAC,WAAW,CAAC,aAAa,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;gCAC1F,MAAM;4BACR,KAAK,iBAAiB,CAAC,KAAK;gCAC1B,MAAM,SAAS,GAAG,iBAAgD,CAAC;gCACnE,gBAAgB,CAAC,WAAW,CAAC,aAAa,CAAC,SAAS,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;gCAC5E,MAAM;4BACR;gCACE,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oDAAoD,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC;gCACjI,MAAM;yBACT;oBACH,CAAC,CAAC,CAAC;oBACH,MAAM,aAAa,EAAE,CAAC;iBACvB;YACH,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC;YAC9D,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;SAC5B;aAAM;YACL,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAC1B,MAAM,aAAa,EAAE,CAAC;SACvB;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAA2B,EAAE,gBAAwC,EAAE,aAAkC;QACtI;;;UAGE;QACF,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;gBACtC,MAAM,UAAU,GAAG,MAAM,CAAC,UAA+B,CAAC;gBAC1D,gBAAgB,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACvF,MAAM,aAAa,EAAE,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC;YAC3D,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;SACzB;aAAM;YACL,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YACvB,MAAM,aAAa,EAAE,CAAC;SACvB;IACH,CAAC;;AA3Kc,kCAAa,GAAG,2BAA2B,CAAC;AAC5C,+BAAU,GAAU,IAAI,KAAK,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAClE,kCAAa,GAAU,IAAI,KAAK,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module Table\r\n */\r\n\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { Timer } from \"@itwin/core-react\";\r\nimport ReactDataGrid from \"react-data-grid\";\r\nimport { UiComponents } from \"../../UiComponents\";\r\nimport { TableColumn } from \"../component/TableColumn\";\r\nimport { ColumnDescription, FilterRenderer } from \"../TableDataProvider\";\r\nimport { ColumnFilterDescriptor, FilterCompositionLogicalOperator, FilterOperator, TableDistinctValue } from \"./ColumnFiltering\";\r\n\r\n/** @internal */\r\nexport interface ReactDataGridFilter extends ReactDataGrid.Filter {\r\n  column: TableColumn;\r\n}\r\n\r\n/** ReactDataGrid NumericFilter type\r\n * @internal\r\n */\r\nexport enum NumericFilterType {\r\n  ExactMatch = 1,\r\n  Range = 2,\r\n  GreaterThan = 3,\r\n  LessThan = 4,\r\n}\r\n\r\n/** NumericFilter data\r\n * @internal\r\n */\r\nexport interface NumericFilterData {\r\n  type: number;\r\n}\r\n\r\n/** Numeric Exact Match data\r\n * @internal\r\n */\r\nexport interface NumericExactMatchData {\r\n  type: NumericFilterType.ExactMatch;\r\n  value: number;\r\n}\r\n\r\n/** Numeric Range data\r\n * @internal\r\n */\r\nexport interface NumericRangeData {\r\n  type: NumericFilterType.Range;\r\n  begin: number;\r\n  end: number;\r\n}\r\n\r\n/** Numeric Greater Than data\r\n * @internal\r\n */\r\nexport interface NumericGreaterThanData {\r\n  type: NumericFilterType.GreaterThan;\r\n  value: number;\r\n}\r\n\r\n/** Numeric Less Than data\r\n * @internal\r\n */\r\nexport interface NumericLessThanData {\r\n  type: NumericFilterType.LessThan;\r\n  value: number;\r\n}\r\n\r\n/** @internal */\r\nexport type NumericFilterRule = NumericExactMatchData | NumericRangeData | NumericGreaterThanData | NumericLessThanData;\r\n\r\n/** @internal */\r\nexport interface FieldFilterData {\r\n  fieldValue: any;\r\n  operator: FilterOperator;\r\n  isCaseSensitive?: boolean;\r\n}\r\n\r\n/** @internal */\r\nexport interface MultiValueFilterData {\r\n  distinctValues: TableDistinctValue[];\r\n  fieldValues: FieldFilterData[];\r\n  fieldLogicalOperator: FilterCompositionLogicalOperator;\r\n}\r\n\r\n/** @internal */\r\nexport const FILTER_PARSER_TIMER_TIMEOUT = 250;\r\n\r\n/** ReactDataGrid Filter Parser\r\n * @internal\r\n */\r\nexport class DataGridFilterParser {\r\n  private static _timerTimeout = FILTER_PARSER_TIMER_TIMEOUT;\r\n  private static _textTimer: Timer = new Timer(DataGridFilterParser._timerTimeout);\r\n  private static _numericTimer: Timer = new Timer(DataGridFilterParser._timerTimeout);\r\n\r\n  public static get timerTimeout(): number { return DataGridFilterParser._timerTimeout; }\r\n  public static set timerTimeout(v: number) { DataGridFilterParser._timerTimeout = v; }\r\n\r\n  public static async handleFilterChange(\r\n    filter: ReactDataGridFilter,\r\n    filterDescriptor: ColumnFilterDescriptor,\r\n    columnDescription: ColumnDescription,\r\n    onApplyFilter: () => Promise<void>,\r\n  ): Promise<void> {\r\n\r\n    filterDescriptor.clear();\r\n\r\n    if (columnDescription.filterRenderer !== undefined) {\r\n      switch (columnDescription.filterRenderer) {\r\n        case FilterRenderer.MultiSelect:\r\n          await DataGridFilterParser.parseMultiSelect(filter, filterDescriptor, onApplyFilter);\r\n          break;\r\n        case FilterRenderer.MultiValue:\r\n          await DataGridFilterParser.parseMultiValue(filter, filterDescriptor, onApplyFilter);\r\n          break;\r\n        case FilterRenderer.SingleSelect:\r\n          await DataGridFilterParser.parseSingleSelect(filter, filterDescriptor, onApplyFilter);\r\n          break;\r\n        case FilterRenderer.Numeric:\r\n          await DataGridFilterParser.parseNumeric(filter, filterDescriptor, onApplyFilter);\r\n          break;\r\n        case FilterRenderer.Text:\r\n          await DataGridFilterParser.parseText(filter, filterDescriptor, onApplyFilter);\r\n          break;\r\n      }\r\n    } else {\r\n      await DataGridFilterParser.parseText(filter, filterDescriptor, onApplyFilter);\r\n    }\r\n  }\r\n\r\n  private static async parseMultiSelect(filter: ReactDataGridFilter, filterDescriptor: ColumnFilterDescriptor, onApplyFilter: () => Promise<void>): Promise<void> {\r\n    /*\r\n    MultiSelect filters\r\n    0: {value: \"Title 1\", label: \"Title 1\"}\r\n    1: {value: \"Title 100\", label: \"Title 100\"}\r\n    2: {value: \"Title 10000\", label: \"Title 10000\"}\r\n    length: 3\r\n    */\r\n    // istanbul ignore else\r\n    if (filter.filterTerm) {\r\n      const filterData = filter.filterTerm as unknown as TableDistinctValue[];\r\n      if (filterData.length) {\r\n        filterData.forEach((distinctValue: TableDistinctValue) => {\r\n          filterDescriptor.distinctFilter.addDistinctValue(distinctValue.value);\r\n        });\r\n      }\r\n    }\r\n    await onApplyFilter();\r\n  }\r\n\r\n  private static async parseMultiValue(filter: ReactDataGridFilter, filterDescriptor: ColumnFilterDescriptor, onApplyFilter: () => Promise<void>): Promise<void> {\r\n    /*\r\n    MultiValue filters\r\n      distinctValues\r\n        length: 3\r\n        0: {value: \"Title 1\", label: \"Title 1\"}\r\n        1: {value: \"Title 100\", label: \"Title 100\"}\r\n        2: {value: \"Title 10000\", label: \"Title 10000\"}\r\n      fieldValues\r\n        length: 1\r\n        0: {value: any, operator: FilterOperator, isCaseSensitive?: boolean}\r\n      logicalOperator: FilterCompositionLogicalOperator\r\n    */\r\n    // istanbul ignore else\r\n    if (filter.filterTerm) {\r\n      const filterData = filter.filterTerm as unknown as MultiValueFilterData;\r\n      if (filterData.distinctValues.length) {\r\n        filterData.distinctValues.forEach((distinctValue: TableDistinctValue) => {\r\n          filterDescriptor.distinctFilter.addDistinctValue(distinctValue.value);\r\n        });\r\n      }\r\n      if (filterData.fieldValues.length) {\r\n        filterData.fieldValues.forEach((fieldData: FieldFilterData) => {\r\n          filterDescriptor.fieldFilter.addFieldValue(fieldData.fieldValue, fieldData.operator, fieldData.isCaseSensitive);\r\n        });\r\n        filterDescriptor.fieldFilter.logicalOperator = filterData.fieldLogicalOperator;\r\n      }\r\n    }\r\n    await onApplyFilter();\r\n  }\r\n\r\n  private static async parseSingleSelect(filter: ReactDataGridFilter, filterDescriptor: ColumnFilterDescriptor, onApplyFilter: () => Promise<void>): Promise<void> {\r\n    /*\r\n    SingleSelect filters\r\n    filter.filterTerm: {value: 1, label: \"Red\"}\r\n    */\r\n    // istanbul ignore else\r\n    if (filter.filterTerm) {\r\n      const filterData = filter.filterTerm as unknown as TableDistinctValue;\r\n      filterDescriptor.distinctFilter.addDistinctValue(filterData.value);\r\n    }\r\n    await onApplyFilter();\r\n  }\r\n\r\n  private static async parseNumeric(filter: ReactDataGridFilter, filterDescriptor: ColumnFilterDescriptor, onApplyFilter: () => Promise<void>): Promise<void> {\r\n    /*\r\n    NumericFilter\r\n    0: {type: 2, begin: 1, end: 10} // range\r\n    1: {type: 1, value: 15} // Exact match\r\n    2: {type: 3, value: 30} // > 30\r\n    3: {type: 4, value: 5}  // < 5\r\n    length: 4\r\n    */\r\n    if (filter.filterTerm) {\r\n      this._numericTimer.setOnExecute(async () => {\r\n        const filterData = filter.filterTerm as unknown as NumericFilterData[];\r\n        if (filterData.length) {\r\n          filterDescriptor.fieldFilter.logicalOperator = FilterCompositionLogicalOperator.Or;\r\n\r\n          filterData.forEach((numericFilterData: NumericFilterData) => {\r\n            switch (numericFilterData.type) {\r\n              case NumericFilterType.ExactMatch:\r\n                const exactMatchData = numericFilterData as unknown as NumericExactMatchData;\r\n                filterDescriptor.fieldFilter.addFieldValue(exactMatchData.value, FilterOperator.IsEqualTo);\r\n                break;\r\n              case NumericFilterType.GreaterThan:\r\n                const greaterThanData = numericFilterData as unknown as NumericGreaterThanData;\r\n                filterDescriptor.fieldFilter.addFieldValue(greaterThanData.value, FilterOperator.IsGreaterThan);\r\n                break;\r\n              case NumericFilterType.LessThan:\r\n                const lessThanData = numericFilterData as unknown as NumericLessThanData;\r\n                filterDescriptor.fieldFilter.addFieldValue(lessThanData.value, FilterOperator.IsLessThan);\r\n                break;\r\n              case NumericFilterType.Range:\r\n                const rangeData = numericFilterData as unknown as NumericRangeData;\r\n                filterDescriptor.fieldFilter.addFieldValue(rangeData, FilterOperator.Range);\r\n                break;\r\n              default:\r\n                Logger.logError(UiComponents.loggerCategory(this), `parseNumeric: Unknown numeric filter data type - ${numericFilterData.type}`);\r\n                break;\r\n            }\r\n          });\r\n          await onApplyFilter();\r\n        }\r\n      });\r\n\r\n      this._numericTimer.delay = DataGridFilterParser._timerTimeout;\r\n      this._numericTimer.start();\r\n    } else {\r\n      this._numericTimer.stop();\r\n      await onApplyFilter();\r\n    }\r\n  }\r\n\r\n  private static async parseText(filter: ReactDataGridFilter, filterDescriptor: ColumnFilterDescriptor, onApplyFilter: () => Promise<void>): Promise<void> {\r\n    /*\r\n    Input filter\r\n    filter.filterTerm: 1000\r\n    */\r\n    if (filter.filterTerm) {\r\n      this._textTimer.setOnExecute(async () => {\r\n        const filterData = filter.filterTerm as unknown as string;\r\n        filterDescriptor.fieldFilter.addFieldValue(filterData, FilterOperator.Contains, false);\r\n        await onApplyFilter();\r\n      });\r\n\r\n      this._textTimer.delay = DataGridFilterParser._timerTimeout;\r\n      this._textTimer.start();\r\n    } else {\r\n      this._textTimer.stop();\r\n      await onApplyFilter();\r\n    }\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/components-react/table/columnfiltering/FilterableColumnBase.d.ts

@@ -0,0 +1,58 @@
+/** @packageDocumentation
+ * @module Table
+ */
+import { ColumnDescription } from "../TableDataProvider";
+import { ColumnFilterDescriptor, DistinctValueCollection, FilterableColumn, FilterableTable, FilterOperator } from "./ColumnFiltering";
+import { TableFilterDescriptor } from "./TableFilterDescriptor";
+/** Filterable Column base class.
+ * @internal
+ */
+export declare abstract class FilterableColumnBase implements FilterableColumn {
+    private _columnDescription;
+    private _filterable;
+    private _showFieldFilters;
+    private _showDistinctValueFilters;
+    private _filterCaseSensitive;
+    private _filterableTable;
+    constructor(filterableTable: FilterableTable, description: ColumnDescription);
+    /** Indicates whether column is filterable.
+     */
+    get filterable(): boolean;
+    /** Gets the owning filterable Table.
+     */
+    get filterableTable(): FilterableTable;
+    /** Gets the Column Description.
+     */
+    get columnDescription(): ColumnDescription;
+    /** Gets the column filter descriptor.
+     * @return A class implementing IColumnFilterDescriptor.
+     */
+    get columnFilterDescriptor(): ColumnFilterDescriptor;
+    /** Creates the column filter descriptor.
+     * @return A new class implementing ColumnFilterDescriptor.
+     */
+    protected createColumnFilterDescriptor(): ColumnFilterDescriptor;
+    /** Creates a basic filter descriptor for use .
+     * @return A new FilterDescriptor.
+     */
+    createSimpleFilterDescriptor(value: any, filterOperator: FilterOperator): TableFilterDescriptor;
+    /** Gets the filter member key.
+     */
+    get filterMemberKey(): string;
+    /** Gets the filter member type.
+     */
+    get filterMemberType(): string;
+    /** Determines if a filter is active. */
+    get isFilterActive(): boolean;
+    /** Determines if the filter should show distinct values as a filter option */
+    get showDistinctValueFilters(): boolean;
+    /** Determines if the filter should show field filter options */
+    get showFieldFilters(): boolean;
+    /** Determines if the filter is case-sensitive */
+    get filterCaseSensitive(): boolean;
+    /** Gets the distinct values for a column.
+     * @return The distinct values.
+     */
+    abstract getDistinctValues(maximumValueCount: number): Promise<DistinctValueCollection>;
+}
+//# sourceMappingURL=FilterableColumnBase.d.ts.map

package/lib/esm/components-react/table/columnfiltering/FilterableColumnBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilterableColumnBase.d.ts","sourceRoot":"","sources":["../../../../../src/components-react/table/columnfiltering/FilterableColumnBase.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEvI,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGhE;;GAEG;AACH,8BAAsB,oBAAqB,YAAW,gBAAgB;IACpE,OAAO,CAAC,kBAAkB,CAAoB;IAE9C,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,iBAAiB,CAAU;IACnC,OAAO,CAAC,yBAAyB,CAAU;IAC3C,OAAO,CAAC,oBAAoB,CAAU;IAEtC,OAAO,CAAC,gBAAgB,CAAkB;gBAE9B,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB;IAkB5E;OACG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;OACG;IACH,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED;OACG;IACH,IAAW,iBAAiB,IAAI,iBAAiB,CAEhD;IAED;;OAEG;IACH,IAAW,sBAAsB,IAAI,sBAAsB,CAS1D;IAED;;OAEG;IACH,SAAS,CAAC,4BAA4B,IAAI,sBAAsB;IAIhE;;OAEG;IACI,4BAA4B,CAAC,KAAK,EAAE,GAAG,EAAE,cAAc,EAAE,cAAc,GAAG,qBAAqB;IAItG;OACG;IACH,IAAW,eAAe,IAAI,MAAM,CAEnC;IAED;OACG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAMpC;IAED,wCAAwC;IACxC,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,8EAA8E;IAC9E,IAAW,wBAAwB,IAAI,OAAO,CAE7C;IAED,gEAAgE;IAChE,IAAW,gBAAgB,IAAI,OAAO,CAErC;IAED,iDAAiD;IACjD,IAAW,mBAAmB,IAAI,OAAO,CAExC;IAED;;OAEG;aACa,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAE/F"}

package/lib/esm/components-react/table/columnfiltering/FilterableColumnBase.js

@@ -0,0 +1,100 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Table
+ */
+import { TableColumnFilterDescriptor } from "./TableColumnFilterDescriptor";
+import { TableFilterDescriptor } from "./TableFilterDescriptor";
+/* eslint-disable deprecation/deprecation */
+/** Filterable Column base class.
+ * @internal
+ */
+export class FilterableColumnBase {
+    constructor(filterableTable, description) {
+        this._filterable = false;
+        this._filterableTable = filterableTable;
+        this._columnDescription = description;
+        this._filterable = (description.filterable === undefined) ? false : description.filterable;
+        this._showFieldFilters = (description.showFieldFilters === undefined) ? true : description.showFieldFilters;
+        this._showDistinctValueFilters = (description.showDistinctValueFilters === undefined) ? true : description.showDistinctValueFilters;
+        this._filterCaseSensitive = (description.filterCaseSensitive === undefined) ? false : description.filterCaseSensitive;
+        if (!this._columnDescription.propertyDescription) {
+            this._columnDescription.propertyDescription = {
+                name: "",
+                displayLabel: "",
+                typename: "",
+            };
+        }
+    }
+    /** Indicates whether column is filterable.
+     */
+    get filterable() {
+        return this._filterable;
+    }
+    /** Gets the owning filterable Table.
+     */
+    get filterableTable() {
+        return this._filterableTable;
+    }
+    /** Gets the Column Description.
+     */
+    get columnDescription() {
+        return this._columnDescription;
+    }
+    /** Gets the column filter descriptor.
+     * @return A class implementing IColumnFilterDescriptor.
+     */
+    get columnFilterDescriptor() {
+        let columnFilterDescriptor = this._filterableTable.filterDescriptors.getColumnFilterDescriptor(this.filterMemberKey);
+        if (undefined === columnFilterDescriptor) {
+            columnFilterDescriptor = this.createColumnFilterDescriptor();
+            this._filterableTable.filterDescriptors.add(columnFilterDescriptor);
+        }
+        return columnFilterDescriptor;
+    }
+    /** Creates the column filter descriptor.
+     * @return A new class implementing ColumnFilterDescriptor.
+     */
+    createColumnFilterDescriptor() {
+        return new TableColumnFilterDescriptor(this, this.filterMemberKey, this.filterMemberType);
+    }
+    /** Creates a basic filter descriptor for use .
+     * @return A new FilterDescriptor.
+     */
+    createSimpleFilterDescriptor(value, filterOperator) {
+        return new TableFilterDescriptor(this._filterableTable, this.filterMemberKey, this.filterMemberType, filterOperator, value, this._filterCaseSensitive);
+    }
+    /** Gets the filter member key.
+     */
+    get filterMemberKey() {
+        return this._columnDescription.key;
+    }
+    /** Gets the filter member type.
+     */
+    get filterMemberType() {
+        let memberType = "";
+        // istanbul ignore else
+        if (this._columnDescription.propertyDescription)
+            memberType = this._columnDescription.propertyDescription.typename;
+        return memberType;
+    }
+    /** Determines if a filter is active. */
+    get isFilterActive() {
+        return this._filterableTable.filterDescriptors.isColumnFilterActive(this.filterMemberKey);
+    }
+    /** Determines if the filter should show distinct values as a filter option */
+    get showDistinctValueFilters() {
+        return this._showDistinctValueFilters;
+    }
+    /** Determines if the filter should show field filter options */
+    get showFieldFilters() {
+        return this._showFieldFilters;
+    }
+    /** Determines if the filter is case-sensitive */
+    get filterCaseSensitive() {
+        return this._filterCaseSensitive;
+    }
+}
+//# sourceMappingURL=FilterableColumnBase.js.map

package/lib/esm/components-react/table/columnfiltering/FilterableColumnBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilterableColumnBase.js","sourceRoot":"","sources":["../../../../../src/components-react/table/columnfiltering/FilterableColumnBase.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,4CAA4C;AAE5C;;GAEG;AACH,MAAM,OAAgB,oBAAoB;IAUxC,YAAY,eAAgC,EAAE,WAA8B;QAPpE,gBAAW,GAAY,KAAK,CAAC;QAQnC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,WAAW,CAAC;QAEtC,IAAI,CAAC,WAAW,GAAG,CAAC,WAAW,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC;QAC3F,IAAI,CAAC,iBAAiB,GAAG,CAAC,WAAW,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC;QAC5G,IAAI,CAAC,yBAAyB,GAAG,CAAC,WAAW,CAAC,wBAAwB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC;QACpI,IAAI,CAAC,oBAAoB,GAAG,CAAC,WAAW,CAAC,mBAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC;QAEtH,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,EAAE;YAChD,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,GAAG;gBAC5C,IAAI,EAAE,EAAE;gBACR,YAAY,EAAE,EAAE;gBAChB,QAAQ,EAAE,EAAE;aACb,CAAC;SACH;IACH,CAAC;IAED;OACG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;OACG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;OACG;IACH,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,sBAAsB;QAC/B,IAAI,sBAAsB,GAAG,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,yBAAyB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAErH,IAAI,SAAS,KAAK,sBAAsB,EAAE;YACxC,sBAAsB,GAAG,IAAI,CAAC,4BAA4B,EAAE,CAAC;YAC7D,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;SACrE;QAED,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,4BAA4B;QACpC,OAAO,IAAI,2BAA2B,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,4BAA4B,CAAC,KAAU,EAAE,cAA8B;QAC5E,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,gBAAgB,EAAE,cAAc,EAAE,KAAK,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACzJ,CAAC;IAED;OACG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC;IACrC,CAAC;IAED;OACG;IACH,IAAW,gBAAgB;QACzB,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,uBAAuB;QACvB,IAAI,IAAI,CAAC,kBAAkB,CAAC,mBAAmB;YAC7C,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,QAAQ,CAAC;QACpE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,wCAAwC;IACxC,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5F,CAAC;IAED,8EAA8E;IAC9E,IAAW,wBAAwB;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IAED,gEAAgE;IAChE,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,iDAAiD;IACjD,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;CAOF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Table\r\n */\r\n\r\nimport { ColumnDescription } from \"../TableDataProvider\";\r\nimport { ColumnFilterDescriptor, DistinctValueCollection, FilterableColumn, FilterableTable, FilterOperator } from \"./ColumnFiltering\";\r\nimport { TableColumnFilterDescriptor } from \"./TableColumnFilterDescriptor\";\r\nimport { TableFilterDescriptor } from \"./TableFilterDescriptor\";\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** Filterable Column base class.\r\n * @internal\r\n */\r\nexport abstract class FilterableColumnBase implements FilterableColumn {\r\n  private _columnDescription: ColumnDescription;\r\n\r\n  private _filterable: boolean = false;\r\n  private _showFieldFilters: boolean;\r\n  private _showDistinctValueFilters: boolean;\r\n  private _filterCaseSensitive: boolean;\r\n\r\n  private _filterableTable: FilterableTable;\r\n\r\n  constructor(filterableTable: FilterableTable, description: ColumnDescription) {\r\n    this._filterableTable = filterableTable;\r\n    this._columnDescription = description;\r\n\r\n    this._filterable = (description.filterable === undefined) ? false : description.filterable;\r\n    this._showFieldFilters = (description.showFieldFilters === undefined) ? true : description.showFieldFilters;\r\n    this._showDistinctValueFilters = (description.showDistinctValueFilters === undefined) ? true : description.showDistinctValueFilters;\r\n    this._filterCaseSensitive = (description.filterCaseSensitive === undefined) ? false : description.filterCaseSensitive;\r\n\r\n    if (!this._columnDescription.propertyDescription) {\r\n      this._columnDescription.propertyDescription = {\r\n        name: \"\",\r\n        displayLabel: \"\",\r\n        typename: \"\",\r\n      };\r\n    }\r\n  }\r\n\r\n  /** Indicates whether column is filterable.\r\n   */\r\n  public get filterable(): boolean {\r\n    return this._filterable;\r\n  }\r\n\r\n  /** Gets the owning filterable Table.\r\n   */\r\n  public get filterableTable(): FilterableTable {\r\n    return this._filterableTable;\r\n  }\r\n\r\n  /** Gets the Column Description.\r\n   */\r\n  public get columnDescription(): ColumnDescription {\r\n    return this._columnDescription;\r\n  }\r\n\r\n  /** Gets the column filter descriptor.\r\n   * @return A class implementing IColumnFilterDescriptor.\r\n   */\r\n  public get columnFilterDescriptor(): ColumnFilterDescriptor {\r\n    let columnFilterDescriptor = this._filterableTable.filterDescriptors.getColumnFilterDescriptor(this.filterMemberKey);\r\n\r\n    if (undefined === columnFilterDescriptor) {\r\n      columnFilterDescriptor = this.createColumnFilterDescriptor();\r\n      this._filterableTable.filterDescriptors.add(columnFilterDescriptor);\r\n    }\r\n\r\n    return columnFilterDescriptor;\r\n  }\r\n\r\n  /** Creates the column filter descriptor.\r\n   * @return A new class implementing ColumnFilterDescriptor.\r\n   */\r\n  protected createColumnFilterDescriptor(): ColumnFilterDescriptor {\r\n    return new TableColumnFilterDescriptor(this, this.filterMemberKey, this.filterMemberType);\r\n  }\r\n\r\n  /** Creates a basic filter descriptor for use .\r\n   * @return A new FilterDescriptor.\r\n   */\r\n  public createSimpleFilterDescriptor(value: any, filterOperator: FilterOperator): TableFilterDescriptor {\r\n    return new TableFilterDescriptor(this._filterableTable, this.filterMemberKey, this.filterMemberType, filterOperator, value, this._filterCaseSensitive);\r\n  }\r\n\r\n  /** Gets the filter member key.\r\n   */\r\n  public get filterMemberKey(): string {\r\n    return this._columnDescription.key;\r\n  }\r\n\r\n  /** Gets the filter member type.\r\n   */\r\n  public get filterMemberType(): string {\r\n    let memberType = \"\";\r\n    // istanbul ignore else\r\n    if (this._columnDescription.propertyDescription)\r\n      memberType = this._columnDescription.propertyDescription.typename;\r\n    return memberType;\r\n  }\r\n\r\n  /** Determines if a filter is active. */\r\n  public get isFilterActive(): boolean {\r\n    return this._filterableTable.filterDescriptors.isColumnFilterActive(this.filterMemberKey);\r\n  }\r\n\r\n  /** Determines if the filter should show distinct values as a filter option */\r\n  public get showDistinctValueFilters(): boolean {\r\n    return this._showDistinctValueFilters;\r\n  }\r\n\r\n  /** Determines if the filter should show field filter options */\r\n  public get showFieldFilters(): boolean {\r\n    return this._showFieldFilters;\r\n  }\r\n\r\n  /** Determines if the filter is case-sensitive */\r\n  public get filterCaseSensitive(): boolean {\r\n    return this._filterCaseSensitive;\r\n  }\r\n\r\n  /** Gets the distinct values for a column.\r\n   * @return The distinct values.\r\n   */\r\n  public abstract getDistinctValues(maximumValueCount: number): Promise<DistinctValueCollection>;\r\n\r\n}\r\n"]}

package/lib/esm/components-react/table/columnfiltering/TableColumnFilterDescriptor.d.ts

@@ -0,0 +1,57 @@
+/** @packageDocumentation
+ * @module Table
+ */
+import { RowItem } from "../TableDataProvider";
+import { ColumnFilterDescriptor, DistinctValuesFilterDescriptor, FieldFilterDescriptor, FilterableColumn } from "./ColumnFiltering";
+/** A ColumnFilterDescriptor for TableColumn.
+ * @internal
+ */
+export declare class TableColumnFilterDescriptor implements ColumnFilterDescriptor {
+    private _column;
+    private _compositeFilter;
+    private _distinctFilter;
+    private _fieldFilter;
+    private _memberKey;
+    private _memberType;
+    /** Initializes a new instance of the ColumnFilterDescriptor class.
+     * @param  column      The column.
+     * @param  memberKey   The member (key).
+     * @param  memberType  The member type.
+     */
+    constructor(column: FilterableColumn, memberKey: string, memberType: string);
+    /** Gets the distinct values filter descriptor.
+     */
+    get distinctFilter(): DistinctValuesFilterDescriptor;
+    /** Gets the field filter descriptor.
+     */
+    get fieldFilter(): FieldFilterDescriptor;
+    /** Determines if the filter descriptor is active.
+     */
+    get isActive(): boolean;
+    /** Gets the column.
+     */
+    get column(): FilterableColumn;
+    /** Clears the filter descriptor.
+     */
+    clear(): void;
+    /** Evaluates a row for filtering
+     */
+    evaluateRow(row: RowItem): boolean;
+    /** Determines if this filter is for a particular column.
+     */
+    isFilterForColumn(columnKey: string): boolean;
+    getFilterExpression(): string;
+    /** Gets the member (key).
+     */
+    get memberKey(): string;
+    /** Sets the member (key).
+     */
+    set memberKey(value: string);
+    /** Gets the member type.
+     */
+    get memberType(): string;
+    /** Sets the member type.
+     */
+    set memberType(value: string);
+}
+//# sourceMappingURL=TableColumnFilterDescriptor.d.ts.map

package/lib/esm/components-react/table/columnfiltering/TableColumnFilterDescriptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TableColumnFilterDescriptor.d.ts","sourceRoot":"","sources":["../../../../../src/components-react/table/columnfiltering/TableColumnFilterDescriptor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EACL,sBAAsB,EAAsD,8BAA8B,EAAE,qBAAqB,EAAE,gBAAgB,EAGpJ,MAAM,mBAAmB,CAAC;AAG3B;;GAEG;AACH,qBAAa,2BAA4B,YAAW,sBAAsB;IACxE,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,gBAAgB,CAAgC;IACxD,OAAO,CAAC,eAAe,CAAqC;IAC5D,OAAO,CAAC,YAAY,CAAwB;IAC5C,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,WAAW,CAAS;IAE5B;;;;OAIG;gBACgB,MAAM,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAclF;OACG;IACH,IAAW,cAAc,IAAI,8BAA8B,CAE1D;IAED;OACG;IACH,IAAW,WAAW,IAAI,qBAAqB,CAE9C;IAED;OACG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;OACG;IACH,IAAW,MAAM,IAAI,gBAAgB,CAEpC;IAED;OACG;IACI,KAAK,IAAI,IAAI;IAOpB;OACG;IACI,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IAIzC;OACG;IACI,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI7C,mBAAmB,IAAI,MAAM;IAIpC;OACG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;OACG;IACH,IAAW,SAAS,CAAC,KAAK,EAAE,MAAM,EAOjC;IAED;OACG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED;OACG;IACH,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAOlC;CACF"}