Home > kibana-plugin-core-server > IUiSettingsClient
Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI.
Signature:
export interface IUiSettingsClient | Property | Type | Description |
|---|---|---|
| get | <T = any>(key: string) => Promise<T> |
Retrieves uiSettings values set by the user with fallbacks to default values if not specified. |
| getAll | <T = any>() => Promise<Record<string, T>> |
Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. |
| getRegistered | () => Readonly<Record<string, PublicUiSettingsParams>> |
Returns registered uiSettings values UiSettingsParams |
| getUserProvided | <T = any>() => Promise<Record<string, UserProvidedValues<T>>> |
Retrieves a set of all uiSettings values set by the user. |
| isOverridden | (key: string) => boolean |
Shows whether the uiSettings value set by the user. |
| remove | (key: string) => Promise<void> |
Removes uiSettings value by key. |
| removeMany | (keys: string[]) => Promise<void> |
Removes multiple uiSettings values by keys. |
| set | (key: string, value: any) => Promise<void> |
Writes uiSettings value and marks it as set by the user. |
| setMany | (changes: Record<string, any>) => Promise<void> |
Writes multiple uiSettings values and marks them as set by the user. |