Class WidgetController

constructor

• new WidgetController(): WidgetController

  Returns WidgetController

Readonlycontent

Readonlyfactory

Readonlysignals

widgets

• get widgets(): Widget[]

  List of viewport widgets

  Returns Widget[]

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 widgets from the viewport

  Returns void

ensureWidgetsInRect

• ensureWidgetsInRect(): void

  Ensure all widgets are visible in the widgets container.

  Returns void

getWidgetsAtPos

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

  Parameters

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

  Returns Widget[]

getWidgetsOfType

• getWidgetsOfType<
      T extends keyof WidgetRegistry,
      TWidget = ExtractFactoryFunctionWidget<WidgetRegistry[T]>,
  >(
      type: T,
  ): Generator<TWidget>

  Returns an iterator over the widget of the given type

  Type Parameters

  • T extends keyof WidgetRegistry
  • TWidget = ExtractFactoryFunctionWidget<WidgetRegistry[T]>

  Parameters

  • type: T

  Returns Generator<TWidget>

hasWidget

• hasWidget(widget: Widget): boolean

  Returns whether the given widget is displayed on the viewport

  Parameters

  • widget: Widget

  Returns boolean

hasWidgetOfType

• hasWidgetOfType(type: keyof WidgetRegistry): boolean

  Parameters

  • type: keyof WidgetRegistry

  Returns boolean

putWidgetInForeground

• putWidgetInForeground(widget: Widget): void

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

  Parameters

  • widget: Widget

  Returns void

removeWidget

• removeWidget(widget: Widget): void

  Removes the given widget from the viewport

  Parameters

  • widget: Widget

  Returns void