{ "id": "data.query", "client": { "classes": [ { "parentPluginId": "data", "id": "def-public.FilterManager", "type": "Class", "tags": [], "label": "FilterManager", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]>" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.Unnamed.$1", "type": "Object", "tags": [], "label": "uiSettings", "description": [], "signature": [ { "pluginId": "@kbn/core-ui-settings-browser", "scope": "common", "docId": "kibKbnCoreUiSettingsBrowserPluginApi", "section": "def-common.IUiSettingsClient", "text": "IUiSettingsClient" } ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.getFilters", "type": "Function", "tags": [], "label": "getFilters", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.getAppFilters", "type": "Function", "tags": [], "label": "getAppFilters", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.getGlobalFilters", "type": "Function", "tags": [], "label": "getGlobalFilters", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.getPartitionedFilters", "type": "Function", "tags": [], "label": "getPartitionedFilters", "description": [], "signature": [ "() => PartitionedFilters" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.getUpdates$", "type": "Function", "tags": [], "label": "getUpdates$", "description": [], "signature": [ "() => ", "Observable", "" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.getFetches$", "type": "Function", "tags": [], "label": "getFetches$", "description": [], "signature": [ "() => ", "Observable", "" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.addFilters", "type": "Function", "tags": [], "label": "addFilters", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[], pinFilterStatus?: boolean) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.addFilters.$1", "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.FilterManager.addFilters.$2", "type": "boolean", "tags": [], "label": "pinFilterStatus", "description": [], "signature": [ "boolean" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.setFilters", "type": "Function", "tags": [], "label": "setFilters", "description": [], "signature": [ "(newFilters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[], pinFilterStatus?: boolean) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.setFilters.$1", "type": "Array", "tags": [], "label": "newFilters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.FilterManager.setFilters.$2", "type": "boolean", "tags": [], "label": "pinFilterStatus", "description": [], "signature": [ "boolean" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": 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": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.setGlobalFilters.$1", "type": "Array", "tags": [], "label": "newGlobalFilters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": 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": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.setAppFilters.$1", "type": "Array", "tags": [], "label": "newAppFilters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.removeFilter", "type": "Function", "tags": [], "label": "removeFilter", "description": [], "signature": [ "(filter: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ") => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.removeFilter.$1", "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" } ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.removeAll", "type": "Function", "tags": [], "label": "removeAll", "description": [], "signature": [ "() => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore", "type": "Function", "tags": [], "label": "setFiltersStore", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[], store: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" }, ", shouldOverrideStore?: boolean) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore.$1", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore.$2", "type": "Enum", "tags": [], "label": "store", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" } ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.FilterManager.setFiltersStore.$3", "type": "boolean", "tags": [], "label": "shouldOverrideStore", "description": [], "signature": [ "boolean" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.FilterManager.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]) => { state: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.extract.$1", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "data", "id": "def-public.FilterManager.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[], references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.inject.$1", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.FilterManager.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "data", "id": "def-public.FilterManager.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[], collector: unknown) => {}" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-public.FilterManager.telemetry.$1", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.FilterManager.telemetry.$2", "type": "Unknown", "tags": [], "label": "collector", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "data", "id": "def-public.FilterManager.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.PersistedLog", "type": "Class", "tags": [], "label": "PersistedLog", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.PersistedLog", "text": "PersistedLog" }, "" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.PersistedLog.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.PersistedLog.maxLength", "type": "number", "tags": [], "label": "maxLength", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.PersistedLog.filterDuplicates", "type": "CompoundType", "tags": [], "label": "filterDuplicates", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.PersistedLog.isDuplicate", "type": "Function", "tags": [], "label": "isDuplicate", "description": [], "signature": [ "(oldItem: T, newItem: T) => boolean" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-public.PersistedLog.isDuplicate.$1", "type": "Uncategorized", "tags": [], "label": "oldItem", "description": [], "signature": [ "T" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.PersistedLog.isDuplicate.$2", "type": "Uncategorized", "tags": [], "label": "newItem", "description": [], "signature": [ "T" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "data", "id": "def-public.PersistedLog.storage", "type": "Object", "tags": [], "label": "storage", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.IStorageWrapper", "text": "IStorageWrapper" }, "" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.PersistedLog.items", "type": "Array", "tags": [], "label": "items", "description": [], "signature": [ "T[]" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.PersistedLog.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.PersistedLog.Unnamed.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.PersistedLog.Unnamed.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "PersistedLogOptions" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.PersistedLog.Unnamed.$3", "type": "Object", "tags": [], "label": "storage", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.IStorageWrapper", "text": "IStorageWrapper" }, "" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.PersistedLog.add", "type": "Function", "tags": [], "label": "add", "description": [], "signature": [ "(val: any) => T[]" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.PersistedLog.add.$1", "type": "Any", "tags": [], "label": "val", "description": [], "signature": [ "any" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.PersistedLog.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "() => T[]" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.PersistedLog.get$", "type": "Function", "tags": [], "label": "get$", "description": [], "signature": [ "() => ", "Observable", "" ], "path": "src/plugins/data/public/query/persisted_log/persisted_log.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.TimeHistory", "type": "Class", "tags": [], "label": "TimeHistory", "description": [], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.TimeHistory.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": 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" }, "" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.TimeHistory.add", "type": "Function", "tags": [], "label": "add", "description": [], "signature": [ "(time: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => void" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.TimeHistory.add.$1", "type": "Object", "tags": [], "label": "time", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.TimeHistory.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "[]" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.TimeHistory.get$", "type": "Function", "tags": [], "label": "get$", "description": [], "signature": [ "() => ", "Observable", "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "[]>" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": 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": [ "({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStart", "text": "QueryStart" }, " | ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QuerySetup", "text": "QuerySetup" }, ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, stateContainer: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.BaseStateContainer", "text": "BaseStateContainer" }, ", syncConfig: { time?: boolean | undefined; refreshInterval?: boolean | undefined; filters?: boolean | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" }, " | undefined; query?: boolean | undefined; }) => () => void" ], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": 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<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStart", "text": "QueryStart" }, " | ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QuerySetup", "text": "QuerySetup" }, ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">" ], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": 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" }, "" ], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.connectToQueryState.$3", "type": "Object", "tags": [], "label": "syncConfig", "description": [], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.time", "type": "CompoundType", "tags": [], "label": "time", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.refreshInterval", "type": "CompoundType", "tags": [], "label": "refreshInterval", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.filters", "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ "boolean | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" }, " | undefined" ], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.connectToQueryState.$3.query", "type": "CompoundType", "tags": [], "label": "query", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.createSavedQueryService", "type": "Function", "tags": [], "label": "createSavedQueryService", "description": [], "signature": [ "(http: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", "docId": "kibKbnCoreHttpBrowserPluginApi", "section": "def-common.HttpSetup", "text": "HttpSetup" }, ") => { createQuery: (attributes: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.SavedQueryAttributes", "text": "SavedQueryAttributes" }, ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">; updateQuery: (id: string, attributes: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.SavedQueryAttributes", "text": "SavedQueryAttributes" }, ") => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">; getAllSavedQueries: () => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, "[]; }>; getSavedQuery: (id: string) => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }" ], "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.createSavedQueryService.$1", "type": "Object", "tags": [], "label": "http", "description": [], "signature": [ { "pluginId": "@kbn/core-http-browser", "scope": "common", "docId": "kibKbnCoreHttpBrowserPluginApi", "section": "def-common.HttpSetup", "text": "HttpSetup" } ], "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.generateFilters", "type": "Function", "tags": [], "label": "generateFilters", "description": [ "\nGenerate filter objects, as a result of triggering a filter action on a\nspecific index pattern field.\n" ], "signature": [ "(filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, ", field: string | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.DataViewFieldBase", "text": "DataViewFieldBase" }, ", values: any, operation: string, index: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.DataViewBase", "text": "DataViewBase" }, ") => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.generateFilters.$1", "type": "Object", "tags": [], "label": "filterManager", "description": [ "- The active filter manager to lookup for existing filters" ], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" } ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.generateFilters.$2", "type": "CompoundType", "tags": [], "label": "field", "description": [ "- The field for which filters should be generated" ], "signature": [ "string | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.DataViewFieldBase", "text": "DataViewFieldBase" } ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.generateFilters.$3", "type": "Any", "tags": [], "label": "values", "description": [ "- One or more values to filter for." ], "signature": [ "any" ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.generateFilters.$4", "type": "string", "tags": [], "label": "operation", "description": [ "- \"-\" to create a negated filter" ], "signature": [ "string" ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.generateFilters.$5", "type": "Object", "tags": [], "label": "index", "description": [ "- Index string to generate filters for" ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.DataViewBase", "text": "DataViewBase" } ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "An array of filters to be added back to filterManager" ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.getDefaultQuery", "type": "Function", "tags": [], "label": "getDefaultQuery", "description": [], "signature": [ "(language: QueryLanguage) => { query: string; language: QueryLanguage; }" ], "path": "src/plugins/data/public/query/lib/get_default_query.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.getDefaultQuery.$1", "type": "CompoundType", "tags": [], "label": "language", "description": [], "signature": [ "QueryLanguage" ], "path": "src/plugins/data/public/query/lib/get_default_query.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.getDisplayValueFromFilter", "type": "Function", "tags": [], "label": "getDisplayValueFromFilter", "description": [], "signature": [ "(filter: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ", indexPatterns: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, "[]) => string" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.getDisplayValueFromFilter.$1", "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" } ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.getDisplayValueFromFilter.$2", "type": "Array", "tags": [], "label": "indexPatterns", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.getFieldDisplayValueFromFilter", "type": "Function", "tags": [], "label": "getFieldDisplayValueFromFilter", "description": [], "signature": [ "(filter: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ", indexPatterns: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, "[]) => string" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.getFieldDisplayValueFromFilter.$1", "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" } ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.getFieldDisplayValueFromFilter.$2", "type": "Array", "tags": [], "label": "indexPatterns", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.getIndexPatternFromFilter", "type": "Function", "tags": [], "label": "getIndexPatternFromFilter", "description": [], "signature": [ "(filter: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ", indexPatterns: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, "[]) => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, " | undefined" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.getIndexPatternFromFilter.$1", "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" } ], "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.getIndexPatternFromFilter.$2", "type": "Array", "tags": [], "label": "indexPatterns", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.mapAndFlattenFilters", "type": "Function", "tags": [], "label": "mapAndFlattenFilters", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.mapAndFlattenFilters.$1", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.syncGlobalQueryStateWithUrl", "type": "Function", "tags": [], "label": "syncGlobalQueryStateWithUrl", "description": [ "\nHelper to sync global query state {@link GlobalQueryStateFromUrl} with the URL (`_g` query param that is preserved between apps)" ], "signature": [ "(query: Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStart", "text": "QueryStart" }, " | ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QuerySetup", "text": "QuerySetup" }, ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, kbnUrlStateStorage: ", { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.IKbnUrlStateStorage", "text": "IKbnUrlStateStorage" }, ") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }" ], "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.syncGlobalQueryStateWithUrl.$1", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStart", "text": "QueryStart" }, " | ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QuerySetup", "text": "QuerySetup" }, ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">" ], "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.syncGlobalQueryStateWithUrl.$2", "type": "Object", "tags": [], "label": "kbnUrlStateStorage", "description": [ "to use for syncing" ], "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.IKbnUrlStateStorage", "text": "IKbnUrlStateStorage" } ], "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.syncQueryStateWithUrl", "type": "Function", "tags": [ "deprecated" ], "label": "syncQueryStateWithUrl", "description": [], "signature": [ "(query: Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStart", "text": "QueryStart" }, " | ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QuerySetup", "text": "QuerySetup" }, ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, kbnUrlStateStorage: ", { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.IKbnUrlStateStorage", "text": "IKbnUrlStateStorage" }, ") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }" ], "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "discover", "path": "src/plugins/discover/public/application/main/services/discover_state.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/application/main/services/discover_state.ts" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" }, { "plugin": "monitoring", "path": "x-pack/plugins/monitoring/public/url_state.ts" }, { "plugin": "monitoring", "path": "x-pack/plugins/monitoring/public/url_state.ts" } ], "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-public.syncQueryStateWithUrl.$1", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ "{ state$: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryState", "text": "QueryState" }, "$; timefilter: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.TimefilterSetup", "text": "TimefilterSetup" }, "; filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, "; queryString: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStringContract", "text": "QueryStringContract" }, "; }" ], "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.syncQueryStateWithUrl.$2", "type": "Object", "tags": [], "label": "kbnUrlStateStorage", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.IKbnUrlStateStorage", "text": "IKbnUrlStateStorage" } ], "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "data", "id": "def-public.GlobalQueryStateFromUrl", "type": "Interface", "tags": [], "label": "GlobalQueryStateFromUrl", "description": [ "\nPart of {@link QueryState} serialized in the `_g` portion of Url" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.GlobalQueryStateFromUrl.time", "type": "Object", "tags": [], "label": "time", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.GlobalQueryStateFromUrl.refreshInterval", "type": "Object", "tags": [], "label": "refreshInterval", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, " | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.GlobalQueryStateFromUrl.filters", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.QuerySetup", "type": "Interface", "tags": [], "label": "QuerySetup", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QuerySetup", "text": "QuerySetup" }, " extends ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.QueryState", "text": "QueryState" }, ">" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.QuerySetup.filterManager", "type": "Object", "tags": [], "label": "filterManager", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" } ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QuerySetup.timefilter", "type": "Object", "tags": [], "label": "timefilter", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.TimefilterSetup", "text": "TimefilterSetup" } ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QuerySetup.queryString", "type": "Object", "tags": [], "label": "queryString", "description": [], "signature": [ "{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, " | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, "; getUpdates$: () => ", "Observable", "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, ">; getQuery: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, "; setQuery: (query: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, ") => void; clearQuery: () => void; }" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QuerySetup.state$", "type": "Object", "tags": [], "label": "state$", "description": [], "signature": [ "Observable", "<{ changes: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStateChange", "text": "QueryStateChange" }, "; state: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.QueryState", "text": "QueryState" }, "; }>" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QuerySetup.getState", "type": "Function", "tags": [], "label": "getState", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.QueryState", "text": "QueryState" } ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.QueryStart", "type": "Interface", "tags": [], "label": "QueryStart", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStart", "text": "QueryStart" }, " extends ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.QueryState", "text": "QueryState" }, ">" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.QueryStart.filterManager", "type": "Object", "tags": [], "label": "filterManager", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" } ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QueryStart.timefilter", "type": "Object", "tags": [], "label": "timefilter", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.TimefilterSetup", "text": "TimefilterSetup" } ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QueryStart.queryString", "type": "Object", "tags": [], "label": "queryString", "description": [], "signature": [ "{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, " | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, "; getUpdates$: () => ", "Observable", "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, ">; getQuery: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, "; setQuery: (query: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, ") => void; clearQuery: () => void; }" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QueryStart.state$", "type": "Object", "tags": [], "label": "state$", "description": [], "signature": [ "Observable", "<{ changes: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStateChange", "text": "QueryStateChange" }, "; state: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.QueryState", "text": "QueryState" }, "; }>" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QueryStart.getState", "type": "Function", "tags": [], "label": "getState", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.QueryState", "text": "QueryState" } ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.QueryStart.addToQueryLog", "type": "Function", "tags": [], "label": "addToQueryLog", "description": [], "signature": [ "(appName: string, { language, query }: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, ") => void" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-public.QueryStart.addToQueryLog.$1", "type": "string", "tags": [], "label": "appName", "description": [], "path": "src/plugins/data/public/query/lib/add_to_query_log.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QueryStart.addToQueryLog.$2", "type": "Object", "tags": [], "label": "__1", "description": [], "signature": [ "{ query: string | { [key: string]: any; }; language: string; }" ], "path": "src/plugins/data/public/query/lib/add_to_query_log.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "data", "id": "def-public.QueryStart.savedQueries", "type": "Object", "tags": [], "label": "savedQueries", "description": [], "signature": [ "{ createQuery: (attributes: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.SavedQueryAttributes", "text": "SavedQueryAttributes" }, ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">; updateQuery: (id: string, attributes: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.SavedQueryAttributes", "text": "SavedQueryAttributes" }, ") => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">; getAllSavedQueries: () => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, "[]; }>; getSavedQuery: (id: string) => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QueryStart.getEsQuery", "type": "Function", "tags": [], "label": "getEsQuery", "description": [], "signature": [ "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ", timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined) => { bool: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.BoolQuery", "text": "BoolQuery" }, "; }" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.QueryStart.getEsQuery.$1", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" } ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.QueryStart.getEsQuery.$2", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "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" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.QueryStateChange.appFilters", "type": "CompoundType", "tags": [], "label": "appFilters", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.QueryStateChange.globalFilters", "type": "CompoundType", "tags": [], "label": "globalFilters", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.SavedQuery", "type": "Interface", "tags": [], "label": "SavedQuery", "description": [], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.SavedQuery.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.SavedQuery.attributes", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ "SavedQueryAttributes" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.SavedQueryService", "type": "Interface", "tags": [], "label": "SavedQueryService", "description": [], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.SavedQueryService.createQuery", "type": "Function", "tags": [], "label": "createQuery", "description": [], "signature": [ "(attributes: ", "SavedQueryAttributes", ") => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.SavedQueryService.createQuery.$1", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ "SavedQueryAttributes" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.SavedQueryService.updateQuery", "type": "Function", "tags": [], "label": "updateQuery", "description": [], "signature": [ "(id: string, attributes: ", "SavedQueryAttributes", ") => Promise<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQuery", "text": "SavedQuery" }, ">" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.SavedQueryService.updateQuery.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.SavedQueryService.updateQuery.$2", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ "SavedQueryAttributes" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "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" }, "[]>" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "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" }, "[]; }>" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.SavedQueryService.findSavedQueries.$1", "type": "string", "tags": [], "label": "searchText", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-public.SavedQueryService.findSavedQueries.$2", "type": "number", "tags": [], "label": "perPage", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-public.SavedQueryService.findSavedQueries.$3", "type": "number", "tags": [], "label": "activePage", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "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" }, ">" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.SavedQueryService.getSavedQuery.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.SavedQueryService.deleteSavedQuery", "type": "Function", "tags": [], "label": "deleteSavedQuery", "description": [], "signature": [ "(id: string) => Promise<{}>" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.SavedQueryService.deleteSavedQuery.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.SavedQueryService.getSavedQueryCount", "type": "Function", "tags": [], "label": "getSavedQueryCount", "description": [], "signature": [ "() => Promise" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.TimefilterSetup", "type": "Interface", "tags": [], "label": "TimefilterSetup", "description": [], "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-public.TimefilterSetup.timefilter", "type": "Object", "tags": [], "label": "timefilter", "description": [], "signature": [ "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; isRefreshIntervalTouched: () => boolean; getEnabledUpdated$: () => ", "Observable", "; getTimeUpdate$: () => ", "Observable", "; getRefreshIntervalUpdate$: () => ", "Observable", "; getAutoRefreshFetch$: () => ", "Observable", "<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.AutoRefreshDoneFn", "text": "AutoRefreshDoneFn" }, ">; getFetch$: () => ", "Observable", "; getTime: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "; getAbsoluteTime: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "; setTime: (time: ", "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": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ", timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.ScriptedRangeFilter", "text": "ScriptedRangeFilter" }, " | ", "MatchAllRangeFilter", " | undefined; createRelativeFilter: (indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ", timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.ScriptedRangeFilter", "text": "ScriptedRangeFilter" }, " | ", "MatchAllRangeFilter", " | undefined; getBounds: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRangeBounds", "text": "TimeRangeBounds" }, "; calculateBounds: (timeRange: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "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": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "; getRefreshIntervalDefaults: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, "; }" ], "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-public.TimefilterSetup.history", "type": "Object", "tags": [], "label": "history", "description": [], "signature": [ "{ get: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "[]; add: (time: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => void; get$: () => ", "Observable", "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "[]>; }" ], "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "data", "id": "def-public.AutoRefreshDoneFn", "type": "Type", "tags": [], "label": "AutoRefreshDoneFn", "description": [], "signature": [ "() => void" ], "path": "src/plugins/data/public/query/timefilter/lib/auto_refresh_loop.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.QueryState$", "type": "Type", "tags": [], "label": "QueryState$", "description": [], "signature": [ "Observable", "<{ changes: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStateChange", "text": "QueryStateChange" }, "; state: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.QueryState", "text": "QueryState" }, "; }>" ], "path": "src/plugins/data/public/query/state_sync/create_query_state_observable.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.QueryStringContract", "type": "Type", "tags": [], "label": "QueryStringContract", "description": [], "signature": [ "{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, " | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, "; getUpdates$: () => ", "Observable", "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, ">; getQuery: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, "; setQuery: (query: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, ") => void; clearQuery: () => void; }" ], "path": "src/plugins/data/public/query/query_string/query_string_manager.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.SavedQueryTimeFilter", "type": "Type", "tags": [], "label": "SavedQueryTimeFilter", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " & { refreshInterval: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, "; }" ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.TimefilterContract", "type": "Type", "tags": [], "label": "TimefilterContract", "description": [], "signature": [ "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; isRefreshIntervalTouched: () => boolean; getEnabledUpdated$: () => ", "Observable", "; getTimeUpdate$: () => ", "Observable", "; getRefreshIntervalUpdate$: () => ", "Observable", "; getAutoRefreshFetch$: () => ", "Observable", "<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.AutoRefreshDoneFn", "text": "AutoRefreshDoneFn" }, ">; getFetch$: () => ", "Observable", "; getTime: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "; getAbsoluteTime: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "; setTime: (time: ", "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": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ", timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.ScriptedRangeFilter", "text": "ScriptedRangeFilter" }, " | ", "MatchAllRangeFilter", " | undefined; createRelativeFilter: (indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ", timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.ScriptedRangeFilter", "text": "ScriptedRangeFilter" }, " | ", "MatchAllRangeFilter", " | undefined; getBounds: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRangeBounds", "text": "TimeRangeBounds" }, "; calculateBounds: (timeRange: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "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": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "; getRefreshIntervalDefaults: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, "; }" ], "path": "src/plugins/data/public/query/timefilter/timefilter.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.TimeHistoryContract", "type": "Type", "tags": [], "label": "TimeHistoryContract", "description": [], "signature": [ "{ get: () => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "[]; add: (time: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => void; get$: () => ", "Observable", "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "[]>; }" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "trackAdoption": 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": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ", options: ", "CalculateBoundsOptions", ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRangeBounds", "text": "TimeRangeBounds" } ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.calculateBounds.$1", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.calculateBounds.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "CalculateBoundsOptions" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange", "type": "Function", "tags": [], "label": "getAbsoluteTimeRange", "description": [], "signature": [ "(timeRange: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ", { forceNow }: { forceNow?: Date | undefined; }) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange.$1", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange.$2", "type": "Object", "tags": [], "label": "{ forceNow }", "description": [], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.getAbsoluteTimeRange.$2.forceNow", "type": "Object", "tags": [], "label": "forceNow", "description": [], "signature": [ "Date | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getRelativeTime", "type": "Function", "tags": [], "label": "getRelativeTime", "description": [], "signature": [ "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, " | undefined, timeRange: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.ScriptedRangeFilter", "text": "ScriptedRangeFilter" }, " | ", "MatchAllRangeFilter", " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.getRelativeTime.$1", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.getRelativeTime.$2", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.getRelativeTime.$3", "type": "Object", "tags": [], "label": "options", "description": [], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.getRelativeTime.$3.forceNow", "type": "Object", "tags": [], "label": "forceNow", "description": [], "signature": [ "Date | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.getRelativeTime.$3.fieldName", "type": "string", "tags": [], "label": "fieldName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getTime", "type": "Function", "tags": [], "label": "getTime", "description": [], "signature": [ "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, " | undefined, timeRange: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.ScriptedRangeFilter", "text": "ScriptedRangeFilter" }, " | ", "MatchAllRangeFilter", " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.getTime.$1", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.getTime.$2", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.getTime.$3", "type": "Object", "tags": [], "label": "options", "description": [], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.getTime.$3.forceNow", "type": "Object", "tags": [], "label": "forceNow", "description": [], "signature": [ "Date | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.getTime.$3.fieldName", "type": "string", "tags": [], "label": "fieldName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isQuery", "type": "Function", "tags": [], "label": "isQuery", "description": [], "signature": [ "(x: unknown) => x is ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" } ], "path": "src/plugins/data/common/query/is_query.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.isQuery.$1", "type": "Unknown", "tags": [], "label": "x", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/query/is_query.ts", "deprecated": false, "trackAdoption": 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" } ], "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.isTimeRange.$1", "type": "Unknown", "tags": [], "label": "x", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.textBasedQueryStateToAstWithValidation", "type": "Function", "tags": [], "label": "textBasedQueryStateToAstWithValidation", "description": [ "\nConverts QueryState to expression AST" ], "signature": [ "({\n filters,\n query,\n inputQuery,\n time,\n dataViewsService,\n}: Args) => Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined>" ], "path": "src/plugins/data/common/query/text_based_query_state_to_ast_with_validation.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.textBasedQueryStateToAstWithValidation.$1", "type": "Object", "tags": [], "label": "{\n filters,\n query,\n inputQuery,\n time,\n dataViewsService,\n}", "description": [], "signature": [ "Args" ], "path": "src/plugins/data/common/query/text_based_query_state_to_ast_with_validation.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.textBasedQueryStateToExpressionAst", "type": "Function", "tags": [], "label": "textBasedQueryStateToExpressionAst", "description": [ "\nConverts QueryState to expression AST" ], "signature": [ "({\n filters,\n query,\n inputQuery,\n time,\n timeFieldName,\n}: Args) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/query/text_based_query_state_to_ast.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.textBasedQueryStateToExpressionAst.$1", "type": "Object", "tags": [], "label": "{\n filters,\n query,\n inputQuery,\n time,\n timeFieldName,\n}", "description": [], "signature": [ "Args" ], "path": "src/plugins/data/common/query/text_based_query_state_to_ast.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "data", "id": "def-common.SavedQuery", "type": "Interface", "tags": [], "label": "SavedQuery", "description": [], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.SavedQuery.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.SavedQuery.attributes", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.SavedQueryAttributes", "text": "SavedQueryAttributes" } ], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SavedQueryAttributes", "type": "Interface", "tags": [], "label": "SavedQueryAttributes", "description": [], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.SavedQueryAttributes.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.SavedQueryAttributes.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.SavedQueryAttributes.query", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ "{ query: string | { [key: string]: any; }; language: string; }" ], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.SavedQueryAttributes.filters", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.SavedQueryAttributes.timefilter", "type": "CompoundType", "tags": [], "label": "timefilter", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.SavedQueryTimeFilter", "text": "SavedQueryTimeFilter" }, " | undefined" ], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.TimeRangeBounds", "type": "Interface", "tags": [], "label": "TimeRangeBounds", "description": [], "path": "src/plugins/data/common/query/timefilter/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "data", "id": "def-common.TimeRangeBounds.min", "type": "Object", "tags": [], "label": "min", "description": [], "signature": [ "moment.Moment | undefined" ], "path": "src/plugins/data/common/query/timefilter/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "data", "id": "def-common.TimeRangeBounds.max", "type": "Object", "tags": [], "label": "max", "description": [], "signature": [ "moment.Moment | undefined" ], "path": "src/plugins/data/common/query/timefilter/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "data", "id": "def-common.QueryState", "type": "Type", "tags": [], "label": "QueryState", "description": [ "\nAll query state service state\n" ], "signature": [ "{ time?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined; refreshInterval?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, " | undefined; filters?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, " | undefined; }" ], "path": "src/plugins/data/common/query/query_state.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.RefreshInterval", "type": "Type", "tags": [], "label": "RefreshInterval", "description": [], "signature": [ "{ pause: boolean; value: number; }" ], "path": "src/plugins/data/common/query/timefilter/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.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" }, "; }" ], "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.TimeRange", "type": "Type", "tags": [], "label": "TimeRange", "description": [], "signature": [ "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" ], "path": "src/plugins/data/common/query/timefilter/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }