kibana/api_docs/advanced_settings.devdocs.json

{
  "id": "advancedSettings",
  "client": {
    "classes": [],
    "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<FieldProps & React.RefAttributes<",
          "Field",
          ">> & { 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-browser",
            "scope": "common",
            "docId": "kibKbnCoreUiSettingsBrowserPluginApi",
            "section": "def-common.PublicUiSettingsParams",
            "text": "PublicUiSettingsParams"
          },
          " & ",
          {
            "pluginId": "@kbn/core-ui-settings-common",
            "scope": "common",
            "docId": "kibKbnCoreUiSettingsCommonPluginApi",
            "section": "def-common.UserProvidedValues",
            "text": "UserProvidedValues"
          },
          "<any>; 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-browser",
                    "scope": "common",
                    "docId": "kibKbnCoreUiSettingsBrowserPluginApi",
                    "section": "def-common.PublicUiSettingsParams",
                    "text": "PublicUiSettingsParams"
                  },
                  " & ",
                  {
                    "pluginId": "@kbn/core-ui-settings-common",
                    "scope": "common",
                    "docId": "kibKbnCoreUiSettingsCommonPluginApi",
                    "section": "def-common.UserProvidedValues",
                    "text": "UserProvidedValues"
                  },
                  "<any>"
                ],
                "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": "Type",
      "tags": [],
      "label": "AdvancedSettingsSetup",
      "description": [],
      "signature": [
        "{ addSpaceSection: (Component: RegistryComponent, queryMatch: QueryMatchFn) => void; addGlobalSection: (Component: RegistryComponent, queryMatch: QueryMatchFn) => 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": "Type",
      "tags": [],
      "label": "AdvancedSettingsStart",
      "description": [],
      "signature": [
        "{ getGlobalSections: () => ",
        {
          "pluginId": "@kbn/management-settings-section-registry",
          "scope": "common",
          "docId": "kibKbnManagementSettingsSectionRegistryPluginApi",
          "section": "def-common.RegistryEntry",
          "text": "RegistryEntry"
        },
        "[]; getSpacesSections: () => ",
        {
          "pluginId": "@kbn/management-settings-section-registry",
          "scope": "common",
          "docId": "kibKbnManagementSettingsSectionRegistryPluginApi",
          "section": "def-common.RegistryEntry",
          "text": "RegistryEntry"
        },
        "[]; }"
      ],
      "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": []
  }
}