feat: Implement support for currencies in more charts (#24594)

This commit is contained in:
Kamil Gabryjelski
2023-07-07 19:28:13 +02:00
committed by GitHub
parent c573cfcd12
commit d74d7eca23
18 changed files with 404 additions and 78 deletions

View File

@@ -0,0 +1,54 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import {
CurrencyFormatter,
ensureIsArray,
getNumberFormatter,
isSavedMetric,
NumberFormats,
QueryFormMetric,
ValueFormatter,
} from '@superset-ui/core';
export const getYAxisFormatter = (
metrics: QueryFormMetric[],
forcePercentFormatter: boolean,
customFormatters: Record<string, ValueFormatter>,
yAxisFormat: string = NumberFormats.SMART_NUMBER,
) => {
if (forcePercentFormatter) {
return getNumberFormatter(',.0%');
}
const metricsArray = ensureIsArray(metrics);
if (
metricsArray.every(isSavedMetric) &&
metricsArray
.map(metric => customFormatters[metric])
.every(
(formatter, _, formatters) =>
formatter instanceof CurrencyFormatter &&
(formatter as CurrencyFormatter)?.currency?.symbol ===
(formatters[0] as CurrencyFormatter)?.currency?.symbol,
)
) {
return customFormatters[metricsArray[0]];
}
return getNumberFormatter(yAxisFormat);
};

View File

@@ -518,7 +518,7 @@ export function getAxisType(dataType?: GenericDataType): AxisType {
export function getOverMaxHiddenFormatter(
config: {
max?: number;
formatter?: NumberFormatter;
formatter?: ValueFormatter;
} = {},
) {
const { max, formatter } = config;

View File

@@ -1,63 +0,0 @@
import {
Currency,
CurrencyFormatter,
ensureIsArray,
getNumberFormatter,
isSavedMetric,
QueryFormMetric,
ValueFormatter,
} from '@superset-ui/core';
export const buildCustomFormatters = (
metrics: QueryFormMetric | QueryFormMetric[] | undefined,
currencyFormats: Record<string, Currency>,
columnFormats: Record<string, string>,
d3Format: string | undefined,
) => {
const metricsArray = ensureIsArray(metrics);
return metricsArray.reduce((acc, metric) => {
const actualD3Format = isSavedMetric(metric)
? columnFormats[metric] ?? d3Format
: d3Format;
if (isSavedMetric(metric)) {
return currencyFormats[metric]
? {
...acc,
[metric]: new CurrencyFormatter({
d3Format: actualD3Format,
currency: currencyFormats[metric],
}),
}
: {
...acc,
[metric]: getNumberFormatter(actualD3Format),
};
}
return acc;
}, {});
};
export const getCustomFormatter = (
customFormatters: Record<string, ValueFormatter>,
metrics: QueryFormMetric | QueryFormMetric[] | undefined,
key?: string,
) => {
const metricsArray = ensureIsArray(metrics);
if (metricsArray.length === 1 && isSavedMetric(metricsArray[0])) {
return customFormatters[metricsArray[0]];
}
return key ? customFormatters[key] : undefined;
};
export const getValueFormatter = (
metrics: QueryFormMetric | QueryFormMetric[] | undefined,
currencyFormats: Record<string, Currency>,
columnFormats: Record<string, string>,
d3Format: string | undefined,
key?: string,
) =>
getCustomFormatter(
buildCustomFormatters(metrics, currencyFormats, columnFormats, d3Format),
metrics,
key,
) ?? getNumberFormatter(d3Format);