maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/data.json
Stacey Gammon 503cfcf8c9
Track API stats as part of ci (#95733) 
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00

27712 lines
884 KiB
JSON
Raw Blame History

{
"id": "data",
"client": {
"classes": [
{
"id": "def-public.AggConfig",
"type": "Class",
"tags": [],
"label": "AggConfig",
"description": [],
"children": [
{
"id": "def-public.AggConfig.ensureIds",
"type": "Function",
"label": "ensureIds",
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
".ensureIds"
],
"description": [
"\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n"
],
"children": [
{
"id": "def-public.AggConfig.ensureIds.$1",
"type": "Array",
"label": "list",
"isRequired": true,
"signature": [
"any[]"
],
"description": [
"- a list of objects, objects can be anything really"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 63
}
}
],
"tags": [
"return"
],
"returnComment": [
"- the list that was passed in"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 63
}
},
{
"id": "def-public.AggConfig.nextId",
"type": "Function",
"label": "nextId",
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
".nextId"
],
"description": [
"\nCalculate the next id based on the ids in this list\n"
],
"children": [
{
"id": "def-public.AggConfig.nextId.$1",
"type": "Array",
"label": "list",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 83
}
}
],
"tags": [
"return"
],
"returnComment": [
"list - a list of objects with id properties"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 83
}
},
{
"tags": [],
"id": "def-public.AggConfig.aggConfigs",
"type": "Object",
"label": "aggConfigs",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 92
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
}
]
},
{
"tags": [],
"id": "def-public.AggConfig.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 93
}
},
{
"tags": [],
"id": "def-public.AggConfig.enabled",
"type": "boolean",
"label": "enabled",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 94
}
},
{
"tags": [],
"id": "def-public.AggConfig.params",
"type": "Any",
"label": "params",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 95
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.AggConfig.parent",
"type": "Object",
"label": "parent",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 96
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.AggConfig.brandNew",
"type": "CompoundType",
"label": "brandNew",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 97
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.AggConfig.schema",
"type": "string",
"label": "schema",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 98
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.AggConfig.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.Unnamed.$1",
"type": "Object",
"label": "aggConfigs",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 104
}
},
{
"id": "def-public.AggConfig.Unnamed.$2",
"type": "Object",
"label": "opts",
"isRequired": true,
"signature": [
"Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & Pick<{ type: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, \"type\"> & Pick<{ type: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 104
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 104
}
},
{
"id": "def-public.AggConfig.setParams",
"type": "Function",
"label": "setParams",
"signature": [
"(from: any) => void"
],
"description": [
"\nWrite the current values to this.params, filling in the defaults as we go\n"
],
"children": [
{
"id": "def-public.AggConfig.setParams.$1",
"type": "Any",
"label": "from",
"isRequired": true,
"signature": [
"any"
],
"description": [
"- optional object to read values from,\n used when initializing"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 134
}
}
],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 134
}
},
{
"id": "def-public.AggConfig.getParam",
"type": "Function",
"label": "getParam",
"signature": [
"(key: string) => any"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.getParam.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 171
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 171
}
},
{
"id": "def-public.AggConfig.write",
"type": "Function",
"label": "write",
"signature": [
"(aggs?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
},
" | undefined) => Record<string, any>"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.write.$1",
"type": "Object",
"label": "aggs",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 175
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 175
}
},
{
"id": "def-public.AggConfig.isFilterable",
"type": "Function",
"label": "isFilterable",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 179
}
},
{
"id": "def-public.AggConfig.createFilter",
"type": "Function",
"label": "createFilter",
"signature": [
"(key: string, params?: {}) => any"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.createFilter.$1",
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 183
}
},
{
"id": "def-public.AggConfig.createFilter.$2",
"type": "Object",
"label": "params",
"isRequired": true,
"signature": [
"{}"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 183
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 183
}
},
{
"id": "def-public.AggConfig.onSearchRequestStart",
"type": "Function",
"label": "onSearchRequestStart",
"signature": [
"(searchSource: Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined) => Promise<void> | Promise<any[]>"
],
"description": [
"\n Hook for pre-flight logic, see AggType#onSearchRequestStart"
],
"children": [
{
"id": "def-public.AggConfig.onSearchRequestStart.$1",
"type": "Object",
"label": "searchSource",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 209
}
},
{
"id": "def-public.AggConfig.onSearchRequestStart.$2",
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 209
}
}
],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 209
}
},
{
"id": "def-public.AggConfig.toDsl",
"type": "Function",
"label": "toDsl",
"signature": [
"(aggConfigs?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
},
" | undefined) => any"
],
"description": [
"\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n"
],
"children": [
{
"id": "def-public.AggConfig.toDsl.$1",
"type": "Object",
"label": "aggConfigs",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
},
" | undefined"
],
"description": [
"- the config object to convert"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 230
}
}
],
"tags": [
"return"
],
"returnComment": [
"- if the config has a dsl representation, it is\n returned, else undefined is returned"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 230
}
},
{
"id": "def-public.AggConfig.serialize",
"type": "Function",
"label": "serialize",
"signature": [
"() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [
"Returns a serialized representation of an AggConfig."
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 265
}
},
{
"id": "def-public.AggConfig.toJSON",
"type": "Function",
"label": "toJSON",
"signature": [
"() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; }"
],
"description": [],
"children": [],
"tags": [
"deprecated"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 296
}
},
{
"id": "def-public.AggConfig.toSerializedFieldFormat",
"type": "Function",
"label": "toSerializedFieldFormat",
"signature": [
"() => {}"
],
"description": [
"\nReturns a serialized field format for the field used in this agg.\nThis can be passed to fieldFormats.deserialize to get the field\nformat instance.\n"
],
"children": [],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 307
}
},
{
"id": "def-public.AggConfig.toExpressionAst",
"type": "Function",
"label": "toExpressionAst",
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
" | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [
"Returns an ExpressionAst representing the this agg type."
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 316
}
},
{
"id": "def-public.AggConfig.getAggParams",
"type": "Function",
"label": "getAggParams",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggParamType",
"text": "AggParamType"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
">[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 371
}
},
{
"id": "def-public.AggConfig.getRequestAggs",
"type": "Function",
"label": "getRequestAggs",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 375
}
},
{
"id": "def-public.AggConfig.getResponseAggs",
"type": "Function",
"label": "getResponseAggs",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 379
}
},
{
"id": "def-public.AggConfig.getValue",
"type": "Function",
"label": "getValue",
"signature": [
"(bucket: any) => any"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.getValue.$1",
"type": "Any",
"label": "bucket",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 383
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 383
}
},
{
"id": "def-public.AggConfig.getKey",
"type": "Function",
"label": "getKey",
"signature": [
"(bucket: any, key?: string | undefined) => any"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.getKey.$1",
"type": "Any",
"label": "bucket",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 387
}
},
{
"id": "def-public.AggConfig.getKey.$2",
"type": "string",
"label": "key",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 387
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 387
}
},
{
"id": "def-public.AggConfig.getFieldDisplayName",
"type": "Function",
"label": "getFieldDisplayName",
"signature": [
"() => any"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 395
}
},
{
"id": "def-public.AggConfig.getField",
"type": "Function",
"label": "getField",
"signature": [
"() => any"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 401
}
},
{
"id": "def-public.AggConfig.getValueBucketPath",
"type": "Function",
"label": "getValueBucketPath",
"signature": [
"() => string"
],
"description": [
"\nReturns the bucket path containing the main value the agg will produce\n(e.g. for sum of bytes it will point to the sum, for median it will point\n to the 50 percentile in the percentile multi value bucket)"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 410
}
},
{
"id": "def-public.AggConfig.makeLabel",
"type": "Function",
"label": "makeLabel",
"signature": [
"(percentageMode?: boolean) => any"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.makeLabel.$1",
"type": "boolean",
"label": "percentageMode",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 414
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 414
}
},
{
"id": "def-public.AggConfig.getIndexPattern",
"type": "Function",
"label": "getIndexPattern",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 428
}
},
{
"id": "def-public.AggConfig.getTimeRange",
"type": "Function",
"label": "getTimeRange",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 432
}
},
{
"id": "def-public.AggConfig.fieldName",
"type": "Function",
"label": "fieldName",
"signature": [
"() => any"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 436
}
},
{
"id": "def-public.AggConfig.fieldIsTimeField",
"type": "Function",
"label": "fieldIsTimeField",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 441
}
},
{
"id": "def-public.AggConfig.type",
"type": "Object",
"label": "type",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 452
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
}
]
},
{
"id": "def-public.AggConfig.type",
"type": "Object",
"label": "type",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 456
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
}
]
},
{
"id": "def-public.AggConfig.setType",
"type": "Function",
"label": "setType",
"signature": [
"(type: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
") => void"
],
"description": [],
"children": [
{
"id": "def-public.AggConfig.setType.$1",
"type": "Object",
"label": "type",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 486
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 486
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 55
},
"initialIsOpen": false
},
{
"id": "def-public.AggConfigs",
"type": "Class",
"tags": [],
"label": "AggConfigs",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.AggConfigs.indexPattern",
"type": "Object",
"label": "indexPattern",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 65
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
]
},
{
"tags": [],
"id": "def-public.AggConfigs.timeRange",
"type": "Object",
"label": "timeRange",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 66
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.AggConfigs.timeFields",
"type": "Array",
"label": "timeFields",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 67
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-public.AggConfigs.aggs",
"type": "Array",
"label": "aggs",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 70
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
]
},
{
"id": "def-public.AggConfigs.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.Unnamed.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 73
}
},
{
"id": "def-public.AggConfigs.Unnamed.$2",
"type": "Array",
"label": "configStates",
"isRequired": true,
"signature": [
"Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, \"type\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 74
}
},
{
"id": "def-public.AggConfigs.Unnamed.$3",
"type": "Object",
"label": "opts",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigsOptions",
"text": "AggConfigsOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 75
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 72
}
},
{
"id": "def-public.AggConfigs.setTimeFields",
"type": "Function",
"label": "setTimeFields",
"signature": [
"(timeFields: string[] | undefined) => void"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.setTimeFields.$1",
"type": "Array",
"label": "timeFields",
"isRequired": false,
"signature": [
"string[] | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 87
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 87
}
},
{
"id": "def-public.AggConfigs.setTimeRange",
"type": "Function",
"label": "setTimeRange",
"signature": [
"(timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
") => void"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.setTimeRange.$1",
"type": "Object",
"label": "timeRange",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 91
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 91
}
},
{
"id": "def-public.AggConfigs.clone",
"type": "Function",
"label": "clone",
"signature": [
"({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfigs",
"text": "AggConfigs"
}
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.clone.$1",
"type": "Object",
"label": "{ enabledOnly = true }",
"isRequired": true,
"signature": [
"{ enabledOnly?: boolean | undefined; }"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 109
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 109
}
},
{
"id": "def-public.AggConfigs.createAggConfig",
"type": "Function",
"children": [
{
"id": "def-public.AggConfigs.createAggConfig.$1",
"type": "Object",
"label": "params",
"isRequired": true,
"signature": [
"Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, \"type\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 123
}
},
{
"id": "def-public.AggConfigs.createAggConfig.$2",
"type": "Object",
"label": "{ addToAggConfigs = true }",
"isRequired": true,
"signature": [
"{ addToAggConfigs?: boolean | undefined; }"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 124
}
}
],
"signature": [
"<T extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
" = ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
">(params: Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, \"type\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
}
],
"description": [],
"label": "createAggConfig",
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 122
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.AggConfigs.jsonDataEquals",
"type": "Function",
"label": "jsonDataEquals",
"signature": [
"(aggConfigs: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]) => boolean"
],
"description": [
"\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes"
],
"children": [
{
"id": "def-public.AggConfigs.jsonDataEquals.$1",
"type": "Array",
"label": "aggConfigs",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [
"an AggConfigs instance"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 165
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 165
}
},
{
"id": "def-public.AggConfigs.toDsl",
"type": "Function",
"label": "toDsl",
"signature": [
"(hierarchical?: boolean) => Record<string, any>"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.toDsl.$1",
"type": "boolean",
"label": "hierarchical",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 177
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 177
}
},
{
"id": "def-public.AggConfigs.getAll",
"type": "Function",
"label": "getAll",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 246
}
},
{
"id": "def-public.AggConfigs.byIndex",
"type": "Function",
"label": "byIndex",
"signature": [
"(index: number) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
}
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.byIndex.$1",
"type": "number",
"label": "index",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 250
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 250
}
},
{
"id": "def-public.AggConfigs.byId",
"type": "Function",
"label": "byId",
"signature": [
"(id: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.byId.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 254
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 254
}
},
{
"id": "def-public.AggConfigs.byName",
"type": "Function",
"label": "byName",
"signature": [
"(name: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.byName.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 258
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 258
}
},
{
"id": "def-public.AggConfigs.byType",
"type": "Function",
"label": "byType",
"signature": [
"(type: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.byType.$1",
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 262
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 262
}
},
{
"id": "def-public.AggConfigs.byTypeName",
"type": "Function",
"label": "byTypeName",
"signature": [
"(type: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.byTypeName.$1",
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 266
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 266
}
},
{
"id": "def-public.AggConfigs.bySchemaName",
"type": "Function",
"label": "bySchemaName",
"signature": [
"(schema: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.bySchemaName.$1",
"type": "string",
"label": "schema",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 270
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 270
}
},
{
"id": "def-public.AggConfigs.getRequestAggs",
"type": "Function",
"label": "getRequestAggs",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 274
}
},
{
"id": "def-public.AggConfigs.getRequestAggById",
"type": "Function",
"label": "getRequestAggById",
"signature": [
"(id: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.getRequestAggById.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 288
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 288
}
},
{
"id": "def-public.AggConfigs.getResponseAggs",
"type": "Function",
"label": "getResponseAggs",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
"[]"
],
"description": [
"\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n"
],
"children": [],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 303
}
},
{
"id": "def-public.AggConfigs.getResponseAggById",
"type": "Function",
"label": "getResponseAggById",
"signature": [
"(id: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
" | undefined"
],
"description": [
"\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n"
],
"children": [
{
"id": "def-public.AggConfigs.getResponseAggById.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- the id of the agg to find"
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 317
}
}
],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 317
}
},
{
"id": "def-public.AggConfigs.onSearchRequestStart",
"type": "Function",
"label": "onSearchRequestStart",
"signature": [
"(searchSource: Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>"
],
"description": [],
"children": [
{
"id": "def-public.AggConfigs.onSearchRequestStart.$1",
"type": "Object",
"label": "searchSource",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 326
}
},
{
"id": "def-public.AggConfigs.onSearchRequestStart.$2",
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 326
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 326
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"lineNumber": 64
},
"initialIsOpen": false
},
{
"id": "def-public.AggParamType",
"type": "Class",
"tags": [],
"label": "AggParamType",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggParamType",
"text": "AggParamType"
},
"<TAggConfig> extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.BaseParamType",
"text": "BaseParamType"
},
"<TAggConfig>"
],
"children": [
{
"tags": [],
"id": "def-public.AggParamType.makeAgg",
"type": "Function",
"label": "makeAgg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 15
},
"signature": [
"(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; } | undefined) => TAggConfig"
]
},
{
"tags": [],
"id": "def-public.AggParamType.allowedAggs",
"type": "Array",
"label": "allowedAggs",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 16
},
"signature": [
"string[]"
]
},
{
"id": "def-public.AggParamType.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.AggParamType.Unnamed.$1",
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 18
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-public.DataPublicPlugin",
"type": "Class",
"tags": [],
"label": "DataPublicPlugin",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPlugin",
"text": "DataPublicPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginSetup",
"text": "DataPublicPluginSetup"
},
", ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
},
", ",
"DataSetupDependencies"
],
"children": [
{
"id": "def-public.DataPublicPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.DataPublicPlugin.Unnamed.$1",
"type": "Object",
"label": "initializerContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>"
],
"description": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 71
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 71
}
},
{
"id": "def-public.DataPublicPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<",
"DataStartDependencies",
", ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
},
">, { bfetch, expressions, uiActions, usageCollection, inspector }: ",
"DataSetupDependencies",
") => ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginSetup",
"text": "DataPublicPluginSetup"
}
],
"description": [],
"children": [
{
"id": "def-public.DataPublicPlugin.setup.$1",
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<",
"DataStartDependencies",
", ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 81
}
},
{
"id": "def-public.DataPublicPlugin.setup.$2",
"type": "Object",
"label": "{ bfetch, expressions, uiActions, usageCollection, inspector }",
"isRequired": true,
"signature": [
"DataSetupDependencies"
],
"description": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 82
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 80
}
},
{
"id": "def-public.DataPublicPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
", { uiActions }: ",
"DataStartDependencies",
") => ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"description": [],
"children": [
{
"id": "def-public.DataPublicPlugin.start.$1",
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 131
}
},
{
"id": "def-public.DataPublicPlugin.start.$2",
"type": "Object",
"label": "{ uiActions }",
"isRequired": true,
"signature": [
"DataStartDependencies"
],
"description": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 131
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 131
}
},
{
"id": "def-public.DataPublicPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 213
}
}
],
"source": {
"path": "src/plugins/data/public/plugin.ts",
"lineNumber": 55
},
"initialIsOpen": false
},
{
"id": "def-public.DuplicateIndexPatternError",
"type": "Class",
"tags": [],
"label": "DuplicateIndexPatternError",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.DuplicateIndexPatternError",
"text": "DuplicateIndexPatternError"
},
" extends Error"
],
"children": [
{
"id": "def-public.DuplicateIndexPatternError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.DuplicateIndexPatternError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
"lineNumber": 10
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
"lineNumber": 10
}
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-public.FieldFormat",
"type": "Class",
"tags": [],
"label": "FieldFormat",
"description": [],
"children": [
{
"tags": [
"property",
"static",
"public"
],
"id": "def-public.FieldFormat.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 32
}
},
{
"tags": [
"property",
"static",
"public"
],
"id": "def-public.FieldFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 38
}
},
{
"tags": [
"property",
"private"
],
"id": "def-public.FieldFormat.fieldType",
"type": "CompoundType",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 44
},
"signature": [
"string | string[]"
]
},
{
"tags": [
"property",
"private"
],
"id": "def-public.FieldFormat.convertObject",
"type": "Object",
"label": "convertObject",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 52
},
"signature": [
"FieldFormatConvert",
" | undefined"
]
},
{
"tags": [
"property",
"protected"
],
"id": "def-public.FieldFormat.htmlConvert",
"type": "Function",
"label": "htmlConvert",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 60
},
"signature": [
"HtmlContextTypeConvert",
" | undefined"
]
},
{
"tags": [
"property",
"protected"
],
"id": "def-public.FieldFormat.textConvert",
"type": "Function",
"label": "textConvert",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 68
},
"signature": [
"TextContextTypeConvert",
" | undefined"
]
},
{
"tags": [
"property",
"private"
],
"id": "def-public.FieldFormat.type",
"type": "Any",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 74
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.FieldFormat.allowsNumericalAggregations",
"type": "CompoundType",
"label": "allowsNumericalAggregations",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 75
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.FieldFormat._params",
"type": "Any",
"label": "_params",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 77
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.FieldFormat.getConfig",
"type": "Function",
"label": "getConfig",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 78
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
" | undefined"
]
},
{
"id": "def-public.FieldFormat.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.FieldFormat.Unnamed.$1",
"type": "Object",
"label": "_params",
"isRequired": true,
"signature": [
"IFieldFormatMetaParams"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 80
}
},
{
"id": "def-public.FieldFormat.Unnamed.$2",
"type": "Function",
"label": "getConfig",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 80
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 80
}
},
{
"id": "def-public.FieldFormat.convert",
"type": "Function",
"label": "convert",
"signature": [
"(value: any, contentType?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
},
", options?: Record<string, any> | ",
"HtmlContextTypeOptions",
" | undefined) => string"
],
"description": [
"\nConvert a raw value to a formatted string"
],
"children": [
{
"id": "def-public.FieldFormat.convert.$1",
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 99
}
},
{
"id": "def-public.FieldFormat.convert.$2",
"type": "CompoundType",
"label": "contentType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
],
"description": [
"- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 100
}
},
{
"id": "def-public.FieldFormat.convert.$3",
"type": "CompoundType",
"label": "options",
"isRequired": false,
"signature": [
"Record<string, any> | ",
"HtmlContextTypeOptions",
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 101
}
}
],
"tags": [
"return",
"public"
],
"returnComment": [
"- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 98
}
},
{
"id": "def-public.FieldFormat.getConverterFor",
"type": "Function",
"label": "getConverterFor",
"signature": [
"(contentType?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
},
") => ",
"FieldFormatConvertFunction"
],
"description": [
"\nGet a convert function that is bound to a specific contentType"
],
"children": [
{
"id": "def-public.FieldFormat.getConverterFor.$1",
"type": "CompoundType",
"label": "contentType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 119
}
}
],
"tags": [
"return",
"public"
],
"returnComment": [
"- a bound converter function"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 118
}
},
{
"id": "def-public.FieldFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => Record<string, any>"
],
"description": [
"\nGet parameter defaults"
],
"children": [],
"tags": [
"return",
"public"
],
"returnComment": [
"- parameter defaults"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 133
}
},
{
"id": "def-public.FieldFormat.param",
"type": "Function",
"label": "param",
"signature": [
"(name: string) => any"
],
"description": [
"\nGet the value of a param. This value may be a default value.\n"
],
"children": [
{
"id": "def-public.FieldFormat.param.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- the param name to fetch"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 144
}
}
],
"tags": [
"return",
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 144
}
},
{
"id": "def-public.FieldFormat.params",
"type": "Function",
"label": "params",
"signature": [
"() => Record<string, any>"
],
"description": [
"\nGet all of the params in a single object"
],
"children": [],
"tags": [
"return",
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 161
}
},
{
"id": "def-public.FieldFormat.toJSON",
"type": "Function",
"label": "toJSON",
"signature": [
"() => { id: any; params: any; }"
],
"description": [
"\nSerialize this format to a simple POJO, with only the params\nthat are not default\n"
],
"children": [],
"tags": [
"return",
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 172
}
},
{
"id": "def-public.FieldFormat.from",
"type": "Function",
"label": "from",
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
".from"
],
"description": [],
"children": [
{
"id": "def-public.FieldFormat.from.$1",
"type": "Function",
"label": "convertFn",
"isRequired": true,
"signature": [
"FieldFormatConvertFunction"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 193
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 193
}
},
{
"id": "def-public.FieldFormat.setupContentType",
"type": "Function",
"label": "setupContentType",
"signature": [
"() => ",
"FieldFormatConvert"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 197
}
},
{
"id": "def-public.FieldFormat.isInstanceOfFieldFormat",
"type": "Function",
"label": "isInstanceOfFieldFormat",
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
".isInstanceOfFieldFormat"
],
"description": [],
"children": [
{
"id": "def-public.FieldFormat.isInstanceOfFieldFormat.$1",
"type": "Any",
"label": "fieldFormat",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 204
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 204
}
}
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPattern",
"type": "Class",
"tags": [],
"label": "IndexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" implements ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"children": [
{
"tags": [],
"id": "def-public.IndexPattern.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 45
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 46
}
},
{
"tags": [],
"id": "def-public.IndexPattern.fieldFormatMap",
"type": "Object",
"label": "fieldFormatMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 47
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.typeMeta",
"type": "Object",
"label": "typeMeta",
"description": [
"\nOnly used by rollup indices, used by rollup specific endpoint to load field list"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 51
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.TypeMeta",
"text": "TypeMeta"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.fields",
"type": "CompoundType",
"label": "fields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 52
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPatternFieldList",
"text": "IIndexPatternFieldList"
},
" & { toSpec: () => Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
">; }"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.timeFieldName",
"type": "string",
"label": "timeFieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 53
},
"signature": [
"string | undefined"
]
},
{
"tags": [
"deprecated"
],
"id": "def-public.IndexPattern.intervalName",
"type": "string",
"label": "intervalName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 58
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.type",
"type": "string",
"label": "type",
"description": [
"\nType is used to identify rollup index patterns"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 62
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.formatHit",
"type": "Function",
"label": "formatHit",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 63
},
"signature": [
"{ (hit: Record<string, any>, type?: string | undefined): any; formatField: FormatFieldFn; }"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.formatField",
"type": "Function",
"label": "formatField",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 67
},
"signature": [
"FormatFieldFn"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.flattenHit",
"type": "Function",
"label": "flattenHit",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 68
},
"signature": [
"(hit: Record<string, any>, deep?: boolean | undefined) => Record<string, any>"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.metaFields",
"type": "Array",
"label": "metaFields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 69
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.version",
"type": "string",
"label": "version",
"description": [
"\nSavedObject version"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 73
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.sourceFilters",
"type": "Array",
"label": "sourceFilters",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 74
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.SourceFilter",
"text": "SourceFilter"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPattern.allowNoIndex",
"type": "boolean",
"label": "allowNoIndex",
"description": [
"\nprevents errors when index pattern exists before indices"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 84
}
},
{
"id": "def-public.IndexPattern.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.IndexPattern.Unnamed.$1",
"type": "Object",
"label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }",
"isRequired": true,
"signature": [
"IndexPatternDeps"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 86
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 86
}
},
{
"id": "def-public.IndexPattern.getOriginalSavedObjectBody",
"type": "Function",
"children": [],
"signature": [
"() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }"
],
"description": [
"\nGet last saved saved object fields"
],
"label": "getOriginalSavedObjectBody",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 128
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPattern.resetOriginalSavedObjectBody",
"type": "Function",
"children": [],
"signature": [
"() => void"
],
"description": [
"\nReset last saved saved object fields. used after saving"
],
"label": "resetOriginalSavedObjectBody",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 133
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPattern.getFieldAttrs",
"type": "Function",
"children": [],
"signature": [
"() => { [x: string]: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"; }"
],
"description": [],
"label": "getFieldAttrs",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 137
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPattern.getComputedFields",
"type": "Function",
"label": "getComputedFields",
"signature": [
"() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
">; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 162
}
},
{
"id": "def-public.IndexPattern.toSpec",
"type": "Function",
"label": "toSpec",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [
"\nCreate static representation of index pattern"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 208
}
},
{
"id": "def-public.IndexPattern.getSourceFiltering",
"type": "Function",
"label": "getSourceFiltering",
"signature": [
"() => { excludes: any[]; }"
],
"description": [
"\nGet the source filtering configuration for that index."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 230
}
},
{
"id": "def-public.IndexPattern.addScriptedField",
"type": "Function",
"label": "addScriptedField",
"signature": [
"(name: string, script: string, fieldType?: string) => Promise<void>"
],
"description": [
"\nAdd scripted field to field list\n"
],
"children": [
{
"id": "def-public.IndexPattern.addScriptedField.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"field name"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
},
{
"id": "def-public.IndexPattern.addScriptedField.$2",
"type": "string",
"label": "script",
"isRequired": true,
"signature": [
"string"
],
"description": [
"script code"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
},
{
"id": "def-public.IndexPattern.addScriptedField.$3",
"type": "string",
"label": "fieldType",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
},
{
"id": "def-public.IndexPattern.removeScriptedField",
"type": "Function",
"label": "removeScriptedField",
"signature": [
"(fieldName: string) => void"
],
"description": [
"\nRemove scripted field from field list"
],
"children": [
{
"id": "def-public.IndexPattern.removeScriptedField.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 270
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 270
}
},
{
"id": "def-public.IndexPattern.getNonScriptedFields",
"type": "Function",
"label": "getNonScriptedFields",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 277
}
},
{
"id": "def-public.IndexPattern.getScriptedFields",
"type": "Function",
"label": "getScriptedFields",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 281
}
},
{
"id": "def-public.IndexPattern.isTimeBased",
"type": "Function",
"label": "isTimeBased",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 285
}
},
{
"id": "def-public.IndexPattern.isTimeNanosBased",
"type": "Function",
"label": "isTimeNanosBased",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 289
}
},
{
"id": "def-public.IndexPattern.getTimeField",
"type": "Function",
"label": "getTimeField",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 294
}
},
{
"id": "def-public.IndexPattern.getFieldByName",
"type": "Function",
"label": "getFieldByName",
"signature": [
"(name: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-public.IndexPattern.getFieldByName.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 299
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 299
}
},
{
"id": "def-public.IndexPattern.getAggregationRestrictions",
"type": "Function",
"label": "getAggregationRestrictions",
"signature": [
"() => Record<string, Record<string, { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }>> | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 304
}
},
{
"id": "def-public.IndexPattern.getAsSavedObjectBody",
"type": "Function",
"label": "getAsSavedObjectBody",
"signature": [
"() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }"
],
"description": [
"\nReturns index pattern as saved object body for saving"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 311
}
},
{
"id": "def-public.IndexPattern.getFormatterForField",
"type": "Function",
"label": "getFormatterForField",
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"description": [
"\nProvide a field, get its formatter"
],
"children": [
{
"id": "def-public.IndexPattern.getFormatterForField.$1",
"type": "CompoundType",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 340
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 339
}
},
{
"id": "def-public.IndexPattern.addRuntimeField",
"type": "Function",
"label": "addRuntimeField",
"signature": [
"(name: string, runtimeField: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
") => void"
],
"description": [
"\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate"
],
"children": [
{
"id": "def-public.IndexPattern.addRuntimeField.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"Field name"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
}
},
{
"id": "def-public.IndexPattern.addRuntimeField.$2",
"type": "Object",
"label": "runtimeField",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
}
],
"description": [
"Runtime field definition"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
}
},
{
"id": "def-public.IndexPattern.removeRuntimeField",
"type": "Function",
"label": "removeRuntimeField",
"signature": [
"(name: string) => void"
],
"description": [
"\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate"
],
"children": [
{
"id": "def-public.IndexPattern.removeRuntimeField.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"Field name"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
}
},
{
"id": "def-public.IndexPattern.getFormatterForFieldNoDefault",
"type": "Function",
"label": "getFormatterForFieldNoDefault",
"signature": [
"(fieldname: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
" | undefined"
],
"description": [
"\nGet formatter for a given field name. Return undefined if none exists"
],
"children": [
{
"id": "def-public.IndexPattern.getFormatterForFieldNoDefault.$1",
"type": "string",
"label": "fieldname",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
}
},
{
"id": "def-public.IndexPattern.setFieldAttrs",
"type": "Function",
"label": "setFieldAttrs",
"signature": [
"<K extends \"customLabel\" | \"count\">(fieldName: string, attrName: K, value: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"[K]) => void"
],
"description": [],
"children": [
{
"id": "def-public.IndexPattern.setFieldAttrs.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 412
}
},
{
"id": "def-public.IndexPattern.setFieldAttrs.$2",
"type": "Uncategorized",
"label": "attrName",
"isRequired": true,
"signature": [
"K"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 413
}
},
{
"id": "def-public.IndexPattern.setFieldAttrs.$3",
"type": "Uncategorized",
"label": "value",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"[K]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 414
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 411
}
},
{
"id": "def-public.IndexPattern.setFieldCustomLabel",
"type": "Function",
"label": "setFieldCustomLabel",
"signature": [
"(fieldName: string, customLabel: string | null | undefined) => void"
],
"description": [],
"children": [
{
"id": "def-public.IndexPattern.setFieldCustomLabel.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
}
},
{
"id": "def-public.IndexPattern.setFieldCustomLabel.$2",
"type": "CompoundType",
"label": "customLabel",
"isRequired": false,
"signature": [
"string | null | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
}
},
{
"id": "def-public.IndexPattern.setFieldCount",
"type": "Function",
"label": "setFieldCount",
"signature": [
"(fieldName: string, count: number | null | undefined) => void"
],
"description": [],
"children": [
{
"id": "def-public.IndexPattern.setFieldCount.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
}
},
{
"id": "def-public.IndexPattern.setFieldCount.$2",
"type": "CompoundType",
"label": "count",
"isRequired": false,
"signature": [
"number | null | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
}
},
{
"id": "def-public.IndexPattern.setFieldFormat",
"type": "Function",
"children": [
{
"id": "def-public.IndexPattern.setFieldFormat.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
}
},
{
"id": "def-public.IndexPattern.setFieldFormat.$2",
"type": "Object",
"label": "format",
"isRequired": true,
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
}
}
],
"signature": [
"(fieldName: string, format: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>) => void"
],
"description": [],
"label": "setFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPattern.deleteFieldFormat",
"type": "Function",
"children": [
{
"id": "def-public.IndexPattern.deleteFieldFormat.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
}
}
],
"signature": [
"(fieldName: string) => void"
],
"description": [],
"label": "deleteFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 44
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternField",
"type": "Class",
"tags": [],
"label": "IndexPatternField",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" implements ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternField.spec",
"type": "Object",
"label": "spec",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 17
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
]
},
{
"id": "def-public.IndexPatternField.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.IndexPatternField.Unnamed.$1",
"type": "Object",
"label": "spec",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 21
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 21
}
},
{
"id": "def-public.IndexPatternField.count",
"type": "number",
"label": "count",
"tags": [],
"description": [
"\nCount is used for field popularity"
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 31
}
},
{
"id": "def-public.IndexPatternField.count",
"type": "number",
"label": "count",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 35
}
},
{
"id": "def-public.IndexPatternField.runtimeField",
"type": "Object",
"label": "runtimeField",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 39
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
" | undefined"
]
},
{
"id": "def-public.IndexPatternField.runtimeField",
"type": "Object",
"label": "runtimeField",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 43
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
" | undefined"
]
},
{
"id": "def-public.IndexPatternField.script",
"type": "string",
"label": "script",
"tags": [],
"description": [
"\nScript field code"
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 50
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.IndexPatternField.script",
"type": "string",
"label": "script",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 54
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.IndexPatternField.lang",
"type": "string",
"label": "lang",
"tags": [],
"description": [
"\nScript field language"
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 61
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.IndexPatternField.lang",
"type": "string",
"label": "lang",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 65
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.IndexPatternField.customLabel",
"type": "string",
"label": "customLabel",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 69
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.IndexPatternField.customLabel",
"type": "string",
"label": "customLabel",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 73
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.IndexPatternField.conflictDescriptions",
"type": "Object",
"label": "conflictDescriptions",
"tags": [],
"description": [
"\nDescription of field type conflicts across different indices in the same index pattern"
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 80
},
"signature": [
"Record<string, string[]> | undefined"
]
},
{
"id": "def-public.IndexPatternField.conflictDescriptions",
"type": "Object",
"label": "conflictDescriptions",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 84
},
"signature": [
"Record<string, string[]> | undefined"
]
},
{
"id": "def-public.IndexPatternField.name",
"type": "string",
"label": "name",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 89
}
},
{
"id": "def-public.IndexPatternField.displayName",
"type": "string",
"label": "displayName",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 93
}
},
{
"id": "def-public.IndexPatternField.type",
"type": "string",
"label": "type",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 101
}
},
{
"id": "def-public.IndexPatternField.esTypes",
"type": "Array",
"label": "esTypes",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 107
},
"signature": [
"string[] | undefined"
]
},
{
"id": "def-public.IndexPatternField.scripted",
"type": "boolean",
"label": "scripted",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 111
}
},
{
"id": "def-public.IndexPatternField.searchable",
"type": "boolean",
"label": "searchable",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 115
}
},
{
"id": "def-public.IndexPatternField.aggregatable",
"type": "boolean",
"label": "aggregatable",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 119
}
},
{
"id": "def-public.IndexPatternField.readFromDocValues",
"type": "boolean",
"label": "readFromDocValues",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 123
}
},
{
"id": "def-public.IndexPatternField.subType",
"type": "Object",
"label": "subType",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 127
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldSubType",
"text": "IFieldSubType"
},
" | undefined"
]
},
{
"id": "def-public.IndexPatternField.isMapped",
"type": "CompoundType",
"label": "isMapped",
"tags": [],
"description": [
"\nIs the field part of the index mapping?"
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 134
},
"signature": [
"boolean | undefined"
]
},
{
"id": "def-public.IndexPatternField.sortable",
"type": "boolean",
"label": "sortable",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 139
}
},
{
"id": "def-public.IndexPatternField.filterable",
"type": "boolean",
"label": "filterable",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 146
}
},
{
"id": "def-public.IndexPatternField.visualizable",
"type": "boolean",
"label": "visualizable",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 154
}
},
{
"id": "def-public.IndexPatternField.deleteCount",
"type": "Function",
"label": "deleteCount",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 159
}
},
{
"id": "def-public.IndexPatternField.toJSON",
"type": "Function",
"label": "toJSON",
"signature": [
"() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record<string, string[]> | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldSubType",
"text": "IFieldSubType"
},
" | undefined; customLabel: string | undefined; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 163
}
},
{
"id": "def-public.IndexPatternField.toSpec",
"type": "Function",
"label": "toSpec",
"signature": [
"({ getFormatterForField, }?: { getFormatterForField?: ((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") | undefined; }) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"description": [],
"children": [
{
"id": "def-public.IndexPatternField.toSpec.$1.getFormatterForField",
"type": "Object",
"label": "{\n getFormatterForField,\n }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternField.toSpec.$1.getFormatterForField.getFormatterForField",
"type": "Function",
"label": "getFormatterForField",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 184
},
"signature": [
"((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 183
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 181
}
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternsService",
"type": "Class",
"tags": [],
"label": "IndexPatternsService",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternsService.ensureDefaultIndexPattern",
"type": "Function",
"label": "ensureDefaultIndexPattern",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 67
},
"signature": [
"EnsureDefaultIndexPattern"
]
},
{
"id": "def-public.IndexPatternsService.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.IndexPatternsService.Unnamed.$1",
"type": "Object",
"label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }",
"isRequired": true,
"signature": [
"IndexPatternsServiceDeps"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 69
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 69
}
},
{
"id": "def-public.IndexPatternsService.getIds",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.getIds.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 108
}
}
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"description": [
"\nGet list of index pattern ids"
],
"label": "getIds",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 108
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.getTitles",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.getTitles.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 122
}
}
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"description": [
"\nGet list of index pattern titles"
],
"label": "getTitles",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 122
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.find",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.find.$1",
"type": "string",
"label": "search",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
}
},
{
"id": "def-public.IndexPatternsService.find.$2",
"type": "number",
"label": "size",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
}
}
],
"signature": [
"(search: string, size?: number) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"[]>"
],
"description": [
"\nFind and load index patterns by title"
],
"label": "find",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
},
"tags": [],
"returnComment": [
"IndexPattern[]"
]
},
{
"id": "def-public.IndexPatternsService.getIdsWithTitle",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.getIdsWithTitle.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 157
}
}
],
"signature": [
"(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"
],
"description": [
"\nGet list of index pattern ids with titles"
],
"label": "getIdsWithTitle",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 156
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.clearCache",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.clearCache.$1",
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 175
}
}
],
"signature": [
"(id?: string | undefined) => void"
],
"description": [
"\nClear index pattern list cache"
],
"label": "clearCache",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 175
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.getCache",
"type": "Function",
"children": [],
"signature": [
"() => Promise<",
"SavedObject",
"<",
"IndexPatternSavedObjectAttrs",
">[] | null | undefined>"
],
"description": [],
"label": "getCache",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 184
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.getDefault",
"type": "Function",
"children": [],
"signature": [
"() => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | null>"
],
"description": [
"\nGet default index pattern"
],
"label": "getDefault",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 194
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.setDefault",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.setDefault.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
}
},
{
"id": "def-public.IndexPatternsService.setDefault.$2",
"type": "boolean",
"label": "force",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
}
}
],
"signature": [
"(id: string, force?: boolean) => Promise<void>"
],
"description": [
"\nOptionally set default index pattern, unless force = true"
],
"label": "setDefault",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.getFieldsForWildcard",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.getFieldsForWildcard.$1",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219
}
}
],
"signature": [
"(options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<any>"
],
"description": [
"\nGet field list by providing { pattern }"
],
"label": "getFieldsForWildcard",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219
},
"tags": [],
"returnComment": [
"FieldSpec[]"
]
},
{
"id": "def-public.IndexPatternsService.getFieldsForIndexPattern",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.getFieldsForIndexPattern.$1",
"type": "CompoundType",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 236
}
},
{
"id": "def-public.IndexPatternsService.getFieldsForIndexPattern.$2",
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 237
}
}
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
" | undefined) => Promise<any>"
],
"description": [
"\nGet field list by providing an index patttern (or spec)"
],
"label": "getFieldsForIndexPattern",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 235
},
"tags": [],
"returnComment": [
"FieldSpec[]"
]
},
{
"id": "def-public.IndexPatternsService.refreshFields",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.refreshFields.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250
}
}
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
") => Promise<void>"
],
"description": [
"\nRefresh field list for a given index pattern"
],
"label": "refreshFields",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.fieldArrayToMap",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.fieldArrayToMap.$1",
"type": "Array",
"label": "fields",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
}
},
{
"id": "def-public.IndexPatternsService.fieldArrayToMap.$2",
"type": "Object",
"label": "fieldAttrs",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
}
}
],
"signature": [
"(fields: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[], fieldAttrs?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined) => Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
">"
],
"description": [
"\nConverts field array to map"
],
"label": "fieldArrayToMap",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
},
"tags": [],
"returnComment": [
"Record<string, FieldSpec>"
]
},
{
"id": "def-public.IndexPatternsService.savedObjectToSpec",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.savedObjectToSpec.$1",
"type": "Object",
"label": "savedObject",
"isRequired": true,
"signature": [
"SavedObject",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343
}
}
],
"signature": [
"(savedObject: ",
"SavedObject",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
},
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [
"\nConverts index pattern saved object to index pattern spec"
],
"label": "savedObjectToSpec",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343
},
"tags": [],
"returnComment": [
"IndexPatternSpec"
]
},
{
"id": "def-public.IndexPatternsService.get",
"type": "Function",
"children": [
{
"id": "def-public.IndexPatternsService.get.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465
}
}
],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nGet an index pattern by id. Cache optimized"
],
"label": "get",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.IndexPatternsService.create",
"type": "Function",
"label": "create",
"signature": [
"(spec: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", skipFetchFields?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nCreate a new index pattern instance"
],
"children": [
{
"id": "def-public.IndexPatternsService.create.$1",
"type": "Object",
"label": "spec",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
},
{
"id": "def-public.IndexPatternsService.create.$2",
"type": "boolean",
"label": "skipFetchFields",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
}
],
"tags": [],
"returnComment": [
"IndexPattern"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
},
{
"id": "def-public.IndexPatternsService.createAndSave",
"type": "Function",
"label": "createAndSave",
"signature": [
"(spec: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", override?: boolean, skipFetchFields?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nCreate a new index pattern and save it right away"
],
"children": [
{
"id": "def-public.IndexPatternsService.createAndSave.$1",
"type": "Object",
"label": "spec",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-public.IndexPatternsService.createAndSave.$2",
"type": "boolean",
"label": "override",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Overwrite if existing index pattern exists."
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-public.IndexPatternsService.createAndSave.$3",
"type": "boolean",
"label": "skipFetchFields",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Whether to skip field refresh step."
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-public.IndexPatternsService.createSavedObject",
"type": "Function",
"label": "createSavedObject",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", override?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nSave a new index pattern"
],
"children": [
{
"id": "def-public.IndexPatternsService.createSavedObject.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
},
{
"id": "def-public.IndexPatternsService.createSavedObject.$2",
"type": "boolean",
"label": "override",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Overwrite if existing index pattern exists"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
},
{
"id": "def-public.IndexPatternsService.updateSavedObject",
"type": "Function",
"label": "updateSavedObject",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>"
],
"description": [
"\nSave existing index pattern. Will attempt to merge differences if there are conflicts"
],
"children": [
{
"id": "def-public.IndexPatternsService.updateSavedObject.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 551
}
},
{
"id": "def-public.IndexPatternsService.updateSavedObject.$2",
"type": "number",
"label": "saveAttempts",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 552
}
},
{
"id": "def-public.IndexPatternsService.updateSavedObject.$3",
"type": "boolean",
"label": "ignoreErrors",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 553
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 550
}
},
{
"id": "def-public.IndexPatternsService.delete",
"type": "Function",
"label": "delete",
"signature": [
"(indexPatternId: string) => Promise<{}>"
],
"description": [
"\nDeletes an index pattern from .kibana index"
],
"children": [
{
"id": "def-public.IndexPatternsService.delete.$1",
"type": "string",
"label": "indexPatternId",
"isRequired": true,
"signature": [
"string"
],
"description": [
": Id of kibana Index Pattern to delete"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636
}
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 57
},
"initialIsOpen": false
},
{
"id": "def-public.OptionedParamType",
"type": "Class",
"tags": [],
"label": "OptionedParamType",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.OptionedParamType",
"text": "OptionedParamType"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.BaseParamType",
"text": "BaseParamType"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
">"
],
"children": [
{
"tags": [],
"id": "def-public.OptionedParamType.options",
"type": "Array",
"label": "options",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.OptionedValueProp",
"text": "OptionedValueProp"
},
"[]"
]
},
{
"id": "def-public.OptionedParamType.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.OptionedParamType.Unnamed.$1",
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 22
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 22
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"id": "def-public.SearchSource",
"type": "Class",
"tags": [
"public"
],
"label": "SearchSource",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.SearchSource.history",
"type": "Array",
"label": "history",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 111
},
"signature": [
"Record<string, any>[]"
]
},
{
"id": "def-public.SearchSource.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.SearchSource.Unnamed.$1",
"type": "Object",
"label": "fields",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 115
}
},
{
"id": "def-public.SearchSource.Unnamed.$2",
"type": "Object",
"label": "dependencies",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceDependencies",
"text": "SearchSourceDependencies"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 115
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 115
}
},
{
"id": "def-public.SearchSource.setPreferredSearchStrategyId",
"type": "Function",
"label": "setPreferredSearchStrategyId",
"signature": [
"(searchStrategyId: string) => void"
],
"description": [
"**\nPUBLIC API\n\ninternal, dont use"
],
"children": [
{
"id": "def-public.SearchSource.setPreferredSearchStrategyId.$1",
"type": "string",
"label": "searchStrategyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 133
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 133
}
},
{
"id": "def-public.SearchSource.setField",
"type": "Function",
"label": "setField",
"signature": [
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"size\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, value: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]) => this"
],
"description": [
"\nsets value to a single search source field"
],
"children": [
{
"id": "def-public.SearchSource.setField.$1",
"type": "Uncategorized",
"label": "field",
"isRequired": true,
"signature": [
"K"
],
"description": [
": field name"
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 142
}
},
{
"id": "def-public.SearchSource.setField.$2",
"type": "Uncategorized",
"label": "value",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]"
],
"description": [
": value for the field"
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 142
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 142
}
},
{
"id": "def-public.SearchSource.removeField",
"type": "Function",
"label": "removeField",
"signature": [
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"size\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => this"
],
"description": [
"\nremove field"
],
"children": [
{
"id": "def-public.SearchSource.removeField.$1",
"type": "Uncategorized",
"label": "field",
"isRequired": true,
"signature": [
"K"
],
"description": [
": field name"
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 154
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 154
}
},
{
"id": "def-public.SearchSource.setFields",
"type": "Function",
"label": "setFields",
"signature": [
"(newFields: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
") => this"
],
"description": [
"\nInternal, do not use. Overrides all search source fields with the new field array.\n"
],
"children": [
{
"id": "def-public.SearchSource.setFields.$1",
"type": "Object",
"label": "newFields",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
}
],
"description": [
"New field array."
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 165
}
}
],
"tags": [
"private"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 165
}
},
{
"id": "def-public.SearchSource.getId",
"type": "Function",
"label": "getId",
"signature": [
"() => string"
],
"description": [
"\nreturns search source id"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 173
}
},
{
"id": "def-public.SearchSource.getFields",
"type": "Function",
"label": "getFields",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
}
],
"description": [
"\nreturns all search source fields"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 180
}
},
{
"id": "def-public.SearchSource.getField",
"type": "Function",
"label": "getField",
"signature": [
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"size\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, recurse?: boolean) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]"
],
"description": [
"\nGets a single field from the fields"
],
"children": [
{
"id": "def-public.SearchSource.getField.$1",
"type": "Uncategorized",
"label": "field",
"isRequired": true,
"signature": [
"K"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 187
}
},
{
"id": "def-public.SearchSource.getField.$2",
"type": "boolean",
"label": "recurse",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 187
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 187
}
},
{
"id": "def-public.SearchSource.getOwnField",
"type": "Function",
"label": "getOwnField",
"signature": [
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"size\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]"
],
"description": [
"\nGet the field from our own fields, don't traverse up the chain"
],
"children": [
{
"id": "def-public.SearchSource.getOwnField.$1",
"type": "Uncategorized",
"label": "field",
"isRequired": true,
"signature": [
"K"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 198
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 198
}
},
{
"id": "def-public.SearchSource.create",
"type": "Function",
"label": "create",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
}
],
"description": [],
"children": [],
"tags": [
"deprecated"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 205
}
},
{
"id": "def-public.SearchSource.createCopy",
"type": "Function",
"label": "createCopy",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
}
],
"description": [
"\ncreates a copy of this search source (without its children)"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 212
}
},
{
"id": "def-public.SearchSource.createChild",
"type": "Function",
"label": "createChild",
"signature": [
"(options?: {}) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
}
],
"description": [
"\ncreates a new child search source"
],
"children": [
{
"id": "def-public.SearchSource.createChild.$1",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
"{}"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 226
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 226
}
},
{
"id": "def-public.SearchSource.setParent",
"type": "Function",
"label": "setParent",
"signature": [
"(parent?: Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceOptions",
"text": "SearchSourceOptions"
},
") => this"
],
"description": [
"\nSet a searchSource that this source should inherit from"
],
"children": [
{
"id": "def-public.SearchSource.setParent.$1",
"type": "Object",
"label": "parent",
"isRequired": false,
"signature": [
"Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"
],
"description": [
"- the parent searchSource"
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 238
}
},
{
"id": "def-public.SearchSource.setParent.$2",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceOptions",
"text": "SearchSourceOptions"
}
],
"description": [
"- the inherit options"
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 238
}
}
],
"tags": [
"return"
],
"returnComment": [
"- chainable"
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 238
}
},
{
"id": "def-public.SearchSource.getParent",
"type": "Function",
"label": "getParent",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
" | undefined"
],
"description": [
"\nGet the parent of this SearchSource"
],
"children": [],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 248
}
},
{
"id": "def-public.SearchSource.fetch$",
"type": "Function",
"label": "fetch$",
"signature": [
"(options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
") => ",
"Observable",
"<",
"SearchResponse",
"<any>>"
],
"description": [
"\nFetch this source from Elasticsearch, returning an observable over the response(s)"
],
"children": [
{
"id": "def-public.SearchSource.fetch$.$1",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 256
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 256
}
},
{
"id": "def-public.SearchSource.fetch",
"type": "Function",
"label": "fetch",
"signature": [
"(options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
") => Promise<",
"SearchResponse",
"<any>>"
],
"description": [
"\nFetch this source and reject the returned Promise on error"
],
"children": [
{
"id": "def-public.SearchSource.fetch.$1",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 283
}
}
],
"tags": [
"deprecated"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 283
}
},
{
"id": "def-public.SearchSource.onRequestStart",
"type": "Function",
"label": "onRequestStart",
"signature": [
"(handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined) => Promise<unknown>) => void"
],
"description": [
"\n Add a handler that will be notified whenever requests start"
],
"children": [
{
"id": "def-public.SearchSource.onRequestStart.$1",
"type": "Function",
"label": "handler",
"isRequired": true,
"signature": [
"(searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined) => Promise<unknown>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 293
}
}
],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 292
}
},
{
"id": "def-public.SearchSource.getSearchRequestBody",
"type": "Function",
"label": "getSearchRequestBody",
"signature": [
"() => Promise<any>"
],
"description": [
"\nReturns body contents of the search request, often referred as query DSL."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 301
}
},
{
"id": "def-public.SearchSource.destroy",
"type": "Function",
"label": "destroy",
"signature": [
"() => void"
],
"description": [
"\nCompletely destroy the SearchSource."
],
"children": [],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 310
}
},
{
"id": "def-public.SearchSource.getSerializedFields",
"type": "Function",
"label": "getSerializedFields",
"signature": [
"(recurse?: boolean) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
}
],
"description": [
"\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})"
],
"children": [
{
"id": "def-public.SearchSource.getSerializedFields.$1",
"type": "boolean",
"label": "recurse",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 688
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 688
}
},
{
"id": "def-public.SearchSource.serialize",
"type": "Function",
"label": "serialize",
"signature": [
"() => { searchSourceJSON: string; references: ",
"SavedObjectReference",
"[]; }"
],
"description": [
"\nSerializes the instance to a JSON string and a set of referenced objects.\nUse this method to get a representation of the search source which can be stored in a saved object.\n\nThe references returned by this function can be mixed with other references in the same object,\nhowever make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index`\nand `kibanaSavedObjectMeta.searchSourceJSON.filter[<number>].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created."
],
"children": [],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 717
}
}
],
"source": {
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"lineNumber": 103
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-public.castEsToKbnFieldTypeName",
"type": "Function",
"children": [
{
"id": "def-public.castEsToKbnFieldTypeName.$1",
"type": "string",
"label": "esType",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 39
}
}
],
"signature": [
"(esType: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [
"\n Get the KbnFieldType name for an esType string\n"
],
"label": "castEsToKbnFieldTypeName",
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 39
},
"tags": [
"return"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.extractReferences",
"type": "Function",
"children": [
{
"id": "def-public.extractReferences.$1",
"type": "Object",
"label": "state",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/extract_references.ts",
"lineNumber": 14
}
}
],
"signature": [
"(state: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
") => [",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
" & { indexRefName?: string | undefined; }, ",
"SavedObjectReference",
"[]]"
],
"description": [],
"label": "extractReferences",
"source": {
"path": "src/plugins/data/common/search/search_source/extract_references.ts",
"lineNumber": 13
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.fieldList",
"type": "Function",
"children": [
{
"id": "def-public.fieldList.$1",
"type": "Array",
"label": "specs",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 35
}
},
{
"id": "def-public.fieldList.$2",
"type": "boolean",
"label": "shortDotsEnable",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 36
}
}
],
"signature": [
"(specs?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[], shortDotsEnable?: boolean) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPatternFieldList",
"text": "IIndexPatternFieldList"
}
],
"description": [],
"label": "fieldList",
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 34
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getKbnTypeNames",
"type": "Function",
"children": [],
"signature": [
"() => string[]"
],
"description": [
"\n Get the esTypes known by all kbnFieldTypes\n"
],
"label": "getKbnTypeNames",
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 30
},
"tags": [
"return"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.getSearchParamsFromRequest",
"type": "Function",
"label": "getSearchParamsFromRequest",
"signature": [
"(searchRequest: Record<string, any>, dependencies: { getConfig: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
"; }) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchRequestParams",
"text": "ISearchRequestParams"
}
],
"description": [],
"children": [
{
"id": "def-public.getSearchParamsFromRequest.$1",
"type": "Object",
"label": "searchRequest",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
"lineNumber": 34
}
},
{
"id": "def-public.getSearchParamsFromRequest.$2.dependencies",
"type": "Object",
"label": "dependencies",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.getSearchParamsFromRequest.$2.dependencies.getConfig",
"type": "Function",
"label": "getConfig",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
"lineNumber": 35
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
}
]
}
],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
"lineNumber": 35
}
}
],
"tags": [
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
"lineNumber": 33
},
"initialIsOpen": false
},
{
"id": "def-public.getTime",
"type": "Function",
"label": "getTime",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-public.getTime.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 38
}
},
{
"id": "def-public.getTime.$2",
"type": "Object",
"label": "timeRange",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 39
}
},
{
"id": "def-public.getTime.$3.options",
"type": "Object",
"label": "options",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.getTime.$3.options.forceNow",
"type": "Object",
"label": "forceNow",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
},
"signature": [
"Date | undefined"
]
},
{
"tags": [],
"id": "def-public.getTime.$3.options.fieldName",
"type": "string",
"label": "fieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-public.injectReferences",
"type": "Function",
"children": [
{
"id": "def-public.injectReferences.$1",
"type": "CompoundType",
"label": "searchSourceFields",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
" & { indexRefName: string; }"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/inject_references.ts",
"lineNumber": 13
}
},
{
"id": "def-public.injectReferences.$2",
"type": "Array",
"label": "references",
"isRequired": true,
"signature": [
"SavedObjectReference",
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/inject_references.ts",
"lineNumber": 14
}
}
],
"signature": [
"(searchSourceFields: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
" & { indexRefName: string; }, references: ",
"SavedObjectReference",
"[]) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
}
],
"description": [],
"label": "injectReferences",
"source": {
"path": "src/plugins/data/common/search/search_source/inject_references.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.isCompleteResponse",
"type": "Function",
"children": [
{
"id": "def-public.isCompleteResponse.$1",
"type": "Object",
"label": "response",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/utils.ts",
"lineNumber": 21
}
}
],
"signature": [
"(response?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any> | undefined) => boolean"
],
"description": [],
"label": "isCompleteResponse",
"source": {
"path": "src/plugins/data/common/search/utils.ts",
"lineNumber": 21
},
"tags": [],
"returnComment": [
"true if response is completed successfully"
],
"initialIsOpen": false
},
{
"id": "def-public.isErrorResponse",
"type": "Function",
"children": [
{
"id": "def-public.isErrorResponse.$1",
"type": "Object",
"label": "response",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/utils.ts",
"lineNumber": 14
}
}
],
"signature": [
"(response?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any> | undefined) => boolean | undefined"
],
"description": [],
"label": "isErrorResponse",
"source": {
"path": "src/plugins/data/common/search/utils.ts",
"lineNumber": 14
},
"tags": [],
"returnComment": [
"true if response had an error while executing in ES"
],
"initialIsOpen": false
},
{
"id": "def-public.isFilter",
"type": "Function",
"children": [
{
"id": "def-public.isFilter.$1",
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 103
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"label": "isFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 103
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.isFilters",
"type": "Function",
"children": [
{
"id": "def-public.isFilters.$1",
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 110
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"label": "isFilters",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 110
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.isPartialResponse",
"type": "Function",
"children": [
{
"id": "def-public.isPartialResponse.$1",
"type": "Object",
"label": "response",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/utils.ts",
"lineNumber": 28
}
}
],
"signature": [
"(response?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any> | undefined) => boolean"
],
"description": [],
"label": "isPartialResponse",
"source": {
"path": "src/plugins/data/common/search/utils.ts",
"lineNumber": 28
},
"tags": [],
"returnComment": [
"true if request is still running an/d response contains partial results"
],
"initialIsOpen": false
},
{
"id": "def-public.isQuery",
"type": "Function",
"children": [
{
"id": "def-public.isQuery.$1",
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/is_query.ts",
"lineNumber": 11
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
}
],
"description": [],
"label": "isQuery",
"source": {
"path": "src/plugins/data/common/query/is_query.ts",
"lineNumber": 11
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.isTimeRange",
"type": "Function",
"children": [
{
"id": "def-public.isTimeRange.$1",
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/is_time_range.ts",
"lineNumber": 11
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"label": "isTimeRange",
"source": {
"path": "src/plugins/data/common/query/timefilter/is_time_range.ts",
"lineNumber": 11
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.parseSearchSourceJSON",
"type": "Function",
"children": [
{
"id": "def-public.parseSearchSourceJSON.$1",
"type": "string",
"label": "searchSourceJSON",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/parse_json.ts",
"lineNumber": 12
}
}
],
"signature": [
"(searchSourceJSON: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
}
],
"description": [],
"label": "parseSearchSourceJSON",
"source": {
"path": "src/plugins/data/common/search/search_source/parse_json.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.AggFunctionsMapping",
"type": "Interface",
"label": "AggFunctionsMapping",
"description": [
"\nA global list of the expression function definitions for each agg type function."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggFilter",
"type": "Object",
"label": "aggFilter",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 196
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggFilters",
"type": "Object",
"label": "aggFilters",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 197
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggSignificantTerms",
"type": "Object",
"label": "aggSignificantTerms",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 198
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggIpRange",
"type": "Object",
"label": "aggIpRange",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 199
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggDateRange",
"type": "Object",
"label": "aggDateRange",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 200
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggRange",
"type": "Object",
"label": "aggRange",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 201
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggGeoTile",
"type": "Object",
"label": "aggGeoTile",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 202
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggGeoHash",
"type": "Object",
"label": "aggGeoHash",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 203
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggHistogram",
"type": "Object",
"label": "aggHistogram",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 204
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggDateHistogram",
"type": "Object",
"label": "aggDateHistogram",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 205
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggTerms",
"type": "Object",
"label": "aggTerms",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 206
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggAvg",
"type": "Object",
"label": "aggAvg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 207
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggBucketAvg",
"type": "Object",
"label": "aggBucketAvg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 208
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggBucketMax",
"type": "Object",
"label": "aggBucketMax",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 209
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggBucketMin",
"type": "Object",
"label": "aggBucketMin",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 210
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggBucketSum",
"type": "Object",
"label": "aggBucketSum",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 211
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggFilteredMetric",
"type": "Object",
"label": "aggFilteredMetric",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 212
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggCardinality",
"type": "Object",
"label": "aggCardinality",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 213
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggCount",
"type": "Object",
"label": "aggCount",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 214
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggCumulativeSum",
"type": "Object",
"label": "aggCumulativeSum",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 215
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggDerivative",
"type": "Object",
"label": "aggDerivative",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 216
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggGeoBounds",
"type": "Object",
"label": "aggGeoBounds",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 217
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggGeoCentroid",
"type": "Object",
"label": "aggGeoCentroid",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 218
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggMax",
"type": "Object",
"label": "aggMax",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 219
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggMedian",
"type": "Object",
"label": "aggMedian",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 220
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggSinglePercentile",
"type": "Object",
"label": "aggSinglePercentile",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 221
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggMin",
"type": "Object",
"label": "aggMin",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 222
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggMovingAvg",
"type": "Object",
"label": "aggMovingAvg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 223
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggPercentileRanks",
"type": "Object",
"label": "aggPercentileRanks",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 224
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggPercentiles",
"type": "Object",
"label": "aggPercentiles",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 225
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggSerialDiff",
"type": "Object",
"label": "aggSerialDiff",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 226
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggStdDeviation",
"type": "Object",
"label": "aggStdDeviation",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 227
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggSum",
"type": "Object",
"label": "aggSum",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 228
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-public.AggFunctionsMapping.aggTopHit",
"type": "Object",
"label": "aggTopHit",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 229
},
"signature": [
"FunctionDefinition"
]
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 195
},
"initialIsOpen": false
},
{
"id": "def-public.AggParamOption",
"type": "Interface",
"label": "AggParamOption",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AggParamOption.val",
"type": "string",
"label": "val",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-public.AggParamOption.display",
"type": "string",
"label": "display",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 32
}
},
{
"id": "def-public.AggParamOption.enabled",
"type": "Function",
"label": "enabled",
"signature": [
"((agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean) | undefined"
],
"description": [],
"children": [
{
"id": "def-public.AggParamOption.enabled.$1",
"type": "Object",
"label": "agg",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 33
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 33
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 30
},
"initialIsOpen": false
},
{
"id": "def-public.ApplyGlobalFilterActionContext",
"type": "Interface",
"label": "ApplyGlobalFilterActionContext",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ApplyGlobalFilterActionContext.filters",
"type": "Array",
"label": "filters",
"description": [],
"source": {
"path": "src/plugins/data/public/actions/apply_filter_action.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.ApplyGlobalFilterActionContext.timeFieldName",
"type": "string",
"label": "timeFieldName",
"description": [],
"source": {
"path": "src/plugins/data/public/actions/apply_filter_action.ts",
"lineNumber": 20
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ApplyGlobalFilterActionContext.embeddable",
"type": "Unknown",
"label": "embeddable",
"description": [],
"source": {
"path": "src/plugins/data/public/actions/apply_filter_action.ts",
"lineNumber": 23
},
"signature": [
"unknown"
]
}
],
"source": {
"path": "src/plugins/data/public/actions/apply_filter_action.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-public.DataPublicPluginStartActions",
"type": "Interface",
"label": "DataPublicPluginStartActions",
"description": [
"\nutilities to generate filters from action context"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DataPublicPluginStartActions.createFiltersFromValueClickAction",
"type": "Function",
"label": "createFiltersFromValueClickAction",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 68
},
"signature": [
"({ data, negate, }: ",
"ValueClickDataContext",
") => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]>"
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStartActions.createFiltersFromRangeSelectAction",
"type": "Function",
"label": "createFiltersFromRangeSelectAction",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 69
},
"signature": [
"typeof ",
"createFiltersFromRangeSelectAction"
]
}
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 67
},
"initialIsOpen": false
},
{
"id": "def-public.DataPublicPluginStartUi",
"type": "Interface",
"label": "DataPublicPluginStartUi",
"description": [
"\nData plugin prewired UI components"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DataPublicPluginStartUi.IndexPatternSelect",
"type": "CompoundType",
"label": "IndexPatternSelect",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 60
},
"signature": [
"React.ComponentType<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataUiPluginApi",
"section": "def-public.IndexPatternSelectProps",
"text": "IndexPatternSelectProps"
},
">"
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStartUi.SearchBar",
"type": "CompoundType",
"label": "SearchBar",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 61
},
"signature": [
"React.ComponentType<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataUiPluginApi",
"section": "def-public.StatefulSearchBarProps",
"text": "StatefulSearchBarProps"
},
">"
]
}
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 59
},
"initialIsOpen": false
},
{
"id": "def-public.EsQueryConfig",
"type": "Interface",
"label": "EsQueryConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.EsQueryConfig.allowLeadingWildcards",
"type": "boolean",
"label": "allowLeadingWildcards",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 18
}
},
{
"tags": [],
"id": "def-public.EsQueryConfig.queryStringOptions",
"type": "Object",
"label": "queryStringOptions",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 19
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-public.EsQueryConfig.ignoreFilterIfFieldNotInIndex",
"type": "boolean",
"label": "ignoreFilterIfFieldNotInIndex",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-public.EsQueryConfig.dateFormatTZ",
"type": "string",
"label": "dateFormatTZ",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-public.FieldFormatConfig",
"type": "Interface",
"label": "FieldFormatConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FieldFormatConfig.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 63
}
},
{
"tags": [],
"id": "def-public.FieldFormatConfig.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 64
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-public.FieldFormatConfig.es",
"type": "CompoundType",
"label": "es",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 65
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 62
},
"initialIsOpen": false
},
{
"id": "def-public.IDataPluginServices",
"type": "Interface",
"label": "IDataPluginServices",
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.IDataPluginServices",
"text": "IDataPluginServices"
},
" extends Partial<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
">"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IDataPluginServices.appName",
"type": "string",
"label": "appName",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 116
}
},
{
"tags": [],
"id": "def-public.IDataPluginServices.uiSettings",
"type": "Object",
"label": "uiSettings",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 117
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IUiSettingsClient",
"text": "IUiSettingsClient"
}
]
},
{
"tags": [],
"id": "def-public.IDataPluginServices.savedObjects",
"type": "Object",
"label": "savedObjects",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 118
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsStart",
"text": "SavedObjectsStart"
}
]
},
{
"tags": [],
"id": "def-public.IDataPluginServices.notifications",
"type": "Object",
"label": "notifications",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 119
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.NotificationsStart",
"text": "NotificationsStart"
}
]
},
{
"tags": [],
"id": "def-public.IDataPluginServices.http",
"type": "Object",
"label": "http",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 120
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
]
},
{
"tags": [],
"id": "def-public.IDataPluginServices.storage",
"type": "Object",
"label": "storage",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 121
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorageWrapper",
"text": "IStorageWrapper"
},
"<any, void>"
]
},
{
"tags": [],
"id": "def-public.IDataPluginServices.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 122
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
]
},
{
"tags": [],
"id": "def-public.IDataPluginServices.usageCollection",
"type": "Object",
"label": "usageCollection",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 123
},
"signature": [
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.UsageCollectionStart",
"text": "UsageCollectionStart"
},
" | undefined"
]
}
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 115
},
"initialIsOpen": false
},
{
"id": "def-public.IEsSearchRequest",
"type": "Interface",
"label": "IEsSearchRequest",
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchRequest",
"text": "IEsSearchRequest"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchRequest",
"text": "IKibanaSearchRequest"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchRequestParams",
"text": "ISearchRequestParams"
},
">"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IEsSearchRequest.indexType",
"type": "string",
"label": "indexType",
"description": [],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-public.IFieldSubType",
"type": "Interface",
"label": "IFieldSubType",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IFieldSubType.multi",
"type": "Object",
"label": "multi",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 154
},
"signature": [
"{ parent: string; } | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldSubType.nested",
"type": "Object",
"label": "nested",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 155
},
"signature": [
"{ path: string; } | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 153
},
"initialIsOpen": false
},
{
"id": "def-public.IFieldType",
"type": "Interface",
"label": "IFieldType",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IFieldType.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-public.IFieldType.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-public.IFieldType.script",
"type": "string",
"label": "script",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 14
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.lang",
"type": "string",
"label": "lang",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 15
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.count",
"type": "number",
"label": "count",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 16
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.esTypes",
"type": "Array",
"label": "esTypes",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 19
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.aggregatable",
"type": "CompoundType",
"label": "aggregatable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 20
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.filterable",
"type": "CompoundType",
"label": "filterable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 21
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.searchable",
"type": "CompoundType",
"label": "searchable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 22
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.sortable",
"type": "CompoundType",
"label": "sortable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 23
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.visualizable",
"type": "CompoundType",
"label": "visualizable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 24
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.readFromDocValues",
"type": "CompoundType",
"label": "readFromDocValues",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 25
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.scripted",
"type": "CompoundType",
"label": "scripted",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 26
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.subType",
"type": "Object",
"label": "subType",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 27
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldSubType",
"text": "IFieldSubType"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.displayName",
"type": "string",
"label": "displayName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 28
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.customLabel",
"type": "string",
"label": "customLabel",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 29
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IFieldType.format",
"type": "Any",
"label": "format",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 30
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.IFieldType.toSpec",
"type": "Function",
"label": "toSpec",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 31
},
"signature": [
"((options?: { getFormatterForField?: ((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") | undefined; } | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.IIndexPattern",
"type": "Interface",
"label": "IIndexPattern",
"description": [
"\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IIndexPattern.fields",
"type": "Array",
"label": "fields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 32
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.IIndexPattern.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-public.IIndexPattern.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 34
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IIndexPattern.type",
"type": "string",
"label": "type",
"description": [
"\nType is used for identifying rollup indices, otherwise left undefined"
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 38
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IIndexPattern.timeFieldName",
"type": "string",
"label": "timeFieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 39
},
"signature": [
"string | undefined"
]
},
{
"id": "def-public.IIndexPattern.getTimeField",
"type": "Function",
"label": "getTimeField",
"signature": [
"(() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | undefined) | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 40
}
},
{
"tags": [],
"id": "def-public.IIndexPattern.fieldFormatMap",
"type": "Object",
"label": "fieldFormatMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 41
},
"signature": [
"Record<string, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<unknown> | undefined> | undefined"
]
},
{
"tags": [],
"id": "def-public.IIndexPattern.getFormatterForField",
"type": "Function",
"label": "getFormatterForField",
"description": [
"\nLook up a formatter for a given field"
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 45
},
"signature": [
"((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 31
},
"initialIsOpen": false
},
{
"id": "def-public.IIndexPatternFieldList",
"type": "Interface",
"label": "IIndexPatternFieldList",
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPatternFieldList",
"text": "IIndexPatternFieldList"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"description": [],
"tags": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.add",
"type": "Function",
"label": "add",
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => void"
],
"description": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.add.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 18
}
},
{
"id": "def-public.IIndexPatternFieldList.getAll",
"type": "Function",
"label": "getAll",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 19
}
},
{
"id": "def-public.IIndexPatternFieldList.getByName",
"type": "Function",
"label": "getByName",
"signature": [
"(name: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.getByName.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 20
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 20
}
},
{
"id": "def-public.IIndexPatternFieldList.getByType",
"type": "Function",
"label": "getByType",
"signature": [
"(type: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"description": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.getByType.$1",
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 21
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 21
}
},
{
"id": "def-public.IIndexPatternFieldList.remove",
"type": "Function",
"label": "remove",
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
") => void"
],
"description": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.remove.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 22
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 22
}
},
{
"id": "def-public.IIndexPatternFieldList.removeAll",
"type": "Function",
"label": "removeAll",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 23
}
},
{
"id": "def-public.IIndexPatternFieldList.replaceAll",
"type": "Function",
"label": "replaceAll",
"signature": [
"(specs: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]) => void"
],
"description": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.replaceAll.$1",
"type": "Array",
"label": "specs",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 24
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 24
}
},
{
"id": "def-public.IIndexPatternFieldList.update",
"type": "Function",
"label": "update",
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => void"
],
"description": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.update.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 25
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 25
}
},
{
"id": "def-public.IIndexPatternFieldList.toSpec",
"type": "Function",
"label": "toSpec",
"signature": [
"(options?: { getFormatterForField?: ((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") | undefined; } | undefined) => Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"description": [],
"children": [
{
"id": "def-public.IIndexPatternFieldList.toSpec.$1.options",
"type": "Object",
"label": "options",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IIndexPatternFieldList.toSpec.$1.options.getFormatterForField",
"type": "Function",
"label": "getFormatterForField",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 27
},
"signature": [
"((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 26
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 26
}
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-public.IKibanaSearchRequest",
"type": "Interface",
"label": "IKibanaSearchRequest",
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchRequest",
"text": "IKibanaSearchRequest"
},
"<Params>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IKibanaSearchRequest.id",
"type": "string",
"label": "id",
"description": [
"\nAn id can be used to uniquely identify this request."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 78
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IKibanaSearchRequest.params",
"type": "Uncategorized",
"label": "params",
"description": [],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 80
},
"signature": [
"Params | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 74
},
"initialIsOpen": false
},
{
"id": "def-public.IKibanaSearchResponse",
"type": "Interface",
"label": "IKibanaSearchResponse",
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<RawResponse>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IKibanaSearchResponse.id",
"type": "string",
"label": "id",
"description": [
"\nSome responses may contain a unique id to identify the request this response came from."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 44
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IKibanaSearchResponse.total",
"type": "number",
"label": "total",
"description": [
"\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 50
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.IKibanaSearchResponse.loaded",
"type": "number",
"label": "loaded",
"description": [
"\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 56
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.IKibanaSearchResponse.isRunning",
"type": "CompoundType",
"label": "isRunning",
"description": [
"\nIndicates whether search is still in flight"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 61
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IKibanaSearchResponse.isPartial",
"type": "CompoundType",
"label": "isPartial",
"description": [
"\nIndicates whether the results returned are complete or partial"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 66
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IKibanaSearchResponse.rawResponse",
"type": "Uncategorized",
"label": "rawResponse",
"description": [
"\nThe raw response returned by the internal search method (usually the raw ES response)"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 71
},
"signature": [
"RawResponse"
]
}
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 40
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternAttributes",
"type": "Interface",
"label": "IndexPatternAttributes",
"description": [
"\nInterface for an index pattern saved object"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternAttributes.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 54
}
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.fields",
"type": "string",
"label": "fields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 55
}
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 56
}
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.typeMeta",
"type": "string",
"label": "typeMeta",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 57
}
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.timeFieldName",
"type": "string",
"label": "timeFieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 58
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.intervalName",
"type": "string",
"label": "intervalName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 59
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.sourceFilters",
"type": "string",
"label": "sourceFilters",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 60
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.fieldFormatMap",
"type": "string",
"label": "fieldFormatMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 61
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.fieldAttrs",
"type": "string",
"label": "fieldAttrs",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 62
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.runtimeFieldMap",
"type": "string",
"label": "runtimeFieldMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 63
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternAttributes.allowNoIndex",
"type": "CompoundType",
"label": "allowNoIndex",
"description": [
"\nprevents errors when index pattern exists before indices"
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 67
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 53
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternSpec",
"type": "Interface",
"label": "IndexPatternSpec",
"description": [
"\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternSpec.id",
"type": "string",
"label": "id",
"description": [
"\nsaved object id"
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 228
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.version",
"type": "string",
"label": "version",
"description": [
"\nsaved object version string"
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 232
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 233
},
"signature": [
"string | undefined"
]
},
{
"tags": [
"deprecated"
],
"id": "def-public.IndexPatternSpec.intervalName",
"type": "string",
"label": "intervalName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 238
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.timeFieldName",
"type": "string",
"label": "timeFieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 239
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.sourceFilters",
"type": "Array",
"label": "sourceFilters",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 240
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.SourceFilter",
"text": "SourceFilter"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.fields",
"type": "Object",
"label": "fields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 241
},
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"> | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.typeMeta",
"type": "Object",
"label": "typeMeta",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 242
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.TypeMeta",
"text": "TypeMeta"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 243
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.fieldFormats",
"type": "Object",
"label": "fieldFormats",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 244
},
"signature": [
"Record<string, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>> | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.runtimeFieldMap",
"type": "Object",
"label": "runtimeFieldMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 245
},
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
"> | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.fieldAttrs",
"type": "Object",
"label": "fieldAttrs",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 246
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternSpec.allowNoIndex",
"type": "CompoundType",
"label": "allowNoIndex",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 247
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 224
},
"initialIsOpen": false
},
{
"id": "def-public.ISearchOptions",
"type": "Interface",
"label": "ISearchOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ISearchOptions.abortSignal",
"type": "Object",
"label": "abortSignal",
"description": [
"\nAn `AbortSignal` that allows the caller of `search` to abort a search request."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 87
},
"signature": [
"AbortSignal | undefined"
]
},
{
"tags": [],
"id": "def-public.ISearchOptions.strategy",
"type": "string",
"label": "strategy",
"description": [
"\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 92
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ISearchOptions.legacyHitsTotal",
"type": "CompoundType",
"label": "legacyHitsTotal",
"description": [
"\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 98
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.ISearchOptions.sessionId",
"type": "string",
"label": "sessionId",
"description": [
"\nA session ID, grouping multiple search requests into a single session."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 103
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ISearchOptions.isStored",
"type": "CompoundType",
"label": "isStored",
"description": [
"\nWhether the session is already saved (i.e. sent to background)"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 108
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.ISearchOptions.isRestore",
"type": "CompoundType",
"label": "isRestore",
"description": [
"\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 114
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.ISearchOptions.indexPattern",
"type": "Object",
"label": "indexPattern",
"description": [
"\nIndex pattern reference is used for better error messages"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 120
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 83
},
"initialIsOpen": false
},
{
"id": "def-public.ISearchStartSearchSource",
"type": "Interface",
"label": "ISearchStartSearchSource",
"description": [
"\nhigh level search service"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ISearchStartSearchSource.create",
"type": "Function",
"label": "create",
"description": [
"\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 30
},
"signature": [
"(fields?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
" | undefined) => Promise<Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">>"
]
},
{
"tags": [],
"id": "def-public.ISearchStartSearchSource.createEmpty",
"type": "Function",
"label": "createEmpty",
"description": [
"\ncreates empty {@link SearchSource}"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 34
},
"signature": [
"() => Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"
]
}
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 25
},
"initialIsOpen": false
},
{
"id": "def-public.KueryNode",
"type": "Interface",
"label": "KueryNode",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.KueryNode.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 12
},
"signature": [
"\"function\" | \"literal\" | \"namedArg\" | \"wildcard\""
]
},
{
"id": "def-public.KueryNode.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 13
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.OptionedValueProp",
"type": "Interface",
"label": "OptionedValueProp",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.OptionedValueProp.value",
"type": "string",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-public.OptionedValueProp.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-public.OptionedValueProp.disabled",
"type": "CompoundType",
"label": "disabled",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 15
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.OptionedValueProp.isCompatible",
"type": "Function",
"label": "isCompatible",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 16
},
"signature": [
"(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-public.RangeFilterParams",
"type": "Interface",
"label": "RangeFilterParams",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.RangeFilterParams.from",
"type": "CompoundType",
"label": "from",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 36
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-public.RangeFilterParams.to",
"type": "CompoundType",
"label": "to",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 37
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-public.RangeFilterParams.gt",
"type": "CompoundType",
"label": "gt",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 38
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-public.RangeFilterParams.lt",
"type": "CompoundType",
"label": "lt",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 39
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-public.RangeFilterParams.gte",
"type": "CompoundType",
"label": "gte",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 40
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-public.RangeFilterParams.lte",
"type": "CompoundType",
"label": "lte",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 41
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-public.RangeFilterParams.format",
"type": "string",
"label": "format",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 42
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 35
},
"initialIsOpen": false
},
{
"id": "def-public.RefreshInterval",
"type": "Interface",
"label": "RefreshInterval",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.RefreshInterval.pause",
"type": "boolean",
"label": "pause",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-public.RefreshInterval.value",
"type": "number",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 13
}
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.SearchError",
"type": "Interface",
"label": "SearchError",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SearchError.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
"lineNumber": 40
}
},
{
"tags": [],
"id": "def-public.SearchError.status",
"type": "string",
"label": "status",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
"lineNumber": 41
}
},
{
"tags": [],
"id": "def-public.SearchError.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
"lineNumber": 42
}
},
{
"tags": [],
"id": "def-public.SearchError.message",
"type": "string",
"label": "message",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
"lineNumber": 43
}
},
{
"tags": [],
"id": "def-public.SearchError.path",
"type": "string",
"label": "path",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
"lineNumber": 44
}
},
{
"tags": [],
"id": "def-public.SearchError.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
"lineNumber": 45
}
}
],
"source": {
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
"lineNumber": 39
},
"initialIsOpen": false
},
{
"id": "def-public.SearchSourceFields",
"type": "Interface",
"label": "SearchSourceFields",
"description": [
"\nsearch source fields"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SearchSourceFields.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 62
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.query",
"type": "Object",
"label": "query",
"description": [
"\n{@link Query}"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 66
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.filter",
"type": "CompoundType",
"label": "filter",
"description": [
"\n{@link Filter}"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 70
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | (() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined) | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.sort",
"type": "CompoundType",
"label": "sort",
"description": [
"\n{@link EsQuerySortValue}"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 74
},
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SortDirectionNumeric",
"text": "SortDirectionNumeric"
},
"> | Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SortDirectionNumeric",
"text": "SortDirectionNumeric"
},
">[] | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.highlight",
"type": "Any",
"label": "highlight",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 75
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.highlightAll",
"type": "CompoundType",
"label": "highlightAll",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 76
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.trackTotalHits",
"type": "CompoundType",
"label": "trackTotalHits",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 77
},
"signature": [
"number | boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.aggs",
"type": "Any",
"label": "aggs",
"description": [
"\n{@link AggConfigs}"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 81
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.from",
"type": "number",
"label": "from",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 82
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.size",
"type": "number",
"label": "size",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 83
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.source",
"type": "CompoundType",
"label": "source",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 84
},
"signature": [
"string | boolean | string[] | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.version",
"type": "CompoundType",
"label": "version",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 85
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.fields",
"type": "Array",
"label": "fields",
"description": [
"\nRetrieve fields via the search Fields API"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 89
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchFieldValue",
"text": "SearchFieldValue"
},
"[] | undefined"
]
},
{
"tags": [
"deprecated"
],
"id": "def-public.SearchSourceFields.fieldsFromSource",
"type": "CompoundType",
"label": "fieldsFromSource",
"description": [
"\nRetreive fields directly from _source (legacy behavior)\n"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 95
},
"signature": [
"string | boolean | string[] | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.index",
"type": "Object",
"label": "index",
"description": [
"\n{@link IndexPatternService}"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 99
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.searchAfter",
"type": "Object",
"label": "searchAfter",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 100
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.EsQuerySearchAfter",
"text": "EsQuerySearchAfter"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.timeout",
"type": "string",
"label": "timeout",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 101
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.terminate_after",
"type": "number",
"label": "terminate_after",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 102
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.SearchSourceFields.parent",
"type": "Object",
"label": "parent",
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 104
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
" | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 61
},
"initialIsOpen": false
},
{
"id": "def-public.TypeMeta",
"type": "Interface",
"label": "TypeMeta",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.TypeMeta.aggs",
"type": "Object",
"label": "aggs",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 159
},
"signature": [
"Record<string, Record<string, { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }>> | undefined"
]
},
{
"id": "def-public.TypeMeta.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 160
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 158
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-public.BUCKET_TYPES",
"type": "Enum",
"label": "BUCKET_TYPES",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-public.ES_FIELD_TYPES",
"type": "Enum",
"label": "ES_FIELD_TYPES",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-public.KBN_FIELD_TYPES",
"type": "Enum",
"label": "KBN_FIELD_TYPES",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 64
},
"initialIsOpen": false
},
{
"id": "def-public.METRIC_TYPES",
"type": "Enum",
"label": "METRIC_TYPES",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-public.SortDirection",
"type": "Enum",
"label": "SortDirection",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 39
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-public.ACTION_GLOBAL_APPLY_FILTER",
"type": "string",
"label": "ACTION_GLOBAL_APPLY_FILTER",
"description": [],
"source": {
"path": "src/plugins/data/public/actions/apply_filter_action.ts",
"lineNumber": 16
},
"signature": [
"\"ACTION_GLOBAL_APPLY_FILTER\""
],
"initialIsOpen": false
},
{
"id": "def-public.AggConfigOptions",
"type": "Type",
"label": "AggConfigOptions",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 43
},
"signature": [
"{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.AggGroupName",
"type": "Type",
"label": "AggGroupName",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 18
},
"signature": [
"\"buckets\" | \"metrics\" | \"none\""
],
"initialIsOpen": false
},
{
"id": "def-public.AggParam",
"type": "Type",
"label": "AggParam",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 28
},
"signature": [
"BaseParamType<AggConfig>"
],
"initialIsOpen": false
},
{
"id": "def-public.AggregationRestrictions",
"type": "Type",
"label": "AggregationRestrictions",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 141
},
"signature": [
"{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }"
],
"initialIsOpen": false
},
{
"id": "def-public.AggsStart",
"type": "Type",
"label": "AggsStart",
"tags": [
"public"
],
"description": [
"\nAggsStart represents the actual external contract as AggsCommonStart\nis only used internally. The difference is that AggsStart includes the\ntypings for the registry with initialized agg types.\n"
],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 129
},
"signature": [
"{ calculateAutoTimeExpression: (range: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
") => string | undefined; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise<IndexPattern | undefined>; getAggConfig: (column: DatatableColumn) => Promise<AggConfig | undefined>; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, \"type\"> & Pick<{ type: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IAggType",
"text": "IAggType"
},
"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.APPLY_FILTER_TRIGGER",
"type": "string",
"label": "APPLY_FILTER_TRIGGER",
"description": [],
"source": {
"path": "src/plugins/data/public/triggers/apply_filter_trigger.ts",
"lineNumber": 12
},
"signature": [
"\"FILTER_TRIGGER\""
],
"initialIsOpen": false
},
{
"id": "def-public.CustomFilter",
"type": "Type",
"label": "CustomFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/custom_filter.ts",
"lineNumber": 11
},
"signature": [
"Filter & { query: any; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.ES_SEARCH_STRATEGY",
"type": "string",
"label": "ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 12
},
"signature": [
"\"es\""
],
"initialIsOpen": false
},
{
"id": "def-public.EsaggsExpressionFunctionDefinition",
"type": "Type",
"label": "EsaggsExpressionFunctionDefinition",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts",
"lineNumber": 35
},
"signature": [
"ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableState",
">>"
],
"initialIsOpen": false
},
{
"id": "def-public.EsdslExpressionFunctionDefinition",
"type": "Type",
"label": "EsdslExpressionFunctionDefinition",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/esdsl.ts",
"lineNumber": 29
},
"signature": [
"ExpressionFunctionDefinition<\"esdsl\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ExecutionContextSearch",
"text": "ExecutionContextSearch"
},
"> | null, Arguments, Output, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableState"
],
"initialIsOpen": false
},
{
"id": "def-public.EsQuerySortValue",
"type": "Type",
"label": "EsQuerySortValue",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 49
},
"signature": [
"{ [x: string]: SortDirection | SortDirectionNumeric; }"
],
"initialIsOpen": false
},
{
"id": "def-public.EsRawResponseExpressionTypeDefinition",
"type": "Type",
"label": "EsRawResponseExpressionTypeDefinition",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
"lineNumber": 57
},
"signature": [
"ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse<unknown>, EsRawResponse<unknown>>"
],
"initialIsOpen": false
},
{
"id": "def-public.ExecutionContextSearch",
"type": "Type",
"label": "ExecutionContextSearch",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"lineNumber": 15
},
"signature": [
"{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.ExistsFilter",
"type": "Type",
"label": "ExistsFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 18
},
"signature": [
"Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.ExpressionFunctionKibana",
"type": "Type",
"label": "ExpressionFunctionKibana",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana.ts",
"lineNumber": 17
},
"signature": [
"ExpressionFunctionDefinition<\"kibana\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch> | null, object, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch>, ExecutionContext<Adapters, ExecutionContextSearch>>"
],
"initialIsOpen": false
},
{
"id": "def-public.ExpressionFunctionKibanaContext",
"type": "Type",
"label": "ExpressionFunctionKibanaContext",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context.ts",
"lineNumber": 34
},
"signature": [
"ExpressionFunctionDefinition<\"kibana_context\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext<Adapters, ExecutionContextSearch>>"
],
"initialIsOpen": false
},
{
"id": "def-public.ExpressionValueSearchContext",
"type": "Type",
"label": "ExpressionValueSearchContext",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"lineNumber": 21
},
"signature": [
"{ type: \"kibana_context\"; } & ExecutionContextSearch"
],
"initialIsOpen": false
},
{
"id": "def-public.FieldFormatId",
"type": "Type",
"label": "FieldFormatId",
"tags": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 75
},
"signature": [
"string"
],
"initialIsOpen": false
},
{
"id": "def-public.FieldFormatsContentType",
"type": "Type",
"label": "FieldFormatsContentType",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 14
},
"signature": [
"\"html\" | \"text\""
],
"initialIsOpen": false
},
{
"id": "def-public.FieldFormatsGetConfigFn",
"type": "Type",
"label": "FieldFormatsGetConfigFn",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 68
},
"signature": [
"(key: string, defaultOverride: T | undefined) => T"
],
"initialIsOpen": false
},
{
"id": "def-public.Filter",
"type": "Type",
"label": "Filter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 41
},
"signature": [
"{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }"
],
"initialIsOpen": false
},
{
"id": "def-public.IAggConfig",
"type": "Type",
"label": "IAggConfig",
"tags": [
"name",
"description"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 53
},
"signature": [
"AggConfig"
],
"initialIsOpen": false
},
{
"id": "def-public.IAggType",
"type": "Type",
"label": "IAggType",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
"lineNumber": 59
},
"signature": [
"AggType<AggConfig, AggParamType<AggConfig>>"
],
"initialIsOpen": false
},
{
"id": "def-public.IEsSearchResponse",
"type": "Type",
"label": "IEsSearchResponse",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 22
},
"signature": [
"IKibanaSearchResponse<estypes.SearchResponse<Source>>"
],
"initialIsOpen": false
},
{
"id": "def-public.IFieldFormat",
"type": "Type",
"label": "IFieldFormat",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 70
},
"signature": [
"FieldFormat"
],
"initialIsOpen": false
},
{
"id": "def-public.IFieldFormatsRegistry",
"type": "Type",
"label": "IFieldFormatsRegistry",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/index.ts",
"lineNumber": 11
},
"signature": [
"{ init: (getConfig: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
", metaParamsOptions?: Record<string, any>, defaultFieldConverters?: ",
"FieldFormatInstanceType",
"[]) => void; register: (fieldFormats: ",
"FieldFormatInstanceType",
"[]) => void; deserialize: ",
"FormatFactory",
"; getDefaultConfig: (fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"initialIsOpen": false
},
{
"id": "def-public.IFieldParamType",
"type": "Type",
"label": "IFieldParamType",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
"lineNumber": 24
},
"signature": [
"FieldParamType"
],
"initialIsOpen": false
},
{
"id": "def-public.IMetricAggType",
"type": "Type",
"label": "IMetricAggType",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
"lineNumber": 35
},
"signature": [
"MetricAggType<IMetricAggConfig>"
],
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternLoadExpressionFunctionDefinition",
"type": "Type",
"label": "IndexPatternLoadExpressionFunctionDefinition",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
"lineNumber": 35
},
"signature": [
"ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableState",
">>"
],
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternsContract",
"type": "Type",
"label": "IndexPatternsContract",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 642
},
"signature": [
"{ get: (id: string) => Promise<IndexPattern>; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise<IndexPattern>; find: (search: string, size?: number) => Promise<IndexPattern[]>; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<SavedObject<IndexPatternSavedObjectAttrs>[] | null | undefined>; getDefault: () => Promise<IndexPattern | null>; setDefault: (id: string, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: GetFieldsOptions) => Promise<any>; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise<any>; refreshFields: (indexPattern: IndexPattern) => Promise<void>; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record<string, FieldSpec>; savedObjectToSpec: (savedObject: SavedObject<IndexPatternAttributes>) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise<IndexPattern>; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise<IndexPattern>; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>; }"
],
"initialIsOpen": false
},
{
"id": "def-public.ISearchGeneric",
"type": "Type",
"label": "ISearchGeneric",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 13
},
"signature": [
"(request: SearchStrategyRequest, options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
" | undefined) => ",
"Observable",
"<SearchStrategyResponse>"
],
"initialIsOpen": false
},
{
"id": "def-public.ISearchSource",
"type": "Type",
"label": "ISearchSource",
"tags": [
"public"
],
"description": [
"\nsearch source interface"
],
"source": {
"path": "src/plugins/data/common/search/search_source/types.ts",
"lineNumber": 19
},
"signature": [
"{ create: () => SearchSource; history: Record<string, any>[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: <K>(field: K, value: SearchSourceFields[K]) => SearchSource; removeField: <K>(field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: <K>(field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: <K>(field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick<SearchSource, \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
") => ",
"Observable",
"<",
"SearchResponse",
"<any>>; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
},
") => Promise<",
"SearchResponse"
],
"initialIsOpen": false
},
{
"id": "def-public.KibanaContext",
"type": "Type",
"label": "KibanaContext",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"lineNumber": 32
},
"signature": [
"{ type: \"kibana_context\"; } & ExecutionContextSearch"
],
"initialIsOpen": false
},
{
"id": "def-public.MatchAllFilter",
"type": "Type",
"label": "MatchAllFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/match_all_filter.ts",
"lineNumber": 16
},
"signature": [
"Filter & { meta: MatchAllFilterMeta; match_all: any; }"
],
"initialIsOpen": false
},
{
"id": "def-public.ParsedInterval",
"type": "Type",
"label": "ParsedInterval",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
"lineNumber": 18
},
"signature": [
"{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }"
],
"initialIsOpen": false
},
{
"id": "def-public.PhraseFilter",
"type": "Type",
"label": "PhraseFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 21
},
"signature": [
"Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.PhrasesFilter",
"type": "Type",
"label": "PhrasesFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 19
},
"signature": [
"Filter & { meta: PhrasesFilterMeta; }"
],
"initialIsOpen": false
},
{
"id": "def-public.Query",
"type": "Type",
"label": "Query",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/query/types.ts",
"lineNumber": 12
},
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"initialIsOpen": false
},
{
"id": "def-public.RangeFilter",
"type": "Type",
"label": "RangeFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 60
},
"signature": [
"Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }"
],
"initialIsOpen": false
},
{
"id": "def-public.RangeFilterMeta",
"type": "Type",
"label": "RangeFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 50
},
"signature": [
"FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.TimeRange",
"type": "Type",
"label": "TimeRange",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 17
},
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-public.AggGroupLabels",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AggGroupLabels.AggGroupNames.Buckets",
"type": "string",
"label": "[AggGroupNames.Buckets]",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-public.AggGroupLabels.AggGroupNames.Metrics",
"type": "string",
"label": "[AggGroupNames.Metrics]",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 24
}
},
{
"tags": [],
"id": "def-public.AggGroupLabels.AggGroupNames.None",
"type": "string",
"label": "[AggGroupNames.None]",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 27
}
}
],
"description": [],
"label": "AggGroupLabels",
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.AggGroupNames",
"type": "Object",
"label": "AggGroupNames",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 12
},
"signature": [
"Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>"
],
"initialIsOpen": false
},
{
"id": "def-public.esFilters",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.esFilters.FilterLabel",
"type": "Function",
"label": "FilterLabel",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 57
},
"signature": [
"(props: ",
"FilterLabelProps",
") => JSX.Element"
]
},
{
"tags": [],
"id": "def-public.esFilters.FilterItem",
"type": "Function",
"label": "FilterItem",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 58
},
"signature": [
"(props: ",
"FilterItemProps",
") => JSX.Element"
]
},
{
"tags": [],
"id": "def-public.esFilters.FILTERS",
"type": "Object",
"label": "FILTERS",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 60
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FILTERS",
"text": "FILTERS"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.FilterStateStore",
"type": "Object",
"label": "FilterStateStore",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 61
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.buildEmptyFilter",
"type": "Function",
"label": "buildEmptyFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 63
},
"signature": [
"(isPinned: boolean, index?: string | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.buildPhrasesFilter",
"type": "Function",
"label": "buildPhrasesFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 64
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", params: any[], indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.buildExistsFilter",
"type": "Function",
"label": "buildExistsFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 65
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.buildPhraseFilter",
"type": "Function",
"label": "buildPhraseFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 66
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", value: any, indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.buildQueryFilter",
"type": "Function",
"label": "buildQueryFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 67
},
"signature": [
"(query: any, index: string, alias: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.QueryStringFilter",
"text": "QueryStringFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.buildRangeFilter",
"type": "Function",
"label": "buildRangeFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 68
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", params: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
},
", indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
", formattedValue?: string | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isPhraseFilter",
"type": "Function",
"label": "isPhraseFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 70
},
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isExistsFilter",
"type": "Function",
"label": "isExistsFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 71
},
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isPhrasesFilter",
"type": "Function",
"label": "isPhrasesFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 72
},
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isRangeFilter",
"type": "Function",
"label": "isRangeFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 73
},
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isMatchAllFilter",
"type": "Function",
"label": "isMatchAllFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 74
},
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MatchAllFilter",
"text": "MatchAllFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isMissingFilter",
"type": "Function",
"label": "isMissingFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 75
},
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MissingFilter",
"text": "MissingFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isQueryStringFilter",
"type": "Function",
"label": "isQueryStringFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 76
},
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.QueryStringFilter",
"text": "QueryStringFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.isFilterPinned",
"type": "Function",
"label": "isFilterPinned",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 77
},
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.esFilters.toggleFilterNegated",
"type": "Function",
"label": "toggleFilterNegated",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 79
},
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterState",
"text": "FilterState"
},
" | undefined; query?: any; }"
]
},
{
"tags": [],
"id": "def-public.esFilters.disableFilter",
"type": "Function",
"label": "disableFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 80
},
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.getPhraseFilterField",
"type": "Function",
"label": "getPhraseFilterField",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 81
},
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
},
") => string"
]
},
{
"tags": [],
"id": "def-public.esFilters.getPhraseFilterValue",
"type": "Function",
"label": "getPhraseFilterValue",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 82
},
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
},
") => PhraseFilterValue"
]
},
{
"tags": [],
"id": "def-public.esFilters.getDisplayValueFromFilter",
"type": "Function",
"label": "getDisplayValueFromFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 83
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.getDisplayValueFromFilter",
"text": "getDisplayValueFromFilter"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.compareFilters",
"type": "Function",
"label": "compareFilters",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 85
},
"signature": [
"(first: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], second: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], comparatorOptions?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.COMPARE_ALL_OPTIONS",
"type": "Object",
"label": "COMPARE_ALL_OPTIONS",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 86
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.FilterCompareOptions",
"text": "FilterCompareOptions"
}
]
},
{
"tags": [],
"id": "def-public.esFilters.generateFilters",
"type": "Function",
"label": "generateFilters",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 87
},
"signature": [
"typeof ",
"generateFilters"
]
},
{
"tags": [],
"id": "def-public.esFilters.onlyDisabledFiltersChanged",
"type": "Function",
"label": "onlyDisabledFiltersChanged",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 88
},
"signature": [
"(newFilters?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined, oldFilters?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined) => boolean"
]
},
{
"tags": [],
"id": "def-public.esFilters.changeTimeFilter",
"type": "Function",
"label": "changeTimeFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 90
},
"signature": [
"typeof ",
"changeTimeFilter"
]
},
{
"tags": [],
"id": "def-public.esFilters.convertRangeFilterToTimeRangeString",
"type": "Function",
"label": "convertRangeFilterToTimeRangeString",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 91
},
"signature": [
"typeof ",
"convertRangeFilterToTimeRangeString"
]
},
{
"tags": [],
"id": "def-public.esFilters.mapAndFlattenFilters",
"type": "Function",
"label": "mapAndFlattenFilters",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 92
},
"signature": [
"(filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.esFilters.extractTimeFilter",
"type": "Function",
"label": "extractTimeFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 93
},
"signature": [
"typeof ",
"extractTimeFilter"
]
},
{
"tags": [],
"id": "def-public.esFilters.extractTimeRange",
"type": "Function",
"label": "extractTimeRange",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 94
},
"signature": [
"typeof ",
"extractTimeRange"
]
}
],
"description": [],
"label": "esFilters",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 56
},
"initialIsOpen": false
},
{
"id": "def-public.esKuery",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.esKuery.nodeTypes",
"type": "Object",
"label": "nodeTypes",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 124
},
"signature": [
"NodeTypes"
]
},
{
"tags": [],
"id": "def-public.esKuery.fromKueryExpression",
"type": "Function",
"label": "fromKueryExpression",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 125
},
"signature": [
"(expression: any, parseOptions?: Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryParseOptions",
"text": "KueryParseOptions"
},
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
]
},
{
"tags": [],
"id": "def-public.esKuery.toElasticsearchQuery",
"type": "Function",
"label": "toElasticsearchQuery",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 126
},
"signature": [
"(node: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
", indexPattern?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, config?: Record<string, any> | undefined, context?: Record<string, any> | undefined) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
}
]
}
],
"description": [],
"label": "esKuery",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 123
},
"initialIsOpen": false
},
{
"id": "def-public.esQuery",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.esQuery.buildEsQuery",
"type": "Function",
"label": "buildEsQuery",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 130
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.buildEsQuery",
"text": "buildEsQuery"
}
]
},
{
"tags": [],
"id": "def-public.esQuery.getEsQueryConfig",
"type": "Function",
"label": "getEsQueryConfig",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 131
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.getEsQueryConfig",
"text": "getEsQueryConfig"
}
]
},
{
"tags": [],
"id": "def-public.esQuery.buildQueryFromFilters",
"type": "Function",
"label": "buildQueryFromFilters",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 132
},
"signature": [
"(filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined, indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }"
]
},
{
"tags": [],
"id": "def-public.esQuery.luceneStringToDsl",
"type": "Function",
"label": "luceneStringToDsl",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 133
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.luceneStringToDsl",
"text": "luceneStringToDsl"
}
]
},
{
"tags": [],
"id": "def-public.esQuery.decorateQuery",
"type": "Function",
"label": "decorateQuery",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 134
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.decorateQuery",
"text": "decorateQuery"
}
]
}
],
"description": [],
"label": "esQuery",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 129
},
"initialIsOpen": false
},
{
"id": "def-public.exporters",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.exporters.datatableToCSV",
"type": "Function",
"label": "datatableToCSV",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 214
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.datatableToCSV",
"text": "datatableToCSV"
}
]
},
{
"tags": [],
"id": "def-public.exporters.CSV_MIME_TYPE",
"type": "string",
"label": "CSV_MIME_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 215
}
}
],
"description": [],
"label": "exporters",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 213
},
"initialIsOpen": false
},
{
"id": "def-public.fieldFormats",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.fieldFormats.FieldFormat",
"type": "Object",
"label": "FieldFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 171
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.FieldFormatsRegistry",
"type": "Object",
"label": "FieldFormatsRegistry",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 172
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.DEFAULT_CONVERTER_COLOR",
"type": "Object",
"label": "DEFAULT_CONVERTER_COLOR",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 174
},
"signature": [
"{ range: string; regex: string; text: string; background: string; }"
]
},
{
"tags": [],
"id": "def-public.fieldFormats.HTML_CONTEXT_TYPE",
"type": "CompoundType",
"label": "HTML_CONTEXT_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 175
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.TEXT_CONTEXT_TYPE",
"type": "CompoundType",
"label": "TEXT_CONTEXT_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 176
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.FIELD_FORMAT_IDS",
"type": "Object",
"label": "FIELD_FORMAT_IDS",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 177
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.BoolFormat",
"type": "Object",
"label": "BoolFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 179
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.BoolFormat",
"text": "BoolFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.BytesFormat",
"type": "Object",
"label": "BytesFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 180
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.BytesFormat",
"text": "BytesFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.ColorFormat",
"type": "Object",
"label": "ColorFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 181
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.ColorFormat",
"text": "ColorFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.DateFormat",
"type": "Object",
"label": "DateFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 182
},
"signature": [
"typeof ",
"DateFormat"
]
},
{
"tags": [],
"id": "def-public.fieldFormats.DateNanosFormat",
"type": "Object",
"label": "DateNanosFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 183
},
"signature": [
"typeof ",
"DateNanosFormat"
]
},
{
"tags": [],
"id": "def-public.fieldFormats.DurationFormat",
"type": "Object",
"label": "DurationFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 184
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.DurationFormat",
"text": "DurationFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.IpFormat",
"type": "Object",
"label": "IpFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 185
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.IpFormat",
"text": "IpFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.NumberFormat",
"type": "Object",
"label": "NumberFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 186
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.NumberFormat",
"text": "NumberFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.PercentFormat",
"type": "Object",
"label": "PercentFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 187
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.PercentFormat",
"text": "PercentFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.RelativeDateFormat",
"type": "Object",
"label": "RelativeDateFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 188
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.RelativeDateFormat",
"text": "RelativeDateFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.SourceFormat",
"type": "Object",
"label": "SourceFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 189
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.SourceFormat",
"text": "SourceFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.StaticLookupFormat",
"type": "Object",
"label": "StaticLookupFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 190
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.StaticLookupFormat",
"text": "StaticLookupFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.UrlFormat",
"type": "Object",
"label": "UrlFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 191
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.UrlFormat",
"text": "UrlFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.StringFormat",
"type": "Object",
"label": "StringFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 192
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.StringFormat",
"text": "StringFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.TruncateFormat",
"type": "Object",
"label": "TruncateFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 193
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.TruncateFormat",
"text": "TruncateFormat"
}
]
},
{
"tags": [],
"id": "def-public.fieldFormats.HistogramFormat",
"type": "Object",
"label": "HistogramFormat",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 194
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HistogramFormat",
"text": "HistogramFormat"
}
]
}
],
"description": [],
"label": "fieldFormats",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 170
},
"initialIsOpen": false
},
{
"id": "def-public.indexPatterns",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY",
"type": "string",
"label": "ILLEGAL_CHARACTERS_KEY",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 239
}
},
{
"tags": [],
"id": "def-public.indexPatterns.CONTAINS_SPACES_KEY",
"type": "string",
"label": "CONTAINS_SPACES_KEY",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 240
}
},
{
"tags": [],
"id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE",
"type": "Array",
"label": "ILLEGAL_CHARACTERS_VISIBLE",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 241
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.indexPatterns.ILLEGAL_CHARACTERS",
"type": "Array",
"label": "ILLEGAL_CHARACTERS",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 242
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.indexPatterns.isDefault",
"type": "Function",
"label": "isDefault",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 243
},
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => boolean"
]
},
{
"tags": [],
"id": "def-public.indexPatterns.isFilterable",
"type": "Function",
"label": "isFilterable",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 244
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.isFilterable",
"text": "isFilterable"
}
]
},
{
"tags": [],
"id": "def-public.indexPatterns.isNestedField",
"type": "Function",
"label": "isNestedField",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 245
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.isNestedField",
"text": "isNestedField"
}
]
},
{
"tags": [],
"id": "def-public.indexPatterns.validate",
"type": "Function",
"label": "validate",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 246
},
"signature": [
"typeof ",
"validateIndexPattern"
]
},
{
"tags": [],
"id": "def-public.indexPatterns.flattenHitWrapper",
"type": "Function",
"label": "flattenHitWrapper",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 247
},
"signature": [
"typeof ",
"flattenHitWrapper"
]
},
{
"tags": [],
"id": "def-public.indexPatterns.formatHitProvider",
"type": "Function",
"label": "formatHitProvider",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 248
},
"signature": [
"typeof ",
"formatHitProvider"
]
}
],
"description": [],
"label": "indexPatterns",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 238
},
"initialIsOpen": false
},
{
"id": "def-public.search",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-public.search.aggs",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.search.aggs.CidrMask",
"type": "Object",
"label": "CidrMask",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 408
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.CidrMask",
"text": "CidrMask"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.dateHistogramInterval",
"type": "Function",
"label": "dateHistogramInterval",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 409
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.dateHistogramInterval",
"text": "dateHistogramInterval"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.intervalOptions",
"type": "Array",
"label": "intervalOptions",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 410
},
"signature": [
"({ display: string; val: string; enabled(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IBucketAggConfig",
"text": "IBucketAggConfig"
},
"): boolean; } | { display: string; val: string; })[]"
]
},
{
"tags": [],
"id": "def-public.search.aggs.InvalidEsCalendarIntervalError",
"type": "Object",
"label": "InvalidEsCalendarIntervalError",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 411
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.InvalidEsCalendarIntervalError",
"text": "InvalidEsCalendarIntervalError"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.InvalidEsIntervalFormatError",
"type": "Object",
"label": "InvalidEsIntervalFormatError",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 412
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.InvalidEsIntervalFormatError",
"text": "InvalidEsIntervalFormatError"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.Ipv4Address",
"type": "Object",
"label": "Ipv4Address",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 413
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.Ipv4Address",
"text": "Ipv4Address"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.isDateHistogramBucketAggConfig",
"type": "Function",
"label": "isDateHistogramBucketAggConfig",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 414
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.isDateHistogramBucketAggConfig",
"text": "isDateHistogramBucketAggConfig"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.isNumberType",
"type": "Function",
"label": "isNumberType",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 415
},
"signature": [
"(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
},
{
"tags": [],
"id": "def-public.search.aggs.isStringType",
"type": "Function",
"label": "isStringType",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 416
},
"signature": [
"(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
},
{
"tags": [],
"id": "def-public.search.aggs.isType",
"type": "Function",
"label": "isType",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 417
},
"signature": [
"(...types: string[]) => (agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
},
{
"tags": [],
"id": "def-public.search.aggs.isValidEsInterval",
"type": "Function",
"label": "isValidEsInterval",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 418
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.isValidEsInterval",
"text": "isValidEsInterval"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.isValidInterval",
"type": "Function",
"label": "isValidInterval",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 419
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.isValidInterval",
"text": "isValidInterval"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.parentPipelineType",
"type": "string",
"label": "parentPipelineType",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 420
}
},
{
"tags": [],
"id": "def-public.search.aggs.parseEsInterval",
"type": "Function",
"label": "parseEsInterval",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 421
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.parseEsInterval",
"text": "parseEsInterval"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.parseInterval",
"type": "Function",
"label": "parseInterval",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 422
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.parseInterval",
"text": "parseInterval"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.propFilter",
"type": "Function",
"label": "propFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 423
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.propFilter",
"text": "propFilter"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.siblingPipelineType",
"type": "string",
"label": "siblingPipelineType",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 424
}
},
{
"tags": [],
"id": "def-public.search.aggs.termsAggFilter",
"type": "Array",
"label": "termsAggFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 425
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.search.aggs.toAbsoluteDates",
"type": "Function",
"label": "toAbsoluteDates",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 426
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.toAbsoluteDates",
"text": "toAbsoluteDates"
}
]
},
{
"tags": [],
"id": "def-public.search.aggs.boundsDescendingRaw",
"type": "Array",
"label": "boundsDescendingRaw",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 427
},
"signature": [
"({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]"
]
},
{
"tags": [],
"id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn",
"type": "Function",
"label": "getNumberHistogramIntervalByDatatableColumn",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 428
},
"signature": [
"(column: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
") => number | undefined"
]
},
{
"tags": [],
"id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn",
"type": "Function",
"label": "getDateHistogramMetaDataByDatatableColumn",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 429
},
"signature": [
"(column: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
") => { interval: string | undefined; timeZone: string | undefined; timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; } | undefined"
]
}
],
"description": [],
"label": "aggs",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 407
}
},
{
"tags": [],
"id": "def-public.search.getRequestInspectorStats",
"type": "Function",
"label": "getRequestInspectorStats",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 431
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.getRequestInspectorStats",
"text": "getRequestInspectorStats"
}
]
},
{
"tags": [],
"id": "def-public.search.getResponseInspectorStats",
"type": "Function",
"label": "getResponseInspectorStats",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 432
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.getResponseInspectorStats",
"text": "getResponseInspectorStats"
}
]
},
{
"tags": [],
"id": "def-public.search.tabifyAggResponse",
"type": "Function",
"label": "tabifyAggResponse",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 433
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.tabifyAggResponse",
"text": "tabifyAggResponse"
}
]
},
{
"tags": [],
"id": "def-public.search.tabifyGetColumns",
"type": "Function",
"label": "tabifyGetColumns",
"description": [],
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 434
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.tabifyGetColumns",
"text": "tabifyGetColumns"
}
]
}
],
"description": [],
"label": "search",
"source": {
"path": "src/plugins/data/public/index.ts",
"lineNumber": 406
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.UI_SETTINGS",
"type": "Object",
"label": "UI_SETTINGS",
"description": [],
"source": {
"path": "src/plugins/data/common/constants.ts",
"lineNumber": 12
},
"signature": [
"{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }"
],
"initialIsOpen": false
}
],
"setup": {
"id": "def-public.DataPublicPluginSetup",
"type": "Interface",
"label": "DataPublicPluginSetup",
"description": [
"\nData plugin public Setup contract"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DataPublicPluginSetup.autocomplete",
"type": "Object",
"label": "autocomplete",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 46
},
"signature": [
"{ getQuerySuggestions: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFn",
"text": "QuerySuggestionGetFn"
},
"; }"
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginSetup.search",
"type": "Object",
"label": "search",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 47
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataSearchPluginApi",
"section": "def-public.ISearchSetup",
"text": "ISearchSetup"
}
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginSetup.fieldFormats",
"type": "Object",
"label": "fieldFormats",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 48
},
"signature": [
"Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
},
", \"register\">"
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginSetup.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 49
},
"signature": [
"{ filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; timefilter: ",
"TimefilterSetup",
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
"Observable",
"<{ changes: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.QueryStateChange",
"text": "QueryStateChange"
}
]
}
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 45
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.DataPublicPluginStart",
"type": "Interface",
"label": "DataPublicPluginStart",
"description": [
"\nData plugin public Start contract"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DataPublicPluginStart.actions",
"type": "Object",
"label": "actions",
"description": [
"\nfilter creation utilities\n{@link DataPublicPluginStartActions}"
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 80
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStartActions",
"text": "DataPublicPluginStartActions"
}
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStart.autocomplete",
"type": "Object",
"label": "autocomplete",
"description": [
"\nautocomplete service\n{@link AutocompleteStart}"
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 85
},
"signature": [
"{ getQuerySuggestions: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFn",
"text": "QuerySuggestionGetFn"
},
"; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ",
"ValueSuggestionsGetFn",
"; }"
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStart.indexPatterns",
"type": "Object",
"label": "indexPatterns",
"description": [
"\nindex patterns service\n{@link IndexPatternsContract}"
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 90
},
"signature": [
"Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternsService",
"text": "IndexPatternsService"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStart.search",
"type": "Object",
"label": "search",
"description": [
"\nsearch service\n{@link ISearchStart}"
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 95
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataSearchPluginApi",
"section": "def-public.ISearchStart",
"text": "ISearchStart"
}
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStart.fieldFormats",
"type": "CompoundType",
"label": "fieldFormats",
"description": [
"\nfield formats service\n{@link FieldFormatsStart}"
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 100
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
}
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStart.query",
"type": "Object",
"label": "query",
"description": [
"\nquery service\n{@link QueryStart}"
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 105
},
"signature": [
"{ addToQueryLog: (appName: string, { language, query }: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void; filterManager: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
"; queryString: Pick<",
"QueryStringManager",
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQueryService",
"text": "SavedQueryService"
},
"; state$: ",
"Observable"
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStart.ui",
"type": "Object",
"label": "ui",
"description": [
"\nprewired UI components\n{@link DataPublicPluginStartUi}"
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 110
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStartUi",
"text": "DataPublicPluginStartUi"
}
]
},
{
"tags": [],
"id": "def-public.DataPublicPluginStart.nowProvider",
"type": "Object",
"label": "nowProvider",
"description": [],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 112
},
"signature": [
"Pick<Pick<",
"NowProvider",
", \"get\" | \"set\" | \"reset\">, \"get\">"
]
}
],
"source": {
"path": "src/plugins/data/public/types.ts",
"lineNumber": 75
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"id": "def-server.AggParamType",
"type": "Class",
"tags": [],
"label": "AggParamType",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggParamType",
"text": "AggParamType"
},
"<TAggConfig> extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.BaseParamType",
"text": "BaseParamType"
},
"<TAggConfig>"
],
"children": [
{
"tags": [],
"id": "def-server.AggParamType.makeAgg",
"type": "Function",
"label": "makeAgg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 15
},
"signature": [
"(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
"SerializableState",
" | undefined; schema?: string | undefined; } | undefined) => TAggConfig"
]
},
{
"tags": [],
"id": "def-server.AggParamType.allowedAggs",
"type": "Array",
"label": "allowedAggs",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 16
},
"signature": [
"string[]"
]
},
{
"id": "def-server.AggParamType.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.AggParamType.Unnamed.$1",
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 18
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-server.DataServerPlugin",
"type": "Class",
"tags": [],
"label": "DataServerPlugin",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataServerPlugin",
"text": "DataServerPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginSetup",
"text": "DataPluginSetup"
},
", ",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
", ",
"DataPluginSetupDependencies"
],
"children": [
{
"id": "def-server.DataServerPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.DataServerPlugin.Unnamed.$1",
"type": "Object",
"label": "initializerContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>"
],
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 71
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 71
}
},
{
"id": "def-server.DataServerPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"DataPluginStartDependencies",
", ",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
">, { bfetch, expressions, usageCollection }: ",
"DataPluginSetupDependencies",
") => { __enhance: (enhancements: ",
"DataEnhancements"
],
"description": [],
"children": [
{
"id": "def-server.DataServerPlugin.setup.$1",
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"DataPluginStartDependencies",
", ",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 80
}
},
{
"id": "def-server.DataServerPlugin.setup.$2",
"type": "Object",
"label": "{ bfetch, expressions, usageCollection }",
"isRequired": true,
"signature": [
"DataPluginSetupDependencies"
],
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 81
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 79
}
},
{
"id": "def-server.DataServerPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
") => { fieldFormats: { fieldFormatServiceFactory: (uiSettings: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.IUiSettingsClient",
"text": "IUiSettingsClient"
},
") => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
},
">; }; indexPatterns: { indexPatternsServiceFactory: (savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, elasticsearchClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"children": [
{
"id": "def-server.DataServerPlugin.start.$1",
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 110
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 110
}
},
{
"id": "def-server.DataServerPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 124
}
}
],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 54
},
"initialIsOpen": false
},
{
"id": "def-server.IndexPattern",
"type": "Class",
"tags": [],
"label": "IndexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" implements ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"children": [
{
"tags": [],
"id": "def-server.IndexPattern.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 45
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 46
}
},
{
"tags": [],
"id": "def-server.IndexPattern.fieldFormatMap",
"type": "Object",
"label": "fieldFormatMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 47
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.typeMeta",
"type": "Object",
"label": "typeMeta",
"description": [
"\nOnly used by rollup indices, used by rollup specific endpoint to load field list"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 51
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.TypeMeta",
"text": "TypeMeta"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.fields",
"type": "CompoundType",
"label": "fields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 52
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPatternFieldList",
"text": "IIndexPatternFieldList"
},
" & { toSpec: () => Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
">; }"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.timeFieldName",
"type": "string",
"label": "timeFieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 53
},
"signature": [
"string | undefined"
]
},
{
"tags": [
"deprecated"
],
"id": "def-server.IndexPattern.intervalName",
"type": "string",
"label": "intervalName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 58
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.type",
"type": "string",
"label": "type",
"description": [
"\nType is used to identify rollup index patterns"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 62
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.formatHit",
"type": "Function",
"label": "formatHit",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 63
},
"signature": [
"{ (hit: Record<string, any>, type?: string | undefined): any; formatField: FormatFieldFn; }"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.formatField",
"type": "Function",
"label": "formatField",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 67
},
"signature": [
"FormatFieldFn"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.flattenHit",
"type": "Function",
"label": "flattenHit",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 68
},
"signature": [
"(hit: Record<string, any>, deep?: boolean | undefined) => Record<string, any>"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.metaFields",
"type": "Array",
"label": "metaFields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 69
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.version",
"type": "string",
"label": "version",
"description": [
"\nSavedObject version"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 73
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.sourceFilters",
"type": "Array",
"label": "sourceFilters",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 74
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.SourceFilter",
"text": "SourceFilter"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPattern.allowNoIndex",
"type": "boolean",
"label": "allowNoIndex",
"description": [
"\nprevents errors when index pattern exists before indices"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 84
}
},
{
"id": "def-server.IndexPattern.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.IndexPattern.Unnamed.$1",
"type": "Object",
"label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }",
"isRequired": true,
"signature": [
"IndexPatternDeps"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 86
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 86
}
},
{
"id": "def-server.IndexPattern.getOriginalSavedObjectBody",
"type": "Function",
"children": [],
"signature": [
"() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }"
],
"description": [
"\nGet last saved saved object fields"
],
"label": "getOriginalSavedObjectBody",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 128
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPattern.resetOriginalSavedObjectBody",
"type": "Function",
"children": [],
"signature": [
"() => void"
],
"description": [
"\nReset last saved saved object fields. used after saving"
],
"label": "resetOriginalSavedObjectBody",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 133
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPattern.getFieldAttrs",
"type": "Function",
"children": [],
"signature": [
"() => { [x: string]: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"; }"
],
"description": [],
"label": "getFieldAttrs",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 137
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPattern.getComputedFields",
"type": "Function",
"label": "getComputedFields",
"signature": [
"() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
">; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 162
}
},
{
"id": "def-server.IndexPattern.toSpec",
"type": "Function",
"label": "toSpec",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [
"\nCreate static representation of index pattern"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 208
}
},
{
"id": "def-server.IndexPattern.getSourceFiltering",
"type": "Function",
"label": "getSourceFiltering",
"signature": [
"() => { excludes: any[]; }"
],
"description": [
"\nGet the source filtering configuration for that index."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 230
}
},
{
"id": "def-server.IndexPattern.addScriptedField",
"type": "Function",
"label": "addScriptedField",
"signature": [
"(name: string, script: string, fieldType?: string) => Promise<void>"
],
"description": [
"\nAdd scripted field to field list\n"
],
"children": [
{
"id": "def-server.IndexPattern.addScriptedField.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"field name"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
},
{
"id": "def-server.IndexPattern.addScriptedField.$2",
"type": "string",
"label": "script",
"isRequired": true,
"signature": [
"string"
],
"description": [
"script code"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
},
{
"id": "def-server.IndexPattern.addScriptedField.$3",
"type": "string",
"label": "fieldType",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 244
}
},
{
"id": "def-server.IndexPattern.removeScriptedField",
"type": "Function",
"label": "removeScriptedField",
"signature": [
"(fieldName: string) => void"
],
"description": [
"\nRemove scripted field from field list"
],
"children": [
{
"id": "def-server.IndexPattern.removeScriptedField.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 270
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 270
}
},
{
"id": "def-server.IndexPattern.getNonScriptedFields",
"type": "Function",
"label": "getNonScriptedFields",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 277
}
},
{
"id": "def-server.IndexPattern.getScriptedFields",
"type": "Function",
"label": "getScriptedFields",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 281
}
},
{
"id": "def-server.IndexPattern.isTimeBased",
"type": "Function",
"label": "isTimeBased",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 285
}
},
{
"id": "def-server.IndexPattern.isTimeNanosBased",
"type": "Function",
"label": "isTimeNanosBased",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 289
}
},
{
"id": "def-server.IndexPattern.getTimeField",
"type": "Function",
"label": "getTimeField",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 294
}
},
{
"id": "def-server.IndexPattern.getFieldByName",
"type": "Function",
"label": "getFieldByName",
"signature": [
"(name: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-server.IndexPattern.getFieldByName.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 299
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 299
}
},
{
"id": "def-server.IndexPattern.getAggregationRestrictions",
"type": "Function",
"label": "getAggregationRestrictions",
"signature": [
"() => Record<string, Record<string, { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }>> | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 304
}
},
{
"id": "def-server.IndexPattern.getAsSavedObjectBody",
"type": "Function",
"label": "getAsSavedObjectBody",
"signature": [
"() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }"
],
"description": [
"\nReturns index pattern as saved object body for saving"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 311
}
},
{
"id": "def-server.IndexPattern.getFormatterForField",
"type": "Function",
"label": "getFormatterForField",
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"description": [
"\nProvide a field, get its formatter"
],
"children": [
{
"id": "def-server.IndexPattern.getFormatterForField.$1",
"type": "CompoundType",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 340
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 339
}
},
{
"id": "def-server.IndexPattern.addRuntimeField",
"type": "Function",
"label": "addRuntimeField",
"signature": [
"(name: string, runtimeField: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
") => void"
],
"description": [
"\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate"
],
"children": [
{
"id": "def-server.IndexPattern.addRuntimeField.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"Field name"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
}
},
{
"id": "def-server.IndexPattern.addRuntimeField.$2",
"type": "Object",
"label": "runtimeField",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
}
],
"description": [
"Runtime field definition"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
}
},
{
"id": "def-server.IndexPattern.removeRuntimeField",
"type": "Function",
"label": "removeRuntimeField",
"signature": [
"(name: string) => void"
],
"description": [
"\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate"
],
"children": [
{
"id": "def-server.IndexPattern.removeRuntimeField.$1",
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"Field name"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
}
},
{
"id": "def-server.IndexPattern.getFormatterForFieldNoDefault",
"type": "Function",
"label": "getFormatterForFieldNoDefault",
"signature": [
"(fieldname: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
" | undefined"
],
"description": [
"\nGet formatter for a given field name. Return undefined if none exists"
],
"children": [
{
"id": "def-server.IndexPattern.getFormatterForFieldNoDefault.$1",
"type": "string",
"label": "fieldname",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
}
},
{
"id": "def-server.IndexPattern.setFieldAttrs",
"type": "Function",
"label": "setFieldAttrs",
"signature": [
"<K extends \"customLabel\" | \"count\">(fieldName: string, attrName: K, value: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"[K]) => void"
],
"description": [],
"children": [
{
"id": "def-server.IndexPattern.setFieldAttrs.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 412
}
},
{
"id": "def-server.IndexPattern.setFieldAttrs.$2",
"type": "Uncategorized",
"label": "attrName",
"isRequired": true,
"signature": [
"K"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 413
}
},
{
"id": "def-server.IndexPattern.setFieldAttrs.$3",
"type": "Uncategorized",
"label": "value",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"[K]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 414
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 411
}
},
{
"id": "def-server.IndexPattern.setFieldCustomLabel",
"type": "Function",
"label": "setFieldCustomLabel",
"signature": [
"(fieldName: string, customLabel: string | null | undefined) => void"
],
"description": [],
"children": [
{
"id": "def-server.IndexPattern.setFieldCustomLabel.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
}
},
{
"id": "def-server.IndexPattern.setFieldCustomLabel.$2",
"type": "CompoundType",
"label": "customLabel",
"isRequired": false,
"signature": [
"string | null | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
}
},
{
"id": "def-server.IndexPattern.setFieldCount",
"type": "Function",
"label": "setFieldCount",
"signature": [
"(fieldName: string, count: number | null | undefined) => void"
],
"description": [],
"children": [
{
"id": "def-server.IndexPattern.setFieldCount.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
}
},
{
"id": "def-server.IndexPattern.setFieldCount.$2",
"type": "CompoundType",
"label": "count",
"isRequired": false,
"signature": [
"number | null | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
}
},
{
"id": "def-server.IndexPattern.setFieldFormat",
"type": "Function",
"children": [
{
"id": "def-server.IndexPattern.setFieldFormat.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
}
},
{
"id": "def-server.IndexPattern.setFieldFormat.$2",
"type": "Object",
"label": "format",
"isRequired": true,
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
}
}
],
"signature": [
"(fieldName: string, format: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>) => void"
],
"description": [],
"label": "setFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPattern.deleteFieldFormat",
"type": "Function",
"children": [
{
"id": "def-server.IndexPattern.deleteFieldFormat.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
}
}
],
"signature": [
"(fieldName: string) => void"
],
"description": [],
"label": "deleteFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 44
},
"initialIsOpen": false
},
{
"id": "def-server.IndexPatternsService",
"type": "Class",
"tags": [],
"label": "IndexPatternsService",
"description": [],
"children": [
{
"tags": [],
"id": "def-server.IndexPatternsService.ensureDefaultIndexPattern",
"type": "Function",
"label": "ensureDefaultIndexPattern",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 67
},
"signature": [
"EnsureDefaultIndexPattern"
]
},
{
"id": "def-server.IndexPatternsService.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.IndexPatternsService.Unnamed.$1",
"type": "Object",
"label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }",
"isRequired": true,
"signature": [
"IndexPatternsServiceDeps"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 69
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 69
}
},
{
"id": "def-server.IndexPatternsService.getIds",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getIds.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 108
}
}
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"description": [
"\nGet list of index pattern ids"
],
"label": "getIds",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 108
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getTitles",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getTitles.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 122
}
}
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"description": [
"\nGet list of index pattern titles"
],
"label": "getTitles",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 122
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.find",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.find.$1",
"type": "string",
"label": "search",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
}
},
{
"id": "def-server.IndexPatternsService.find.$2",
"type": "number",
"label": "size",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
}
}
],
"signature": [
"(search: string, size?: number) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"[]>"
],
"description": [
"\nFind and load index patterns by title"
],
"label": "find",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
},
"tags": [],
"returnComment": [
"IndexPattern[]"
]
},
{
"id": "def-server.IndexPatternsService.getIdsWithTitle",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getIdsWithTitle.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 157
}
}
],
"signature": [
"(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"
],
"description": [
"\nGet list of index pattern ids with titles"
],
"label": "getIdsWithTitle",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 156
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.clearCache",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.clearCache.$1",
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 175
}
}
],
"signature": [
"(id?: string | undefined) => void"
],
"description": [
"\nClear index pattern list cache"
],
"label": "clearCache",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 175
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getCache",
"type": "Function",
"children": [],
"signature": [
"() => Promise<",
"SavedObject",
"<",
"IndexPatternSavedObjectAttrs",
">[] | null | undefined>"
],
"description": [],
"label": "getCache",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 184
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getDefault",
"type": "Function",
"children": [],
"signature": [
"() => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | null>"
],
"description": [
"\nGet default index pattern"
],
"label": "getDefault",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 194
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.setDefault",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.setDefault.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
}
},
{
"id": "def-server.IndexPatternsService.setDefault.$2",
"type": "boolean",
"label": "force",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
}
}
],
"signature": [
"(id: string, force?: boolean) => Promise<void>"
],
"description": [
"\nOptionally set default index pattern, unless force = true"
],
"label": "setDefault",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getFieldsForWildcard",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getFieldsForWildcard.$1",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219
}
}
],
"signature": [
"(options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<any>"
],
"description": [
"\nGet field list by providing { pattern }"
],
"label": "getFieldsForWildcard",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219
},
"tags": [],
"returnComment": [
"FieldSpec[]"
]
},
{
"id": "def-server.IndexPatternsService.getFieldsForIndexPattern",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$1",
"type": "CompoundType",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 236
}
},
{
"id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$2",
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 237
}
}
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
" | undefined) => Promise<any>"
],
"description": [
"\nGet field list by providing an index patttern (or spec)"
],
"label": "getFieldsForIndexPattern",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 235
},
"tags": [],
"returnComment": [
"FieldSpec[]"
]
},
{
"id": "def-server.IndexPatternsService.refreshFields",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.refreshFields.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250
}
}
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
") => Promise<void>"
],
"description": [
"\nRefresh field list for a given index pattern"
],
"label": "refreshFields",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.fieldArrayToMap",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.fieldArrayToMap.$1",
"type": "Array",
"label": "fields",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
}
},
{
"id": "def-server.IndexPatternsService.fieldArrayToMap.$2",
"type": "Object",
"label": "fieldAttrs",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
}
}
],
"signature": [
"(fields: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[], fieldAttrs?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined) => Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
">"
],
"description": [
"\nConverts field array to map"
],
"label": "fieldArrayToMap",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
},
"tags": [],
"returnComment": [
"Record<string, FieldSpec>"
]
},
{
"id": "def-server.IndexPatternsService.savedObjectToSpec",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.savedObjectToSpec.$1",
"type": "Object",
"label": "savedObject",
"isRequired": true,
"signature": [
"SavedObject",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343
}
}
],
"signature": [
"(savedObject: ",
"SavedObject",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
},
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [
"\nConverts index pattern saved object to index pattern spec"
],
"label": "savedObjectToSpec",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343
},
"tags": [],
"returnComment": [
"IndexPatternSpec"
]
},
{
"id": "def-server.IndexPatternsService.get",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.get.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465
}
}
],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nGet an index pattern by id. Cache optimized"
],
"label": "get",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.create",
"type": "Function",
"label": "create",
"signature": [
"(spec: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", skipFetchFields?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nCreate a new index pattern instance"
],
"children": [
{
"id": "def-server.IndexPatternsService.create.$1",
"type": "Object",
"label": "spec",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
},
{
"id": "def-server.IndexPatternsService.create.$2",
"type": "boolean",
"label": "skipFetchFields",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
}
],
"tags": [],
"returnComment": [
"IndexPattern"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
},
{
"id": "def-server.IndexPatternsService.createAndSave",
"type": "Function",
"label": "createAndSave",
"signature": [
"(spec: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", override?: boolean, skipFetchFields?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nCreate a new index pattern and save it right away"
],
"children": [
{
"id": "def-server.IndexPatternsService.createAndSave.$1",
"type": "Object",
"label": "spec",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-server.IndexPatternsService.createAndSave.$2",
"type": "boolean",
"label": "override",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Overwrite if existing index pattern exists."
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-server.IndexPatternsService.createAndSave.$3",
"type": "boolean",
"label": "skipFetchFields",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Whether to skip field refresh step."
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-server.IndexPatternsService.createSavedObject",
"type": "Function",
"label": "createSavedObject",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", override?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nSave a new index pattern"
],
"children": [
{
"id": "def-server.IndexPatternsService.createSavedObject.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
},
{
"id": "def-server.IndexPatternsService.createSavedObject.$2",
"type": "boolean",
"label": "override",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Overwrite if existing index pattern exists"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
},
{
"id": "def-server.IndexPatternsService.updateSavedObject",
"type": "Function",
"label": "updateSavedObject",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>"
],
"description": [
"\nSave existing index pattern. Will attempt to merge differences if there are conflicts"
],
"children": [
{
"id": "def-server.IndexPatternsService.updateSavedObject.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 551
}
},
{
"id": "def-server.IndexPatternsService.updateSavedObject.$2",
"type": "number",
"label": "saveAttempts",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 552
}
},
{
"id": "def-server.IndexPatternsService.updateSavedObject.$3",
"type": "boolean",
"label": "ignoreErrors",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 553
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 550
}
},
{
"id": "def-server.IndexPatternsService.delete",
"type": "Function",
"label": "delete",
"signature": [
"(indexPatternId: string) => Promise<{}>"
],
"description": [
"\nDeletes an index pattern from .kibana index"
],
"children": [
{
"id": "def-server.IndexPatternsService.delete.$1",
"type": "string",
"label": "indexPatternId",
"isRequired": true,
"signature": [
"string"
],
"description": [
": Id of kibana Index Pattern to delete"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636
}
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 57
},
"initialIsOpen": false
},
{
"id": "def-server.IndexPatternsService",
"type": "Class",
"tags": [],
"label": "IndexPatternsService",
"description": [],
"children": [
{
"tags": [],
"id": "def-server.IndexPatternsService.ensureDefaultIndexPattern",
"type": "Function",
"label": "ensureDefaultIndexPattern",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 67
},
"signature": [
"EnsureDefaultIndexPattern"
]
},
{
"id": "def-server.IndexPatternsService.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.IndexPatternsService.Unnamed.$1",
"type": "Object",
"label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }",
"isRequired": true,
"signature": [
"IndexPatternsServiceDeps"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 69
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 69
}
},
{
"id": "def-server.IndexPatternsService.getIds",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getIds.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 108
}
}
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"description": [
"\nGet list of index pattern ids"
],
"label": "getIds",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 108
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getTitles",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getTitles.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 122
}
}
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"description": [
"\nGet list of index pattern titles"
],
"label": "getTitles",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 122
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.find",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.find.$1",
"type": "string",
"label": "search",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
}
},
{
"id": "def-server.IndexPatternsService.find.$2",
"type": "number",
"label": "size",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
}
}
],
"signature": [
"(search: string, size?: number) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"[]>"
],
"description": [
"\nFind and load index patterns by title"
],
"label": "find",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 138
},
"tags": [],
"returnComment": [
"IndexPattern[]"
]
},
{
"id": "def-server.IndexPatternsService.getIdsWithTitle",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getIdsWithTitle.$1",
"type": "boolean",
"label": "refresh",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 157
}
}
],
"signature": [
"(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"
],
"description": [
"\nGet list of index pattern ids with titles"
],
"label": "getIdsWithTitle",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 156
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.clearCache",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.clearCache.$1",
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 175
}
}
],
"signature": [
"(id?: string | undefined) => void"
],
"description": [
"\nClear index pattern list cache"
],
"label": "clearCache",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 175
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getCache",
"type": "Function",
"children": [],
"signature": [
"() => Promise<",
"SavedObject",
"<",
"IndexPatternSavedObjectAttrs",
">[] | null | undefined>"
],
"description": [],
"label": "getCache",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 184
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getDefault",
"type": "Function",
"children": [],
"signature": [
"() => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | null>"
],
"description": [
"\nGet default index pattern"
],
"label": "getDefault",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 194
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.setDefault",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.setDefault.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
}
},
{
"id": "def-server.IndexPatternsService.setDefault.$2",
"type": "boolean",
"label": "force",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
}
}
],
"signature": [
"(id: string, force?: boolean) => Promise<void>"
],
"description": [
"\nOptionally set default index pattern, unless force = true"
],
"label": "setDefault",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.getFieldsForWildcard",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getFieldsForWildcard.$1",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219
}
}
],
"signature": [
"(options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<any>"
],
"description": [
"\nGet field list by providing { pattern }"
],
"label": "getFieldsForWildcard",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219
},
"tags": [],
"returnComment": [
"FieldSpec[]"
]
},
{
"id": "def-server.IndexPatternsService.getFieldsForIndexPattern",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$1",
"type": "CompoundType",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 236
}
},
{
"id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$2",
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 237
}
}
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
" | undefined) => Promise<any>"
],
"description": [
"\nGet field list by providing an index patttern (or spec)"
],
"label": "getFieldsForIndexPattern",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 235
},
"tags": [],
"returnComment": [
"FieldSpec[]"
]
},
{
"id": "def-server.IndexPatternsService.refreshFields",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.refreshFields.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250
}
}
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
") => Promise<void>"
],
"description": [
"\nRefresh field list for a given index pattern"
],
"label": "refreshFields",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.fieldArrayToMap",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.fieldArrayToMap.$1",
"type": "Array",
"label": "fields",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
}
},
{
"id": "def-server.IndexPatternsService.fieldArrayToMap.$2",
"type": "Object",
"label": "fieldAttrs",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
}
}
],
"signature": [
"(fields: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[], fieldAttrs?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined) => Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
">"
],
"description": [
"\nConverts field array to map"
],
"label": "fieldArrayToMap",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327
},
"tags": [],
"returnComment": [
"Record<string, FieldSpec>"
]
},
{
"id": "def-server.IndexPatternsService.savedObjectToSpec",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.savedObjectToSpec.$1",
"type": "Object",
"label": "savedObject",
"isRequired": true,
"signature": [
"SavedObject",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343
}
}
],
"signature": [
"(savedObject: ",
"SavedObject",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
},
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [
"\nConverts index pattern saved object to index pattern spec"
],
"label": "savedObjectToSpec",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343
},
"tags": [],
"returnComment": [
"IndexPatternSpec"
]
},
{
"id": "def-server.IndexPatternsService.get",
"type": "Function",
"children": [
{
"id": "def-server.IndexPatternsService.get.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465
}
}
],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nGet an index pattern by id. Cache optimized"
],
"label": "get",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.IndexPatternsService.create",
"type": "Function",
"label": "create",
"signature": [
"(spec: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", skipFetchFields?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nCreate a new index pattern instance"
],
"children": [
{
"id": "def-server.IndexPatternsService.create.$1",
"type": "Object",
"label": "spec",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
},
{
"id": "def-server.IndexPatternsService.create.$2",
"type": "boolean",
"label": "skipFetchFields",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
}
],
"tags": [],
"returnComment": [
"IndexPattern"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484
}
},
{
"id": "def-server.IndexPatternsService.createAndSave",
"type": "Function",
"label": "createAndSave",
"signature": [
"(spec: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
},
", override?: boolean, skipFetchFields?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nCreate a new index pattern and save it right away"
],
"children": [
{
"id": "def-server.IndexPatternsService.createAndSave.$1",
"type": "Object",
"label": "spec",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-server.IndexPatternsService.createAndSave.$2",
"type": "boolean",
"label": "override",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Overwrite if existing index pattern exists."
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-server.IndexPatternsService.createAndSave.$3",
"type": "boolean",
"label": "skipFetchFields",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Whether to skip field refresh step."
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509
}
},
{
"id": "def-server.IndexPatternsService.createSavedObject",
"type": "Function",
"label": "createSavedObject",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", override?: boolean) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"description": [
"\nSave a new index pattern"
],
"children": [
{
"id": "def-server.IndexPatternsService.createSavedObject.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
},
{
"id": "def-server.IndexPatternsService.createSavedObject.$2",
"type": "boolean",
"label": "override",
"isRequired": true,
"signature": [
"boolean"
],
"description": [
"Overwrite if existing index pattern exists"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522
}
},
{
"id": "def-server.IndexPatternsService.updateSavedObject",
"type": "Function",
"label": "updateSavedObject",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>"
],
"description": [
"\nSave existing index pattern. Will attempt to merge differences if there are conflicts"
],
"children": [
{
"id": "def-server.IndexPatternsService.updateSavedObject.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 551
}
},
{
"id": "def-server.IndexPatternsService.updateSavedObject.$2",
"type": "number",
"label": "saveAttempts",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 552
}
},
{
"id": "def-server.IndexPatternsService.updateSavedObject.$3",
"type": "boolean",
"label": "ignoreErrors",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 553
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 550
}
},
{
"id": "def-server.IndexPatternsService.delete",
"type": "Function",
"label": "delete",
"signature": [
"(indexPatternId: string) => Promise<{}>"
],
"description": [
"\nDeletes an index pattern from .kibana index"
],
"children": [
{
"id": "def-server.IndexPatternsService.delete.$1",
"type": "string",
"label": "indexPatternId",
"isRequired": true,
"signature": [
"string"
],
"description": [
": Id of kibana Index Pattern to delete"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636
}
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 57
},
"initialIsOpen": false
},
{
"id": "def-server.OptionedParamType",
"type": "Class",
"tags": [],
"label": "OptionedParamType",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.OptionedParamType",
"text": "OptionedParamType"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.BaseParamType",
"text": "BaseParamType"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
">"
],
"children": [
{
"tags": [],
"id": "def-server.OptionedParamType.options",
"type": "Array",
"label": "options",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.OptionedValueProp",
"text": "OptionedValueProp"
},
"[]"
]
},
{
"id": "def-server.OptionedParamType.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.OptionedParamType.Unnamed.$1",
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 22
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 22
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 19
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-server.castEsToKbnFieldTypeName",
"type": "Function",
"children": [
{
"id": "def-server.castEsToKbnFieldTypeName.$1",
"type": "string",
"label": "esType",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 39
}
}
],
"signature": [
"(esType: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [
"\n Get the KbnFieldType name for an esType string\n"
],
"label": "castEsToKbnFieldTypeName",
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 39
},
"tags": [
"return"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.getTime",
"type": "Function",
"label": "getTime",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-server.getTime.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 38
}
},
{
"id": "def-server.getTime.$2",
"type": "Object",
"label": "timeRange",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 39
}
},
{
"id": "def-server.getTime.$3.options",
"type": "Object",
"label": "options",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-server.getTime.$3.options.forceNow",
"type": "Object",
"label": "forceNow",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
},
"signature": [
"Date | undefined"
]
},
{
"tags": [],
"id": "def-server.getTime.$3.options.fieldName",
"type": "string",
"label": "fieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 40
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-server.parseInterval",
"type": "Function",
"label": "parseInterval",
"signature": [
"(interval: string) => moment.Duration | null"
],
"description": [],
"children": [
{
"id": "def-server.parseInterval.$1",
"type": "string",
"label": "interval",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts",
"lineNumber": 29
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-server.AggFunctionsMapping",
"type": "Interface",
"label": "AggFunctionsMapping",
"description": [
"\nA global list of the expression function definitions for each agg type function."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggFilter",
"type": "Object",
"label": "aggFilter",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 196
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggFilters",
"type": "Object",
"label": "aggFilters",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 197
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggSignificantTerms",
"type": "Object",
"label": "aggSignificantTerms",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 198
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggIpRange",
"type": "Object",
"label": "aggIpRange",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 199
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggDateRange",
"type": "Object",
"label": "aggDateRange",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 200
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggRange",
"type": "Object",
"label": "aggRange",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 201
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggGeoTile",
"type": "Object",
"label": "aggGeoTile",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 202
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggGeoHash",
"type": "Object",
"label": "aggGeoHash",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 203
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggHistogram",
"type": "Object",
"label": "aggHistogram",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 204
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggDateHistogram",
"type": "Object",
"label": "aggDateHistogram",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 205
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggTerms",
"type": "Object",
"label": "aggTerms",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 206
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggAvg",
"type": "Object",
"label": "aggAvg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 207
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggBucketAvg",
"type": "Object",
"label": "aggBucketAvg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 208
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggBucketMax",
"type": "Object",
"label": "aggBucketMax",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 209
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggBucketMin",
"type": "Object",
"label": "aggBucketMin",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 210
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggBucketSum",
"type": "Object",
"label": "aggBucketSum",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 211
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggFilteredMetric",
"type": "Object",
"label": "aggFilteredMetric",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 212
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggCardinality",
"type": "Object",
"label": "aggCardinality",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 213
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggCount",
"type": "Object",
"label": "aggCount",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 214
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggCumulativeSum",
"type": "Object",
"label": "aggCumulativeSum",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 215
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggDerivative",
"type": "Object",
"label": "aggDerivative",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 216
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggGeoBounds",
"type": "Object",
"label": "aggGeoBounds",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 217
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggGeoCentroid",
"type": "Object",
"label": "aggGeoCentroid",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 218
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggMax",
"type": "Object",
"label": "aggMax",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 219
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggMedian",
"type": "Object",
"label": "aggMedian",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 220
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggSinglePercentile",
"type": "Object",
"label": "aggSinglePercentile",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 221
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggMin",
"type": "Object",
"label": "aggMin",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 222
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggMovingAvg",
"type": "Object",
"label": "aggMovingAvg",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 223
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggPercentileRanks",
"type": "Object",
"label": "aggPercentileRanks",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 224
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggPercentiles",
"type": "Object",
"label": "aggPercentiles",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 225
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggSerialDiff",
"type": "Object",
"label": "aggSerialDiff",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 226
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggStdDeviation",
"type": "Object",
"label": "aggStdDeviation",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 227
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggSum",
"type": "Object",
"label": "aggSum",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 228
},
"signature": [
"FunctionDefinition"
]
},
{
"tags": [],
"id": "def-server.AggFunctionsMapping.aggTopHit",
"type": "Object",
"label": "aggTopHit",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 229
},
"signature": [
"FunctionDefinition"
]
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/types.ts",
"lineNumber": 195
},
"initialIsOpen": false
},
{
"id": "def-server.AggParamOption",
"type": "Interface",
"label": "AggParamOption",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.AggParamOption.val",
"type": "string",
"label": "val",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-server.AggParamOption.display",
"type": "string",
"label": "display",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 32
}
},
{
"id": "def-server.AggParamOption.enabled",
"type": "Function",
"label": "enabled",
"signature": [
"((agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean) | undefined"
],
"description": [],
"children": [
{
"id": "def-server.AggParamOption.enabled.$1",
"type": "Object",
"label": "agg",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 33
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 33
}
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 30
},
"initialIsOpen": false
},
{
"id": "def-server.EsQueryConfig",
"type": "Interface",
"label": "EsQueryConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.EsQueryConfig.allowLeadingWildcards",
"type": "boolean",
"label": "allowLeadingWildcards",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 18
}
},
{
"tags": [],
"id": "def-server.EsQueryConfig.queryStringOptions",
"type": "Object",
"label": "queryStringOptions",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 19
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-server.EsQueryConfig.ignoreFilterIfFieldNotInIndex",
"type": "boolean",
"label": "ignoreFilterIfFieldNotInIndex",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-server.EsQueryConfig.dateFormatTZ",
"type": "string",
"label": "dateFormatTZ",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-server.FieldFormatConfig",
"type": "Interface",
"label": "FieldFormatConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.FieldFormatConfig.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 63
}
},
{
"tags": [],
"id": "def-server.FieldFormatConfig.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 64
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-server.FieldFormatConfig.es",
"type": "CompoundType",
"label": "es",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 65
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 62
},
"initialIsOpen": false
},
{
"id": "def-server.IEsSearchRequest",
"type": "Interface",
"label": "IEsSearchRequest",
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchRequest",
"text": "IEsSearchRequest"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchRequest",
"text": "IKibanaSearchRequest"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchRequestParams",
"text": "ISearchRequestParams"
},
">"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.IEsSearchRequest.indexType",
"type": "string",
"label": "indexType",
"description": [],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-server.IFieldSubType",
"type": "Interface",
"label": "IFieldSubType",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.IFieldSubType.multi",
"type": "Object",
"label": "multi",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 154
},
"signature": [
"{ parent: string; } | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldSubType.nested",
"type": "Object",
"label": "nested",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 155
},
"signature": [
"{ path: string; } | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 153
},
"initialIsOpen": false
},
{
"id": "def-server.IFieldType",
"type": "Interface",
"label": "IFieldType",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.IFieldType.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-server.IFieldType.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-server.IFieldType.script",
"type": "string",
"label": "script",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 14
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.lang",
"type": "string",
"label": "lang",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 15
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.count",
"type": "number",
"label": "count",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 16
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.esTypes",
"type": "Array",
"label": "esTypes",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 19
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.aggregatable",
"type": "CompoundType",
"label": "aggregatable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 20
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.filterable",
"type": "CompoundType",
"label": "filterable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 21
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.searchable",
"type": "CompoundType",
"label": "searchable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 22
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.sortable",
"type": "CompoundType",
"label": "sortable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 23
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.visualizable",
"type": "CompoundType",
"label": "visualizable",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 24
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.readFromDocValues",
"type": "CompoundType",
"label": "readFromDocValues",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 25
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.scripted",
"type": "CompoundType",
"label": "scripted",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 26
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.subType",
"type": "Object",
"label": "subType",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 27
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldSubType",
"text": "IFieldSubType"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.displayName",
"type": "string",
"label": "displayName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 28
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.customLabel",
"type": "string",
"label": "customLabel",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 29
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IFieldType.format",
"type": "Any",
"label": "format",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 30
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-server.IFieldType.toSpec",
"type": "Function",
"label": "toSpec",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 31
},
"signature": [
"((options?: { getFormatterForField?: ((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") | undefined; } | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-server.IndexPatternAttributes",
"type": "Interface",
"label": "IndexPatternAttributes",
"description": [
"\nInterface for an index pattern saved object"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.IndexPatternAttributes.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 54
}
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.fields",
"type": "string",
"label": "fields",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 55
}
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 56
}
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.typeMeta",
"type": "string",
"label": "typeMeta",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 57
}
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.timeFieldName",
"type": "string",
"label": "timeFieldName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 58
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.intervalName",
"type": "string",
"label": "intervalName",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 59
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.sourceFilters",
"type": "string",
"label": "sourceFilters",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 60
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.fieldFormatMap",
"type": "string",
"label": "fieldFormatMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 61
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.fieldAttrs",
"type": "string",
"label": "fieldAttrs",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 62
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.runtimeFieldMap",
"type": "string",
"label": "runtimeFieldMap",
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 63
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.IndexPatternAttributes.allowNoIndex",
"type": "CompoundType",
"label": "allowNoIndex",
"description": [
"\nprevents errors when index pattern exists before indices"
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 67
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/index_patterns/types.ts",
"lineNumber": 53
},
"initialIsOpen": false
},
{
"id": "def-server.ISearchOptions",
"type": "Interface",
"label": "ISearchOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.ISearchOptions.abortSignal",
"type": "Object",
"label": "abortSignal",
"description": [
"\nAn `AbortSignal` that allows the caller of `search` to abort a search request."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 87
},
"signature": [
"AbortSignal | undefined"
]
},
{
"tags": [],
"id": "def-server.ISearchOptions.strategy",
"type": "string",
"label": "strategy",
"description": [
"\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 92
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.ISearchOptions.legacyHitsTotal",
"type": "CompoundType",
"label": "legacyHitsTotal",
"description": [
"\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 98
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.ISearchOptions.sessionId",
"type": "string",
"label": "sessionId",
"description": [
"\nA session ID, grouping multiple search requests into a single session."
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 103
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.ISearchOptions.isStored",
"type": "CompoundType",
"label": "isStored",
"description": [
"\nWhether the session is already saved (i.e. sent to background)"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 108
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.ISearchOptions.isRestore",
"type": "CompoundType",
"label": "isRestore",
"description": [
"\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 114
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.ISearchOptions.indexPattern",
"type": "Object",
"label": "indexPattern",
"description": [
"\nIndex pattern reference is used for better error messages"
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 120
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/types.ts",
"lineNumber": 83
},
"initialIsOpen": false
},
{
"id": "def-server.KueryNode",
"type": "Interface",
"label": "KueryNode",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.KueryNode.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 12
},
"signature": [
"\"function\" | \"literal\" | \"namedArg\" | \"wildcard\""
]
},
{
"id": "def-server.KueryNode.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 13
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-server.OptionedValueProp",
"type": "Interface",
"label": "OptionedValueProp",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.OptionedValueProp.value",
"type": "string",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-server.OptionedValueProp.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-server.OptionedValueProp.disabled",
"type": "CompoundType",
"label": "disabled",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 15
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.OptionedValueProp.isCompatible",
"type": "Function",
"label": "isCompatible",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 16
},
"signature": [
"(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
}
],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-server.RefreshInterval",
"type": "Interface",
"label": "RefreshInterval",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.RefreshInterval.pause",
"type": "boolean",
"label": "pause",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-server.RefreshInterval.value",
"type": "number",
"label": "value",
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 13
}
}
],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 11
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-server.BUCKET_TYPES",
"type": "Enum",
"label": "BUCKET_TYPES",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-server.ES_FIELD_TYPES",
"type": "Enum",
"label": "ES_FIELD_TYPES",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-server.KBN_FIELD_TYPES",
"type": "Enum",
"label": "KBN_FIELD_TYPES",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 64
},
"initialIsOpen": false
},
{
"id": "def-server.METRIC_TYPES",
"type": "Enum",
"label": "METRIC_TYPES",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts",
"lineNumber": 9
},
"initialIsOpen": false
}
],
"misc": [
{
"id": "def-server.AggConfigOptions",
"type": "Type",
"label": "AggConfigOptions",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 43
},
"signature": [
"{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-server.AggGroupName",
"type": "Type",
"label": "AggGroupName",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 18
},
"signature": [
"\"buckets\" | \"metrics\" | \"none\""
],
"initialIsOpen": false
},
{
"id": "def-server.AggParam",
"type": "Type",
"label": "AggParam",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
"lineNumber": 28
},
"signature": [
"BaseParamType<AggConfig>"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-server.ES_SEARCH_STRATEGY",
"type": "string",
"label": "ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 12
},
"signature": [
"\"es\""
],
"initialIsOpen": false
},
{
"id": "def-server.EsaggsExpressionFunctionDefinition",
"type": "Type",
"label": "EsaggsExpressionFunctionDefinition",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts",
"lineNumber": 35
},
"signature": [
"ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableState",
">>"
],
"initialIsOpen": false
},
{
"id": "def-server.ExecutionContextSearch",
"type": "Type",
"label": "ExecutionContextSearch",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"lineNumber": 15
},
"signature": [
"{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-server.ExpressionFunctionKibana",
"type": "Type",
"label": "ExpressionFunctionKibana",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana.ts",
"lineNumber": 17
},
"signature": [
"ExpressionFunctionDefinition<\"kibana\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch> | null, object, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch>, ExecutionContext<Adapters, ExecutionContextSearch>>"
],
"initialIsOpen": false
},
{
"id": "def-server.ExpressionFunctionKibanaContext",
"type": "Type",
"label": "ExpressionFunctionKibanaContext",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context.ts",
"lineNumber": 34
},
"signature": [
"ExpressionFunctionDefinition<\"kibana_context\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext<Adapters, ExecutionContextSearch>>"
],
"initialIsOpen": false
},
{
"id": "def-server.ExpressionValueSearchContext",
"type": "Type",
"label": "ExpressionValueSearchContext",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"lineNumber": 21
},
"signature": [
"{ type: \"kibana_context\"; } & ExecutionContextSearch"
],
"initialIsOpen": false
},
{
"id": "def-server.FieldFormatsGetConfigFn",
"type": "Type",
"label": "FieldFormatsGetConfigFn",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 68
},
"signature": [
"(key: string, defaultOverride: T | undefined) => T"
],
"initialIsOpen": false
},
{
"id": "def-server.Filter",
"type": "Type",
"label": "Filter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 41
},
"signature": [
"{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }"
],
"initialIsOpen": false
},
{
"id": "def-server.IAggConfig",
"type": "Type",
"label": "IAggConfig",
"tags": [
"name",
"description"
],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"lineNumber": 53
},
"signature": [
"AggConfig"
],
"initialIsOpen": false
},
{
"id": "def-server.IAggType",
"type": "Type",
"label": "IAggType",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
"lineNumber": 59
},
"signature": [
"AggType<AggConfig, AggParamType<AggConfig>>"
],
"initialIsOpen": false
},
{
"id": "def-server.IEsSearchResponse",
"type": "Type",
"label": "IEsSearchResponse",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/es_search/types.ts",
"lineNumber": 22
},
"signature": [
"IKibanaSearchResponse<estypes.SearchResponse<Source>>"
],
"initialIsOpen": false
},
{
"id": "def-server.IFieldFormatsRegistry",
"type": "Type",
"label": "IFieldFormatsRegistry",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/index.ts",
"lineNumber": 11
},
"signature": [
"{ init: (getConfig: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
", metaParamsOptions?: Record<string, any>, defaultFieldConverters?: ",
"FieldFormatInstanceType",
"[]) => void; register: (fieldFormats: ",
"FieldFormatInstanceType",
"[]) => void; deserialize: ",
"FormatFactory",
"; getDefaultConfig: (fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"initialIsOpen": false
},
{
"id": "def-server.IFieldParamType",
"type": "Type",
"label": "IFieldParamType",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
"lineNumber": 24
},
"signature": [
"FieldParamType"
],
"initialIsOpen": false
},
{
"id": "def-server.IMetricAggType",
"type": "Type",
"label": "IMetricAggType",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
"lineNumber": 35
},
"signature": [
"MetricAggType<IMetricAggConfig>"
],
"initialIsOpen": false
},
{
"id": "def-server.IndexPatternLoadExpressionFunctionDefinition",
"type": "Type",
"label": "IndexPatternLoadExpressionFunctionDefinition",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
"lineNumber": 35
},
"signature": [
"ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableState",
">>"
],
"initialIsOpen": false
},
{
"id": "def-server.KibanaContext",
"type": "Type",
"label": "KibanaContext",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"lineNumber": 32
},
"signature": [
"{ type: \"kibana_context\"; } & ExecutionContextSearch"
],
"initialIsOpen": false
},
{
"id": "def-server.ParsedInterval",
"type": "Type",
"label": "ParsedInterval",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
"lineNumber": 18
},
"signature": [
"{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }"
],
"initialIsOpen": false
},
{
"id": "def-server.Query",
"type": "Type",
"label": "Query",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/query/types.ts",
"lineNumber": 12
},
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"initialIsOpen": false
},
{
"id": "def-server.TimeRange",
"type": "Type",
"label": "TimeRange",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/query/timefilter/types.ts",
"lineNumber": 17
},
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-server.AggGroupLabels",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.AggGroupLabels.AggGroupNames.Buckets",
"type": "string",
"label": "[AggGroupNames.Buckets]",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-server.AggGroupLabels.AggGroupNames.Metrics",
"type": "string",
"label": "[AggGroupNames.Metrics]",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 24
}
},
{
"tags": [],
"id": "def-server.AggGroupLabels.AggGroupNames.None",
"type": "string",
"label": "[AggGroupNames.None]",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 27
}
}
],
"description": [],
"label": "AggGroupLabels",
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-server.AggGroupNames",
"type": "Object",
"label": "AggGroupNames",
"description": [],
"source": {
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"lineNumber": 12
},
"signature": [
"Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>"
],
"initialIsOpen": false
},
{
"id": "def-server.esFilters",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.esFilters.buildQueryFilter",
"type": "Function",
"label": "buildQueryFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 30
},
"signature": [
"(query: any, index: string, alias: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.QueryStringFilter",
"text": "QueryStringFilter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.buildCustomFilter",
"type": "Function",
"label": "buildCustomFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 31
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.buildCustomFilter",
"text": "buildCustomFilter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.buildEmptyFilter",
"type": "Function",
"label": "buildEmptyFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 32
},
"signature": [
"(isPinned: boolean, index?: string | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.buildExistsFilter",
"type": "Function",
"label": "buildExistsFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 33
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.buildFilter",
"type": "Function",
"label": "buildFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 34
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.buildFilter",
"text": "buildFilter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.buildPhraseFilter",
"type": "Function",
"label": "buildPhraseFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 35
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", value: any, indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.buildPhrasesFilter",
"type": "Function",
"label": "buildPhrasesFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 36
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", params: any[], indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.buildRangeFilter",
"type": "Function",
"label": "buildRangeFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 37
},
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", params: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
},
", indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
", formattedValue?: string | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
}
]
},
{
"tags": [],
"id": "def-server.esFilters.isFilterDisabled",
"type": "Function",
"label": "isFilterDisabled",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 38
},
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => boolean"
]
}
],
"description": [],
"label": "esFilters",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 29
},
"initialIsOpen": false
},
{
"id": "def-server.esKuery",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.esKuery.nodeTypes",
"type": "Object",
"label": "nodeTypes",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 65
},
"signature": [
"NodeTypes"
]
},
{
"tags": [],
"id": "def-server.esKuery.fromKueryExpression",
"type": "Function",
"label": "fromKueryExpression",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 66
},
"signature": [
"(expression: any, parseOptions?: Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryParseOptions",
"text": "KueryParseOptions"
},
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
]
},
{
"tags": [],
"id": "def-server.esKuery.toElasticsearchQuery",
"type": "Function",
"label": "toElasticsearchQuery",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 67
},
"signature": [
"(node: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
", indexPattern?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, config?: Record<string, any> | undefined, context?: Record<string, any> | undefined) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
}
]
}
],
"description": [],
"label": "esKuery",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 64
},
"initialIsOpen": false
},
{
"id": "def-server.esQuery",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.esQuery.buildQueryFromFilters",
"type": "Function",
"label": "buildQueryFromFilters",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 71
},
"signature": [
"(filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined, indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }"
]
},
{
"tags": [],
"id": "def-server.esQuery.getEsQueryConfig",
"type": "Function",
"label": "getEsQueryConfig",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 72
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.getEsQueryConfig",
"text": "getEsQueryConfig"
}
]
},
{
"tags": [],
"id": "def-server.esQuery.buildEsQuery",
"type": "Function",
"label": "buildEsQuery",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 73
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.buildEsQuery",
"text": "buildEsQuery"
}
]
}
],
"description": [],
"label": "esQuery",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 70
},
"initialIsOpen": false
},
{
"id": "def-server.exporters",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.exporters.datatableToCSV",
"type": "Function",
"label": "datatableToCSV",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 47
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.datatableToCSV",
"text": "datatableToCSV"
}
]
},
{
"tags": [],
"id": "def-server.exporters.CSV_MIME_TYPE",
"type": "string",
"label": "CSV_MIME_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 48
}
}
],
"description": [],
"label": "exporters",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 46
},
"initialIsOpen": false
},
{
"id": "def-server.fieldFormats",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.fieldFormats.FieldFormatsRegistry",
"type": "Object",
"label": "FieldFormatsRegistry",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 102
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.FieldFormat",
"type": "Object",
"label": "FieldFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 103
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.BoolFormat",
"type": "Object",
"label": "BoolFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 104
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.BoolFormat",
"text": "BoolFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.BytesFormat",
"type": "Object",
"label": "BytesFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 105
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.BytesFormat",
"text": "BytesFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.ColorFormat",
"type": "Object",
"label": "ColorFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 106
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.ColorFormat",
"text": "ColorFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.DurationFormat",
"type": "Object",
"label": "DurationFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 107
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.DurationFormat",
"text": "DurationFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.IpFormat",
"type": "Object",
"label": "IpFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 108
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.IpFormat",
"text": "IpFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.NumberFormat",
"type": "Object",
"label": "NumberFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 109
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.NumberFormat",
"text": "NumberFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.PercentFormat",
"type": "Object",
"label": "PercentFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 110
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.PercentFormat",
"text": "PercentFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.RelativeDateFormat",
"type": "Object",
"label": "RelativeDateFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 111
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.RelativeDateFormat",
"text": "RelativeDateFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.SourceFormat",
"type": "Object",
"label": "SourceFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 112
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.SourceFormat",
"text": "SourceFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.StaticLookupFormat",
"type": "Object",
"label": "StaticLookupFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 113
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.StaticLookupFormat",
"text": "StaticLookupFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.UrlFormat",
"type": "Object",
"label": "UrlFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 114
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.UrlFormat",
"text": "UrlFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.StringFormat",
"type": "Object",
"label": "StringFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 115
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.StringFormat",
"text": "StringFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.TruncateFormat",
"type": "Object",
"label": "TruncateFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 116
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.TruncateFormat",
"text": "TruncateFormat"
}
]
},
{
"tags": [],
"id": "def-server.fieldFormats.HistogramFormat",
"type": "Object",
"label": "HistogramFormat",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 117
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HistogramFormat",
"text": "HistogramFormat"
}
]
}
],
"description": [],
"label": "fieldFormats",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 101
},
"initialIsOpen": false
},
{
"id": "def-server.indexPatterns",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.indexPatterns.isFilterable",
"type": "Function",
"label": "isFilterable",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 129
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.isFilterable",
"text": "isFilterable"
}
]
},
{
"tags": [],
"id": "def-server.indexPatterns.isNestedField",
"type": "Function",
"label": "isNestedField",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 130
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.isNestedField",
"text": "isNestedField"
}
]
}
],
"description": [],
"label": "indexPatterns",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 128
},
"initialIsOpen": false
},
{
"id": "def-server.search",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-server.search.aggs",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.search.aggs.CidrMask",
"type": "Object",
"label": "CidrMask",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 246
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.CidrMask",
"text": "CidrMask"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.dateHistogramInterval",
"type": "Function",
"label": "dateHistogramInterval",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 247
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.dateHistogramInterval",
"text": "dateHistogramInterval"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.intervalOptions",
"type": "Array",
"label": "intervalOptions",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 248
},
"signature": [
"({ display: string; val: string; enabled(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IBucketAggConfig",
"text": "IBucketAggConfig"
},
"): boolean; } | { display: string; val: string; })[]"
]
},
{
"tags": [],
"id": "def-server.search.aggs.InvalidEsCalendarIntervalError",
"type": "Object",
"label": "InvalidEsCalendarIntervalError",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 249
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.InvalidEsCalendarIntervalError",
"text": "InvalidEsCalendarIntervalError"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.InvalidEsIntervalFormatError",
"type": "Object",
"label": "InvalidEsIntervalFormatError",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 250
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.InvalidEsIntervalFormatError",
"text": "InvalidEsIntervalFormatError"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.Ipv4Address",
"type": "Object",
"label": "Ipv4Address",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 251
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.Ipv4Address",
"text": "Ipv4Address"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.isNumberType",
"type": "Function",
"label": "isNumberType",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 252
},
"signature": [
"(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
},
{
"tags": [],
"id": "def-server.search.aggs.isStringType",
"type": "Function",
"label": "isStringType",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 253
},
"signature": [
"(agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
},
{
"tags": [],
"id": "def-server.search.aggs.isType",
"type": "Function",
"label": "isType",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 254
},
"signature": [
"(...types: string[]) => (agg: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggConfig",
"text": "AggConfig"
},
") => boolean"
]
},
{
"tags": [],
"id": "def-server.search.aggs.isValidEsInterval",
"type": "Function",
"label": "isValidEsInterval",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 255
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.isValidEsInterval",
"text": "isValidEsInterval"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.isValidInterval",
"type": "Function",
"label": "isValidInterval",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 256
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.isValidInterval",
"text": "isValidInterval"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.parentPipelineType",
"type": "string",
"label": "parentPipelineType",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 257
}
},
{
"tags": [],
"id": "def-server.search.aggs.parseEsInterval",
"type": "Function",
"label": "parseEsInterval",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 258
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.parseEsInterval",
"text": "parseEsInterval"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.parseInterval",
"type": "Function",
"label": "parseInterval",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 259
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.parseInterval",
"text": "parseInterval"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.propFilter",
"type": "Function",
"label": "propFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 260
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.propFilter",
"text": "propFilter"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.siblingPipelineType",
"type": "string",
"label": "siblingPipelineType",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 261
}
},
{
"tags": [],
"id": "def-server.search.aggs.termsAggFilter",
"type": "Array",
"label": "termsAggFilter",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 262
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-server.search.aggs.toAbsoluteDates",
"type": "Function",
"label": "toAbsoluteDates",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 263
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.toAbsoluteDates",
"text": "toAbsoluteDates"
}
]
},
{
"tags": [],
"id": "def-server.search.aggs.calcAutoIntervalLessThan",
"type": "Function",
"label": "calcAutoIntervalLessThan",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 264
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.calcAutoIntervalLessThan",
"text": "calcAutoIntervalLessThan"
}
]
}
],
"description": [],
"label": "aggs",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 245
}
},
{
"tags": [],
"id": "def-server.search.getRequestInspectorStats",
"type": "Function",
"label": "getRequestInspectorStats",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 266
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.getRequestInspectorStats",
"text": "getRequestInspectorStats"
}
]
},
{
"tags": [],
"id": "def-server.search.getResponseInspectorStats",
"type": "Function",
"label": "getResponseInspectorStats",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 267
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.getResponseInspectorStats",
"text": "getResponseInspectorStats"
}
]
},
{
"tags": [],
"id": "def-server.search.tabifyAggResponse",
"type": "Function",
"label": "tabifyAggResponse",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 268
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.tabifyAggResponse",
"text": "tabifyAggResponse"
}
]
},
{
"tags": [],
"id": "def-server.search.tabifyGetColumns",
"type": "Function",
"label": "tabifyGetColumns",
"description": [],
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 269
},
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.tabifyGetColumns",
"text": "tabifyGetColumns"
}
]
}
],
"description": [],
"label": "search",
"source": {
"path": "src/plugins/data/server/index.ts",
"lineNumber": 244
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-server.UI_SETTINGS",
"type": "Object",
"label": "UI_SETTINGS",
"description": [],
"source": {
"path": "src/plugins/data/common/constants.ts",
"lineNumber": 12
},
"signature": [
"{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }"
],
"initialIsOpen": false
}
],
"setup": {
"id": "def-server.DataPluginSetup",
"type": "Interface",
"label": "DataPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.DataPluginSetup.search",
"type": "Object",
"label": "search",
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 29
},
"signature": [
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataSearchPluginApi",
"section": "def-server.ISearchSetup",
"text": "ISearchSetup"
}
]
},
{
"tags": [],
"id": "def-server.DataPluginSetup.fieldFormats",
"type": "Object",
"label": "fieldFormats",
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 30
},
"signature": [
"{ register: (customFieldFormat: ",
"FieldFormatInstanceType",
") => number; }"
]
}
],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 28
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.DataPluginStart",
"type": "Interface",
"label": "DataPluginStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.DataPluginStart.search",
"type": "Object",
"label": "search",
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 38
},
"signature": [
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataSearchPluginApi",
"section": "def-server.ISearchStart",
"text": "ISearchStart"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchRequest",
"text": "IEsSearchRequest"
},
", ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchResponse",
"text": "IEsSearchResponse"
},
"<any>>"
]
},
{
"tags": [],
"id": "def-server.DataPluginStart.fieldFormats",
"type": "Object",
"label": "fieldFormats",
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 39
},
"signature": [
"{ fieldFormatServiceFactory: (uiSettings: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.IUiSettingsClient",
"text": "IUiSettingsClient"
},
") => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
},
">; }"
]
},
{
"tags": [],
"id": "def-server.DataPluginStart.indexPatterns",
"type": "Object",
"label": "indexPatterns",
"description": [],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 40
},
"signature": [
"IndexPatternsServiceStart"
]
}
],
"source": {
"path": "src/plugins/data/server/plugin.ts",
"lineNumber": 37
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [
{
"id": "def-common.KbnFieldType",
"type": "Class",
"tags": [],
"label": "KbnFieldType",
"description": [],
"children": [
{
"tags": [],
"id": "def-common.KbnFieldType.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-common.KbnFieldType.sortable",
"type": "boolean",
"label": "sortable",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.KbnFieldType.filterable",
"type": "boolean",
"label": "filterable",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-common.KbnFieldType.esTypes",
"type": "Object",
"label": "esTypes",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts",
"lineNumber": 15
},
"signature": [
"readonly ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[]"
]
},
{
"id": "def-common.KbnFieldType.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.KbnFieldType.Unnamed.$1",
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
"Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KbnFieldTypeOptions",
"text": "KbnFieldTypeOptions"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts",
"lineNumber": 17
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts",
"lineNumber": 17
}
}
],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.KQLSyntaxError",
"type": "Class",
"tags": [],
"label": "KQLSyntaxError",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KQLSyntaxError",
"text": "KQLSyntaxError"
},
" extends Error"
],
"children": [
{
"tags": [],
"id": "def-common.KQLSyntaxError.shortMessage",
"type": "string",
"label": "shortMessage",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts",
"lineNumber": 42
}
},
{
"id": "def-common.KQLSyntaxError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-common.KQLSyntaxError.Unnamed.$1",
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"KQLSyntaxErrorData"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts",
"lineNumber": 44
}
},
{
"id": "def-common.KQLSyntaxError.Unnamed.$2",
"type": "Any",
"label": "expression",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts",
"lineNumber": 44
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts",
"lineNumber": 44
}
}
],
"source": {
"path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts",
"lineNumber": 41
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-common.buildCustomFilter",
"type": "Function",
"label": "buildCustomFilter",
"signature": [
"(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"children": [
{
"id": "def-common.buildCustomFilter.$1",
"type": "string",
"label": "indexPatternString",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 42
}
},
{
"id": "def-common.buildCustomFilter.$2",
"type": "Any",
"label": "queryDsl",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 43
}
},
{
"id": "def-common.buildCustomFilter.$3",
"type": "boolean",
"label": "disabled",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 44
}
},
{
"id": "def-common.buildCustomFilter.$4",
"type": "boolean",
"label": "negate",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 45
}
},
{
"id": "def-common.buildCustomFilter.$5",
"type": "CompoundType",
"label": "alias",
"isRequired": false,
"signature": [
"string | null"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 46
}
},
{
"id": "def-common.buildCustomFilter.$6",
"type": "Enum",
"label": "store",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 47
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-common.buildEmptyFilter",
"type": "Function",
"children": [
{
"id": "def-common.buildEmptyFilter.$1",
"type": "boolean",
"label": "isPinned",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 52
}
},
{
"id": "def-common.buildEmptyFilter.$2",
"type": "string",
"label": "index",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 52
}
}
],
"signature": [
"(isPinned: boolean, index?: string | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"label": "buildEmptyFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 52
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.buildEsQuery",
"type": "Function",
"label": "buildEsQuery",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, queries: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"[], filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"children": [
{
"id": "def-common.buildEsQuery.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 33
}
},
{
"id": "def-common.buildEsQuery.$2",
"type": "CompoundType",
"label": "queries",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"[]"
],
"description": [
"- a query object or array of query objects. Each query has a language property and a query property."
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 34
}
},
{
"id": "def-common.buildEsQuery.$3",
"type": "CompoundType",
"label": "filters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [
"- a filter object or array of filter objects"
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 35
}
},
{
"id": "def-common.buildEsQuery.$4",
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.EsQueryConfig",
"text": "EsQueryConfig"
}
],
"description": [
"- an objects with query:allowLeadingWildcards and query:queryString:options UI\nsettings in form of { allowLeadingWildcards, queryStringOptions }\nconfig contains dateformat:tz"
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 36
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 32
},
"initialIsOpen": false
},
{
"id": "def-common.buildExistsFilter",
"type": "Function",
"children": [
{
"id": "def-common.buildExistsFilter.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 29
}
},
{
"id": "def-common.buildExistsFilter.$2",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 29
}
}
],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
}
],
"description": [],
"label": "buildExistsFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 29
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.buildFilter",
"type": "Function",
"label": "buildFilter",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
", field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", type: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FILTERS",
"text": "FILTERS"
},
", negate: boolean, disabled: boolean, params: any, alias: string | null, store: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
" | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"children": [
{
"id": "def-common.buildFilter.$1",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 22
}
},
{
"id": "def-common.buildFilter.$2",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 23
}
},
{
"id": "def-common.buildFilter.$3",
"type": "Enum",
"label": "type",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FILTERS",
"text": "FILTERS"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 24
}
},
{
"id": "def-common.buildFilter.$4",
"type": "boolean",
"label": "negate",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 25
}
},
{
"id": "def-common.buildFilter.$5",
"type": "boolean",
"label": "disabled",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 26
}
},
{
"id": "def-common.buildFilter.$6",
"type": "Any",
"label": "params",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 27
}
},
{
"id": "def-common.buildFilter.$7",
"type": "CompoundType",
"label": "alias",
"isRequired": false,
"signature": [
"string | null"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 28
}
},
{
"id": "def-common.buildFilter.$8",
"type": "CompoundType",
"label": "store",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/build_filters.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-common.buildPhraseFilter",
"type": "Function",
"children": [
{
"id": "def-common.buildPhraseFilter.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 61
}
},
{
"id": "def-common.buildPhraseFilter.$2",
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 62
}
},
{
"id": "def-common.buildPhraseFilter.$3",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 63
}
}
],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", value: any, indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
],
"description": [],
"label": "buildPhraseFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 60
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.buildPhrasesFilter",
"type": "Function",
"children": [
{
"id": "def-common.buildPhrasesFilter.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 35
}
},
{
"id": "def-common.buildPhrasesFilter.$2",
"type": "Array",
"label": "params",
"isRequired": true,
"signature": [
"any[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 36
}
},
{
"id": "def-common.buildPhrasesFilter.$3",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 37
}
}
],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", params: any[], indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
}
],
"description": [],
"label": "buildPhrasesFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 34
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.buildQueryFilter",
"type": "Function",
"children": [
{
"id": "def-common.buildQueryFilter.$1",
"type": "Any",
"label": "query",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 26
}
},
{
"id": "def-common.buildQueryFilter.$2",
"type": "string",
"label": "index",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 26
}
},
{
"id": "def-common.buildQueryFilter.$3",
"type": "string",
"label": "alias",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 26
}
}
],
"signature": [
"(query: any, index: string, alias: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.QueryStringFilter",
"text": "QueryStringFilter"
}
],
"description": [],
"label": "buildQueryFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 26
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.buildQueryFromFilters",
"type": "Function",
"children": [
{
"id": "def-common.buildQueryFromFilters.$1",
"type": "Array",
"label": "filters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/from_filters.ts",
"lineNumber": 47
}
},
{
"id": "def-common.buildQueryFromFilters.$2",
"type": "Object",
"label": "indexPattern",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/from_filters.ts",
"lineNumber": 48
}
},
{
"id": "def-common.buildQueryFromFilters.$3",
"type": "boolean",
"label": "ignoreFilterIfFieldNotInIndex",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/from_filters.ts",
"lineNumber": 49
}
}
],
"signature": [
"(filters: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined, indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; should: never[]; must_not: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; }"
],
"description": [],
"label": "buildQueryFromFilters",
"source": {
"path": "src/plugins/data/common/es_query/es_query/from_filters.ts",
"lineNumber": 46
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.buildRangeFilter",
"type": "Function",
"children": [
{
"id": "def-common.buildRangeFilter.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 94
}
},
{
"id": "def-common.buildRangeFilter.$2",
"type": "Object",
"label": "params",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 95
}
},
{
"id": "def-common.buildRangeFilter.$3",
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 96
}
},
{
"id": "def-common.buildRangeFilter.$4",
"type": "string",
"label": "formattedValue",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 97
}
}
],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", params: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
},
", indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
", formattedValue?: string | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
}
],
"description": [],
"label": "buildRangeFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 93
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.castEsToKbnFieldTypeName",
"type": "Function",
"children": [
{
"id": "def-common.castEsToKbnFieldTypeName.$1",
"type": "string",
"label": "esType",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 39
}
}
],
"signature": [
"(esType: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [
"\n Get the KbnFieldType name for an esType string\n"
],
"label": "castEsToKbnFieldTypeName",
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 39
},
"tags": [
"return"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.cleanFilter",
"type": "Function",
"children": [
{
"id": "def-common.cleanFilter.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/index.ts",
"lineNumber": 36
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [
"\nClean out any invalid attributes from the filters"
],
"label": "cleanFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/index.ts",
"lineNumber": 36
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.datatableToCSV",
"type": "Function",
"label": "datatableToCSV",
"signature": [
"({ columns, rows }: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string"
],
"description": [],
"children": [
{
"id": "def-common.datatableToCSV.$1",
"type": "Object",
"label": "{ columns, rows }",
"isRequired": true,
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/exports/export_csv.tsx",
"lineNumber": 42
}
},
{
"id": "def-common.datatableToCSV.$2",
"type": "Object",
"label": "{ csvSeparator, quoteValues, formatFactory, raw }",
"isRequired": true,
"signature": [
"CSVOptions"
],
"description": [],
"source": {
"path": "src/plugins/data/common/exports/export_csv.tsx",
"lineNumber": 43
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/exports/export_csv.tsx",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-common.decorateQuery",
"type": "Function",
"label": "decorateQuery",
"signature": [
"(query: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
},
", queryStringOptions: string | Record<string, any>, dateFormatTZ: string | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
}
],
"description": [
"\nDecorate queries with default parameters"
],
"children": [
{
"id": "def-common.decorateQuery.$1",
"type": "CompoundType",
"label": "query",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
}
],
"description": [
"object"
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/decorate_query.ts",
"lineNumber": 22
}
},
{
"id": "def-common.decorateQuery.$2",
"type": "CompoundType",
"label": "queryStringOptions",
"isRequired": true,
"signature": [
"string | Record<string, any>"
],
"description": [
"query:queryString:options from UI settings"
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/decorate_query.ts",
"lineNumber": 23
}
},
{
"id": "def-common.decorateQuery.$3",
"type": "string",
"label": "dateFormatTZ",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [
"dateFormat:tz from UI settings"
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/decorate_query.ts",
"lineNumber": 24
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/decorate_query.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-common.disableFilter",
"type": "Function",
"children": [
{
"id": "def-common.disableFilter.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 94
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"label": "disableFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 94
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.enableFilter",
"type": "Function",
"children": [
{
"id": "def-common.enableFilter.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 91
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"label": "enableFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 91
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.fromKueryExpression",
"type": "Function",
"children": [
{
"id": "def-common.fromKueryExpression.$1",
"type": "Any",
"label": "expression",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 45
}
},
{
"id": "def-common.fromKueryExpression.$2",
"type": "Object",
"label": "parseOptions",
"isRequired": true,
"signature": [
"Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryParseOptions",
"text": "KueryParseOptions"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 46
}
}
],
"signature": [
"(expression: any, parseOptions?: Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryParseOptions",
"text": "KueryParseOptions"
},
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
],
"description": [],
"label": "fromKueryExpression",
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 44
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.fromLiteralExpression",
"type": "Function",
"children": [
{
"id": "def-common.fromLiteralExpression.$1",
"type": "Any",
"label": "expression",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 31
}
},
{
"id": "def-common.fromLiteralExpression.$2",
"type": "Object",
"label": "parseOptions",
"isRequired": true,
"signature": [
"Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryParseOptions",
"text": "KueryParseOptions"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 32
}
}
],
"signature": [
"(expression: any, parseOptions?: Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryParseOptions",
"text": "KueryParseOptions"
},
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
],
"description": [],
"label": "fromLiteralExpression",
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 30
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getDisplayValueFromFilter",
"type": "Function",
"label": "getDisplayValueFromFilter",
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
", indexPatterns: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
"[]) => string"
],
"description": [],
"children": [
{
"id": "def-common.getDisplayValueFromFilter.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_display_value.ts",
"lineNumber": 31
}
},
{
"id": "def-common.getDisplayValueFromFilter.$2",
"type": "Array",
"label": "indexPatterns",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_display_value.ts",
"lineNumber": 31
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_display_value.ts",
"lineNumber": 31
},
"initialIsOpen": false
},
{
"id": "def-common.getEsQueryConfig",
"type": "Function",
"label": "getEsQueryConfig",
"signature": [
"(config: KibanaConfig) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.EsQueryConfig",
"text": "EsQueryConfig"
}
],
"description": [],
"children": [
{
"id": "def-common.getEsQueryConfig.$1",
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
"KibanaConfig"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts",
"lineNumber": 16
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-common.getExistsFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getExistsFilterField.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 25
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
},
") => any"
],
"description": [],
"label": "getExistsFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 25
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getFilterableKbnTypeNames",
"type": "Function",
"children": [],
"signature": [
"() => string[]"
],
"description": [
"\n Get filterable KbnFieldTypes\n"
],
"label": "getFilterableKbnTypeNames",
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 50
},
"tags": [
"return"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getFilterField.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_filter_field.ts",
"lineNumber": 18
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => any"
],
"description": [],
"label": "getFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/get_filter_field.ts",
"lineNumber": 18
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getFilterParams",
"type": "Function",
"label": "getFilterParams",
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => any"
],
"description": [],
"children": [
{
"id": "def-common.getFilterParams.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_filter_params.ts",
"lineNumber": 11
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_filter_params.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.getGeoBoundingBoxFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getGeoBoundingBoxFilterField.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GeoBoundingBoxFilter",
"text": "GeoBoundingBoxFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts",
"lineNumber": 26
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GeoBoundingBoxFilter",
"text": "GeoBoundingBoxFilter"
},
") => any"
],
"description": [],
"label": "getGeoBoundingBoxFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts",
"lineNumber": 26
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getGeoPolygonFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getGeoPolygonFilterField.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GeoPolygonFilter",
"text": "GeoPolygonFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts",
"lineNumber": 25
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GeoPolygonFilter",
"text": "GeoPolygonFilter"
},
") => any"
],
"description": [],
"label": "getGeoPolygonFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts",
"lineNumber": 25
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getIndexPatternFromFilter",
"type": "Function",
"label": "getIndexPatternFromFilter",
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
", indexPatterns: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
"[]) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-common.getIndexPatternFromFilter.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts",
"lineNumber": 13
}
},
{
"id": "def-common.getIndexPatternFromFilter.$2",
"type": "Array",
"label": "indexPatterns",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-common.getKbnFieldType",
"type": "Function",
"children": [
{
"id": "def-common.getKbnFieldType.$1",
"type": "string",
"label": "typeName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 22
}
}
],
"signature": [
"(typeName: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KbnFieldType",
"text": "KbnFieldType"
}
],
"description": [
"\n Get a type object by name\n"
],
"label": "getKbnFieldType",
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 22
},
"tags": [
"return"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getKbnTypeNames",
"type": "Function",
"children": [],
"signature": [
"() => string[]"
],
"description": [
"\n Get the esTypes known by all kbnFieldTypes\n"
],
"label": "getKbnTypeNames",
"source": {
"path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts",
"lineNumber": 30
},
"tags": [
"return"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getMissingFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getMissingFilterField.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MissingFilter",
"text": "MissingFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/missing_filter.ts",
"lineNumber": 20
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MissingFilter",
"text": "MissingFilter"
},
") => any"
],
"description": [],
"label": "getMissingFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/missing_filter.ts",
"lineNumber": 20
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getPhraseFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getPhraseFilterField.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 49
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
},
") => string"
],
"description": [],
"label": "getPhraseFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 49
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getPhraseFilterValue",
"type": "Function",
"children": [
{
"id": "def-common.getPhraseFilterValue.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 54
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
},
") => PhraseFilterValue"
],
"description": [],
"label": "getPhraseFilterValue",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 54
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getPhraseScript",
"type": "Function",
"children": [
{
"id": "def-common.getPhraseScript.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 84
}
},
{
"id": "def-common.getPhraseScript.$2",
"type": "string",
"label": "value",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 84
}
}
],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", value: string) => { script: { source: string; lang: string | undefined; params: { value: any; }; }; }"
],
"description": [],
"label": "getPhraseScript",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 84
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getPhrasesFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getPhrasesFilterField.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 26
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
},
") => string | undefined"
],
"description": [],
"label": "getPhrasesFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 26
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getRangeFilterField",
"type": "Function",
"children": [
{
"id": "def-common.getRangeFilterField.$1",
"type": "CompoundType",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 81
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
},
") => string"
],
"description": [],
"label": "getRangeFilterField",
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 81
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.getRangeScript",
"type": "Function",
"children": [
{
"id": "def-common.getRangeScript.$1",
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 140
}
},
{
"id": "def-common.getRangeScript.$2",
"type": "Object",
"label": "params",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 140
}
}
],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
", params: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
},
") => { script: { source: string; params: Partial<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
},
">; lang: string | undefined; }; }"
],
"description": [],
"label": "getRangeScript",
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 140
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isExistsFilter",
"type": "Function",
"children": [
{
"id": "def-common.isExistsFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 23
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
}
],
"description": [],
"label": "isExistsFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 23
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isFilter",
"type": "Function",
"children": [
{
"id": "def-common.isFilter.$1",
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 103
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"label": "isFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 103
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isFilterDisabled",
"type": "Function",
"children": [
{
"id": "def-common.isFilterDisabled.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/index.ts",
"lineNumber": 38
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => boolean"
],
"description": [],
"label": "isFilterDisabled",
"source": {
"path": "src/plugins/data/common/es_query/filters/index.ts",
"lineNumber": 38
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isFilterPinned",
"type": "Function",
"children": [
{
"id": "def-common.isFilterPinned.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 66
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => boolean | undefined"
],
"description": [],
"label": "isFilterPinned",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 66
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isFilters",
"type": "Function",
"children": [
{
"id": "def-common.isFilters.$1",
"type": "Unknown",
"label": "x",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 110
}
}
],
"signature": [
"(x: unknown) => x is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"description": [],
"label": "isFilters",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 110
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isGeoBoundingBoxFilter",
"type": "Function",
"children": [
{
"id": "def-common.isGeoBoundingBoxFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts",
"lineNumber": 23
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GeoBoundingBoxFilter",
"text": "GeoBoundingBoxFilter"
}
],
"description": [],
"label": "isGeoBoundingBoxFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts",
"lineNumber": 23
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isGeoPolygonFilter",
"type": "Function",
"children": [
{
"id": "def-common.isGeoPolygonFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts",
"lineNumber": 22
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GeoPolygonFilter",
"text": "GeoPolygonFilter"
}
],
"description": [],
"label": "isGeoPolygonFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts",
"lineNumber": 22
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isMatchAllFilter",
"type": "Function",
"children": [
{
"id": "def-common.isMatchAllFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/match_all_filter.ts",
"lineNumber": 21
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MatchAllFilter",
"text": "MatchAllFilter"
}
],
"description": [],
"label": "isMatchAllFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/match_all_filter.ts",
"lineNumber": 21
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isMissingFilter",
"type": "Function",
"children": [
{
"id": "def-common.isMissingFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/missing_filter.ts",
"lineNumber": 18
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MissingFilter",
"text": "MissingFilter"
}
],
"description": [],
"label": "isMissingFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/missing_filter.ts",
"lineNumber": 18
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isPhraseFilter",
"type": "Function",
"children": [
{
"id": "def-common.isPhraseFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 34
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
],
"description": [],
"label": "isPhraseFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 34
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isPhrasesFilter",
"type": "Function",
"children": [
{
"id": "def-common.isPhrasesFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 23
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
}
],
"description": [],
"label": "isPhrasesFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 23
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isQueryStringFilter",
"type": "Function",
"children": [
{
"id": "def-common.isQueryStringFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 22
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.QueryStringFilter",
"text": "QueryStringFilter"
}
],
"description": [],
"label": "isQueryStringFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 22
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isRangeFilter",
"type": "Function",
"children": [
{
"id": "def-common.isRangeFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 73
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
}
],
"description": [],
"label": "isRangeFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 73
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isScriptedPhraseFilter",
"type": "Function",
"children": [
{
"id": "def-common.isScriptedPhraseFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 46
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
}
],
"description": [],
"label": "isScriptedPhraseFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 46
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isScriptedRangeFilter",
"type": "Function",
"children": [
{
"id": "def-common.isScriptedRangeFilter.$1",
"type": "Any",
"label": "filter",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 75
}
}
],
"signature": [
"(filter: any) => filter is ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
}
],
"description": [],
"label": "isScriptedRangeFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 75
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.luceneStringToDsl",
"type": "Function",
"label": "luceneStringToDsl",
"signature": [
"(query: any) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.DslQuery",
"text": "DslQuery"
}
],
"description": [],
"children": [
{
"id": "def-common.luceneStringToDsl.$1",
"type": "Any",
"label": "query",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts",
"lineNumber": 12
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-common.pinFilter",
"type": "Function",
"children": [
{
"id": "def-common.pinFilter.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 97
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"label": "pinFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 97
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.shortenDottedString",
"type": "Function",
"label": "shortenDottedString",
"signature": [
"(input: any) => any"
],
"description": [
"\nConvert a dot.notated.string into a short\nversion (d.n.string)\n"
],
"children": [
{
"id": "def-common.shortenDottedString.$1",
"type": "Any",
"label": "input",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/utils/shorten_dotted_string.ts",
"lineNumber": 17
}
}
],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/utils/shorten_dotted_string.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-common.toElasticsearchQuery",
"type": "Function",
"children": [
{
"id": "def-common.toElasticsearchQuery.$1",
"type": "Object",
"label": "node",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 67
}
},
{
"id": "def-common.toElasticsearchQuery.$2",
"type": "Object",
"label": "indexPattern",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 68
}
},
{
"id": "def-common.toElasticsearchQuery.$3",
"type": "Object",
"label": "config",
"isRequired": false,
"signature": [
"Record<string, any> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 69
}
},
{
"id": "def-common.toElasticsearchQuery.$4",
"type": "Object",
"label": "context",
"isRequired": false,
"signature": [
"Record<string, any> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 70
}
}
],
"signature": [
"(node: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
", indexPattern?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | undefined, config?: Record<string, any> | undefined, context?: Record<string, any> | undefined) => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.JsonObject",
"text": "JsonObject"
}
],
"description": [],
"label": "toElasticsearchQuery",
"source": {
"path": "src/plugins/data/common/es_query/kuery/ast/ast.ts",
"lineNumber": 66
},
"tags": [
"params"
],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.toggleFilterDisabled",
"type": "Function",
"children": [
{
"id": "def-common.toggleFilterDisabled.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 70
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => { meta: { disabled: boolean; alias: string | null; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterState",
"text": "FilterState"
},
" | undefined; query?: any; }"
],
"description": [],
"label": "toggleFilterDisabled",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 70
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.toggleFilterNegated",
"type": "Function",
"children": [
{
"id": "def-common.toggleFilterNegated.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 77
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterState",
"text": "FilterState"
},
" | undefined; query?: any; }"
],
"description": [],
"label": "toggleFilterNegated",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 77
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.toggleFilterPinned",
"type": "Function",
"children": [
{
"id": "def-common.toggleFilterPinned.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 84
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => { $state: { store: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
"; }; meta: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterMeta",
"text": "FilterMeta"
},
"; query?: any; }"
],
"description": [],
"label": "toggleFilterPinned",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 84
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.unpinFilter",
"type": "Function",
"children": [
{
"id": "def-common.unpinFilter.$1",
"type": "Object",
"label": "filter",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 100
}
}
],
"signature": [
"(filter: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"description": [],
"label": "unpinFilter",
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 100
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.EsQueryConfig",
"type": "Interface",
"label": "EsQueryConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.EsQueryConfig.allowLeadingWildcards",
"type": "boolean",
"label": "allowLeadingWildcards",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 18
}
},
{
"tags": [],
"id": "def-common.EsQueryConfig.queryStringOptions",
"type": "Object",
"label": "queryStringOptions",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 19
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-common.EsQueryConfig.ignoreFilterIfFieldNotInIndex",
"type": "boolean",
"label": "ignoreFilterIfFieldNotInIndex",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.EsQueryConfig.dateFormatTZ",
"type": "string",
"label": "dateFormatTZ",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/es_query/build_es_query.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-common.EsRangeFilter",
"type": "Interface",
"label": "EsRangeFilter",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.EsRangeFilter.range",
"type": "Object",
"label": "range",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 57
},
"signature": [
"{ [key: string]: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilterParams",
"text": "RangeFilterParams"
},
"; }"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 56
},
"initialIsOpen": false
},
{
"id": "def-common.FilterExistsProperty",
"type": "Interface",
"label": "FilterExistsProperty",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FilterExistsProperty.field",
"type": "Any",
"label": "field",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 15
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-common.FilterValueFormatter",
"type": "Interface",
"label": "FilterValueFormatter",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FilterValueFormatter.convert",
"type": "Function",
"label": "convert",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 21
},
"signature": [
"FilterFormatterFunction"
]
},
{
"tags": [],
"id": "def-common.FilterValueFormatter.getConverterFor",
"type": "Function",
"label": "getConverterFor",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 22
},
"signature": [
"(type: string) => FilterFormatterFunction"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"id": "def-common.KbnFieldTypeOptions",
"type": "Interface",
"label": "KbnFieldTypeOptions",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-common.KbnFieldTypeOptions.sortable",
"type": "boolean",
"label": "sortable",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 11
}
},
{
"tags": [],
"id": "def-common.KbnFieldTypeOptions.filterable",
"type": "boolean",
"label": "filterable",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-common.KbnFieldTypeOptions.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.KbnFieldTypeOptions.esTypes",
"type": "Array",
"label": "esTypes",
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 14
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[]"
]
}
],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.KueryNode",
"type": "Interface",
"label": "KueryNode",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.KueryNode.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 12
},
"signature": [
"\"function\" | \"literal\" | \"namedArg\" | \"wildcard\""
]
},
{
"id": "def-common.KueryNode.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 13
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.KueryParseOptions",
"type": "Interface",
"label": "KueryParseOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.KueryParseOptions.helpers",
"type": "Object",
"label": "helpers",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 19
},
"signature": [
"{ [key: string]: any; }"
]
},
{
"tags": [],
"id": "def-common.KueryParseOptions.startRule",
"type": "string",
"label": "startRule",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 22
}
},
{
"tags": [],
"id": "def-common.KueryParseOptions.allowLeadingWildcards",
"type": "boolean",
"label": "allowLeadingWildcards",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 23
}
},
{
"tags": [],
"id": "def-common.KueryParseOptions.cursorSymbol",
"type": "string",
"label": "cursorSymbol",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 24
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.KueryParseOptions.parseCursor",
"type": "CompoundType",
"label": "parseCursor",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 25
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-common.LatLon",
"type": "Interface",
"label": "LatLon",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.LatLon.lat",
"type": "number",
"label": "lat",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 48
}
},
{
"tags": [],
"id": "def-common.LatLon.lon",
"type": "number",
"label": "lon",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 49
}
}
],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 47
},
"initialIsOpen": false
},
{
"id": "def-common.MatchAllFilterMeta",
"type": "Interface",
"label": "MatchAllFilterMeta",
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MatchAllFilterMeta",
"text": "MatchAllFilterMeta"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterMeta",
"text": "FilterMeta"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.MatchAllFilterMeta.field",
"type": "Any",
"label": "field",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/match_all_filter.ts",
"lineNumber": 12
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-common.MatchAllFilterMeta.formattedValue",
"type": "string",
"label": "formattedValue",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/match_all_filter.ts",
"lineNumber": 13
}
}
],
"source": {
"path": "src/plugins/data/common/es_query/filters/match_all_filter.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.RangeFilterParams",
"type": "Interface",
"label": "RangeFilterParams",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RangeFilterParams.from",
"type": "CompoundType",
"label": "from",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 36
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-common.RangeFilterParams.to",
"type": "CompoundType",
"label": "to",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 37
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-common.RangeFilterParams.gt",
"type": "CompoundType",
"label": "gt",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 38
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-common.RangeFilterParams.lt",
"type": "CompoundType",
"label": "lt",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 39
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-common.RangeFilterParams.gte",
"type": "CompoundType",
"label": "gte",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 40
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-common.RangeFilterParams.lte",
"type": "CompoundType",
"label": "lte",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 41
},
"signature": [
"string | number | undefined"
]
},
{
"tags": [],
"id": "def-common.RangeFilterParams.format",
"type": "string",
"label": "format",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 42
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 35
},
"initialIsOpen": false
},
{
"id": "def-common.SavedObject",
"type": "Interface",
"label": "SavedObject",
"signature": [
"SavedObject",
"<T>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SavedObject.id",
"type": "string",
"label": "id",
"description": [
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 71
}
},
{
"tags": [],
"id": "def-common.SavedObject.type",
"type": "string",
"label": "type",
"description": [
" The type of Saved Object. Each plugin can define it's own custom Saved Object types."
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 73
}
},
{
"tags": [],
"id": "def-common.SavedObject.version",
"type": "string",
"label": "version",
"description": [
"An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 75
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObject.updated_at",
"type": "string",
"label": "updated_at",
"description": [
"Timestamp of the last time this document had been updated."
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 77
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObject.error",
"type": "Object",
"label": "error",
"description": [],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 78
},
"signature": [
"SavedObjectError",
" | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObject.attributes",
"type": "Uncategorized",
"label": "attributes",
"description": [
"{@inheritdoc SavedObjectAttributes}"
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 80
},
"signature": [
"T"
]
},
{
"tags": [],
"id": "def-common.SavedObject.references",
"type": "Array",
"label": "references",
"description": [
"{@inheritdoc SavedObjectReference}"
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 82
},
"signature": [
"SavedObjectReference",
"[]"
]
},
{
"tags": [],
"id": "def-common.SavedObject.migrationVersion",
"type": "Object",
"label": "migrationVersion",
"description": [
"{@inheritdoc SavedObjectsMigrationVersion}"
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 84
},
"signature": [
"SavedObjectsMigrationVersion",
" | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObject.coreMigrationVersion",
"type": "string",
"label": "coreMigrationVersion",
"description": [
"A semver value that is used when upgrading objects between Kibana versions."
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 86
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObject.namespaces",
"type": "Array",
"label": "namespaces",
"description": [
"Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types."
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 88
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObject.originId",
"type": "string",
"label": "originId",
"description": [
"\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace."
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 95
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/types/saved_objects.ts",
"lineNumber": 69
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-common.ES_FIELD_TYPES",
"type": "Enum",
"label": "ES_FIELD_TYPES",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-common.FILTERS",
"type": "Enum",
"label": "FILTERS",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/types.ts",
"lineNumber": 29
},
"initialIsOpen": false
},
{
"id": "def-common.FilterStateStore",
"type": "Enum",
"label": "FilterStateStore",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-common.KBN_FIELD_TYPES",
"type": "Enum",
"label": "KBN_FIELD_TYPES",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/kbn_field_types/types.ts",
"lineNumber": 64
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-common.CSV_MIME_TYPE",
"type": "string",
"label": "CSV_MIME_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/common/exports/export_csv.tsx",
"lineNumber": 17
},
"signature": [
"\"text/plain;charset=utf-8\""
],
"initialIsOpen": false
},
{
"id": "def-common.CustomFilter",
"type": "Type",
"label": "CustomFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/custom_filter.ts",
"lineNumber": 11
},
"signature": [
"Filter & { query: any; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_QUERY_LANGUAGE",
"type": "string",
"label": "DEFAULT_QUERY_LANGUAGE",
"description": [],
"source": {
"path": "src/plugins/data/common/constants.ts",
"lineNumber": 9
},
"signature": [
"\"kuery\""
],
"initialIsOpen": false
},
{
"id": "def-common.DslQuery",
"type": "Type",
"label": "DslQuery",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/types.ts",
"lineNumber": 16
},
"signature": [
"any"
],
"initialIsOpen": false
},
{
"id": "def-common.ExistsFilter",
"type": "Type",
"label": "ExistsFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 18
},
"signature": [
"Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.ExistsFilterMeta",
"type": "Type",
"label": "ExistsFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/exists_filter.ts",
"lineNumber": 12
},
"signature": [
"{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.FieldFilter",
"type": "Type",
"label": "FieldFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/types.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhrasesFilter",
"text": "PhrasesFilter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ExistsFilter",
"text": "ExistsFilter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.PhraseFilter",
"text": "PhraseFilter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.RangeFilter",
"text": "RangeFilter"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.MatchAllFilter",
"text": "MatchAllFilter"
}
],
"initialIsOpen": false
},
{
"id": "def-common.Filter",
"type": "Type",
"label": "Filter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 41
},
"signature": [
"{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }"
],
"initialIsOpen": false
},
{
"id": "def-common.FilterMeta",
"type": "Type",
"label": "FilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 26
},
"signature": [
"{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.FilterState",
"type": "Type",
"label": "FilterState",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/meta_filter.ts",
"lineNumber": 15
},
"signature": [
"{ store: FilterStateStore; }"
],
"initialIsOpen": false
},
{
"id": "def-common.GeoBoundingBoxFilter",
"type": "Type",
"label": "GeoBoundingBoxFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts",
"lineNumber": 18
},
"signature": [
"Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }"
],
"initialIsOpen": false
},
{
"id": "def-common.GeoBoundingBoxFilterMeta",
"type": "Type",
"label": "GeoBoundingBoxFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts",
"lineNumber": 11
},
"signature": [
"FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }"
],
"initialIsOpen": false
},
{
"id": "def-common.GeoPolygonFilter",
"type": "Type",
"label": "GeoPolygonFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts",
"lineNumber": 17
},
"signature": [
"Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }"
],
"initialIsOpen": false
},
{
"id": "def-common.GeoPolygonFilterMeta",
"type": "Type",
"label": "GeoPolygonFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts",
"lineNumber": 11
},
"signature": [
"FilterMeta & { params: { points: LatLon[];}; }"
],
"initialIsOpen": false
},
{
"id": "def-common.GetConfigFn",
"type": "Type",
"label": "GetConfigFn",
"tags": [],
"description": [
"\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible."
],
"source": {
"path": "src/plugins/data/common/types.ts",
"lineNumber": 23
},
"signature": [
"(key: string, defaultOverride: T | undefined) => T"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY",
"type": "string",
"label": "KIBANA_USER_QUERY_LANGUAGE_KEY",
"description": [],
"source": {
"path": "src/plugins/data/common/constants.ts",
"lineNumber": 10
},
"signature": [
"\"kibana.userQueryLanguage\""
],
"initialIsOpen": false
},
{
"id": "def-common.MatchAllFilter",
"type": "Type",
"label": "MatchAllFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/match_all_filter.ts",
"lineNumber": 16
},
"signature": [
"Filter & { meta: MatchAllFilterMeta; match_all: any; }"
],
"initialIsOpen": false
},
{
"id": "def-common.MissingFilter",
"type": "Type",
"label": "MissingFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/missing_filter.ts",
"lineNumber": 13
},
"signature": [
"Filter & { meta: MissingFilterMeta; missing: any; }"
],
"initialIsOpen": false
},
{
"id": "def-common.MissingFilterMeta",
"type": "Type",
"label": "MissingFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/missing_filter.ts",
"lineNumber": 11
},
"signature": [
"{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PhraseFilter",
"type": "Type",
"label": "PhraseFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 21
},
"signature": [
"Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PhraseFilterMeta",
"type": "Type",
"label": "PhraseFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
"lineNumber": 13
},
"signature": [
"FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PhrasesFilter",
"type": "Type",
"label": "PhrasesFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 19
},
"signature": [
"Filter & { meta: PhrasesFilterMeta; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PhrasesFilterMeta",
"type": "Type",
"label": "PhrasesFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/phrases_filter.ts",
"lineNumber": 14
},
"signature": [
"FilterMeta & { params: string[]; field?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.QueryStringFilter",
"type": "Type",
"label": "QueryStringFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 13
},
"signature": [
"Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.QueryStringFilterMeta",
"type": "Type",
"label": "QueryStringFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/query_string_filter.ts",
"lineNumber": 11
},
"signature": [
"{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.RangeFilter",
"type": "Type",
"label": "RangeFilter",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 60
},
"signature": [
"Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }"
],
"initialIsOpen": false
},
{
"id": "def-common.RangeFilterMeta",
"type": "Type",
"label": "RangeFilterMeta",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/filters/range_filter.ts",
"lineNumber": 50
},
"signature": [
"FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-common.nodeBuilder",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.nodeBuilder.is",
"type": "Function",
"children": [
{
"id": "def-common.nodeBuilder.is.$1",
"type": "string",
"label": "fieldName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 12
}
},
{
"id": "def-common.nodeBuilder.is.$2",
"type": "CompoundType",
"label": "value",
"isRequired": true,
"signature": [
"string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 12
}
}
],
"signature": [
"(fieldName: string, value: string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
") => ",
"FunctionTypeBuildNode"
],
"description": [],
"label": "is",
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.nodeBuilder.or",
"type": "Function",
"children": [
{
"id": "def-common.nodeBuilder.or.$1",
"type": "Array",
"label": "nodes",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 19
}
}
],
"signature": [
"(nodes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
"[]) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
],
"description": [],
"label": "or",
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 19
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.nodeBuilder.and",
"type": "Function",
"children": [
{
"id": "def-common.nodeBuilder.and.$1",
"type": "Array",
"label": "nodes",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 22
}
}
],
"signature": [
"(nodes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
"[]) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
],
"description": [],
"label": "and",
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 22
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "nodeBuilder",
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.nodeTypes",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.nodeTypes.function",
"type": "Object",
"label": "function",
"description": [
"// This requires better typing of the different typings and their return types.\n// @ts-ignore"
],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/index.ts",
"lineNumber": 21
},
"signature": [
"typeof ",
"src/plugins/data/common/es_query/kuery/node_types/function"
]
},
{
"tags": [],
"id": "def-common.nodeTypes.literal",
"type": "Object",
"label": "literal",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/index.ts",
"lineNumber": 22
},
"signature": [
"typeof ",
"src/plugins/data/common/es_query/kuery/node_types/literal"
]
},
{
"tags": [],
"id": "def-common.nodeTypes.namedArg",
"type": "Object",
"label": "namedArg",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/index.ts",
"lineNumber": 23
},
"signature": [
"typeof ",
"src/plugins/data/common/es_query/kuery/node_types/named_arg"
]
},
{
"tags": [],
"id": "def-common.nodeTypes.wildcard",
"type": "Object",
"label": "wildcard",
"description": [],
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/index.ts",
"lineNumber": 24
},
"signature": [
"typeof ",
"src/plugins/data/common/es_query/kuery/node_types/wildcard"
]
}
],
"description": [],
"label": "nodeTypes",
"source": {
"path": "src/plugins/data/common/es_query/kuery/node_types/index.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UI_SETTINGS",
"type": "Object",
"label": "UI_SETTINGS",
"description": [],
"source": {
"path": "src/plugins/data/common/constants.ts",
"lineNumber": 12
},
"signature": [
"{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }"
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink