@univerjs/sheets-filter v0.4.2 • Docs
@univerjs/sheets-filter
Enumerations
| Enumeration | Description |
|---|---|
| CustomFilterOperator | These basic operators are defined in 18.18.31. |
Classes
| Class | Description |
|---|---|
| FilterColumn | This is the filter criteria on a specific column. |
| FilterModel | This is the in-memory model of filter. |
| SheetsFilterService | This service is responsible for managing filter models, especially their lifecycle. |
| UniverSheetsFilterPlugin | Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods. |
Interfaces
| Interface | Description |
|---|---|
| IAutoFilter | Data of a filter in a Worksheet. |
| ICustomFilter | A custom filter. |
| ICustomFilters | Custom filters. |
| IFilterColumn | The filter criteria of a column. |
| IFilters | Basic filters (filter by value). |
| ISetSheetsFilterCriteriaMutationParams | Parameters of mutation SetSheetsFilterCriteriaMutation. |
| ISetSheetsFilterRangeMutationParams | Parameters of mutation SetSheetsFilterRangeMutation. |
Variables
| Variable | Description |
|---|---|
| FILTER_MUTATIONS | - |
| ReCalcSheetsFilterMutation | A CommandType.MUTATION to re-calculate a FilterModel. |
| RemoveSheetsFilterMutation | A CommandType.MUTATION to remove a FilterModel in a Worksheet. |
| SHEET_FILTER_SNAPSHOT_ID | - |
| SetSheetsFilterCriteriaMutation | A CommandType.MUTATION to set filter criteria of a given column of a FilterModel. |
| SetSheetsFilterRangeMutation | A CommandType.MUTATION to set filter range in a Worksheet. If no FilterModel exists, a new FilterModel will be created. |
| equals | - |
| greaterThan | - |
| greaterThanOrEqualTo | - |
| lessThan | - |
| lessThanOrEqualTo | - |
| notEquals | - |
Functions
| Function | Description |
|---|---|
| getCustomFilterFn | - |