Class StyleCollection

Base implementation of IStyleCollection

TODO - defaultFontSize move to theme?

Implements

IStyleCollection

Constructors

constructor

new StyleCollection(
    theme?: ITheme | null,
    indexedColors?: string[] | null,
    defaultFontSize?: number,
): StyleCollection
Parameters
- theme: ITheme | null = null
- indexedColors: string[] | null = null
- defaultFontSize: number = 11
Returns StyleCollection

Accessors

isIStyleCollection

get isIStyleCollection(): true

For runtime type checking.

Returns true

Implementation of IStyleCollection.isIStyleCollection

Methods

addListeners

addListeners(
listeners: IStyleCollection.IListeners,
options?: IListener.Options,
): Remove
Add a set of callbacks to receive notification.
Parameters
- listeners: IStyleCollection.IListeners
  The callbacks object.
- Optionaloptions: IListener.Options
  Options
Returns Remove
A function that can be called to remove the listener.

Remarks
Listeners are fired in the order that they are added.

Implementation of IStyleCollection.addListeners

addRecentColor

addRecentColor(color: IColor): readonly IColor[]
Add a color to the mru list. This is used to populate color pickers.
Parameters
- color: IColor
  The color to record.
Returns readonly IColor[]

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

Implementation of IStyleCollection.addRecentColor

beginPersist

beginPersist(): IStyleCollection.IPersistScope
Start persisting styles.
- This is used during save/load to allow for styles to be references by an id count.
- This is a stack so multiple begins will need to be matched with an end.
Returns IStyleCollection.IPersistScope

Implementation of IStyleCollection.beginPersist

clearRecentColors

clearRecentColors(): void

Clears the mru color list

Returns void

Implementation of IStyleCollection.clearRecentColors

getCustomIndexedColors

getCustomIndexedColors(): readonly IColor[]

Returns the customized Indexed colors.

Returns readonly IColor[]

Implementation of IStyleCollection.getCustomIndexedColors

getCustomNamed

getCustomNamed(): IStyle.INamed[]

Returns the document's own named styles, customized built-ins included.

Returns IStyle.INamed[]

Implementation of IStyleCollection.getCustomNamed

getCustomTableStyles

getCustomTableStyles(): ITableStyle[]

Returns the document's own table styles, customized built-ins included.

Returns ITableStyle[]

Implementation of IStyleCollection.getCustomTableStyles

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

Implementation of IStyleCollection.getDefaultFontSize

getDefaultTableStyle

getDefaultTableStyle(): ITableStyle

Returns the style a table is given when it is created without one.

Returns ITableStyle

Implementation of IStyleCollection.getDefaultTableStyle

getIndexedColors

getIndexedColors(): readonly IColor[]

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

Returns readonly IColor[]

Implementation of IStyleCollection.getIndexedColors

getNamed

getNamed(name: string): IStyle.INamed | null
Returns the named style with the given name, or null if there is none.
Parameters
- name: string
Returns IStyle.INamed | null

Implementation of IStyleCollection.getNamed

getNamedStyles

getNamedStyles(): INamedStyleCollection

Returns the named cell styles.

Returns INamedStyleCollection

Implementation of IStyleCollection.getNamedStyles

getNormal

getNormal(): IStyle

Return a the Normal styles as an IStyle.;

Returns IStyle

Implementation of IStyleCollection.getNormal

getNormalRanged

getNormalRanged(): ICellRanged<IStyle.Properties<Serializable>>

Convenience mechanism (and slightly faster) way to call getNamed('Normal').getRanged();

Returns ICellRanged<IStyle.Properties<Serializable>>

Implementation of IStyleCollection.getNormalRanged

getTableStyle

getTableStyle(name?: string): ITableStyle | null
Returns the table style with the given name, or null if there is none; with no name, the style of a table that has none.
Parameters
- Optionalname: string
Returns ITableStyle | null

Implementation of IStyleCollection.getTableStyle

getTableStyles

getTableStyles(): ITableStyleCollection

Returns the table styles, and the default for a new table.

Returns ITableStyleCollection

Implementation of IStyleCollection.getTableStyles

getTheme

getTheme(): ITheme

Returns the current theme

Returns ITheme

Implementation of IStyleCollection.getTheme

indexedLookup

indexedLookup(): IndexedLookup

This is available for functions that want to resolve colors using the index color palette.

Returns IndexedLookup

Implementation of IStyleCollection.indexedLookup

normalize

normalize(values: IStyle.Modifiers, name?: string): Partial<IStyle.Properties>
Converts a list of IStyle.Modifiers that contain shorthand values into native values.
Parameters
- values: IStyle.Modifiers
  IStyle.Modifiers
- Optionalname: string
  Name used to normalize against. This overrides any specified in the modifiers.
Returns Partial<IStyle.Properties>
A valid IStyle.Modifiers with values that match the normal style removed.

Remarks
Will also remove any value that resolve to the same values as the referenced named style (or Normal if this is not specified).

Implementation of IStyleCollection.normalize

parseColor

parseColor(str: string): IColor
Parses the color using the Theme being used by this style
Parameters
- str: string
  Any string that represents a color IColor.
Returns IColor

Implementation of IStyleCollection.parseColor

recentColors

recentColors(): readonly IColor[]

Returns a list of colors that were added via addRecentColor.

Returns readonly IColor[]

Implementation of IStyleCollection.recentColors

resolve

resolve(values: IStyle.Modifiers, name?: string): Partial<IStyle.Properties>
Flattens a style against the named style it references, resolving shorthand values as it goes.
Parameters
- values: IStyle.Modifiers
  IStyle.Modifiers
- Optionalname: string
  Name used to resolve against. This overrides any specified in the modifiers.
Returns Partial<IStyle.Properties>
A valid IStyle.Properties with the referenced style's values merged in.

Remarks
The inverse of IStyleCollection.normalize: where normalize reduces a style to what it authors over its named style, this restores what that authorship actually resolves to. Formats that store a style as a self-contained record rather than as a delta (OOXML xf) need this on the way out.

Implementation of IStyleCollection.resolve

schemeLookup

schemeLookup(): SchemeLookup

This is available for functions that want to resolve colors for the theme used specifically for this style.

Returns SchemeLookup

Implementation of IStyleCollection.schemeLookup

setCustomIndexedColors

setCustomIndexedColors(colors: readonly IColor[]): void
Override the default indexed colors.
Parameters
- colors: readonly IColor[]
  An array of colors.
Returns void

Implementation of IStyleCollection.setCustomIndexedColors

setCustomTableStyle

setCustomTableStyle(
name: string,
properties: ITableStyle.ResolvableProperties,
): ITableStyle
Adds or updates a table style.
Parameters
- name: string
- properties: ITableStyle.ResolvableProperties
Returns ITableStyle

Implementation of IStyleCollection.setCustomTableStyle

setDefaultFontSize

setDefaultFontSize(fontSize: number): void
Set the default fontSize. Note - A theme does NOT contain this.
Parameters
- fontSize: number
  The new default font size.
Returns void

Implementation of IStyleCollection.setDefaultFontSize

setDefaultTableStyle

setDefaultTableStyle(styleName: string): void
Sets the style a table is given when it is created without one.
Parameters
- styleName: string
Returns void

Implementation of IStyleCollection.setDefaultTableStyle

setNamed

setNamed(modifiers: NamedUpdate, mergeIfExists?: boolean): IStyle.INamed
Adds or updates a named style.
Parameters
- modifiers: NamedUpdate
- mergeIfExists: boolean = false
Returns IStyle.INamed

Implementation of IStyleCollection.setNamed

setTheme

setTheme(theme: ITheme): void
Set the theme used to calculate styles.
Parameters
- theme: ITheme
  The ITheme to use.
Returns void

Implementation of IStyleCollection.setTheme

validateStyleName

validateStyleName(name: string, checkDuplicates?: boolean): void
Checks the current name to see if this is a valid sheetName.
Parameters
- name: string
- checkDuplicates: boolean = false
Returns void

Implementation of IStyleCollection.validateStyleName

Class StyleCollection

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns StyleCollection

Accessors

isIStyleCollection

Returns true

Methods

addListeners

Parameters

Returns Remove

Remarks

addRecentColor

Parameters

Returns readonly IColor[]

Remarks

beginPersist

Returns IStyleCollection.IPersistScope

clearRecentColors

Returns void

getCustomIndexedColors

Returns readonly IColor[]

getCustomNamed

Returns IStyle.INamed[]

getCustomTableStyles

Returns ITableStyle[]

getDefaultFontSize

Returns number

getDefaultTableStyle

Returns ITableStyle

getIndexedColors

Returns readonly IColor[]

getNamed

Parameters

Returns IStyle.INamed | null

getNamedStyles

Returns INamedStyleCollection

getNormal

Returns IStyle

getNormalRanged

Returns ICellRanged<IStyle.Properties<Serializable>>

getTableStyle

Parameters

Returns ITableStyle | null

getTableStyles

Returns ITableStyleCollection

getTheme

Returns ITheme

indexedLookup

Returns IndexedLookup

normalize

Parameters

Returns Partial<IStyle.Properties>

Remarks

parseColor

Parameters

Returns IColor

recentColors

Returns readonly IColor[]

resolve

Parameters

Returns Partial<IStyle.Properties>

Remarks

schemeLookup

Returns SchemeLookup

setCustomIndexedColors

Parameters

Returns void

setCustomTableStyle

Parameters

Returns ITableStyle

setDefaultFontSize

Parameters

Returns void