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

package/lib/esm/components-react/table/SimpleTableDataProvider.js

@@ -0,0 +1,251 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { PropertyValueFormat, UiError } from "@itwin/appui-abstract";
+import { SortDirection } from "@itwin/core-react";
+import { TypeConverterManager } from "../converters/TypeConverterManager";
+import { UiComponents } from "../UiComponents";
+import { DistinctValueCollection } from "./columnfiltering/ColumnFiltering";
+import { TableDataChangeEvent } from "./TableDataProvider";
+/* eslint-disable deprecation/deprecation */
+// cSpell:ignore columnfiltering
+/**
+ * A Table Data Provider using an array of items.
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this class.
+ * @public
+ */
+export class SimpleTableDataProvider {
+    constructor(columns) {
+        this._sortDirection = SortDirection.NoSort;
+        this._sortColumnIndex = -1;
+        /** Event emitted by the data provider when column data changes */
+        this.onColumnsChanged = new TableDataChangeEvent();
+        /** Event emitted by the data provider when row data changes */
+        this.onRowsChanged = new TableDataChangeEvent();
+        this._columns = columns;
+        this._items = [];
+        this._rowItemIndices = [];
+        this._secondarySortColumnStack = [];
+    }
+    /** Sets the row items based on an array */
+    setItems(items) {
+        this._items = items;
+        this._rowItemIndices = [];
+        this.resetRowIndices();
+        this.onRowsChanged.raiseEvent();
+    }
+    resetRowIndices() {
+        this._rowItemIndices.splice(0);
+        for (let rowIndex = 0; rowIndex < this._items.length; rowIndex++) {
+            this._rowItemIndices.push(rowIndex);
+        }
+    }
+    /** Retrieves the column descriptions */
+    async getColumns() {
+        return this._columns;
+    }
+    /** Retrieves the row count */
+    async getRowsCount() {
+        return this._rowItemIndices.length;
+    }
+    /** Retrieves a specific row by index */
+    async getRow(rowIndex, unfiltered) {
+        let realRowIndex = -1;
+        if (unfiltered) {
+            // istanbul ignore else
+            if (0 <= rowIndex && rowIndex < this._items.length)
+                realRowIndex = rowIndex;
+        }
+        else {
+            if (0 <= rowIndex && rowIndex < this._rowItemIndices.length)
+                realRowIndex = this.getRowIndexFromFilteredRowIndex(rowIndex);
+        }
+        if (0 <= realRowIndex && realRowIndex < this._items.length)
+            return this._items[realRowIndex];
+        throw new UiError(UiComponents.loggerCategory(this), `getRow: Invalid row index - ${rowIndex}`);
+    }
+    getRowIndexFromFilteredRowIndex(filteredRowIndex) {
+        // istanbul ignore next
+        if (filteredRowIndex === undefined)
+            return filteredRowIndex;
+        // istanbul ignore next
+        if (filteredRowIndex < 0 || filteredRowIndex >= this._rowItemIndices.length)
+            return -1;
+        return this._rowItemIndices[filteredRowIndex];
+    }
+    /** Sorts the rows based on the value in a specific column */
+    async sort(columnIndex, sortDirection) {
+        // istanbul ignore next
+        if (columnIndex < 0 || columnIndex >= this._columns.length)
+            return;
+        this._sortColumnIndex = columnIndex;
+        this._sortDirection = sortDirection;
+        if (sortDirection === SortDirection.NoSort) {
+            if (this._filterDescriptors)
+                await this.applyFilterDescriptors(this._filterDescriptors);
+            else
+                this.resetRowIndices();
+            return;
+        }
+        this._secondarySortColumnStack = [];
+        this._secondarySortColumnStack.push(columnIndex);
+        // Sort by the column
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const dataProvider = this;
+        this._rowItemIndices.sort((a, b) => {
+            return dataProvider.sortDispatcher(dataProvider._items[a], dataProvider._items[b], columnIndex, sortDirection);
+        });
+        delete this._secondarySortColumnStack;
+        return;
+    }
+    sortDispatcher(a, b, columnIndex, sortDirection) {
+        let result = this.sortRows(a, b, columnIndex, sortDirection);
+        if (result !== 0)
+            return result;
+        // Secondary sort column support
+        // istanbul ignore else
+        const column = this._columns[columnIndex];
+        if (this._secondarySortColumnStack !== undefined &&
+            column.secondarySortColumn !== undefined &&
+            column.secondarySortColumn !== columnIndex &&
+            this._secondarySortColumnStack.indexOf(column.secondarySortColumn) < 0) {
+            this._secondarySortColumnStack.push(column.secondarySortColumn);
+            result = this.sortDispatcher(a, b, column.secondarySortColumn, sortDirection);
+            this._secondarySortColumnStack.pop();
+        }
+        return result;
+    }
+    getPrimitiveValue(record) {
+        let primitiveValue;
+        const recordValue = record.value;
+        // istanbul ignore else
+        if (recordValue.valueFormat === PropertyValueFormat.Primitive)
+            primitiveValue = recordValue.value;
+        return primitiveValue;
+    }
+    sortRows(a, b, columnIndex, sortDirection) {
+        var _a;
+        const aCell = a.cells[columnIndex];
+        const bCell = b.cells[columnIndex];
+        let result = 0;
+        const column = this._columns[columnIndex];
+        const propertyDescription = column.propertyDescription;
+        const valueA = this.getPrimitiveValue(aCell.record);
+        const valueB = this.getPrimitiveValue(bCell.record);
+        // istanbul ignore else
+        if (valueA !== undefined && valueB !== undefined && propertyDescription)
+            result = TypeConverterManager.getConverter(propertyDescription.typename, (_a = propertyDescription.converter) === null || _a === void 0 ? void 0 : _a.name).sortCompare(valueA, valueB, column.sortIgnoreCase);
+        if (sortDirection === SortDirection.Descending)
+            result *= -1;
+        return result;
+    }
+    /** Gets distinct values in a column
+     * @public
+     */
+    async getDistinctValues(columnKey, maximumValueCount) {
+        var _a;
+        const distinctValues = new DistinctValueCollection();
+        const columnIndex = this._columns.findIndex((description) => description.key === columnKey);
+        if (columnIndex < 0 || columnIndex >= this._columns.length)
+            return distinctValues;
+        const columnDescription = this._columns[columnIndex];
+        const propertyDescription = columnDescription.propertyDescription;
+        const uniqueKeysMap = {};
+        const uniqueValues = [];
+        // istanbul ignore next
+        if (!propertyDescription)
+            return distinctValues;
+        for (const row of this._items) {
+            const cell = row.cells[columnIndex];
+            const record = cell.record;
+            // istanbul ignore next
+            if (record === undefined)
+                continue;
+            const value = this.getPrimitiveValue(record);
+            const displayValue = await TypeConverterManager
+                .getConverter(propertyDescription.typename, (_a = propertyDescription.converter) === null || _a === void 0 ? void 0 : _a.name)
+                .convertPropertyToString(propertyDescription, value);
+            // istanbul ignore next
+            if (value === undefined || typeof displayValue !== "string")
+                continue;
+            const valueKey = value.toString();
+            if (!uniqueKeysMap.hasOwnProperty(valueKey)) {
+                const propertyValue = { value, label: displayValue };
+                uniqueKeysMap[valueKey] = propertyValue;
+                uniqueValues.push(propertyValue);
+            }
+        }
+        distinctValues.values = uniqueValues;
+        distinctValues.values.sort((a, b) => {
+            var _a;
+            if (a.value && b.value)
+                return TypeConverterManager.getConverter(propertyDescription.typename, (_a = propertyDescription.converter) === null || _a === void 0 ? void 0 : _a.name).sortCompare(a.value, b.value);
+            return 0;
+        });
+        if (maximumValueCount !== undefined && distinctValues.values.length > maximumValueCount)
+            distinctValues.values.splice(maximumValueCount);
+        return distinctValues;
+    }
+    /** Apply a filter descriptor collection
+     * @public
+     */
+    async applyFilterDescriptors(filterDescriptors) {
+        this._filterDescriptors = filterDescriptors;
+        this._rowItemIndices.splice(0);
+        this._items.forEach((row, i) => {
+            if (filterDescriptors.evaluateRow(row))
+                this._rowItemIndices.push(i);
+        });
+        if (this._sortDirection !== SortDirection.NoSort) {
+            await this.sort(this._sortColumnIndex, this._sortDirection);
+        }
+    }
+    /** Adds a row to the end */
+    addRow(rowItem) {
+        return this.insertRow(rowItem, -1);
+    }
+    /** Inserts a row at a given row index */
+    insertRow(rowItem, index) {
+        let newIdx = index;
+        if (index < 0 || index >= this._items.length)
+            newIdx = this._items.push(rowItem) - 1;
+        else
+            this._items.splice(newIdx, 0, rowItem);
+        this.resetRowIndices();
+        this.onRowsChanged.raiseEvent();
+        return newIdx;
+    }
+    /** Deletes a row */
+    deleteRow(rowItem, raiseRowsChangedEvent = true) {
+        const rowIndex = this.findRowIndex(rowItem);
+        if (rowIndex >= 0) {
+            this._items.splice(rowIndex, 1);
+            this.resetRowIndices();
+            if (raiseRowsChangedEvent)
+                this.onRowsChanged.raiseEvent();
+        }
+    }
+    /** Moves a row to a new row index */
+    moveRow(rowItem, newIndex) {
+        const oldIndex = this.findRowIndex(rowItem);
+        if (oldIndex >= 0) {
+            this.deleteRow(rowItem, false);
+            if (newIndex > oldIndex)
+                newIndex--; // removing the row will shrink the count by 1
+            return this.insertRow(rowItem, newIndex);
+        }
+        return -1;
+    }
+    findRowIndex(item) {
+        for (let i = 0; i < this._items.length; i++) {
+            if (item === this._items[i])
+                return i;
+        }
+        return -1;
+    }
+}
+//# sourceMappingURL=SimpleTableDataProvider.js.map

