Class WidgetController

constructor

• new WidgetController(): WidgetController

  Returns WidgetController

Readonlyevents

widgets

• get widgets(): Widget<Viewer>[]

  List of viewport widgets

  Returns Widget<Viewer>[]

addWidget

• addWidget(widget: Widget, shiftDelta?: number): void

  Adds the given widget to the viewport

  Parameters

  • widget: Widget
  • shiftDelta: number = 20

    Delta in pixels to shift the widget position if overlapping another

  Returns void

clearAllWidgets

• clearAllWidgets(): void

  Removes all the widget from the viewport

  Returns void

ensureWidgetsInRect

• ensureWidgetsInRect(): void

  Ensure widgets are visible in the rect (x, y, width, height)

  Returns void

getWidgetsAtPos

• getWidgetsAtPos(x: number, y: number, delta?: number): Widget<Viewer>[]

  Parameters

  • x: number
  • y: number
  • delta: number = 5

  Returns Widget<Viewer>[]

getWidgetsOfType

• getWidgetsOfType<T extends Widget<Viewer> = Widget<Viewer>>(
      type: keyof ViewerWidgetRegistry,
  ): Generator<T, void, unknown>

  Returns an iterator over the widget of the given type

  Type Parameters

  • T extends Widget<Viewer> = Widget<Viewer>

  Parameters

  • type: keyof ViewerWidgetRegistry

  Returns Generator<T, void, unknown>

hasWidget

• hasWidget(widget: Widget): boolean

  Returns whether the given widget is displayed on the viewport

  Parameters

  • widget: Widget

  Returns boolean

putWidgetInForeground

• putWidgetInForeground(foregroundWidget: Widget): void

  Puts the given widget in the foreground and put the others in the background (changes z-index).

  Parameters

  • foregroundWidget: Widget

  Returns void

removeWidget

• removeWidget(widget: Widget): void

  Removes the given widget from the viewport

  Parameters

  • widget: Widget

  Returns void