AdapTable Version:

Framework:

ThemeApi

Provides run-time access to the Theme Module and associated state

TypeScript

export interface

Methods

Method	Description
addUserTheme(theme)	Adds a User Theme to State
applyCurrentTheme()	Applies the Current Theme
deleteUserTheme(theme)	Deletes a User Theme from State
editTheme(theme)	Edits an existing theme
getCurrentTheme()	Retrieves name of Current Theme
getCurrentThemeObject()	Retrieves the current theme object
getSystemThemes()	Retrieves System Themes in State
getThemeByName(themeName)	Retrieves a Theme by name
getThemes()	Retrieves all Themes (both System & User) in State
getThemeState()	Retrieves Theme section from Adaptable State
getUserThemes()	Retrieves User Themes in State
loadDarkTheme()	Sets AdapTable Dark Theme - updates the AG Grid theme to match
loadLightTheme()	Sets AdapTable Light Theme - updates the AG Grid theme to match
loadTheme(theme)	Sets Adaptable to use a given theme
openThemeSettingsPanel()	Opens Settings Panel with Theme section selected and visible
setSystemThemes(systemThemes)	Sets available System Themes; if empty array is passed none will be
setUserThemes(userThemes)	Sets available User Themes

Method Details

addUserTheme

Adds a User Theme to State

TypeScript

addUserTheme(theme: AdaptableTheme): void;

Parameters

Parameter	Type	Description
theme	`AdaptableTheme`

Returns

void

applyCurrentTheme

Applies the Current Theme

TypeScript

applyCurrentTheme(): void;

Returns

void

deleteUserTheme

Deletes a User Theme from State

TypeScript

deleteUserTheme(theme: AdaptableTheme): void;

Parameters

Parameter	Type	Description
theme	`AdaptableTheme`

Returns

void

editTheme

Edits an existing theme

TypeScript

editTheme(theme: AdaptableTheme): void;

Parameters

Parameter	Type
theme	`AdaptableTheme`

Returns

void

getCurrentTheme

Retrieves name of Current Theme

TypeScript

getCurrentTheme(): string;

Returns

string

getCurrentThemeObject

Retrieves the current theme object

TypeScript

getCurrentThemeObject(): AdaptableTheme;

Returns

AdaptableTheme

getSystemThemes

Retrieves System Themes in State

TypeScript

getSystemThemes(): AdaptableTheme[];

Returns

AdaptableTheme[]

getThemeByName

Retrieves a Theme by name

TypeScript

getThemeByName(themeName: string): AdaptableTheme;

Parameters

Parameter	Type	Description
themeName	`string`

Returns

AdaptableTheme

getThemes

Retrieves all Themes (both System & User) in State

TypeScript

getThemes(): AdaptableTheme[];

Returns

AdaptableTheme[]

getThemeState

Retrieves Theme section from Adaptable State

TypeScript

getThemeState(): ThemeState;

Returns

ThemeState

getUserThemes

Retrieves User Themes in State

TypeScript

getUserThemes(): AdaptableTheme[];

Returns

AdaptableTheme[]

loadDarkTheme

Sets AdapTable Dark Theme - updates the AG Grid theme to match

TypeScript

loadDarkTheme(): void;

Returns

void

loadLightTheme

Sets AdapTable Light Theme - updates the AG Grid theme to match

TypeScript

loadLightTheme(): void;

Returns

void

loadTheme

Sets Adaptable to use a given theme

TypeScript

loadTheme(theme: string): void;

Parameters

Parameter	Type	Description
theme	`string`	name of theme to apply

Returns

void

openThemeSettingsPanel

Opens Settings Panel with Theme section selected and visible

TypeScript

openThemeSettingsPanel(): void;

Returns

void

setSystemThemes

Sets available System Themes; if empty array is passed none will be

TypeScript

setSystemThemes(systemThemes: AdaptableTheme[]): void;

Parameters

Parameter	Type	Description
systemThemes	`AdaptableTheme[]`	system themes to use ('light', 'dark', both, or none)

Returns

void

setUserThemes

Sets available User Themes

TypeScript

setUserThemes(userThemes: AdaptableTheme[]): void;

Parameters

Parameter	Type	Description
userThemes	`AdaptableTheme[]`	User themes to set - each has name, description

Returns

void

PreviousTeamSharingState NextThemeChangedInfo