kibana/api_docs/data_visualizer.devdocs.json

523 lines
No EOL
18 KiB
JSON

{
"id": "dataVisualizer",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.GetAdditionalLinksParams",
"type": "Interface",
"tags": [],
"label": "GetAdditionalLinksParams",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.GetAdditionalLinksParams.dataViewId",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.GetAdditionalLinksParams.dataViewTitle",
"type": "string",
"tags": [],
"label": "dataViewTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.GetAdditionalLinksParams.globalState",
"type": "Any",
"tags": [],
"label": "globalState",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps",
"type": "Interface",
"tags": [],
"label": "IndexDataVisualizerViewProps",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps.currentDataView",
"type": "Object",
"tags": [],
"label": "currentDataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps.currentSavedSearch",
"type": "CompoundType",
"tags": [],
"label": "currentSavedSearch",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
},
" | null"
],
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps.currentSessionId",
"type": "string",
"tags": [],
"label": "currentSessionId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps.getAdditionalLinks",
"type": "Array",
"tags": [],
"label": "getAdditionalLinks",
"description": [],
"signature": [
{
"pluginId": "dataVisualizer",
"scope": "public",
"docId": "kibDataVisualizerPluginApi",
"section": "def-public.GetAdditionalLinks",
"text": "GetAdditionalLinks"
},
" | undefined"
],
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink",
"type": "Interface",
"tags": [],
"label": "ResultLink",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"index\" | \"file\""
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.getUrl",
"type": "Function",
"tags": [],
"label": "getUrl",
"description": [],
"signature": [
"(params?: any) => Promise<string>"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.getUrl.$1",
"type": "Any",
"tags": [],
"label": "params",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.canDisplay",
"type": "Function",
"tags": [],
"label": "canDisplay",
"description": [],
"signature": [
"(params?: any) => Promise<boolean>"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.canDisplay.$1",
"type": "Any",
"tags": [],
"label": "params",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.ResultLink.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.DataDriftSpec",
"type": "Type",
"tags": [],
"label": "DataDriftSpec",
"description": [],
"signature": [
"React.FunctionComponent<",
"DataDriftDetectionAppStateProps",
">"
],
"path": "x-pack/plugins/data_visualizer/public/application/data_drift/data_drift_app_state.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.DataDriftSpec.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.DataDriftSpec.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.FileDataVisualizerSpec",
"type": "Type",
"tags": [],
"label": "FileDataVisualizerSpec",
"description": [],
"signature": [
"React.FunctionComponent<",
"Props",
">"
],
"path": "x-pack/plugins/data_visualizer/public/application/file_data_visualizer/file_data_visualizer.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.FileDataVisualizerSpec.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.FileDataVisualizerSpec.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.GetAdditionalLinks",
"type": "Type",
"tags": [],
"label": "GetAdditionalLinks",
"description": [],
"signature": [
"((params: ",
{
"pluginId": "dataVisualizer",
"scope": "public",
"docId": "kibDataVisualizerPluginApi",
"section": "def-public.GetAdditionalLinksParams",
"text": "GetAdditionalLinksParams"
},
") => Promise<",
{
"pluginId": "dataVisualizer",
"scope": "public",
"docId": "kibDataVisualizerPluginApi",
"section": "def-public.ResultLink",
"text": "ResultLink"
},
"[] | undefined>)[]"
],
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerSpec",
"type": "Type",
"tags": [],
"label": "IndexDataVisualizerSpec",
"description": [],
"signature": [
"React.FunctionComponent<",
"Props",
">"
],
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerSpec.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerSpec.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "dataVisualizer",
"id": "def-public.DataVisualizerPluginStart",
"type": "Type",
"tags": [],
"label": "DataVisualizerPluginStart",
"description": [],
"signature": [
"{ getFileDataVisualizerComponent: () => Promise<() => ",
"SpecWithLinks",
"<React.FC<",
"Props",
">>>; getIndexDataVisualizerComponent: () => Promise<() => React.FC<",
"Props",
">>; getDataDriftComponent: () => Promise<() => React.FC<",
"DataDriftDetectionAppStateProps",
">>; getMaxBytesFormatted: () => string; FieldStatsUnavailableMessage: React.ForwardRefExoticComponent<{ id?: string | undefined; title?: string | undefined; } & React.RefAttributes<{}>>; FieldStatisticsTable: React.ForwardRefExoticComponent<",
"FieldStatisticTableEmbeddableProps",
" & React.RefAttributes<{}>>; }"
],
"path": "x-pack/plugins/data_visualizer/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}