@univerjssheets-filterindexReadme

@univerjs/sheets-filter v0.5.0-beta.1 • Docs

index

Index

Enumerations

EnumerationDescription
CustomFilterOperatorThese basic operators are defined in 18.18.31.

Classes

ClassDescription
FilterColumnThis is the filter criteria on a specific column.
FilterModelThis is the in-memory model of filter.
SheetsFilterServiceThis service is responsible for managing filter models, especially their lifecycle.
UniverSheetsFilterPluginPlug-in base class, all plug-ins must inherit from this base class. Provide basic methods.

Interfaces

InterfaceDescription
IAutoFilterData of a filter in a Worksheet.
ICustomFilterA custom filter.
ICustomFiltersCustom filters.
IFilterColumnThe filter criteria of a column.
IFiltersBasic filters (filter by value).
ISetSheetFilterRangeCommandParamsParameters of command SetSheetFilterRangeCommand.
ISetSheetsFilterCriteriaCommandParamsParameters of command SetSheetsFilterCriteriaCommand.
ISetSheetsFilterCriteriaMutationParamsParameters of mutation SetSheetsFilterCriteriaMutation.
ISetSheetsFilterRangeMutationParamsParameters of mutation SetSheetsFilterRangeMutation.

Variables

VariableDescription
ClearSheetsFilterCriteriaCommandA CommandType.COMMAND to clear all filter criteria in the targeting FilterModel. Its params ISheetCommandSharedParams is required.
equals-
FILTER_MUTATIONS-
greaterThan-
greaterThanOrEqualTo-
lessThan-
lessThanOrEqualTo-
notEquals-
ReCalcSheetsFilterCommandA CommandType.COMMAND forcing the currently active FilterModel to re-calculate all filter criteria. Its params ISheetCommandSharedParams is required.
ReCalcSheetsFilterMutationA CommandType.MUTATION to re-calculate a FilterModel.
RemoveSheetFilterCommandA CommandType.COMMAND to remove filter in a Worksheet. Its params ISheetCommandSharedParams is required. If the FilterModel does not exist, it will fail to execute.
RemoveSheetsFilterMutationA CommandType.MUTATION to remove a FilterModel in a Worksheet.
SetSheetFilterRangeCommandA CommandType.COMMAND to set filter range in a Worksheet. Its params ISetSheetFilterRangeCommandParams is required. If the FilterModel does not exist, it will be created.
SetSheetsFilterCriteriaCommandA CommandType.COMMAND to set filter criteria to a column in the targeting FilterModel. Its params ISetSheetsFilterCriteriaCommandParams is required.
SetSheetsFilterCriteriaMutationA CommandType.MUTATION to set filter criteria of a given column of a FilterModel.
SetSheetsFilterRangeMutationA CommandType.MUTATION to set filter range in a Worksheet. If no FilterModel exists, a new FilterModel will be created.
SHEET_FILTER_SNAPSHOT_ID-
SmartToggleSheetsFilterCommandA CommandType.COMMAND to toggle filter in the current Worksheet.

Functions

FunctionDescription
getCustomFilterFn-
FfilterFiltercolumn