Class DocTheme

A collection of colors, fonts, and effects that determine the overall look of your document.

Implements

IDocTheme

Index

Constructors

constructor

new DocTheme(override?, delegate?, builtIn?): DocTheme
Parameters
- override: 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;
  }> = {}
- delegate: Partial<DocThemeValues> = null
- builtIn: number = null
Returns DocTheme

Accessors

builtInID

get builtInID(): number
Returns number

colorScheme

get colorScheme(): IColorScheme
A set of colors that are used in a document.

Returns IColorScheme
Implementation of IDocTheme.colorScheme

fontScheme

get fontScheme(): IFontScheme
A set of fonts that are used in a document.

Returns IFontScheme
Implementation of IDocTheme.fontScheme

name

get name(): string
Human readable text describing the theme

Returns string
Implementation of IDocTheme.name

Methods

isCustom

isCustom(): boolean
If a custom theme or built in theme.

Returns boolean
Implementation of IDocTheme.isCustom

parseColor

parseColor(str): AdjustedColor
Parses the color using the current Theme schema (if required)
Parameters
- str: string
Returns AdjustedColor
Implementation of IDocTheme.parseColor

schemeLookup

schemeLookup(): SchemeColorLookup
This is available for functions that want to resolve themed colors

Returns SchemeColorLookup
Implementation of IDocTheme.schemeLookup

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 IDocTheme.toJSON

Class DocTheme

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns DocTheme

Accessors

builtInID

Returns number

colorScheme

Returns IColorScheme

fontScheme

Returns IFontScheme

name

Returns string

Methods

isCustom

Returns boolean

parseColor

Parameters

Returns AdjustedColor

schemeLookup

Returns SchemeColorLookup

toJSON

Settings

Member Visibility

Theme

On This Page