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_search_api_panels.devdocs.json

1350 lines
No EOL
49 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/search-api-panels",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CloudDetailsPanel",
"type": "Function",
"tags": [],
"label": "CloudDetailsPanel",
"description": [],
"signature": [
"({ cloudId, elasticsearchUrl, isPanelLeft, overviewPanelProps, }: ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.CloudDetailsPanelProps",
"text": "CloudDetailsPanelProps"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/cloud_details.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CloudDetailsPanel.$1",
"type": "Object",
"tags": [],
"label": "{\n cloudId,\n elasticsearchUrl = ELASTICSEARCH_URL_PLACEHOLDER,\n isPanelLeft = true,\n overviewPanelProps,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.CloudDetailsPanelProps",
"text": "CloudDetailsPanelProps"
}
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/cloud_details.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CodeBox",
"type": "Function",
"tags": [],
"label": "CodeBox",
"description": [],
"signature": [
"({ application, codeSnippet, consolePlugin, languageType, languages, assetBasePath, selectedLanguage, setSelectedLanguage, sharePlugin, consoleRequest, consoleTitle, showTopBar, }: CodeBoxProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/code_box.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CodeBox.$1",
"type": "Object",
"tags": [],
"label": "{\n application,\n codeSnippet,\n consolePlugin,\n languageType,\n languages,\n assetBasePath,\n selectedLanguage,\n setSelectedLanguage,\n sharePlugin,\n consoleRequest,\n consoleTitle,\n showTopBar = true,\n}",
"description": [],
"signature": [
"CodeBoxProps"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/code_box.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.getConsoleRequest",
"type": "Function",
"tags": [],
"label": "getConsoleRequest",
"description": [],
"signature": [
"(code: keyof ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinition",
"text": "LanguageDefinition"
},
", args?: ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinitionSnippetArguments",
"text": "LanguageDefinitionSnippetArguments"
},
" | undefined) => string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.getConsoleRequest.$1",
"type": "CompoundType",
"tags": [],
"label": "code",
"description": [],
"signature": [
"keyof ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinition",
"text": "LanguageDefinition"
}
],
"path": "src/platform/packages/shared/kbn-search-api-panels/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.getConsoleRequest.$2",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinitionSnippetArguments",
"text": "LanguageDefinitionSnippetArguments"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.getLanguageDefinitionCodeSnippet",
"type": "Function",
"tags": [],
"label": "getLanguageDefinitionCodeSnippet",
"description": [],
"signature": [
"(language: Partial<",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinition",
"text": "LanguageDefinition"
},
">, key: keyof ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinition",
"text": "LanguageDefinition"
},
", args: ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinitionSnippetArguments",
"text": "LanguageDefinitionSnippetArguments"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.getLanguageDefinitionCodeSnippet.$1",
"type": "Object",
"tags": [],
"label": "language",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinition",
"text": "LanguageDefinition"
},
">"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.getLanguageDefinitionCodeSnippet.$2",
"type": "CompoundType",
"tags": [],
"label": "key",
"description": [],
"signature": [
"keyof ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinition",
"text": "LanguageDefinition"
}
],
"path": "src/platform/packages/shared/kbn-search-api-panels/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.getLanguageDefinitionCodeSnippet.$3",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.LanguageDefinitionSnippetArguments",
"text": "LanguageDefinitionSnippetArguments"
}
],
"path": "src/platform/packages/shared/kbn-search-api-panels/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.GithubLink",
"type": "Function",
"tags": [],
"label": "GithubLink",
"description": [],
"signature": [
"({ assetBasePath, label, href, \"aria-label\": ariaLabel }: { assetBasePath: string; label: string; href: string; 'aria-label'?: string | undefined; }) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/github_link.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.GithubLink.$1",
"type": "Object",
"tags": [],
"label": "{ assetBasePath, label, href, 'aria-label': ariaLabel }",
"description": [],
"signature": [
"{ assetBasePath: string; label: string; href: string; 'aria-label'?: string | undefined; }"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/github_link.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.IngestData",
"type": "Function",
"tags": [],
"label": "IngestData",
"description": [],
"signature": [
"({ codeSnippet, selectedLanguage, selectedPipeline, setSelectedLanguage, docLinks, assetBasePath, application, consolePlugin, sharePlugin, languages, consoleRequest, additionalIngestionPanel, ingestPipelineData, setSelectedPipeline, defaultIngestPipeline, }: IngestDataProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/ingest_data.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.IngestData.$1",
"type": "Object",
"tags": [],
"label": "{\n codeSnippet,\n selectedLanguage,\n selectedPipeline,\n setSelectedLanguage,\n docLinks,\n assetBasePath,\n application,\n consolePlugin,\n sharePlugin,\n languages,\n consoleRequest,\n additionalIngestionPanel,\n ingestPipelineData,\n setSelectedPipeline,\n defaultIngestPipeline,\n}",
"description": [],
"signature": [
"IngestDataProps"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/ingest_data.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.IngestionsPanel",
"type": "Function",
"tags": [],
"label": "IngestionsPanel",
"description": [],
"signature": [
"({ additionalIngestionPanel, docLinks, assetBasePath, }: IngestionPanelProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/ingestions_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.IngestionsPanel.$1",
"type": "Object",
"tags": [],
"label": "{\n additionalIngestionPanel,\n docLinks,\n assetBasePath,\n}",
"description": [],
"signature": [
"IngestionPanelProps"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/ingestions_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.IngestPipelinePanel",
"type": "Function",
"tags": [],
"label": "IngestPipelinePanel",
"description": [],
"signature": [
"({ selectedPipeline, setSelectedPipeline, ingestPipelinesData, defaultIngestPipeline, }: IngestPipelinePanelProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/ingest_pipelines/ingest_pipeline_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.IngestPipelinePanel.$1",
"type": "Object",
"tags": [],
"label": "{\n selectedPipeline,\n setSelectedPipeline,\n ingestPipelinesData,\n defaultIngestPipeline,\n}",
"description": [],
"signature": [
"IngestPipelinePanelProps"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/ingest_pipelines/ingest_pipeline_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.InstallClientPanel",
"type": "Function",
"tags": [],
"label": "InstallClientPanel",
"description": [],
"signature": [
"({ codeSnippet, consoleRequest, language, languages, setSelectedLanguage, assetBasePath, application, sharePlugin, isPanelLeft, overviewPanelProps, }: InstallClientProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/install_client.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.InstallClientPanel.$1",
"type": "Object",
"tags": [],
"label": "{\n codeSnippet,\n consoleRequest,\n language,\n languages,\n setSelectedLanguage,\n assetBasePath,\n application,\n sharePlugin,\n isPanelLeft = true,\n overviewPanelProps,\n}",
"description": [],
"signature": [
"InstallClientProps"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/install_client.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageClientPanel",
"type": "Function",
"tags": [],
"label": "LanguageClientPanel",
"description": [],
"signature": [
"({ language, setSelectedLanguage, isSelectedLanguage, assetBasePath, src, }: SelectClientProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/language_client_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageClientPanel.$1",
"type": "Object",
"tags": [],
"label": "{\n language,\n setSelectedLanguage,\n isSelectedLanguage,\n assetBasePath,\n src,\n}",
"description": [],
"signature": [
"SelectClientProps"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/language_client_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.OverviewPanel",
"type": "Function",
"tags": [],
"label": "OverviewPanel",
"description": [],
"signature": [
"({ children, description, leftPanelContent, links, rightPanelContent, title, overviewPanelProps, }: React.PropsWithChildren<OverviewPanelProps>) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/overview_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.OverviewPanel.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n description,\n leftPanelContent,\n links,\n rightPanelContent,\n title,\n overviewPanelProps,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<OverviewPanelProps>"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/overview_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.PipelinePanel",
"type": "Function",
"tags": [],
"label": "PipelinePanel",
"description": [],
"signature": [
"({ clusterImage, cutImage, reporterImage, }: PipelinePanelProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/pipeline_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.PipelinePanel.$1",
"type": "Object",
"tags": [],
"label": "{\n clusterImage,\n cutImage,\n reporterImage,\n}",
"description": [],
"signature": [
"PipelinePanelProps"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/pipeline_panel.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.PreprocessDataPanel",
"type": "Function",
"tags": [],
"label": "PreprocessDataPanel",
"description": [],
"signature": [
"({ docLinks, images }: { docLinks: { arrayOrJson: string; dataEnrichment: string; dataFiltering: string; dataTransformation: string; pipelineHandling: string; }; images: { dataEnrichment: string; dataTransformation: string; dataFiltering: string; pipelineHandling: string; arrayHandling: string; }; }) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/preprocess_data.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.PreprocessDataPanel.$1",
"type": "Object",
"tags": [],
"label": "{ docLinks, images }",
"description": [],
"signature": [
"{ docLinks: { arrayOrJson: string; dataEnrichment: string; dataFiltering: string; dataTransformation: string; pipelineHandling: string; }; images: { dataEnrichment: string; dataTransformation: string; dataFiltering: string; pipelineHandling: string; arrayHandling: string; }; }"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/preprocess_data.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanel",
"type": "Function",
"tags": [],
"label": "SelectClientPanel",
"description": [],
"signature": [
"({ docLinks, children, isPanelLeft, overviewPanelProps, callout, application, consolePlugin, sharePlugin, }: React.PropsWithChildren<",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.SelectClientPanelProps",
"text": "SelectClientPanelProps"
},
">) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanel.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n docLinks,\n children,\n isPanelLeft = true,\n overviewPanelProps,\n callout,\n application,\n consolePlugin,\n sharePlugin,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.SelectClientPanelProps",
"text": "SelectClientPanelProps"
},
">"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.WelcomeBanner",
"type": "Function",
"tags": [],
"label": "WelcomeBanner",
"description": [],
"signature": [
"({ user, assetBasePath, image, showDescription, }: ",
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.WelcomeBannerProps",
"text": "WelcomeBannerProps"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.WelcomeBanner.$1",
"type": "Object",
"tags": [],
"label": "{\n user,\n assetBasePath,\n image,\n showDescription = true,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.WelcomeBannerProps",
"text": "WelcomeBannerProps"
}
],
"path": "src/platform/packages/shared/kbn-search-api-panels/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CloudDetailsPanelProps",
"type": "Interface",
"tags": [],
"label": "CloudDetailsPanelProps",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/cloud_details.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CloudDetailsPanelProps.cloudId",
"type": "string",
"tags": [],
"label": "cloudId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/cloud_details.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CloudDetailsPanelProps.elasticsearchUrl",
"type": "string",
"tags": [],
"label": "elasticsearchUrl",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/cloud_details.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CloudDetailsPanelProps.isPanelLeft",
"type": "CompoundType",
"tags": [],
"label": "isPanelLeft",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/cloud_details.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.CloudDetailsPanelProps.overviewPanelProps",
"type": "CompoundType",
"tags": [],
"label": "overviewPanelProps",
"description": [],
"signature": [
"Partial<(",
"DisambiguateSet",
"<",
"_EuiPanelButtonlike",
", ",
"_EuiPanelDivlike",
"> & ",
"_EuiPanelDivlike",
") | (",
"DisambiguateSet",
"<",
"_EuiPanelDivlike",
", ",
"_EuiPanelButtonlike",
"> & ",
"_EuiPanelButtonlike",
")> | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/cloud_details.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition",
"type": "Interface",
"tags": [],
"label": "LanguageDefinition",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.id",
"type": "Enum",
"tags": [],
"label": "id",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-api-panels",
"scope": "common",
"docId": "kibKbnSearchApiPanelsPluginApi",
"section": "def-common.Languages",
"text": "Languages"
}
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.iconType",
"type": "string",
"tags": [],
"label": "iconType",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.docLink",
"type": "string",
"tags": [],
"label": "docLink",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.configureClient",
"type": "CompoundType",
"tags": [],
"label": "configureClient",
"description": [],
"signature": [
"CodeSnippet | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.ingestData",
"type": "CompoundType",
"tags": [],
"label": "ingestData",
"description": [],
"signature": [
"CodeSnippet | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.ingestDataIndex",
"type": "CompoundType",
"tags": [],
"label": "ingestDataIndex",
"description": [],
"signature": [
"CodeSnippet | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.installClient",
"type": "string",
"tags": [],
"label": "installClient",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.buildSearchQuery",
"type": "CompoundType",
"tags": [],
"label": "buildSearchQuery",
"description": [],
"signature": [
"CodeSnippet | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.testConnection",
"type": "CompoundType",
"tags": [],
"label": "testConnection",
"description": [],
"signature": [
"CodeSnippet | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.advancedConfig",
"type": "string",
"tags": [],
"label": "advancedConfig",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.apiReference",
"type": "string",
"tags": [],
"label": "apiReference",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.basicConfig",
"type": "string",
"tags": [],
"label": "basicConfig",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.github",
"type": "Object",
"tags": [],
"label": "github",
"description": [],
"signature": [
"{ link: string; label: string; } | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinition.languageStyling",
"type": "string",
"tags": [],
"label": "languageStyling",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinitionSnippetArguments",
"type": "Interface",
"tags": [],
"label": "LanguageDefinitionSnippetArguments",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinitionSnippetArguments.url",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinitionSnippetArguments.apiKey",
"type": "string",
"tags": [],
"label": "apiKey",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinitionSnippetArguments.indexName",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinitionSnippetArguments.cloudId",
"type": "string",
"tags": [],
"label": "cloudId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinitionSnippetArguments.ingestPipeline",
"type": "string",
"tags": [],
"label": "ingestPipeline",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.LanguageDefinitionSnippetArguments.extraIngestDocumentValues",
"type": "Object",
"tags": [],
"label": "extraIngestDocumentValues",
"description": [],
"signature": [
"Record<string, boolean> | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps",
"type": "Interface",
"tags": [],
"label": "SelectClientPanelProps",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.docLinks",
"type": "Object",
"tags": [],
"label": "docLinks",
"description": [],
"signature": [
"{ elasticsearchClients: string; kibanaRunApiInConsole: string; }"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.isPanelLeft",
"type": "CompoundType",
"tags": [],
"label": "isPanelLeft",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.overviewPanelProps",
"type": "CompoundType",
"tags": [],
"label": "overviewPanelProps",
"description": [],
"signature": [
"Partial<(",
"DisambiguateSet",
"<",
"_EuiPanelButtonlike",
", ",
"_EuiPanelDivlike",
"> & ",
"_EuiPanelDivlike",
") | (",
"DisambiguateSet",
"<",
"_EuiPanelDivlike",
", ",
"_EuiPanelButtonlike",
"> & ",
"_EuiPanelButtonlike",
")> | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.callout",
"type": "CompoundType",
"tags": [],
"label": "callout",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.application",
"type": "Object",
"tags": [],
"label": "application",
"description": [],
"signature": [
"ApplicationStart",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.consolePlugin",
"type": "Object",
"tags": [],
"label": "consolePlugin",
"description": [],
"signature": [
{
"pluginId": "console",
"scope": "public",
"docId": "kibConsolePluginApi",
"section": "def-public.ConsolePluginStart",
"text": "ConsolePluginStart"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.sharePlugin",
"type": "CompoundType",
"tags": [],
"label": "sharePlugin",
"description": [],
"signature": [
"{ toggleShareContextMenu: (options: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShowShareMenuOptions",
"text": "ShowShareMenuOptions"
},
") => void; } & { url: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.BrowserUrlService",
"text": "BrowserUrlService"
},
"; navigate(options: ",
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">): void; }"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.SelectClientPanelProps.children",
"type": "CompoundType",
"tags": [],
"label": "children",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/components/select_client.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.WelcomeBannerProps",
"type": "Interface",
"tags": [],
"label": "WelcomeBannerProps",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.WelcomeBannerProps.user",
"type": "Object",
"tags": [],
"label": "user",
"description": [],
"signature": [
"AuthenticatedUser",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.WelcomeBannerProps.assetBasePath",
"type": "string",
"tags": [],
"label": "assetBasePath",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.WelcomeBannerProps.image",
"type": "string",
"tags": [],
"label": "image",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.WelcomeBannerProps.showDescription",
"type": "CompoundType",
"tags": [],
"label": "showDescription",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-search-api-panels/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/search-api-panels",
"id": "def-common.Languages",
"type": "Enum",
"tags": [],
"label": "Languages",
"description": [],
"path": "src/platform/packages/shared/kbn-search-api-panels/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink