kibana/api_docs/kbn_text_based_editor.devdocs.json

{
  "id": "@kbn/text-based-editor",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/text-based-editor",
        "id": "def-public.fetchFieldsFromESQL",
        "type": "Function",
        "tags": [],
        "label": "fetchFieldsFromESQL",
        "description": [],
        "signature": [
          "(query: ",
          {
            "pluginId": "@kbn/es-query",
            "scope": "common",
            "docId": "kibKbnEsQueryPluginApi",
            "section": "def-common.Query",
            "text": "Query"
          },
          " | ",
          {
            "pluginId": "@kbn/es-query",
            "scope": "common",
            "docId": "kibKbnEsQueryPluginApi",
            "section": "def-common.AggregateQuery",
            "text": "AggregateQuery"
          },
          ", expressions: ",
          {
            "pluginId": "expressions",
            "scope": "public",
            "docId": "kibExpressionsPluginApi",
            "section": "def-public.ExpressionsStart",
            "text": "ExpressionsStart"
          },
          ", time: ",
          {
            "pluginId": "@kbn/es-query",
            "scope": "common",
            "docId": "kibKbnEsQueryPluginApi",
            "section": "def-common.TimeRange",
            "text": "TimeRange"
          },
          " | undefined) => Promise<",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.Datatable",
            "text": "Datatable"
          },
          " | undefined>"
        ],
        "path": "packages/kbn-text-based-editor/src/fetch_fields_from_esql.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.fetchFieldsFromESQL.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "query",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/es-query",
                "scope": "common",
                "docId": "kibKbnEsQueryPluginApi",
                "section": "def-common.Query",
                "text": "Query"
              },
              " | ",
              {
                "pluginId": "@kbn/es-query",
                "scope": "common",
                "docId": "kibKbnEsQueryPluginApi",
                "section": "def-common.AggregateQuery",
                "text": "AggregateQuery"
              }
            ],
            "path": "packages/kbn-text-based-editor/src/fetch_fields_from_esql.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.fetchFieldsFromESQL.$2",
            "type": "Object",
            "tags": [],
            "label": "expressions",
            "description": [],
            "signature": [
              {
                "pluginId": "expressions",
                "scope": "public",
                "docId": "kibExpressionsPluginApi",
                "section": "def-public.ExpressionsStart",
                "text": "ExpressionsStart"
              }
            ],
            "path": "packages/kbn-text-based-editor/src/fetch_fields_from_esql.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.fetchFieldsFromESQL.$3",
            "type": "Object",
            "tags": [],
            "label": "time",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/es-query",
                "scope": "common",
                "docId": "kibKbnEsQueryPluginApi",
                "section": "def-common.TimeRange",
                "text": "TimeRange"
              },
              " | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/fetch_fields_from_esql.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/text-based-editor",
        "id": "def-public.TextBasedLanguagesEditor",
        "type": "Function",
        "tags": [],
        "label": "TextBasedLanguagesEditor",
        "description": [],
        "signature": [
          "React.NamedExoticComponent<",
          {
            "pluginId": "@kbn/text-based-editor",
            "scope": "public",
            "docId": "kibKbnTextBasedEditorPluginApi",
            "section": "def-public.TextBasedLanguagesEditorProps",
            "text": "TextBasedLanguagesEditorProps"
          },
          ">"
        ],
        "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditor.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/text-based-editor",
        "id": "def-public.TextBasedLanguagesEditorProps",
        "type": "Interface",
        "tags": [],
        "label": "TextBasedLanguagesEditorProps",
        "description": [],
        "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.query",
            "type": "CompoundType",
            "tags": [],
            "label": "query",
            "description": [],
            "signature": [
              "{ sql: string; } | { esql: string; }"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange",
            "type": "Function",
            "tags": [],
            "label": "onTextLangQueryChange",
            "description": [],
            "signature": [
              "(query: ",
              {
                "pluginId": "@kbn/es-query",
                "scope": "common",
                "docId": "kibKbnEsQueryPluginApi",
                "section": "def-common.AggregateQuery",
                "text": "AggregateQuery"
              },
              ") => void"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/text-based-editor",
                "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange.$1",
                "type": "CompoundType",
                "tags": [],
                "label": "query",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/es-query",
                    "scope": "common",
                    "docId": "kibKbnEsQueryPluginApi",
                    "section": "def-common.AggregateQuery",
                    "text": "AggregateQuery"
                  }
                ],
                "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQuerySubmit",
            "type": "Function",
            "tags": [],
            "label": "onTextLangQuerySubmit",
            "description": [],
            "signature": [
              "() => void"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.expandCodeEditor",
            "type": "Function",
            "tags": [],
            "label": "expandCodeEditor",
            "description": [],
            "signature": [
              "(status: boolean) => void"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/text-based-editor",
                "id": "def-public.TextBasedLanguagesEditorProps.expandCodeEditor.$1",
                "type": "boolean",
                "tags": [],
                "label": "status",
                "description": [],
                "signature": [
                  "boolean"
                ],
                "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.isCodeEditorExpanded",
            "type": "boolean",
            "tags": [],
            "label": "isCodeEditorExpanded",
            "description": [],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.detectTimestamp",
            "type": "CompoundType",
            "tags": [],
            "label": "detectTimestamp",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.errors",
            "type": "Array",
            "tags": [],
            "label": "errors",
            "description": [],
            "signature": [
              "Error[] | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.warning",
            "type": "string",
            "tags": [],
            "label": "warning",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.isDisabled",
            "type": "CompoundType",
            "tags": [],
            "label": "isDisabled",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.isDarkMode",
            "type": "CompoundType",
            "tags": [],
            "label": "isDarkMode",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.dataTestSubj",
            "type": "string",
            "tags": [],
            "label": "dataTestSubj",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.hideMinimizeButton",
            "type": "CompoundType",
            "tags": [],
            "label": "hideMinimizeButton",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/text-based-editor",
            "id": "def-public.TextBasedLanguagesEditorProps.hideRunQueryText",
            "type": "CompoundType",
            "tags": [],
            "label": "hideRunQueryText",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}