package/lib/esm/components-react/table/SimpleTableDataProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleTableDataProvider.js","sourceRoot":"","sources":["../../../../src/components-react/table/SimpleTableDataProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAA8B,mBAAmB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACjG,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAuC,uBAAuB,EAAsB,MAAM,mCAAmC,CAAC;AACrI,OAAO,EAAwD,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEjH,4CAA4C;AAC5C,gCAAgC;AAEhC;;;;GAIG;AACH,MAAM,OAAO,uBAAuB;IAclC,YAAY,OAA4B;QAThC,mBAAc,GAAkB,aAAa,CAAC,MAAM,CAAC;QACrD,qBAAgB,GAAW,CAAC,CAAC,CAAC;QAGtC,kEAAkE;QAC3D,qBAAgB,GAAG,IAAI,oBAAoB,EAAE,CAAC;QACrD,+DAA+D;QACxD,kBAAa,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAGhD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,yBAAyB,GAAG,EAAE,CAAC;IACtC,CAAC;IAED,2CAA2C;IACpC,QAAQ,CAAC,KAAgB;QAC9B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE/B,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YAChE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACrC;IACH,CAAC;IAED,wCAAwC;IACjC,KAAK,CAAC,UAAU;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,8BAA8B;IACvB,KAAK,CAAC,YAAY;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;IACrC,CAAC;IAED,wCAAwC;IACjC,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,UAAoB;QACxD,IAAI,YAAY,GAAW,CAAC,CAAC,CAAC;QAE9B,IAAI,UAAU,EAAE;YACd,uBAAuB;YACvB,IAAI,CAAC,IAAI,QAAQ,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM;gBAChD,YAAY,GAAG,QAAQ,CAAC;SAC3B;aAAM;YACL,IAAI,CAAC,IAAI,QAAQ,IAAI,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM;gBACzD,YAAY,GAAG,IAAI,CAAC,+BAA+B,CAAC,QAAQ,CAAC,CAAC;SACjE;QAED,IAAI,CAAC,IAAI,YAAY,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM;YACxD,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAEnC,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,+BAA+B,QAAQ,EAAE,CAAC,CAAC;IAClG,CAAC;IAEO,+BAA+B,CAAC,gBAAwB;QAC9D,uBAAuB;QACvB,IAAI,gBAAgB,KAAK,SAAS;YAChC,OAAO,gBAAgB,CAAC;QAE1B,uBAAuB;QACvB,IAAI,gBAAgB,GAAG,CAAC,IAAI,gBAAgB,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM;YACzE,OAAO,CAAC,CAAC,CAAC;QAEZ,OAAO,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAChD,CAAC;IAED,6DAA6D;IACtD,KAAK,CAAC,IAAI,CAAC,WAAmB,EAAE,aAA4B;QACjE,uBAAuB;QACvB,IAAI,WAAW,GAAG,CAAC,IAAI,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM;YACxD,OAAO;QAET,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QAEpC,IAAI,aAAa,KAAK,aAAa,CAAC,MAAM,EAAE;YAC1C,IAAI,IAAI,CAAC,kBAAkB;gBACzB,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;;gBAE3D,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,OAAO;SACR;QAED,IAAI,CAAC,yBAAyB,GAAG,EAAE,CAAC;QACpC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEjD,qBAAqB;QACrB,4DAA4D;QAC5D,MAAM,YAAY,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE;YACjD,OAAO,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;QACjH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,yBAAyB,CAAC;QAEtC,OAAO;IACT,CAAC;IAEO,cAAc,CAAC,CAAU,EAAE,CAAU,EAAE,WAAmB,EAAE,aAA4B;QAC9F,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;QAE7D,IAAI,MAAM,KAAK,CAAC;YACd,OAAO,MAAM,CAAC;QAEhB,gCAAgC;QAChC,uBAAuB;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC1C,IAAI,IAAI,CAAC,yBAAyB,KAAK,SAAS;YAC9C,MAAM,CAAC,mBAAmB,KAAK,SAAS;YACxC,MAAM,CAAC,mBAAmB,KAAK,WAAW;YAC1C,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE;YAExE,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;YAChE,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;YAC9E,IAAI,CAAC,yBAAyB,CAAC,GAAG,EAAE,CAAC;SACtC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,iBAAiB,CAAC,MAAsB;QAC9C,IAAI,cAA4C,CAAC;QACjD,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC;QACjC,uBAAuB;QACvB,IAAI,WAAW,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS;YAC3D,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC;QACrC,OAAO,cAAc,CAAC;IACxB,CAAC;IAEO,QAAQ,CAAC,CAAU,EAAE,CAAU,EAAE,WAAmB,EAAE,aAA4B;;QACxF,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAEnC,IAAI,MAAM,GAAW,CAAC,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAE1C,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;QACvD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,MAAwB,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,MAAwB,CAAC,CAAC;QACtE,uBAAuB;QACvB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,mBAAmB;YACrE,MAAM,GAAG,oBAAoB,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAA,mBAAmB,CAAC,SAAS,0CAAE,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnK,IAAI,aAAa,KAAK,aAAa,CAAC,UAAU;YAC5C,MAAM,IAAI,CAAC,CAAC,CAAC;QAEf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAAC,SAAiB,EAAE,iBAA0B;;QAC1E,MAAM,cAAc,GAAG,IAAI,uBAAuB,EAAE,CAAC;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,WAA8B,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC;QAC/G,IAAI,WAAW,GAAG,CAAC,IAAI,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM;YACxD,OAAO,cAAc,CAAC;QAExB,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACrD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;QAClE,MAAM,aAAa,GAA0C,EAAE,CAAC;QAChE,MAAM,YAAY,GAAU,EAAE,CAAC;QAE/B,uBAAuB;QACvB,IAAI,CAAC,mBAAmB;YACtB,OAAO,cAAc,CAAC;QAExB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACpC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAE3B,uBAAuB;YACvB,IAAI,MAAM,KAAK,SAAS;gBACtB,SAAS;YAEX,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,YAAY,GAAG,MAAM,oBAAoB;iBAC5C,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAA,mBAAmB,CAAC,SAAS,0CAAE,IAAI,CAAC;iBAC/E,uBAAuB,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YAEvD,uBAAuB;YACvB,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,YAAY,KAAK,QAAQ;gBACzD,SAAS;YAEX,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;gBAC3C,MAAM,aAAa,GAAuB,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;gBAEzE,aAAa,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC;gBACxC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAClC;SACF;QAED,cAAc,CAAC,MAAM,GAAG,YAAY,CAAC;QAErC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAqB,EAAE,CAAqB,EAAE,EAAE;;YAC1E,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK;gBACpB,OAAO,oBAAoB,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAA,mBAAmB,CAAC,SAAS,0CAAE,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;YAC5I,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,IAAI,iBAAiB,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,CAAC,MAAM,GAAG,iBAAiB;YACrF,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QAElD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,sBAAsB,CAAC,iBAAsD;QACxF,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAE5C,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE/B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAY,EAAE,CAAS,EAAE,EAAE;YAC9C,IAAI,iBAAiB,CAAC,WAAW,CAAC,GAAG,CAAC;gBACpC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,cAAc,KAAK,aAAa,CAAC,MAAM,EAAE;YAChD,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SAC7D;IACH,CAAC;IAED,4BAA4B;IACrB,MAAM,CAAC,OAAgB;QAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,yCAAyC;IAClC,SAAS,CAAC,OAAgB,EAAE,KAAa;QAC9C,IAAI,MAAM,GAAG,KAAK,CAAC;QAEnB,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1C,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;;YAEvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;QAEzC,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;QAEhC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,oBAAoB;IACb,SAAS,CAAC,OAAgB,EAAE,wBAAiC,IAAI;QACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAEhC,IAAI,CAAC,eAAe,EAAE,CAAC;YAEvB,IAAI,qBAAqB;gBACvB,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;SACnC;IACH,CAAC;IAED,qCAAqC;IAC9B,OAAO,CAAC,OAAgB,EAAE,QAAgB;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAE/B,IAAI,QAAQ,GAAG,QAAQ;gBACrB,QAAQ,EAAE,CAAC,CAAK,8CAA8C;YAEhE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC1C;QAED,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;IAEO,YAAY,CAAC,IAAa;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC3C,IAAI,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;gBACzB,OAAO,CAAC,CAAC;SACZ;QACD,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;CACF","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 { Primitives, PropertyRecord, PropertyValueFormat, UiError } from \"@itwin/appui-abstract\";\r\nimport { SortDirection } from \"@itwin/core-react\";\r\nimport { TypeConverterManager } from \"../converters/TypeConverterManager\";\r\nimport { UiComponents } from \"../UiComponents\";\r\nimport { CompositeFilterDescriptorCollection, DistinctValueCollection, TableDistinctValue } from \"./columnfiltering/ColumnFiltering\";\r\nimport { ColumnDescription, MutableTableDataProvider, RowItem, TableDataChangeEvent } from \"./TableDataProvider\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n// cSpell:ignore columnfiltering\r\n\r\n/**\r\n * A Table Data Provider using an array of items.\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this class.\r\n * @public\r\n */\r\nexport class SimpleTableDataProvider implements MutableTableDataProvider {\r\n  private _items: RowItem[];\r\n  private _rowItemIndices: number[];     // Used for both filtering and sorting\r\n  private _columns: ColumnDescription[];\r\n  private _secondarySortColumnStack?: number[];\r\n  private _sortDirection: SortDirection = SortDirection.NoSort;\r\n  private _sortColumnIndex: number = -1;\r\n  private _filterDescriptors?: CompositeFilterDescriptorCollection;\r\n\r\n  /** Event emitted by the data provider when column data changes */\r\n  public onColumnsChanged = new TableDataChangeEvent();\r\n  /** Event emitted by the data provider when row data changes */\r\n  public onRowsChanged = new TableDataChangeEvent();\r\n\r\n  constructor(columns: ColumnDescription[]) {\r\n    this._columns = columns;\r\n    this._items = [];\r\n    this._rowItemIndices = [];\r\n    this._secondarySortColumnStack = [];\r\n  }\r\n\r\n  /** Sets the row items based on an array */\r\n  public setItems(items: RowItem[]): void {\r\n    this._items = items;\r\n    this._rowItemIndices = [];\r\n    this.resetRowIndices();\r\n    this.onRowsChanged.raiseEvent();\r\n  }\r\n\r\n  private resetRowIndices(): void {\r\n    this._rowItemIndices.splice(0);\r\n\r\n    for (let rowIndex = 0; rowIndex < this._items.length; rowIndex++) {\r\n      this._rowItemIndices.push(rowIndex);\r\n    }\r\n  }\r\n\r\n  /** Retrieves the column descriptions */\r\n  public async getColumns(): Promise<ColumnDescription[]> {\r\n    return this._columns;\r\n  }\r\n\r\n  /** Retrieves the row count */\r\n  public async getRowsCount(): Promise<number> {\r\n    return this._rowItemIndices.length;\r\n  }\r\n\r\n  /** Retrieves a specific row by index */\r\n  public async getRow(rowIndex: number, unfiltered?: boolean): Promise<RowItem> {\r\n    let realRowIndex: number = -1;\r\n\r\n    if (unfiltered) {\r\n      // istanbul ignore else\r\n      if (0 <= rowIndex && rowIndex < this._items.length)\r\n        realRowIndex = rowIndex;\r\n    } else {\r\n      if (0 <= rowIndex && rowIndex < this._rowItemIndices.length)\r\n        realRowIndex = this.getRowIndexFromFilteredRowIndex(rowIndex);\r\n    }\r\n\r\n    if (0 <= realRowIndex && realRowIndex < this._items.length)\r\n      return this._items[realRowIndex];\r\n\r\n    throw new UiError(UiComponents.loggerCategory(this), `getRow: Invalid row index - ${rowIndex}`);\r\n  }\r\n\r\n  private getRowIndexFromFilteredRowIndex(filteredRowIndex: number): number {\r\n    // istanbul ignore next\r\n    if (filteredRowIndex === undefined)\r\n      return filteredRowIndex;\r\n\r\n    // istanbul ignore next\r\n    if (filteredRowIndex < 0 || filteredRowIndex >= this._rowItemIndices.length)\r\n      return -1;\r\n\r\n    return this._rowItemIndices[filteredRowIndex];\r\n  }\r\n\r\n  /** Sorts the rows based on the value in a specific column */\r\n  public async sort(columnIndex: number, sortDirection: SortDirection): Promise<void> {\r\n    // istanbul ignore next\r\n    if (columnIndex < 0 || columnIndex >= this._columns.length)\r\n      return;\r\n\r\n    this._sortColumnIndex = columnIndex;\r\n    this._sortDirection = sortDirection;\r\n\r\n    if (sortDirection === SortDirection.NoSort) {\r\n      if (this._filterDescriptors)\r\n        await this.applyFilterDescriptors(this._filterDescriptors);\r\n      else\r\n        this.resetRowIndices();\r\n      return;\r\n    }\r\n\r\n    this._secondarySortColumnStack = [];\r\n    this._secondarySortColumnStack.push(columnIndex);\r\n\r\n    // Sort by the column\r\n    // eslint-disable-next-line @typescript-eslint/no-this-alias\r\n    const dataProvider = this;\r\n    this._rowItemIndices.sort((a: number, b: number) => {\r\n      return dataProvider.sortDispatcher(dataProvider._items[a], dataProvider._items[b], columnIndex, sortDirection);\r\n    });\r\n\r\n    delete this._secondarySortColumnStack;\r\n\r\n    return;\r\n  }\r\n\r\n  private sortDispatcher(a: RowItem, b: RowItem, columnIndex: number, sortDirection: SortDirection): number {\r\n    let result = this.sortRows(a, b, columnIndex, sortDirection);\r\n\r\n    if (result !== 0)\r\n      return result;\r\n\r\n    // Secondary sort column support\r\n    // istanbul ignore else\r\n    const column = this._columns[columnIndex];\r\n    if (this._secondarySortColumnStack !== undefined &&\r\n      column.secondarySortColumn !== undefined &&\r\n      column.secondarySortColumn !== columnIndex &&\r\n      this._secondarySortColumnStack.indexOf(column.secondarySortColumn) < 0) {\r\n\r\n      this._secondarySortColumnStack.push(column.secondarySortColumn);\r\n      result = this.sortDispatcher(a, b, column.secondarySortColumn, sortDirection);\r\n      this._secondarySortColumnStack.pop();\r\n    }\r\n\r\n    return result;\r\n  }\r\n\r\n  private getPrimitiveValue(record: PropertyRecord) {\r\n    let primitiveValue: Primitives.Value | undefined;\r\n    const recordValue = record.value;\r\n    // istanbul ignore else\r\n    if (recordValue.valueFormat === PropertyValueFormat.Primitive)\r\n      primitiveValue = recordValue.value;\r\n    return primitiveValue;\r\n  }\r\n\r\n  private sortRows(a: RowItem, b: RowItem, columnIndex: number, sortDirection: SortDirection): number {\r\n    const aCell = a.cells[columnIndex];\r\n    const bCell = b.cells[columnIndex];\r\n\r\n    let result: number = 0;\r\n    const column = this._columns[columnIndex];\r\n\r\n    const propertyDescription = column.propertyDescription;\r\n    const valueA = this.getPrimitiveValue(aCell.record as PropertyRecord);\r\n    const valueB = this.getPrimitiveValue(bCell.record as PropertyRecord);\r\n    // istanbul ignore else\r\n    if (valueA !== undefined && valueB !== undefined && propertyDescription)\r\n      result = TypeConverterManager.getConverter(propertyDescription.typename, propertyDescription.converter?.name).sortCompare(valueA, valueB, column.sortIgnoreCase);\r\n\r\n    if (sortDirection === SortDirection.Descending)\r\n      result *= -1;\r\n\r\n    return result;\r\n  }\r\n\r\n  /** Gets distinct values in a column\r\n   * @public\r\n   */\r\n  public async getDistinctValues(columnKey: string, maximumValueCount?: number): Promise<DistinctValueCollection> {\r\n    const distinctValues = new DistinctValueCollection();\r\n    const columnIndex = this._columns.findIndex((description: ColumnDescription) => description.key === columnKey);\r\n    if (columnIndex < 0 || columnIndex >= this._columns.length)\r\n      return distinctValues;\r\n\r\n    const columnDescription = this._columns[columnIndex];\r\n    const propertyDescription = columnDescription.propertyDescription;\r\n    const uniqueKeysMap: { [key: string]: TableDistinctValue } = {};\r\n    const uniqueValues: any[] = [];\r\n\r\n    // istanbul ignore next\r\n    if (!propertyDescription)\r\n      return distinctValues;\r\n\r\n    for (const row of this._items) {\r\n      const cell = row.cells[columnIndex];\r\n      const record = cell.record;\r\n\r\n      // istanbul ignore next\r\n      if (record === undefined)\r\n        continue;\r\n\r\n      const value = this.getPrimitiveValue(record);\r\n      const displayValue = await TypeConverterManager\r\n        .getConverter(propertyDescription.typename, propertyDescription.converter?.name)\r\n        .convertPropertyToString(propertyDescription, value);\r\n\r\n      // istanbul ignore next\r\n      if (value === undefined || typeof displayValue !== \"string\")\r\n        continue;\r\n\r\n      const valueKey = value.toString();\r\n      if (!uniqueKeysMap.hasOwnProperty(valueKey)) {\r\n        const propertyValue: TableDistinctValue = { value, label: displayValue };\r\n\r\n        uniqueKeysMap[valueKey] = propertyValue;\r\n        uniqueValues.push(propertyValue);\r\n      }\r\n    }\r\n\r\n    distinctValues.values = uniqueValues;\r\n\r\n    distinctValues.values.sort((a: TableDistinctValue, b: TableDistinctValue) => {\r\n      if (a.value && b.value)\r\n        return TypeConverterManager.getConverter(propertyDescription.typename, propertyDescription.converter?.name).sortCompare(a.value, b.value);\r\n      return 0;\r\n    });\r\n\r\n    if (maximumValueCount !== undefined && distinctValues.values.length > maximumValueCount)\r\n      distinctValues.values.splice(maximumValueCount);\r\n\r\n    return distinctValues;\r\n  }\r\n\r\n  /** Apply a filter descriptor collection\r\n   * @public\r\n   */\r\n  public async applyFilterDescriptors(filterDescriptors: CompositeFilterDescriptorCollection): Promise<void> {\r\n    this._filterDescriptors = filterDescriptors;\r\n\r\n    this._rowItemIndices.splice(0);\r\n\r\n    this._items.forEach((row: RowItem, i: number) => {\r\n      if (filterDescriptors.evaluateRow(row))\r\n        this._rowItemIndices.push(i);\r\n    });\r\n\r\n    if (this._sortDirection !== SortDirection.NoSort) {\r\n      await this.sort(this._sortColumnIndex, this._sortDirection);\r\n    }\r\n  }\r\n\r\n  /** Adds a row to the end */\r\n  public addRow(rowItem: RowItem): number {\r\n    return this.insertRow(rowItem, -1);\r\n  }\r\n\r\n  /** Inserts a row at a given row index */\r\n  public insertRow(rowItem: RowItem, index: number): number {\r\n    let newIdx = index;\r\n\r\n    if (index < 0 || index >= this._items.length)\r\n      newIdx = this._items.push(rowItem) - 1;\r\n    else\r\n      this._items.splice(newIdx, 0, rowItem);\r\n\r\n    this.resetRowIndices();\r\n    this.onRowsChanged.raiseEvent();\r\n\r\n    return newIdx;\r\n  }\r\n\r\n  /** Deletes a row */\r\n  public deleteRow(rowItem: RowItem, raiseRowsChangedEvent: boolean = true): void {\r\n    const rowIndex = this.findRowIndex(rowItem);\r\n    if (rowIndex >= 0) {\r\n      this._items.splice(rowIndex, 1);\r\n\r\n      this.resetRowIndices();\r\n\r\n      if (raiseRowsChangedEvent)\r\n        this.onRowsChanged.raiseEvent();\r\n    }\r\n  }\r\n\r\n  /** Moves a row to a new row index */\r\n  public moveRow(rowItem: RowItem, newIndex: number): number {\r\n    const oldIndex = this.findRowIndex(rowItem);\r\n    if (oldIndex >= 0) {\r\n      this.deleteRow(rowItem, false);\r\n\r\n      if (newIndex > oldIndex)\r\n        newIndex--;     // removing the row will shrink the count by 1\r\n\r\n      return this.insertRow(rowItem, newIndex);\r\n    }\r\n\r\n    return -1;\r\n  }\r\n\r\n  private findRowIndex(item: RowItem): number {\r\n    for (let i = 0; i < this._items.length; i++) {\r\n      if (item === this._items[i])\r\n        return i;\r\n    }\r\n    return -1;\r\n  }\r\n}\r\n"]}

