179
src/utils/formatters.ts
Normal file
179
src/utils/formatters.ts
Normal file
@@ -0,0 +1,179 @@
|
||||
/**
|
||||
* 时间单位类型
|
||||
*/
|
||||
export type TimeUnit = 'ms' | 's'
|
||||
|
||||
export interface ScientificYAxisLabelOptions {
|
||||
precision?: number
|
||||
axisMin?: number
|
||||
axisMax?: number
|
||||
topTickValue?: number
|
||||
}
|
||||
|
||||
const DEFAULT_Y_AXIS_PRECISION = 2
|
||||
const SCIENTIFIC_MIN_ABSOLUTE_VALUE = 0.01
|
||||
const SCIENTIFIC_MAX_PLAIN_ABSOLUTE_VALUE = 100
|
||||
const TOOLTIP_NUMBER_FORMATTER = new Intl.NumberFormat('zh-CN', {
|
||||
maximumFractionDigits: 4,
|
||||
})
|
||||
|
||||
function formatFixedNumber(value: number, precision: number): string {
|
||||
const formatted = value.toFixed(Math.max(0, precision))
|
||||
return /^-0(?:\.0+)?$/.test(formatted) ? formatted.slice(1) : formatted
|
||||
}
|
||||
|
||||
/** Whether an axis magnitude should use one shared scientific exponent. */
|
||||
export function shouldUseScientificYAxisLabel(maxAbsoluteValue: number): boolean {
|
||||
return (
|
||||
Number.isFinite(maxAbsoluteValue) &&
|
||||
(maxAbsoluteValue >= SCIENTIFIC_MAX_PLAIN_ABSOLUTE_VALUE ||
|
||||
(maxAbsoluteValue > 0 && maxAbsoluteValue < SCIENTIFIC_MIN_ABSOLUTE_VALUE))
|
||||
)
|
||||
}
|
||||
|
||||
function resolveScientificExponent(axisMin?: number, axisMax?: number): number | null {
|
||||
if (typeof axisMin !== 'number' || typeof axisMax !== 'number') return null
|
||||
|
||||
const maxAbsoluteValue = Math.max(Math.abs(axisMin), Math.abs(axisMax))
|
||||
return shouldUseScientificYAxisLabel(maxAbsoluteValue)
|
||||
? Math.floor(Math.log10(maxAbsoluteValue))
|
||||
: null
|
||||
}
|
||||
|
||||
function formatExponent(exponent: number): string {
|
||||
const sign = exponent >= 0 ? '+' : '-'
|
||||
return `E${sign}${Math.abs(exponent).toString().padStart(2, '0')}`
|
||||
}
|
||||
|
||||
/** Format a Y-axis tick, sharing one exponent derived from the complete axis domain. */
|
||||
export function formatScientificYAxisLabel(
|
||||
value: number,
|
||||
options: ScientificYAxisLabelOptions = {},
|
||||
): string {
|
||||
if (!Number.isFinite(value)) return String(value)
|
||||
|
||||
const precision = options.precision ?? DEFAULT_Y_AXIS_PRECISION
|
||||
const exponent = resolveScientificExponent(options.axisMin, options.axisMax)
|
||||
const scaledValue = exponent === null ? value : value / 10 ** exponent
|
||||
const formattedValue = formatFixedNumber(scaledValue, precision)
|
||||
|
||||
return exponent !== null && value === options.topTickValue
|
||||
? `${formatExponent(exponent)} ${formattedValue}`
|
||||
: formattedValue
|
||||
}
|
||||
|
||||
/** Format tooltip values as localized plain numbers with at most four decimal places. */
|
||||
export function formatTooltipNumber(value: number): string {
|
||||
if (!Number.isFinite(value)) return String(value)
|
||||
if (Object.is(value, -0)) return '0'
|
||||
return TOOLTIP_NUMBER_FORMATTER.format(value)
|
||||
}
|
||||
|
||||
/** Convert a number to complete plain decimal text without forcing exponential notation. */
|
||||
export function formatPlainNumber(value: number): string {
|
||||
if (!Number.isFinite(value)) return String(value)
|
||||
if (Object.is(value, -0)) return '0'
|
||||
|
||||
const [mantissaPart, exponentPart] = value.toExponential().split('e')
|
||||
const exponent = Number(exponentPart)
|
||||
const isNegative = mantissaPart.startsWith('-')
|
||||
const digits = mantissaPart.replace('-', '').replace('.', '')
|
||||
const decimalIndex = exponent + 1
|
||||
let plainText: string
|
||||
|
||||
if (decimalIndex <= 0) {
|
||||
plainText = `0.${'0'.repeat(Math.abs(decimalIndex))}${digits}`
|
||||
} else if (decimalIndex >= digits.length) {
|
||||
plainText = `${digits}${'0'.repeat(decimalIndex - digits.length)}`
|
||||
} else {
|
||||
plainText = `${digits.slice(0, decimalIndex)}.${digits.slice(decimalIndex)}`
|
||||
}
|
||||
|
||||
return `${isNegative ? '-' : ''}${plainText}`
|
||||
}
|
||||
|
||||
/**
|
||||
* 根据时间单位转换显示值
|
||||
* @param value 原始时间值(秒)
|
||||
* @param timeUnit 时间单位
|
||||
* @returns 转换后的显示值
|
||||
*/
|
||||
export function displayTime(value: number, timeUnit: TimeUnit): number {
|
||||
return timeUnit === 'ms' ? value * 1000 : value
|
||||
}
|
||||
|
||||
/**
|
||||
* 计算端点标签的小数位数
|
||||
* @param domain 数据域 [最小值, 最大值]
|
||||
* @param timeUnit 时间单位
|
||||
* @returns 小数位数
|
||||
*/
|
||||
export function endpointFractionDigits(domain: [number, number], timeUnit: TimeUnit): number {
|
||||
const displayedSpan = Math.abs(
|
||||
displayTime(domain[1], timeUnit) - displayTime(domain[0], timeUnit),
|
||||
)
|
||||
if (!Number.isFinite(displayedSpan) || displayedSpan <= 0) return 0
|
||||
return Math.min(4, Math.max(0, Math.ceil(-Math.log10(displayedSpan / 100))))
|
||||
}
|
||||
|
||||
/**
|
||||
* 格式化端点时间(动态精度,本地化格式)
|
||||
* @param value 时间值(秒)
|
||||
* @param domain 数据域
|
||||
* @param timeUnit 时间单位
|
||||
* @returns 格式化的时间字符串
|
||||
*/
|
||||
export function formatEndpointTime(
|
||||
value: number,
|
||||
domain: [number, number],
|
||||
timeUnit: TimeUnit,
|
||||
): string {
|
||||
const displayValue = displayTime(value, timeUnit)
|
||||
const digits = endpointFractionDigits(domain, timeUnit)
|
||||
|
||||
// 如果是整数值且计算出的小数位数会导致显示小数,则强制为0
|
||||
if (displayValue === Math.floor(displayValue) && digits > 0) {
|
||||
return displayValue.toLocaleString('zh-CN', {
|
||||
minimumFractionDigits: 0,
|
||||
maximumFractionDigits: 0,
|
||||
})
|
||||
}
|
||||
|
||||
return displayValue.toLocaleString('zh-CN', {
|
||||
minimumFractionDigits: digits,
|
||||
maximumFractionDigits: digits,
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* 格式化坐标轴时间(整数,本地化格式)
|
||||
* @param value 时间值(秒)
|
||||
* @param timeUnit 时间单位
|
||||
* @returns 格式化的时间字符串
|
||||
*/
|
||||
export function formatAxisTime(value: number, timeUnit: TimeUnit): string {
|
||||
const displayValue = displayTime(value, timeUnit)
|
||||
return displayValue.toLocaleString('zh-CN', {
|
||||
maximumFractionDigits: 0,
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* 格式化悬浮提示时间(4 位小数,本地化格式)
|
||||
* @param value 时间值(秒)
|
||||
* @param timeUnit 时间单位
|
||||
* @returns 格式化的时间字符串
|
||||
*/
|
||||
export function formatTooltipTime(value: number, timeUnit: TimeUnit): string {
|
||||
const displayValue = displayTime(value, timeUnit)
|
||||
return displayValue.toLocaleString('zh-CN', {
|
||||
minimumFractionDigits: 4,
|
||||
maximumFractionDigits: 4,
|
||||
})
|
||||
}
|
||||
|
||||
/** Format an annotation X coordinate in the selected display time unit. */
|
||||
export function formatAnnotationTime(value: number, timeUnit: TimeUnit): string {
|
||||
if (!Number.isFinite(value)) return String(value)
|
||||
return formatFixedNumber(displayTime(value, timeUnit), 3)
|
||||
}
|
||||
Reference in New Issue
Block a user