FrequencyRulerViewer

Frequency ruler viewer canvas controller and coordinate tick renderer.

Implements

• IFrequencyRulerViewer

Constructors

Constructor

new FrequencyRulerViewer(
   canvas: HTMLCanvasElement,
   viewport: IViewportController,
   options?: Partial<FrequencyRulerConfig>): FrequencyRulerViewer;

Parameters

Parameter	Type
canvas	HTMLCanvasElement
viewport	IViewportController
options?	Partial<FrequencyRulerConfig>

Returns

FrequencyRulerViewer

Methods

canvasToFrequency()

canvasToFrequency(y: number): number;

Converts canvas Y pixel position to frequency in Hz.

Parameters

Parameter	Type
y	number

Returns

number

Implementation of

IFrequencyRulerViewer.canvasToFrequency

---

destroy()

destroy(): void;

Disposes the frequency ruler renderer and event listeners.

Returns

void

Implementation of

IFrequencyRulerViewer.destroy

---

frequencyToCanvas()

frequencyToCanvas(freq: number): number;

Converts frequency in Hz to canvas Y pixel position.

Parameters

Parameter	Type
freq	number

Returns

number

Implementation of

IFrequencyRulerViewer.frequencyToCanvas

---

getCanvas()

getCanvas(): HTMLCanvasElement;

Returns the bound HTML canvas element.

Returns

HTMLCanvasElement

Implementation of

IFrequencyRulerViewer.getCanvas

---

getConfig()

getConfig(): ResolvedFrequencyRulerConfig;

Returns the resolved frequency ruler configuration options.

Returns

ResolvedFrequencyRulerConfig

Implementation of

IFrequencyRulerViewer.getConfig

---

getStatus()

getStatus(): FrequencyRulerStatus;

Returns the current render status.

Returns

FrequencyRulerStatus

Implementation of

IFrequencyRulerViewer.getStatus

---

getViewport()

getViewport(): FrequencyRulerViewport;

Returns the visible frequency viewport.

Returns

FrequencyRulerViewport

Implementation of

IFrequencyRulerViewer.getViewport

---

getViewportController()

getViewportController(): IViewportController;

Returns the bound viewport controller.

Returns

IViewportController

Implementation of

IFrequencyRulerViewer.getViewportController

---

on()

on<Name>(name: Name, handler: (event: FrequencyRulerEvents[Name]) => void): () => void;

Subscribes to frequency ruler events.

Type Parameters

Type Parameter
Name extends keyof FrequencyRulerEvents

Parameters

Parameter	Type
name	Name
handler	(event: FrequencyRulerEvents[Name]) => void

Returns

() => void

Implementation of

IFrequencyRulerViewer.on

---

render()

render(): Promise<void>;

Renders the current frequency ruler viewport asynchronously.

Returns

Promise<void>

Implementation of

IFrequencyRulerViewer.render

---

requestRender()

requestRender(): void;

Schedules a render on the next animation frame.

Returns

void

Implementation of

IFrequencyRulerViewer.requestRender

---

setConfig()

setConfig(input: Partial<FrequencyRulerOptions>): void;

Alias for updateConfig.

Parameters

Parameter	Type
input	Partial<FrequencyRulerOptions>

Returns

void

Implementation of

IFrequencyRulerViewer.setConfig

---

setViewport()

setViewport(vp: Partial<ViewportConfig>): void;

Parameters

Parameter	Type
vp	Partial<ViewportConfig>

Returns

void

---

updateConfig()

updateConfig(input: Partial<FrequencyRulerOptions>): void;

Updates configuration options and triggers a re-render.

Parameters

Parameter	Type
input	Partial<FrequencyRulerOptions>

Returns

void

Implementation of

IFrequencyRulerViewer.updateConfig