audio? | HTMLAudioElement | - | - |
autoRender? | boolean | Whether to automatically re-render when viewport or configuration changes. Default true | FrequencyRulerConfig.autoRender |
autoResize? | boolean | Whether to automatically resize canvas pixel resolution when container dimensions change. Default true | FrequencyRulerConfig.autoResize |
backgroundColor? | string | Canvas background fill color. Default "transparent" | FrequencyRulerConfig.backgroundColor |
canvasProps? | HTMLAttributes<HTMLCanvasElement> | - | - |
className? | string | - | - |
color? | string | Primary color for axis lines, tick marks, and text labels. Default "#a0a0a0" | FrequencyRulerConfig.color |
devicePixelRatio? | number | boolean | Device pixel ratio scaling factor for HiDPI/Retina displays. Default window.devicePixelRatio | FrequencyRulerConfig.devicePixelRatio |
font? | string | CSS font specification for frequency labels. Default "10px monospace" | FrequencyRulerConfig.font |
frequencyFormat? | FrequencyFormatMode | Frequency label formatting mode. - “auto”: Switches between Hz and kHz depending on magnitude. - “hz”: Always formats in Hertz (e.g. 2000 Hz). - “khz”: Always formats in kilohertz (e.g. 2.0 kHz). - Custom function (hz: number) => string. Default "auto" | FrequencyRulerConfig.frequencyFormat |
frequencyScale? | FrequencyScale | Frequency scale mapping: linear, mel, or logarithmic. Default inherits from Sonoscope viewport scale | FrequencyRulerConfig.frequencyScale |
height? | string | number | - | - |
labelColor? | string | Specific color override for text labels. Default color | FrequencyRulerConfig.labelColor |
minMajorPixelSpacing? | number | Minimum pixel spacing between adjacent major frequency labels. Default 45 | FrequencyRulerConfig.minMajorPixelSpacing |
onReady? | (viewer: FrequencyRulerViewer) => void | - | - |
renderer? | FrequencyRulerRendererName | FrequencyRulerRenderer | Visual renderer: standard tick lines or segmented boxes. Default "ticks" | FrequencyRulerConfig.renderer |
scope? | Sonoscope | null | - | - |
source? | AudioSource | - | - |
style? | CSSProperties | - | - |
tickColor? | string | Specific color override for tick lines. Default color | FrequencyRulerConfig.tickColor |
tickPosition? | "both" | "left" | "right" | "inside" | Tick mark position relative to the vertical ruler axis. Default "left" | FrequencyRulerConfig.tickPosition |
url? | string | - | - |
width? | string | number | - | - |