@univerjs/sheets-filter 0.4.1 → 0.4.2-nightly.202410301606

package/lib/es/facade.js

@@ -0,0 +1,133 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: !0 });
+import { Inject, Injector, ICommandService } from "@univerjs/core";
+import { FRange, FWorksheet } from "@univerjs/sheets/facade";
+import { r as SetSheetsFilterCriteriaCommand, m as ClearSheetsFilterCriteriaCommand, p as RemoveSheetFilterCommand, q as SetSheetFilterRangeCommand, a as SheetsFilterService } from "../sheets-filter.command-CL_iGKJ6.mjs";
+var __defProp2 = Object.defineProperty, __getOwnPropDesc = Object.getOwnPropertyDescriptor, __decorateClass = /* @__PURE__ */ __name((decorators, target, key, kind) => {
+  for (var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target, i = decorators.length - 1, decorator; i >= 0; i--)
+    (decorator = decorators[i]) && (result = (kind ? decorator(target, key, result) : decorator(result)) || result);
+  return kind && result && __defProp2(target, key, result), result;
+}, "__decorateClass"), __decorateParam = /* @__PURE__ */ __name((index, decorator) => (target, key) => decorator(target, key, index), "__decorateParam"), _a;
+let FFilter = (_a = class {
+  constructor(_workbook, _worksheet, _filterModel, _injector, _commandSrv) {
+    this._workbook = _workbook, this._worksheet = _worksheet, this._filterModel = _filterModel, this._injector = _injector, this._commandSrv = _commandSrv;
+  }
+  /**
+   * Get the filtered out rows by this filter.
+   * @returns {number[]} Filtered out rows by this filter.
+   */
+  getFilteredOutRows() {
+    return Array.from(this._filterModel.filteredOutRows).sort();
+  }
+  /**
+   * Get the filter criteria of a column.
+   * @param {number} col The column number.
+   * @returns {Nullable<IFilterColumn>} The filter criteria of the column.
+   */
+  getColumnFilterCriteria(col) {
+    var _a2;
+    return (_a2 = this._filterModel.getFilterColumn(col)) == null ? void 0 : _a2.getColumnData();
+  }
+  /**
+   * Clear the filter criteria of a column.
+   * @param {number} col The column number.
+   * @returns {Promise<boolean>} If the filter criteria is cleared.
+   */
+  removeColumnFilterCriteria(col) {
+    return this._commandSrv.executeCommand(SetSheetsFilterCriteriaCommand.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      col,
+      criteria: null
+    });
+  }
+  /**
+   * Set the filter criteria of a column.
+   * @param {number} col  The column number.
+   * @param {ISetSheetsFilterCriteriaCommandParams['criteria']} criteria The new filter criteria.
+   * @returns {Promise<boolean>} If the filter criteria is set.
+   */
+  setColumnFilterCriteria(col, criteria) {
+    return this._commandSrv.executeCommand(SetSheetsFilterCriteriaCommand.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      col,
+      criteria
+    });
+  }
+  /**
+   * Get the range of the filter.
+   * @returns {FRange} The range of the filter.
+   */
+  getRange() {
+    const range = this._filterModel.getRange();
+    return this._injector.createInstance(FRange, this._workbook, this._worksheet, range);
+  }
+  /**
+   * Remove the filter criteria of all columns.
+   * @returns {Promise<boolean>} If the filter criteria is removed.
+   */
+  removeFilterCriteria() {
+    return this._commandSrv.executeCommand(ClearSheetsFilterCriteriaCommand.id);
+  }
+  /**
+   * Remove the filter from the worksheet.
+   * @returns {Promise<boolean>} If the filter is removed.
+   */
+  remove() {
+    return this._commandSrv.executeCommand(RemoveSheetFilterCommand.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId()
+    });
+  }
+}, __name(_a, "FFilter"), _a);
+FFilter = __decorateClass([
+  __decorateParam(3, Inject(Injector)),
+  __decorateParam(4, ICommandService)
+], FFilter);
+const _FRangeFilter = class _FRangeFilter extends FRange {
+  async createFilter() {
+    return this._getFilterModel() || !await this._commandService.executeCommand(SetSheetFilterRangeCommand.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      range: this._range
+    }) ? null : this.getFilter();
+  }
+  /**
+   * Get the filter for the current range's worksheet.
+   *
+   * @return {FFilter | null} The interface class to handle the filter. If the worksheet does not have a filter,
+   * this method would return `null`.
+   */
+  getFilter() {
+    const filterModel = this._getFilterModel();
+    return filterModel ? this._injector.createInstance(FFilter, this._workbook, this._worksheet, filterModel) : null;
+  }
+  _getFilterModel() {
+    return this._injector.get(SheetsFilterService).getFilterModel(
+      this._workbook.getUnitId(),
+      this._worksheet.getSheetId()
+    );
+  }
+};
+__name(_FRangeFilter, "FRangeFilter");
+let FRangeFilter = _FRangeFilter;
+FRange.extend(FRangeFilter);
+const _FWorksheetFilter = class _FWorksheetFilter extends FWorksheet {
+  getFilter() {
+    const filterModel = this._getFilterModel();
+    return filterModel ? this._injector.createInstance(FFilter, this._workbook, this._worksheet, filterModel) : null;
+  }
+  _getFilterModel() {
+    return this._injector.get(SheetsFilterService).getFilterModel(
+      this._workbook.getUnitId(),
+      this._worksheet.getSheetId()
+    );
+  }
+};
+__name(_FWorksheetFilter, "FWorksheetFilter");
+let FWorksheetFilter = _FWorksheetFilter;
+FWorksheet.extend(FWorksheetFilter);
+export {
+  FFilter
+};