Class: FilterColumn

Defined in: sheets-filter/src/models/filter-model.ts:294

This is the filter criteria on a specific column.

Extends

Disposable

Constructors

new FilterColumn()

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

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

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

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	core/src/shared/lifecycle.ts:96
`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>>>

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

Returns

Readonly<Nullable<Set<number>>>

Methods

__clearCache()

__clearCache(): void

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

Internal

Returns

void

calc()

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

Defined in: sheets-filter/src/models/filter-model.ts:377

Parameters

Parameter	Type
`context`	`IFilterColumnContext`

Returns

Readonly<Nullable<Set<number>>>

dispose()

dispose(): void

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

Returns

void

Overrides

Disposable.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: core/src/shared/lifecycle.ts:99

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed

getColumnData()

getColumnData(): Readonly<IFilterColumn>

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

Returns

Readonly<IFilterColumn>

hasCache()

hasCache(): boolean

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

Returns

boolean

reCalc()

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

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

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.

serialize()

serialize(): IFilterColumn

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

Returns

IFilterColumn

setCriteria()

setCriteria(criteria): void

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

Parameters

Parameter	Type
`criteria`	`IFilterColumn`

Returns

void

setRangeAndColumn()

setRangeAndColumn(range, column): void

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

Parameters

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

Returns

void

Readme Filtermodel