mirror of
https://github.com/elastic/kibana.git
synced 2025-04-18 23:21:39 -04:00
547 lines
No EOL
20 KiB
JSON
547 lines
No EOL
20 KiB
JSON
{
|
|
"id": "textBasedLanguages",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLangEditor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "TextBasedLangEditor",
|
|
"description": [],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "@kbn/text-based-editor",
|
|
"scope": "public",
|
|
"docId": "kibKbnTextBasedEditorPluginApi",
|
|
"section": "def-public.TextBasedLanguagesEditorProps",
|
|
"text": "TextBasedLanguagesEditorProps"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"path": "src/plugins/text_based_languages/public/create_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLangEditor.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/text-based-editor",
|
|
"scope": "public",
|
|
"docId": "kibKbnTextBasedEditorPluginApi",
|
|
"section": "def-public.TextBasedLanguagesEditorProps",
|
|
"text": "TextBasedLanguagesEditorProps"
|
|
}
|
|
],
|
|
"path": "src/plugins/text_based_languages/public/create_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.onTextLangQuerySubmit.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "abortController",
|
|
"description": [],
|
|
"signature": [
|
|
"AbortController | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.expandCodeEditor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "expandCodeEditor",
|
|
"description": [
|
|
"Can be used to expand/minimize the editor"
|
|
],
|
|
"signature": [
|
|
"(status: boolean) => void"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.isCodeEditorExpanded",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isCodeEditorExpanded",
|
|
"description": [
|
|
"If it is true, the editor initializes with height EDITOR_INITIAL_HEIGHT_EXPANDED"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.detectTimestamp",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "detectTimestamp",
|
|
"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": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [
|
|
"Array of errors"
|
|
],
|
|
"signature": [
|
|
"Error[] | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.isDisabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isDisabled",
|
|
"description": [
|
|
"Disables the editor"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.isDarkMode",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isDarkMode",
|
|
"description": [
|
|
"Indicator if the editor is on dark mode"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.hideMinimizeButton",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hideMinimizeButton",
|
|
"description": [
|
|
"If true it hides the minimize button and the user can't return to the minimized version\nUseful when the application doesn't want to give this capability"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"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/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.hideTimeFilterInfo",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hideTimeFilterInfo",
|
|
"description": [
|
|
"hide @timestamp info"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.hideQueryHistory",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hideQueryHistory",
|
|
"description": [
|
|
"hide query history"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesEditorProps.hideHeaderWhenExpanded",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hideHeaderWhenExpanded",
|
|
"description": [
|
|
"hide header buttons when editor is expanded"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesPluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TextBasedLanguagesPluginStart",
|
|
"description": [],
|
|
"path": "src/plugins/text_based_languages/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "textBasedLanguages",
|
|
"id": "def-public.TextBasedLanguagesPluginStart.Editor",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "Editor",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ComponentClass<",
|
|
{
|
|
"pluginId": "@kbn/text-based-editor",
|
|
"scope": "public",
|
|
"docId": "kibKbnTextBasedEditorPluginApi",
|
|
"section": "def-public.TextBasedLanguagesEditorProps",
|
|
"text": "TextBasedLanguagesEditorProps"
|
|
},
|
|
", any> | React.FunctionComponent<",
|
|
{
|
|
"pluginId": "@kbn/text-based-editor",
|
|
"scope": "public",
|
|
"docId": "kibKbnTextBasedEditorPluginApi",
|
|
"section": "def-public.TextBasedLanguagesEditorProps",
|
|
"text": "TextBasedLanguagesEditorProps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/text_based_languages/public/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": []
|
|
}
|
|
} |