2 Commits

Author SHA1 Message Date
李启源
8987cae846 feat(坐标轴): 支持配置纵轴等分刻度
All checks were successful
Package component / package (push) Successful in 4m43s
2026-08-18 11:45:40 +08:00
李启源
233b9b0aa2 feat(坐标轴): 支持显示纵轴单位
All checks were successful
Package component / package (push) Successful in 4m18s
2026-08-18 10:06:36 +08:00
15 changed files with 241 additions and 39 deletions

View File

@@ -115,7 +115,7 @@ const data = ref<WaveformData>({
| `yDomain` | `[number, number]` | 未设置 | 所有波形的固定 Y 轴范围 | | `yDomain` | `[number, number]` | 未设置 | 所有波形的固定 Y 轴范围 |
| `yDomains` | `Record<string, [number, number]>` | 未设置 | 按 track/series ID 配置固定范围 | | `yDomains` | `Record<string, [number, number]>` | 未设置 | 按 track/series ID 配置固定范围 |
| `grid` | `WaveformGridOptions` | `{ rowCount: 2, columnCount: 1, showPagination: true }` | 网格和分页 | | `grid` | `WaveformGridOptions` | `{ rowCount: 2, columnCount: 1, showPagination: true }` | 网格和分页 |
| `axes` | `WaveformAxesOptions` | 轴线均显示 | X/Y 轴基线显隐与 X 轴 label 格式化 | | `axes` | `WaveformAxesOptions` | 轴线均显示 | X/Y 轴基线、Y 轴分割数与 X 轴 label 格式化 |
| `rendering` | `WaveformRenderingOptions` | `{}` | 降采样与点/误差棒间距 | | `rendering` | `WaveformRenderingOptions` | `{}` | 降采样与点/误差棒间距 |
| `title` / `legend` / `frameStyle` | 对应公开类型 | 未设置 | 标题、图例和图框样式 | | `title` / `legend` / `frameStyle` | 对应公开类型 | 未设置 | 标题、图例和图框样式 |
| `frameNumber` | `string \| number` | 未设置 | 图框水印内容 | | `frameNumber` | `string \| number` | 未设置 | 图框水印内容 |
@@ -208,7 +208,8 @@ import 'waveform-analysis/style.css'
范围优先级为 `trackId` 配置、`seriesId` 配置、全局 `yDomain`、数据自动范围。上下限必须 范围优先级为 `trackId` 配置、`seriesId` 配置、全局 `yDomain`、数据自动范围。上下限必须
是两个有限且不相等的数字;倒序范围会自动调整为升序,无效配置会回退到下一优先级。 是两个有限且不相等的数字;倒序范围会自动调整为升序,无效配置会回退到下一优先级。
固定范围会精确作为坐标域使用,不会经过 D3 的 `nice()` 扩展 固定范围作为 Y 轴刻度算法的初始范围;轴会按漂亮步长经过 D3 的 `nice()` 扩展,确保主刻度
等间距。原始数据和传入的范围值不会被修改。
单值轴叠加模式会合并同一根轴上所有可见系列的有效范围;多值轴模式按系列分别使用配置, 单值轴叠加模式会合并同一根轴上所有可见系列的有效范围;多值轴模式按系列分别使用配置,
超过四根轴后复用第 4 根轴的系列会取范围并集。隐藏系列不参与公共范围合并。 超过四根轴后复用第 4 根轴的系列会取范围并集。隐藏系列不参与公共范围合并。
@@ -216,6 +217,16 @@ import 'waveform-analysis/style.css'
固定范围存在时,对应图框的 Y 轴不会被平移或视口重置覆盖X 轴缩放、平移和重置保持原有 固定范围存在时,对应图框的 Y 轴不会被平移或视口重置覆盖X 轴缩放、平移和重置保持原有
行为。运行时更新或移除 `yDomain` / `yDomains` 会立即重新布局,移除后恢复自动范围。 行为。运行时更新或移除 `yDomain` / `yDomains` 会立即重新布局,移除后恢复自动范围。
### Y 轴自动等分
Y 轴默认显示 5 个主刻度(包含上下端点),并使用类似 ECharts 的 `1 / 2 / 5 × 10ⁿ` 漂亮
步长,保证主刻度之间数值等间距。可以通过 `axes.y.splitNumber` 指定主刻度总数;每条
Y 轴会独立计算:
```vue
<WaveformChart :data="chartData" :axes="{ y: { splitNumber: 5 } }" />
```
### 缩放后按可视区间加载数据 ### 缩放后按可视区间加载数据
组件支持 Plotly 风格的矩形框选缩放:在 zoom 模式下按住鼠标左键拖拽,松开后同时缩放 组件支持 Plotly 风格的矩形框选缩放:在 zoom 模式下按住鼠标左键拖拽,松开后同时缩放
@@ -298,6 +309,34 @@ chartRef.value?.setViewportDomain(trackDomain, trackIndex)
Tooltip 每个系列按 `炮号:通道 (x:值 y:值)` 格式显示。`WaveformSeries.shotNo` 为空或未提供时, Tooltip 每个系列按 `炮号:通道 (x:值 y:值)` 格式显示。`WaveformSeries.shotNo` 为空或未提供时,
炮号显示为“未配置炮号”Tooltip 不显示单位和误差附加文本。 炮号显示为“未配置炮号”Tooltip 不显示单位和误差附加文本。
### 纵轴单位
可在每个 `WaveformSeries` 上设置可选的 `unit`,单位会显示在对应 Y 轴的顶部刻度中:
```ts
const chartData = {
kind: 'series',
series: [
{
id: 'voltage',
name: '电压',
unit: 'V',
data: {
kind: 'points',
points: [
{ x: 0, y: 1200 },
{ x: 1, y: 3000 },
],
},
},
],
} satisfies WaveformData
```
当 Y 轴使用科学计数法时,顶部刻度格式为 `E+03 (V) 3`;未使用科学计数法时,格式为
`(V) 3`。单位为空、全为空白或未配置时,不显示 `(单位)`,例如仍显示为 `E+03 3``3`
多 Y 轴模式下,每根轴使用该轴首个 series 的单位。
### 线型、点型与误差棒 ### 线型、点型与误差棒
每条序列可以独立设置连线方式、数据点符号和误差棒: 每条序列可以独立设置连线方式、数据点符号和误差棒:
@@ -669,7 +708,7 @@ async function importAnnotationFile(file: File) {
字段无效时会抛出 `TypeError`,不会返回部分结果。导入包含未知 `seriesId` 的标注是允许的, 字段无效时会抛出 `TypeError`,不会返回部分结果。导入包含未知 `seriesId` 的标注是允许的,
对应曲线加载后会恢复显示。文件选择、错误提示和下载由业务层实现。 对应曲线加载后会恢复显示。文件选择、错误提示和下载由业务层实现。
X 轴刻度和左右端点先按 `timeUnit` 转换为秒或毫秒,再显示为不带分组符和科学计数法的完整普通十进制值,并可通过 `axes.x.labelFormatter` 自定义。Y 轴会根据完整显示域选择格式:最大绝对值在 `[0.01, 100)` 时显示两位普通小数;大于等于 `100`,或大于 `0` 且小于 `0.01` 时,刻度显示两位缩放值,并在轴末端单独显示共享倍率 `E±NN`,多 Y 轴分别计算倍率。tooltip 使用最多 4 位小数的本地化普通数字并省略无意义尾零;标注编辑器的 X 坐标跟随 `timeUnit` 并固定 3 位小数Y 坐标显示完整普通十进制。所有格式化都只发生在展示层,内部坐标值保持原始精度。 X 轴刻度和左右端点先按 `timeUnit` 转换为秒或毫秒,再显示为不带分组符和科学计数法的完整普通十进制值,并可通过 `axes.x.labelFormatter` 自定义。Y 轴会根据完整显示域选择格式:最大绝对值在 `[0.01, 100)` 时显示两位普通小数;大于等于 `100`,或大于 `0` 且小于 `0.01` 时,刻度显示两位缩放值,并在顶部刻度单独显示共享倍率 `E±NN`。如果 series 配置了 `unit`,顶部刻度会在倍率后追加 `(单位)`;没有科学计数法时也会显示 `(单位)`,多 Y 轴分别使用对应轴首个 series 的单位。tooltip 使用最多 4 位小数的本地化普通数字并省略无意义尾零;标注编辑器的 X 坐标跟随 `timeUnit` 并固定 3 位小数Y 坐标显示完整普通十进制。所有格式化都只发生在展示层,内部坐标值保持原始精度。
标注框默认布局在采样点正上方,只做绘图区边界裁剪;文本框通过连接箭头指向标注位置,多个标注重叠时可通过拖动手动避让。 标注框默认布局在采样点正上方,只做绘图区边界裁剪;文本框通过连接箭头指向标注位置,多个标注重叠时可通过拖动手动避让。
## 事件 ## 事件

View File

@@ -1,6 +1,6 @@
{ {
"name": "waveform-analysis", "name": "waveform-analysis",
"version": "0.1.39", "version": "0.1.41",
"main": "./dist/index.cjs", "main": "./dist/index.cjs",
"module": "./dist/index.js", "module": "./dist/index.js",
"types": "./dist/types/index.d.ts", "types": "./dist/types/index.d.ts",

View File

@@ -35,7 +35,7 @@ function track(seriesList: DisplaySeries[]): DisplayTrack {
} }
describe('fixed Y-domain layout', () => { describe('fixed Y-domain layout', () => {
it('uses an exact global fixed domain without applying nice bounds', () => { it('expands a global fixed domain to nice equal intervals', () => {
const sourceTrack = track([series('a', 0, 100)]) const sourceTrack = track([series('a', 0, 100)])
const result = buildTrackLayouts({ const result = buildTrackLayouts({
cells: [ cells: [
@@ -66,10 +66,80 @@ describe('fixed Y-domain layout', () => {
showCompactEmptyTracks: false, showCompactEmptyTracks: false,
})[0] })[0]
expect(result?.yScale.domain()).toEqual([3, 97]) expect(result?.yScale.domain()).toEqual([0, 100])
expect(result?.yAxes[0]?.tickValues).toContain(3) expect(result?.yAxes[0]?.tickValues).toContain(0)
expect(result?.yAxes[0]?.tickValues).toContain(97) expect(result?.yAxes[0]?.tickValues).toContain(100)
expect(result?.seriesPaths[0]?.yScale.domain()).toEqual([3, 97]) expect(result?.seriesPaths[0]?.yScale.domain()).toEqual([0, 100])
})
it('uses the configured split number for fixed domains', () => {
const result = buildTrackLayouts({
cells: [
{
slotIndex: 0,
row: 0,
column: 0,
left: 0,
top: 0,
width: 120,
height: 100,
plotHeight: 100,
cellHeight: 130,
xAxisBand: 30,
series: track([series('a', 0, 100)]),
},
],
grid: { rowCount: 1, columnCount: 1, showPagination: false, trackLines: {} },
displayMode: 'independent',
overlayMode: 'single-axis',
independentTransforms: [zoomIdentity],
sharedZoomDomain: [0, 1],
fixedYDomain: [3, 97],
yAxisSplitNumber: 5,
timeUnit: 'ms',
rendering: DEFAULT_WAVEFORM_RENDERING_OPTIONS,
hideSecondaryLabels: false,
yAxisLabelX: -50,
showCompactEmptyTracks: false,
})[0]
expect(result?.yAxes[0]?.majorTicks).toEqual([0, 25, 50, 75, 100])
})
it('defaults to five ticks and supports a two-tick axis', () => {
const build = (splitNumber?: number) =>
buildTrackLayouts({
cells: [
{
slotIndex: 0,
row: 0,
column: 0,
left: 0,
top: 0,
width: 120,
height: 100,
plotHeight: 100,
cellHeight: 130,
xAxisBand: 30,
series: track([series('a', 3, 97)]),
},
],
grid: { rowCount: 1, columnCount: 1, showPagination: false, trackLines: {} },
displayMode: 'independent',
overlayMode: 'single-axis',
independentTransforms: [zoomIdentity],
sharedZoomDomain: [0, 1],
fixedYDomain: [3, 97],
yAxisSplitNumber: splitNumber,
timeUnit: 'ms',
rendering: DEFAULT_WAVEFORM_RENDERING_OPTIONS,
hideSecondaryLabels: false,
yAxisLabelX: -50,
showCompactEmptyTracks: false,
})[0]?.yAxes[0]?.majorTicks
expect(build()).toHaveLength(5)
expect(build(2)).toEqual([0, 100])
}) })
it('resolves track, series, and global fixed-domain precedence', () => { it('resolves track, series, and global fixed-domain precedence', () => {

View File

@@ -9,6 +9,7 @@ import {
findClosestTrackAtPointer, findClosestTrackAtPointer,
MAX_MULTI_Y_AXIS_COUNT, MAX_MULTI_Y_AXIS_COUNT,
measureYAxisGroupClearance, measureYAxisGroupClearance,
resolveYAxisTickCount,
} from './layout' } from './layout'
function series(id: string, minimum: number, maximum: number): DisplaySeries { function series(id: string, minimum: number, maximum: number): DisplaySeries {
@@ -119,8 +120,15 @@ describe('multi-value Y-axis grouping', () => {
showCompactEmptyTracks: false, showCompactEmptyTracks: false,
})[0] })[0]
expect(result?.yScale.domain()).toEqual([25, 75]) expect(result?.yScale.domain()).toEqual([20, 80])
expect(result?.seriesPaths[0]?.yScale.domain()).toEqual([25, 75]) expect(result?.seriesPaths[0]?.yScale.domain()).toEqual([20, 80])
})
it('normalizes configured Y-axis split counts', () => {
expect(resolveYAxisTickCount(100, 0)).toBe(2)
expect(resolveYAxisTickCount(100, 4.8)).toBe(4)
expect(resolveYAxisTickCount(100, Number.NaN)).toBe(5)
expect(resolveYAxisTickCount(220)).toBe(5)
}) })
it('keeps every overlaid series on one axis in single-axis mode', () => { it('keeps every overlaid series on one axis in single-axis mode', () => {

View File

@@ -20,6 +20,13 @@ const Y_AXIS_OUTER_PADDING = 4
const Y_AXIS_LABEL_GAP = 6 const Y_AXIS_LABEL_GAP = 6
const Y_AXIS_LABEL_BAND_WIDTH = 24 const Y_AXIS_LABEL_BAND_WIDTH = 24
export function resolveYAxisTickCount(_plotHeight: number, splitNumber?: number): number {
if (typeof splitNumber === 'number' && Number.isFinite(splitNumber)) {
return Math.max(2, Math.floor(splitNumber))
}
return 5
}
export interface YAxisSeriesGroup { export interface YAxisSeriesGroup {
index: number index: number
side: 'left' | 'right' side: 'left' | 'right'
@@ -103,16 +110,22 @@ export function axisTextMetrics(
domain: [number, number], domain: [number, number],
nice = true, nice = true,
tickValues?: number[], tickValues?: number[],
unit?: string,
tickCount = 10,
): { tickTextWidth: number } { ): { tickTextWidth: number } {
const effectiveTickCount =
typeof tickCount === 'number' && Number.isFinite(tickCount)
? Math.max(2, Math.floor(tickCount))
: 10
const scale = scaleLinear(domain, [1, 0]) const scale = scaleLinear(domain, [1, 0])
if (nice) scale.nice() if (nice) scale.nice(effectiveTickCount)
const [axisMin, axisMax] = scale.domain() const [axisMin, axisMax] = scale.domain()
const values = tickValues ?? Array.from(new Set([axisMin, ...scale.ticks(10), axisMax])) const values = tickValues ?? scale.ticks(effectiveTickCount)
const topTickValue = Math.max(...values) const topTickValue = Math.max(...values)
const maximumTickCharacters = Math.max( const maximumTickCharacters = Math.max(
1, 1,
...values.map( ...values.map(
(value) => formatScientificAxisLabel(value, { axisMin, axisMax, topTickValue }).length, (value) => formatScientificAxisLabel(value, { axisMin, axisMax, topTickValue, unit }).length,
), ),
) )
return { return {
@@ -120,9 +133,10 @@ export function axisTextMetrics(
} }
} }
export function measureYAxisGroupClearance(group: YAxisSeriesGroup): number { export function measureYAxisGroupClearance(group: YAxisSeriesGroup, tickCount?: number): number {
return ( return (
axisTextMetrics(group.domain, !group.fixed).tickTextWidth + axisTextMetrics(group.domain, true, undefined, group.seriesList[0]?.unit, tickCount)
.tickTextWidth +
Y_AXIS_TICK_PADDING + Y_AXIS_TICK_PADDING +
Y_AXIS_LABEL_GAP + Y_AXIS_LABEL_GAP +
Y_AXIS_LABEL_BAND_WIDTH + Y_AXIS_LABEL_BAND_WIDTH +
@@ -130,9 +144,10 @@ export function measureYAxisGroupClearance(group: YAxisSeriesGroup): number {
) )
} }
function measureYAxisGroupTickClearance(group: YAxisSeriesGroup): number { function measureYAxisGroupTickClearance(group: YAxisSeriesGroup, tickCount?: number): number {
return ( return (
axisTextMetrics(group.domain, !group.fixed).tickTextWidth + axisTextMetrics(group.domain, true, undefined, group.seriesList[0]?.unit, tickCount)
.tickTextWidth +
Y_AXIS_TICK_PADDING + Y_AXIS_TICK_PADDING +
Y_AXIS_OUTER_PADDING Y_AXIS_OUTER_PADDING
) )
@@ -143,13 +158,14 @@ export function measureTrackYAxisClearance(
overlayMode: WaveformOverlayMode, overlayMode: WaveformOverlayMode,
yDomain?: WaveformYDomain, yDomain?: WaveformYDomain,
yDomains?: Record<string, WaveformYDomain>, yDomains?: Record<string, WaveformYDomain>,
tickCount?: number,
): { left: number; right: number } { ): { left: number; right: number } {
return resolveYAxisSeriesGroups(track, overlayMode, yDomain, yDomains).reduce( return resolveYAxisSeriesGroups(track, overlayMode, yDomain, yDomains).reduce(
(clearance, group) => { (clearance, group) => {
clearance[group.side] += clearance[group.side] +=
overlayMode === 'multi-axis' || track.visibleSeries.length === 1 overlayMode === 'multi-axis' || track.visibleSeries.length === 1
? measureYAxisGroupClearance(group) ? measureYAxisGroupClearance(group, tickCount)
: measureYAxisGroupTickClearance(group) : measureYAxisGroupTickClearance(group, tickCount)
return clearance return clearance
}, },
{ left: 0, right: 0 }, { left: 0, right: 0 },

View File

@@ -25,7 +25,7 @@ import {
type GridCellGeometry, type GridCellGeometry,
type NormalizedWaveformGridOptions, type NormalizedWaveformGridOptions,
} from './grid' } from './grid'
import { axisTextMetrics, resolveYAxisSeriesGroups } from './layout' import { axisTextMetrics, resolveYAxisSeriesGroups, resolveYAxisTickCount } from './layout'
import type { DisplaySeries, DisplayTrack, TrackLayout, WaveformYAxisLayout } from './types' import type { DisplaySeries, DisplayTrack, TrackLayout, WaveformYAxisLayout } from './types'
import { applyXDomainStrategy } from './xDomain' import { applyXDomainStrategy } from './xDomain'
import { import {
@@ -54,6 +54,7 @@ export interface BuildTrackLayoutsOptions {
yDomains?: Record<string, [number, number]> yDomains?: Record<string, [number, number]>
timeUnit: 's' | 'ms' timeUnit: 's' | 'ms'
xAxisLabelFormatter?: WaveformXAxisLabelFormatter xAxisLabelFormatter?: WaveformXAxisLabelFormatter
yAxisSplitNumber?: number
rendering: ResolvedWaveformRenderingOptions rendering: ResolvedWaveformRenderingOptions
hideSecondaryLabels: boolean hideSecondaryLabels: boolean
yAxisLabelX: number yAxisLabelX: number
@@ -124,18 +125,27 @@ export function buildTrackLayouts(options: BuildTrackLayoutsOptions): TrackLayou
) )
const sideOffsets = { left: 0, right: 0 } const sideOffsets = { left: 0, right: 0 }
const yAxes: WaveformYAxisLayout[] = yAxisGroups.map((group) => { const yAxes: WaveformYAxisLayout[] = yAxisGroups.map((group) => {
const tickCount = resolveYAxisTickCount(cell.plotHeight, options.yAxisSplitNumber)
const niceCount = Math.max(1, tickCount - 1)
const scale = scaleLinear(group.domain, [cell.plotHeight, 0]) const scale = scaleLinear(group.domain, [cell.plotHeight, 0])
if (!group.fixed) scale.nice() scale.nice(niceCount)
const majorTicks = scale.ticks(Math.max(2, Math.floor(cell.plotHeight / 55)))
const [axisStart, axisEnd] = scale.domain() const [axisStart, axisEnd] = scale.domain()
const majorTicks = Array.from(
{ length: tickCount },
(_, index) => axisStart + ((axisEnd - axisStart) * index) / (tickCount - 1),
)
const showAxisEnd = options.displayMode !== 'compact' || cell.row === 0 const showAxisEnd = options.displayMode !== 'compact' || cell.row === 0
const visibleMajorTicks = showAxisEnd const visibleMajorTicks = showAxisEnd
? majorTicks ? majorTicks
: majorTicks.filter((tick) => tick !== axisEnd) : majorTicks.filter((tick) => tick !== axisEnd)
const tickValues = Array.from( const tickValues = visibleMajorTicks
new Set([axisStart, ...visibleMajorTicks, ...(showAxisEnd ? [axisEnd] : [])]), const { tickTextWidth } = axisTextMetrics(
scale.domain() as [number, number],
false,
tickValues,
group.seriesList[0]?.unit,
tickCount,
) )
const { tickTextWidth } = axisTextMetrics(group.domain, !group.fixed, tickValues)
const clearance = const clearance =
tickTextWidth + tickTextWidth +
Y_AXIS_TICK_PADDING + Y_AXIS_TICK_PADDING +

View File

@@ -112,7 +112,16 @@ export function useWaveformLayout(context: LayoutContext) {
.flatMap((track) => .flatMap((track) =>
resolveYAxisSeriesGroups(track, props.overlayMode, props.yDomain, props.yDomains), resolveYAxisSeriesGroups(track, props.overlayMode, props.yDomain, props.yDomains),
) )
.map((group) => axisTextMetrics(group.domain, !group.fixed).tickTextWidth) .map(
(group) =>
axisTextMetrics(
group.domain,
true,
undefined,
group.seriesList[0]?.unit,
props.axes?.y?.splitNumber,
).tickTextWidth,
)
const tickTextWidth = Math.max(Y_AXIS_CHARACTER_WIDTH, ...axisText) const tickTextWidth = Math.max(Y_AXIS_CHARACTER_WIDTH, ...axisText)
const tickClearance = tickTextWidth + Y_AXIS_TICK_PADDING + Y_AXIS_OUTER_PADDING const tickClearance = tickTextWidth + Y_AXIS_TICK_PADDING + Y_AXIS_OUTER_PADDING
const labelCenterX = -( const labelCenterX = -(
@@ -157,6 +166,7 @@ export function useWaveformLayout(context: LayoutContext) {
props.overlayMode, props.overlayMode,
props.yDomain, props.yDomain,
props.yDomains, props.yDomains,
props.axes?.y?.splitNumber,
) )
return { return {
left: Math.max(maximum.left, clearance.left), left: Math.max(maximum.left, clearance.left),
@@ -298,6 +308,7 @@ export function useWaveformLayout(context: LayoutContext) {
: sharedYDomains.value, : sharedYDomains.value,
timeUnit: props.timeUnit, timeUnit: props.timeUnit,
xAxisLabelFormatter: props.axes?.x?.labelFormatter, xAxisLabelFormatter: props.axes?.x?.labelFormatter,
yAxisSplitNumber: props.axes?.y?.splitNumber,
rendering: renderingOptions.value, rendering: renderingOptions.value,
hideSecondaryLabels: isCleanView.value || yAxisLayout.value.hideSecondaryLabels, hideSecondaryLabels: isCleanView.value || yAxisLayout.value.hideSecondaryLabels,
yAxisLabelX: yAxisMetrics.value.labelCenterX, yAxisLabelX: yAxisMetrics.value.labelCenterX,

View File

@@ -44,9 +44,10 @@ function renderAxes() {
if (!element) return if (!element) return
const [axisMin, axisMax] = axis.scale.domain() const [axisMin, axisMax] = axis.scale.domain()
const topTickValue = Math.max(...axis.tickValues) const topTickValue = Math.max(...axis.tickValues)
const unit = axis.seriesList[0]?.unit
const yAxis = (axis.side === 'left' ? axisLeft(axis.scale) : axisRight(axis.scale)) const yAxis = (axis.side === 'left' ? axisLeft(axis.scale) : axisRight(axis.scale))
.tickFormat((value) => .tickFormat((value) =>
formatScientificAxisLabel(Number(value), { axisMin, axisMax, topTickValue }), formatScientificAxisLabel(Number(value), { axisMin, axisMax, topTickValue, unit }),
) )
.tickSize(-4) .tickSize(-4)
.tickPadding(7) .tickPadding(7)

View File

@@ -65,9 +65,9 @@ describe('WaveformChart', () => {
) )
expect(endTicks[0]).toHaveLength(1) expect(endTicks[0]).toHaveLength(1)
expect(Number(endTicks[0][0].text())).toBe(0.9) expect(Number(endTicks[0][0].text())).toBe(1)
expect(endTicks[1]).toHaveLength(1) expect(endTicks[1]).toHaveLength(1)
expect(Number(endTicks[1][0].text())).toBe(1.9) expect(Number(endTicks[1][0].text())).toBe(2)
expect(endTicks[2]).toHaveLength(0) expect(endTicks[2]).toHaveLength(0)
expect(endTicks[3]).toHaveLength(0) expect(endTicks[3]).toHaveLength(0)
}) })

View File

@@ -158,6 +158,12 @@ describe('WaveformChart', () => {
expect(paths[0].attributes('data-series-name')).toBe('BT2_2M') expect(paths[0].attributes('data-series-name')).toBe('BT2_2M')
const yAxisLabels = wrapper.findAll('.waveform-chart__y-axis-label') const yAxisLabels = wrapper.findAll('.waveform-chart__y-axis-label')
expect(yAxisLabels.map((label) => label.text())).toEqual(['BT2_2M', 'BT1_2M']) expect(yAxisLabels.map((label) => label.text())).toEqual(['BT2_2M', 'BT1_2M'])
expect(
wrapper
.findAll('.waveform-chart__axis--y .tick text')
.map((label) => label.text())
.some((label) => label.includes('(T)')),
).toBe(true)
expect(yAxisLabels.map((label) => label.attributes('fill'))).toEqual(['#0960bd', '#ff7f0e']) expect(yAxisLabels.map((label) => label.attributes('fill'))).toEqual(['#0960bd', '#ff7f0e'])
const labelX = Number( const labelX = Number(
yAxisLabels[0].attributes('transform')?.match(/^translate\(([-\d.]+),/)?.[1], yAxisLabels[0].attributes('transform')?.match(/^translate\(([-\d.]+),/)?.[1],
@@ -255,7 +261,7 @@ describe('WaveformChart', () => {
}) })
expect(startTicks).toHaveLength(1) expect(startTicks).toHaveLength(1)
expect(Number(startTicks[0].text())).toBe(0.1) expect(Number(startTicks[0].text())).toBe(0)
}, },
) )
@@ -291,7 +297,7 @@ describe('WaveformChart', () => {
{ displayMode }, { displayMode },
) )
const expectedEndValues = [0.9, 4.9] const expectedEndValues = [1, 5]
wrapper.findAll('.waveform-chart__track').forEach((track, index) => { wrapper.findAll('.waveform-chart__track').forEach((track, index) => {
const endTicks = track.findAll('.waveform-chart__axis--y .tick').filter((tick) => { const endTicks = track.findAll('.waveform-chart__axis--y .tick').filter((tick) => {
const match = tick.attributes('transform')?.match(/translate\(0,\s*([\d.]+)\)/) const match = tick.attributes('transform')?.match(/translate\(0,\s*([\d.]+)\)/)

View File

@@ -6,6 +6,26 @@ import { resizeObservers } from '../../test/setup'
import { gridSeries, mountSizedChart } from '../../test/waveformChart' import { gridSeries, mountSizedChart } from '../../test/waveformChart'
describe('WaveformChart', () => { describe('WaveformChart', () => {
it('applies the configured Y-axis split number', async () => {
const wrapper = await mountSizedChart(
{
kind: 'points',
points: [
{ x: 0, y: 3 },
{ x: 1, y: 97 },
],
},
{ axes: { y: { splitNumber: 5 } } },
)
expect(
wrapper
.get('.waveform-chart__axis--y')
.findAll('.tick text')
.map((tick) => tick.text()),
).toEqual(['0', '25', '50', '75', '100'])
})
it('expands the Y-axis label gutter for signed values and long exponents', async () => { it('expands the Y-axis label gutter for signed values and long exponents', async () => {
const wrapper = await mountSizedChart( const wrapper = await mountSizedChart(
{ {
@@ -296,7 +316,7 @@ describe('WaveformChart', () => {
expect(wrapper.get('.waveform-chart__axis-endpoint--end').text()).toBe('1000') expect(wrapper.get('.waveform-chart__axis-endpoint--end').text()).toBe('1000')
}) })
it('reacts to exact fixed Y-domain props and returns to automatic bounds', async () => { it('reacts to nice fixed Y-domain props and returns to automatic bounds', async () => {
const wrapper = await mountSizedChart({ const wrapper = await mountSizedChart({
kind: 'points', kind: 'points',
points: [ points: [
@@ -312,8 +332,8 @@ describe('WaveformChart', () => {
await wrapper.setProps({ yDomain: [3, 97] }) await wrapper.setProps({ yDomain: [3, 97] })
await flushPromises() await flushPromises()
expect(yTickLabels()).toContain('3') expect(yTickLabels()).toContain('0')
expect(yTickLabels()).toContain('97') expect(yTickLabels()).toContain('100')
await wrapper.setProps({ yDomain: undefined }) await wrapper.setProps({ yDomain: undefined })
await flushPromises() await flushPromises()

View File

@@ -15,6 +15,7 @@ describe('WaveformChart', () => {
{ {
trackId: 'shared-frame', trackId: 'shared-frame',
name: '普通量程', name: '普通量程',
unit: 'V',
data: { data: {
kind: 'points', kind: 'points',
points: [ points: [
@@ -26,6 +27,7 @@ describe('WaveformChart', () => {
{ {
trackId: 'shared-frame', trackId: 'shared-frame',
name: '大量程', name: '大量程',
unit: 'A',
data: { data: {
kind: 'points', kind: 'points',
points: [ points: [
@@ -37,6 +39,7 @@ describe('WaveformChart', () => {
{ {
trackId: 'shared-frame', trackId: 'shared-frame',
name: '小量程', name: '小量程',
unit: 'T',
data: { data: {
kind: 'points', kind: 'points',
points: [ points: [
@@ -57,7 +60,11 @@ describe('WaveformChart', () => {
.map((label) => label.text()) .map((label) => label.text())
.filter((label) => label.startsWith('E')), .filter((label) => label.startsWith('E')),
), ),
).toEqual([[], [expect.stringMatching(/^E\+03 /)], [expect.stringMatching(/^E-04 /)]]) ).toEqual([
[],
[expect.stringMatching(/^E\+03 \(A\) /)],
[expect.stringMatching(/^E-04 \(T\) /)],
])
}) })
it('reprojects annotations with the Y axis assigned to their series', async () => { it('reprojects annotations with the Y axis assigned to their series', async () => {

View File

@@ -174,6 +174,8 @@ export interface WaveformAxesOptions {
} }
y?: { y?: {
lineVisible?: boolean lineVisible?: boolean
/** Target total number of equal Y-axis ticks, including endpoints. Defaults to 5. */
splitNumber?: number
} }
} }

View File

@@ -40,6 +40,15 @@ describe('waveform number formatters', () => {
expect(formatScientificAxisExponent(0.0001, 0.0003)).toBe('E-04') expect(formatScientificAxisExponent(0.0001, 0.0003)).toBe('E-04')
}) })
it('appends a unit to the top tick with or without scientific notation', () => {
expect(formatScientificAxisLabel(3000, { axisMin: 1000, axisMax: 3000, unit: 'V' })).toBe(
'E+03 (V) 3',
)
expect(formatScientificAxisLabel(3, { axisMin: 0, axisMax: 3, unit: 'A' })).toBe('(A) 3')
expect(formatScientificAxisLabel(2, { axisMin: 0, axisMax: 3, unit: 'A' })).toBe('2')
expect(formatScientificAxisLabel(3, { axisMin: 0, axisMax: 3, unit: ' ' })).toBe('3')
})
it('derives the exponent from the largest absolute endpoint', () => { it('derives the exponent from the largest absolute endpoint', () => {
expect(resolveScientificAxisExponent(-9000, -1000)).toBe(3) expect(resolveScientificAxisExponent(-9000, -1000)).toBe(3)
expect(resolveScientificAxisExponent(-100_000, -3000)).toBe(5) expect(resolveScientificAxisExponent(-100_000, -3000)).toBe(5)

View File

@@ -11,6 +11,7 @@ export interface ScientificAxisLabelOptions {
axisMin?: number axisMin?: number
axisMax?: number axisMax?: number
topTickValue?: number topTickValue?: number
unit?: string
} }
/** @deprecated Use ScientificAxisLabelOptions. */ /** @deprecated Use ScientificAxisLabelOptions. */
@@ -71,9 +72,11 @@ export function formatScientificAxisLabel(
const scaledValue = exponent === null ? value : value / 10 ** exponent const scaledValue = exponent === null ? value : value / 10 ** exponent
const formattedValue = formatYAxisNumber(scaledValue) const formattedValue = formatYAxisNumber(scaledValue)
const topTickValue = options.topTickValue ?? options.axisMax const topTickValue = options.topTickValue ?? options.axisMax
return exponent !== null && value === topTickValue if (value !== topTickValue) return formattedValue
? `${formatExponent(exponent)} ${formattedValue}` const unit = options.unit?.trim()
: formattedValue const unitLabel = unit ? `(${unit}) ` : ''
const exponentLabel = exponent === null ? '' : `${formatExponent(exponent)} `
return `${exponentLabel}${unitLabel}${formattedValue}`
} }
/** Return the shared E-style multiplier for an axis, or null for a plain axis. */ /** Return the shared E-style multiplier for an axis, or null for a plain axis. */