FRangeFilter
| packages | @univerjs/sheets-filter |
|---|
APIs
createFilter
Create a filter for the current range. If the worksheet already has a filter, this method would return null.
Signature
createFilter(): FFilter | nullReturns
- (
FFilter | null) — The FFilter instance to handle the filter.
Examples
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1:D14')
let fFilter = fRange.createFilter()
// If the worksheet already has a filter, remove it and create a new filter.
if (!fFilter) {
fWorksheet.getFilter().remove()
fFilter = fRange.createFilter()
}
console.log(fFilter, fFilter.getRange().getA1Notation())getFilter
Get the filter for the current range's worksheet.
Signature
getFilter(): FFilter | nullReturns
- (
FFilter | null) — The interface class to handle the filter. If the worksheet does not have a filter, this method would returnnull.
Examples
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1:D14')
let fFilter = fRange.getFilter()
// If the worksheet does not have a filter, create a new filter.
if (!fFilter) {
fFilter = fRange.createFilter()
}
console.log(fFilter, fFilter.getRange().getA1Notation())