Files
redash/viz-lib/src/lib/value-format.tsx
Tsuneo Yoshioka d8ae679937 Make NULL values visible (#7439)
* Make NULL value visible
* Make the representation of NULL value configurable
* use display-as-null css class for null-value styling
2025-07-16 00:48:36 +00:00

123 lines
3.6 KiB
TypeScript

import React from "react";
import ReactDOMServer from "react-dom/server";
import moment from "moment/moment";
import numeral from "numeral";
import { isString, isArray, isUndefined, isFinite, isNil, toString } from "lodash";
import { visualizationsSettings } from "@/visualizations/visualizationsSettings";
numeral.options.scalePercentBy100 = false;
// eslint-disable-next-line
const urlPattern = /(^|[\s\n]|<br\/?>)((?:https?|ftp):\/\/[\-A-Z0-9+\u0026\u2019@#\/%?=()~_|!:,.;]*[\-A-Z0-9+\u0026@#\/%=~()_|])/gi;
const hasOwnProperty = Object.prototype.hasOwnProperty;
function NullValueComponent() {
return <span className="display-as-null">{visualizationsSettings.nullValue}</span>;
}
export function createTextFormatter(highlightLinks: any) {
if (highlightLinks) {
return (value: any) => {
if (value === null) {
return <NullValueComponent/>
}
if (isString(value)) {
const Link = visualizationsSettings.LinkComponent;
value = value.replace(urlPattern, (unused, prefix, href) => {
const link = ReactDOMServer.renderToStaticMarkup(
<Link href={href} target="_blank" rel="noopener noreferrer">
{href}
</Link>
);
return prefix + link;
});
}
return toString(value);
};
}
return (value: any) => value === null ? <NullValueComponent/> : toString(value);
}
function toMoment(value: any) {
if (moment.isMoment(value)) {
return value;
}
if (isFinite(value)) {
return moment(value);
}
// same as default `moment(value)`, but avoid fallback to `new Date()`
return moment(toString(value), [moment.ISO_8601, moment.RFC_2822]);
}
export function createDateTimeFormatter(format: any) {
if (isString(format) && format !== "") {
return (value: any) => {
if (value === null) {
return <NullValueComponent/>;
}
const wrapped = toMoment(value);
return wrapped.isValid() ? wrapped.format(format) : toString(value);
};
}
return (value: any) => value === null ? <NullValueComponent/> : toString(value);
}
export function createBooleanFormatter(values: any) {
if (isArray(values)) {
if (values.length >= 2) {
// Both `true` and `false` specified
return (value: any) => {
if (value === null) {
return <NullValueComponent/>;
}
if (isNil(value)) {
return "";
}
return "" + values[value ? 1 : 0];
};
} else if (values.length === 1) {
// Only `true`
return (value: any) => (value ? values[0] : "");
}
}
return (value: any) => {
if (value === null) {
return <NullValueComponent/>;
}
if (isNil(value)) {
return "";
}
return value ? "true" : "false";
};
}
export function createNumberFormatter(format: any, canReturnHTMLElement: boolean = false) {
if (isString(format) && format !== "") {
const n = numeral(0); // cache `numeral` instance
return (value: any) => {
if (canReturnHTMLElement && value === null) {
return <NullValueComponent/>;
}
if (value === "" || value === null) {
return "";
}
return n.set(value).format(format);
}
}
return (value: any) => (canReturnHTMLElement && value === null) ? <NullValueComponent/> : toString(value);
}
export function formatSimpleTemplate(str: any, data: any) {
if (!isString(str)) {
return "";
}
return str.replace(/{{\s*([^\s]+?)\s*}}/g, (match, prop) => {
if (hasOwnProperty.call(data, prop) && !isUndefined(data[prop])) {
return data[prop];
}
return match;
});
}