{ "id": "advancedSettings", "client": { "classes": [ { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry", "type": "Class", "tags": [], "label": "ComponentRegistry", "description": [], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.componentType", "type": "Object", "tags": [], "label": "componentType", "description": [], "signature": [ "{ [key: string]: Id; }" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry", "type": "Object", "tags": [], "label": "defaultRegistry", "description": [], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title", "type": "Function", "tags": [], "label": "advanced_settings_page_title", "description": [], "signature": [ "() => JSX.Element" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle", "type": "Function", "tags": [], "label": "advanced_settings_page_subtitle", "description": [], "signature": [ "() => null" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer", "type": "Function", "tags": [], "label": "advanced_settings_page_footer", "description": [], "signature": [ "() => null" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] } ] }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.registry", "type": "Object", "tags": [], "label": "registry", "description": [], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "children": [] }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup", "type": "Object", "tags": [], "label": "setup", "description": [], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup.componentType", "type": "Object", "tags": [], "label": "componentType", "description": [], "signature": [ "{ [key: string]: Id; }" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup.register", "type": "Function", "tags": [], "label": "register", "description": [ "/**\n * Attempts to register the provided component, with the ability to optionally allow\n * the component to override an existing one.\n *\n * If the intent is to override, then `allowOverride` must be set to true, otherwise an exception is thrown.\n *\n * @param id the id of the component to register\n * @param component the component\n * @param allowOverride (default: false) - optional flag to allow this component to override a previously registered component\n */" ], "signature": [ "(id: Id, component: RegistryComponent, allowOverride?: boolean) => void" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup.register.$1", "type": "CompoundType", "tags": [], "label": "id", "description": [], "signature": [ "Id" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup.register.$2", "type": "CompoundType", "tags": [], "label": "component", "description": [], "signature": [ "RegistryComponent" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.setup.register.$3", "type": "boolean", "tags": [], "label": "allowOverride", "description": [], "signature": [ "boolean" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.start", "type": "Object", "tags": [], "label": "start", "description": [], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.start.componentType", "type": "Object", "tags": [], "label": "componentType", "description": [], "signature": [ "{ [key: string]: Id; }" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.start.get", "type": "Function", "tags": [], "label": "get", "description": [ "/**\n * Retrieve a registered component by its ID.\n * If the component does not exist, then an exception is thrown.\n *\n * @param id the ID of the component to retrieve\n */" ], "signature": [ "(id: Id) => RegistryComponent" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.ComponentRegistry.start.get.$1", "type": "CompoundType", "tags": [], "label": "id", "description": [], "signature": [ "Id" ], "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "advancedSettings", "id": "def-public.LazyField", "type": "Function", "tags": [], "label": "LazyField", "description": [ "\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context." ], "signature": [ "React.ExoticComponent> & { readonly _result: typeof ", "Field", "; }" ], "path": "src/plugins/advanced_settings/public/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.LazyField.$1", "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ "P" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "advancedSettings", "id": "def-public.toEditableConfig", "type": "Function", "tags": [], "label": "toEditableConfig", "description": [], "signature": [ "({\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}: { def: ", { "pluginId": "@kbn/core-ui-settings-common", "scope": "common", "docId": "kibKbnCoreUiSettingsCommonPluginApi", "section": "def-common.PublicUiSettingsParams", "text": "PublicUiSettingsParams" }, " & ", { "pluginId": "@kbn/core-ui-settings-common", "scope": "common", "docId": "kibKbnCoreUiSettingsCommonPluginApi", "section": "def-common.UserProvidedValues", "text": "UserProvidedValues" }, "; name: string; value: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectAttribute", "text": "SavedObjectAttribute" }, "; isCustom: boolean; isOverridden: boolean; }) => ", "FieldSetting" ], "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.toEditableConfig.$1", "type": "Object", "tags": [], "label": "{\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}", "description": [], "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.toEditableConfig.$1.def", "type": "CompoundType", "tags": [], "label": "def", "description": [], "signature": [ { "pluginId": "@kbn/core-ui-settings-common", "scope": "common", "docId": "kibKbnCoreUiSettingsCommonPluginApi", "section": "def-common.PublicUiSettingsParams", "text": "PublicUiSettingsParams" }, " & ", { "pluginId": "@kbn/core-ui-settings-common", "scope": "common", "docId": "kibKbnCoreUiSettingsCommonPluginApi", "section": "def-common.UserProvidedValues", "text": "UserProvidedValues" }, "" ], "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.toEditableConfig.$1.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.toEditableConfig.$1.value", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectAttributeSingle", "text": "SavedObjectAttributeSingle" }, " | ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectAttributeSingle", "text": "SavedObjectAttributeSingle" }, "[]" ], "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.toEditableConfig.$1.isCustom", "type": "boolean", "tags": [], "label": "isCustom", "description": [], "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.toEditableConfig.$1.isOverridden", "type": "boolean", "tags": [], "label": "isOverridden", "description": [], "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [ "the editable config object" ], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "advancedSettings", "id": "def-public.FieldState", "type": "Interface", "tags": [], "label": "FieldState", "description": [], "path": "src/plugins/advanced_settings/public/management_app/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.FieldState.value", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/advanced_settings/public/management_app/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.FieldState.changeImage", "type": "CompoundType", "tags": [], "label": "changeImage", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/advanced_settings/public/management_app/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.FieldState.loading", "type": "CompoundType", "tags": [], "label": "loading", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/advanced_settings/public/management_app/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.FieldState.isInvalid", "type": "CompoundType", "tags": [], "label": "isInvalid", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/advanced_settings/public/management_app/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "advancedSettings", "id": "def-public.FieldState.error", "type": "CompoundType", "tags": [], "label": "error", "description": [], "signature": [ "string | null | undefined" ], "path": "src/plugins/advanced_settings/public/management_app/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsSetup", "type": "Interface", "tags": [], "label": "AdvancedSettingsSetup", "description": [], "path": "src/plugins/advanced_settings/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsSetup.component", "type": "Object", "tags": [], "label": "component", "description": [], "signature": [ "{ componentType: { [key: string]: Id; }; register: (id: Id, component: RegistryComponent, allowOverride?: boolean) => void; }" ], "path": "src/plugins/advanced_settings/public/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsStart", "type": "Interface", "tags": [], "label": "AdvancedSettingsStart", "description": [], "path": "src/plugins/advanced_settings/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "advancedSettings", "id": "def-public.AdvancedSettingsStart.component", "type": "Object", "tags": [], "label": "component", "description": [], "signature": [ "{ componentType: { [key: string]: Id; }; get: (id: Id) => RegistryComponent; }" ], "path": "src/plugins/advanced_settings/public/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }