@univerjs/sheets-filter v0.4.2 • Docs

Class: FilterModel

This is the in-memory model of filter.

Extends

Disposable

Constructors

new FilterModel()

new FilterModel(
   unitId, 
   subUnitId, 
   _worksheet): FilterModel

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`_worksheet`	`Worksheet`

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	-	`Disposable`.`_disposed`	core/src/shared/lifecycle.ts:93 (opens in a new tab)
`filteredOutRows$`	`readonly`	`Observable`<`Readonly`<`Set`<`number`>>>	`undefined`	An observable value. A set of filtered out rows.	-	sheets-filter/src/models/filter-model.ts:32 (opens in a new tab)
`hasCriteria$`	`readonly`	`Observable`<`boolean`>	`undefined`	-	-	sheets-filter/src/models/filter-model.ts:41 (opens in a new tab)
`subUnitId`	`readonly`	`string`	`undefined`	-	-	sheets-filter/src/models/filter-model.ts:51 (opens in a new tab)
`unitId`	`readonly`	`string`	`undefined`	-	-	sheets-filter/src/models/filter-model.ts:50 (opens in a new tab)

Accessors

filteredOutRows

get filteredOutRows(): Set<number>

set filteredOutRows(rows): void

Parameters

Parameter	Type
`rows`	`Set`<`number`>

Returns

Set<number>

Defined in

sheets-filter/src/models/filter-model.ts:33 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

sheets-filter/src/models/filter-model.ts:57 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100 (opens in a new tab)

getAllFilterColumns()

getAllFilterColumns(): [number, FilterColumn][]

Returns

[number, FilterColumn][]

Defined in

sheets-filter/src/models/filter-model.ts:190 (opens in a new tab)

getFilterColumn()

getFilterColumn(index): Nullable<FilterColumn>

Parameters

Parameter	Type
`index`	`number`

Returns

Nullable<FilterColumn>

Defined in

sheets-filter/src/models/filter-model.ts:194 (opens in a new tab)

getFilteredOutRowsExceptCol()

getFilteredOutRowsExceptCol(col): Set<number>

Get filtered out rows except the specific column. This method is considered as "pure". In another word it would not change filteredOutRows on FilterModel nor FilterColumn.

Parameters

Parameter	Type
`col`	`number`

Returns

Set<number>

Defined in

sheets-filter/src/models/filter-model.ts:130 (opens in a new tab)

getRange()

getRange(): IRange

Returns

IRange

Defined in

sheets-filter/src/models/filter-model.ts:117 (opens in a new tab)

isRowFiltered()

isRowFiltered(row): boolean

Parameters

Parameter	Type
`row`	`number`

Returns

boolean

Defined in

sheets-filter/src/models/filter-model.ts:113 (opens in a new tab)

reCalc()

reCalc(): void

Returns

void

Defined in

sheets-filter/src/models/filter-model.ts:198 (opens in a new tab)

serialize()

serialize(): IAutoFilter

Serialize this filter model to the JSON format representation.

Returns

IAutoFilter

Defined in

sheets-filter/src/models/filter-model.ts:67 (opens in a new tab)

setCriteria()

setCriteria(
   col, 
   criteria, 
   reCalc): void

Set or remove filter criteria on a specific row.

Parameters

Parameter	Type	Default value
`col`	`number`	`undefined`
`criteria`	`Nullable`<`IFilterColumn`>	`undefined`
`reCalc`	`boolean`	`false`

Returns

void

Defined in

sheets-filter/src/models/filter-model.ts:165 (opens in a new tab)

setRange()

setRange(range): void

Set range of the filter model, this would remove some IFilterColumn if the new range not overlaps the old range.

Parameters

Parameter	Type
`range`	`IRange`

Returns

void

Defined in

sheets-filter/src/models/filter-model.ts:144 (opens in a new tab)

deserialize()

static deserialize(
   unitId, 
   subUnitId, 
   worksheet, 
   autoFilter): FilterModel

Deserialize auto filter info to construct a FilterModel object.

Parameters

Parameter	Type	Description
`unitId`	`string`	workbook id
`subUnitId`	`string`	worksheet id
`worksheet`	`Worksheet`	the Worksheet object
`autoFilter`	`IAutoFilter`	auto filter data

Returns

FilterModel

Defined in

sheets-filter/src/models/filter-model.ts:89 (opens in a new tab)

Filtercolumn Sheetsfilterservice