Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • IThemeApi

Implemented by

Index

Methods

getAllSystemTheme

  • Retrieves all the System Themes in the State

    Returns AdaptableBlotterTheme[]

getAllTheme

  • Retrieves all Themes - both System Theme and User Theme - in the State

    Returns AdaptableBlotterTheme[]

getAllUserTheme

  • Retrieves all the User Themes in the State

    Returns AdaptableBlotterTheme[]

getCurrentTheme

  • getCurrentTheme(): string
  • Retrieves the name of the Current Theme

    Returns string

getThemeState

  • Retrieves all the Theme State

    Returns ThemeState

setDarkTheme

  • setDarkTheme(): void
  • Sets the Dark Theme of the Adaptable Blotter

    This will also update the underlying vendor grid theme to match

    Returns void

setLightTheme

  • setLightTheme(): void
  • Sets the Light Theme of the Adaptable Blotter

    This will also update the underlying vendor grid to match

    Returns void

setSystemThemes

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

    Parameters

    Returns void

setTheme

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

    Parameters

    • theme: string

      name of the theme to apply

    Returns void

setUserThemes

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

    Parameters

    Returns void

Generated using TypeDoc