@univerjs/sheets-filter v0.5.0-beta.1 • 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`	-

Returns

FilterColumn

Overrides

Disposable.constructor

Defined in

sheets-filter/src/models/filter-model.ts:306

Properties

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

Accessors

filteredOutRows

Get Signature

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

Returns

Readonly<Nullable<Set<number>>>

Defined in

sheets-filter/src/models/filter-model.ts:296

Methods

__clearCache()

__clearCache(): void

Internal

Returns

void

Defined in

sheets-filter/src/models/filter-model.ts:329

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

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

sheets-filter/src/models/filter-model.ts:320

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100

getColumnData()

getColumnData(): Readonly<IFilterColumn>

Returns

Readonly<IFilterColumn>

Defined in

sheets-filter/src/models/filter-model.ts:362

hasCache()

hasCache(): boolean

Returns

boolean

Defined in

sheets-filter/src/models/filter-model.ts:344

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.

Defined in

sheets-filter/src/models/filter-model.ts:372

serialize()

serialize(): IFilterColumn

Returns

IFilterColumn

Defined in

sheets-filter/src/models/filter-model.ts:333

setCriteria()

setCriteria(criteria): void

Parameters

Parameter	Type
`criteria`	`IFilterColumn`

Returns

void

Defined in

sheets-filter/src/models/filter-model.ts:354

setRangeAndColumn()

setRangeAndColumn(range, column): void

Parameters

Parameter	Type
`range`	`IRange`
`column`	`number`

Returns

void

Defined in

sheets-filter/src/models/filter-model.ts:349

Readme Filtermodel