@univerjs/sheets-filter v0.1.17 • Docs

Class: FilterColumn

This is the filter criteria on a specific column.

Extends

Disposable

Constructors

new FilterColumn()

new FilterColumn(
   unitId, 
   subUnitId, 
   _worksheet, 
   _criteria, 
   _filterColumnContext): FilterColumn

Parameters

Parameter	Type	Description
`unitId`	`string`	-
`subUnitId`	`string`	-
`_worksheet`	`Worksheet`	-
`_criteria`	`IFilterColumn`	A `FilterColumn` instance should not be created without a filter criteria.
`_filterColumnContext`	`IFilterColumnContext`	-

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	core/src/shared/lifecycle.ts:93 (opens in a new tab)
`subUnitId`	`readonly`	`string`	`undefined`	-	sheets-filter/src/models/filter-model.ts:308 (opens in a new tab)
`unitId`	`readonly`	`string`	`undefined`	-	sheets-filter/src/models/filter-model.ts:307 (opens in a new tab)

Accessors

filteredOutRows

get filteredOutRows(): Readonly<Nullable<Set<number>>>

Returns

Readonly<Nullable<Set<number>>>

Defined in

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

Methods

__clearCache()

__clearCache(): void

Internal

Returns

void

Defined in

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

calc()

calc(context): Readonly<Nullable<Set<number>>>

Parameters

Parameter	Type
`context`	`IFilterColumnContext`

Returns

Readonly<Nullable<Set<number>>>

Defined in

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

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

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

disposeWithMe()

protected 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)

getColumnData()

getColumnData(): Readonly<IFilterColumn>

Returns

Readonly<IFilterColumn>

Defined in

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

hasCache()

hasCache(): boolean

Returns

boolean

Defined in

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

reCalc()

reCalc(): Readonly<Nullable<Set<number>>>

Trigger new calculation on this FilterModel instance.

Returns

Readonly<Nullable<Set<number>>>

External

DO NOT EVER call this method from FilterColumn itself. The whole process heavily relies on filteredOutByOthers, and it is more comprehensible if we let FilterModel take full control over the process.