maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/data_query.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

2618 lines
92 KiB
JSON
Raw Blame History

{
"id": "data.query",
"client": {
"classes": [
{
"id": "def-public.FilterManager",
"type": "Class",
"tags": [],
"label": "FilterManager",
"description": [],
"children": [
{
"id": "def-public.FilterManager.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "uiSettings",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L35"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L35"
}
},
{
"id": "def-public.FilterManager.getFilters",
"type": "Function",
"label": "getFilters",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L92"
}
},
{
"id": "def-public.FilterManager.getAppFilters",
"type": "Function",
"label": "getAppFilters",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 96,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L96"
}
},
{
"id": "def-public.FilterManager.getGlobalFilters",
"type": "Function",
"label": "getGlobalFilters",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L101"
}
},
{
"id": "def-public.FilterManager.getPartitionedFilters",
"type": "Function",
"label": "getPartitionedFilters",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.PartitionedFilters",
"text": "PartitionedFilters"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 106,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L106"
}
},
{
"id": "def-public.FilterManager.getUpdates$",
"type": "Function",
"label": "getUpdates$",
"signature": [
"() => ",
"Observable",
"<void>"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 110,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L110"
}
},
{
"id": "def-public.FilterManager.getFetches$",
"type": "Function",
"label": "getFetches$",
"signature": [
"() => ",
"Observable",
"<void>"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 114,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L114"
}
},
{
"id": "def-public.FilterManager.addFilters",
"type": "Function",
"label": "addFilters",
"signature": [
"(filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], pinFilterStatus?: boolean) => void"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "filters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 121,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L121"
}
},
{
"type": "boolean",
"label": "pinFilterStatus",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 122,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L122"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 120,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L120"
}
},
{
"id": "def-public.FilterManager.setFilters",
"type": "Function",
"label": "setFilters",
"signature": [
"(newFilters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], pinFilterStatus?: boolean) => void"
],
"description": [],
"children": [
{
"type": "Array",
"label": "newFilters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 149,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L149"
}
},
{
"type": "boolean",
"label": "pinFilterStatus",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 150,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L150"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 148,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L148"
}
},
{
"id": "def-public.FilterManager.setGlobalFilters",
"type": "Function",
"label": "setGlobalFilters",
"signature": [
"(newGlobalFilters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void"
],
"description": [
"\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"
],
"children": [
{
"type": "Array",
"label": "newGlobalFilters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 167,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L167"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 167,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L167"
}
},
{
"id": "def-public.FilterManager.setAppFilters",
"type": "Function",
"label": "setAppFilters",
"signature": [
"(newAppFilters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void"
],
"description": [
"\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"
],
"children": [
{
"type": "Array",
"label": "newAppFilters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 184,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L184"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 184,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L184"
}
},
{
"id": "def-public.FilterManager.removeFilter",
"type": "Function",
"label": "removeFilter",
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 195,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L195"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 195,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L195"
}
},
{
"id": "def-public.FilterManager.removeAll",
"type": "Function",
"label": "removeAll",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 207,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L207"
}
},
{
"id": "def-public.FilterManager.setFiltersStore",
"type": "Function",
"label": "setFiltersStore",
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
".setFiltersStore"
],
"description": [],
"children": [
{
"type": "Array",
"label": "filters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 212,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L212"
}
},
{
"type": "Enum",
"label": "store",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 213,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L213"
}
},
{
"type": "boolean",
"label": "shouldOverrideStore",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 214,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L214"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 211,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L211"
}
}
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L29"
},
"initialIsOpen": false
},
{
"id": "def-public.TimeHistory",
"type": "Class",
"tags": [],
"label": "TimeHistory",
"description": [],
"children": [
{
"id": "def-public.TimeHistory.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "storage",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorageWrapper",
"text": "IStorageWrapper"
},
"<any, void>"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L18"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L18"
}
},
{
"id": "def-public.TimeHistory.add",
"type": "Function",
"label": "add",
"signature": [
"(time: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "time",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L29"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L29"
}
},
{
"id": "def-public.TimeHistory.get",
"type": "Function",
"label": "get",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L42"
}
}
],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L15"
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-public.createSavedQueryService",
"type": "Function",
"children": [
{
"type": "Object",
"label": "savedObjectsClient",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/saved_query_service.ts#L21"
}
}
],
"signature": [
"(savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">) => ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
}
],
"description": [],
"label": "createSavedQueryService",
"source": {
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/saved_query_service.ts#L20"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.connectToQueryState",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }",
"isRequired": true,
"signature": [
"Pick<{ addToQueryLog: (appName: string, { language, query }: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void; filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; queryString: Pick<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStringManager",
"text": "QueryStringManager"
},
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
},
"; state$: ",
"Observable"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L24"
}
},
{
"type": "Object",
"label": "stateContainer",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<S>"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L30"
}
},
{
"id": "def-public.connectToQueryState.syncConfig",
"type": "Object",
"label": "syncConfig",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.connectToQueryState.syncConfig.time",
"type": "CompoundType",
"label": "time",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L32"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.connectToQueryState.syncConfig.refreshInterval",
"type": "CompoundType",
"label": "refreshInterval",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L33"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.connectToQueryState.syncConfig.filters",
"type": "CompoundType",
"label": "filters",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L34"
},
"signature": [
"boolean | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.connectToQueryState.syncConfig.query",
"type": "CompoundType",
"label": "query",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L35"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L31"
}
}
],
"signature": [
"<S extends ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
">({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void; filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
}
],
"description": [
"\nHelper to setup two-way syncing of global data and a state container"
],
"label": "connectToQueryState",
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L23"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.syncQueryStateWithUrl",
"type": "Function",
"children": [
{
"type": "Object",
"label": "query",
"isRequired": true,
"signature": [
"Pick<{ addToQueryLog: (appName: string, { language, query }: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void; filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; queryString: Pick<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStringManager",
"text": "QueryStringManager"
},
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
},
"; state$: ",
"Observable"
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L27"
}
},
{
"type": "Object",
"label": "kbnUrlStateStorage",
"isRequired": true,
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IKbnUrlStateStorage",
"text": "IKbnUrlStateStorage"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L28"
}
}
],
"signature": [
"(query: Pick<{ addToQueryLog: (appName: string, { language, query }: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void; filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
},
"; state$: ",
"Observable"
],
"description": [
"\nHelper to setup syncing of global data with the URL"
],
"label": "syncQueryStateWithUrl",
"source": {
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L26"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getDefaultQuery",
"type": "Function",
"label": "getDefaultQuery",
"signature": [
"(language: ",
"QueryLanguage",
") => { query: string; language: ",
"QueryLanguage",
"; }"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "language",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryLanguage",
"text": "QueryLanguage"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/query/lib/get_default_query.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/lib/get_default_query.ts#L11"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/query/lib/get_default_query.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/lib/get_default_query.ts#L11"
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.QueryState",
"type": "Interface",
"label": "QueryState",
"description": [
"\nAll query state service state"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.QueryState.time",
"type": "Object",
"label": "time",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L15"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryState.refreshInterval",
"type": "Object",
"label": "refreshInterval",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L16"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryState.filters",
"type": "Array",
"label": "filters",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L17"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryState.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L18"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
]
}
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L14"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedQuery",
"type": "Interface",
"label": "SavedQuery",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedQuery.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L16"
}
},
{
"tags": [],
"id": "def-public.SavedQuery.attributes",
"type": "Object",
"label": "attributes",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L17"
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryAttributes",
"text": "SavedQueryAttributes"
}
]
}
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L15"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedQueryService",
"type": "Interface",
"label": "SavedQueryService",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedQueryService.saveQuery",
"type": "Function",
"label": "saveQuery",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L29"
},
"signature": [
"(attributes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryAttributes",
"text": "SavedQueryAttributes"
},
", config?: { overwrite: boolean; } | undefined) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">"
]
},
{
"tags": [],
"id": "def-public.SavedQueryService.getAllSavedQueries",
"type": "Function",
"label": "getAllSavedQueries",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L33"
},
"signature": [
"() => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]>"
]
},
{
"tags": [],
"id": "def-public.SavedQueryService.findSavedQueries",
"type": "Function",
"label": "findSavedQueries",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L34"
},
"signature": [
"(searchText?: string | undefined, perPage?: number | undefined, activePage?: number | undefined) => Promise<{ total: number; queries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]; }>"
]
},
{
"tags": [],
"id": "def-public.SavedQueryService.getSavedQuery",
"type": "Function",
"label": "getSavedQuery",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L39"
},
"signature": [
"(id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">"
]
},
{
"tags": [],
"id": "def-public.SavedQueryService.deleteSavedQuery",
"type": "Function",
"label": "deleteSavedQuery",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L40"
},
"signature": [
"(id: string) => Promise<{}>"
]
},
{
"tags": [],
"id": "def-public.SavedQueryService.getSavedQueryCount",
"type": "Function",
"label": "getSavedQueryCount",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L41"
},
"signature": [
"() => Promise<number>"
]
}
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L28"
},
"initialIsOpen": false
},
{
"id": "def-public.QueryStateChange",
"type": "Interface",
"label": "QueryStateChange",
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
" extends QueryStateChangePartial"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.QueryStateChange.appFilters",
"type": "CompoundType",
"label": "appFilters",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L26"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStateChange.globalFilters",
"type": "CompoundType",
"label": "globalFilters",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L27"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L25"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.SavedQueryTimeFilter",
"type": "Type",
"label": "SavedQueryTimeFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L11"
},
"signature": [
"TimeRange & { refreshInterval: RefreshInterval; }"
],
"initialIsOpen": false
},
{
"id": "def-public.InputTimeRange",
"type": "Type",
"label": "InputTimeRange",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/types.ts#L19"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | { from: moment.Moment; to: moment.Moment; }"
],
"initialIsOpen": false
},
{
"id": "def-public.TimefilterContract",
"type": "Type",
"label": "TimefilterContract",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/timefilter.ts",
"lineNumber": 240,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/timefilter.ts#L240"
},
"signature": [
"{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ",
"Observable",
"<boolean>; getTimeUpdate$: () => ",
"Observable",
"<unknown>; getRefreshIntervalUpdate$: () => ",
"Observable",
"<unknown>; getAutoRefreshFetch$: () => ",
"Observable",
"<unknown>; getFetch$: () => ",
"Observable"
],
"initialIsOpen": false
},
{
"id": "def-public.TimeHistoryContract",
"type": "Type",
"label": "TimeHistoryContract",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L47"
},
"signature": [
"{ add: (time: TimeRange) => void; get: () => TimeRange[]; }"
],
"initialIsOpen": false
},
{
"id": "def-public.QueryStart",
"type": "Type",
"label": "QueryStart",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/query/query_service.ts",
"lineNumber": 103,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/query_service.ts#L103"
},
"signature": [
"{ addToQueryLog: (appName: string, { language, query }: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void; filterManager: FilterManager; queryString: Pick<QueryStringManager, \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
},
"; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
}
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"id": "def-common.dedupFilters",
"type": "Function",
"children": [
{
"type": "Array",
"label": "existingFilters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L23"
}
},
{
"type": "Array",
"label": "filters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L24"
}
},
{
"type": "Object",
"label": "comparatorOptions",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L25"
}
}
],
"signature": [
"(existingFilters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], comparatorOptions?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [
"\nCombine 2 filter collections, removing duplicates\n"
],
"label": "dedupFilters",
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L22"
},
"tags": [],
"returnComment": [
"An array of filters that were not in existing"
],
"initialIsOpen": false
},
{
"id": "def-common.uniqFilters",
"type": "Function",
"children": [
{
"type": "Array",
"label": "filters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21"
}
},
{
"type": "Any",
"label": "comparatorOptions",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21"
}
}
],
"signature": [
"(filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], comparatorOptions?: any) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [
"\nRemove duplicate filters from an array of filters\n"
],
"label": "uniqFilters",
"source": {
"path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21"
},
"tags": [],
"returnComment": [
"The original filters array with duplicates removed"
],
"initialIsOpen": false
},
{
"id": "def-common.compareFilters",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "first",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L65"
}
},
{
"type": "CompoundType",
"label": "second",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L66"
}
},
{
"type": "Object",
"label": "comparatorOptions",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L67"
}
}
],
"signature": [
"(first: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], second: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], comparatorOptions?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
}
],
"description": [
"\nCompare two filters or filter arrays to see if they match.\nFor filter arrays, the assumption is they are sorted.\n"
],
"label": "compareFilters",
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L64"
},
"tags": [],
"returnComment": [
"Filters are the same"
],
"initialIsOpen": false
},
{
"id": "def-common.calculateBounds",
"type": "Function",
"label": "calculateBounds",
"signature": [
"(timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
", options: CalculateBoundsOptions) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRangeBounds",
"text": "TimeRangeBounds"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "timeRange",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L17"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
"CalculateBoundsOptions"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L18"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L16"
},
"initialIsOpen": false
},
{
"id": "def-common.getAbsoluteTimeRange",
"type": "Function",
"label": "getAbsoluteTimeRange",
"signature": [
"(timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
", { forceNow }: { forceNow?: Date | undefined; }) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "timeRange",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L27"
}
},
{
"id": "def-common.getAbsoluteTimeRange.{-forceNow }",
"type": "Object",
"label": "{ forceNow }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-common.getAbsoluteTimeRange.{-forceNow }.forceNow",
"type": "Object",
"label": "forceNow",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L28"
},
"signature": [
"Date | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L28"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L26"
},
"initialIsOpen": false
},
{
"id": "def-common.getTime",
"type": "Function",
"label": "getTime",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
},
" | undefined"
],
"description": [],
"children": [
{
"type": "Object",
"label": "indexPattern",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L38"
}
},
{
"type": "Object",
"label": "timeRange",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L39"
}
},
{
"id": "def-common.getTime.options",
"type": "Object",
"label": "options",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-common.getTime.options.forceNow",
"type": "Object",
"label": "forceNow",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"
},
"signature": [
"Date | undefined"
]
},
{
"tags": [],
"id": "def-common.getTime.options.fieldName",
"type": "string",
"label": "fieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L37"
},
"initialIsOpen": false
},
{
"id": "def-common.isTimeRange",
"type": "Function",
"children": [
{
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/is_time_range.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11"
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"label": "isTimeRange",
"source": {
"path": "src/plugins/data/common/query/timefilter/is_time_range.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isQuery",
"type": "Function",
"children": [
{
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/is_query.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11"
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
}
],
"description": [],
"label": "isQuery",
"source": {
"path": "src/plugins/data/common/query/is_query.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.FilterCompareOptions",
"type": "Interface",
"label": "FilterCompareOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FilterCompareOptions.index",
"type": "CompoundType",
"label": "index",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L13"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.FilterCompareOptions.disabled",
"type": "CompoundType",
"label": "disabled",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L14"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.FilterCompareOptions.negate",
"type": "CompoundType",
"label": "negate",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L15"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.FilterCompareOptions.state",
"type": "CompoundType",
"label": "state",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L16"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.FilterCompareOptions.alias",
"type": "CompoundType",
"label": "alias",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L17"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L12"
},
"initialIsOpen": false
},
{
"id": "def-common.RefreshInterval",
"type": "Interface",
"label": "RefreshInterval",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RefreshInterval.pause",
"type": "boolean",
"label": "pause",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L12"
}
},
{
"tags": [],
"id": "def-common.RefreshInterval.value",
"type": "number",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L13"
}
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L11"
},
"initialIsOpen": false
},
{
"id": "def-common.TimeRangeBounds",
"type": "Interface",
"label": "TimeRangeBounds",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.TimeRangeBounds.min",
"type": "Object",
"label": "min",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L24"
},
"signature": [
"moment.Moment | undefined"
]
},
{
"tags": [],
"id": "def-common.TimeRangeBounds.max",
"type": "Object",
"label": "max",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L25"
},
"signature": [
"moment.Moment | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L23"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-common.Query",
"type": "Type",
"label": "Query",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/query/types.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/types.ts#L12"
},
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"initialIsOpen": false
},
{
"id": "def-common.TimeRange",
"type": "Type",
"label": "TimeRange",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L17"
},
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-common.COMPARE_ALL_OPTIONS",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.COMPARE_ALL_OPTIONS.index",
"type": "boolean",
"label": "index",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L24"
},
"signature": [
"true"
]
},
{
"tags": [],
"id": "def-common.COMPARE_ALL_OPTIONS.disabled",
"type": "boolean",
"label": "disabled",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L25"
},
"signature": [
"true"
]
},
{
"tags": [],
"id": "def-common.COMPARE_ALL_OPTIONS.negate",
"type": "boolean",
"label": "negate",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L26"
},
"signature": [
"true"
]
},
{
"tags": [],
"id": "def-common.COMPARE_ALL_OPTIONS.state",
"type": "boolean",
"label": "state",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L27"
},
"signature": [
"true"
]
},
{
"tags": [],
"id": "def-common.COMPARE_ALL_OPTIONS.alias",
"type": "boolean",
"label": "alias",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L28"
},
"signature": [
"true"
]
}
],
"description": [
"\nInclude disabled, negate and store when comparing filters"
],
"label": "COMPARE_ALL_OPTIONS",
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L23"
},
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink