Interface ISheetStyle

For managing styles in a sheet.

There are two types of cell styles; SharedStyles and Named Styles.

Cells can only used SharedStyles directly.

Named styles are a 'style template' and can be used by SharedStyles.

When a shared style is create or retrieved using getSharedStyle releaseSharedStyled should be called when it is no longer required.

interface ISheetStyle {
    addListener(listener): RemoveListener;
    addRecentColor(color): readonly AdjustedColor[];
    addSharedStyleRef(style, ref): ICellStyle;
    beginPersist(): IStylesPersistScope;
    clearRecentColors(): void;
    createTemporaryStyle(overrides, inherit?): ICellStyle;
    getBuiltInCellStyle(key): INamedCellStyle;
    getBuiltInTableStyle(name): ITableStyle;
    getCustomCellStyles(): INamedCellStyle[];
    getCustomIndexedColors(): readonly AdjustedColor[];
    getCustomTableStyles(): ITableStyle[];
    getDefaultFontSize(): number;
    getDefaultTableStyle(): ITableStyle;
    getIndexedColors(): readonly AdjustedColor[];
    getNamedCellStyle(name): INamedCellStyle;
    getNormalStyle(): INamedCellStyle;
    getSharedStyle(adjustment, original, ref): ICellStyle;
    getTableStyle(name?): ITableStyle;
    getTheme(): IDocTheme;
    hideOrRemoveNamedCellStyle(style): boolean;
    indexedColorLookup(): IndexedColorLookup;
    normalize(values): Partial<CellStyleValues>;
    normalizeBorder(original, coords, range): Partial<{
        bottom: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        diagonalDown: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        diagonalUp: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        horizontal: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        left: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        right: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        top: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        vertical: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
    }>;
    recentColors(): readonly AdjustedColor[];
    removeCustomCellStyle(style): boolean;
    removeCustomTableStyle(name): boolean;
    resolveColor(str): AdjustedColor;
    schemeLookup(): SchemeColorLookup;
    setCustomCellStyle(name, style, mergeIfExists?): INamedCellStyle;
    setCustomIndexedColors(colors): void;
    setCustomTableStyle(name, tableStyleValues): ITableStyle;
    setDefaultFontSize(fontSize): void;
    setDefaultTableStyle(name): void;
    setTheme(theme): void;
    validateStyleName(name, checkDuplicates?): void;
}

Implemented by

Methods

addListener addRecentColor addSharedStyleRef beginPersist clearRecentColors createTemporaryStyle getBuiltInCellStyle getBuiltInTableStyle getCustomCellStyles getCustomIndexedColors getCustomTableStyles getDefaultFontSize getDefaultTableStyle getIndexedColors getNamedCellStyle getNormalStyle getSharedStyle getTableStyle getTheme hideOrRemoveNamedCellStyle indexedColorLookup normalize normalizeBorder recentColors removeCustomCellStyle removeCustomTableStyle resolveColor schemeLookup setCustomCellStyle setCustomIndexedColors setCustomTableStyle setDefaultFontSize setDefaultTableStyle setTheme validateStyleName

Methods

addListener

addRecentColor

  • addRecentColor(color): readonly AdjustedColor[]

  • Add a color to the mru list. This is used to populate color pickers.

    Note - Any color can be added but generally this should be limited to custom/non-themed color

    Parameters

    Returns readonly AdjustedColor[]

addSharedStyleRef

  • addSharedStyleRef(style, ref): ICellStyle

  • Add a reference for a shared style. This is done to allow styles to be shared. The reference passed is used to track the current style usage. Once it's released or GC'ed the style will be release from the shared pool.

    Parameters

    Returns ICellStyle

    Remarks

    Returns a reference to a new style. If will generally be the same cell style but if the cells style was created from a different styles then a new one will be returned.

    Style

    The previously created style

beginPersist

clearRecentColors

  • clearRecentColors(): void

  • Clears the mru color list

    Returns void

createTemporaryStyle

  • createTemporaryStyle(overrides, inherit?): ICellStyle

  • Allows for a non managed style. Useful for tooltips or other transient styles.

    Parameters

    • overrides: Partial<{
          alignment: string | CellAlignmentValues | Partial<{
              horizontal: string;
              indent: string | number;
              justifyLastLine: string | Partial<boolean>;
              overflow: string;
              readingDirection: string;
              relativeIndent: string | number;
              rotation: string | number;
              stacked: string | Partial<boolean>;
              vertical: string;
          }>;
          border: string | CellBorderValues | Partial<{
              bottom: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              diagonalDown: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              diagonalUp: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              horizontal: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              left: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              right: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              top: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              vertical: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
          }>;
          fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          } | {
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              fillType: string;
          } | {
              angle: string | number;
              fillTo: string | Rectangle | Partial<{
                  bottom: string | number;
                  left: string | number;
                  right: string | number;
                  top: string | number;
              }>;
              fillType: string;
              gradientType: string;
              stops: string | GradientStop[] | (string | GradientStop | Partial<{
                  color: ...;
                  offset?: ...;
              }>)[];
          } | {
              background: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              fillType: string;
              foreground: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              patternType: string;
          } | {
              fillType: string;
          }>;
          font: string | FontValues | Partial<{
              extend: string | Partial<boolean>;
              family: string;
              familyFallbacks: string | string[];
              fill: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              letterSpacing: string | number;
              outline: string | Partial<boolean>;
              scheme: string;
              shadow: string | Partial<boolean>;
              size: string | number;
              strike: string | Partial<boolean>;
              style: string;
              underline: string | boolean;
              verticalAlign: string;
              weight: string | number;
          }>;
          namedStyle: string;
          numberFormat: string;
          protection: string | CellProtectionValues | Partial<{
              formulaHidden: string | Partial<boolean>;
              locked: string | Partial<boolean>;
          }>;
          quotePrefix: string | Partial<boolean>;
      }>
    • Optional inherit: ICellStyle

      (And original values to inherit from)

    Returns ICellStyle

getBuiltInCellStyle

getBuiltInTableStyle

  • getBuiltInTableStyle(name): ITableStyle

  • Returns the built in style for the given key.

    Parameters

    • name: string

      A string of the name of the table.

    Returns ITableStyle

    Remarks

    Case insensitive; to find the actual name casing use

    See

    INamedCellStyle.name

getCustomCellStyles

  • getCustomCellStyles(): INamedCellStyle[]

  • Returns all customized named cell styles.

    Returns INamedCellStyle[]

    Remarks

    This includes new style names and builtin overrides.

getCustomIndexedColors

getCustomTableStyles

  • getCustomTableStyles(): ITableStyle[]

  • Returns all customized table styles.

    Returns ITableStyle[]

    Remarks

    This includes new table styles and builtin overrides.

getDefaultFontSize

  • getDefaultFontSize(): number

  • Themes do not contain font sizes but it is possible to set a default font size at the document or application level.

    Returns number

getDefaultTableStyle

getIndexedColors

  • getIndexedColors(): readonly AdjustedColor[]

  • Return an array of colors that will be used to resolve any colors that use IndexXX or ColorXX as a key.

    Returns readonly AdjustedColor[]

    Remarks

    This will also return a list of colors.

getNamedCellStyle

  • getNamedCellStyle(name): INamedCellStyle

  • Returns The named style from either a custom style or a builtin.

    Parameters

    • name: string

    Returns INamedCellStyle

    Remarks

    Will try to return:

    1. The custom style for the name
    2. The builtin style for the name.
    3. nul if it doesn't exist.

getNormalStyle

