@univerjs/sheets-filter-ui v0.4.2 • Docs
@univerjs/sheets-filter-ui
Classes
| Class | Description |
|---|---|
| UniverSheetsFilterMobileUIPlugin | Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods. |
| UniverSheetsFilterUIPlugin | The plugin for the desktop version of the sheets filter UI. Its type is UniverInstanceType.UNIVER_SHEET. |
| UniverSheetsFilterUIWorkerPlugin | Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods. |
Interfaces
| Interface | Description |
|---|---|
| IOpenFilterPanelOperationParams | - |
| ISetSheetFilterRangeCommandParams | Parameters of command SetSheetFilterRangeCommand. |
| ISetSheetsFilterCriteriaCommandParams | Parameters of command SetSheetsFilterCriteriaCommand. |
Variables
| Variable | Description |
|---|---|
| ChangeFilterByOperation | - |
| ClearSheetsFilterCriteriaCommand | A CommandType.COMMAND to clear all filter criteria in the targeting FilterModel. Its params ISheetCommandSharedParams is required. |
| CloseFilterPanelOperation | - |
| OpenFilterPanelOperation | The operation to open the filter panel and prepare for changing the filter conditions on a given column. |
| ReCalcSheetsFilterCommand | A CommandType.COMMAND forcing the currently active FilterModel to re-calculate all filter criteria. Its params ISheetCommandSharedParams is required. |
| RemoveSheetFilterCommand | A CommandType.COMMAND to remove filter in a Worksheet. Its params ISheetCommandSharedParams is required. If the FilterModel does not exist, it will fail to execute. |
| SetSheetFilterRangeCommand | A CommandType.COMMAND to set filter range in a Worksheet. Its params ISetSheetFilterRangeCommandParams is required. If the FilterModel does not exist, it will be created. |
| SetSheetsFilterCriteriaCommand | A CommandType.COMMAND to set filter criteria to a column in the targeting FilterModel. Its params ISetSheetsFilterCriteriaCommandParams is required. |
| SmartToggleSheetsFilterCommand | A CommandType.COMMAND to toggle filter in the current Worksheet. |