@univerjssheetsindexclassesSheetrangethemeservice

@univerjs/sheets v0.5.4


Class: SheetRangeThemeService

Defined in: submodules/univer/packages/sheets/src/services/range-theme-service.ts:22

Extends

Constructors

new SheetRangeThemeService()

new SheetRangeThemeService(_sheetRangeThemeModel): SheetRangeThemeService

Defined in: submodules/univer/packages/sheets/src/services/range-theme-service.ts:23

Parameters

ParameterType
_sheetRangeThemeModelSheetRangeThemeModel

Returns

SheetRangeThemeService

Overrides

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96

Methods

dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed


getALLRegisterThemes()

getALLRegisterThemes(): string[]

Defined in: submodules/univer/packages/sheets/src/services/range-theme-service.ts:42

Get custom register themes name list

Returns

string[]

The list of custom register themes name.


getAppliedRangeThemeStyle()

getAppliedRangeThemeStyle(rangeInfo): undefined | string

Defined in: submodules/univer/packages/sheets/src/services/range-theme-service.ts:60

Get applied range theme style name.

Parameters

ParameterTypeDescription
rangeInfoIRangeThemeRangeInfoThe range info to get the applied theme style.

Returns

undefined | string

The applied theme style name or not exist.


getRegisteredRangeThemes()

getRegisteredRangeThemes(): string[]

Defined in: submodules/univer/packages/sheets/src/services/range-theme-service.ts:67

Get registered build-in range theme style

Returns

string[]


registerRangeTheme()

registerRangeTheme(unitId, rangeThemeStyle): void

Defined in: submodules/univer/packages/sheets/src/services/range-theme-service.ts:34

Register a custom range theme style.

Parameters

ParameterTypeDescription
unitIdstringWhich unit to register the range theme style.
rangeThemeStyleRangeThemeStyleThe range theme style to register.

Returns

void


registerRangeThemeStyle()

registerRangeThemeStyle(themeName, rangeInfo): void

Defined in: submodules/univer/packages/sheets/src/services/range-theme-service.ts:51

Register range theme style to the range.

Parameters

ParameterTypeDescription
themeNamestringThe defined theme name.
rangeInfoIRangeThemeRangeInfoThe range info to apply the theme style.

Returns

void