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
Parameter | Type |
---|---|
_sheetRangeThemeModel | SheetRangeThemeModel |
Returns
Overrides
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | submodules/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
disposeWithMe()
disposeWithMe(disposable): IDisposable
Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
ensureNotDisposed()
protected ensureNotDisposed(): void
Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103
Returns
void
Inherited from
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
Parameter | Type | Description |
---|---|---|
rangeInfo | IRangeThemeRangeInfo | The 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
Parameter | Type | Description |
---|---|---|
unitId | string | Which unit to register the range theme style. |
rangeThemeStyle | RangeThemeStyle | The 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
Parameter | Type | Description |
---|---|---|
themeName | string | The defined theme name. |
rangeInfo | IRangeThemeRangeInfo | The range info to apply the theme style. |
Returns
void