move legendSize default and pixel translation to expression layer

elastic · May 5, 2022 · bf828cb · bf828cb
1 parent 43a69e9
commit bf828cb
Show file tree

Hide file tree

Showing 24 changed files with 118 additions and 43 deletions.
diff --git a/...lugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts b/...lugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts
@@ -8,6 +8,7 @@
 import { Position } from '@elastic/charts';
 import { i18n } from '@kbn/i18n';
 import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common';
+import { DEFAULT_LEGEND_SIZE, LegendSize } from '@kbn/visualizations-plugin/common/constants';
 import { EXPRESSION_HEATMAP_LEGEND_NAME } from '../constants';
 import { HeatmapLegendConfig, HeatmapLegendConfigResult } from '../types';
 
@@ -52,10 +53,19 @@ export const heatmapLegendConfig: ExpressionFunctionDefinition<
       }),
     },
     legendSize: {
-      types: ['number'],
+      types: ['string'],
+      default: DEFAULT_LEGEND_SIZE,
       help: i18n.translate('expressionHeatmap.function.args.legendSize.help', {
-        defaultMessage: 'Specifies the legend size in pixels.',
+        defaultMessage: 'Specifies the legend size.',
       }),
+      options: [
+        LegendSize.AUTO,
+        LegendSize.SMALL,
+        LegendSize.MEDIUM,
+        LegendSize.LARGE,
+        LegendSize.EXTRA_LARGE,
+      ],
+      strict: true,
     },
   },
   fn(input, args) {

diff --git a/src/plugins/chart_expressions/expression_heatmap/public/components/heatmap_component.tsx b/src/plugins/chart_expressions/expression_heatmap/public/components/heatmap_component.tsx
@@ -29,6 +29,10 @@ import {
   getAccessorByDimension,
   getFormatByAccessor,
 } from '@kbn/visualizations-plugin/common/utils';
+import {
+  DEFAULT_LEGEND_SIZE,
+  LegendSizeToPixels,
+} from '@kbn/visualizations-plugin/common/constants';
 import type { HeatmapRenderProps, FilterEvent, BrushEvent } from '../../common';
 import { applyPaletteParams, findMinMaxByColumnId, getSortPredicate } from './helpers';
 import {
@@ -485,7 +489,7 @@ export const HeatmapComponent: FC<HeatmapRenderProps> = memo(
               onElementClick={interactive ? (onElementClick as ElementClickListener) : undefined}
               showLegend={showLegend ?? args.legend.isVisible}
               legendPosition={args.legend.position}
-              legendSize={args.legend.legendSize}
+              legendSize={LegendSizeToPixels[args.legend.legendSize ?? DEFAULT_LEGEND_SIZE]}
               legendColorPicker={uiState ? LegendColorPickerWrapper : undefined}
               debugState={window._echDebugStateFlag ?? false}
               tooltip={tooltip}

diff --git a/..._partition_vis/common/expression_functions/__snapshots__/mosaic_vis_function.test.ts.snap b/..._partition_vis/common/expression_functions/__snapshots__/mosaic_vis_function.test.ts.snap
diff --git a/...ion_partition_vis/common/expression_functions/__snapshots__/pie_vis_function.test.ts.snap b/...ion_partition_vis/common/expression_functions/__snapshots__/pie_vis_function.test.ts.snap
diff --git a/...partition_vis/common/expression_functions/__snapshots__/treemap_vis_function.test.ts.snap b/...partition_vis/common/expression_functions/__snapshots__/treemap_vis_function.test.ts.snap
diff --git a/..._partition_vis/common/expression_functions/__snapshots__/waffle_vis_function.test.ts.snap b/..._partition_vis/common/expression_functions/__snapshots__/waffle_vis_function.test.ts.snap
diff --git a/src/plugins/chart_expressions/expression_partition_vis/common/expression_functions/i18n.ts b/src/plugins/chart_expressions/expression_partition_vis/common/expression_functions/i18n.ts
@@ -47,7 +47,7 @@ export const strings = {
     }),
   getLegendSizeArgHelp: () =>
     i18n.translate('expressionPartitionVis.reusable.function.args.legendSizeHelpText', {
-      defaultMessage: 'Specifies the legend size in pixels',
+      defaultMessage: 'Specifies the legend size',
     }),
   getNestedLegendArgHelp: () =>
     i18n.translate('expressionPartitionVis.reusable.function.args.nestedLegendHelpText', {

diff --git a/...t_expressions/expression_partition_vis/common/expression_functions/mosaic_vis_function.ts b/...t_expressions/expression_partition_vis/common/expression_functions/mosaic_vis_function.ts
@@ -8,6 +8,7 @@
 
 import { Position } from '@elastic/charts';
 import { prepareLogTable, validateAccessor } from '@kbn/visualizations-plugin/common/utils';
+import { DEFAULT_LEGEND_SIZE, LegendSize } from '@kbn/visualizations-plugin/common/constants';
 import { LegendDisplay, PartitionVisParams } from '../types/expression_renderers';
 import { ChartTypes, MosaicVisExpressionFunctionDefinition } from '../types';
 import {
@@ -64,8 +65,17 @@ export const mosaicVisFunction = (): MosaicVisExpressionFunctionDefinition => ({
       strict: true,
     },
     legendSize: {
-      types: ['number'],
+      types: ['string'],
+      default: DEFAULT_LEGEND_SIZE,
       help: strings.getLegendSizeArgHelp(),
+      options: [
+        LegendSize.AUTO,
+        LegendSize.SMALL,
+        LegendSize.MEDIUM,
+        LegendSize.LARGE,
+        LegendSize.EXTRA_LARGE,
+      ],
+      strict: true,
     },
     nestedLegend: {
       types: ['boolean'],

diff --git a/...expressions/expression_partition_vis/common/expression_functions/pie_vis_function.test.ts b/...expressions/expression_partition_vis/common/expression_functions/pie_vis_function.test.ts
@@ -14,7 +14,7 @@ import {
   ValueFormats,
   LegendDisplay,
 } from '../types/expression_renderers';
-import { ExpressionValueVisDimension } from '@kbn/visualizations-plugin/common';
+import { ExpressionValueVisDimension, LegendSize } from '@kbn/visualizations-plugin/common';
 import { Datatable } from '@kbn/expressions-plugin/common/expression_types/specs';
 import { pieVisFunction } from './pie_vis_function';
 import { PARTITION_LABELS_VALUE } from '../constants';
@@ -31,7 +31,7 @@ describe('interpreter/functions#pieVis', () => {
     addTooltip: true,
     legendDisplay: LegendDisplay.SHOW,
     legendPosition: 'right',
-    legendSize: 80,
+    legendSize: LegendSize.SMALL,
     isDonut: true,
     emptySizeRatio: EmptySizeRatios.SMALL,
     nestedLegend: true,

diff --git a/...hart_expressions/expression_partition_vis/common/expression_functions/pie_vis_function.ts b/...hart_expressions/expression_partition_vis/common/expression_functions/pie_vis_function.ts
@@ -8,6 +8,7 @@
 
 import { Position } from '@elastic/charts';
 import { prepareLogTable, validateAccessor } from '@kbn/visualizations-plugin/common/utils';
+import { DEFAULT_LEGEND_SIZE, LegendSize } from '@kbn/visualizations-plugin/common/constants';
 import { EmptySizeRatios, LegendDisplay, PartitionVisParams } from '../types/expression_renderers';
 import { ChartTypes, PieVisExpressionFunctionDefinition } from '../types';
 import {
@@ -64,8 +65,17 @@ export const pieVisFunction = (): PieVisExpressionFunctionDefinition => ({
       strict: true,
     },
     legendSize: {
-      types: ['number'],
+      types: ['string'],
+      default: DEFAULT_LEGEND_SIZE,
       help: strings.getLegendSizeArgHelp(),
+      options: [
+        LegendSize.AUTO,
+        LegendSize.SMALL,
+        LegendSize.MEDIUM,
+        LegendSize.LARGE,
+        LegendSize.EXTRA_LARGE,
+      ],
+      strict: true,
     },
     nestedLegend: {
       types: ['boolean'],

diff --git a/..._expressions/expression_partition_vis/common/expression_functions/treemap_vis_function.ts b/..._expressions/expression_partition_vis/common/expression_functions/treemap_vis_function.ts
@@ -8,6 +8,7 @@
 
 import { Position } from '@elastic/charts';
 import { prepareLogTable, validateAccessor } from '@kbn/visualizations-plugin/common/utils';
+import { DEFAULT_LEGEND_SIZE, LegendSize } from '@kbn/visualizations-plugin/common/constants';
 import { LegendDisplay, PartitionVisParams } from '../types/expression_renderers';
 import { ChartTypes, TreemapVisExpressionFunctionDefinition } from '../types';
 import {
@@ -64,8 +65,17 @@ export const treemapVisFunction = (): TreemapVisExpressionFunctionDefinition =>
       strict: true,
     },
     legendSize: {
-      types: ['number'],
+      types: ['string'],
+      default: DEFAULT_LEGEND_SIZE,
       help: strings.getLegendSizeArgHelp(),
+      options: [
+        LegendSize.AUTO,
+        LegendSize.SMALL,
+        LegendSize.MEDIUM,
+        LegendSize.LARGE,
+        LegendSize.EXTRA_LARGE,
+      ],
+      strict: true,
     },
     nestedLegend: {
       types: ['boolean'],

diff --git a/...t_expressions/expression_partition_vis/common/expression_functions/waffle_vis_function.ts b/...t_expressions/expression_partition_vis/common/expression_functions/waffle_vis_function.ts
@@ -8,6 +8,7 @@
 
 import { Position } from '@elastic/charts';
 import { prepareLogTable, validateAccessor } from '@kbn/visualizations-plugin/common/utils';
+import { DEFAULT_LEGEND_SIZE, LegendSize } from '@kbn/visualizations-plugin/common/constants';
 import { LegendDisplay, PartitionVisParams } from '../types/expression_renderers';
 import { ChartTypes, WaffleVisExpressionFunctionDefinition } from '../types';
 import {
@@ -63,8 +64,17 @@ export const waffleVisFunction = (): WaffleVisExpressionFunctionDefinition => ({
       strict: true,
     },
     legendSize: {
-      types: ['number'],
+      types: ['string'],
+      default: DEFAULT_LEGEND_SIZE,
       help: strings.getLegendSizeArgHelp(),
+      options: [
+        LegendSize.AUTO,
+        LegendSize.SMALL,
+        LegendSize.MEDIUM,
+        LegendSize.LARGE,
+        LegendSize.EXTRA_LARGE,
+      ],
+      strict: true,
     },
     truncateLegend: {
       types: ['boolean'],

diff --git a/src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts
@@ -59,28 +59,28 @@ export type ExpressionValuePartitionLabels = ExpressionValueBoxed<
 export type PieVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof PIE_VIS_EXPRESSION_NAME,
   Datatable,
-  Omit<PieVisConfig, 'legendSize'> & { legendSize: number | undefined },
+  PieVisConfig,
   ExpressionValueRender<RenderValue>
 >;
 
 export type TreemapVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof TREEMAP_VIS_EXPRESSION_NAME,
   Datatable,
-  Omit<TreemapVisConfig, 'legendSize'> & { legendSize: number | undefined },
+  TreemapVisConfig,
   ExpressionValueRender<RenderValue>
 >;
 
 export type MosaicVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof MOSAIC_VIS_EXPRESSION_NAME,
   Datatable,
-  Omit<MosaicVisConfig, 'legendSize'> & { legendSize: number | undefined },
+  MosaicVisConfig,
   ExpressionValueRender<RenderValue>
 >;
 
 export type WaffleVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof WAFFLE_VIS_EXPRESSION_NAME,
   Datatable,
-  Omit<WaffleVisConfig, 'legendSize'> & { legendSize: number | undefined },
+  WaffleVisConfig,
   ExpressionValueRender<RenderValue>
 >;
 

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
@@ -85,7 +85,6 @@ export interface PieVisConfig extends VisCommonConfig {
   respectSourceOrder?: boolean;
   startFromSecondLargestSlice?: boolean;
   distinctColors?: boolean;
-  legendSize?: LegendSize;
   nestedLegend: boolean;
 }
 

diff --git a/...ssion_partition_vis/public/components/__snapshots__/partition_vis_component.test.tsx.snap b/...ssion_partition_vis/public/components/__snapshots__/partition_vis_component.test.tsx.snap
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
@@ -22,7 +22,11 @@ import {
 import { useEuiTheme } from '@elastic/eui';
 import type { PaletteRegistry } from '@kbn/coloring';
 import { LegendToggle, ChartsPluginSetup } from '@kbn/charts-plugin/public';
-import type { PersistedState } from '@kbn/visualizations-plugin/public';
+import {
+  DEFAULT_LEGEND_SIZE,
+  LegendSizeToPixels,
+} from '@kbn/visualizations-plugin/common/constants';
+import { PersistedState } from '@kbn/visualizations-plugin/public';
 import { getColumnByAccessor } from '@kbn/visualizations-plugin/common/utils';
 import {
   Datatable,
@@ -387,7 +391,7 @@ const PartitionVisComponent = (props: PartitionVisComponentProps) => {
                   showLegend ?? shouldShowLegend(visType, visParams.legendDisplay, bucketColumns)
                 }
                 legendPosition={legendPosition}
-                legendSize={visParams.legendSize}
+                legendSize={LegendSizeToPixels[visParams.legendSize ?? DEFAULT_LEGEND_SIZE]}
                 legendMaxDepth={visParams.nestedLegend ? undefined : 1}
                 legendColorPicker={props.uiState ? LegendColorPickerWrapper : undefined}
                 flatLegend={flatLegend}

diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts
@@ -8,6 +8,7 @@
 
 import { HorizontalAlignment, Position, VerticalAlignment } from '@elastic/charts';
 import { i18n } from '@kbn/i18n';
+import { DEFAULT_LEGEND_SIZE, LegendSize } from '@kbn/visualizations-plugin/common/constants';
 import { LEGEND_CONFIG } from '../constants';
 import { LegendConfigFn } from '../types';
 
@@ -85,10 +86,19 @@ export const legendConfigFunction: LegendConfigFn = {
       }),
     },
     legendSize: {
-      types: ['number'],
+      types: ['string'],
+      default: DEFAULT_LEGEND_SIZE,
       help: i18n.translate('expressionXY.legendConfig.legendSize.help', {
-        defaultMessage: 'Specifies the legend size in pixels.',
+        defaultMessage: 'Specifies the legend size.',
       }),
+      options: [
+        LegendSize.AUTO,
+        LegendSize.SMALL,
+        LegendSize.MEDIUM,
+        LegendSize.LARGE,
+        LegendSize.EXTRA_LARGE,
+      ],
+      strict: true,
     },
   },
   async fn(input, args, handlers) {