diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.tojson.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.tojson.md index aa639aa574076..6e9f12d98d149 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.tojson.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.tojson.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> - Use serialize() instead. +> Use serialize() instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.customfilter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.customfilter.md index 5c666c7f9fe1e..3d08df8544d6c 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.customfilter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.customfilter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esfilters.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esfilters.md index c13f6e951be98..24d60613d913a 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esfilters.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esfilters.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import helpers from the "@kbn/es-query" package directly instead. 8.0 > Filter helpers namespace: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.eskuery.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.eskuery.md index 48cb20e0b9032..e569733f15e7f 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.eskuery.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.eskuery.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import helpers from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esquery.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esquery.md index deb50b1928010..447e387f90eb5 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esquery.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esquery.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import helpers from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esqueryconfig.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esqueryconfig.md index 3e8c370941260..f877fa26b1b25 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esqueryconfig.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esqueryconfig.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.existsfilter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.existsfilter.md index ec5bc71c614ec..5c98ba4131ac3 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.existsfilter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.existsfilter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.filter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.filter.md index 454dde806532f..b25d313129634 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.filter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.filter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldsubtype.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldsubtype.md index e2fa06a8acc6c..ec723ddc00e72 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldsubtype.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldsubtype.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldtype.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldtype.md index e1acea53ea5e0..b4b3198092604 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldtype.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldtype.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Use IndexPatternField or FieldSpec instead +> Use [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md index e0ee1f0ec15a4..3f8048d2913fb 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Add scripted field to field list diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md index 1bbe0b594ecf0..e42980bb53af4 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md @@ -9,9 +9,7 @@ ```typescript getAggregationRestrictions(): Record Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md index 57e1b5f49371b..517dec992c090 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.intervalname.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.intervalname.md index 81e7fb9c1d57b..9d26cf9730f46 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.intervalname.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.intervalname.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Deprecated. used by time range index patterns +> Used by time range index patterns 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md index d3e1b26810fd7..fbd85a7d73230 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Remove scripted field from field list diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md index dc206ceabefe2..d42ff9270df97 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md @@ -4,6 +4,7 @@ ## IndexPatternField class + Signature: ```typescript diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilter.md index eb6b9968544c7..8891620ad01ef 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilters.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilters.md index 52bfaa67e2258..522a1c66bb80e 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilters.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilters.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kuerynode.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kuerynode.md index bb3eb02dc88b9..6c6904d6625c6 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kuerynode.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kuerynode.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.matchallfilter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.matchallfilter.md index 36712d80ff644..35ebdb1473c4e 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.matchallfilter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.matchallfilter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasefilter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasefilter.md index 1c0dcc0589d0a..850aff0f6cd85 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasefilter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasefilter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasesfilter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasesfilter.md index 64bce6d4f6111..a28dba5b1cd3f 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasesfilter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.phrasesfilter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilter.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilter.md index 9f072aae6e194..91dd7c13c472e 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilter.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefiltermeta.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefiltermeta.md index e1b4f2886a6de..291dc90c3971d 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefiltermeta.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefiltermeta.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilterparams.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilterparams.md index 23c11b1317c7e..42db2d353befa 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilterparams.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.rangefilterparams.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsource.fetch.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsource.fetch.md index e6ba1a51a867d..977f875b214e5 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsource.fetch.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsource.fetch.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Use fetch$ instead +> Use the `fetch$` method instead 8.0 > Fetch this source and reject the returned Promise on error diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.md index fba0d9fe62c78..83cbcd016f92a 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.1 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.esqueryconfig.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.esqueryconfig.md index 6d8383ead501f..b3487b1a0f863 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.esqueryconfig.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.esqueryconfig.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.1 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.filter.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.filter.md index e7f3777cd2d3f..821c1a0168205 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.filter.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.filter.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.1 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldsubtype.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldsubtype.md index 07a59d41fb0a3..9ac9ba1abc637 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldsubtype.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldsubtype.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldtype.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldtype.md index 9f14bedf92008..932afceb5d22b 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldtype.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldtype.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Use IndexPatternField or FieldSpec instead +> Use [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) 8.0 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md index 33f1ac5e31660..9fe169233af13 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Add scripted field to field list diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getaggregationrestrictions.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getaggregationrestrictions.md index 70a3da86e9fbd..b655e779e4fa4 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getaggregationrestrictions.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getaggregationrestrictions.md @@ -9,9 +9,7 @@ ```typescript getAggregationRestrictions(): Record Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md index 95f9f31309674..15978b6414947 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.intervalname.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.intervalname.md index c144520075790..e2810cc21a378 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.intervalname.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.intervalname.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Deprecated. used by time range index patterns +> Used by time range index patterns 8.0 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md index b351eba2ace4f..bc96d3596ed12 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> use runtime field instead +> use runtime field instead 8.0 > Remove scripted field from field list diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield._constructor_.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield._constructor_.md new file mode 100644 index 0000000000000..d3c990a356852 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [(constructor)](./kibana-plugin-plugins-data-server.indexpatternfield._constructor_.md) + +## IndexPatternField.(constructor) + +Constructs a new instance of the `IndexPatternField` class + +Signature: + +```typescript +constructor(spec: FieldSpec); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| spec | FieldSpec | | + diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.aggregatable.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.aggregatable.md new file mode 100644 index 0000000000000..39fde64218547 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.aggregatable.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [aggregatable](./kibana-plugin-plugins-data-server.indexpatternfield.aggregatable.md) + +## IndexPatternField.aggregatable property + +Signature: + +```typescript +get aggregatable(): boolean; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.conflictdescriptions.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.conflictdescriptions.md new file mode 100644 index 0000000000000..f386e68fc2e0e --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.conflictdescriptions.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [conflictDescriptions](./kibana-plugin-plugins-data-server.indexpatternfield.conflictdescriptions.md) + +## IndexPatternField.conflictDescriptions property + +Description of field type conflicts across different indices in the same index pattern + +Signature: + +```typescript +get conflictDescriptions(): Record | undefined; + +set conflictDescriptions(conflictDescriptions: Record | undefined); +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.count.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.count.md new file mode 100644 index 0000000000000..65b73e16ea36b --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.count.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [count](./kibana-plugin-plugins-data-server.indexpatternfield.count.md) + +## IndexPatternField.count property + +Count is used for field popularity + +Signature: + +```typescript +get count(): number; + +set count(count: number); +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.customlabel.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.customlabel.md new file mode 100644 index 0000000000000..844afc863b77f --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.customlabel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [customLabel](./kibana-plugin-plugins-data-server.indexpatternfield.customlabel.md) + +## IndexPatternField.customLabel property + +Signature: + +```typescript +get customLabel(): string | undefined; + +set customLabel(customLabel: string | undefined); +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.deletecount.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.deletecount.md new file mode 100644 index 0000000000000..d870275ef1a85 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.deletecount.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [deleteCount](./kibana-plugin-plugins-data-server.indexpatternfield.deletecount.md) + +## IndexPatternField.deleteCount() method + +Signature: + +```typescript +deleteCount(): void; +``` +Returns: + +`void` + diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.displayname.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.displayname.md new file mode 100644 index 0000000000000..6a0d58cdeed8d --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.displayname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [displayName](./kibana-plugin-plugins-data-server.indexpatternfield.displayname.md) + +## IndexPatternField.displayName property + +Signature: + +```typescript +get displayName(): string; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.estypes.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.estypes.md new file mode 100644 index 0000000000000..3f4c704a44905 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.estypes.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [esTypes](./kibana-plugin-plugins-data-server.indexpatternfield.estypes.md) + +## IndexPatternField.esTypes property + +Signature: + +```typescript +get esTypes(): string[] | undefined; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.filterable.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.filterable.md new file mode 100644 index 0000000000000..dbcfeb2ff6519 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.filterable.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [filterable](./kibana-plugin-plugins-data-server.indexpatternfield.filterable.md) + +## IndexPatternField.filterable property + +Signature: + +```typescript +get filterable(): boolean; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.ismapped.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.ismapped.md new file mode 100644 index 0000000000000..e77965022e9e5 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.ismapped.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [isMapped](./kibana-plugin-plugins-data-server.indexpatternfield.ismapped.md) + +## IndexPatternField.isMapped property + +Is the field part of the index mapping? + +Signature: + +```typescript +get isMapped(): boolean | undefined; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.lang.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.lang.md new file mode 100644 index 0000000000000..d7f119bc12e55 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.lang.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [lang](./kibana-plugin-plugins-data-server.indexpatternfield.lang.md) + +## IndexPatternField.lang property + +Script field language + +Signature: + +```typescript +get lang(): "painless" | "expression" | "mustache" | "java" | undefined; + +set lang(lang: "painless" | "expression" | "mustache" | "java" | undefined); +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.md new file mode 100644 index 0000000000000..79648441a72b2 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) + +## IndexPatternField class + + +Signature: + +```typescript +export declare class IndexPatternField implements IFieldType +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(spec)](./kibana-plugin-plugins-data-server.indexpatternfield._constructor_.md) | | Constructs a new instance of the IndexPatternField class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [aggregatable](./kibana-plugin-plugins-data-server.indexpatternfield.aggregatable.md) | | boolean | | +| [conflictDescriptions](./kibana-plugin-plugins-data-server.indexpatternfield.conflictdescriptions.md) | | Record<string, string[]> | undefined | Description of field type conflicts across different indices in the same index pattern | +| [count](./kibana-plugin-plugins-data-server.indexpatternfield.count.md) | | number | Count is used for field popularity | +| [customLabel](./kibana-plugin-plugins-data-server.indexpatternfield.customlabel.md) | | string | undefined | | +| [displayName](./kibana-plugin-plugins-data-server.indexpatternfield.displayname.md) | | string | | +| [esTypes](./kibana-plugin-plugins-data-server.indexpatternfield.estypes.md) | | string[] | undefined | | +| [filterable](./kibana-plugin-plugins-data-server.indexpatternfield.filterable.md) | | boolean | | +| [isMapped](./kibana-plugin-plugins-data-server.indexpatternfield.ismapped.md) | | boolean | undefined | Is the field part of the index mapping? | +| [lang](./kibana-plugin-plugins-data-server.indexpatternfield.lang.md) | | "painless" | "expression" | "mustache" | "java" | undefined | Script field language | +| [name](./kibana-plugin-plugins-data-server.indexpatternfield.name.md) | | string | | +| [readFromDocValues](./kibana-plugin-plugins-data-server.indexpatternfield.readfromdocvalues.md) | | boolean | | +| [runtimeField](./kibana-plugin-plugins-data-server.indexpatternfield.runtimefield.md) | | RuntimeField | undefined | | +| [script](./kibana-plugin-plugins-data-server.indexpatternfield.script.md) | | string | undefined | Script field code | +| [scripted](./kibana-plugin-plugins-data-server.indexpatternfield.scripted.md) | | boolean | | +| [searchable](./kibana-plugin-plugins-data-server.indexpatternfield.searchable.md) | | boolean | | +| [sortable](./kibana-plugin-plugins-data-server.indexpatternfield.sortable.md) | | boolean | | +| [spec](./kibana-plugin-plugins-data-server.indexpatternfield.spec.md) | | FieldSpec | | +| [subType](./kibana-plugin-plugins-data-server.indexpatternfield.subtype.md) | | import("@kbn/es-query").IFieldSubType | undefined | | +| [type](./kibana-plugin-plugins-data-server.indexpatternfield.type.md) | | string | | +| [visualizable](./kibana-plugin-plugins-data-server.indexpatternfield.visualizable.md) | | boolean | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [deleteCount()](./kibana-plugin-plugins-data-server.indexpatternfield.deletecount.md) | | | +| [toJSON()](./kibana-plugin-plugins-data-server.indexpatternfield.tojson.md) | | | +| [toSpec({ getFormatterForField, })](./kibana-plugin-plugins-data-server.indexpatternfield.tospec.md) | | | + diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.name.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.name.md new file mode 100644 index 0000000000000..496dae139b0e7 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [name](./kibana-plugin-plugins-data-server.indexpatternfield.name.md) + +## IndexPatternField.name property + +Signature: + +```typescript +get name(): string; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.readfromdocvalues.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.readfromdocvalues.md new file mode 100644 index 0000000000000..90c30c8475220 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.readfromdocvalues.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [readFromDocValues](./kibana-plugin-plugins-data-server.indexpatternfield.readfromdocvalues.md) + +## IndexPatternField.readFromDocValues property + +Signature: + +```typescript +get readFromDocValues(): boolean; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.runtimefield.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.runtimefield.md new file mode 100644 index 0000000000000..bb33615a1557a --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.runtimefield.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [runtimeField](./kibana-plugin-plugins-data-server.indexpatternfield.runtimefield.md) + +## IndexPatternField.runtimeField property + +Signature: + +```typescript +get runtimeField(): RuntimeField | undefined; + +set runtimeField(runtimeField: RuntimeField | undefined); +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.script.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.script.md new file mode 100644 index 0000000000000..1d585a4ef9d13 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.script.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [script](./kibana-plugin-plugins-data-server.indexpatternfield.script.md) + +## IndexPatternField.script property + +Script field code + +Signature: + +```typescript +get script(): string | undefined; + +set script(script: string | undefined); +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.scripted.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.scripted.md new file mode 100644 index 0000000000000..679ef7207bb4d --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.scripted.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [scripted](./kibana-plugin-plugins-data-server.indexpatternfield.scripted.md) + +## IndexPatternField.scripted property + +Signature: + +```typescript +get scripted(): boolean; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.searchable.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.searchable.md new file mode 100644 index 0000000000000..e1aed6f472384 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.searchable.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [searchable](./kibana-plugin-plugins-data-server.indexpatternfield.searchable.md) + +## IndexPatternField.searchable property + +Signature: + +```typescript +get searchable(): boolean; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.sortable.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.sortable.md new file mode 100644 index 0000000000000..5a52b91d87fc4 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.sortable.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [sortable](./kibana-plugin-plugins-data-server.indexpatternfield.sortable.md) + +## IndexPatternField.sortable property + +Signature: + +```typescript +get sortable(): boolean; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.spec.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.spec.md new file mode 100644 index 0000000000000..f3e22f0cb88ac --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.spec.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [spec](./kibana-plugin-plugins-data-server.indexpatternfield.spec.md) + +## IndexPatternField.spec property + +Signature: + +```typescript +readonly spec: FieldSpec; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.subtype.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.subtype.md new file mode 100644 index 0000000000000..458c35bc1b391 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.subtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [subType](./kibana-plugin-plugins-data-server.indexpatternfield.subtype.md) + +## IndexPatternField.subType property + +Signature: + +```typescript +get subType(): import("@kbn/es-query").IFieldSubType | undefined; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.tojson.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.tojson.md new file mode 100644 index 0000000000000..092e74949d5d5 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.tojson.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [toJSON](./kibana-plugin-plugins-data-server.indexpatternfield.tojson.md) + +## IndexPatternField.toJSON() method + +Signature: + +```typescript +toJSON(): { + count: number; + script: string | undefined; + lang: "painless" | "expression" | "mustache" | "java" | undefined; + conflictDescriptions: Record | undefined; + name: string; + type: string; + esTypes: string[] | undefined; + scripted: boolean; + searchable: boolean; + aggregatable: boolean; + readFromDocValues: boolean; + subType: import("@kbn/es-query").IFieldSubType | undefined; + customLabel: string | undefined; + }; +``` +Returns: + +`{ + count: number; + script: string | undefined; + lang: "painless" | "expression" | "mustache" | "java" | undefined; + conflictDescriptions: Record | undefined; + name: string; + type: string; + esTypes: string[] | undefined; + scripted: boolean; + searchable: boolean; + aggregatable: boolean; + readFromDocValues: boolean; + subType: import("@kbn/es-query").IFieldSubType | undefined; + customLabel: string | undefined; + }` + diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.tospec.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.tospec.md new file mode 100644 index 0000000000000..883a0b360612e --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.tospec.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [toSpec](./kibana-plugin-plugins-data-server.indexpatternfield.tospec.md) + +## IndexPatternField.toSpec() method + +Signature: + +```typescript +toSpec({ getFormatterForField, }?: { + getFormatterForField?: IndexPattern['getFormatterForField']; + }): FieldSpec; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| { getFormatterForField, } | {
getFormatterForField?: IndexPattern['getFormatterForField'];
} | | + +Returns: + +`FieldSpec` + diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.type.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.type.md new file mode 100644 index 0000000000000..5e8f4e8676ca3 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [type](./kibana-plugin-plugins-data-server.indexpatternfield.type.md) + +## IndexPatternField.type property + +Signature: + +```typescript +get type(): string; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.visualizable.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.visualizable.md new file mode 100644 index 0000000000000..1868e9d107a27 --- /dev/null +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternfield.visualizable.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) > [visualizable](./kibana-plugin-plugins-data-server.indexpatternfield.visualizable.md) + +## IndexPatternField.visualizable property + +Signature: + +```typescript +get visualizable(): boolean; +``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kuerynode.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kuerynode.md index 28d64cf9e17da..0bdb5d6726fa8 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kuerynode.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kuerynode.md @@ -6,7 +6,7 @@ > Warning: This API is now obsolete. > -> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. +> Import from the "@kbn/es-query" package directly instead. 8.0 > Signature: diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md index 755fa33bfe506..2e76e3b0c6ad4 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md @@ -10,6 +10,7 @@ | --- | --- | | [AggParamType](./kibana-plugin-plugins-data-server.aggparamtype.md) | | | [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) | | +| [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) | | | [IndexPatternsFetcher](./kibana-plugin-plugins-data-server.indexpatternsfetcher.md) | | | [IndexPatternsService](./kibana-plugin-plugins-data-server.indexpatternsservice.md) | | | [IndexPatternsServiceProvider](./kibana-plugin-plugins-data-server.indexpatternsserviceprovider.md) | | diff --git a/src/plugins/data/common/es_query/index.ts b/src/plugins/data/common/es_query/index.ts index b24ddf7303694..ee98a9ecf8892 100644 --- a/src/plugins/data/common/es_query/index.ts +++ b/src/plugins/data/common/es_query/index.ts @@ -72,288 +72,347 @@ import { } from '@kbn/es-query'; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isFilter = oldIsFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isFilterDisabled = oldIsFilterDisabled; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const disableFilter = oldDisableFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const fromKueryExpression = oldFromKueryExpression; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const toElasticsearchQuery = oldToElasticsearchQuery; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const nodeTypes = oldNodeTypes; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildEsQuery = oldBuildEsQuery; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildQueryFromFilters = oldBuildQueryFromFilters; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const luceneStringToDsl = oldLuceneStringToDsl; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const decorateQuery = olddecorateQuery; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const getPhraseFilterField = oldgetPhraseFilterField; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const getPhraseFilterValue = oldgetPhraseFilterValue; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isFilterPinned = oldIsFilterPinned; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const nodeBuilder = oldNodeBuilder; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isFilters = oldIsFilters; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const uniqFilters = oldUniqFilters; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const onlyDisabledFiltersChanged = oldOnlyDisabledFiltersChanged; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isExistsFilter = oldIsExistsFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isMatchAllFilter = oldIsMatchAllFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isGeoBoundingBoxFilter = oldIsGeoBoundingBoxFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isGeoPolygonFilter = oldIsGeoPolygonFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isMissingFilter = oldIsMissingFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isPhraseFilter = oldIsPhraseFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isPhrasesFilter = oldIsPhrasesFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isRangeFilter = oldIsRangeFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const isQueryStringFilter = oldIsQueryStringFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildQueryFilter = oldBuildQueryFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildPhrasesFilter = oldBuildPhrasesFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildPhraseFilter = oldBuildPhraseFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildRangeFilter = oldBuildRangeFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildCustomFilter = oldBuildCustomFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildFilter = oldBuildFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildEmptyFilter = oldBuildEmptyFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const buildExistsFilter = oldBuildExistsFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const toggleFilterNegated = oldtoggleFilterNegated; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const enableFilter = oldEnableFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const pinFilter = oldPinFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const toggleFilterDisabled = oldToggleFilterDisabled; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const compareFilters = oldCompareFilters; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const dedupFilters = oldDedupFilters; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const COMPARE_ALL_OPTIONS = OLD_COMPARE_ALL_OPTIONS; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ const FILTERS = oldFILTERS; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type Filter = oldFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type RangeFilterMeta = oldRangeFilterMeta; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type RangeFilterParams = oldRangeFilterParams; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type ExistsFilter = oldExistsFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type GeoPolygonFilter = oldGeoPolygonFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type PhrasesFilter = oldPhrasesFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type PhraseFilter = oldPhraseFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type MatchAllFilter = oldMatchAllFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type CustomFilter = oldCustomFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type MissingFilter = oldMissingFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type RangeFilter = oldRangeFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type GeoBoundingBoxFilter = oldGeoBoundingBoxFilter; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type KueryNode = oldKueryNode; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type FilterMeta = oldFilterMeta; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type IFieldSubType = oldIFieldSubType; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ type EsQueryConfig = oldEsQueryConfig; /** - * @deprecated Please import from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ export { diff --git a/src/plugins/data/common/index.ts b/src/plugins/data/common/index.ts index eac55317c89cd..cd05c613f793f 100644 --- a/src/plugins/data/common/index.ts +++ b/src/plugins/data/common/index.ts @@ -18,8 +18,9 @@ export * from './utils'; export * from './exports'; /** - * Use data plugin interface instead - * @deprecated + * + * @deprecated Use data plugin interface instead + * @removeBy 8.1 */ export { IndexPatternAttributes } from './types'; diff --git a/src/plugins/data/common/index_patterns/fields/index_pattern_field.ts b/src/plugins/data/common/index_patterns/fields/index_pattern_field.ts index e5f4945c9ad6d..0c7a668087da8 100644 --- a/src/plugins/data/common/index_patterns/fields/index_pattern_field.ts +++ b/src/plugins/data/common/index_patterns/fields/index_pattern_field.ts @@ -13,6 +13,7 @@ import type { IFieldType } from './types'; import { FieldSpec, IndexPattern } from '../..'; import { shortenDottedString } from '../../utils'; +/** @public */ export class IndexPatternField implements IFieldType { readonly spec: FieldSpec; // not writable or serialized diff --git a/src/plugins/data/common/index_patterns/fields/types.ts b/src/plugins/data/common/index_patterns/fields/types.ts index 38258dd4f53f4..8c8413f6894bf 100644 --- a/src/plugins/data/common/index_patterns/fields/types.ts +++ b/src/plugins/data/common/index_patterns/fields/types.ts @@ -9,8 +9,8 @@ import { IndexPatternFieldBase } from '@kbn/es-query'; import { FieldSpec, IndexPattern } from '../..'; /** - * @deprecated - * Use IndexPatternField or FieldSpec instead + * @deprecated Use {@link IndexPatternField} + * @removeBy 8.1 */ export interface IFieldType extends IndexPatternFieldBase { count?: number; diff --git a/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts b/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts index 0c3a9901f8c8c..b3f2605723c02 100644 --- a/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts +++ b/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts @@ -52,8 +52,9 @@ export class IndexPattern implements IIndexPattern { public fields: IIndexPatternFieldList & { toSpec: () => IndexPatternFieldMap }; public timeFieldName: string | undefined; /** - * @deprecated - * Deprecated. used by time range index patterns + * @deprecated Used by time range index patterns + * @removeBy 8.1 + * */ public intervalName: string | undefined; /** @@ -241,6 +242,7 @@ export class IndexPattern implements IIndexPattern { * @param fieldType * @param lang * @deprecated use runtime field instead + * @removeBy 8.1 */ async addScriptedField(name: string, script: string, fieldType: string = 'string') { const scriptedFields = this.getScriptedFields(); @@ -267,6 +269,7 @@ export class IndexPattern implements IIndexPattern { * Remove scripted field from field list * @param fieldName * @deprecated use runtime field instead + * @removeBy 8.1 */ removeScriptedField(fieldName: string) { @@ -279,6 +282,7 @@ export class IndexPattern implements IIndexPattern { /** * * @deprecated use runtime field instead + * @removeBy 8.1 */ getNonScriptedFields() { return [...this.fields.getAll().filter((field) => !field.scripted)]; @@ -287,6 +291,7 @@ export class IndexPattern implements IIndexPattern { /** * * @deprecated use runtime field instead + * @removeBy 8.1 */ getScriptedFields() { return [...this.fields.getAll().filter((field) => field.scripted)]; diff --git a/src/plugins/data/common/kbn_field_types/index.ts b/src/plugins/data/common/kbn_field_types/index.ts index 69ee9737d0f80..26fd3abd232d4 100644 --- a/src/plugins/data/common/kbn_field_types/index.ts +++ b/src/plugins/data/common/kbn_field_types/index.ts @@ -17,25 +17,25 @@ import { /** * @deprecated Import from the "@kbn/field-types" package directly instead. - * @removeBy 8.0 + * @removeBy 8.1 */ const castEsToKbnFieldTypeName = oldCastEsToKbnFieldTypeName; /** * @deprecated Import from the "@kbn/field-types" package directly instead. - * @removeBy 8.0 + * @removeBy 8.1 */ const getFilterableKbnTypeNames = oldGetFilterableKbnTypeNames; /** * @deprecated Import from the "@kbn/field-types" package directly instead. - * @removeBy 8.0 + * @removeBy 8.1 */ const getKbnFieldType = oldGetKbnFieldType; /** * @deprecated Import from the "@kbn/field-types" package directly instead. - * @removeBy 8.0 + * @removeBy 8.1 */ const getKbnTypeNames = oldGetKbnTypeNames; diff --git a/src/plugins/data/common/search/aggs/agg_config.ts b/src/plugins/data/common/search/aggs/agg_config.ts index 8f14e96a6970e..90540dc33cb6f 100644 --- a/src/plugins/data/common/search/aggs/agg_config.ts +++ b/src/plugins/data/common/search/aggs/agg_config.ts @@ -317,7 +317,8 @@ export class AggConfig { } /** - * @deprecated - Use serialize() instead. + * @deprecated Use serialize() instead. + * @removeBy 8.1 */ toJSON(): AggConfigSerialized { return this.serialize(); diff --git a/src/plugins/data/common/search/search_source/search_source.ts b/src/plugins/data/common/search/search_source/search_source.ts index 13f157da731a6..c982ba1e7a293 100644 --- a/src/plugins/data/common/search/search_source/search_source.ts +++ b/src/plugins/data/common/search/search_source/search_source.ts @@ -314,7 +314,8 @@ export class SearchSource { /** * Fetch this source and reject the returned Promise on error - * @deprecated Use fetch$ instead + * @deprecated Use the `fetch$` method instead + * @removeBy 8.1 */ fetch(options: ISearchOptions = {}) { return this.fetch$(options) diff --git a/src/plugins/data/public/deprecated.ts b/src/plugins/data/public/deprecated.ts index 229b6b39d9ad8..cfd58bead549b 100644 --- a/src/plugins/data/public/deprecated.ts +++ b/src/plugins/data/public/deprecated.ts @@ -70,25 +70,30 @@ import { } from './query'; /** - * @deprecated This import will be removed in v8.0.0. + * @deprecated This import will be removed. + * @removeBy 8.1 */ const changeTimeFilter = oldChangeTimeFilter; /** - * @deprecated This import will be removed in v8.0.0. + * @deprecated This import will be removed. + * @removeBy 8.1 */ const mapAndFlattenFilters = oldMapAndFlattenFilters; /** - * @deprecated This import will be removed in v8.0.0. + * @deprecated This import will be removed. + * @removeBy 8.1 */ const extractTimeFilter = oldExtractTimeFilter; /** - * @deprecated This import will be removed in v8.0.0. + * @deprecated This import will be removed. + * @removeBy 8.1 */ const convertRangeFilterToTimeRangeString = oldConvertRangeFilterToTimeRangeString; /** * Filter helpers namespace: - * @deprecated Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import helpers from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ export const esFilters = { FilterLabel, @@ -151,7 +156,8 @@ export { }; /** - * @deprecated Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import helpers from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ export const esKuery = { nodeTypes, @@ -160,7 +166,8 @@ export const esKuery = { }; /** - * @deprecated Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0. + * @deprecated Import helpers from the "@kbn/es-query" package directly instead. + * @removeBy 8.1 */ export const esQuery = { buildEsQuery, diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md index 7409163c5d766..ce105b8cc94ac 100644 --- a/src/plugins/data/public/public.api.md +++ b/src/plugins/data/public/public.api.md @@ -1353,9 +1353,7 @@ export class IndexPattern implements IIndexPattern { // (undocumented) getAggregationRestrictions(): Record { @@ -817,6 +813,74 @@ export interface IndexPatternAttributes { typeMeta: string; } +// @public (undocumented) +export class IndexPatternField implements IFieldType { + constructor(spec: FieldSpec); + // (undocumented) + get aggregatable(): boolean; + get conflictDescriptions(): Record | undefined; + set conflictDescriptions(conflictDescriptions: Record | undefined); + get count(): number; + set count(count: number); + // (undocumented) + get customLabel(): string | undefined; + set customLabel(customLabel: string | undefined); + // (undocumented) + deleteCount(): void; + // (undocumented) + get displayName(): string; + // (undocumented) + get esTypes(): string[] | undefined; + // (undocumented) + get filterable(): boolean; + get isMapped(): boolean | undefined; + get lang(): "painless" | "expression" | "mustache" | "java" | undefined; + set lang(lang: "painless" | "expression" | "mustache" | "java" | undefined); + // (undocumented) + get name(): string; + // (undocumented) + get readFromDocValues(): boolean; + // (undocumented) + get runtimeField(): RuntimeField | undefined; + set runtimeField(runtimeField: RuntimeField | undefined); + get script(): string | undefined; + set script(script: string | undefined); + // (undocumented) + get scripted(): boolean; + // (undocumented) + get searchable(): boolean; + // (undocumented) + get sortable(): boolean; + // (undocumented) + readonly spec: FieldSpec; + // (undocumented) + get subType(): import("@kbn/es-query").IFieldSubType | undefined; + // (undocumented) + toJSON(): { + count: number; + script: string | undefined; + lang: "painless" | "expression" | "mustache" | "java" | undefined; + conflictDescriptions: Record | undefined; + name: string; + type: string; + esTypes: string[] | undefined; + scripted: boolean; + searchable: boolean; + aggregatable: boolean; + readFromDocValues: boolean; + subType: import("@kbn/es-query").IFieldSubType | undefined; + customLabel: string | undefined; + }; + // (undocumented) + toSpec({ getFormatterForField, }?: { + getFormatterForField?: IndexPattern['getFormatterForField']; + }): FieldSpec; + // (undocumented) + get type(): string; + // (undocumented) + get visualizable(): boolean; +} + // Warning: (ae-forgotten-export) The symbol "name" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "Input" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "Arguments" needs to be exported by the entry point index.d.ts @@ -1387,9 +1451,9 @@ export function usageProvider(core: CoreSetup_2): SearchUsage; // Warnings were encountered during analysis: // // src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:52:45 - (ae-forgotten-export) The symbol "IndexPatternFieldMap" needs to be exported by the entry point index.d.ts -// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:65:5 - (ae-forgotten-export) The symbol "FormatFieldFn" needs to be exported by the entry point index.d.ts -// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:138:7 - (ae-forgotten-export) The symbol "FieldAttrSet" needs to be exported by the entry point index.d.ts -// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:169:7 - (ae-forgotten-export) The symbol "RuntimeField" needs to be exported by the entry point index.d.ts +// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:66:5 - (ae-forgotten-export) The symbol "FormatFieldFn" needs to be exported by the entry point index.d.ts +// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:139:7 - (ae-forgotten-export) The symbol "FieldAttrSet" needs to be exported by the entry point index.d.ts +// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:170:7 - (ae-forgotten-export) The symbol "RuntimeField" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:21:23 - (ae-forgotten-export) The symbol "datatableToCSV" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:49:26 - (ae-forgotten-export) The symbol "FieldFormatsRegistry" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:49:26 - (ae-forgotten-export) The symbol "FieldFormat" needs to be exported by the entry point index.d.ts @@ -1409,18 +1473,18 @@ export function usageProvider(core: CoreSetup_2): SearchUsage; // src/plugins/data/server/index.ts:49:26 - (ae-forgotten-export) The symbol "HistogramFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:81:27 - (ae-forgotten-export) The symbol "isFilterable" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:81:27 - (ae-forgotten-export) The symbol "isNestedField" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:197:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:197:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:199:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:200:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:209:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:210:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:211:1 - (ae-forgotten-export) The symbol "IpAddress" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:215:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:216:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:220:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:223:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts -// src/plugins/data/server/index.ts:224:1 - (ae-forgotten-export) The symbol "calcAutoIntervalLessThan" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:198:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:198:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:200:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:201:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:210:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:211:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:212:1 - (ae-forgotten-export) The symbol "IpAddress" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:216:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:217:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:221:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:224:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts +// src/plugins/data/server/index.ts:225:1 - (ae-forgotten-export) The symbol "calcAutoIntervalLessThan" needs to be exported by the entry point index.d.ts // src/plugins/data/server/plugin.ts:81:74 - (ae-forgotten-export) The symbol "DataEnhancements" needs to be exported by the entry point index.d.ts // src/plugins/data/server/search/types.ts:120:5 - (ae-forgotten-export) The symbol "ISearchStartSearchSource" needs to be exported by the entry point index.d.ts