waveform-analysis 0.1.78 → 0.1.80

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/index.ts CHANGED
@@ -94,6 +94,7 @@ export type {
94
94
  WaveformXAxisLabelKind,
95
95
  WaveformXAxisLabelFormatterContext,
96
96
  WaveformXAxisLabelFormatter,
97
+ // Explicit axes.y padding ratios preserve exact bounds with nice ticks.
97
98
  // Includes axes.y.maximumTickVisible and minimumTickVisible for independent extrema ticks.
98
99
  WaveformAxesOptions,
99
100
  WaveformYAxisLabelTextStyle,
@@ -285,17 +285,17 @@ export interface WaveformAxesOptions {
285
285
  lineVisible?: boolean
286
286
  /** Styles series names on both left and right Y axes, without changing tick labels. */
287
287
  labelTextStyle?: WaveformYAxisLabelTextStyle
288
- /** Target total number of equal Y-axis ticks, including endpoints. Defaults to 5. */
288
+ /** Target Y-axis tick count before filtering to explicit padding or amplitude bounds. Defaults to 5. */
289
289
  splitNumber?: number
290
- /** Expands Y-axis domains to equal, human-friendly intervals. Defaults to true. */
290
+ /** Uses human-friendly intervals; explicit padding sides keep their exact bounds. Defaults to true. */
291
291
  nice?: boolean
292
292
  /** Shows the full data maximum's extra tick and label. Defaults to true. */
293
293
  maximumTickVisible?: boolean
294
294
  /** Shows the full data minimum's extra tick and label. Defaults to true. */
295
295
  minimumTickVisible?: boolean
296
- /** Fraction of the automatic Y span added above its maximum. Defaults to 0. */
296
+ /** Exact fraction of the automatic Y span added above its maximum, even with nice. Defaults to 0. */
297
297
  upperPaddingRatio?: number
298
- /** Fraction of the automatic Y span added below its minimum. Defaults to 0. */
298
+ /** Exact fraction of the automatic Y span added below its minimum, even with nice. Defaults to 0. */
299
299
  lowerPaddingRatio?: number
300
300
  /** False disables upper padding; true defaults an omitted ratio to 0.1. */
301
301
  upperPaddingEnabled?: boolean