documentation

elastic · Jun 21, 2021 · b191412 · b191412
1 parent a7e3608
commit b191412
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 2 deletions.
diff --git a/...ata/public/kibana-plugin-plugins-data-public.aggconfigs.getresolvedtimerange.md b/...ata/public/kibana-plugin-plugins-data-public.aggconfigs.getresolvedtimerange.md
@@ -4,6 +4,8 @@
 
 ## AggConfigs.getResolvedTimeRange() method
 
+Returns the current time range as moment instance (date math will get resolved using the current "now" value or system time if not set)
+
 <b>Signature:</b>
 
 ```typescript
@@ -13,3 +15,5 @@ getResolvedTimeRange(): import("../..").TimeRangeBounds | undefined;
 
 `import("../..").TimeRangeBounds | undefined`
 
+Current time range as resolved date.
+
diff --git a/...development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.md b/...development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.md
@@ -42,7 +42,7 @@ export declare class AggConfigs
 |  [getAll()](./kibana-plugin-plugins-data-public.aggconfigs.getall.md) |  |  |
 |  [getRequestAggById(id)](./kibana-plugin-plugins-data-public.aggconfigs.getrequestaggbyid.md) |  |  |
 |  [getRequestAggs()](./kibana-plugin-plugins-data-public.aggconfigs.getrequestaggs.md) |  |  |
-|  [getResolvedTimeRange()](./kibana-plugin-plugins-data-public.aggconfigs.getresolvedtimerange.md) |  |  |
+|  [getResolvedTimeRange()](./kibana-plugin-plugins-data-public.aggconfigs.getresolvedtimerange.md) |  | Returns the current time range as moment instance (date math will get resolved using the current "now" value or system time if not set) |
 |  [getResponseAggById(id)](./kibana-plugin-plugins-data-public.aggconfigs.getresponseaggbyid.md) |  | Find a response agg by it's id. This may be an agg in the aggConfigs, or one created specifically for a response value |
 |  [getResponseAggs()](./kibana-plugin-plugins-data-public.aggconfigs.getresponseaggs.md) |  | Gets the AggConfigs (and possibly ResponseAggConfigs) that represent the values that will be produced when all aggs are run.<!-- -->With multi-value metric aggs it is possible for a single agg request to result in multiple agg values, which is why the length of a vis' responseValuesAggs may be different than the vis' aggs {<!-- -->array\[AggConfig\]<!-- -->} |
 |  [getSearchSourceTimeFilter(forceNow)](./kibana-plugin-plugins-data-public.aggconfigs.getsearchsourcetimefilter.md) |  |  |

diff --git a/src/plugins/data/common/search/aggs/agg_configs.ts b/src/plugins/data/common/search/aggs/agg_configs.ts
@@ -127,6 +127,10 @@ export class AggConfigs {
     this.aggs.forEach(updateAggTimeRange);
   }
 
+  /**
+   * Returns the current time range as moment instance (date math will get resolved using the current "now" value or system time if not set)
+   * @returns Current time range as resolved date.
+   */
   getResolvedTimeRange() {
     return (
       this.timeRange &&

diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
@@ -259,7 +259,6 @@ export class AggConfigs {
     getRequestAggById(id: string): AggConfig | undefined;
     // (undocumented)
     getRequestAggs(): AggConfig[];
-    // (undocumented)
     getResolvedTimeRange(): import("../..").TimeRangeBounds | undefined;
     getResponseAggById(id: string): AggConfig | undefined;
     getResponseAggs(): AggConfig[];