ViewportController

Controls visible time and frequency coordinates across synchronized viewers.

Implements

• IViewportController

Constructors

Constructor

new ViewportController(options?: ViewportControllerOptions): ViewportController;

Parameters

Parameter	Type
options	ViewportControllerOptions

Returns

ViewportController

Methods

attachNavigation()

attachNavigation(container: HTMLElement, options?: NavigationOptions): () => void;

Attaches drag, wheel, and pinch gestures on an element.

Parameters

Parameter	Type	Description
container	HTMLElement	DOM element to attach listeners to.
options?	NavigationOptions	Gesture configuration.

Returns

Cleanup function that removes listeners.

() => void

Implementation of

IViewportController.attachNavigation

---

destroy()

destroy(): void;

Disposes listeners and event emitters.

Returns

void

Implementation of

IViewportController.destroy

---

getTimeBounds()

getTimeBounds(): object;

Returns active outer time limits in seconds.

Returns

object

maxTime

maxTime: number;

minTime

minTime: number;

Implementation of

IViewportController.getTimeBounds

---

getViewport()

getViewport(): ViewportState;

Returns the current viewport state.

Returns

ViewportState

Implementation of

IViewportController.getViewport

---

on()

on<K>(event: K, handler: (e: ViewportEvents[K]) => void): () => void;

Subscribes to viewport change and destruction events.

Type Parameters

Type Parameter
K extends keyof ViewportEvents

Parameters

Parameter	Type
event	K
handler	(e: ViewportEvents[K]) => void

Returns

() => void

Implementation of

IViewportController.on

---

pan()

pan(deltaSeconds: number, source?: string): void;

Shifts visible start and end times by a delta in seconds.

Parameters

Parameter	Type
deltaSeconds	number
source?	string

Returns

void

Implementation of

IViewportController.pan

---

panFrequency()

panFrequency(deltaHz: number, source?: string): void;

Shifts visible frequency range by a delta in Hz.

Parameters

Parameter	Type
deltaHz	number
source?	string

Returns

void

Implementation of

IViewportController.panFrequency

---

panTime()

panTime(deltaSeconds: number, source?: string): void;

Shifts visible start and end times by a delta in seconds.

Parameters

Parameter	Type
deltaSeconds	number
source?	string

Returns

void

Implementation of

IViewportController.panTime

---

panTo()

panTo(startTime: number, source?: string): void;

Moves the viewport start to a specific timestamp in seconds.

Parameters

Parameter	Type
startTime	number
source?	string

Returns

void

Implementation of

IViewportController.panTo

---

reset()

reset(): void;

Resets viewport to default time and frequency limits.

Returns

void

Implementation of

IViewportController.reset

---

setBaseFrequencyBounds()

setBaseFrequencyBounds(minFrequency: number, maxFrequency: number): void;

Parameters

Parameter	Type
minFrequency	number
maxFrequency	number

Returns

void

---

setTimeBounds()

setTimeBounds(minTime: number, maxTime: number): void;

Sets outer time limits in seconds for panning and zooming.

Parameters

Parameter	Type
minTime	number
maxTime	number

Returns

void

Implementation of

IViewportController.setTimeBounds

---

setTotalDuration()

setTotalDuration(totalDuration: number): void;

Parameters

Parameter	Type
totalDuration	number

Returns

void

---

setViewport()

setViewport(patch: Partial<ViewportConfig>, source?: string): void;

Updates viewport coordinates and notifies listeners.

Parameters

Parameter	Type
patch	Partial<ViewportConfig>
source?	string

Returns

void

Implementation of

IViewportController.setViewport

---

updateViewport()

updateViewport(patch: Partial<ViewportConfig>, source?: string): void;

Alias for setViewport.

Parameters

Parameter	Type
patch	Partial<ViewportConfig>
source?	string

Returns

void

Implementation of

IViewportController.updateViewport

---

zoom()

zoom(
   factor: number,
   centerTime?: number,
   source?: string): void;

Zooms the time axis around an optional center time in seconds.

Parameters

Parameter	Type
factor	number
centerTime?	number
source?	string

Returns

void

Implementation of

IViewportController.zoom

---

zoomBoth()

zoomBoth(
   factor:
  | number
  | {
  frequency: number;
  time: number;
},
   center?: object,
   source?: string): void;

Zooms both time and frequency axes simultaneously.

Parameters

Parameter	Type
factor	| number | { frequency: number; time: number; }
center?	{ frequency?: number; time?: number; }
center.frequency?	number
center.time?	number
source?	string

Returns

void

Implementation of

IViewportController.zoomBoth

---

zoomFreq()

zoomFreq(
   factor: number,
   centerFrequency?: number,
   source?: string): void;

Alias for zoomFrequency.

Parameters

Parameter	Type
factor	number
centerFrequency?	number
source?	string

Returns

void

Implementation of

IViewportController.zoomFreq

---

zoomFrequency()

zoomFrequency(
   factor: number,
   centerFrequency?: number,
   source?: string): void;

Zooms the frequency axis around an optional center frequency in Hz.

Parameters

Parameter	Type
factor	number
centerFrequency?	number
source?	string

Returns

void

Implementation of

IViewportController.zoomFrequency

---

zoomTime()

zoomTime(
   factor: number,
   centerTime?: number,
   source?: string): void;

Zooms the time axis around an optional center time in seconds.

Parameters

Parameter	Type
factor	number
centerTime?	number
source?	string

Returns

void

Implementation of

IViewportController.zoomTime