Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Lens] Allow non-numeric metrics for metric vis #169258

Merged
merged 4 commits into from Oct 30, 2023
Merged

[Lens] Allow non-numeric metrics for metric vis #169258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1cb1fed
[Lens] Allow non-numeric metrics for metric vis
mbondyra Oct 18, 2023
6e5540e
fix copy
mbondyra Oct 26, 2023
3e651fc
fix tests
mbondyra Oct 26, 2023
d06095e
fix the palette bug
mbondyra Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 40 additions & 19 deletions src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx
View file
Open in desktop
Expand Up @@ -20,12 +20,14 @@ import {
MetricWTrend,
MetricWNumber,
SettingsProps,
MetricWText,
} from '@elastic/charts';
import { getColumnByAccessor, getFormatByAccessor } from '@kbn/visualizations-plugin/common/utils';
import { ExpressionValueVisDimension } from '@kbn/visualizations-plugin/common';
import type {
Datatable,
DatatableColumn,
DatatableRow,
IInterpreterRenderHandlers,
RenderMode,
} from '@kbn/expressions-plugin/common';
Expand Down Expand Up @@ -65,6 +67,28 @@ function enhanceFieldFormat(serializedFieldFormat: SerializedFieldFormat | undef
return serializedFieldFormat ?? { id: formatId };
}

const renderSecondaryMetric = (
columns: DatatableColumn[],
row: DatatableRow,
config: Pick<VisParams, 'metric' | 'dimensions'>
) => {
let secondaryMetricColumn: DatatableColumn | undefined;
let formatSecondaryMetric: ReturnType<typeof getMetricFormatter>;
if (config.dimensions.secondaryMetric) {
secondaryMetricColumn = getColumnByAccessor(config.dimensions.secondaryMetric, columns);
formatSecondaryMetric = getMetricFormatter(config.dimensions.secondaryMetric, columns);
}
const secondaryPrefix = config.metric.secondaryPrefix ?? secondaryMetricColumn?.name;
return (
<span>
{secondaryPrefix}
{secondaryMetricColumn
? `${secondaryPrefix ? ' ' : ''}${formatSecondaryMetric!(row[secondaryMetricColumn.id])}`
: undefined}
</span>
);
};

const getMetricFormatter = (
accessor: ExpressionValueVisDimension | string,
columns: Datatable['columns']
Expand Down Expand Up @@ -149,13 +173,6 @@ export const MetricVis = ({
const primaryMetricColumn = getColumnByAccessor(config.dimensions.metric, data.columns)!;
const formatPrimaryMetric = getMetricFormatter(config.dimensions.metric, data.columns);

let secondaryMetricColumn: DatatableColumn | undefined;
let formatSecondaryMetric: ReturnType<typeof getMetricFormatter>;
if (config.dimensions.secondaryMetric) {
secondaryMetricColumn = getColumnByAccessor(config.dimensions.secondaryMetric, data.columns);
formatSecondaryMetric = getMetricFormatter(config.dimensions.secondaryMetric, data.columns);
}

let breakdownByColumn: DatatableColumn | undefined;
let formatBreakdownValue: FieldFormatConvertFunction;
if (config.dimensions.breakdownBy) {
Expand All @@ -172,28 +189,32 @@ export const MetricVis = ({
const metricConfigs: MetricSpec['data'][number] = (
breakdownByColumn ? data.rows : data.rows.slice(0, 1)
).map((row, rowIdx) => {
const value: number = row[primaryMetricColumn.id] !== null ? row[primaryMetricColumn.id] : NaN;
const value: number | string =
row[primaryMetricColumn.id] !== null ? row[primaryMetricColumn.id] : NaN;
const title = breakdownByColumn
? formatBreakdownValue(row[breakdownByColumn.id])
: primaryMetricColumn.name;
const subtitle = breakdownByColumn ? primaryMetricColumn.name : config.metric.subtitle;
const secondaryPrefix = config.metric.secondaryPrefix ?? secondaryMetricColumn?.name;

if (typeof value !== 'number') {
const nonNumericMetric: MetricWText = {
value: formatPrimaryMetric(value),
title: String(title),
subtitle,
icon: config.metric?.icon ? getIcon(config.metric?.icon) : undefined,
extra: renderSecondaryMetric(data.columns, row, config),
color: config.metric.color ?? defaultColor,
};
return nonNumericMetric;
}

mbondyra marked this conversation as resolved.
Show resolved Hide resolved
const baseMetric: MetricWNumber = {
value,
valueFormatter: formatPrimaryMetric,
title: String(title),
subtitle,
icon: config.metric?.icon ? getIcon(config.metric?.icon) : undefined,
extra: (
<span>
{secondaryPrefix}
{secondaryMetricColumn
? `${secondaryPrefix ? ' ' : ''}${formatSecondaryMetric!(
row[secondaryMetricColumn.id]
)}`
: undefined}
</span>
),
extra: renderSecondaryMetric(data.columns, row, config),
color:
config.metric.palette && value != null
? getColor(
Expand Down
27 changes: 27 additions & 0 deletions ...k/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx
View file
Open in desktop
Expand Up @@ -224,6 +224,33 @@ describe('LayerPanel', () => {
const group = instance.find('.lnsLayerPanel__dimensionContainer[data-test-subj="lnsGroup"]');
expect(group).toHaveLength(1);
});
it('does not render a hidden group', async () => {
mockVisualization.getConfiguration.mockReturnValue({
groups: [
{
groupLabel: 'A',
groupId: 'a',
accessors: [],
filterOperations: () => true,
supportsMoreColumns: true,
dataTestSubj: 'lnsGroup',
},
{
groupLabel: 'B',
groupId: 'b',
accessors: [],
filterOperations: () => true,
isHidden: true,
supportsMoreColumns: true,
dataTestSubj: 'lnsGroup',
},
],
});

const { instance } = await mountWithProvider(<LayerPanel {...getDefaultProps()} />);
const group = instance.find('.lnsLayerPanel__dimensionContainer[data-test-subj="lnsGroup"]');
expect(group).toHaveLength(1);
});

it('should render the required warning when only one group is configured', async () => {
mockVisualization.getConfiguration.mockReturnValue({
Expand Down