maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/discover.json
Stacey Gammon 87a5b22626
API DOCS Step 3/3 (#92929) 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-02 22:02:17 -05:00

1153 lines
39 KiB
JSON
Raw Blame History

{
"id": "discover",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.createSavedSearchesLoader",
"type": "Function",
"label": "createSavedSearchesLoader",
"signature": [
"({ savedObjectsClient, savedObjects }: Services) => ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectLoader",
"text": "SavedObjectLoader"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "{ savedObjectsClient, savedObjects }",
"isRequired": true,
"signature": [
"Services"
],
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/saved_searches.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/saved_searches.ts#L18"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/saved_searches.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/saved_searches.ts#L18"
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.SavedSearch",
"type": "Interface",
"label": "SavedSearch",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedSearch.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L15"
}
},
{
"tags": [],
"id": "def-public.SavedSearch.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L16"
}
},
{
"tags": [],
"id": "def-public.SavedSearch.searchSource",
"type": "Object",
"label": "searchSource",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L17"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
}
]
},
{
"tags": [],
"id": "def-public.SavedSearch.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L18"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedSearch.columns",
"type": "Array",
"label": "columns",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L19"
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.SavedSearch.sort",
"type": "Array",
"label": "sort",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L20"
},
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SortOrder",
"text": "SortOrder"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.SavedSearch.grid",
"type": "Object",
"label": "grid",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L21"
},
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverGridSettings",
"text": "DiscoverGridSettings"
}
]
},
{
"tags": [],
"id": "def-public.SavedSearch.destroy",
"type": "Function",
"label": "destroy",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L22"
},
"signature": [
"() => void"
]
},
{
"tags": [],
"id": "def-public.SavedSearch.save",
"type": "Function",
"label": "save",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L23"
},
"signature": [
"(saveOptions: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectSaveOpts",
"text": "SavedObjectSaveOpts"
},
") => Promise<string>"
]
},
{
"tags": [],
"id": "def-public.SavedSearch.lastSavedTitle",
"type": "string",
"label": "lastSavedTitle",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L24"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedSearch.copyOnSave",
"type": "CompoundType",
"label": "copyOnSave",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L25"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedSearch.hideChart",
"type": "CompoundType",
"label": "hideChart",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L26"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L14"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedSearchLoader",
"type": "Interface",
"label": "SavedSearchLoader",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedSearchLoader.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L29"
},
"signature": [
"(id: string) => Promise<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
},
">"
]
},
{
"tags": [],
"id": "def-public.SavedSearchLoader.urlFor",
"type": "Function",
"label": "urlFor",
"description": [],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L30"
},
"signature": [
"(id: string) => string"
]
}
],
"source": {
"path": "src/plugins/discover/public/saved_searches/types.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L28"
},
"initialIsOpen": false
},
{
"id": "def-public.ISearchEmbeddable",
"type": "Interface",
"label": "ISearchEmbeddable",
"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",
">"
],
"description": [],
"tags": [],
"children": [
{
"id": "def-public.ISearchEmbeddable.getSavedSearch",
"type": "Function",
"label": "getSavedSearch",
"signature": [
"() => ",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L35"
}
}
],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L34"
},
"initialIsOpen": false
},
{
"id": "def-public.SearchInput",
"type": "Interface",
"label": "SearchInput",
"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"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SearchInput.timeRange",
"type": "Object",
"label": "timeRange",
"description": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L20"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
]
},
{
"tags": [],
"id": "def-public.SearchInput.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L21"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchInput.filters",
"type": "Array",
"label": "filters",
"description": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L22"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchInput.hidePanelTitles",
"type": "CompoundType",
"label": "hidePanelTitles",
"description": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L23"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchInput.columns",
"type": "Array",
"label": "columns",
"description": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L24"
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchInput.sort",
"type": "Array",
"label": "sort",
"description": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L25"
},
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SortOrder",
"text": "SortOrder"
},
"[] | undefined"
]
}
],
"source": {
"path": "src/plugins/discover/public/application/embeddable/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L19"
},
"initialIsOpen": false
},
{
"id": "def-public.DiscoverUrlGeneratorState",
"type": "Interface",
"label": "DiscoverUrlGeneratorState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.savedSearchId",
"type": "string",
"label": "savedSearchId",
"description": [
"\nOptionally set saved search ID."
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L26"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.indexPatternId",
"type": "string",
"label": "indexPatternId",
"description": [
"\nOptionally set index pattern ID."
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L31"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.timeRange",
"type": "Object",
"label": "timeRange",
"description": [
"\nOptionally set the time range in the time picker."
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L36"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.refreshInterval",
"type": "Object",
"label": "refreshInterval",
"description": [
"\nOptionally set the refresh interval."
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L41"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.filters",
"type": "Array",
"label": "filters",
"description": [
"\nOptionally apply filters."
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L46"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.query",
"type": "Object",
"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."
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L52"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.useHash",
"type": "CompoundType",
"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."
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L58"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.searchSessionId",
"type": "string",
"label": "searchSessionId",
"description": [
"\nBackground search session id"
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L63"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.columns",
"type": "Array",
"label": "columns",
"description": [
"\nColumns displayed in the table"
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 68,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L68"
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.interval",
"type": "string",
"label": "interval",
"description": [
"\nUsed interval of the histogram"
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L73"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.sort",
"type": "Array",
"label": "sort",
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L77"
},
"signature": [
"string[][] | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverUrlGeneratorState.savedQuery",
"type": "string",
"label": "savedQuery",
"description": [
"\nid of the used saved query"
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L81"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L22"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.SEARCH_EMBEDDABLE_TYPE",
"type": "string",
"label": "SEARCH_EMBEDDABLE_TYPE",
"description": [],
"source": {
"path": "src/plugins/discover/public/application/embeddable/constants.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/constants.ts#L9"
},
"signature": [
"\"search\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.DISCOVER_APP_URL_GENERATOR",
"type": "string",
"label": "DISCOVER_APP_URL_GENERATOR",
"description": [],
"source": {
"path": "src/plugins/discover/public/url_generator.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L20"
},
"signature": [
"\"DISCOVER_APP_URL_GENERATOR\""
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-public.DiscoverSetup",
"type": "Interface",
"label": "DiscoverSetup",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.DiscoverSetup.docViews",
"type": "Object",
"label": "docViews",
"description": [],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L75"
},
"signature": [
"{ addDocView(docViewRaw: ",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DocViewInput",
"text": "DocViewInput"
},
" | ",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DocViewInputFn",
"text": "DocViewInputFn"
},
"): void; }"
]
}
],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 74,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L74"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.DiscoverStart",
"type": "Interface",
"label": "DiscoverStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DiscoverStart.savedSearchLoader",
"type": "Object",
"label": "savedSearchLoader",
"description": [],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 86,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L86"
},
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectLoader",
"text": "SavedObjectLoader"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverStart.urlGenerator",
"type": "Object",
"label": "urlGenerator",
"description": [
"\n`share` plugin URL generator for Discover app. Use it to generate links into\nDiscover application, example:\n\n```ts\nconst url = await plugins.discover.urlGenerator.createUrl({\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```"
],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 104,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L104"
},
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.UrlGeneratorContract",
"text": "UrlGeneratorContract"
},
"<\"DISCOVER_APP_URL_GENERATOR\"> | undefined"
]
}
],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L85"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.DEFAULT_COLUMNS_SETTING",
"type": "string",
"label": "DEFAULT_COLUMNS_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L9"
},
"signature": [
"\"defaultColumns\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.SAMPLE_SIZE_SETTING",
"type": "string",
"label": "SAMPLE_SIZE_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L10"
},
"signature": [
"\"discover:sampleSize\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGGS_TERMS_SIZE_SETTING",
"type": "string",
"label": "AGGS_TERMS_SIZE_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L11"
},
"signature": [
"\"discover:aggs:terms:size\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.SORT_DEFAULT_ORDER_SETTING",
"type": "string",
"label": "SORT_DEFAULT_ORDER_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L12"
},
"signature": [
"\"discover:sort:defaultOrder\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING",
"type": "string",
"label": "SEARCH_ON_PAGE_LOAD_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L13"
},
"signature": [
"\"discover:searchOnPageLoad\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DOC_HIDE_TIME_COLUMN_SETTING",
"type": "string",
"label": "DOC_HIDE_TIME_COLUMN_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L14"
},
"signature": [
"\"doc_table:hideTimeColumn\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FIELDS_LIMIT_SETTING",
"type": "string",
"label": "FIELDS_LIMIT_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L15"
},
"signature": [
"\"fields:popularLimit\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING",
"type": "string",
"label": "CONTEXT_DEFAULT_SIZE_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L16"
},
"signature": [
"\"context:defaultSize\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.CONTEXT_STEP_SETTING",
"type": "string",
"label": "CONTEXT_STEP_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L17"
},
"signature": [
"\"context:step\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"type": "string",
"label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L18"
},
"signature": [
"\"context:tieBreakerFields\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DOC_TABLE_LEGACY",
"type": "string",
"label": "DOC_TABLE_LEGACY",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L19"
},
"signature": [
"\"doc_table:legacy\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MODIFY_COLUMNS_ON_SWITCH",
"type": "string",
"label": "MODIFY_COLUMNS_ON_SWITCH",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L20"
},
"signature": [
"\"discover:modifyColumnsOnSwitch\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.SEARCH_FIELDS_FROM_SOURCE",
"type": "string",
"label": "SEARCH_FIELDS_FROM_SOURCE",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L21"
},
"signature": [
"\"discover:searchFieldsFromSource\""
],
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink