github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_text_based_editor.devdocs.json

608 lines
No EOL
21 KiB
JSON
Raw Permalink Blame History

{
"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, abortController: AbortController | undefined, dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | 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
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.fetchFieldsFromESQL.$4",
"type": "Object",
"tags": [],
"label": "abortController",
"description": [],
"signature": [
"AbortController | undefined"
],
"path": "packages/kbn-text-based-editor/src/fetch_fields_from_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.fetchFieldsFromESQL.$5",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | 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/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"The aggregate type query"
],
"signature": [
"{ esql: string; }"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange",
"type": "Function",
"tags": [],
"label": "onTextLangQueryChange",
"description": [
"Callback running everytime the query changes"
],
"signature": [
"(query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
") => void"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange.$1",
"type": "Object",
"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/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.onTextLangQuerySubmit",
"type": "Function",
"tags": [],
"label": "onTextLangQuerySubmit",
"description": [
"Callback running when the user submits the query"
],
"signature": [
"(query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined, abortController?: AbortController | undefined) => Promise<void>"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.onTextLangQuerySubmit.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.onTextLangQuerySubmit.$2",
"type": "Object",
"tags": [],
"label": "abortController",
"description": [],
"signature": [
"AbortController | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.detectedTimestamp",
"type": "string",
"tags": [],
"label": "detectedTimestamp",
"description": [
"If it is true, the editor displays the message @timestamp found\nThe text based queries are relying on adhoc dataviews which\ncan have an @timestamp timefield or nothing"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [
"Array of errors"
],
"signature": [
"Error[] | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.warning",
"type": "string",
"tags": [],
"label": "warning",
"description": [
"Warning string as it comes from ES"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.isLoading",
"type": "CompoundType",
"tags": [],
"label": "isLoading",
"description": [
"Disables the editor and displays loading icon in run button\nIt is also used for hiding the history component if it is not defined"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.isDisabled",
"type": "CompoundType",
"tags": [],
"label": "isDisabled",
"description": [
"Disables the editor"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.hideRunQueryText",
"type": "CompoundType",
"tags": [],
"label": "hideRunQueryText",
"description": [
"Hide the Run query information which appears on the footer"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.editorIsInline",
"type": "CompoundType",
"tags": [],
"label": "editorIsInline",
"description": [
"This is used for applications (such as the inline editing flyout in dashboards)\nwhich want to add the editor without being part of the Unified search component\nIt renders a submit query button inside the editor"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.disableSubmitAction",
"type": "CompoundType",
"tags": [],
"label": "disableSubmitAction",
"description": [
"Disables the submit query action"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.allowQueryCancellation",
"type": "CompoundType",
"tags": [],
"label": "allowQueryCancellation",
"description": [
"when set to true enables query cancellation"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.hideTimeFilterInfo",
"type": "CompoundType",
"tags": [],
"label": "hideTimeFilterInfo",
"description": [
"hide @timestamp info"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.hideQueryHistory",
"type": "CompoundType",
"tags": [],
"label": "hideQueryHistory",
"description": [
"hide query history"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.hasOutline",
"type": "CompoundType",
"tags": [],
"label": "hasOutline",
"description": [
"adds border in the editor"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/text-based-editor",
"id": "def-public.TextBasedLanguagesEditorProps.displayDocumentationAsFlyout",
"type": "CompoundType",
"tags": [],
"label": "displayDocumentationAsFlyout",
"description": [
"adds a documentation icon in the footer which opens the inline docs as a flyout"
],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-text-based-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink