divide the types

mbondyra · Apr 30, 2024 · f28dd3e · f28dd3e
1 parent 8cd7dbb
commit f28dd3e
Show file tree

Hide file tree

Showing 27 changed files with 93 additions and 70 deletions.
diff --git a/packages/kbn-lens-embeddable-utils/attribute_builder/visualization_types/xy_chart.ts b/packages/kbn-lens-embeddable-utils/attribute_builder/visualization_types/xy_chart.ts
@@ -17,7 +17,7 @@ import type {
 import type { DataView } from '@kbn/data-views-plugin/public';
 import type { SavedObjectReference } from '@kbn/core/server';
 import { AxesSettingsConfig } from '@kbn/visualizations-plugin/common';
-import type { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import type { XYLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import type { Chart, ChartConfig, ChartLayer } from '../types';
 import { DEFAULT_LAYER_ID } from '../utils';
 import { XY_ID } from './constants';
@@ -131,7 +131,7 @@ export const getXYVisualizationState = (
     isVisible: false,
     position: 'right',
     showSingleSeries: false,
-    legendStats: ['currentAndLastValue' as LegendValue.CurrentAndLastValue],
+    legendStats: ['currentAndLastValue' as XYLegendValue.CurrentAndLastValue],
   },
   valueLabels: 'show',
   yLeftScale: 'linear',

diff --git a/...ressions/expression_partition_vis/common/expression_functions/waffle_vis_function.test.ts b/...ressions/expression_partition_vis/common/expression_functions/waffle_vis_function.test.ts
@@ -13,7 +13,10 @@ import {
   ValueFormats,
   LegendDisplay,
 } from '../types/expression_renderers';
-import { ExpressionValueVisDimension, LegendValue } from '@kbn/visualizations-plugin/common';
+import {
+  ExpressionValueVisDimension,
+  PartitionLegendValue,
+} from '@kbn/visualizations-plugin/common';
 import { Datatable } from '@kbn/expressions-plugin/common/expression_types/specs';
 import { waffleVisFunction } from './waffle_vis_function';
 import { PARTITION_LABELS_VALUE, PARTITION_VIS_RENDERER_NAME } from '../constants';
@@ -34,7 +37,7 @@ describe('interpreter/functions#waffleVis', () => {
 
   const visConfig: WaffleVisConfig = {
     addTooltip: true,
-    legendStats: [LegendValue.Value],
+    legendStats: [PartitionLegendValue.Value],
     metricsToLabels: JSON.stringify({}),
     legendDisplay: LegendDisplay.SHOW,
     legendPosition: 'right',

diff --git a/src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts b/src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts
@@ -11,7 +11,10 @@ import type { AllowedChartOverrides, AllowedSettingsOverrides } from '@kbn/chart
 import type { PaletteOutput } from '@kbn/coloring';
 import type { Datatable, DatatableColumn } from '@kbn/expressions-plugin/common';
 import type { SerializedFieldFormat } from '@kbn/field-formats-plugin/common';
-import type { ExpressionValueVisDimension, LegendValue } from '@kbn/visualizations-plugin/common';
+import type {
+  ExpressionValueVisDimension,
+  PartitionLegendValue,
+} from '@kbn/visualizations-plugin/common';
 import type { LegendSize } from '@kbn/visualizations-plugin/public';
 import {
   type AllowedPartitionOverrides,
@@ -80,7 +83,7 @@ export interface PartitionVisParams extends VisCommonParams {
   labels: LabelsParams;
   palette: PaletteOutput;
   isDonut?: boolean;
-  legendStats?: LegendValue[];
+  legendStats?: PartitionLegendValue[];
   respectSourceOrder?: boolean;
   emptySizeRatio?: EmptySizeRatios;
   startFromSecondLargestSlice?: boolean;
@@ -110,7 +113,7 @@ export interface MosaicVisConfig
 
 export interface WaffleVisConfig extends Omit<VisCommonConfig, 'buckets'> {
   bucket?: ExpressionValueVisDimension | string;
-  legendStats?: LegendValue[];
+  legendStats?: PartitionLegendValue[];
 }
 
 export interface PartitionChartProps {

diff --git a/...plugins/chart_expressions/expression_partition_vis/public/__stories__/shared/arg_types.ts b/...plugins/chart_expressions/expression_partition_vis/public/__stories__/shared/arg_types.ts
@@ -8,7 +8,7 @@
 
 import { Position } from '@elastic/charts';
 import { ArgTypes } from '@storybook/addons';
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { PartitionLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import { EmptySizeRatios, LegendDisplay } from '../../../common';
 import { ChartTypes } from '../../../common/types';
 
@@ -212,7 +212,7 @@ export const waffleArgTypes: ArgTypes = {
     description: 'Legend stats',
     type: { name: 'string', required: false },
     table: { type: { summary: 'string' }, defaultValue: { summary: undefined } },
-    options: [LegendValue.Value],
+    options: [PartitionLegendValue.Value],
     control: { type: 'select' },
   },
 };
diff --git a/.../chart_expressions/expression_partition_vis/public/components/partition_vis_component.tsx b/.../chart_expressions/expression_partition_vis/public/components/partition_vis_component.tsx
@@ -39,7 +39,7 @@ import {
 } from '@kbn/expressions-plugin/public';
 import type { FieldFormat } from '@kbn/field-formats-plugin/common';
 import { getOverridesFor } from '@kbn/chart-expressions-common';
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { PartitionLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import { consolidateMetricColumns } from '../../common/utils';
 import { DEFAULT_PERCENT_DECIMALS } from '../../common/constants';
 import {
@@ -564,7 +564,7 @@ const PartitionVisComponent = (props: PartitionVisComponentProps) => {
                 legendColorPicker={props.uiState ? LegendColorPickerWrapper : undefined}
                 flatLegend={flatLegend}
                 legendSort={customLegendSort}
-                showLegendExtra={visParams.legendStats?.[0] === LegendValue.Value}
+                showLegendExtra={visParams.legendStats?.[0] === PartitionLegendValue.Value}
                 onElementClick={([elementEvent]) => {
                   // this cast is safe because we are rendering a partition chart
                   const [layerValues] = elementEvent as PartitionElementEvent;

diff --git a/src/plugins/chart_expressions/expression_partition_vis/public/mocks.ts b/src/plugins/chart_expressions/expression_partition_vis/public/mocks.ts
@@ -7,7 +7,7 @@
  */
 
 import { Datatable } from '@kbn/expressions-plugin/public';
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { PartitionLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import {
   BucketColumns,
   PartitionVisParams,
@@ -382,6 +382,6 @@ export const createMockWaffleParams = (): PartitionVisParams => {
         },
       ],
     },
-    legendStats: [LegendValue.Value],
+    legendStats: [PartitionLegendValue.Value],
   };
 };
diff --git a/src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts
@@ -14,7 +14,7 @@ import type {
   DatatableColumnMeta,
   ExpressionFunctionDefinition,
 } from '@kbn/expressions-plugin/common';
-import { LegendSize, LegendValue } from '@kbn/visualizations-plugin/common';
+import { LegendSize, XYLegendValue } from '@kbn/visualizations-plugin/common';
 import { EventAnnotationOutput } from '@kbn/event-annotation-plugin/common';
 import { ExpressionValueVisDimension } from '@kbn/visualizations-plugin/common';
 
@@ -217,7 +217,7 @@ export interface LegendConfig {
   /**
    * metrics to display in the legend
    */
-  legendStats?: LegendValue[];
+  legendStats?: XYLegendValue[];
 }
 
 // Arguments to XY chart expression, with computed properties

diff --git a/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.test.tsx b/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.test.tsx
@@ -58,7 +58,7 @@ import { XYChart, XYChartRenderProps } from './xy_chart';
 import { ExtendedDataLayerConfig, XYProps, AnnotationLayerConfigResult } from '../../common/types';
 import { DataLayers } from './data_layers';
 import { SplitChart } from './split_chart';
-import { LegendSize, LegendValue } from '@kbn/visualizations-plugin/common';
+import { LegendSize, XYLegendValue } from '@kbn/visualizations-plugin/common';
 import type { LayerCellValueActions } from '../types';
 
 const onClickValue = jest.fn();
@@ -744,7 +744,7 @@ describe('XYChart component', () => {
         {...defaultProps}
         args={{
           ...args,
-          legend: { ...args.legend, legendStats: [LegendValue.CurrentAndLastValue] },
+          legend: { ...args.legend, legendStats: [XYLegendValue.CurrentAndLastValue] },
         }}
       />
     );
@@ -760,7 +760,7 @@ describe('XYChart component', () => {
           ...args,
           legend: {
             ...args.legend,
-            legendStats: [LegendValue.CurrentAndLastValue],
+            legendStats: [XYLegendValue.CurrentAndLastValue],
           },
           layers: [dateHistogramLayer],
         }}

diff --git a/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.tsx b/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.tsx
@@ -50,7 +50,7 @@ import {
 import {
   DEFAULT_LEGEND_SIZE,
   LegendSizeToPixels,
-  LegendValue,
+  XYLegendValue,
 } from '@kbn/visualizations-plugin/common/constants';
 import { PersistedState } from '@kbn/visualizations-plugin/public';
 import { getOverridesFor, ChartSizeSpec } from '@kbn/chart-expressions-common';
@@ -870,7 +870,7 @@ export function XYChart({
                 : undefined
             }
             showLegendExtra={
-              isHistogramViz && legend.legendStats?.[0] === LegendValue.CurrentAndLastValue
+              isHistogramViz && legend.legendStats?.[0] === XYLegendValue.CurrentAndLastValue
             }
             ariaLabel={args.ariaLabel}
             ariaUseDefaultSummary={!args.ariaLabel}

diff --git a/src/plugins/vis_types/pie/public/convert_to_lens/configurations/index.test.ts b/src/plugins/vis_types/pie/public/convert_to_lens/configurations/index.test.ts
@@ -6,7 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { PartitionLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import { getConfiguration } from '.';
 import { samplePieVis } from '../../sample_vis.test.mocks';
 
@@ -39,7 +39,7 @@ describe('getConfiguration', () => {
           percentDecimals: 2,
           primaryGroups: ['bucket-1'],
           secondaryGroups: [],
-          legendStats: [LegendValue.Value],
+          legendStats: [PartitionLegendValue.Value],
           truncateLegend: true,
         },
       ],

diff --git a/src/plugins/vis_types/pie/public/convert_to_lens/configurations/index.ts b/src/plugins/vis_types/pie/public/convert_to_lens/configurations/index.ts
@@ -7,7 +7,7 @@
  */
 
 import { LegendDisplay, PartitionVisParams } from '@kbn/expression-partition-vis-plugin/common';
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { PartitionLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import {
   CategoryDisplayTypes,
   NumberDisplayTypes,
@@ -28,7 +28,7 @@ const getLayers = (
   const showValuesInLegend =
     vis.params.labels.values ??
     (vis.params.legendStats
-      ? vis.params.legendStats?.[0] === LegendValue.Value
+      ? vis.params.legendStats?.[0] === PartitionLegendValue.Value
       : vis.type.visConfig.defaults.showValuesInLegend);
 
   return [
@@ -50,7 +50,7 @@ const getLayers = (
         vis.params.legendDisplay ??
         vis.type.visConfig.defaults.legendDisplay,
       legendPosition: vis.params.legendPosition ?? vis.type.visConfig.defaults.legendPosition,
-      legendStats: showValuesInLegend ? [LegendValue.Value] : undefined,
+      legendStats: showValuesInLegend ? [PartitionLegendValue.Value] : undefined,
       nestedLegend: vis.params.nestedLegend ?? vis.type.visConfig.defaults.nestedLegend,
       percentDecimals:
         vis.params.labels.percentDecimals ?? vis.type.visConfig.defaults.labels.percentDecimals,

diff --git a/src/plugins/vis_types/xy/public/convert_to_lens/configurations/index.ts b/src/plugins/vis_types/xy/public/convert_to_lens/configurations/index.ts
@@ -15,7 +15,7 @@ import {
   XYReferenceLineLayerConfig,
 } from '@kbn/visualizations-plugin/common/convert_to_lens';
 import { Vis } from '@kbn/visualizations-plugin/public';
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { XYLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import { Layer } from '..';
 import { ChartType } from '../../../common';
 import {
@@ -237,7 +237,7 @@ export const getConfiguration = (
       maxLines: vis.params.maxLegendLines ?? vis.type.visConfig.defaults.maxLegendLines,
       showSingleSeries: true,
       legendStats: Boolean(vis.params.labels.show ?? vis.type.visConfig.defaults.labels?.show)
-        ? [LegendValue.CurrentAndLastValue]
+        ? [XYLegendValue.CurrentAndLastValue]
         : undefined,
     },
     fittingFunction: fittingFunction

diff --git a/src/plugins/vis_types/xy/public/to_ast.ts b/src/plugins/vis_types/xy/public/to_ast.ts
@@ -20,7 +20,7 @@ import { buildExpression, buildExpressionFunction } from '@kbn/expressions-plugi
 import { BUCKET_TYPES } from '@kbn/data-plugin/public';
 import type { TimeRangeBounds } from '@kbn/data-plugin/common';
 import type { PaletteOutput } from '@kbn/charts-plugin/common/expressions/palette/types';
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { XYLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import {
   Dimensions,
   Dimension,
@@ -48,7 +48,7 @@ const prepareLengend = (params: VisParams, legendSize?: LegendSize) => {
     shouldTruncate: params.truncateLegend,
     showSingleSeries: true,
     legendSize,
-    legendStats: params.labels.show ? [LegendValue.CurrentAndLastValue] : undefined,
+    legendStats: params.labels.show ? [XYLegendValue.CurrentAndLastValue] : undefined,
   });
 
   return buildExpression([legend]);

diff --git a/src/plugins/visualizations/common/constants.ts b/src/plugins/visualizations/common/constants.ts
@@ -52,7 +52,10 @@ export const SUPPORTED_AGGREGATIONS = [
   ...Object.values(BUCKET_TYPES),
 ] as const;
 
-export enum LegendValue {
+export enum XYLegendValue {
   CurrentAndLastValue = 'currentAndLastValue',
+}
+
+export enum PartitionLegendValue {
   Value = 'value',
 }
diff --git a/src/plugins/visualizations/common/convert_to_lens/types/configurations.ts b/src/plugins/visualizations/common/convert_to_lens/types/configurations.ts
@@ -10,7 +10,7 @@ import { HorizontalAlignment, LayoutDirection, Position, VerticalAlignment } fro
 import { $Values } from '@kbn/utility-types';
 import type { CustomPaletteParams, PaletteOutput } from '@kbn/coloring';
 import { KibanaQueryOutput } from '@kbn/data-plugin/common';
-import { LegendSize, LegendValue } from '../../constants';
+import { LegendSize, XYLegendValue, PartitionLegendValue } from '../../constants';
 import {
   CategoryDisplayTypes,
   PartitionChartTypes,
@@ -142,7 +142,7 @@ export interface LegendConfig {
   maxLines?: number;
   shouldTruncate?: boolean;
   legendSize?: LegendSize;
-  legendStats?: LegendValue[];
+  legendStats?: XYLegendValue[];
 }
 
 export interface XYConfiguration {
@@ -238,7 +238,7 @@ export interface PartitionLayerState {
   categoryDisplay: CategoryDisplayType;
   legendDisplay: LegendDisplayType;
   legendPosition?: Position;
-  legendStats?: LegendValue[];
+  legendStats?: PartitionLegendValue[];
   nestedLegend?: boolean;
   percentDecimals?: number;
   emptySizeRatio?: number;

diff --git a/src/plugins/visualizations/common/index.ts b/src/plugins/visualizations/common/index.ts
@@ -16,4 +16,10 @@ export * from './expression_functions';
 export * from './convert_to_lens';
 export { convertToSchemaConfig } from './vis_schemas';
 
-export { LegendSize, LegendSizeToPixels, DEFAULT_LEGEND_SIZE, LegendValue } from './constants';
+export {
+  LegendSize,
+  LegendSizeToPixels,
+  DEFAULT_LEGEND_SIZE,
+  XYLegendValue,
+  PartitionLegendValue,
+} from './constants';
diff --git a/x-pack/plugins/lens/common/types.ts b/x-pack/plugins/lens/common/types.ts
@@ -10,7 +10,7 @@ import type { Position } from '@elastic/charts';
 import type { $Values } from '@kbn/utility-types';
 import { CustomPaletteParams, PaletteOutput, ColorMapping } from '@kbn/coloring';
 import type { ColorMode } from '@kbn/charts-plugin/common';
-import type { LegendSize, LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import type { LegendSize, PartitionLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import { CategoryDisplay, LegendDisplay, NumberDisplay, PieChartTypes } from './constants';
 import { layerTypes } from './layer_types';
 import { CollapseFunction } from './expressions';
@@ -64,7 +64,7 @@ export interface SharedPieLayerState {
   categoryDisplay: CategoryDisplayType;
   legendDisplay: LegendDisplayType;
   legendPosition?: Position;
-  legendStats?: LegendValue[];
+  legendStats?: PartitionLegendValue[];
   nestedLegend?: boolean;
   percentDecimals?: number;
   emptySizeRatio?: number;

diff --git a/x-pack/plugins/lens/public/shared_components/legend/legend_settings_popover.tsx b/x-pack/plugins/lens/public/shared_components/legend/legend_settings_popover.tsx
@@ -19,13 +19,13 @@ import {
 import { Position, VerticalAlignment, HorizontalAlignment } from '@elastic/charts';
 import { LegendSize } from '@kbn/visualizations-plugin/public';
 import { useDebouncedValue } from '@kbn/visualization-ui-components';
-import { LegendValue } from '@kbn/visualizations-plugin/common/constants';
+import { XYLegendValue } from '@kbn/visualizations-plugin/common/constants';
 import { ToolbarPopover, type ToolbarPopoverProps } from '../toolbar_popover';
 import { LegendLocationSettings } from './location/legend_location_settings';
 import { ColumnsNumberSetting } from './layout/columns_number_setting';
 import { LegendSizeSettings } from './size/legend_size_settings';
 
-export interface LegendSettingsPopoverProps {
+export interface LegendSettingsPopoverProps<S = XYLegendValue> {
   /**
    * Determines the legend display options
    */
@@ -109,7 +109,7 @@ export interface LegendSettingsPopoverProps {
   /**
    * value in legend status
    */
-  legendStats?: LegendValue[];
+  legendStats?: S[];
   /**
    * Callback on value in legend status change
    */
@@ -182,7 +182,7 @@ const PANEL_STYLE = {
   width: '500px',
 };
 
-export const LegendSettingsPopover: React.FunctionComponent<LegendSettingsPopoverProps> = ({
+export function LegendSettingsPopover<T = XYLegendValue>({
   legendOptions,
   mode,
   onDisplayChange,
@@ -209,7 +209,7 @@ export const LegendSettingsPopover: React.FunctionComponent<LegendSettingsPopove
   legendSize,
   onLegendSizeChange,
   showAutoLegendSizeOption,
-}) => {
+}: LegendSettingsPopoverProps<T>) {
   return (
     <ToolbarPopover
       title={i18n.translate('xpack.lens.shared.legendLabel', {
@@ -344,4 +344,4 @@ export const LegendSettingsPopover: React.FunctionComponent<LegendSettingsPopove
       )}
     </ToolbarPopover>
   );
-};
+}