@univerjs/facade v0.2.14 • Docs
Class: FFilter
This interface class provides methods to modify the filter settings of a worksheet.
Constructors
new FFilter()
new FFilter(
_workbook,
_worksheet,
_filterModel,
_injector,
_commandSrv): FFilterParameters
| Parameter | Type |
|---|---|
_workbook | Workbook |
_worksheet | Worksheet |
_filterModel | FilterModel |
_injector | Injector |
_commandSrv | ICommandService |
Returns
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:29 (opens in a new tab)
Methods
getColumnFilterCriteria()
getColumnFilterCriteria(col): Nullable<IFilterColumn>Get the filter criteria of a column.
Parameters
| Parameter | Type | Description |
|---|---|---|
col | number | The column number. |
Returns
The filter criteria of the column.
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:52 (opens in a new tab)
getFilteredOutRows()
getFilteredOutRows(): number[]Get the filtered out rows by this filter.
Returns
number[]
Filtered out rows by this filter.
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:43 (opens in a new tab)
getRange()
getRange(): FRangeGet the range of the filter.
Returns
The range of the filter.
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:89 (opens in a new tab)
remove()
remove(): Promise<boolean>Remove the filter from the worksheet.
Returns
Promise<boolean>
If the filter is removed.
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:106 (opens in a new tab)
removeColumnFilterCriteria()
removeColumnFilterCriteria(col): Promise<boolean>Clear the filter criteria of a column.
Parameters
| Parameter | Type | Description |
|---|---|---|
col | number | The column number. |
Returns
Promise<boolean>
If the filter criteria is cleared.
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:61 (opens in a new tab)
removeFilterCriteria()
removeFilterCriteria(): Promise<boolean>Remove the filter criteria of all columns.
Returns
Promise<boolean>
If the filter criteria is removed.
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:98 (opens in a new tab)
setColumnFilterCriteria()
setColumnFilterCriteria(col, criteria): Promise<boolean>Set the filter criteria of a column.
Parameters
| Parameter | Type | Description |
|---|---|---|
col | number | The column number. |
criteria | Nullable<IFilterColumn> | The new filter criteria. |
Returns
Promise<boolean>
If the filter criteria is set.
Defined in
submodules/univer/packages/facade/src/apis/sheets/f-filter.ts:76 (opens in a new tab)