getSharedStyle

  • getSharedStyle(adjustment, original, ref): ICellStyle

  • Returns a style that is an adjustment of the original. This method also tracks usages of the styles.

    If an adjustment of null or has no values then the 'named' style will be returned.

    Note - If a style that is being updated is using the same original cell and the same ref. The original style is released.

    Parameters

    • adjustment: Partial<{
          alignment: string | CellAlignmentValues | Partial<{
              horizontal: string | ((value, resolveShorthands?) => string);
              indent: string | number | ((value, resolveShorthands?) => string | number);
              justifyLastLine: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              overflow: string | ((value, resolveShorthands?) => string);
              readingDirection: string | ((value, resolveShorthands?) => string);
              relativeIndent: string | number | ((value, resolveShorthands?) => string | number);
              rotation: string | number | ((value, resolveShorthands?) => string | number);
              stacked: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              vertical: string | ((value, resolveShorthands?) => string);
          }> | ((value, resolveShorthands?) => string | CellAlignmentValues);
          border: string | CellBorderValues | Partial<{
              bottom: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              diagonalDown: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              diagonalUp: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              horizontal: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              left: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              right: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              top: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              vertical: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
          }> | ((value, resolveShorthands?) => string | CellBorderValues);
          fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
              val: string | ((value, resolveShorthands?) => string);
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          } | {
              color: string | AdjustedColor | Partial<{
                  val: (...) | (...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              fillType: string | ((value, resolveShorthands?) => string);
          } | {
              angle: string | number | ((value, resolveShorthands?) => string | number);
              fillTo: string | Rectangle | Partial<{
                  bottom: (...) | (...) | (...);
                  left: (...) | (...) | (...);
                  right: (...) | (...) | (...);
                  top: (...) | (...) | (...);
              }> | ((value, resolveShorthands?) => string | Rectangle);
              fillType: string | ((value, resolveShorthands?) => string);
              gradientType: string | ((value, resolveShorthands?) => string);
              stops: string | GradientStop[] | (string | GradientStop | Partial<(...)> | ((value, resolveShorthands?) => ...))[] | ((value, resolveShorthands?) => string | (...)[]);
          } | {
              background: string | AdjustedColor | Partial<{
                  val: (...) | (...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              fillType: string | ((value, resolveShorthands?) => string);
              foreground: string | AdjustedColor | Partial<{
                  val: (...) | (...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              patternType: string | ((value, resolveShorthands?) => string);
          } | {
              fillType: string | ((value, resolveShorthands?) => string);
          }> | ((value, resolveShorthands?) => string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues);
          font: string | FontValues | Partial<{
              extend: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              family: string | ((value, resolveShorthands?) => string);
              familyFallbacks: string | string[] | (string | ((value, resolveShorthands?) => string))[] | ((value, resolveShorthands?) => string | string[]);
              fill: string | AdjustedColor | Partial<{
                  val: string | ((value, resolveShorthands?) => ...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              letterSpacing: string | number | ((value, resolveShorthands?) => string | number);
              outline: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              scheme: string | ((value, resolveShorthands?) => string);
              shadow: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              size: string | number | ((value, resolveShorthands?) => string | number);
              strike: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              style: string | ((value, resolveShorthands?) => string);
              underline: string | boolean | ((value, resolveShorthands?) => string | boolean);
              verticalAlign: string | ((value, resolveShorthands?) => string);
              weight: string | number | ((value, resolveShorthands?) => string | number);
          }> | ((value, resolveShorthands?) => string | FontValues);
          namedStyle: string | ((value, resolveShorthands?) => string);
          numberFormat: string | ((value, resolveShorthands?) => string);
          protection: string | CellProtectionValues | Partial<{
              formulaHidden: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              locked: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
          }> | ((value, resolveShorthands?) => string | CellProtectionValues);
          quotePrefix: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
      }> | ICellStyleUpdater
    • original: ICellStyle
    • ref: any

    Returns ICellStyle

    Adjustment

    either a new partial style or a ICellStyleUpdater that

    Original

    the original style. This is either another SharedStyle which will be used as a template or a NamedStyle. If this is not specified then the normal style will be used.

    Ref

    This is any object that is used for tracking.

getTableStyle

  • getTableStyle(name?): ITableStyle

  • Returns The table style. This can be either a custom or a built in table style.

    Parameters

    • Optional name: string

    Returns ITableStyle

    Remarks

    Will try to return:

    1. The custom style for the name
    2. The builtin style for the name.
    3. null if it doesn't exist.

getTheme

hideOrRemoveNamedCellStyle

  • hideOrRemoveNamedCellStyle(style): boolean

  • This will remove a custom styles or hide built-in cell style.

    Parameters

    • style: string | INamedCellStyle

      The named style or the string name of a named style.

    Returns boolean

    Returns a flag indicating if the style was removed or hidden.

indexedColorLookup

normalize

  • normalize(values): Partial<CellStyleValues>

  • Converts a list of SerializableCellStyleValues that contain shorthand values into native values. It will also remove any value that resolve to the same values as the referenced named style (or Normal if this is not specified)

    Parameters

    • values: Partial<{
          alignment: string | CellAlignmentValues | Partial<{
              horizontal: string;
              indent: string | number;
              justifyLastLine: string | Partial<boolean>;
              overflow: string;
              readingDirection: string;
              relativeIndent: string | number;
              rotation: string | number;
              stacked: string | Partial<boolean>;
              vertical: string;
          }>;
          border: string | CellBorderValues | Partial<{
              bottom: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              diagonalDown: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              diagonalUp: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              horizontal: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              left: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              right: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              top: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
              vertical: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  style: string;
              }>;
          }>;
          fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          } | {
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              fillType: string;
          } | {
              angle: string | number;
              fillTo: string | Rectangle | Partial<{
                  bottom: string | number;
                  left: string | number;
                  right: string | number;
                  top: string | number;
              }>;
              fillType: string;
              gradientType: string;
              stops: string | GradientStop[] | (string | GradientStop | Partial<{
                  color: ...;
                  offset?: ...;
              }>)[];
          } | {
              background: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              fillType: string;
              foreground: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              patternType: string;
          } | {
              fillType: string;
          }>;
          font: string | FontValues | Partial<{
              extend: string | Partial<boolean>;
              family: string;
              familyFallbacks: string | string[];
              fill: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              letterSpacing: string | number;
              outline: string | Partial<boolean>;
              scheme: string;
              shadow: string | Partial<boolean>;
              size: string | number;
              strike: string | Partial<boolean>;
              style: string;
              underline: string | boolean;
              verticalAlign: string;
              weight: string | number;
          }>;
          namedStyle: string;
          numberFormat: string;
          protection: string | CellProtectionValues | Partial<{
              formulaHidden: string | Partial<boolean>;
              locked: string | Partial<boolean>;
          }>;
          quotePrefix: string | Partial<boolean>;
      }>

    Returns Partial<CellStyleValues>

normalizeBorder

  • normalizeBorder(original, coords, range): Partial<{
        bottom: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        diagonalDown: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        diagonalUp: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        horizontal: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        left: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        right: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        top: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        vertical: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
    }>

  • Given a border rationalize the border edges for a coord with a range.

    Parameters

    • original: Partial<{
          bottom: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
          diagonalDown: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
          diagonalUp: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
          horizontal: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
          left: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
          right: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
          top: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
          vertical: string | BorderStroke | Partial<{
              color: string | AdjustedColor | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }>;
              style: string;
          }>;
      }>
    • coords: CellCoords
    • range: CellRangeCoords

    Returns Partial<{
        bottom: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        diagonalDown: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        diagonalUp: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        horizontal: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        left: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        right: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        top: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
        vertical: string | BorderStroke | Partial<{
            color: string | AdjustedColor | Partial<{
                val: string;
                adjustments: any;
                asCSS: any;
                isEqual: any;
                isImmutable: any;
                toHSLA: any;
                toHex: any;
                toJSON: any;
                toRGBA: any;
                toString: any;
            }>;
            style: string;
        }>;
    }>

recentColors

removeCustomCellStyle

  • removeCustomCellStyle(style): boolean

  • This will remove a custom cell style.

    Parameters

    • style: string | INamedCellStyle

      The named style or the string name of a named style.

    Returns boolean

    true if the style was removed.

removeCustomTableStyle

  • removeCustomTableStyle(name): boolean

  • This will remove a custom table style.

    Parameters

    • name: string

      A string of the name of the table.

    Returns boolean

    true if the style was removed.

    Remarks

    If the style is a built-in style or doesn't exist then this will do nothing and remove false.

resolveColor

  • resolveColor(str): AdjustedColor

  • Parses the color using the Theme being used by this style

    Parameters

    • str: any

      Any string that represents a color

    Returns AdjustedColor

    See

    .

schemeLookup

setCustomCellStyle

  • setCustomCellStyle(name, style, mergeIfExists?): INamedCellStyle

  • This will add or update a cell style.

    Parameters

    • name: string
    • style: Partial<{
          alignment: string | CellAlignmentValues | Partial<{
              horizontal: string | ((value, resolveShorthands?) => string);
              indent: string | number | ((value, resolveShorthands?) => string | number);
              justifyLastLine: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              overflow: string | ((value, resolveShorthands?) => string);
              readingDirection: string | ((value, resolveShorthands?) => string);
              relativeIndent: string | number | ((value, resolveShorthands?) => string | number);
              rotation: string | number | ((value, resolveShorthands?) => string | number);
              stacked: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              vertical: string | ((value, resolveShorthands?) => string);
          }> | ((value, resolveShorthands?) => string | CellAlignmentValues);
          border: string | CellBorderValues | Partial<{
              bottom: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              diagonalDown: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              diagonalUp: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              horizontal: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              left: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              right: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              top: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
              vertical: string | BorderStroke | Partial<{
                  color: string | AdjustedColor | Partial<(...)> | ((value, resolveShorthands?) => ...);
                  style: string | ((value, resolveShorthands?) => ...);
              }> | ((value, resolveShorthands?) => string | BorderStroke);
          }> | ((value, resolveShorthands?) => string | CellBorderValues);
          fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
              val: string | ((value, resolveShorthands?) => string);
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          } | {
              color: string | AdjustedColor | Partial<{
                  val: (...) | (...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              fillType: string | ((value, resolveShorthands?) => string);
          } | {
              angle: string | number | ((value, resolveShorthands?) => string | number);
              fillTo: string | Rectangle | Partial<{
                  bottom: (...) | (...) | (...);
                  left: (...) | (...) | (...);
                  right: (...) | (...) | (...);
                  top: (...) | (...) | (...);
              }> | ((value, resolveShorthands?) => string | Rectangle);
              fillType: string | ((value, resolveShorthands?) => string);
              gradientType: string | ((value, resolveShorthands?) => string);
              stops: string | GradientStop[] | (string | GradientStop | Partial<(...)> | ((value, resolveShorthands?) => ...))[] | ((value, resolveShorthands?) => string | (...)[]);
          } | {
              background: string | AdjustedColor | Partial<{
                  val: (...) | (...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              fillType: string | ((value, resolveShorthands?) => string);
              foreground: string | AdjustedColor | Partial<{
                  val: (...) | (...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              patternType: string | ((value, resolveShorthands?) => string);
          } | {
              fillType: string | ((value, resolveShorthands?) => string);
          }> | ((value, resolveShorthands?) => string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues);
          font: string | FontValues | Partial<{
              extend: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              family: string | ((value, resolveShorthands?) => string);
              familyFallbacks: string | string[] | (string | ((value, resolveShorthands?) => string))[] | ((value, resolveShorthands?) => string | string[]);
              fill: string | AdjustedColor | Partial<{
                  val: string | ((value, resolveShorthands?) => ...);
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              }> | ((value, resolveShorthands?) => string | AdjustedColor);
              letterSpacing: string | number | ((value, resolveShorthands?) => string | number);
              outline: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              scheme: string | ((value, resolveShorthands?) => string);
              shadow: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              size: string | number | ((value, resolveShorthands?) => string | number);
              strike: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              style: string | ((value, resolveShorthands?) => string);
              underline: string | boolean | ((value, resolveShorthands?) => string | boolean);
              verticalAlign: string | ((value, resolveShorthands?) => string);
              weight: string | number | ((value, resolveShorthands?) => string | number);
          }> | ((value, resolveShorthands?) => string | FontValues);
          hidden: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
          iLevel: string | number | ((value, resolveShorthands?) => string | number);
          namedStyle: string | ((value, resolveShorthands?) => string);
          numberFormat: string | ((value, resolveShorthands?) => string);
          protection: string | CellProtectionValues | Partial<{
              formulaHidden: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
              locked: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
          }> | ((value, resolveShorthands?) => string | CellProtectionValues);
          quotePrefix: string | Partial<boolean> | ((value, resolveShorthands?) => string | boolean);
      }> | INamedCellStyleUpdater
    • Optional mergeIfExists: boolean

      If true then the style will be merged with the existing style otherwise is a replace.

    Returns INamedCellStyle

    the new style after any merges.

    Remarks

    Case insensitive; for duplicate detection purposes.

    Default Value

    false

setCustomIndexedColors

  • setCustomIndexedColors(colors): void

  • Override the default indexed colors.

    Parameters

    Returns void

setCustomTableStyle

  • setCustomTableStyle(name, tableStyleValues): ITableStyle

  • This will add or update a table style.

    Parameters

    • name: string

      A string of the name of the table.

    • tableStyleValues: Partial<{
          fFirstTotalCell?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          firstColumn?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          firstColumnStripe?: string | SizeCellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
              size?: string | number;
          }>;
          firstHeaderCell?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          firstRowStripe?: string | SizeCellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
              size?: string | number;
          }>;
          headerRow?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          lastColumn?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          lastHeaderCell?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          lastTotalCell?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          name?: string;
          pivot?: string | Partial<boolean>;
          secondColumnStripe?: string | SizeCellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
              size?: string | number;
          }>;
          secondRowStripe?: string | SizeCellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
              size?: string | number;
          }>;
          table?: string | Partial<boolean>;
          totalRow?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
          wholeTable?: string | CellStyleValues | Partial<{
              alignment: string | CellAlignmentValues | Partial<{
                  horizontal: string;
                  indent: string | number;
                  justifyLastLine: string | Partial<boolean>;
                  overflow: string;
                  readingDirection: string;
                  relativeIndent: string | number;
                  rotation: string | number;
                  stacked: string | Partial<boolean>;
                  vertical: string;
              }>;
              border: string | CellBorderValues | Partial<{
                  bottom: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalDown: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  diagonalUp: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  horizontal: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  left: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  right: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  top: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
                  vertical: string | BorderStroke | Partial<{
                      color: ...;
                      style: ...;
                  }>;
              }>;
              fill: string | AdjustedColor | SolidFillValues | GradientFillValues | PatternFillValues | NoneFillValues | Partial<{
                  val: string;
                  adjustments: any;
                  asCSS: any;
                  isEqual: any;
                  isImmutable: any;
                  toHSLA: any;
                  toHex: any;
                  toJSON: any;
                  toRGBA: any;
                  toString: any;
              } | {
                  color: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
              } | {
                  angle: string | number;
                  fillTo: string | Rectangle | Partial<(...)>;
                  fillType: string;
                  gradientType: string;
                  stops: string | (...)[] | (...)[];
              } | {
                  background: string | AdjustedColor | Partial<(...)>;
                  fillType: string;
                  foreground: string | AdjustedColor | Partial<(...)>;
                  patternType: string;
              } | {
                  fillType: string;
              }>;
              font: string | FontValues | Partial<{
                  extend: string | Partial<boolean>;
                  family: string;
                  familyFallbacks: string | string[];
                  fill: string | AdjustedColor | Partial<{
                      val: ...;
                      adjustments: any;
                      asCSS: any;
                      isEqual: any;
                      isImmutable: any;
                      toHSLA: any;
                      toHex: any;
                      toJSON: any;
                      toRGBA: any;
                      toString: any;
                  }>;
                  letterSpacing: string | number;
                  outline: string | Partial<boolean>;
                  scheme: string;
                  shadow: string | Partial<boolean>;
                  size: string | number;
                  strike: string | Partial<boolean>;
                  style: string;
                  underline: string | boolean;
                  verticalAlign: string;
                  weight: string | number;
              }>;
              namedStyle: string;
              numberFormat: string;
              protection: string | CellProtectionValues | Partial<{
                  formulaHidden: string | Partial<boolean>;
                  locked: string | Partial<boolean>;
              }>;
              quotePrefix: string | Partial<boolean>;
          }>;
      }>

      the values to set for the table style.

    Returns ITableStyle

    Remarks

    Case insensitive; for duplicate detection purposes.

setDefaultFontSize

  • setDefaultFontSize(fontSize): void

  • Set the default fontSize. Note - A theme does NOT contain this.

    Parameters

    • fontSize: number

      The new default font size.

    Returns void

setDefaultTableStyle

  • setDefaultTableStyle(name): void

  • Set the default table style to use if a table is created without specifying a style.

    Parameters

    • name: string

      A string of the name of the table

    Returns void

    Remarks

    The style must exist or the defaultStyle will be set to 'TableStyleMedium2'.

setTheme

  • setTheme(theme): void

  • Set the theme used to calculate styles.

    Parameters

    Returns void

validateStyleName

  • validateStyleName(name, checkDuplicates?): void

  • Checks the current name to see if this is a valid sheetName.

    Parameters

    • name: string
    • Optional checkDuplicates: boolean

    Returns void

Settings

Member Visibility

Theme

On This Page

addListeneraddRecentColoraddSharedStyleRefbeginPersistclearRecentColorscreateTemporaryStylegetBuiltInCellStylegetBuiltInTableStylegetCustomCellStylesgetCustomIndexedColorsgetCustomTableStylesgetDefaultFontSizegetDefaultTableStylegetIndexedColorsgetNamedCellStylegetNormalStylegetSharedStylegetTableStylegetThemehideOrRemoveNamedCellStyleindexedColorLookupnormalizenormalizeBorderrecentColorsremoveCustomCellStyleremoveCustomTableStyleresolveColorschemeLookupsetCustomCellStylesetCustomIndexedColorssetCustomTableStylesetDefaultFontSizesetDefaultTableStylesetThemevalidateStyleName