feat(legend): select legend statistic value (#2355)

elastic · Apr 9, 2024 · a602838 · a602838
1 parent 40f2b7b
commit a602838
Show file tree

Hide file tree

Showing 143 changed files with 1,248 additions and 588 deletions.
diff --git a/...test.ts-snapshots/baselines/interactions/sunburst-slice-clicks-chrome-linux.png b/...test.ts-snapshots/baselines/interactions/sunburst-slice-clicks-chrome-linux.png
diff --git a/...ll.test.ts-snapshots/baselines/legend/piechart-repeated-labels-chrome-linux.png b/...ll.test.ts-snapshots/baselines/legend/piechart-repeated-labels-chrome-linux.png
diff --git a/...ots/all.test.ts-snapshots/baselines/mosaic-alpha/simple-mosaic-chrome-linux.png b/...ots/all.test.ts-snapshots/baselines/mosaic-alpha/simple-mosaic-chrome-linux.png
diff --git a/...nshots/all.test.ts-snapshots/baselines/sunburst/custom-tooltip-chrome-linux.png b/...nshots/all.test.ts-snapshots/baselines/sunburst/custom-tooltip-chrome-linux.png
diff --git a/....test.ts-snapshots/baselines/sunburst/sunburst-with-two-layers-chrome-linux.png b/....test.ts-snapshots/baselines/sunburst/sunburst-with-two-layers-chrome-linux.png
diff --git a/...enshots/all.test.ts-snapshots/baselines/treemap/mid-two-layers-chrome-linux.png b/...enshots/all.test.ts-snapshots/baselines/treemap/mid-two-layers-chrome-linux.png
diff --git a/...creenshots/all.test.ts-snapshots/baselines/waffle-alpha/simple-chrome-linux.png b/...creenshots/all.test.ts-snapshots/baselines/waffle-alpha/simple-chrome-linux.png
diff --git a/e2e/screenshots/all.test.ts-snapshots/baselines/waffle-alpha/test-chrome-linux.png b/e2e/screenshots/all.test.ts-snapshots/baselines/waffle-alpha/test-chrome-linux.png
diff --git a/...napshots/interactions/tooltips/should-show-tooltip-on-sunburst-chrome-linux.png b/...napshots/interactions/tooltips/should-show-tooltip-on-sunburst-chrome-linux.png
diff --git a/...der-as-nested-with-no-indent-even-if-there-are-repeated-labels-chrome-linux.png b/...der-as-nested-with-no-indent-even-if-there-are-repeated-labels-chrome-linux.png
diff --git a/.../waffle/no-stroke-artifacts-when-using-semi-transparent-colors-chrome-linux.png b/.../waffle/no-stroke-artifacts-when-using-semi-transparent-colors-chrome-linux.png
diff --git a/...est.ts-snapshots/waffle/should-render-cells-in-ascending-order-chrome-linux.png b/...est.ts-snapshots/waffle/should-render-cells-in-ascending-order-chrome-linux.png
diff --git a/packages/charts/api/charts.api.md b/packages/charts/api/charts.api.md
@@ -858,10 +858,7 @@ export interface CustomLegendProps {
         label: CategoryLabel;
         seriesType?: SeriesType;
         pointStyle?: PointStyle;
-        extraValue?: {
-            raw: PrimitiveValue;
-            formatted: string;
-        };
+        extraValue?: LegendItemValue;
         isSeriesHidden?: boolean;
         onItemOverActon: () => void;
         onItemOutAction: () => void;
@@ -1816,6 +1813,12 @@ export interface LegendColorPickerProps {
 // @public (undocumented)
 export type LegendItemListener = (series: SeriesIdentifier[]) => void;
 
+// @public (undocumented)
+export type LegendItemValue = {
+    value: PrimitiveValue;
+    label: string;
+};
+
 // @public (undocumented)
 export interface LegendLabelOptions {
     maxLines: number;
@@ -1851,6 +1854,7 @@ export interface LegendSpec {
     legendSize: number;
     legendSort?: SeriesCompareFn;
     legendStrategy?: LegendStrategy;
+    legendValues: Array<LegendValue>;
     // (undocumented)
     onLegendItemClick?: LegendItemListener;
     // (undocumented)
@@ -1862,7 +1866,6 @@ export interface LegendSpec {
     // (undocumented)
     onLegendItemPlusClick?: LegendItemListener;
     showLegend: boolean;
-    showLegendExtra: boolean;
 }
 
 // @public (undocumented)
@@ -1887,6 +1890,33 @@ export interface LegendStyle {
     verticalWidth: number;
 }
 
+// @public (undocumented)
+export const LegendValue: Readonly<{
+    None: "none";
+    CurrentAndLastValue: "currentAndLastValue";
+    LastValue: "lastValue";
+    LastNonNullValue: "lastNonNullValue";
+    Average: "average";
+    Median: "median";
+    Max: "max";
+    Min: "min";
+    FirstValue: "firstValue";
+    FirstNonNullValue: "firstNonNullValue";
+    Total: "total";
+    Count: "count";
+    DistinctCount: "distinctCount";
+    Variance: "variance";
+    StdDeviation: "stdDeviation";
+    Range: "range";
+    Difference: "difference";
+    DifferencePercent: "differencePercent";
+    Value: "value";
+    Percent: "percent";
+}>;
+
+// @public (undocumented)
+export type LegendValue = $Values<typeof LegendValue>;
+
 // @public
 export const LIGHT_BASE_COLORS: ChartBaseColors;
 
@@ -2708,7 +2738,7 @@ export const Settings: (props: SFProps<SettingsSpec, keyof (typeof settingsBuild
 // Warning: (ae-forgotten-export) The symbol "BuildProps" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export const settingsBuildProps: BuildProps<SettingsSpec, "id" | "chartType" | "specType", "debug" | "locale" | "rotation" | "baseTheme" | "rendering" | "animateData" | "externalPointerEvents" | "pointBuffer" | "pointerUpdateTrigger" | "brushAxis" | "minBrushDelta" | "allowBrushingLastHistogramBin" | "ariaLabelHeadingLevel" | "ariaUseDefaultSummary" | "dow" | "showLegend" | "legendPosition" | "showLegendExtra" | "legendMaxDepth" | "legendSize" | "flatLegend", "ariaDescription" | "ariaLabel" | "xDomain" | "theme" | "debugState" | "onProjectionClick" | "onElementClick" | "onElementOver" | "onElementOut" | "onBrushEnd" | "onPointerUpdate" | "onResize" | "onRenderChange" | "onWillRender" | "onProjectionAreaChange" | "onAnnotationClick" | "resizeDebounce" | "pointerUpdateDebounce" | "roundHistogramBrushValues" | "orderOrdinalBinsBy" | "noResults" | "ariaLabelledBy" | "ariaDescribedBy" | "ariaTableCaption" | "legendStrategy" | "onLegendItemOver" | "onLegendItemOut" | "onLegendItemClick" | "onLegendItemPlusClick" | "onLegendItemMinusClick" | "legendAction" | "legendColorPicker" | "legendSort" | "customLegend", never>;
+export const settingsBuildProps: BuildProps<SettingsSpec, "id" | "chartType" | "specType", "debug" | "locale" | "rotation" | "baseTheme" | "rendering" | "animateData" | "externalPointerEvents" | "pointBuffer" | "pointerUpdateTrigger" | "brushAxis" | "minBrushDelta" | "allowBrushingLastHistogramBin" | "ariaLabelHeadingLevel" | "ariaUseDefaultSummary" | "dow" | "showLegend" | "legendPosition" | "legendValues" | "legendMaxDepth" | "legendSize" | "flatLegend", "ariaDescription" | "ariaLabel" | "xDomain" | "theme" | "debugState" | "onProjectionClick" | "onElementClick" | "onElementOver" | "onElementOut" | "onBrushEnd" | "onPointerUpdate" | "onResize" | "onRenderChange" | "onWillRender" | "onProjectionAreaChange" | "onAnnotationClick" | "resizeDebounce" | "pointerUpdateDebounce" | "roundHistogramBrushValues" | "orderOrdinalBinsBy" | "noResults" | "ariaLabelledBy" | "ariaDescribedBy" | "ariaTableCaption" | "legendStrategy" | "onLegendItemOver" | "onLegendItemOut" | "onLegendItemClick" | "onLegendItemPlusClick" | "onLegendItemMinusClick" | "legendAction" | "legendColorPicker" | "legendSort" | "customLegend", never>;
 
 // @public (undocumented)
 export type SettingsProps = ComponentProps<typeof Settings>;

diff --git a/packages/charts/src/chart_types/heatmap/state/selectors/compute_legend.ts b/packages/charts/src/chart_types/heatmap/state/selectors/compute_legend.ts
@@ -26,12 +26,14 @@ export const computeLegendSelector = createCustomCachedSelector(
       return {
         // the band label is considered unique by construction
         seriesIdentifiers: [{ key: label, specId: label }],
+        depth: 0,
         color,
         label,
         isSeriesHidden: deselectedDataSeries.some(({ key }) => key === label),
         isToggleable: true,
         path: [{ index: 0, value: label }],
         keys: [],
+        values: [],
       };
     });
   },

diff --git a/packages/charts/src/chart_types/heatmap/state/selectors/get_legend_items_labels.ts b/packages/charts/src/chart_types/heatmap/state/selectors/get_legend_items_labels.ts
@@ -14,9 +14,11 @@ import { getSettingsSpecSelector } from '../../../../state/selectors/get_setting
 /** @internal */
 export const getLegendItemsLabelsSelector = createCustomCachedSelector(
   [computeLegendSelector, getSettingsSpecSelector],
-  (legendItems, { showLegendExtra }): LegendItemLabel[] =>
-    legendItems.map(({ label, defaultExtra }) => ({
-      label: `${label}${showLegendExtra ? defaultExtra?.formatted ?? '' : ''}`,
-      depth: 0,
-    })),
+  (legendItems, { legendValues }): LegendItemLabel[] =>
+    legendItems.map(({ label, values }) => {
+      return {
+        label: `${label}${legendValues.length > 0 ? values[0]?.label ?? '' : ''}`,
+        depth: 0,
+      };
+    }),
 );