waveform-analysis 0.1.40 → 0.1.42

package/src/components/core/layout.ts

@@ -20,6 +20,13 @@ const Y_AXIS_OUTER_PADDING = 4
 const Y_AXIS_LABEL_GAP = 6
 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 {
   index: number
   side: 'left' | 'right'
@@ -104,11 +111,16 @@ export function axisTextMetrics(
   nice = true,
   tickValues?: number[],
   unit?: string,
+  tickCount = 10,
 ): { tickTextWidth: number } {
+  const effectiveTickCount =
+    typeof tickCount === 'number' && Number.isFinite(tickCount)
+      ? Math.max(2, Math.floor(tickCount))
+      : 10
   const scale = scaleLinear(domain, [1, 0])
-  if (nice) scale.nice()
+  if (nice) scale.nice(effectiveTickCount)
   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 maximumTickCharacters = Math.max(
     1,
@@ -121,9 +133,9 @@ export function axisTextMetrics(
   }
 }
 
-export function measureYAxisGroupClearance(group: YAxisSeriesGroup): number {
+export function measureYAxisGroupClearance(group: YAxisSeriesGroup, tickCount?: number): number {
   return (
-    axisTextMetrics(group.domain, !group.fixed, undefined, group.seriesList[0]?.unit)
+    axisTextMetrics(group.domain, true, undefined, group.seriesList[0]?.unit, tickCount)
       .tickTextWidth +
     Y_AXIS_TICK_PADDING +
     Y_AXIS_LABEL_GAP +
@@ -132,9 +144,9 @@ export function measureYAxisGroupClearance(group: YAxisSeriesGroup): number {
   )
 }
 
-function measureYAxisGroupTickClearance(group: YAxisSeriesGroup): number {
+function measureYAxisGroupTickClearance(group: YAxisSeriesGroup, tickCount?: number): number {
   return (
-    axisTextMetrics(group.domain, !group.fixed, undefined, group.seriesList[0]?.unit)
+    axisTextMetrics(group.domain, true, undefined, group.seriesList[0]?.unit, tickCount)
       .tickTextWidth +
     Y_AXIS_TICK_PADDING +
     Y_AXIS_OUTER_PADDING
@@ -146,13 +158,14 @@ export function measureTrackYAxisClearance(
   overlayMode: WaveformOverlayMode,
   yDomain?: WaveformYDomain,
   yDomains?: Record<string, WaveformYDomain>,
+  tickCount?: number,
 ): { left: number; right: number } {
   return resolveYAxisSeriesGroups(track, overlayMode, yDomain, yDomains).reduce(
     (clearance, group) => {
       clearance[group.side] +=
         overlayMode === 'multi-axis' || track.visibleSeries.length === 1
-          ? measureYAxisGroupClearance(group)
-          : measureYAxisGroupTickClearance(group)
+          ? measureYAxisGroupClearance(group, tickCount)
+          : measureYAxisGroupTickClearance(group, tickCount)
       return clearance
     },
     { left: 0, right: 0 },

package/src/components/core/trackLayoutBuilder.ts

@@ -25,7 +25,7 @@ import {
   type GridCellGeometry,
   type NormalizedWaveformGridOptions,
 } from './grid'
-import { axisTextMetrics, resolveYAxisSeriesGroups } from './layout'
+import { axisTextMetrics, resolveYAxisSeriesGroups, resolveYAxisTickCount } from './layout'
 import type { DisplaySeries, DisplayTrack, TrackLayout, WaveformYAxisLayout } from './types'
 import { applyXDomainStrategy } from './xDomain'
 import {
@@ -54,6 +54,7 @@ export interface BuildTrackLayoutsOptions {
   yDomains?: Record<string, [number, number]>
   timeUnit: 's' | 'ms'
   xAxisLabelFormatter?: WaveformXAxisLabelFormatter
+  yAxisSplitNumber?: number
   rendering: ResolvedWaveformRenderingOptions
   hideSecondaryLabels: boolean
   yAxisLabelX: number
@@ -124,22 +125,26 @@ export function buildTrackLayouts(options: BuildTrackLayoutsOptions): TrackLayou
     )
     const sideOffsets = { left: 0, right: 0 }
     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])
-      if (!group.fixed) scale.nice()
-      const majorTicks = scale.ticks(Math.max(2, Math.floor(cell.plotHeight / 55)))
+      scale.nice(niceCount)
       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 visibleMajorTicks = showAxisEnd
         ? majorTicks
         : majorTicks.filter((tick) => tick !== axisEnd)
-      const tickValues = Array.from(
-        new Set([axisStart, ...visibleMajorTicks, ...(showAxisEnd ? [axisEnd] : [])]),
-      )
+      const tickValues = visibleMajorTicks
       const { tickTextWidth } = axisTextMetrics(
-        group.domain,
-        !group.fixed,
+        scale.domain() as [number, number],
+        false,
         tickValues,
         group.seriesList[0]?.unit,
+        tickCount,
       )
       const clearance =
         tickTextWidth +
@@ -261,7 +266,7 @@ export function buildTrackLayouts(options: BuildTrackLayoutsOptions): TrackLayou
         (isEmpty || hasVisibleSeries) &&
         (options.displayMode === 'independent' ||
           (options.displayMode === 'compact'
-            ? cell.row === options.grid.rowCount - 1
+            ? (cell.isLastRow ?? cell.row === options.grid.rowCount - 1)
             : bottomCells.has(cell.slotIndex))),
     }
   })

package/src/components/core/useWaveformChartLifecycle.ts

@@ -11,6 +11,7 @@ import {
 
 import type { AnnotationSeriesCandidate } from '../annotation'
 import type { useWaveformAnnotationInteraction } from '../annotation'
+import type { NormalizedWaveformGridOptions } from './grid'
 import type { DisplaySeries, DisplayTrack, TrackLayout } from './types'
 import type { ResolvedWaveformChartProps, WaveformChartEmit } from './waveformChartTypes'
 import { constrainZoomDomain, transformForDomain } from '../interaction/zoomConstraints'
@@ -33,7 +34,7 @@ interface LifecycleContext {
   currentPage: Ref<number>
   pageCount: ComputedRef<number>
   pagedTracks: ComputedRef<Array<DisplayTrack | undefined>>
-  gridOptions: ComputedRef<{ rowCount: number; columnCount: number }>
+  gridOptions: ComputedRef<NormalizedWaveformGridOptions>
   chartSeries: ComputedRef<DisplaySeries[]>
   chartTracks: ComputedRef<DisplayTrack[]>
   trackLayouts: ComputedRef<TrackLayout[]>
@@ -220,6 +221,7 @@ export function useWaveformChartLifecycle(context: LifecycleContext) {
       currentPage,
       () => gridOptions.value.rowCount,
       () => gridOptions.value.columnCount,
+      () => gridOptions.value.fillIncompleteLastRow,
       activeInteractionMode,
     ],
     async () => {
@@ -239,20 +241,28 @@ export function useWaveformChartLifecycle(context: LifecycleContext) {
     },
   )
 
-  watch([pageCount, () => props.grid?.rowCount, () => props.grid?.columnCount], () => {
-    const previousPage = currentPage.value
-    currentPage.value =
-      currentPage.value > pageCount.value
-        ? pageCount.value
-        : currentPage.value !== 1
-          ? 1
-          : currentPage.value
-    if (previousPage !== currentPage.value) {
-      emit('page-change', currentPage.value, pageCount.value)
-    }
-    clearHover()
-    void nextTick(configureZoom)
-  })
+  watch(
+    [
+      pageCount,
+      () => props.grid?.rowCount,
+      () => props.grid?.columnCount,
+      () => props.grid?.fillIncompleteLastRow,
+    ],
+    () => {
+      const previousPage = currentPage.value
+      currentPage.value =
+        currentPage.value > pageCount.value
+          ? pageCount.value
+          : currentPage.value !== 1
+            ? 1
+            : currentPage.value
+      if (previousPage !== currentPage.value) {
+        emit('page-change', currentPage.value, pageCount.value)
+      }
+      clearHover()
+      void nextTick(configureZoom)
+    },
+  )
 
   watch(activeInteractionMode, () => {
     editorSeriesOptions.value = []

package/src/components/core/useWaveformLayout.ts

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

package/src/components/waveformChartCases/compactAndSharedHover.test.ts

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

package/src/components/waveformChartCases/dataLifecycle.test.ts

@@ -261,7 +261,7 @@ describe('WaveformChart', () => {
       })
 
       expect(startTicks).toHaveLength(1)
-      expect(Number(startTicks[0].text())).toBe(0.1)
+      expect(Number(startTicks[0].text())).toBe(0)
     },
   )
 
@@ -297,7 +297,7 @@ describe('WaveformChart', () => {
         { displayMode },
       )
 
-      const expectedEndValues = [0.9, 4.9]
+      const expectedEndValues = [1, 5]
       wrapper.findAll('.waveform-chart__track').forEach((track, index) => {
         const endTicks = track.findAll('.waveform-chart__axis--y .tick').filter((tick) => {
           const match = tick.attributes('transform')?.match(/translate\(0,\s*([\d.]+)\)/)

package/src/components/waveformChartCases/gridFill.test.ts

@@ -0,0 +1,95 @@
+import { flushPromises } from '@vue/test-utils'
+import { describe, expect, it } from 'vitest'
+
+import { gridSeries, mountSizedChart } from '../../test/waveformChart'
+
+function geometry(track: { attributes: (name: string) => string | undefined }) {
+  return {
+    left: Number(track.attributes('data-track-left')),
+    top: Number(track.attributes('data-track-top')),
+    width: Number(track.attributes('data-track-width')),
+    height: Number(track.attributes('data-track-height')),
+  }
+}
+
+describe('WaveformChart incomplete grid rows', () => {
+  it.each(['independent', 'separated', 'compact'] as const)(
+    'fills an incomplete two by two row in %s mode',
+    async (displayMode) => {
+      const wrapper = await mountSizedChart(gridSeries(3), {
+        displayMode,
+        grid: { rowCount: 2, columnCount: 2, fillIncompleteLastRow: true },
+      })
+      const tracks = wrapper.findAll('.waveform-chart__track')
+      const first = geometry(tracks[0]!)
+      const last = geometry(tracks[2]!)
+
+      expect(tracks).toHaveLength(3)
+      expect(wrapper.findAll('.waveform-chart__track--empty')).toHaveLength(0)
+      expect(wrapper.findAll('.waveform-chart__grid-slot-placeholder')).toHaveLength(0)
+      expect(last.left).toBe(0)
+      expect(last.width).toBeGreaterThan(first.width * 1.8)
+      expect(last.top).toBeGreaterThan(first.top)
+      if (displayMode === 'independent') {
+        const overlays = wrapper.findAll('.waveform-chart__overlay--independent')
+        expect(overlays).toHaveLength(3)
+        expect(Number(overlays[2]?.attributes('width'))).toBe(last.width)
+      } else {
+        expect(wrapper.findAll('.waveform-chart__overlay--shared')).toHaveLength(1)
+      }
+    },
+  )
+
+  it('removes unused one-column rows and redistributes chart height', async () => {
+    const base = await mountSizedChart(gridSeries(3), {
+      displayMode: 'independent',
+      grid: { rowCount: 4, columnCount: 1 },
+    })
+    const filled = await mountSizedChart(gridSeries(3), {
+      displayMode: 'independent',
+      grid: { rowCount: 4, columnCount: 1, fillIncompleteLastRow: true },
+    })
+    const baseFirst = geometry(base.findAll('.waveform-chart__track')[0]!)
+    const filledTracks = filled.findAll('.waveform-chart__track')
+    const filledFirst = geometry(filledTracks[0]!)
+    const filledLast = geometry(filledTracks[2]!)
+
+    expect(filledTracks).toHaveLength(3)
+    expect(filledFirst.height).toBeGreaterThan(baseFirst.height)
+    expect(filledLast.top + filledLast.height).toBeGreaterThan(baseFirst.height * 3)
+  })
+
+  it('keeps the final two tracks evenly distributed in a two by three grid', async () => {
+    const wrapper = await mountSizedChart(gridSeries(5), {
+      displayMode: 'separated',
+      grid: { rowCount: 2, columnCount: 3, fillIncompleteLastRow: true },
+    })
+    const tracks = wrapper.findAll('.waveform-chart__track').map(geometry)
+
+    expect(tracks).toHaveLength(5)
+    expect(tracks[3]?.left).toBe(0)
+    expect(tracks[3]?.width).toBeCloseTo(tracks[4]?.width ?? 0)
+    expect(tracks[4]?.left).toBeGreaterThan((tracks[3]?.width ?? 0) + 1)
+  })
+
+  it('keeps full pages unchanged and fills a partial second page', async () => {
+    const data = gridSeries(5)
+    const standard = await mountSizedChart(data, {
+      displayMode: 'separated',
+      grid: { rowCount: 2, columnCount: 2 },
+    })
+    const filled = await mountSizedChart(data, {
+      displayMode: 'separated',
+      grid: { rowCount: 2, columnCount: 2, fillIncompleteLastRow: true },
+    })
+    const standardFirstPage = standard.findAll('.waveform-chart__track').map(geometry)
+    expect(filled.findAll('.waveform-chart__track').map(geometry)).toEqual(standardFirstPage)
+
+    await filled.get('.ant-pagination-next button').trigger('click')
+    await flushPromises()
+    const secondPage = filled.findAll('.waveform-chart__track').map(geometry)
+    expect(secondPage).toHaveLength(1)
+    expect(secondPage[0]?.left).toBe(0)
+    expect(secondPage[0]?.width).toBeGreaterThan(standardFirstPage[0]?.width ?? 0)
+  })
+})

package/src/components/waveformChartCases/layoutAndDomains.test.ts

@@ -6,6 +6,26 @@ import { resizeObservers } from '../../test/setup'
 import { gridSeries, mountSizedChart } from '../../test/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 () => {
     const wrapper = await mountSizedChart(
       {
@@ -296,7 +316,7 @@ describe('WaveformChart', () => {
     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({
       kind: 'points',
       points: [
@@ -312,8 +332,8 @@ describe('WaveformChart', () => {
 
     await wrapper.setProps({ yDomain: [3, 97] })
     await flushPromises()
-    expect(yTickLabels()).toContain('3')
-    expect(yTickLabels()).toContain('97')
+    expect(yTickLabels()).toContain('0')
+    expect(yTickLabels()).toContain('100')
 
     await wrapper.setProps({ yDomain: undefined })
     await flushPromises()

package/src/types/chart.ts

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