kibana/api_docs/runtime_fields.devdocs.json

{
  "id": "runtimeFields",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "runtimeFields",
        "id": "def-public.RuntimeFieldEditor",
        "type": "Function",
        "tags": [],
        "label": "RuntimeFieldEditor",
        "description": [],
        "signature": [
          "({ defaultValue, onChange, docLinks, ctx }: ",
          {
            "pluginId": "runtimeFields",
            "scope": "public",
            "docId": "kibRuntimeFieldsPluginApi",
            "section": "def-public.Props",
            "text": "Props"
          },
          ") => JSX.Element"
        ],
        "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.RuntimeFieldEditor.$1",
            "type": "Object",
            "tags": [],
            "label": "{ defaultValue, onChange, docLinks, ctx }",
            "description": [],
            "signature": [
              {
                "pluginId": "runtimeFields",
                "scope": "public",
                "docId": "kibRuntimeFieldsPluginApi",
                "section": "def-public.Props",
                "text": "Props"
              }
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "runtimeFields",
        "id": "def-public.RuntimeFieldEditorFlyoutContent",
        "type": "Function",
        "tags": [],
        "label": "RuntimeFieldEditorFlyoutContent",
        "description": [],
        "signature": [
          "({ onSave, onCancel, docLinks, defaultValue: field, ctx, }: ",
          {
            "pluginId": "runtimeFields",
            "scope": "public",
            "docId": "kibRuntimeFieldsPluginApi",
            "section": "def-public.Props",
            "text": "Props"
          },
          ") => JSX.Element"
        ],
        "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.RuntimeFieldEditorFlyoutContent.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  onSave,\n  onCancel,\n  docLinks,\n  defaultValue: field,\n  ctx,\n}",
            "description": [],
            "signature": [
              {
                "pluginId": "runtimeFields",
                "scope": "public",
                "docId": "kibRuntimeFieldsPluginApi",
                "section": "def-public.Props",
                "text": "Props"
              }
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "runtimeFields",
        "id": "def-public.FormState",
        "type": "Interface",
        "tags": [],
        "label": "FormState",
        "description": [],
        "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.FormState.isValid",
            "type": "CompoundType",
            "tags": [],
            "label": "isValid",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.FormState.isSubmitted",
            "type": "boolean",
            "tags": [],
            "label": "isSubmitted",
            "description": [],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.FormState.submit",
            "type": "Function",
            "tags": [],
            "label": "submit",
            "description": [],
            "signature": [
              "(e?: React.MouseEvent<Element, MouseEvent> | React.FormEvent<HTMLFormElement> | undefined) => Promise<{ data: ",
              {
                "pluginId": "runtimeFields",
                "scope": "public",
                "docId": "kibRuntimeFieldsPluginApi",
                "section": "def-public.RuntimeField",
                "text": "RuntimeField"
              },
              "; isValid: boolean; }>"
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "returnComment": [],
            "children": [
              {
                "parentPluginId": "runtimeFields",
                "id": "def-public.FormState.submit.$1",
                "type": "CompoundType",
                "tags": [],
                "label": "e",
                "description": [],
                "signature": [
                  "React.MouseEvent<Element, MouseEvent> | React.FormEvent<HTMLFormElement> | undefined"
                ],
                "path": "src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "runtimeFields",
        "id": "def-public.Props",
        "type": "Interface",
        "tags": [],
        "label": "Props",
        "description": [],
        "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.Props.onSave",
            "type": "Function",
            "tags": [],
            "label": "onSave",
            "description": [
              "\nHandler for the \"save\" footer button"
            ],
            "signature": [
              "(field: ",
              {
                "pluginId": "runtimeFields",
                "scope": "public",
                "docId": "kibRuntimeFieldsPluginApi",
                "section": "def-public.RuntimeField",
                "text": "RuntimeField"
              },
              ") => void"
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "runtimeFields",
                "id": "def-public.Props.onSave.$1",
                "type": "Object",
                "tags": [],
                "label": "field",
                "description": [],
                "signature": [
                  {
                    "pluginId": "runtimeFields",
                    "scope": "public",
                    "docId": "kibRuntimeFieldsPluginApi",
                    "section": "def-public.RuntimeField",
                    "text": "RuntimeField"
                  }
                ],
                "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.Props.onCancel",
            "type": "Function",
            "tags": [],
            "label": "onCancel",
            "description": [
              "\nHandler for the \"cancel\" footer button"
            ],
            "signature": [
              "() => void"
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.Props.docLinks",
            "type": "Object",
            "tags": [],
            "label": "docLinks",
            "description": [
              "\nThe docLinks start service from core"
            ],
            "signature": [
              {
                "pluginId": "@kbn/core-doc-links-browser",
                "scope": "common",
                "docId": "kibKbnCoreDocLinksBrowserPluginApi",
                "section": "def-common.DocLinksStart",
                "text": "DocLinksStart"
              }
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.Props.defaultValue",
            "type": "Object",
            "tags": [],
            "label": "defaultValue",
            "description": [
              "\nAn optional runtime field to edit"
            ],
            "signature": [
              {
                "pluginId": "runtimeFields",
                "scope": "public",
                "docId": "kibRuntimeFieldsPluginApi",
                "section": "def-public.RuntimeField",
                "text": "RuntimeField"
              },
              " | undefined"
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.Props.ctx",
            "type": "Object",
            "tags": [],
            "label": "ctx",
            "description": [
              "\nOptional context object"
            ],
            "signature": [
              "{ namesNotAllowed?: string[] | undefined; existingConcreteFields?: Field[] | undefined; } | undefined"
            ],
            "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "runtimeFields",
        "id": "def-public.RuntimeField",
        "type": "Interface",
        "tags": [],
        "label": "RuntimeField",
        "description": [],
        "path": "x-pack/plugins/runtime_fields/public/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.RuntimeField.name",
            "type": "string",
            "tags": [],
            "label": "name",
            "description": [],
            "path": "x-pack/plugins/runtime_fields/public/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.RuntimeField.type",
            "type": "CompoundType",
            "tags": [],
            "label": "type",
            "description": [],
            "signature": [
              "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
            ],
            "path": "x-pack/plugins/runtime_fields/public/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "runtimeFields",
            "id": "def-public.RuntimeField.script",
            "type": "Object",
            "tags": [],
            "label": "script",
            "description": [],
            "signature": [
              "{ source: string; }"
            ],
            "path": "x-pack/plugins/runtime_fields/public/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "runtimeFields",
        "id": "def-public.RUNTIME_FIELD_OPTIONS",
        "type": "Array",
        "tags": [],
        "label": "RUNTIME_FIELD_OPTIONS",
        "description": [],
        "signature": [
          "ComboBoxOption",
          "<\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\">[]"
        ],
        "path": "x-pack/plugins/runtime_fields/public/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "runtimeFields",
        "id": "def-public.RuntimeType",
        "type": "Type",
        "tags": [],
        "label": "RuntimeType",
        "description": [],
        "signature": [
          "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
        ],
        "path": "x-pack/plugins/runtime_fields/public/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "runtimeFields",
      "id": "def-public.PluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "PluginSetup",
      "description": [],
      "path": "x-pack/plugins/runtime_fields/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "runtimeFields",
          "id": "def-public.PluginSetup.loadEditor",
          "type": "Function",
          "tags": [],
          "label": "loadEditor",
          "description": [],
          "signature": [
            "() => Promise<",
            "LoadEditorResponse",
            ">"
          ],
          "path": "x-pack/plugins/runtime_fields/public/types.ts",
          "deprecated": false,
          "trackAdoption": false,
          "children": [],
          "returnComment": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}