Opensearch dashboards.uisettingsservicesetup.register

Home > opensearch-dashboards > UiSettingsServiceSetup > register

UiSettingsServiceSetup.register() method

Sets settings with default values for the uiSettings.

Signature:

register(settings: Record<string, UiSettingsParams>): void;

Parameters

Parameter	Type	Description
settings	Record<string, UiSettingsParams>

Returns:

void

Example

setup(core: CoreSetup){
 core.uiSettings.register([{
  foo: {
   name: i18n.translate('my foo settings'),
   value: true,
   description: 'add some awesomeness',
  },
 }]);
}