@univerjs/sheets-filter v0.5.4

Class: SheetsFilterService

Defined in: sheets-filter/src/services/sheet-filter.service.ts:41

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

Extends

• Disposable

Constructors

new SheetsFilterService()

new SheetsFilterService(
   _resourcesManagerService, 
   _univerInstanceService, 
   _commandService): SheetsFilterService

Defined in: sheets-filter/src/services/sheet-filter.service.ts:56

Parameters

Returns

SheetsFilterService

Overrides

Disposable.constructor

Properties

Accessors

activeFilterModel

Get Signature

get activeFilterModel(): Nullable<FilterModel>

Defined in: sheets-filter/src/services/sheet-filter.service.ts:54

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

Returns

Nullable<FilterModel>

Methods

dispose()

dispose(): void

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

Returns

void

Inherited from

Disposable.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

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

Parameters

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

ensureFilterModel()

ensureFilterModel(unitId, subUnitId): FilterModel

Defined in: sheets-filter/src/services/sheet-filter.service.ts:72

Parameters

Returns

FilterModel

ensureNotDisposed()

protected ensureNotDisposed(): void

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

Returns

void

Inherited from

Disposable.ensureNotDisposed

getFilterModel()

getFilterModel(unitId, subUnitId): Nullable<FilterModel>

Defined in: sheets-filter/src/services/sheet-filter.service.ts:93

Parameters

Returns

Nullable<FilterModel>

removeFilterModel()

removeFilterModel(unitId, subUnitId): boolean

Defined in: sheets-filter/src/services/sheet-filter.service.ts:97

Parameters

Returns

boolean

setFilterErrorMsg()

setFilterErrorMsg(content): void

Defined in: sheets-filter/src/services/sheet-filter.service.ts:108

Parameters

Returns

void