3 Commits

Author SHA1 Message Date
李启源
21bf0d803e feat(annotation): add serialization support
All checks were successful
Package component / package (push) Successful in 6m3s
2026-07-21 23:15:06 +08:00
李启源
4643a2dbfe fix(chart): preserve clean view geometry 2026-07-21 22:26:34 +08:00
李启源
6a6a387868 feat(chart): add zero line and clean view 2026-07-21 20:44:08 +08:00
19 changed files with 751 additions and 210 deletions

View File

@@ -40,7 +40,7 @@ pnpm add waveform-analysis vue d3 ant-design-vue vue3-colorpicker
组件库支持以下运行时版本:
| 依赖 | 支持版本 |
| --- | --- |
| -------------- | ------------- |
| Vue | `>=3.2.33 <4` |
| Ant Design Vue | `>=3.2.20 <4` |
@@ -104,12 +104,15 @@ const data = ref<WaveformData>({
| `grid` | `WaveformGridOptions` | `{ rowCount: 2, columnCount: 1, showPagination: true }` | 网格和分页 |
| `rendering` | `WaveformRenderingOptions` | `{}` | 降采样与点/误差棒间距 |
| `title` / `legend` / `frameStyle` | 对应公开类型 | 未设置 | 标题、图例和图框样式 |
| `zeroLine` | `WaveformZeroLineOptions` | `{ visible: false }` | 零值参考线显隐与样式 |
| `cleanView` | `boolean` | `false` | 仅保留波形的净图模式 |
| `annotations` | `WaveformAnnotation[]` | `[]` | 受控标注数据 |
| `hiddenSeriesIds` | `string[]` | 未设置 | 受控隐藏系列 ID |
| `defaultHiddenSeriesIds` | `string[]` | `[]` | 非受控模式的初始隐藏系列 |
所有公开类型均可从包入口导入,例如 `WaveformData``WaveformSeries`
`WaveformAnnotation``WaveformRenderingOptions``WaveformGridOptions`
`WaveformAnnotation``WaveformRenderingOptions``WaveformZeroLineOptions`
`WaveformGridOptions`
### 数据结构
@@ -381,6 +384,35 @@ const hiddenSeriesIds = ref<string[]>([])
显隐状态以规范化后的 `series.id` 为键。要在数据刷新和重新排序后稳定保留状态,每个系列都应
提供全图唯一且稳定的显式 `id`;自动生成的索引 ID 或重复 ID 添加的后缀不保证跨排序稳定。
### 零值参考线与净图
`zeroLine` 用于绘制 `y = 0` 的水平参考线,默认隐藏。参考线只在对应 Y 轴的当前 domain
包含 0 时渲染,不会为了显示参考线而扩展数据范围。多值轴模式下,每根可见 Y 轴分别按自身
scale 定位零线:
```vue
<WaveformChart
:data="chartData"
:zero-line="{
visible: true,
color: '#98a2b3',
width: 1,
dash: '6 4',
}"
/>
```
`dash` 直接对应 SVG 的 `stroke-dasharray`;传入空字符串可显示实线。无效或非正数的
`width` 会回退到 `1`
设置 `cleanView` 后,组件隐藏标题内容、图例、网格、坐标轴、轴标签、图框背景与边框、帧水印、
零值参考线、标注和分页器,同时保留原图的标题区域、边距和波形尺寸。缩放、悬浮、十字线和
tooltip 仍然可用,切换回普通模式后原有配置和标注不会丢失:
```vue
<WaveformChart :data="chartData" :clean-view="cleanViewEnabled" />
```
### 网格、分页与交互模式
`grid` 控制独立图框的行列数(范围 `110`)以及是否显示分页器。默认值为 `2` 行、
@@ -390,15 +422,13 @@ const hiddenSeriesIds = ref<string[]>([])
<WaveformChart
:data="chartData"
:grid="{ rowCount: 2, columnCount: 2, showPagination: true }"
v-model:interaction-mode="interactionMode"
:show-annotation-toolbar="true"
:interaction-mode="interactionMode"
/>
```
`interactionMode` 可选 `zoom``annotation`默认不渲染标注工具栏,推荐通过右键
打开标注编辑器;设置 `showAnnotationToolbar`显示兼容工具栏。`zoomable`
`showTooltip` 可分别关闭缩放和 tooltip。空数据或过滤后没有有效点时,组件会保留图框
布局并显示“暂无有效波形数据”。
`interactionMode` 可选 `zoom``annotation`默认使用缩放模式。右键绘图区可直接打开
标注编辑器,无需切换交互模式。`zoomable``showTooltip`分别关闭缩放和 tooltip。
空数据或过滤后没有有效点时,组件会保留图框布局并显示“暂无有效波形数据”。
## 大数据渲染
@@ -437,7 +467,13 @@ const hiddenSeriesIds = ref<string[]>([])
```vue
<script setup lang="ts">
import { ref } from 'vue'
import { WaveformChart, type WaveformAnnotation, type WaveformInteractionMode } from './index'
import {
parseWaveformAnnotations,
serializeWaveformAnnotations,
WaveformChart,
type WaveformAnnotation,
type WaveformInteractionMode,
} from './index'
const annotations = ref<WaveformAnnotation[]>([])
const annotationsVisible = ref(true)
@@ -448,16 +484,30 @@ const interactionMode = ref<WaveformInteractionMode>('zoom')
<WaveformChart
:data="chartData"
v-model:annotations="annotations"
v-model:annotations-visible="annotationsVisible"
v-model:interaction-mode="interactionMode"
:annotations-visible="annotationsVisible"
:interaction-mode="interactionMode"
/>
</template>
```
默认显示标注工具栏;右键绘图区任意位置即可弹出居中编辑器,标注会吸附到当前 X 位置最近的真实采样点,右键已有标注可以编辑或删除。需要兼容旧工具栏时可显式设置 `showAnnotationToolbar`
标注默认显示右键绘图区任意位置即可弹出居中编辑器,标注会吸附到当前 X 位置最近的真实采样点,右键已有标注可以编辑或删除。
标注框可以直接拖动进行手动避让,拖动只改变标签框位置,不会改变 `x/y` 数据锚点;偏移会以 `labelOffsetX/labelOffsetY` 像素字段保存在标注中。标注文本最多 40 个字符,边框色、文字色和背景色均支持取色与透明度调整。组件只负责内存中的受控数据,
业务层负责会话或后端持久化。
标注可以序列化为带版本号的 JSON并在解析成功后整体替换当前数据
```ts
const exportedJson = serializeWaveformAnnotations(annotations.value)
async function importAnnotationFile(file: File) {
annotations.value = parseWaveformAnnotations(await file.text())
}
```
导出格式为 `{ version: 1, annotations: [...] }`。解析会验证全部标注;文件格式、版本或任意
字段无效时会抛出 `TypeError`,不会返回部分结果。导入包含未知 `seriesId` 的标注是允许的,
对应曲线加载后会恢复显示。文件选择、错误提示和下载由业务层实现。
X、Y 轴会根据各自完整显示域选择格式:最大绝对值在 `[0.01, 100)` 时显示两位普通小数;大于等于 `100`,或大于 `0` 且小于 `0.01` 时,刻度显示两位缩放值,并在轴末端单独显示共享倍率 `E±NN`。X 轴先按 `timeUnit` 转换为秒或毫秒再判断范围,多 Y 轴则分别计算倍率。tooltip 使用最多 4 位小数的本地化普通数字;标注编辑器的 X 坐标跟随 `timeUnit` 并固定 3 位小数Y 坐标显示完整普通十进制。所有格式化都只发生在展示层,内部坐标值保持原始精度。
标注框默认布局在采样点正上方,只做绘图区边界裁剪;文本框通过连接箭头指向标注位置,多个标注重叠时可通过拖动手动避让。
@@ -475,8 +525,8 @@ X、Y 轴会根据各自完整显示域选择格式:最大绝对值在 `[0.01,
| `series-visibility-change` | 图例切换曲线显隐时触发 |
| `annotation-create` / `annotation-update` / `annotation-delete` | 标注新增、更新或删除 |
`annotations``annotations-visible``interaction-mode``hidden-series-ids` 均支持
`v-model`业务层应负责将标注和显隐状态持久化。
`annotations``hidden-series-ids` 支持 `v-model``annotations-visible`
`interaction-mode` 是受控输入属性。业务层应负责将标注和显隐状态持久化。
## 项目结构

View File

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

View File

@@ -41,6 +41,12 @@ describe('App workspace layout', { timeout: 20_000 }, () => {
expect(panel.find('[aria-label="波形展示方式"]').exists()).toBe(true)
expect(panel.find('[aria-label="波形叠加方式"]').exists()).toBe(true)
expect(panel.find('[aria-label="波形网格尺寸"]').exists()).toBe(true)
expect(panel.find('[aria-label="净图模式"]').exists()).toBe(true)
expect(panel.find('[aria-label="显示零值参考线"]').exists()).toBe(true)
const zeroLineControls = panel.get('.zero-line-controls')
expect(zeroLineControls.findAllComponents(ColorPicker)).toHaveLength(1)
expect(zeroLineControls.find('[aria-label="零值参考线线宽"]').exists()).toBe(true)
expect(zeroLineControls.find('[aria-label="零值参考线线型"]').exists()).toBe(true)
expect(frameControls.findAllComponents(ColorPicker)).toHaveLength(2)
expect(frameControls.text()).toContain('边框颜色')
expect(frameControls.text()).toContain('背景颜色')
@@ -71,6 +77,23 @@ describe('App workspace layout', { timeout: 20_000 }, () => {
wrapper.unmount()
})
it('passes clean view and zero-line controls to the chart', async () => {
const wrapper = mount(App)
await flushPromises()
const chart = wrapper.getComponent(WaveformChart)
expect(chart.props('cleanView')).toBe(false)
expect(chart.props('zeroLine')).toMatchObject({ visible: false, color: '#98a2b3', width: 1 })
await wrapper.get('[aria-label="净图模式"]').trigger('click')
await wrapper.get('[aria-label="显示零值参考线"]').trigger('click')
await flushPromises()
expect(chart.props('cleanView')).toBe(true)
expect(chart.props('zeroLine')).toMatchObject({ visible: true, color: '#98a2b3', width: 1 })
wrapper.unmount()
})
it('switches overlaid tracks between single-axis and multi-axis rendering', async () => {
const wrapper = mount(App)
await flushPromises()

View File

@@ -17,6 +17,7 @@ import {
type WaveformSeries,
type WaveformTitleOptions,
type WaveformZoomEndPayload,
type WaveformZeroLineOptions,
} from './components'
import chartWaveformsJson from './data/chartWaveforms.json'
import demoWaveformsJson from './data/demoWaveforms.json'
@@ -53,6 +54,11 @@ const frameBackgroundColor = ref('rgba(255, 255, 255, 0)')
const frameWatermarkVisible = ref(true)
const annotations = ref<WaveformAnnotation[]>([])
const annotationsVisible = ref(true)
const cleanView = ref(false)
const zeroLineVisible = ref(false)
const zeroLineColor = ref('#98a2b3')
const zeroLineWidth = ref(1)
const zeroLineDash = ref('6 4')
const interactionMode = ref<WaveformInteractionMode>('zoom')
const legendPosition = ref<WaveformLegendPosition>('top-right')
const legendOrientation = ref<WaveformLegendOrientation>('auto')
@@ -88,6 +94,11 @@ const frameBorderStyleOptions = [
{ label: '实线', value: 'solid' },
{ label: '虚线', value: 'dashed' },
]
const zeroLineDashOptions = [
{ label: '虚线', value: '6 4' },
{ label: '点划线', value: '2 3' },
{ label: '实线', value: '' },
]
const titleAlignOptions: Array<{
label: string
value: NonNullable<WaveformTitleOptions['align']>
@@ -109,6 +120,12 @@ const frameStyle = computed<WaveformFrameStyle>(() => ({
borderStyle: frameBorderStyle.value,
backgroundColor: frameBackgroundColor.value,
}))
const zeroLine = computed<WaveformZeroLineOptions>(() => ({
visible: zeroLineVisible.value,
color: zeroLineColor.value,
width: zeroLineWidth.value,
dash: zeroLineDash.value,
}))
const seriesStylePresets: Array<Pick<WaveformSeries, 'lineType' | 'pointType' | 'errorBar'>> = [
{ lineType: 'none', pointType: 'triangle', errorBar: { visible: true } },
@@ -353,6 +370,53 @@ onBeforeUnmount(() => window.removeEventListener('keydown', handleWindowKeydown)
<section class="control-section">
<h2>视图</h2>
<Button block aria-label="重置波形视图" @click="resetWaveformViewport">重置视图</Button>
<div class="auxiliary-style-controls" style="margin-top: 10px">
<label class="frame-style-control frame-style-control--switch">
<span>净图</span>
<Switch v-model:checked="cleanView" size="small" aria-label="净图模式" />
</label>
</div>
</section>
<section class="control-section">
<div class="control-section__header">
<h2>零值参考线</h2>
<Switch v-model:checked="zeroLineVisible" size="small" aria-label="显示零值参考线" />
</div>
<div class="auxiliary-style-controls zero-line-controls" style="margin-top: 10px">
<label class="frame-style-control">
<span>颜色</span>
<ColorPicker
v-model:pure-color="zeroLineColor"
aria-label="零值参考线颜色"
use-type="pure"
picker-type="chrome"
format="hex"
:disable-alpha="true"
:blur-close="true"
/>
</label>
<label class="frame-style-control">
<span>线宽</span>
<InputNumber
v-model:value="zeroLineWidth"
:min="0.5"
:max="10"
:step="0.5"
size="small"
aria-label="零值参考线线宽"
/>
</label>
<label class="frame-style-control">
<span>线型</span>
<Select
v-model:value="zeroLineDash"
:options="zeroLineDashOptions"
size="small"
aria-label="零值参考线线型"
/>
</label>
</div>
</section>
<section class="control-section">
@@ -602,10 +666,12 @@ onBeforeUnmount(() => window.removeEventListener('keydown', handleWindowKeydown)
interactive: true,
}"
:frame-style="frameStyle"
:clean-view="cleanView"
:zero-line="zeroLine"
:frame-number="frameWatermarkVisible ? 1 : undefined"
v-model:annotations="annotations"
v-model:annotations-visible="annotationsVisible"
v-model:interaction-mode="interactionMode"
:annotations-visible="annotationsVisible"
:interaction-mode="interactionMode"
v-model:hidden-series-ids="hiddenSeriesIds"
@zoom-end="handleZoomEnd"
@zoom-reset="resetWaveformViewport"

View File

@@ -220,6 +220,200 @@ describe('WaveformChart', () => {
second.unmount()
})
it('renders a configurable zero line only when the Y domain contains zero', async () => {
const wrapper = await mountSizedChart(
{
kind: 'points',
points: [
{ x: 0, y: -2 },
{ x: 1, y: 4 },
],
},
{ zeroLine: { visible: true, color: '#475467', width: 2, dash: '3 2' } },
)
const zeroLine = wrapper.get('.waveform-chart__zero-line')
expect(zeroLine.attributes()).toMatchObject({
stroke: '#475467',
'stroke-width': '2',
'stroke-dasharray': '3 2',
'data-y-axis-index': '0',
})
expect(zeroLine.attributes('y1')).toBe(zeroLine.attributes('y2'))
await wrapper.setProps({ zeroLine: { visible: false } })
expect(wrapper.find('.waveform-chart__zero-line').exists()).toBe(false)
const positive = await mountSizedChart(
{
kind: 'points',
points: [
{ x: 0, y: 2 },
{ x: 1, y: 4 },
],
},
{ zeroLine: { visible: true } },
)
expect(positive.find('.waveform-chart__zero-line').exists()).toBe(false)
})
it('renders zero lines from each visible Y axis in multi-axis mode', async () => {
const wrapper = await mountSizedChart(
{
kind: 'series',
series: [
{
id: 'small',
trackId: 'overlay',
name: 'small',
data: {
kind: 'points',
points: [
{ x: 0, y: -1 },
{ x: 1, y: 3 },
],
},
},
{
id: 'large',
trackId: 'overlay',
name: 'large',
data: {
kind: 'points',
points: [
{ x: 0, y: -10 },
{ x: 1, y: 2 },
],
},
},
],
},
{ overlayMode: 'multi-axis', zeroLine: { visible: true } },
)
const zeroLines = wrapper.findAll('.waveform-chart__zero-line')
expect(zeroLines).toHaveLength(2)
expect(zeroLines.map((line) => line.attributes('data-y-axis-index'))).toEqual(['0', '1'])
expect(zeroLines[0].attributes('y1')).not.toBe(zeroLines[1].attributes('y1'))
})
it('preserves a titled multi-axis plot and hides auxiliary layers in clean view', async () => {
const data: WaveformData = {
kind: 'series',
series: [
{
id: 'first',
trackId: 'overlay',
name: 'first',
data: {
kind: 'points',
points: [
{ x: 0, y: -1 },
{ x: 1, y: 1 },
],
},
},
{
id: 'second',
trackId: 'overlay',
name: 'second',
data: {
kind: 'points',
points: [
{ x: 0, y: 1 },
{ x: 1, y: 2 },
],
},
},
{
id: 'third',
name: 'third',
data: {
kind: 'points',
points: [
{ x: 0, y: 2 },
{ x: 1, y: 3 },
],
},
},
],
}
const sharedProps = {
grid: { rowCount: 1, columnCount: 1, showPagination: true },
overlayMode: 'multi-axis' as const,
frameNumber: 1,
annotations: [{ id: 'note', seriesId: 'first', x: 0.5, y: 0, text: 'hidden note' }],
zeroLine: { visible: true },
title: { text: 'hidden title' },
}
const regularWrapper = await mountSizedChart(data, sharedProps)
const wrapper = await mountSizedChart(data, {
...sharedProps,
cleanView: true,
})
const regularTrack = regularWrapper.get('.waveform-chart__track')
const cleanTrack = wrapper.get('.waveform-chart__track')
const geometryAttributes = [
'data-track-left',
'data-track-top',
'data-track-width',
'data-track-height',
]
expect(wrapper.get('.waveform-chart').attributes('data-chart-left-margin')).toBe(
regularWrapper.get('.waveform-chart').attributes('data-chart-left-margin'),
)
expect(wrapper.get('.waveform-chart').attributes('data-title-area-height')).toBe(
regularWrapper.get('.waveform-chart').attributes('data-title-area-height'),
)
geometryAttributes.forEach((attribute) => {
expect(cleanTrack.attributes(attribute)).toBe(regularTrack.attributes(attribute))
})
expect(wrapper.get('.waveform-chart').classes()).toContain('waveform-chart--clean')
expect(getComputedStyle(wrapper.get('.waveform-chart').element).borderColor).toBe(
'rgba(0, 0, 0, 0)',
)
expect(wrapper.findAll('.waveform-chart__series')).toHaveLength(2)
expect(wrapper.find('.waveform-chart__overlay--independent').exists()).toBe(true)
expect(wrapper.get('.waveform-chart__title-area').attributes('aria-hidden')).toBe('true')
expect(wrapper.find('.waveform-chart__title-visual').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__axis').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__grid').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__plot-frame').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__plot-background').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__watermark').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__legend-layer').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__label').exists()).toBe(false)
expect(wrapper.find('.waveform-chart__zero-line').exists()).toBe(false)
expect(wrapper.find('.waveform-annotation-layer').exists()).toBe(false)
expect(wrapper.find('.ant-pagination').exists()).toBe(false)
})
it('preserves every track geometry in a multi-column clean view', async () => {
const props = {
displayMode: 'independent' as const,
grid: { rowCount: 2, columnCount: 2 },
}
const regularWrapper = await mountSizedChart(gridSeries(4), props)
const cleanWrapper = await mountSizedChart(gridSeries(4), { ...props, cleanView: true })
const geometryAttributes = [
'data-track-left',
'data-track-top',
'data-track-width',
'data-track-height',
]
const regularTracks = regularWrapper.findAll('.waveform-chart__track')
const cleanTracks = cleanWrapper.findAll('.waveform-chart__track')
expect(cleanTracks).toHaveLength(regularTracks.length)
cleanTracks.forEach((track, index) => {
geometryAttributes.forEach((attribute) => {
expect(track.attributes(attribute)).toBe(regularTracks[index].attributes(attribute))
})
})
})
it('places start, middle, and end step transitions at the expected X positions', async () => {
const lineTypes = ['step-start', 'step-middle', 'step-end', 'step-after'] as const
const wrapper = await mountSizedChart({
@@ -1383,7 +1577,6 @@ describe('WaveformChart', () => {
expect(initialPath).toContain('L')
expect(wrapper.get('.waveform-chart__svg').attributes('width')).toBe('800')
expect(wrapper.find('.waveform-annotation-toolbar').exists()).toBe(false)
expect(wrapper.attributes('data-interaction-mode')).toBeUndefined()
resizeObservers.at(-1)?.resize(500, 360)
@@ -1682,7 +1875,6 @@ describe('WaveformChart', () => {
const wrapper = await mountSizedChart(gridSeries(2), {
title: { text: '波形标题' },
grid: { rowCount: 1, columnCount: 1, showPagination: true },
showAnnotationToolbar: true,
})
for (const selector of [
@@ -1690,7 +1882,6 @@ describe('WaveformChart', () => {
'.waveform-chart__grid',
'.waveform-chart__overlay',
'.waveform-chart__pagination',
'.waveform-annotation-toolbar',
]) {
const event = new MouseEvent('contextmenu', { bubbles: true, cancelable: true })
const dispatched = wrapper.get(selector).element.dispatchEvent(event)
@@ -2216,8 +2407,12 @@ describe('WaveformChart', () => {
)
expect(wrapper.emitted('zoom-end')).toBeUndefined()
flushAnimationFrames()
// Wait for zoom-end debounce (internal throttle + flush)
await vi.advanceTimersByTimeAsync(200)
// The wheel debounce is 200ms: it must not end early, then ends at the boundary.
await vi.advanceTimersByTimeAsync(199)
await flushPromises()
expect(wrapper.emitted('zoom-end')).toBeUndefined()
await vi.advanceTimersByTimeAsync(1)
await flushPromises()
const endEvents = wrapper.emitted('zoom-end') ?? []
@@ -3359,23 +3554,6 @@ describe('WaveformChart', () => {
expect(overlay.classes()).not.toContain('is-zoomable')
})
it('keeps the annotation toolbar available behind the compatibility prop', async () => {
const wrapper = await mountSizedChart(
{
kind: 'points',
points: [
{ x: 0, y: 0 },
{ x: 1, y: 5 },
],
},
{ showAnnotationToolbar: true },
)
expect(wrapper.find('.waveform-annotation-toolbar').exists()).toBe(true)
await wrapper.get('button[aria-label="添加标注"]').trigger('click')
expect(wrapper.attributes('data-interaction-mode')).toBe('annotation')
})
it('creates a controlled annotation from externally selected annotation mode', async () => {
const wrapper = await mountSizedChart(
{
@@ -3728,7 +3906,6 @@ describe('WaveformChart', () => {
},
{
interactionMode: 'annotation',
showAnnotationToolbar: true,
annotations: [
{ id: 'valid', seriesId: 'series-0', x: 1, y: 5, text: '显示' },
{ id: 'unknown', seriesId: 'missing', x: 1, y: 5, text: '不显示' },
@@ -3738,10 +3915,8 @@ describe('WaveformChart', () => {
expect(wrapper.attributes('data-interaction-mode')).toBe('annotation')
expect(wrapper.findAll('.waveform-annotation')).toHaveLength(1)
expect(wrapper.find('.waveform-annotation-toolbar').exists()).toBe(false)
expect(wrapper.get('.waveform-chart__overlay').classes()).toContain('is-annotating')
await wrapper.get('button[aria-label="隐藏标注"]').trigger('click')
expect(wrapper.emitted('update:annotations-visible')?.at(-1)).toEqual([false])
await wrapper.setProps({ annotationsVisible: false })
expect(wrapper.find('.waveform-annotation').exists()).toBe(false)
})

View File

@@ -38,6 +38,7 @@ import {
type WaveformPoint,
type WaveformRenderingOptions,
type WaveformTitleOptions,
type WaveformZeroLineOptions,
type WaveformZoomEndPayload,
} from './data/types'
import {
@@ -50,7 +51,6 @@ import {
type AnnotationEditorAnchor,
WaveformAnnotationContextMenu,
WaveformAnnotationLayer,
WaveformAnnotationToolbar,
type AnnotationHit,
type AnnotationSeriesCandidate,
type AnnotationSeriesInfo,
@@ -102,13 +102,14 @@ const props = withDefaults(
annotations?: WaveformAnnotation[]
annotationsVisible?: boolean
interactionMode?: WaveformInteractionMode
showAnnotationToolbar?: boolean
grid?: WaveformGridOptions
rendering?: WaveformRenderingOptions
title?: WaveformTitleOptions
legend?: WaveformLegendOptions
hiddenSeriesIds?: string[]
defaultHiddenSeriesIds?: string[]
cleanView?: boolean
zeroLine?: WaveformZeroLineOptions
}>(),
{
displayMode: 'independent',
@@ -123,11 +124,12 @@ const props = withDefaults(
annotations: () => [],
annotationsVisible: true,
interactionMode: undefined,
showAnnotationToolbar: false,
grid: () => ({ rowCount: 2, columnCount: 1, showPagination: true }),
rendering: () => ({}),
legend: () => ({ position: 'top-right', orientation: 'auto' }),
defaultHiddenSeriesIds: () => [],
cleanView: false,
zeroLine: () => ({ visible: false }),
},
)
@@ -137,8 +139,6 @@ const emit = defineEmits<{
'zoom-end': [payload: WaveformZoomEndPayload]
'zoom-reset': []
'update:annotations': [annotations: WaveformAnnotation[]]
'update:annotations-visible': [visible: boolean]
'update:interaction-mode': [mode: WaveformInteractionMode]
'update:hidden-series-ids': [ids: string[]]
'series-visibility-change': [
payload: {
@@ -175,7 +175,6 @@ const currentPage = ref(1)
const resizeObserver = shallowRef<ResizeObserver>()
const zoomBehaviors = new Map<number | 'shared', ZoomBehavior<SVGRectElement, unknown>>()
const clipPathId = useWaveformInstanceId('waveform-clip')
const internalInteractionMode = ref<WaveformInteractionMode | undefined>(undefined)
const internalHiddenSeriesIds = ref(new Set(props.defaultHiddenSeriesIds))
const annotationInteraction = useWaveformAnnotationInteraction()
const editorSeriesOptions = ref<AnnotationSeriesCandidate[]>([])
@@ -191,6 +190,8 @@ const lastIndependentZoomGestures = new Map<number, ZoomGestureKind>()
const lastZoomedTrackIndexes = new Set<number>()
const zoomThrottle = useAnimationFrameThrottle()
const hoverThrottle = useAnimationFrameThrottle()
const wheelZoomDebounceMs = 200
let wheelZoomEndTimer: ReturnType<typeof setTimeout> | undefined
const preparedSeries = usePreparedWaveformSeries(() => props.data, handleDataReferenceChange)
interface SelectionState {
@@ -255,6 +256,16 @@ const containerStyle = computed(() => ({
height: fixedHeight.value === undefined ? '100%' : `${fixedHeight.value}px`,
}))
const legendPosition = computed<WaveformLegendPosition>(() => props.legend?.position ?? 'top-right')
const isCleanView = computed(() => props.cleanView === true)
const resolvedZeroLine = computed(() => {
const width = props.zeroLine?.width
return {
visible: props.zeroLine?.visible === true,
color: props.zeroLine?.color || '#98a2b3',
width: typeof width === 'number' && Number.isFinite(width) && width > 0 ? width : 1,
dash: props.zeroLine?.dash ?? '6 4',
}
})
const legendBackgroundColor = computed(
() => props.legend?.backgroundColor || 'rgba(255, 255, 255, 0.7)',
)
@@ -273,10 +284,11 @@ const legendOrientation = computed<Exclude<WaveformLegendOrientation, 'auto'>>((
: 'vertical'
})
const resolvedTitleText = computed(() => props.title?.text.trim() ?? '')
const titleVisible = computed(
const titleAreaReserved = computed(
() =>
Boolean(props.title) && props.title?.visible !== false && resolvedTitleText.value.length > 0,
)
const titleVisible = computed(() => titleAreaReserved.value && !isCleanView.value)
const titleFontSize = computed(() => {
const fontSize = props.title?.textStyle?.fontSize
return Number.isFinite(fontSize) && (fontSize ?? 0) > 0 ? (fontSize as number) : 14
@@ -325,7 +337,8 @@ const titleLayout = computed(() =>
rotation: titleRotation.value,
}),
)
const titleAreaHeight = computed(() => (titleVisible.value ? titleLayout.value.areaHeight : 0))
const titleAreaHeight = computed(() => (titleAreaReserved.value ? titleLayout.value.areaHeight : 0))
const chartTopMargin = computed(() => margin.top)
const drawingHeight = computed(() => Math.max(0, chartHeight.value - titleAreaHeight.value))
const innerHeight = computed(() => Math.max(0, drawingHeight.value - margin.top - margin.bottom))
const titleAreaStyle = computed<CSSProperties>(() => ({
@@ -502,7 +515,7 @@ const hasWaveformData = computed(() => chartSeries.value.length > 0)
const hoveredPoint = computed(() => hoveredSeriesPoints.value[0]?.point ?? null)
const hasChartArea = computed(() => innerWidth.value > 0 && innerHeight.value > 0)
const resolvedXLabel = computed(() => props.xLabel ?? `时间(${props.timeUnit}`)
const activeInteractionMode = computed(() => props.interactionMode ?? internalInteractionMode.value)
const activeInteractionMode = computed(() => props.interactionMode)
// 当 interactionMode 未定义或为 'zoom' 时启用缩放
const isZoomMode = computed(
() => activeInteractionMode.value === 'zoom' || activeInteractionMode.value === undefined,
@@ -593,7 +606,7 @@ const trackLayouts = computed<TrackLayout[]>(() =>
: sharedYDomains.value,
timeUnit: props.timeUnit,
rendering: renderingOptions.value,
hideSecondaryLabels: yAxisLayout.value.hideSecondaryLabels,
hideSecondaryLabels: isCleanView.value || yAxisLayout.value.hideSecondaryLabels,
yAxisLabelX: yAxisMetrics.value.labelCenterX,
showCompactEmptyTracks: props.displayMode === 'compact' && hasWaveformData.value,
}),
@@ -659,6 +672,7 @@ function handleSharedZoom(event: D3ZoomEvent<SVGRectElement, unknown>) {
pendingSharedZoomTransform = event.transform
pendingSharedZoomGesture = 'wheel'
scheduleZoomCommit()
scheduleWheelZoomEnd()
}
function handleIndependentZoom(event: D3ZoomEvent<SVGRectElement, unknown>, trackIndex: number) {
@@ -667,6 +681,7 @@ function handleIndependentZoom(event: D3ZoomEvent<SVGRectElement, unknown>, trac
pendingIndependentZoomTransforms.set(trackIndex, event.transform)
pendingIndependentZoomGestures.set(trackIndex, 'wheel')
scheduleZoomCommit()
scheduleWheelZoomEnd()
}
function commitPendingZoom() {
@@ -714,9 +729,20 @@ function scheduleZoomCommit() {
function flushPendingZoom() {
zoomThrottle.flush()
commitPendingZoom()
if (lastSharedZoomGesture === 'wheel' || lastIndependentZoomGestures.size) return
emitZoomEnd()
}
function scheduleWheelZoomEnd() {
if (wheelZoomEndTimer !== undefined) clearTimeout(wheelZoomEndTimer)
wheelZoomEndTimer = setTimeout(() => {
wheelZoomEndTimer = undefined
zoomThrottle.flush()
commitPendingZoom()
emitZoomEnd()
}, wheelZoomDebounceMs)
}
function emitZoomEnd() {
if (props.displayMode === 'independent') {
lastZoomedTrackIndexes.forEach((trackIndex) => {
@@ -773,6 +799,10 @@ function cancelPendingZoom() {
lastZoomedTrackIndexes.clear()
lastIndependentZoomGestures.clear()
zoomThrottle.cancel()
if (wheelZoomEndTimer !== undefined) {
clearTimeout(wheelZoomEndTimer)
wheelZoomEndTimer = undefined
}
}
function clearZoomBindings() {
@@ -966,22 +996,6 @@ function makeAnnotationId(): string {
return `annotation-${Date.now()}-${generatedAnnotationId}`
}
function setInteractionMode(mode: WaveformInteractionMode) {
if (props.interactionMode === undefined) internalInteractionMode.value = mode
annotationInteraction.closeContextMenu()
editorSeriesOptions.value = []
emit('update:interaction-mode', mode)
}
function setAnnotationsVisible(visible: boolean) {
annotationInteraction.closeContextMenu()
if (!visible) {
annotationInteraction.closeEditor()
editorSeriesOptions.value = []
}
emit('update:annotations-visible', visible)
}
function toggleSeriesVisibility(seriesId: string) {
if (!chartSeries.value.some((series) => series.id === seriesId)) return
const nextHiddenSeriesIds = new Set(hiddenSeriesIdSet.value)
@@ -1004,7 +1018,7 @@ function resolvePointerEditorAnchor(
const track = trackIndex === undefined ? undefined : trackLayouts.value[trackIndex]
return {
x: resolvedChartLeftMargin.value + (track ? track.left + pointerX : pointerX),
y: titleAreaHeight.value + margin.top + (track ? track.top + pointerY : pointerY),
y: titleAreaHeight.value + chartTopMargin.value + (track ? track.top + pointerY : pointerY),
}
}
@@ -1018,7 +1032,7 @@ function resolveAnnotationEditorAnchor(annotation: WaveformAnnotation): Annotati
: chartWidth.value / 2,
y: track
? titleAreaHeight.value +
margin.top +
chartTopMargin.value +
track.top +
resolveSeriesYScale(track, annotation.seriesId)(annotation.y)
: chartHeight.value / 2,
@@ -1293,7 +1307,7 @@ function handleIndependentPointerMove(event: PointerEvent, trackIndex: number) {
})
commitHover(nextPoints, trackIndex, {
x: resolvedChartLeftMargin.value + track.left + pointerX,
y: titleAreaHeight.value + margin.top + track.top + pointerY,
y: titleAreaHeight.value + chartTopMargin.value + track.top + pointerY,
})
})
}
@@ -1324,7 +1338,7 @@ function handleSharedPointerMove(event: PointerEvent) {
)
commitHover(nextPoints, null, {
x: resolvedChartLeftMargin.value + pointerX,
y: titleAreaHeight.value + margin.top + pointerY,
y: titleAreaHeight.value + chartTopMargin.value + pointerY,
})
})
}
@@ -1735,7 +1749,7 @@ watch(
)
function measureTitle() {
if (!titleVisible.value || !titleMeasureElement.value) {
if (!titleAreaReserved.value || !titleMeasureElement.value) {
measuredTitleWidth.value = 0
measuredTitleHeight.value = 0
return
@@ -1746,7 +1760,7 @@ function measureTitle() {
}
watch(
[resolvedTitleText, titleVisible, titleMeasureStyle],
[resolvedTitleText, titleAreaReserved, titleMeasureStyle],
async () => {
measuredTitleWidth.value = 0
measuredTitleHeight.value = 0
@@ -1785,7 +1799,10 @@ onBeforeUnmount(() => {
:class="[
`waveform-chart--${displayMode}`,
`waveform-chart--interaction-${activeInteractionMode}`,
{ 'waveform-chart--panning': selection?.mode === 'pan' },
{
'waveform-chart--clean': isCleanView,
'waveform-chart--panning': selection?.mode === 'pan',
},
]"
:style="containerStyle"
:data-display-mode="displayMode"
@@ -1796,11 +1813,12 @@ onBeforeUnmount(() => {
@contextmenu.capture="handleNativeContextMenu"
>
<div
v-if="titleVisible"
v-if="titleAreaReserved"
class="waveform-chart__title-area"
:style="titleAreaStyle"
role="heading"
aria-level="2"
:role="titleVisible ? 'heading' : undefined"
:aria-level="titleVisible ? 2 : undefined"
:aria-hidden="isCleanView || undefined"
>
<span
ref="titleMeasureElement"
@@ -1810,7 +1828,7 @@ onBeforeUnmount(() => {
>
{{ resolvedTitleText }}
</span>
<span class="waveform-chart__title-visual" :style="titleVisualStyle">
<span v-if="titleVisible" class="waveform-chart__title-visual" :style="titleVisualStyle">
<span
class="waveform-chart__title-text"
:style="titleTextStyle"
@@ -1842,8 +1860,12 @@ onBeforeUnmount(() => {
</clipPath>
</defs>
<g :transform="`translate(${resolvedChartLeftMargin}, ${margin.top})`">
<g v-if="displayMode !== 'compact'" class="waveform-chart__grid-slots" aria-hidden="true">
<g :transform="`translate(${resolvedChartLeftMargin}, ${chartTopMargin})`">
<g
v-if="displayMode !== 'compact' && !isCleanView"
class="waveform-chart__grid-slots"
aria-hidden="true"
>
<g
v-for="cell in gridCells"
:key="`grid-slot-${cell.slotIndex}`"
@@ -1889,6 +1911,8 @@ onBeforeUnmount(() => {
:interaction-mode="activeInteractionMode"
:frame-number="resolveFrameNumber(track.index)"
:frame-style="frameStyle"
:clean-view="isCleanView"
:zero-line="resolvedZeroLine"
:time-unit="timeUnit"
:y-label="yLabel"
:hovered-point="hoveredSeriesPoints.find((p) => p.trackIndex === track.index)"
@@ -1912,6 +1936,7 @@ onBeforeUnmount(() => {
/>
<WaveformAnnotationLayer
v-if="!isCleanView"
:annotations="renderedAnnotations"
:visible="annotationsVisible"
@contextmenu="handleExistingAnnotationContextMenu"
@@ -1920,7 +1945,7 @@ onBeforeUnmount(() => {
@drag-end="endAnnotationDrag"
/>
<g class="waveform-chart__legend-layer">
<g v-if="!isCleanView" class="waveform-chart__legend-layer">
<g
v-for="track in trackLayouts"
:key="`legend-${track.index}-${track.series.name}`"
@@ -1944,7 +1969,7 @@ onBeforeUnmount(() => {
</g>
<text
v-if="resolvedXLabel"
v-if="resolvedXLabel && !isCleanView"
class="waveform-chart__label"
:x="innerWidth / 2"
:y="xAxisTitleY"
@@ -1966,7 +1991,7 @@ onBeforeUnmount(() => {
</svg>
<Pagination
v-if="gridOptions.showPagination && pageCount > 1"
v-if="gridOptions.showPagination && pageCount > 1 && !isCleanView"
class="waveform-chart__pagination"
aria-label="波形分页"
:current="currentPage"
@@ -1977,16 +2002,8 @@ onBeforeUnmount(() => {
@change="goToPage"
/>
<WaveformAnnotationToolbar
v-if="showAnnotationToolbar"
:interaction-mode="activeInteractionMode"
:annotations-visible="annotationsVisible"
@update:interaction-mode="setInteractionMode"
@update:annotations-visible="setAnnotationsVisible"
/>
<WaveformAnnotationEditor
v-if="annotationInteraction.editorDraft.value"
v-if="annotationInteraction.editorDraft.value && !isCleanView"
:annotation="annotationInteraction.editorDraft.value.annotation"
:mode="annotationInteraction.editorDraft.value.mode"
:series="editorSeries"
@@ -1998,6 +2015,7 @@ onBeforeUnmount(() => {
/>
<WaveformAnnotationContextMenu
v-if="!isCleanView"
:visible="annotationInteraction.contextMenu.value !== null"
:x="annotationInteraction.contextMenu.value?.x || 0"
:y="annotationInteraction.contextMenu.value?.y || 0"
@@ -2033,6 +2051,10 @@ onBeforeUnmount(() => {
border-radius: 6px;
}
.waveform-chart--clean {
border-color: transparent;
}
.waveform-chart__pagination {
position: absolute;
right: 10px;

View File

@@ -1,81 +0,0 @@
<script setup lang="ts">
import type { WaveformInteractionMode } from '../../types'
interface Props {
interactionMode?: WaveformInteractionMode
annotationsVisible: boolean
}
const props = defineProps<Props>()
const emit = defineEmits<{
(event: 'update:interaction-mode', mode: WaveformInteractionMode): void
(event: 'update:annotations-visible', visible: boolean): void
}>()
</script>
<template>
<div class="waveform-annotation-toolbar" role="toolbar" aria-label="波形标注工具">
<button
type="button"
:class="{ 'is-active': props.interactionMode === 'zoom' }"
aria-label="缩放模式"
title="缩放模式"
@click="emit('update:interaction-mode', 'zoom')"
>
缩放
</button>
<button
type="button"
:class="{ 'is-active': props.interactionMode === 'annotation' }"
aria-label="添加标注"
title="添加标注"
@click="emit('update:interaction-mode', 'annotation')"
>
标注
</button>
<button
type="button"
:class="{ 'is-active': props.annotationsVisible }"
:aria-pressed="props.annotationsVisible"
:aria-label="props.annotationsVisible ? '隐藏标注' : '显示标注'"
title="显示/隐藏标注"
@click="emit('update:annotations-visible', !props.annotationsVisible)"
>
{{ props.annotationsVisible ? '隐藏' : '显示' }}
</button>
</div>
</template>
<style scoped>
.waveform-annotation-toolbar {
position: absolute;
top: 8px;
right: 8px;
z-index: 10;
display: flex;
gap: 4px;
padding: 5px;
background: #fff;
border: 1px solid #dfe5ef;
border-radius: 4px;
box-shadow: 0 2px 8px rgb(0 0 0 / 8%);
}
.waveform-annotation-toolbar button {
min-width: 42px;
height: 28px;
padding: 0 7px;
color: #667085;
font-size: 12px;
background: transparent;
border: 0;
border-radius: 3px;
cursor: pointer;
}
.waveform-annotation-toolbar button:hover,
.waveform-annotation-toolbar button.is-active {
color: #1677ff;
background: #e6f4ff;
}
</style>

View File

@@ -5,7 +5,6 @@ import { ColorPicker } from 'vue3-colorpicker'
import WaveformAnnotationContextMenu from './WaveformAnnotationContextMenu.vue'
import WaveformAnnotationEditor from './WaveformAnnotationEditor.vue'
import WaveformAnnotationLayer from './WaveformAnnotationLayer.vue'
import WaveformAnnotationToolbar from './WaveformAnnotationToolbar.vue'
describe('waveform annotation controls', () => {
it('keeps dialog title ids unique across editor instances', () => {
@@ -76,18 +75,6 @@ describe('waveform annotation controls', () => {
expect(wrapper.get('.waveform-annotation-editor__series').text()).toContain('通道 A')
})
it('emits controlled toolbar changes', async () => {
const wrapper = mount(WaveformAnnotationToolbar, {
props: { interactionMode: 'zoom', annotationsVisible: true },
})
await wrapper.get('button[aria-label="添加标注"]').trigger('click')
await wrapper.get('button[aria-label="隐藏标注"]').trigger('click')
expect(wrapper.emitted('update:interaction-mode')).toEqual([['annotation']])
expect(wrapper.emitted('update:annotations-visible')).toEqual([[false]])
})
it('validates text and emits an immutable edited annotation with style defaults', async () => {
const annotation = { id: 'note', seriesId: 'a', x: 1, y: 2, text: '' }
const wrapper = mount(WaveformAnnotationEditor, {

View File

@@ -1,6 +1,6 @@
export { default as WaveformAnnotationLayer } from './WaveformAnnotationLayer.vue'
export { default as WaveformAnnotationToolbar } from './WaveformAnnotationToolbar.vue'
export { default as WaveformAnnotationContextMenu } from './WaveformAnnotationContextMenu.vue'
export * from './markup'
export * from './serialization'
export * from './types'
export * from './useWaveformAnnotationInteraction'

View File

@@ -0,0 +1,114 @@
import { describe, expect, it } from 'vitest'
import type { WaveformAnnotation } from '../../types'
import { parseWaveformAnnotations, serializeWaveformAnnotations } from './serialization'
describe('waveform annotation serialization', () => {
it('round-trips every annotation field through a versioned document', () => {
const source: WaveformAnnotation[] = [
{
id: 'note-1',
seriesId: 'channel-a',
x: 1.25,
y: -3.5,
text: '峰值',
labelOffsetX: 12,
labelOffsetY: -8,
createdAt: '2026-07-21T12:00:00.000Z',
style: {
borderColor: '#1677ff',
textColor: '#333333',
backgroundColor: 'rgba(255, 255, 255, 0.92)',
},
},
]
const sourceSnapshot = JSON.parse(JSON.stringify(source))
const parsed = parseWaveformAnnotations(serializeWaveformAnnotations(source))
expect(JSON.parse(serializeWaveformAnnotations(source))).toMatchObject({ version: 1 })
expect(source).toEqual(sourceSnapshot)
expect(parsed).toEqual(source)
expect(parsed).not.toBe(source)
expect(parsed[0]).not.toBe(source[0])
expect(parsed[0].style).not.toBe(source[0].style)
})
it('allows annotations for series that are not currently loaded', () => {
expect(
parseWaveformAnnotations(
JSON.stringify({
version: 1,
annotations: [{ id: 'future', seriesId: 'missing', x: 1, y: 2, text: '稍后显示' }],
}),
),
).toEqual([{ id: 'future', seriesId: 'missing', x: 1, y: 2, text: '稍后显示' }])
})
it.each([
['invalid JSON', '{'],
['non-object root', '[]'],
['unsupported version', JSON.stringify({ version: 2, annotations: [] })],
['missing annotation array', JSON.stringify({ version: 1 })],
[
'invalid annotation entry',
JSON.stringify({ version: 1, annotations: [{ id: 'a', seriesId: 's', x: 1 }] }),
],
[
'non-finite coordinate',
'{"version":1,"annotations":[{"id":"a","seriesId":"s","x":1e400,"y":2,"text":"a"}]}',
],
[
'overlong text',
JSON.stringify({
version: 1,
annotations: [{ id: 'a', seriesId: 's', x: 1, y: 2, text: 'a'.repeat(41) }],
}),
],
[
'duplicate IDs',
JSON.stringify({
version: 1,
annotations: [
{ id: 'a', seriesId: 's', x: 1, y: 2, text: 'one' },
{ id: 'a', seriesId: 's', x: 2, y: 3, text: 'two' },
],
}),
],
])('rejects %s without returning partial data', (_label, json) => {
expect(() => parseWaveformAnnotations(json)).toThrow('Invalid waveform annotation file')
})
it('rejects invalid optional fields and serialization input', () => {
expect(() =>
parseWaveformAnnotations(
JSON.stringify({
version: 1,
annotations: [
{
id: 'a',
seriesId: 's',
x: 1,
y: 2,
text: 'a',
labelOffsetX: '12',
},
],
}),
),
).toThrow('labelOffsetX')
expect(() =>
parseWaveformAnnotations(
JSON.stringify({
version: 1,
annotations: [{ id: 'a', seriesId: 's', x: 1, y: 2, text: 'a', style: [] }],
}),
),
).toThrow('style must be an object')
expect(() =>
serializeWaveformAnnotations([{ id: 'a', seriesId: 's', x: Number.NaN, y: 2, text: 'a' }]),
).toThrow('x must be a finite number')
})
})

View File

@@ -0,0 +1,127 @@
import type { WaveformAnnotation, WaveformAnnotationStyle } from '../../types'
import { ANNOTATION_MAX_TEXT_LENGTH } from './markup'
const ANNOTATION_FILE_VERSION = 1
type JsonRecord = Record<string, unknown>
function fail(message: string): never {
throw new TypeError(`Invalid waveform annotation file: ${message}`)
}
function isRecord(value: unknown): value is JsonRecord {
return typeof value === 'object' && value !== null && !Array.isArray(value)
}
function requiredString(record: JsonRecord, key: string, path: string): string {
const value = record[key]
if (typeof value !== 'string' || value.trim().length === 0) {
fail(`${path}.${key} must be a non-empty string`)
}
return value
}
function optionalString(record: JsonRecord, key: string, path: string): string | undefined {
const value = record[key]
if (value === undefined) return undefined
if (typeof value !== 'string') fail(`${path}.${key} must be a string`)
return value
}
function requiredFiniteNumber(record: JsonRecord, key: string, path: string): number {
const value = record[key]
if (typeof value !== 'number' || !Number.isFinite(value)) {
fail(`${path}.${key} must be a finite number`)
}
return value
}
function optionalFiniteNumber(record: JsonRecord, key: string, path: string): number | undefined {
const value = record[key]
if (value === undefined) return undefined
if (typeof value !== 'number' || !Number.isFinite(value)) {
fail(`${path}.${key} must be a finite number`)
}
return value
}
function parseStyle(value: unknown, path: string): WaveformAnnotationStyle | undefined {
if (value === undefined) return undefined
if (!isRecord(value)) fail(`${path} must be an object`)
const borderColor = optionalString(value, 'borderColor', path)
const textColor = optionalString(value, 'textColor', path)
const backgroundColor = optionalString(value, 'backgroundColor', path)
return {
...(borderColor !== undefined && { borderColor }),
...(textColor !== undefined && { textColor }),
...(backgroundColor !== undefined && { backgroundColor }),
}
}
function parseAnnotation(value: unknown, index: number): WaveformAnnotation {
const path = `annotations[${index}]`
if (!isRecord(value)) fail(`${path} must be an object`)
const text = requiredString(value, 'text', path)
if (text.length > ANNOTATION_MAX_TEXT_LENGTH) {
fail(`${path}.text must not exceed ${ANNOTATION_MAX_TEXT_LENGTH} characters`)
}
const labelOffsetX = optionalFiniteNumber(value, 'labelOffsetX', path)
const labelOffsetY = optionalFiniteNumber(value, 'labelOffsetY', path)
const createdAt = optionalString(value, 'createdAt', path)
const style = parseStyle(value.style, `${path}.style`)
return {
id: requiredString(value, 'id', path),
seriesId: requiredString(value, 'seriesId', path),
x: requiredFiniteNumber(value, 'x', path),
y: requiredFiniteNumber(value, 'y', path),
text,
...(labelOffsetX !== undefined && { labelOffsetX }),
...(labelOffsetY !== undefined && { labelOffsetY }),
...(style !== undefined && { style }),
...(createdAt !== undefined && { createdAt }),
}
}
function normalizeAnnotations(values: readonly unknown[]): WaveformAnnotation[] {
const annotations = values.map(parseAnnotation)
const ids = new Set<string>()
annotations.forEach((annotation, index) => {
if (ids.has(annotation.id)) fail(`annotations[${index}].id must be unique`)
ids.add(annotation.id)
})
return annotations
}
/** Serialize annotations to the versioned waveform annotation JSON format. */
export function serializeWaveformAnnotations(annotations: readonly WaveformAnnotation[]): string {
return JSON.stringify(
{ version: ANNOTATION_FILE_VERSION, annotations: normalizeAnnotations(annotations) },
null,
2,
)
}
/** Parse and validate a versioned waveform annotation JSON document. */
export function parseWaveformAnnotations(json: string): WaveformAnnotation[] {
if (typeof json !== 'string') fail('input must be a JSON string')
let document: unknown
try {
document = JSON.parse(json)
} catch {
fail('input is not valid JSON')
}
if (!isRecord(document)) fail('root must be an object')
if (document.version !== ANNOTATION_FILE_VERSION) {
fail(`version must be ${ANNOTATION_FILE_VERSION}`)
}
if (!Array.isArray(document.annotations)) fail('annotations must be an array')
return normalizeAnnotations(document.annotations)
}

View File

@@ -74,6 +74,7 @@ export function resolveGridCellGeometry(
displayMode: WaveformDisplayMode,
slotHasSeries: boolean[] = [],
horizontalGap?: number,
showXAxis = true,
): GridCellGeometry[] {
const defaultGap = getGridGap(displayMode)
const columnGap = Number.isFinite(horizontalGap)
@@ -81,7 +82,9 @@ export function resolveGridCellGeometry(
: defaultGap
const totalHorizontalGap = Math.max(0, options.columnCount - 1) * columnGap
const axisRows = new Set<number>()
if (displayMode === 'independent') {
if (!showXAxis) {
// Net view uses the full drawing area for waveform pixels.
} else if (displayMode === 'independent') {
for (let row = 0; row < options.rowCount; row += 1) axisRows.add(row)
} else if (displayMode === 'compact') {
// Compact tracks share one continuous plot stack. Reserve the X-axis band

View File

@@ -19,6 +19,7 @@ export type {
WaveformLegendOrientation,
WaveformLegendOptions,
WaveformFrameStyle,
WaveformZeroLineOptions,
SingleWaveformData,
WaveformLineType,
WaveformPointType,

View File

@@ -17,6 +17,7 @@ export type {
WaveformLegendOrientation,
WaveformLegendOptions,
WaveformFrameStyle,
WaveformZeroLineOptions,
WaveformPoint,
WaveformSeries,
WaveformLineType,
@@ -30,8 +31,4 @@ export type { WaveformGridOptions as WaveformGridConfig } from './core/grid'
// 可选:导出各系统的组件(供高级用户使用)
export { WaveformTooltip } from './interaction'
export { WaveformTrack } from './rendering'
export {
WaveformAnnotationLayer,
WaveformAnnotationToolbar,
WaveformAnnotationContextMenu,
} from './annotation'
export { WaveformAnnotationLayer, WaveformAnnotationContextMenu } from './annotation'

View File

@@ -2,7 +2,7 @@
import { computed, nextTick, onMounted, ref, watch } from 'vue'
import { axisBottom, axisLeft, axisRight, select } from 'd3'
import { formatAxisTime, formatScientificAxisLabel } from '../../utils'
import type { WaveformFrameStyle } from '../../types'
import type { WaveformFrameStyle, WaveformZeroLineOptions } from '../../types'
import type { WaveformDisplayMode, WaveformInteractionMode } from '../data/types'
import type {
DisplaySeries,
@@ -37,6 +37,12 @@ interface Props {
hoveredPoint?: HoveredSeriesPoint
/** Y 轴标签回退值 */
yLabel?: string
/** Hide visual aids while keeping chart interaction active. */
cleanView?: boolean
/** Resolved zero reference line style. */
zeroLine?: Required<Pick<WaveformZeroLineOptions, 'color' | 'width' | 'dash'>> & {
visible: boolean
}
}
interface Emits {
@@ -51,6 +57,8 @@ interface Emits {
const props = withDefaults(defineProps<Props>(), {
interactionMode: 'zoom',
cleanView: false,
zeroLine: () => ({ visible: false, color: '#98a2b3', width: 1, dash: '6 4' }),
})
const emit = defineEmits<Emits>()
@@ -111,6 +119,12 @@ function hasCrosshair(): boolean {
)
}
function zeroLineY(axis: WaveformYAxisLayout): number | null {
const [minimum, maximum] = axis.scale.domain()
if (!props.zeroLine.visible || minimum > 0 || maximum < 0) return null
return axis.scale(0)
}
function renderAxes() {
props.track.yAxes.forEach((axis, index) => {
const element = yAxisElements.value[index]
@@ -180,7 +194,7 @@ watch(
:transform="`translate(${track.left ?? 0}, ${track.top})`"
>
<rect
v-if="!track.isEmpty"
v-if="!track.isEmpty && !cleanView"
class="waveform-track__plot-background waveform-chart__plot-background"
:width="track.width ?? innerWidth"
:height="track.height"
@@ -190,7 +204,7 @@ watch(
<!-- 网格和背景 -->
<g
v-if="!track.isEmpty && track.hasVisibleSeries"
v-if="!track.isEmpty && track.hasVisibleSeries && !cleanView"
:clip-path="`url(#${clipPathId}-${track.index})`"
aria-hidden="true"
>
@@ -236,9 +250,31 @@ watch(
</g>
</g>
<g
v-if="!track.isEmpty && track.hasVisibleSeries && zeroLine.visible && !cleanView"
class="waveform-track__zero-lines waveform-chart__zero-lines"
:clip-path="`url(#${clipPathId}-${track.index})`"
aria-hidden="true"
>
<template v-for="axis in track.yAxes" :key="`zero-line-${track.index}-${axis.index}`">
<line
v-if="zeroLineY(axis) !== null"
class="waveform-track__zero-line waveform-chart__zero-line"
:data-y-axis-index="axis.index"
x1="0"
:x2="track.width ?? innerWidth"
:y1="zeroLineY(axis) ?? 0"
:y2="zeroLineY(axis) ?? 0"
:stroke="zeroLine.color"
:stroke-width="zeroLine.width"
:stroke-dasharray="zeroLine.dash || undefined"
/>
</template>
</g>
<!-- 帧编号水印 -->
<text
v-if="!track.isEmpty && track.hasVisibleSeries && frameNumber !== undefined"
v-if="!track.isEmpty && track.hasVisibleSeries && frameNumber !== undefined && !cleanView"
class="waveform-track__watermark waveform-chart__watermark"
:x="(track.width ?? innerWidth) / 2"
:y="track.height / 2"
@@ -252,13 +288,13 @@ watch(
<!-- X -->
<g
v-if="track.showXAxis"
v-if="track.showXAxis && !cleanView"
ref="xAxisElement"
class="waveform-track__axis waveform-track__axis--x waveform-chart__axis waveform-chart__axis--x"
:transform="`translate(0, ${track.height})`"
/>
<g
v-if="track.showXAxis"
v-if="track.showXAxis && !cleanView"
class="waveform-track__axis-endpoints waveform-chart__axis-endpoints"
:transform="`translate(0, ${track.height})`"
font-family="sans-serif"
@@ -285,7 +321,7 @@ watch(
</text>
</g>
<text
v-if="track.showXAxis && track.xAxisExponent"
v-if="track.showXAxis && track.xAxisExponent && !cleanView"
class="waveform-track__axis-exponent waveform-track__axis-exponent--x waveform-chart__axis-exponent waveform-chart__axis-exponent--x"
:x="track.width ?? innerWidth"
:y="track.height + 27"
@@ -297,7 +333,7 @@ watch(
<!-- Y -->
<g
v-for="axis in track.isEmpty ? [] : track.yAxes"
v-for="axis in track.isEmpty || cleanView ? [] : track.yAxes"
:key="`y-axis-${track.index}-${axis.index}`"
:ref="(element) => setYAxisElement(element, axis.index)"
class="waveform-track__axis waveform-track__axis--y waveform-chart__axis waveform-chart__axis--y"
@@ -307,7 +343,9 @@ watch(
:transform="`translate(${axis.x}, 0)`"
/>
<text
v-for="axis in track.isEmpty ? [] : track.yAxes.filter((item) => item.exponentLabel)"
v-for="axis in track.isEmpty || cleanView
? []
: track.yAxes.filter((item) => item.exponentLabel)"
:key="`y-axis-exponent-${track.index}-${axis.index}`"
class="waveform-track__axis-exponent waveform-track__axis-exponent--y waveform-chart__axis-exponent waveform-chart__axis-exponent--y"
:data-y-axis-index="axis.index"
@@ -323,6 +361,7 @@ watch(
<!-- Y 轴标签 -->
<g
v-if="
!cleanView &&
!track.isEmpty &&
track.hasVisibleSeries &&
track.seriesList.length === 1 &&
@@ -351,7 +390,7 @@ watch(
</g>
<g
v-for="axis in track.yAxes.length > 1 ? track.yAxes.filter(hasYAxisTitle) : []"
v-for="axis in !cleanView && track.yAxes.length > 1 ? track.yAxes.filter(hasYAxisTitle) : []"
:key="`y-axis-title-${track.index}-${axis.index}`"
class="waveform-track__multi-axis-title"
:data-y-axis-title-index="axis.index"
@@ -377,7 +416,7 @@ watch(
<!-- 轨道边框 -->
<rect
v-if="!track.isEmpty"
v-if="!track.isEmpty && !cleanView"
class="waveform-track__plot-frame waveform-chart__plot-frame"
:width="track.width ?? innerWidth"
:height="track.height"
@@ -421,7 +460,7 @@ watch(
/>
<text
v-if="!track.isEmpty && !track.hasVisibleSeries"
v-if="!track.isEmpty && !track.hasVisibleSeries && !cleanView"
class="waveform-track__no-visible-series"
:x="(track.width ?? innerWidth) / 2"
:y="track.height / 2"
@@ -516,6 +555,11 @@ watch(
stroke-dasharray: 4 3;
}
.waveform-track__zero-line {
fill: none;
pointer-events: none;
}
.waveform-track__axis-endpoint {
fill: #667085;
font-size: 11px;

View File

@@ -23,6 +23,7 @@ export type {
WaveformLegendOrientation,
WaveformLegendOptions,
WaveformFrameStyle,
WaveformZeroLineOptions,
// 数据类型
SingleWaveformData,
WaveformLineType,
@@ -59,3 +60,5 @@ export {
selectRenderablePoints,
type ResolvedWaveformRenderingOptions,
} from './core'
export { parseWaveformAnnotations, serializeWaveformAnnotations } from './components/annotation'

View File

@@ -156,7 +156,8 @@ body {
border-radius: 4px;
}
.frame-style-controls {
.frame-style-controls,
.auxiliary-style-controls {
display: grid;
gap: 10px;
}

View File

@@ -118,3 +118,11 @@ export interface WaveformFrameStyle {
borderStyle?: 'solid' | 'dashed'
backgroundColor?: string
}
/** Styling and visibility options for the horizontal zero-value reference line. */
export interface WaveformZeroLineOptions {
visible?: boolean
color?: string
width?: number
dash?: string
}

View File

@@ -18,6 +18,7 @@ export type {
WaveformLegendOrientation,
WaveformLegendOptions,
WaveformFrameStyle,
WaveformZeroLineOptions,
} from './chart'
// 数据类型