waveform-analysis 0.1.40 → 0.1.41

package/dist/types/components/core/layout.d.ts

@@ -2,6 +2,7 @@ import type { WaveformOverlayMode } from '../../types';
 import type { DisplaySeries, DisplayTrack, TrackLayout } from './types';
 import { type WaveformYDomain } from './yDomain';
 export { MAX_MULTI_Y_AXIS_COUNT } from './constants';
+export declare function resolveYAxisTickCount(_plotHeight: number, splitNumber?: number): number;
 export interface YAxisSeriesGroup {
     index: number;
     side: 'left' | 'right';
@@ -11,11 +12,11 @@ export interface YAxisSeriesGroup {
 }
 export declare function buildYAxisSeriesGroups(track: DisplayTrack, overlayMode: WaveformOverlayMode): YAxisSeriesGroup[];
 export declare function resolveYAxisSeriesGroups(track: DisplayTrack, overlayMode: WaveformOverlayMode, yDomain?: WaveformYDomain, yDomains?: Record<string, WaveformYDomain>): YAxisSeriesGroup[];
-export declare function axisTextMetrics(domain: [number, number], nice?: boolean, tickValues?: number[], unit?: string): {
+export declare function axisTextMetrics(domain: [number, number], nice?: boolean, tickValues?: number[], unit?: string, tickCount?: number): {
     tickTextWidth: number;
 };
-export declare function measureYAxisGroupClearance(group: YAxisSeriesGroup): number;
-export declare function measureTrackYAxisClearance(track: DisplayTrack, overlayMode: WaveformOverlayMode, yDomain?: WaveformYDomain, yDomains?: Record<string, WaveformYDomain>): {
+export declare function measureYAxisGroupClearance(group: YAxisSeriesGroup, tickCount?: number): number;
+export declare function measureTrackYAxisClearance(track: DisplayTrack, overlayMode: WaveformOverlayMode, yDomain?: WaveformYDomain, yDomains?: Record<string, WaveformYDomain>, tickCount?: number): {
     left: number;
     right: number;
 };

package/dist/types/components/core/trackLayoutBuilder.d.ts

@@ -21,6 +21,7 @@ export interface BuildTrackLayoutsOptions {
     yDomains?: Record<string, [number, number]>;
     timeUnit: 's' | 'ms';
     xAxisLabelFormatter?: WaveformXAxisLabelFormatter;
+    yAxisSplitNumber?: number;
     rendering: ResolvedWaveformRenderingOptions;
     hideSecondaryLabels: boolean;
     yAxisLabelX: number;

package/dist/types/types/chart.d.ts

@@ -150,6 +150,8 @@ export interface WaveformAxesOptions {
     };
     y?: {
         lineVisible?: boolean;
+        /** Target total number of equal Y-axis ticks, including endpoints. Defaults to 5. */
+        splitNumber?: number;
     };
 }
 /** Styling and visibility options for the horizontal zero-value reference line. */

package/package.json

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

package/src/components/core/fixedYDomainLayout.test.ts

@@ -35,7 +35,7 @@ function track(seriesList: DisplaySeries[]): DisplayTrack {
 }
 
 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 result = buildTrackLayouts({
       cells: [
@@ -66,10 +66,80 @@ describe('fixed Y-domain layout', () => {
       showCompactEmptyTracks: false,
     })[0]
 
-    expect(result?.yScale.domain()).toEqual([3, 97])
-    expect(result?.yAxes[0]?.tickValues).toContain(3)
-    expect(result?.yAxes[0]?.tickValues).toContain(97)
-    expect(result?.seriesPaths[0]?.yScale.domain()).toEqual([3, 97])
+    expect(result?.yScale.domain()).toEqual([0, 100])
+    expect(result?.yAxes[0]?.tickValues).toContain(0)
+    expect(result?.yAxes[0]?.tickValues).toContain(100)
+    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', () => {

package/src/components/core/layout.test.ts

@@ -9,6 +9,7 @@ import {
   findClosestTrackAtPointer,
   MAX_MULTI_Y_AXIS_COUNT,
   measureYAxisGroupClearance,
+  resolveYAxisTickCount,
 } from './layout'
 
 function series(id: string, minimum: number, maximum: number): DisplaySeries {
@@ -119,8 +120,15 @@ describe('multi-value Y-axis grouping', () => {
       showCompactEmptyTracks: false,
     })[0]
 
-    expect(result?.yScale.domain()).toEqual([25, 75])
-    expect(result?.seriesPaths[0]?.yScale.domain()).toEqual([25, 75])
+    expect(result?.yScale.domain()).toEqual([20, 80])
+    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', () => {

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 +

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/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
   }
 }