Interface ITableStyle

ReadonlyisITableStyle

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.

  See

  ITableStyle.isBuiltIn

getName

• getName(): string

  Returns the name of the table style.

  Returns string

  The name of the table style as a string.

getProperties

• getProperties(): Readonly<ITableStyle.Properties>

  Returns the readonly list of properties for the style.

  Returns Readonly<ITableStyle.Properties>

  Remarks

  This are unresolved properties.

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.

isBuiltIn

• isBuiltIn(): boolean

  Indicates whether this style is a built-in, predefined style.

  Returns boolean

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

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.

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.

toJSON

• toJSON(): JSON

  Serializes the table style to JSON format.

  Returns JSON

  A ITableStyle.JSON representation of the style.