/** * 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, DataRecordValue, getSmallNumberFormatter, isProbablyHTML, sanitizeHtml, } from '@superset-ui/core'; import { GenericDataType } from '@apache-superset/core/common'; import { DataColumnMeta } from '../types'; import DateWithFormatter from './DateWithFormatter'; /** * Format text for cell value. */ function formatValue( formatter: DataColumnMeta['formatter'], value: DataRecordValue, rowData?: Record, currencyColumn?: string, ): [boolean, string] { // render undefined as empty string if (value === undefined) { return [false, '']; } // render null as `N/A` if ( value === null || // null values in temporal columns are wrapped in a Date object, so make sure we // handle them here too (value instanceof DateWithFormatter && value.input === null) ) { return [false, 'N/A']; } if (formatter) { // If formatter is a CurrencyFormatter, pass row context for AUTO mode if (formatter instanceof CurrencyFormatter) { return [false, formatter(value as number, rowData, currencyColumn)]; } return [false, formatter(value as number)]; } if (typeof value === 'string') { return isProbablyHTML(value) ? [true, sanitizeHtml(value)] : [false, value]; } return [false, value.toString()]; } export function formatColumnValue( column: DataColumnMeta, value: DataRecordValue, rowData?: Record, ) { const { dataType, formatter, config = {}, currencyCodeColumn } = column; const isNumber = dataType === GenericDataType.Numeric; const smallNumberFormatter = getSmallNumberFormatter( formatter, config.d3SmallNumberFormat, config.currencyFormat, ); return formatValue( isNumber && typeof value === 'number' && Math.abs(value) < 1 ? smallNumberFormatter : formatter, value, rowData, currencyCodeColumn, ); }