package/lib/esm/components-react/table/TableDataProvider.d.ts

@@ -1,10 +1,166 @@
-/** @packageDocumentation
- * @module Table
- */
-import { BeEvent } from "@itwin/core-bentley";
-/** An event broadcasted on table data changes
- * @public  @deprecated
- */
-export declare class TableDataChangeEvent extends BeEvent<() => void> {
-}
+/** @packageDocumentation
+ * @module Table
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { PropertyDescription, PropertyRecord } from "@itwin/appui-abstract";
+import { HorizontalAlignment, SortDirection } from "@itwin/core-react";
+import { ItemColorOverrides, ItemStyle } from "../properties/ItemStyle";
+import { CompositeFilterDescriptorCollection, DistinctValueCollection } from "./columnfiltering/ColumnFiltering";
+/** Filter Renderer for a Table column
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
+ * @public
+ */
+export declare enum FilterRenderer {
+    Numeric = 1,
+    MultiSelect = 2,
+    SingleSelect = 3,
+    Text = 4,
+    MultiValue = 5
+}
+/**
+ * Column definition provided to Table.
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
+ * @public
+ */
+export interface ColumnDescription {
+    /** A unique key for this column. */
+    key: string;
+    /** Column header label */
+    label: string;
+    /** Property description for all cells in the column */
+    propertyDescription?: PropertyDescription;
+    /** Preferred initial width of the column */
+    width?: number;
+    /** Indicates whether the cells in the column are editable. Defaults to false. */
+    editable?: boolean;
+    /** Indicates whether the column is resizable. Defaults to false. */
+    resizable?: boolean;
+    /** Indicates whether the display value for the cell is treated as an icon spec. Defaults to false. */
+    icon?: boolean;
+    /** Indicates whether the column is sortable. Defaults to false. */
+    sortable?: boolean;
+    /** Specifies a secondary sort column to use when cell values are the same. */
+    secondarySortColumn?: number;
+    /** Indicates whether the column sorting ignores case. Defaults to false. */
+    sortIgnoreCase?: boolean;
+    /** Indicates whether the column is filterable. Defaults to false. */
+    filterable?: boolean;
+    /** Specifies the filter renderer for the column. */
+    filterRenderer?: FilterRenderer;
+    /** Show field filters in Multi-Value column filtering popup. Defaults to true. */
+    showFieldFilters?: boolean;
+    /** Show distinct value checkboxes in Multi-Value column filtering popup. Defaults to true. */
+    showDistinctValueFilters?: boolean;
+    /** Filtering is case-sensitive in Multi-Value column filtering popup. Defaults to false. */
+    filterCaseSensitive?: boolean;
+    /** Sort type for react-table */
+    sortType?: string;
+}
+/**
+ * Cell definition provided to Table.
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
+ * @public
+ */
+export interface CellItem {
+    /** Key for the column containing the cell */
+    key: string;
+    /** Property record for the cell */
+    record?: PropertyRecord;
+    /** Indicates whether the cell is disabled */
+    isDisabled?: boolean;
+    /** Specifies the horizontal alignment of the contents of the cell */
+    alignment?: HorizontalAlignment;
+    /** Style properties for the contents of the cell */
+    style?: ItemStyle;
+    /**
+     * Property to specify how many cells were merged to create this cell.
+     * Default value is 1.
+     * @alpha
+     */
+    mergedCellsCount?: number;
+}
+/**
+ * Row definition provided to Table.
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
+ * @public
+ */
+export interface RowItem {
+    /** A unique key for this row */
+    key: string;
+    /** Array of cells in the row */
+    cells: CellItem[];
+    /** Indicates whether the row is disabled */
+    isDisabled?: boolean;
+    /** Color overrides for all cells in the row */
+    colorOverrides?: ItemColorOverrides;
+    /**
+     * A key-value pairs data structure that can be used by data provider
+     * to store some custom data for this node item.
+     */
+    extendedData?: {
+        [key: string]: any;
+    };
+    /**
+     * Get the value from the cell for filtering purposes.
+     * If not specified and the value is a primitive, the recordValue.value is returned.
+     */
+    getValueFromCell?: (columnKey: string) => any;
+}
+/** An interface table data change listeners
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this type.
+ * @public
+ */
+export declare type TableDataChangesListener = () => void;
+/** An event broadcasted on table data changes
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this class.
+ * @public
+ */
+export declare class TableDataChangeEvent extends BeEvent<TableDataChangesListener> {
+}
+/**
+ * TableDataProvider provides data to the Table.
+ * It also provides support for data Sorting & Filtering.
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
+ * @public
+ */
+export interface TableDataProvider {
+    /** Event emitted by the data provider when column data changes */
+    onColumnsChanged: TableDataChangeEvent;
+    /** Event emitted by the data provider when row data changes */
+    onRowsChanged: TableDataChangeEvent;
+    /** Retrieves the column descriptions */
+    getColumns(): Promise<ColumnDescription[]>;
+    /** Retrieves the row count */
+    getRowsCount(): Promise<number>;
+    /** Retrieves a specific row by index */
+    getRow(rowIndex: number, unfiltered?: boolean): Promise<RowItem>;
+    /** Sorts the rows based on the value in a specific column */
+    sort(columnIndex: number, sortDirection: SortDirection): Promise<void>;
+    /** Apply a filter descriptor collection
+     */
+    applyFilterDescriptors?: (filterDescriptors: CompositeFilterDescriptorCollection) => Promise<void>;
+    /** Gets distinct values in a column
+     */
+    getDistinctValues?: (columnKey: string, maximumValueCount?: number) => Promise<DistinctValueCollection>;
+    /** Gets property display value expression
+     * @alpha
+     */
+    getPropertyDisplayValueExpression?: (property: string) => string;
+}
+/**
+ * MutableTableDataProvider provides mutation methods for data in the Table.
+ * Useful for Drag & Drop processing.
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
+ * @public
+ */
+export interface MutableTableDataProvider extends TableDataProvider {
+    /** Adds a row to the end */
+    addRow(rowItem: RowItem): number;
+    /** Inserts a row at a given row index */
+    insertRow(rowItem: RowItem, index: number): number;
+    /** Deletes a row */
+    deleteRow(rowItem: RowItem): void;
+    /** Moves a row to a new row index */
+    moveRow(rowItem: RowItem, newIndex: number): number;
+}
 //# sourceMappingURL=TableDataProvider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TableDataProvider.d.ts","sourceRoot":"","sources":["../../../../src/components-react/table/TableDataProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,MAAM,IAAI,CAAC;CAAI"}
