Opensearch dashboards.uisettingsparams
Home > opensearch-dashboards > UiSettingsParams
UiSettingsParams interface
UiSettings parameters defined by the plugins.
Signature:
export interface UiSettingsParams<T = unknown>
Properties
| Property | Type | Description |
|---|---|---|
| category? | string[] | (Optional) used to group the configured setting in the UI |
| deprecation? | DeprecationSettings | (Optional) optional deprecation information. Used to generate a deprecation warning. |
| description? | string | (Optional) description provided to a user in UI |
| name? | string | (Optional) title in the UI |
| optionLabels? | Record<string, string> | (Optional) text labels for 'select' type UI element |
| options? | string[] | (Optional) array of permitted values for this setting |
| readonly? | boolean | (Optional) a flag indicating that value cannot be changed |
| requiresPageReload? | boolean | (Optional) a flag indicating whether new value applying requires page reloading |
| schema | Type<T> | |
| type? | UiSettingsType | (Optional) defines a type of UI element UiSettingsType |
| validation? | ImageValidation | StringValidation | (Optional) |
| value? | T | (Optional) default value to fall back to if a user doesn't provide any |