setWidgetEnabled

Hides or shows any of the viewer UI widgets.

Parameters:

  • widgetName (string | array of strings): The name or list of names of widgets to enable/disable. The following strings are supported. If any other strings are passed, then the whole operation will fail.

    • search: show or hide the search bar

    • fullScreen: the button to switch to full-screen mode

    • navigation: the zoom and compass buttons

    • view_toggle: the button to toggle between sphere and map view

    • snapshot: the button to display the SnapshotHD feature functionality

    • info: the button to show info about the current sphere

    • help: the button to bring up on-screen help for using the viewer

  • enabled (boolean): If true, then show the given widget(s); if false, then hide them. (By default, all are visible.)


Returns: A promise that resolves to an object with boolean properties corresponding to each possible widget name above, set to true if that widget is visible.

Code Sample