IViewportViewer
Viewport-only viewer (e.g. time rulers, frequency rulers, overlays).
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Inherited from |
|---|---|---|
canvasToTimeFrequency? | (x: number, y: number) => object | NavigableViewer.canvasToTimeFrequency |
getFrequencyBounds? | () => FrequencyBounds | NavigableViewer.getFrequencyBounds |
getTimeBounds? | () => TimeBounds | NavigableViewer.getTimeBounds |
timeFrequencyToCanvas? | (time: number, frequency: number) => object | NavigableViewer.timeFrequencyToCanvas |
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy(): void;Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getCanvas()?
Section titled “getCanvas()?”optional getCanvas(): HTMLElement;Returns
Section titled “Returns”HTMLElement
Inherited from
Section titled “Inherited from”getConfig()
Section titled “getConfig()”getConfig(): object;Returns
Section titled “Returns”object
maxFrequency?
Section titled “maxFrequency?”optional maxFrequency?: number;maxViewportDuration?
Section titled “maxViewportDuration?”optional maxViewportDuration?: number;minFrequency?
Section titled “minFrequency?”optional minFrequency?: number;minViewportDuration?
Section titled “minViewportDuration?”optional minViewportDuration?: number;Inherited from
Section titled “Inherited from”getScope()?
Section titled “getScope()?”optional getScope(): object;Returns
Section titled “Returns”object
getDuration()
Section titled “getDuration()”getDuration(): number;Returns
Section titled “Returns”number
getSampleRate()?
Section titled “getSampleRate()?”optional getSampleRate(): number | undefined;Returns
Section titled “Returns”number | undefined
Inherited from
Section titled “Inherited from”getViewport()
Section titled “getViewport()”getViewport(): object;Returns
Section titled “Returns”object
endTime
Section titled “endTime”endTime: number;frequencyScale?
Section titled “frequencyScale?”optional frequencyScale?: string;maxFrequency?
Section titled “maxFrequency?”optional maxFrequency?: number;minFrequency?
Section titled “minFrequency?”optional minFrequency?: number;startTime
Section titled “startTime”startTime: number;Inherited from
Section titled “Inherited from”requestRender()
Section titled “requestRender()”requestRender(): void;Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setViewport()
Section titled “setViewport()”setViewport(viewport: Partial<ViewportConfig>): void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
viewport | Partial<ViewportConfig> |
Returns
Section titled “Returns”void