kibana/api_docs/discover.json
Stacey Gammon e92a945ab1
Add packages to our API documentation (#113564) (#114513)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
# Conflicts:
#	api_docs/alerting.mdx
#	api_docs/apm.json
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/custom_integrations.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_data_views.json
#	api_docs/data_data_views.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/discover_enhanced.json
#	api_docs/embeddable.json
#	api_docs/event_log.mdx
#	api_docs/fleet.mdx
#	api_docs/home.json
#	api_docs/index_management.json
#	api_docs/interactive_setup.mdx
#	api_docs/kibana_legacy.json
#	api_docs/kibana_legacy.mdx
#	api_docs/observability.mdx
#	api_docs/plugin_directory.mdx
#	api_docs/security_oss.mdx
2021-10-11 13:58:18 -04:00

1444 lines
46 KiB
JSON

{
"id": "discover",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "discover",
"id": "def-public.createSavedSearchesLoader",
"type": "Function",
"tags": [],
"label": "createSavedSearchesLoader",
"description": [],
"signature": [
"({ savedObjectsClient, savedObjects }: Services) => ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectLoader",
"text": "SavedObjectLoader"
}
],
"path": "src/plugins/discover/public/saved_searches/saved_searches.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.createSavedSearchesLoader.$1",
"type": "Object",
"tags": [],
"label": "{ savedObjectsClient, savedObjects }",
"description": [],
"signature": [
"Services"
],
"path": "src/plugins/discover/public/saved_searches/saved_searches.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.loadSharingDataHelpers",
"type": "Function",
"tags": [],
"label": "loadSharingDataHelpers",
"description": [],
"signature": [
"() => Promise<typeof ",
"src/plugins/discover/public/application/apps/main/utils/get_sharing_data",
">"
],
"path": "src/plugins/discover/public/shared/index.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams",
"type": "Interface",
"tags": [],
"label": "DiscoverAppLocatorParams",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.savedSearchId",
"type": "string",
"tags": [],
"label": "savedSearchId",
"description": [
"\nOptionally set saved search ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.indexPatternId",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [
"\nOptionally set index pattern ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [
"\nOptionally set the time range in the time picker."
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.refreshInterval",
"type": "CompoundType",
"tags": [],
"label": "refreshInterval",
"description": [
"\nOptionally set the refresh interval."
],
"signature": [
"(",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" & ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"\nOptionally apply filters."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"\nOptionally set a query."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.useHash",
"type": "CompoundType",
"tags": [],
"label": "useHash",
"description": [
"\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.searchSessionId",
"type": "string",
"tags": [],
"label": "searchSessionId",
"description": [
"\nBackground search session id"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [
"\nColumns displayed in the table"
],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [
"\nUsed interval of the histogram"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.sort",
"type": "CompoundType",
"tags": [],
"label": "sort",
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"(string[][] & ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocatorParams.savedQuery",
"type": "string",
"tags": [],
"label": "savedQuery",
"description": [
"\nid of the used saved query"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState",
"type": "Interface",
"tags": [],
"label": "DiscoverUrlGeneratorState",
"description": [],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.savedSearchId",
"type": "string",
"tags": [],
"label": "savedSearchId",
"description": [
"\nOptionally set saved search ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.indexPatternId",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [
"\nOptionally set index pattern ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [
"\nOptionally set the time range in the time picker."
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.refreshInterval",
"type": "Object",
"tags": [],
"label": "refreshInterval",
"description": [
"\nOptionally set the refresh interval."
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"\nOptionally apply filters."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.useHash",
"type": "CompoundType",
"tags": [],
"label": "useHash",
"description": [
"\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.searchSessionId",
"type": "string",
"tags": [],
"label": "searchSessionId",
"description": [
"\nBackground search session id"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [
"\nColumns displayed in the table"
],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [
"\nUsed interval of the histogram"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"string[][] | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverUrlGeneratorState.savedQuery",
"type": "string",
"tags": [],
"label": "savedQuery",
"description": [
"\nid of the used saved query"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.ISearchEmbeddable",
"type": "Interface",
"tags": [],
"label": "ISearchEmbeddable",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.ISearchEmbeddable",
"text": "ISearchEmbeddable"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SearchInput",
"text": "SearchInput"
},
", ",
"SearchOutput",
">"
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.ISearchEmbeddable.getSavedSearch",
"type": "Function",
"tags": [],
"label": "getSavedSearch",
"description": [],
"signature": [
"() => ",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch",
"type": "Interface",
"tags": [],
"label": "SavedSearch",
"description": [],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.searchSource",
"type": "Object",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
}
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"SortOrder",
"[]"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.grid",
"type": "Object",
"tags": [],
"label": "grid",
"description": [],
"signature": [
"DiscoverGridSettings"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.destroy",
"type": "Function",
"tags": [],
"label": "destroy",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.save",
"type": "Function",
"tags": [],
"label": "save",
"description": [],
"signature": [
"(saveOptions: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectSaveOpts",
"text": "SavedObjectSaveOpts"
},
") => Promise<string>"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.save.$1",
"type": "Object",
"tags": [],
"label": "saveOptions",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectSaveOpts",
"text": "SavedObjectSaveOpts"
}
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.lastSavedTitle",
"type": "string",
"tags": [],
"label": "lastSavedTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.copyOnSave",
"type": "CompoundType",
"tags": [],
"label": "copyOnSave",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearch.hideChart",
"type": "CompoundType",
"tags": [],
"label": "hideChart",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader",
"type": "Interface",
"tags": [],
"label": "SavedSearchLoader",
"description": [],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
},
">"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.get.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.urlFor",
"type": "Function",
"tags": [],
"label": "urlFor",
"description": [],
"signature": [
"(id: string) => string"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SavedSearchLoader.urlFor.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/discover/public/saved_searches/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput",
"type": "Interface",
"tags": [],
"label": "SearchInput",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SearchInput",
"text": "SearchInput"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
}
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.hidePanelTitles",
"type": "CompoundType",
"tags": [],
"label": "hidePanelTitles",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"SortOrder",
"[] | undefined"
],
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "discover",
"id": "def-public.DISCOVER_APP_URL_GENERATOR",
"type": "string",
"tags": [],
"label": "DISCOVER_APP_URL_GENERATOR",
"description": [],
"signature": [
"\"DISCOVER_APP_URL_GENERATOR\""
],
"path": "src/plugins/discover/public/url_generator.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppLocator",
"type": "Type",
"tags": [],
"label": "DiscoverAppLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
">"
],
"path": "src/plugins/discover/public/locator.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.SEARCH_EMBEDDABLE_TYPE",
"type": "string",
"tags": [],
"label": "SEARCH_EMBEDDABLE_TYPE",
"description": [],
"signature": [
"\"search\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup",
"type": "Interface",
"tags": [],
"label": "DiscoverSetup",
"description": [],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.docViews",
"type": "Object",
"tags": [],
"label": "docViews",
"description": [],
"signature": [
"{ addDocView(docViewRaw: ComponentDocViewInput | ",
"RenderDocViewInput",
" | ",
"DocViewInputFn",
"): void; }"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [
"\n`share` plugin URL locator for Discover app. Use it to generate links into\nDiscover application, for example, navigate:\n\n```ts\nawait plugins.discover.locator.navigate({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```\n\nGenerate a location:\n\n```ts\nconst location = await plugins.discover.locator.getLocation({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```"
],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverAppLocator",
"text": "DiscoverAppLocator"
},
" | undefined"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "discover",
"id": "def-public.DiscoverStart",
"type": "Interface",
"tags": [],
"label": "DiscoverStart",
"description": [],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.savedSearchLoader",
"type": "Object",
"tags": [],
"label": "savedSearchLoader",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectLoader",
"text": "SavedObjectLoader"
}
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.urlGenerator",
"type": "Object",
"tags": [
"deprecated"
],
"label": "urlGenerator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.UrlGeneratorContract",
"text": "UrlGeneratorContract"
},
"<\"DISCOVER_APP_URL_GENERATOR\"> | undefined"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": true,
"references": [
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_discover_link.tsx"
},
{
"plugin": "osquery",
"path": "x-pack/plugins/osquery/public/scheduled_query_groups/scheduled_query_group_queries_status_table.tsx"
},
{
"plugin": "osquery",
"path": "x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx"
}
]
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [
"\n`share` plugin URL locator for Discover app. Use it to generate links into\nDiscover application, for example, navigate:\n\n```ts\nawait plugins.discover.locator.navigate({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```\n\nGenerate a location:\n\n```ts\nconst location = await plugins.discover.locator.getLocation({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```"
],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverAppLocator",
"text": "DiscoverAppLocator"
},
" | undefined"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "discover",
"id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_DEFAULT_SIZE_SETTING",
"description": [],
"signature": [
"\"context:defaultSize\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.CONTEXT_STEP_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_STEP_SETTING",
"description": [],
"signature": [
"\"context:step\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"description": [],
"signature": [
"\"context:tieBreakerFields\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DEFAULT_COLUMNS_SETTING",
"type": "string",
"tags": [],
"label": "DEFAULT_COLUMNS_SETTING",
"description": [],
"signature": [
"\"defaultColumns\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DOC_HIDE_TIME_COLUMN_SETTING",
"type": "string",
"tags": [],
"label": "DOC_HIDE_TIME_COLUMN_SETTING",
"description": [],
"signature": [
"\"doc_table:hideTimeColumn\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DOC_TABLE_LEGACY",
"type": "string",
"tags": [],
"label": "DOC_TABLE_LEGACY",
"description": [],
"signature": [
"\"doc_table:legacy\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.FIELDS_LIMIT_SETTING",
"type": "string",
"tags": [],
"label": "FIELDS_LIMIT_SETTING",
"description": [],
"signature": [
"\"fields:popularLimit\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.MAX_DOC_FIELDS_DISPLAYED",
"type": "string",
"tags": [],
"label": "MAX_DOC_FIELDS_DISPLAYED",
"description": [],
"signature": [
"\"discover:maxDocFieldsDisplayed\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.MODIFY_COLUMNS_ON_SWITCH",
"type": "string",
"tags": [],
"label": "MODIFY_COLUMNS_ON_SWITCH",
"description": [],
"signature": [
"\"discover:modifyColumnsOnSwitch\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SAMPLE_SIZE_SETTING",
"type": "string",
"tags": [],
"label": "SAMPLE_SIZE_SETTING",
"description": [],
"signature": [
"\"discover:sampleSize\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SEARCH_EMBEDDABLE_TYPE",
"type": "string",
"tags": [],
"label": "SEARCH_EMBEDDABLE_TYPE",
"description": [],
"signature": [
"\"search\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SEARCH_FIELDS_FROM_SOURCE",
"type": "string",
"tags": [],
"label": "SEARCH_FIELDS_FROM_SOURCE",
"description": [],
"signature": [
"\"discover:searchFieldsFromSource\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING",
"type": "string",
"tags": [],
"label": "SEARCH_ON_PAGE_LOAD_SETTING",
"description": [],
"signature": [
"\"discover:searchOnPageLoad\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SHOW_MULTIFIELDS",
"type": "string",
"tags": [],
"label": "SHOW_MULTIFIELDS",
"description": [],
"signature": [
"\"discover:showMultiFields\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SORT_DEFAULT_ORDER_SETTING",
"type": "string",
"tags": [],
"label": "SORT_DEFAULT_ORDER_SETTING",
"description": [],
"signature": [
"\"discover:sort:defaultOrder\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}