kibana/api_docs/advanced_settings.json

{
  "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,
        "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
          },
          {
            "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,
            "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,
                "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,
                "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,
                "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,
            "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,
            "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
              },
              {
                "parentPluginId": "advancedSettings",
                "id": "def-public.ComponentRegistry.setup.register",
                "type": "Function",
                "tags": [],
                "label": "register",
                "description": [],
                "signature": [
                  "(id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void"
                ],
                "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                "deprecated": false,
                "returnComment": [],
                "children": [
                  {
                    "parentPluginId": "advancedSettings",
                    "id": "def-public.ComponentRegistry.setup.register.$1",
                    "type": "CompoundType",
                    "tags": [],
                    "label": "id",
                    "description": [],
                    "signature": [
                      "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
                    ],
                    "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                    "deprecated": false
                  },
                  {
                    "parentPluginId": "advancedSettings",
                    "id": "def-public.ComponentRegistry.setup.register.$2",
                    "type": "CompoundType",
                    "tags": [],
                    "label": "component",
                    "description": [],
                    "signature": [
                      "React.ComponentClass<Record<string, any> | undefined, any> | React.FunctionComponent<Record<string, any> | undefined>"
                    ],
                    "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                    "deprecated": false
                  },
                  {
                    "parentPluginId": "advancedSettings",
                    "id": "def-public.ComponentRegistry.setup.register.$3",
                    "type": "boolean",
                    "tags": [],
                    "label": "allowOverride",
                    "description": [],
                    "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                    "deprecated": false
                  }
                ]
              }
            ]
          },
          {
            "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,
            "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
              },
              {
                "parentPluginId": "advancedSettings",
                "id": "def-public.ComponentRegistry.start.get",
                "type": "Function",
                "tags": [],
                "label": "get",
                "description": [],
                "signature": [
                  "(id: Id) => React.ComponentType<Record<string, any> | undefined>"
                ],
                "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                "deprecated": false,
                "returnComment": [],
                "children": [
                  {
                    "parentPluginId": "advancedSettings",
                    "id": "def-public.ComponentRegistry.start.get.$1",
                    "type": "CompoundType",
                    "tags": [],
                    "label": "id",
                    "description": [],
                    "signature": [
                      "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
                    ],
                    "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
                    "deprecated": false
                  }
                ]
              }
            ]
          }
        ],
        "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<FieldProps & React.RefAttributes<",
          "Field",
          ">> & { readonly _result: typeof ",
          "Field",
          "; }"
        ],
        "path": "src/plugins/advanced_settings/public/index.ts",
        "deprecated": 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
          }
        ],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "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,
      "children": [
        {
          "parentPluginId": "advancedSettings",
          "id": "def-public.AdvancedSettingsSetup.component",
          "type": "Object",
          "tags": [],
          "label": "component",
          "description": [],
          "signature": [
            "{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void; }"
          ],
          "path": "src/plugins/advanced_settings/public/types.ts",
          "deprecated": 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,
      "children": [
        {
          "parentPluginId": "advancedSettings",
          "id": "def-public.AdvancedSettingsStart.component",
          "type": "Object",
          "tags": [],
          "label": "component",
          "description": [],
          "signature": [
            "{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType<Record<string, any> | undefined>; }"
          ],
          "path": "src/plugins/advanced_settings/public/types.ts",
          "deprecated": false
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}