Class Empty

Special table style that doesn't style anything. This is used for tables that have their format's cleared.

Implements

ITableStyle

Index

Constructors

Accessors

Methods

delete getName getProperties getRanged isBuiltIn isShownInPivotStyles isShownInTableStyles toJSON

Constructors

constructor

new Empty(normalStyle: IStyle): Empty
Parameters
- normalStyle: IStyle
Returns Empty

Accessors

isITableStyle

get isITableStyle(): true
For runtime type checking.

Returns true
Implementation of ITableStyle.isITableStyle

Methods

delete

delete(): void
Delete the style from the collection.

Returns void
Remarks
This will only remove if the style is not a built-in style.

Implementation of ITableStyle.delete

getName

getName(): string
Returns the name of the table style.

Returns string
The name of the table style as a string.

Implementation of ITableStyle.getName

getProperties

getProperties(): Readonly<ITableStyle.Properties>
Returns the readonly list of properties for the style.

Returns Readonly<ITableStyle.Properties>
Remarks
This are unresolved properties.

Implementation of ITableStyle.getProperties

getRanged

getRanged(_table: ITable): ICellRanged<IStyle.Properties<Serializable>>
Returns a ranged interface for applying this style to a specific table.
Parameters
- _table: ITable
  The target ITable to which this style will be applied.
Returns ICellRanged<IStyle.Properties<Serializable>>
An ICellRanged interface containing properties for IStyle.

Implementation of ITableStyle.getRanged

isBuiltIn

isBuiltIn(): true
Indicates whether this style is a built-in, predefined style.

Returns true
true if the style is a built-in style; otherwise, false.

Implementation of ITableStyle.isBuiltIn

isShownInPivotStyles

isShownInPivotStyles(): boolean
Indicates whether this style appears in the list of pivot table styles available for selection.

Returns boolean
true if the style is shown in the pivot table styles list; otherwise, false.

Implementation of ITableStyle.isShownInPivotStyles

isShownInTableStyles

isShownInTableStyles(): boolean
Indicates whether this style appears in the list of table styles available for selection.

Returns boolean
true if the style is shown in the table styles list; otherwise, false.

Implementation of ITableStyle.isShownInTableStyles

toJSON

toJSON(): JSON
Serializes the table style to JSON format.

Returns JSON
A ITableStyle.JSON representation of the style.

Implementation of ITableStyle.toJSON