Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ThemeApi

Provides full and comprehensive run-time access to the Theme function and associated state.

Hierarchy

  • ThemeApi

Index

Methods

getAllSystemTheme

getAllTheme

getAllUserTheme

getCurrentTheme

  • getCurrentTheme(): string

getThemeState

loadDarkTheme

  • loadDarkTheme(): void
  • Sets the Dark Theme of Adaptable

    This will also update the underlying vendor grid theme to match

    Returns void

loadLightTheme

  • loadLightTheme(): void
  • Sets the Light Theme of Adaptable

    This will also update the underlying vendor grid to match

    Returns void

loadTheme

  • loadTheme(theme: string): void
  • Sets Adaptable to use the given theme

    Parameters

    • theme: string

      name of the theme to apply

    Returns void

setSystemThemes

  • Sets which System Themes are available. If an empty array is passed then no System Themes will be available.

    Parameters

    • systemThemes: AdaptableTheme[]

      system themes to use ('light', 'dark', both, or none)

    Returns void

setUserThemes

  • Sets which user (a.k.a. custom) themes are available in Adaptable

    Parameters

    • userThemes: AdaptableTheme[]

      user themes to use - each has a name and a description

    Returns void

showThemePopup

  • showThemePopup(): void

Generated using TypeDoc