In-panel and off-panel widgets

Two types of widgets are supported: off-panel widgets (such as the Scalebar widget) and in-panel widgets (such as the Query widget). Before you begin coding, determine whether or not your widget needs a panel. The differences between the two panels are as follows:

  • As the names imply, off-panel widgets cannot open in a panel, while in-panel widgets must open in a panel.
  • Off-panel widgets have a closeable property when configured as an on-screen widget. If closeable is set to true, the app container creates an icon to open and close the widget; if it's set to false, the app container loads and opens the widget by default.
  • Off-panel widgets cannot be put into a group.

All widgets have an initial state to indicate whether the openAtStart property is set to true or false.

You can set the inPanel property in a widget’s manifest.json file. For details, see Widget manifest.

For more information on panels, see Create a theme.