@univerjs/sheets-filter v0.1.17 • Docs

Class: SheetsFilterService

This service is responsible for managing filter models, especially their lifecycle.

Extends

• Disposable

Constructors

new SheetsFilterService()

new SheetsFilterService(
   _resourcesManagerService, 
   _univerInstanceService, 
   _commandService): SheetsFilterService

Parameters

Returns

SheetsFilterService

Overrides

Disposable.constructor

Defined in

sheets-filter/src/services/sheet-filter.service.ts:71 (opens in a new tab)

Properties

Accessors

activeFilterModel

get activeFilterModel(): Nullable<FilterModel>

The current Workbook's active Worksheet's filter model (if there is one).

Returns

Nullable<FilterModel>

Defined in

sheets-filter/src/services/sheet-filter.service.ts:69 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

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

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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

ensureFilterModel()

ensureFilterModel(unitId, subUnitId): FilterModel

Parameters

Returns

FilterModel

Defined in

sheets-filter/src/services/sheet-filter.service.ts:86 (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)

getFilterModel()

getFilterModel(unitId, subUnitId): Nullable<FilterModel>

Parameters

Returns

Nullable<FilterModel>

Defined in

sheets-filter/src/services/sheet-filter.service.ts:107 (opens in a new tab)

removeFilterModel()

removeFilterModel(unitId, subUnitId): boolean

Parameters

Returns

boolean

Defined in

sheets-filter/src/services/sheet-filter.service.ts:111 (opens in a new tab)

setFilterErrorMsg()

setFilterErrorMsg(content): void

Parameters

Returns

void

Defined in

sheets-filter/src/services/sheet-filter.service.ts:122 (opens in a new tab)