Class: RangeThemeStyle

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:110

Range theme style

Description

The range theme style is used to set the style of the range.This class is used to create a build-in theme style or a custom theme style.

Constructors

new RangeThemeStyle()

new RangeThemeStyle(name, options?): RangeThemeStyle

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:160

Parameters

Parameter	Type	Description
`name`	`string`	The name of the range theme style, it used to identify the range theme style.
`options`?	`Omit`<`IRangeThemeStyleJSON`, `"name"`>	The options to initialize the range theme style.

Returns

RangeThemeStyle

Properties

Property	Type	Default value	Defined in
`firstColumnStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:141
`firstRowStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:129
`headerColumnStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:124
`headerRowStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:120
`lastColumnStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:149
`lastRowStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:137
`secondColumnStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:145
`secondRowStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:133
`wholeStyle`	`Nullable`<`IRangeThemeStyleItem`>	`null`	submodules/univer/packages/sheets/src/model/range-theme-util.ts:115

Methods

dispose()

dispose(): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:428

Returns

void

fromJson()

fromJson(json): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:389

Parameters

Parameter	Type
`json`	`IRangeThemeStyleJSON`

Returns

void

getFirstColumnStyle()

getFirstColumnStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:208

Returns

Nullable<IRangeThemeStyleItem>

getFirstRowStyle()

getFirstRowStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:184

Returns

Nullable<IRangeThemeStyleItem>

getHeaderColumnStyle()

getHeaderColumnStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:240

Returns

Nullable<IRangeThemeStyleItem>

getHeaderRowStyle()

getHeaderRowStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:232

Returns

Nullable<IRangeThemeStyleItem>

getLastColumnStyle()

getLastColumnStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:224

Returns

Nullable<IRangeThemeStyleItem>

getLastRowStyle()

getLastRowStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:200

Returns

Nullable<IRangeThemeStyleItem>

getName()

getName(): string

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:172

Gets the name of the range theme style.The name is read only, and use to identifier the range theme style.

Returns

string

The name of the range theme style.

getSecondColumnStyle()

getSecondColumnStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:216

Returns

Nullable<IRangeThemeStyleItem>

getSecondRowStyle()

getSecondRowStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:192

Returns

Nullable<IRangeThemeStyleItem>

getStyle()

getStyle(
   offsetRow, 
   offsetCol, 
   isLastRow, 
   isLastCol): null | IRangeThemeStyleItem

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:248

Parameters

Parameter	Type
`offsetRow`	`number`
`offsetCol`	`number`
`isLastRow`	`boolean`
`isLastCol`	`boolean`

Returns

null | IRangeThemeStyleItem

getWholeStyle()

getWholeStyle(): Nullable<IRangeThemeStyleItem>

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:176

Returns

Nullable<IRangeThemeStyleItem>

setFirstColumnStyle()

setFirstColumnStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:212

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setFirstRowStyle()

setFirstRowStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:188

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setHeaderColumnStyle()

setHeaderColumnStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:244

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setHeaderRowStyle()

setHeaderRowStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:236

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setLastColumnStyle()

setLastColumnStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:228

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setLastRowStyle()

setLastRowStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:204

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setSecondColumnStyle()

setSecondColumnStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:220

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setSecondRowStyle()

setSecondRowStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:196

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

setWholeStyle()

setWholeStyle(style): void

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:180

Parameters

Parameter	Type
`style`	`Nullable`<`IRangeThemeStyleItem`>

Returns

void

toJson()

toJson(): IRangeThemeStyleJSON

Defined in: submodules/univer/packages/sheets/src/model/range-theme-util.ts:346

Returns

IRangeThemeStyleJSON

Rangeprotectionservice Refrangeservice