IFrequencyRulerViewer
Frequency ruler viewer canvas controller and coordinate tick renderer.
Methods
Section titled “Methods”canvasToFrequency()
Section titled “canvasToFrequency()”canvasToFrequency(y: number): number;Converts canvas Y pixel position to frequency in Hz.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
y | number |
Returns
Section titled “Returns”number
destroy()
Section titled “destroy()”destroy(): void;Disposes the frequency ruler renderer and event listeners.
Returns
Section titled “Returns”void
frequencyToCanvas()
Section titled “frequencyToCanvas()”frequencyToCanvas(freq: number): number;Converts frequency in Hz to canvas Y pixel position.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
freq | number |
Returns
Section titled “Returns”number
getCanvas()
Section titled “getCanvas()”getCanvas(): HTMLCanvasElement;Returns the bound HTML canvas element.
Returns
Section titled “Returns”HTMLCanvasElement
getConfig()
Section titled “getConfig()”getConfig(): ResolvedFrequencyRulerConfig;Returns the resolved frequency ruler configuration options.
Returns
Section titled “Returns”getStatus()
Section titled “getStatus()”getStatus(): FrequencyRulerStatus;Returns the current render status.
Returns
Section titled “Returns”getViewport()
Section titled “getViewport()”getViewport(): FrequencyRulerViewport;Returns the visible frequency viewport.
Returns
Section titled “Returns”getViewportController()
Section titled “getViewportController()”getViewportController(): IViewportController;Returns the bound viewport controller.
Returns
Section titled “Returns”on<Name>(name: Name, handler: (event: FrequencyRulerEvents[Name]) => void): () => void;Subscribes to frequency ruler events.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Name extends keyof FrequencyRulerEvents |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
name | Name |
handler | (event: FrequencyRulerEvents[Name]) => void |
Returns
Section titled “Returns”() => void
render()
Section titled “render()”render(): Promise<void>;Renders the current frequency ruler viewport asynchronously.
Returns
Section titled “Returns”Promise<void>
requestRender()
Section titled “requestRender()”requestRender(): void;Schedules a render on the next animation frame.
Returns
Section titled “Returns”void
setConfig()
Section titled “setConfig()”setConfig(input: Partial<FrequencyRulerOptions>): void;Alias for updateConfig.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | Partial<FrequencyRulerOptions> |
Returns
Section titled “Returns”void
updateConfig()
Section titled “updateConfig()”updateConfig(input: Partial<FrequencyRulerOptions>): void;Updates configuration options and triggers a re-render.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | Partial<FrequencyRulerOptions> |
Returns
Section titled “Returns”void