+{"version":3,"file":"TableDataProvider.d.ts","sourceRoot":"","sources":["../../../../src/components-react/table/TableDataProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,mCAAmC,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAKjH;;;GAGG;AACH,oBAAY,cAAc;IACxB,OAAO,IAAI;IACX,WAAW,IAAA;IACX,YAAY,IAAA;IACZ,IAAI,IAAA;IACJ,UAAU,IAAA;CACX;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAC;IAEZ,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,sGAAsG;IACtG,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,mEAAmE;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,4EAA4E;IAC5E,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,qEAAqE;IACrE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,oDAAoD;IACpD,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,kFAAkF;IAClF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,8FAA8F;IAC9F,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,4FAA4F;IAC5F,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,qEAAqE;IACrE,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEhC,oDAAoD;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,4CAA4C;IAC5C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAEpC;;;OAGG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,GAAG,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC;AAE1D;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,kEAAkE;IAClE,gBAAgB,EAAE,oBAAoB,CAAC;IACvC,+DAA+D;IAC/D,aAAa,EAAE,oBAAoB,CAAC;IAEpC,wCAAwC;IACxC,UAAU,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC3C,8BAA8B;IAC9B,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,wCAAwC;IACxC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjE,6DAA6D;IAC7D,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAIvE;OACG;IACH,sBAAsB,CAAC,EAAE,CAAC,iBAAiB,EAAE,mCAAmC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnG;OACG;IACH,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAExG;;OAEG;IACH,iCAAiC,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;CAClE;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,4BAA4B;IAC5B,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC;IACjC,yCAAyC;IACzC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACnD,oBAAoB;IACpB,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,qCAAqC;IACrC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;CACrD"}

package/lib/esm/components-react/table/TableDataProvider.js

@@ -1,14 +1,29 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { BeEvent } from "@itwin/core-bentley";
-/** An event broadcasted on table data changes
- * @public  @deprecated
- */
-export class TableDataChangeEvent extends BeEvent {
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { BeEvent } from "@itwin/core-bentley";
+/* eslint-disable deprecation/deprecation */
+// cSpell:ignore columnfiltering
+/** Filter Renderer for a Table column
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
+ * @public
+ */
+export var FilterRenderer;
+(function (FilterRenderer) {
+    FilterRenderer[FilterRenderer["Numeric"] = 1] = "Numeric";
+    FilterRenderer[FilterRenderer["MultiSelect"] = 2] = "MultiSelect";
+    FilterRenderer[FilterRenderer["SingleSelect"] = 3] = "SingleSelect";
+    FilterRenderer[FilterRenderer["Text"] = 4] = "Text";
+    FilterRenderer[FilterRenderer["MultiValue"] = 5] = "MultiValue";
+})(FilterRenderer || (FilterRenderer = {}));
+/** An event broadcasted on table data changes
+ * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this class.
+ * @public
+ */
+export class TableDataChangeEvent extends BeEvent {
+}
 //# sourceMappingURL=TableDataProvider.js.map

package/lib/esm/components-react/table/TableDataProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"TableDataProvider.js","sourceRoot":"","sources":["../../../../src/components-react/table/TableDataProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAmB;CAAI","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Table\n */\n\nimport { BeEvent } from \"@itwin/core-bentley\";\n\n/** An event broadcasted on table data changes\n * @public  @deprecated\n */\nexport class TableDataChangeEvent extends BeEvent<() => void> { }\n"]}
+{"version":3,"file":"TableDataProvider.js","sourceRoot":"","sources":["../../../../src/components-react/table/TableDataProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAM9C,4CAA4C;AAC5C,gCAAgC;AAEhC;;;GAGG;AACH,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,yDAAW,CAAA;IACX,iEAAW,CAAA;IACX,mEAAY,CAAA;IACZ,mDAAI,CAAA;IACJ,+DAAU,CAAA;AACZ,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AA8GD;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAiC;CAAI","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 { BeEvent } from \"@itwin/core-bentley\";\r\nimport { PropertyDescription, PropertyRecord } from \"@itwin/appui-abstract\";\r\nimport { HorizontalAlignment, SortDirection } from \"@itwin/core-react\";\r\nimport { ItemColorOverrides, ItemStyle } from \"../properties/ItemStyle\";\r\nimport { CompositeFilterDescriptorCollection, DistinctValueCollection } from \"./columnfiltering/ColumnFiltering\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n// cSpell:ignore columnfiltering\r\n\r\n/** Filter Renderer for a Table column\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.\r\n * @public\r\n */\r\nexport enum FilterRenderer {\r\n  Numeric = 1,\r\n  MultiSelect,\r\n  SingleSelect,\r\n  Text,\r\n  MultiValue,\r\n}\r\n\r\n/**\r\n * Column definition provided to Table.\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.\r\n * @public\r\n */\r\nexport interface ColumnDescription {\r\n  /** A unique key for this column. */\r\n  key: string;\r\n\r\n  /** Column header label */\r\n  label: string;\r\n  /** Property description for all cells in the column */\r\n  propertyDescription?: PropertyDescription;\r\n\r\n  /** Preferred initial width of the column */\r\n  width?: number;\r\n\r\n  /** Indicates whether the cells in the column are editable. Defaults to false. */\r\n  editable?: boolean;\r\n  /** Indicates whether the column is resizable. Defaults to false. */\r\n  resizable?: boolean;\r\n  /** Indicates whether the display value for the cell is treated as an icon spec. Defaults to false. */\r\n  icon?: boolean;\r\n\r\n  /** Indicates whether the column is sortable. Defaults to false. */\r\n  sortable?: boolean;\r\n  /** Specifies a secondary sort column to use when cell values are the same. */\r\n  secondarySortColumn?: number;\r\n  /** Indicates whether the column sorting ignores case. Defaults to false. */\r\n  sortIgnoreCase?: boolean;\r\n\r\n  /** Indicates whether the column is filterable. Defaults to false. */\r\n  filterable?: boolean;\r\n  /** Specifies the filter renderer for the column. */\r\n  filterRenderer?: FilterRenderer;\r\n\r\n  /** Show field filters in Multi-Value column filtering popup. Defaults to true. */\r\n  showFieldFilters?: boolean;\r\n  /** Show distinct value checkboxes in Multi-Value column filtering popup. Defaults to true. */\r\n  showDistinctValueFilters?: boolean;\r\n  /** Filtering is case-sensitive in Multi-Value column filtering popup. Defaults to false. */\r\n  filterCaseSensitive?: boolean;\r\n\r\n  /** Sort type for react-table */\r\n  sortType?: string;\r\n}\r\n\r\n/**\r\n * Cell definition provided to Table.\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.\r\n * @public\r\n */\r\nexport interface CellItem {\r\n  /** Key for the column containing the cell */\r\n  key: string;\r\n  /** Property record for the cell */\r\n  record?: PropertyRecord;\r\n\r\n  /** Indicates whether the cell is disabled */\r\n  isDisabled?: boolean;\r\n  /** Specifies the horizontal alignment of the contents of the cell */\r\n  alignment?: HorizontalAlignment;\r\n\r\n  /** Style properties for the contents of the cell */\r\n  style?: ItemStyle;\r\n\r\n  /**\r\n   * Property to specify how many cells were merged to create this cell.\r\n   * Default value is 1.\r\n   * @alpha\r\n   */\r\n  mergedCellsCount?: number;\r\n}\r\n\r\n/**\r\n * Row definition provided to Table.\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.\r\n * @public\r\n */\r\nexport interface RowItem {\r\n  /** A unique key for this row */\r\n  key: string;\r\n  /** Array of cells in the row */\r\n  cells: CellItem[];\r\n  /** Indicates whether the row is disabled */\r\n  isDisabled?: boolean;\r\n  /** Color overrides for all cells in the row */\r\n  colorOverrides?: ItemColorOverrides;\r\n\r\n  /**\r\n   * A key-value pairs data structure that can be used by data provider\r\n   * to store some custom data for this node item.\r\n   */\r\n  extendedData?: { [key: string]: any };\r\n\r\n  /**\r\n   * Get the value from the cell for filtering purposes.\r\n   * If not specified and the value is a primitive, the recordValue.value is returned.\r\n   */\r\n  getValueFromCell?: (columnKey: string) => any;\r\n}\r\n\r\n/** An interface table data change listeners\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this type.\r\n * @public\r\n */\r\nexport declare type TableDataChangesListener = () => void;\r\n\r\n/** An event broadcasted on table data changes\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this class.\r\n * @public\r\n */\r\nexport class TableDataChangeEvent extends BeEvent<TableDataChangesListener> { }\r\n\r\n/**\r\n * TableDataProvider provides data to the Table.\r\n * It also provides support for data Sorting & Filtering.\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.\r\n * @public\r\n */\r\nexport interface TableDataProvider {\r\n  /** Event emitted by the data provider when column data changes */\r\n  onColumnsChanged: TableDataChangeEvent;\r\n  /** Event emitted by the data provider when row data changes */\r\n  onRowsChanged: TableDataChangeEvent;\r\n\r\n  /** Retrieves the column descriptions */\r\n  getColumns(): Promise<ColumnDescription[]>;\r\n  /** Retrieves the row count */\r\n  getRowsCount(): Promise<number>;\r\n  /** Retrieves a specific row by index */\r\n  getRow(rowIndex: number, unfiltered?: boolean): Promise<RowItem>;\r\n\r\n  /** Sorts the rows based on the value in a specific column */\r\n  sort(columnIndex: number, sortDirection: SortDirection): Promise<void>;\r\n\r\n  // Column Filtering methods\r\n\r\n  /** Apply a filter descriptor collection\r\n   */\r\n  applyFilterDescriptors?: (filterDescriptors: CompositeFilterDescriptorCollection) => Promise<void>;\r\n\r\n  /** Gets distinct values in a column\r\n   */\r\n  getDistinctValues?: (columnKey: string, maximumValueCount?: number) => Promise<DistinctValueCollection>;\r\n\r\n  /** Gets property display value expression\r\n   * @alpha\r\n   */\r\n  getPropertyDisplayValueExpression?: (property: string) => string;\r\n}\r\n\r\n/**\r\n * MutableTableDataProvider provides mutation methods for data in the Table.\r\n * Useful for Drag & Drop processing.\r\n * @deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.\r\n * @public\r\n */\r\nexport interface MutableTableDataProvider extends TableDataProvider {\r\n  /** Adds a row to the end */\r\n  addRow(rowItem: RowItem): number;\r\n  /** Inserts a row at a given row index */\r\n  insertRow(rowItem: RowItem, index: number): number;\r\n  /** Deletes a row */\r\n  deleteRow(rowItem: RowItem): void;\r\n  /** Moves a row to a new row index */\r\n  moveRow(rowItem: RowItem, newIndex: number): number;\r\n}\r\n"]}