kibana/api_docs/data_query.json

3523 lines
111 KiB
JSON
Raw Normal View History

{
"id": "data.query",
"client": {
"classes": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager",
"type": "Class",
"tags": [],
"label": "FilterManager",
"description": [],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 35
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 35
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.getFilters",
"type": "Function",
"tags": [],
"label": "getFilters",
"description": [],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 92
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.getAppFilters",
"type": "Function",
"tags": [],
"label": "getAppFilters",
"description": [],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 96
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.getGlobalFilters",
"type": "Function",
"tags": [],
"label": "getGlobalFilters",
"description": [],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 101
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.getPartitionedFilters",
"type": "Function",
"tags": [],
"label": "getPartitionedFilters",
"description": [],
"signature": [
"() => ",
"PartitionedFilters"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 106
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.getUpdates$",
"type": "Function",
"tags": [],
"label": "getUpdates$",
"description": [],
"signature": [
"() => ",
"Observable",
"<void>"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 110
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.getFetches$",
"type": "Function",
"tags": [],
"label": "getFetches$",
"description": [],
"signature": [
"() => ",
"Observable",
"<void>"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 114
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.addFilters",
"type": "Function",
"tags": [],
"label": "addFilters",
"description": [],
"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"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 120
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.addFilters.$1",
"type": "CompoundType",
"tags": [],
"label": "filters",
"description": [],
"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"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 121
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.addFilters.$2",
"type": "boolean",
"tags": [],
"label": "pinFilterStatus",
"description": [],
"signature": [
"boolean"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 122
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setFilters",
"type": "Function",
"tags": [],
"label": "setFilters",
"description": [],
"signature": [
"(newFilters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], pinFilterStatus?: boolean) => void"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 148
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setFilters.$1",
"type": "Array",
"tags": [],
"label": "newFilters",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 149
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setFilters.$2",
"type": "boolean",
"tags": [],
"label": "pinFilterStatus",
"description": [],
"signature": [
"boolean"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 150
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setGlobalFilters",
"type": "Function",
"tags": [],
"label": "setGlobalFilters",
"description": [
"\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"
],
"signature": [
"(newGlobalFilters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 167
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setGlobalFilters.$1",
"type": "Array",
"tags": [],
"label": "newGlobalFilters",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 167
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setAppFilters",
"type": "Function",
"tags": [],
"label": "setAppFilters",
"description": [
"\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"
],
"signature": [
"(newAppFilters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 184
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setAppFilters.$1",
"type": "Array",
"tags": [],
"label": "newAppFilters",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 184
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.removeFilter",
"type": "Function",
"tags": [],
"label": "removeFilter",
"description": [],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => void"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 195
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.removeFilter.$1",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 195
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.removeAll",
"type": "Function",
"tags": [],
"label": "removeAll",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 207
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setFiltersStore",
"type": "Function",
"tags": [],
"label": "setFiltersStore",
"description": [],
"signature": [
"(filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], store: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
", shouldOverrideStore?: boolean) => void"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 211
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setFiltersStore.$1",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 212
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setFiltersStore.$2",
"type": "Enum",
"tags": [],
"label": "store",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
}
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 213
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.FilterManager.setFiltersStore.$3",
"type": "boolean",
"tags": [],
"label": "shouldOverrideStore",
"description": [],
"signature": [
"boolean"
],
"source": {
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
"lineNumber": 214
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.TimeHistory",
"type": "Class",
"tags": [],
"label": "TimeHistory",
"description": [],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.TimeHistory.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 18
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.TimeHistory.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorageWrapper",
"text": "IStorageWrapper"
},
"<any, void>"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 18
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.TimeHistory.add",
"type": "Function",
"tags": [],
"label": "add",
"description": [],
"signature": [
"(time: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
") => void"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.TimeHistory.add.$1",
"type": "Object",
"tags": [],
"label": "time",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 29
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.TimeHistory.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"[]"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 42
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState",
"type": "Function",
"tags": [],
"label": "connectToQueryState",
"description": [
"\nHelper to setup two-way syncing of global data and a state container"
],
"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"
},
"; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; timefilter: ",
"TimefilterSetup",
"; getEsQuery: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
},
"[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; timefilter: ",
"TimefilterSetup",
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, stateContainer: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<S>, syncConfig: { time?: boolean | undefined; refreshInterval?: boolean | undefined; filters?: boolean | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
" | undefined; query?: boolean | undefined; }) => () => void"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 23
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState.$1",
"type": "Object",
"tags": [],
"label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }",
"description": [],
"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<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
},
"; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; timefilter: ",
"TimefilterSetup",
"; getEsQuery: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
},
"[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; timefilter: ",
"TimefilterSetup",
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 24
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState.$2",
"type": "Object",
"tags": [],
"label": "stateContainer",
"description": [
"to use for syncing"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.BaseStateContainer",
"text": "BaseStateContainer"
},
"<S>"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 30
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState.$3.syncConfig",
"type": "Object",
"tags": [],
"label": "syncConfig",
"description": [],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 31
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState.$3.syncConfig.time",
"type": "CompoundType",
"tags": [],
"label": "time",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState.$3.syncConfig.refreshInterval",
"type": "CompoundType",
"tags": [],
"label": "refreshInterval",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState.$3.syncConfig.filters",
"type": "CompoundType",
"tags": [],
"label": "filters",
"description": [],
"signature": [
"boolean | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
" | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.connectToQueryState.$3.syncConfig.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
"lineNumber": 35
},
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.createSavedQueryService",
"type": "Function",
"tags": [],
"label": "createSavedQueryService",
"description": [],
"signature": [
"(savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">) => ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
}
],
"source": {
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.createSavedQueryService.$1",
"type": "Object",
"tags": [],
"label": "savedObjectsClient",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"lineNumber": 22
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.getDefaultQuery",
"type": "Function",
"tags": [],
"label": "getDefaultQuery",
"description": [],
"signature": [
"(language: ",
"QueryLanguage",
") => { query: string; language: ",
"QueryLanguage",
"; }"
],
"source": {
"path": "src/plugins/data/public/query/lib/get_default_query.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.getDefaultQuery.$1",
"type": "CompoundType",
"tags": [],
"label": "language",
"description": [],
"signature": [
"QueryLanguage"
],
"source": {
"path": "src/plugins/data/public/query/lib/get_default_query.ts",
"lineNumber": 11
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.syncQueryStateWithUrl",
"type": "Function",
"tags": [],
"label": "syncQueryStateWithUrl",
"description": [
"\nHelper to setup syncing of global data with the URL"
],
"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",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; timefilter: ",
"TimefilterSetup",
"; getEsQuery: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
},
"[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; timefilter: ",
"TimefilterSetup",
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, kbnUrlStateStorage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IKbnUrlStateStorage",
"text": "IKbnUrlStateStorage"
},
") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.syncQueryStateWithUrl.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"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<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
},
"; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; timefilter: ",
"TimefilterSetup",
"; getEsQuery: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
},
"[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }; }; } | { filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; timefilter: ",
"TimefilterSetup",
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
"lineNumber": 27
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-public.syncQueryStateWithUrl.$2",
"type": "Object",
"tags": [],
"label": "kbnUrlStateStorage",
"description": [
"to use for syncing"
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IKbnUrlStateStorage",
"text": "IKbnUrlStateStorage"
}
],
"source": {
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
"lineNumber": 28
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "data",
"id": "def-public.QueryState",
"type": "Interface",
"tags": [],
"label": "QueryState",
"description": [
"\nAll query state service state"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 14
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.QueryState.time",
"type": "Object",
"tags": [],
"label": "time",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 15
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.QueryState.refreshInterval",
"type": "Object",
"tags": [],
"label": "refreshInterval",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.QueryState.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.QueryState.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"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": 18
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.QueryStateChange",
"type": "Interface",
"tags": [],
"label": "QueryStateChange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
" extends QueryStateChangePartial"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.QueryStateChange.appFilters",
"type": "CompoundType",
"tags": [],
"label": "appFilters",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.QueryStateChange.globalFilters",
"type": "CompoundType",
"tags": [],
"label": "globalFilters",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/public/query/state_sync/types.ts",
"lineNumber": 27
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.SavedQuery",
"type": "Interface",
"tags": [],
"label": "SavedQuery",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.SavedQuery.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.SavedQuery.attributes",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"SavedQueryAttributes"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 17
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService",
"type": "Interface",
"tags": [],
"label": "SavedQueryService",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 28
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.saveQuery",
"type": "Function",
"tags": [],
"label": "saveQuery",
"description": [],
"signature": [
"(attributes: ",
"SavedQueryAttributes",
", config?: { overwrite: boolean; } | undefined) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 29
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-public.attributes",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"SavedQueryAttributes"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
"{ overwrite: boolean; } | undefined"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 31
},
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.getAllSavedQueries",
"type": "Function",
"tags": [],
"label": "getAllSavedQueries",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
"[]>"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 33
},
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.findSavedQueries",
"type": "Function",
"tags": [],
"label": "findSavedQueries",
"description": [],
"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"
},
"[]; }>"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 34
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-public.searchText",
"type": "string",
"tags": [],
"label": "searchText",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.perPage",
"type": "number",
"tags": [],
"label": "perPage",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 36
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.activePage",
"type": "number",
"tags": [],
"label": "activePage",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 37
},
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.getSavedQuery",
"type": "Function",
"tags": [],
"label": "getSavedQuery",
"description": [],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
">"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 39
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-public.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 39
},
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.deleteSavedQuery",
"type": "Function",
"tags": [],
"label": "deleteSavedQuery",
"description": [],
"signature": [
"(id: string) => Promise<{}>"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 40
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-public.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 40
},
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryService.getSavedQueryCount",
"type": "Function",
"tags": [],
"label": "getSavedQueryCount",
"description": [],
"signature": [
"() => Promise<number>"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 41
},
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "data",
"id": "def-public.AutoRefreshDoneFn",
"type": "Type",
"tags": [],
"label": "AutoRefreshDoneFn",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/lib/auto_refresh_loop.ts",
"lineNumber": 13
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.InputTimeRange",
"type": "Type",
"tags": [],
"label": "InputTimeRange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | { from: moment.Moment; to: moment.Moment; }"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/types.ts",
"lineNumber": 19
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.QueryStart",
"type": "Type",
"tags": [],
"label": "QueryStart",
"description": [],
"signature": [
"{ 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",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
},
"; state: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryState",
"text": "QueryState"
},
"; }>; timefilter: ",
"TimefilterSetup",
"; getEsQuery: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { bool: { must: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
},
"[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }; }; }"
],
"source": {
"path": "src/plugins/data/public/query/query_service.ts",
"lineNumber": 103
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.SavedQueryTimeFilter",
"type": "Type",
"tags": [],
"label": "SavedQueryTimeFilter",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" & { refreshInterval: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
"; }"
],
"source": {
"path": "src/plugins/data/public/query/saved_query/types.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.TimefilterContract",
"type": "Type",
"tags": [],
"label": "TimefilterContract",
"description": [],
"signature": [
"{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ",
"Observable",
"<boolean>; getTimeUpdate$: () => ",
"Observable",
"<unknown>; getRefreshIntervalUpdate$: () => ",
"Observable",
"<unknown>; getAutoRefreshFetch$: () => ",
"Observable",
"<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.AutoRefreshDoneFn",
"text": "AutoRefreshDoneFn"
},
">; getFetch$: () => ",
"Observable",
"<unknown>; getTime: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; getAbsoluteTime: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; setTime: (time: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.InputTimeRange",
"text": "InputTimeRange"
},
") => void; getRefreshInterval: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
"; setRefreshInterval: (refreshInterval: Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
">) => void; createFilter: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
", timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
},
" | undefined; getBounds: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRangeBounds",
"text": "TimeRangeBounds"
},
"; calculateBounds: (timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRangeBounds",
"text": "TimeRangeBounds"
},
"; getActiveBounds: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRangeBounds",
"text": "TimeRangeBounds"
},
" | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; getRefreshIntervalDefaults: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
"; }"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/timefilter.ts",
"lineNumber": 242
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.TimeHistoryContract",
"type": "Type",
"tags": [],
"label": "TimeHistoryContract",
"description": [],
"signature": [
"{ add: (time: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
") => void; get: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"[]; }"
],
"source": {
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
"lineNumber": 47
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "data",
"id": "def-common.calculateBounds",
"type": "Function",
"tags": [],
"label": "calculateBounds",
"description": [],
"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"
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 16
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.calculateBounds.$1",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 17
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.calculateBounds.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"CalculateBoundsOptions"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 18
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.compareFilters",
"type": "Function",
"tags": [],
"label": "compareFilters",
"description": [
"\nCompare two filters or filter arrays to see if they match.\nFor filter arrays, the assumption is they are sorted.\n"
],
"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"
},
") => boolean"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 64
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.compareFilters.$1",
"type": "CompoundType",
"tags": [],
"label": "first",
"description": [
"The first filter or filter array to compare"
],
"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"
},
"[]"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 65
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.compareFilters.$2",
"type": "CompoundType",
"tags": [],
"label": "second",
"description": [
"The second filter or filter array to compare"
],
"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"
},
"[]"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 66
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.compareFilters.$3",
"type": "Object",
"tags": [],
"label": "comparatorOptions",
"description": [
"Parameters to use for comparison"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
}
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 67
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"Filters are the same"
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.dedupFilters",
"type": "Function",
"tags": [],
"label": "dedupFilters",
"description": [
"\nCombine 2 filter collections, removing duplicates\n"
],
"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"
},
"[]"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 22
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.dedupFilters.$1",
"type": "Array",
"tags": [],
"label": "existingFilters",
"description": [
"- The filters to compare to"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 23
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.dedupFilters.$2",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"- The filters being added"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 24
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.dedupFilters.$3",
"type": "Object",
"tags": [],
"label": "comparatorOptions",
"description": [
"- Parameters to use for comparison"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
}
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts",
"lineNumber": 25
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"An array of filters that were not in existing"
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.getAbsoluteTimeRange",
"type": "Function",
"tags": [],
"label": "getAbsoluteTimeRange",
"description": [],
"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"
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.getAbsoluteTimeRange.$1",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 27
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.getAbsoluteTimeRange.$2.forceNow",
"type": "Object",
"tags": [],
"label": "{ forceNow }",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 28
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.getAbsoluteTimeRange.$2.forceNow.forceNow",
"type": "Object",
"tags": [],
"label": "forceNow",
"description": [],
"signature": [
"Date | undefined"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 28
},
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.getTime",
"type": "Function",
"tags": [],
"label": "getTime",
"description": [],
"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"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.getTime.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 38
},
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "data",
"id": "def-common.getTime.$2",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 39
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.getTime.$3.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.getTime.$3.options.forceNow",
"type": "Object",
"tags": [],
"label": "forceNow",
"description": [],
"signature": [
"Date | undefined"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.getTime.$3.options.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
},
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.isQuery",
"type": "Function",
"tags": [],
"label": "isQuery",
"description": [],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
}
],
"source": {
"path": "src/plugins/data/common/query/is_query.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.isQuery.$1",
"type": "Unknown",
"tags": [],
"label": "x",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "src/plugins/data/common/query/is_query.ts",
"lineNumber": 11
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.isTimeRange",
"type": "Function",
"tags": [],
"label": "isTimeRange",
"description": [],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/is_time_range.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.isTimeRange.$1",
"type": "Unknown",
"tags": [],
"label": "x",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/is_time_range.ts",
"lineNumber": 11
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.uniqFilters",
"type": "Function",
"tags": [],
"label": "uniqFilters",
"description": [
"\nRemove duplicate filters from an array of filters\n"
],
"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"
},
"[]"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.uniqFilters.$1",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"The filters to remove duplicates from"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts",
"lineNumber": 21
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.uniqFilters.$2",
"type": "Any",
"tags": [],
"label": "comparatorOptions",
"description": [
"- Parameters to use for comparison"
],
"signature": [
"any"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts",
"lineNumber": 21
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The original filters array with duplicates removed"
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "data",
"id": "def-common.FilterCompareOptions",
"type": "Interface",
"tags": [],
"label": "FilterCompareOptions",
"description": [],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 12
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.FilterCompareOptions.index",
"type": "CompoundType",
"tags": [],
"label": "index",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 13
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FilterCompareOptions.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 14
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FilterCompareOptions.negate",
"type": "CompoundType",
"tags": [],
"label": "negate",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 15
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FilterCompareOptions.state",
"type": "CompoundType",
"tags": [],
"label": "state",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FilterCompareOptions.alias",
"type": "CompoundType",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 17
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.RefreshInterval",
"type": "Interface",
"tags": [],
"label": "RefreshInterval",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.RefreshInterval.pause",
"type": "boolean",
"tags": [],
"label": "pause",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 12
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.RefreshInterval.value",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 13
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.TimeRangeBounds",
"type": "Interface",
"tags": [],
"label": "TimeRangeBounds",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 23
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.TimeRangeBounds.min",
"type": "Object",
"tags": [],
"label": "min",
"description": [],
"signature": [
"moment.Moment | undefined"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.TimeRangeBounds.max",
"type": "Object",
"tags": [],
"label": "max",
"description": [],
"signature": [
"moment.Moment | undefined"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 25
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "data",
"id": "def-common.Query",
"type": "Type",
"tags": [],
"label": "Query",
"description": [],
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"source": {
"path": "src/plugins/data/common/query/types.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.TimeRange",
"type": "Type",
"tags": [],
"label": "TimeRange",
"description": [],
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "data",
"id": "def-common.COMPARE_ALL_OPTIONS",
"type": "Object",
"tags": [],
"label": "COMPARE_ALL_OPTIONS",
"description": [
"\nInclude disabled, negate and store when comparing filters"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 23
},
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.COMPARE_ALL_OPTIONS.index",
"type": "boolean",
"tags": [],
"label": "index",
"description": [],
"signature": [
"true"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.COMPARE_ALL_OPTIONS.disabled",
"type": "boolean",
"tags": [],
"label": "disabled",
"description": [],
"signature": [
"true"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.COMPARE_ALL_OPTIONS.negate",
"type": "boolean",
"tags": [],
"label": "negate",
"description": [],
"signature": [
"true"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.COMPARE_ALL_OPTIONS.state",
"type": "boolean",
"tags": [],
"label": "state",
"description": [],
"signature": [
"true"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.COMPARE_ALL_OPTIONS.alias",
"type": "boolean",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"true"
],
"source": {
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
"lineNumber": 28
},
"deprecated": false
}
],
"initialIsOpen": false
}
]
}
}