Class DocThemes

Collection of themes

Implements

IDocThemes

Index

Constructors

constructor

Methods

deleteCustomTheme fromJSON getDefaultTheme getTheme getThemes setCustomTheme setDefaultTheme toJSON

Constructors

constructor

new DocThemes(_json?, isReadOnly?): DocThemes
Parameters
- _json: Partial<{
      colorScheme: string | ColorSchemeValues | Partial<{
          accent1: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent2: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent3: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent4: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent5: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent6: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          dk1: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          dk2: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          folHlink: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          hlink: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          lt1: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          lt2: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          name: string;
      }>;
      fontScheme: string | FontSchemeValues | Partial<{
          majorFont: string;
          minorFont: string;
          name: string;
      }>;
      name: string;
  }>[] = null
- isReadOnly: boolean = false
Returns DocThemes

Methods

deleteCustomTheme

deleteCustomTheme(theme): IDocTheme
This will remove a custom theme.
Parameters
- theme: string | IDocTheme
  or theme name
Returns IDocTheme
true if the Theme was removed.

Implementation of IDocThemes.deleteCustomTheme

fromJSON

fromJSON(_json): void
Load internal state from json
Parameters
- _json: Partial<{
      colorScheme: string | ColorSchemeValues | Partial<{
          accent1: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent2: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent3: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent4: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent5: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          accent6: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          dk1: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          dk2: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          folHlink: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          hlink: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          lt1: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          lt2: string | AdjustedColor | Partial<{
              val: string;
              adjustments: any;
              asCSS: any;
              isEqual: any;
              isImmutable: any;
              toHSLA: any;
              toHex: any;
              toJSON: any;
              toRGBA: any;
              toString: any;
          }>;
          name: string;
      }>;
      fontScheme: string | FontSchemeValues | Partial<{
          majorFont: string;
          minorFont: string;
          name: string;
      }>;
      name: string;
  }>[]
Returns void
Implementation of IDocThemes.fromJSON

getDefaultTheme

getDefaultTheme(): IDocTheme
Returns IDocTheme
Implementation of IDocThemes.getDefaultTheme

getTheme

getTheme(name): IDocTheme
Return the theme for the given name.
Parameters
- name: string
Returns IDocTheme
Remarks
Will try to return:
1. The custom theme for the name
2. The builtin theme for the name.
3. nul if it doesn't exist.
Implementation of IDocThemes.getTheme

getThemes

getThemes(type?): Map<string, IDocTheme>
Returns new map of all themes.
Parameters
- type: GetThemeType = GetThemeType.All
Returns Map<string, IDocTheme>
Default Value
```
GetThemeType.All
```
Remarks
Generates a new map so this can be mutated without affecting the internal state.
Implementation of IDocThemes.getThemes

setCustomTheme

setCustomTheme(theme): IDocTheme
This will add or update a theme.
Parameters
- theme: IDocTheme
Returns IDocTheme
the original theme

Remarks
Case insensitive; for duplicate detection purposes.

Implementation of IDocThemes.setCustomTheme

setDefaultTheme

setDefaultTheme(theme): IDocTheme
Parameters
- theme: IDocTheme
Returns IDocTheme
Implementation of IDocThemes.setDefaultTheme

toJSON

toJSON(): Partial<{
    colorScheme: string | ColorSchemeValues | Partial<{
        accent1: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent2: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent3: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent4: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent5: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent6: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        dk1: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        dk2: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        folHlink: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        hlink: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        lt1: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        lt2: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        name: string;
    }>;
    fontScheme: string | FontSchemeValues | Partial<{
        majorFont: string;
        minorFont: string;
        name: string;
    }>;
    name: string;
}>[]
creates a persistable version of Themes

Returns Partial<{
    colorScheme: string | ColorSchemeValues | Partial<{
        accent1: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent2: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent3: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent4: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent5: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        accent6: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        dk1: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        dk2: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        folHlink: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        hlink: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        lt1: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        lt2: string | AdjustedColor | Partial<{
            val: string;
            adjustments: any;
            asCSS: any;
            isEqual: any;
            isImmutable: any;
            toHSLA: any;
            toHex: any;
            toJSON: any;
            toRGBA: any;
            toString: any;
        }>;
        name: string;
    }>;
    fontScheme: string | FontSchemeValues | Partial<{
        majorFont: string;
        minorFont: string;
        name: string;
    }>;
    name: string;
}>[]
Implementation of IDocThemes.toJSON

Class DocThemes

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DocThemes

Methods

deleteCustomTheme

Parameters

Returns IDocTheme

fromJSON

Parameters

Returns void

getDefaultTheme

Returns IDocTheme

getTheme

Parameters

Returns IDocTheme

Remarks

getThemes

Parameters

Returns Map<string, IDocTheme>

Default Value

Remarks

setCustomTheme

Parameters

Returns IDocTheme

Remarks

setDefaultTheme

Parameters

Returns IDocTheme

toJSON

Settings

Member Visibility

Theme

On This Page