[Lens] Add more in-editor Advanced documentation

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.search.md

@@ -35,6 +35,13 @@ search: {
         siblingPipelineType: string;
         termsAggFilter: string[];
         toAbsoluteDates: typeof toAbsoluteDates;
+        boundsDescendingRaw: ({
+            bound: number;
+            interval: import("moment").Duration;
+        } | {
+            bound: import("moment").Duration;
+            interval: import("moment").Duration;
+        })[];
     };
     getRequestInspectorStats: typeof getRequestInspectorStats;
     getResponseInspectorStats: typeof getResponseInspectorStats;

src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts

@@ -19,73 +19,78 @@
 
 import moment from 'moment';
 
-const boundsDescending = [
+export const boundsDescendingRaw = [
   {
     bound: Infinity,
-    interval: Number(moment.duration(1, 'year')),
+    interval: moment.duration(1, 'year'),
   },
   {
-    bound: Number(moment.duration(1, 'year')),
-    interval: Number(moment.duration(1, 'month')),
+    bound: moment.duration(1, 'year'),
+    interval: moment.duration(1, 'month'),
   },
   {
-    bound: Number(moment.duration(3, 'week')),
-    interval: Number(moment.duration(1, 'week')),
+    bound: moment.duration(3, 'week'),
+    interval: moment.duration(1, 'week'),
   },
   {
-    bound: Number(moment.duration(1, 'week')),
-    interval: Number(moment.duration(1, 'd')),
+    bound: moment.duration(1, 'week'),
+    interval: moment.duration(1, 'd'),
   },
   {
-    bound: Number(moment.duration(24, 'hour')),
-    interval: Number(moment.duration(12, 'hour')),
+    bound: moment.duration(24, 'hour'),
+    interval: moment.duration(12, 'hour'),
   },
   {
-    bound: Number(moment.duration(6, 'hour')),
-    interval: Number(moment.duration(3, 'hour')),
+    bound: moment.duration(6, 'hour'),
+    interval: moment.duration(3, 'hour'),
   },
   {
-    bound: Number(moment.duration(2, 'hour')),
-    interval: Number(moment.duration(1, 'hour')),
+    bound: moment.duration(2, 'hour'),
+    interval: moment.duration(1, 'hour'),
   },
   {
-    bound: Number(moment.duration(45, 'minute')),
-    interval: Number(moment.duration(30, 'minute')),
+    bound: moment.duration(45, 'minute'),
+    interval: moment.duration(30, 'minute'),
   },
   {
-    bound: Number(moment.duration(20, 'minute')),
-    interval: Number(moment.duration(10, 'minute')),
+    bound: moment.duration(20, 'minute'),
+    interval: moment.duration(10, 'minute'),
   },
   {
-    bound: Number(moment.duration(9, 'minute')),
-    interval: Number(moment.duration(5, 'minute')),
+    bound: moment.duration(9, 'minute'),
+    interval: moment.duration(5, 'minute'),
   },
   {
-    bound: Number(moment.duration(3, 'minute')),
-    interval: Number(moment.duration(1, 'minute')),
+    bound: moment.duration(3, 'minute'),
+    interval: moment.duration(1, 'minute'),
   },
   {
-    bound: Number(moment.duration(45, 'second')),
-    interval: Number(moment.duration(30, 'second')),
+    bound: moment.duration(45, 'second'),
+    interval: moment.duration(30, 'second'),
   },
   {
-    bound: Number(moment.duration(15, 'second')),
-    interval: Number(moment.duration(10, 'second')),
+    bound: moment.duration(15, 'second'),
+    interval: moment.duration(10, 'second'),
   },
   {
-    bound: Number(moment.duration(7.5, 'second')),
-    interval: Number(moment.duration(5, 'second')),
+    bound: moment.duration(7.5, 'second'),
+    interval: moment.duration(5, 'second'),
   },
   {
-    bound: Number(moment.duration(5, 'second')),
-    interval: Number(moment.duration(1, 'second')),
+    bound: moment.duration(5, 'second'),
+    interval: moment.duration(1, 'second'),
   },
   {
-    bound: Number(moment.duration(500, 'ms')),
-    interval: Number(moment.duration(100, 'ms')),
+    bound: moment.duration(500, 'ms'),
+    interval: moment.duration(100, 'ms'),
   },
 ];
 
+const boundsDescending = boundsDescendingRaw.map(({ bound, interval }) => ({
+  bound: Number(bound),
+  interval: Number(interval),
+}));
+
 function getPerBucketMs(count: number, duration: number) {
   const ms = duration / count;
   return isFinite(ms) ? ms : NaN;

src/plugins/data/public/index.ts

@@ -318,6 +318,7 @@ import {
   parseEsInterval,
   parseInterval,
   toAbsoluteDates,
+  boundsDescendingRaw,
   // expressions utils
   getRequestInspectorStats,
   getResponseInspectorStats,
@@ -427,6 +428,7 @@ export const search = {
     siblingPipelineType,
     termsAggFilter,
     toAbsoluteDates,
+    boundsDescendingRaw,
   },
   getRequestInspectorStats,
   getResponseInspectorStats,

src/plugins/data/public/public.api.md

@@ -2201,6 +2201,13 @@ export const search: {
         siblingPipelineType: string;
         termsAggFilter: string[];
         toAbsoluteDates: typeof toAbsoluteDates;
+        boundsDescendingRaw: ({
+            bound: number;
+            interval: import("moment").Duration;
+        } | {
+            bound: import("moment").Duration;
+            interval: import("moment").Duration;
+        })[];
     };
     getRequestInspectorStats: typeof getRequestInspectorStats;
     getResponseInspectorStats: typeof getResponseInspectorStats;
@@ -2604,21 +2611,21 @@ export const UI_SETTINGS: {
 // src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "validateIndexPattern" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "flattenHitWrapper" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "formatHitProvider" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:411:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:412:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:421:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:422:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:423:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:424:1 - (ae-forgotten-export) The symbol "isDateHistogramBucketAggConfig" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:428:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:429:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:432:1 - (ae-forgotten-export) The symbol "parseInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:433:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:436:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:410:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:410:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:410:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:410:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:412:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:413:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:422:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:423:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:424:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:425:1 - (ae-forgotten-export) The symbol "isDateHistogramBucketAggConfig" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:429:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:430:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:433:1 - (ae-forgotten-export) The symbol "parseInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:434:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:437:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/query/state_sync/connect_to_query_state.ts:45:5 - (ae-forgotten-export) The symbol "FilterStateStore" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/search/session/session_service.ts:46:5 - (ae-forgotten-export) The symbol "UrlGeneratorStateMapping" needs to be exported by the entry point index.d.ts
 

x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx

@@ -352,6 +352,11 @@ export function DimensionEditor(props: DimensionEditorProps) {
               selectedOperationDefinition?.input,
               currentFieldIsInvalid
             )}
+            helpText={selectedOperationDefinition?.getHelpMessage?.({
+              data: props.data,
+              uiSettings: props.uiSettings,
+              currentColumn: state.layers[layerId].columns[columnId],
+            })}
           >
             <FieldSelect
               fieldIsInvalid={currentFieldIsInvalid}

x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx

@@ -187,6 +187,9 @@ describe('IndexPatternDimensionEditorPanel', () => {
             id: 'bytes',
             title: 'Bytes',
           }),
+          deserialize: jest.fn().mockReturnValue({
+            convert: () => 'formatted',
+          }),
         } as unknown) as DataPublicPluginStart['fieldFormats'],
       } as unknown) as DataPublicPluginStart,
       core: {} as CoreSetup,

x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.scss

@@ -0,0 +1,5 @@
+.lnsIndexPatternDimensionEditor__dateHistogramHelpPopover {
+  max-height: 500px;
+  max-width: 400px;
+  overflow-y: scroll;
+}