Tracker: Widgets

[ibgreen]

Goal: Leverage the new widget support in deck.gl. Increase the catalog of pre-built widgets, improve the usability of the widget system. Support both the geospatial and info vis domains

• RFC
• Openvis Widgets WG -

v9.3+

• feat(mapbox): Add widget support to MapboxOverlay via IControl adapter #9962 - widgets with viewId: 'mapbox' render in Mapbox control container
• feat(mapbox): Add Controlled Mode and State Callbacks to Widgets #9964
  • feat(widgets): Add controlled mode and state callbacks #9973
• GimbalWidget - handle more viewport types
• CompassWidget - handle more viewport types
• TimelineWidget - more features, better styling
• InfoWidget - Decide on if and how to align with getTooltip()

v9.2 Punch List

• Graduate _ResetViewWidget -
• Graduate _ScreenshotWidget -
• Graduate _ThemeWidget -
• Graduate _ScaleWidget -
• Graduate _TimelineWidget - Address feedback in feat(widgets): minimal TimelineWidget (PoC) #9587
• Graduate _SplitterWidget - Address issues in [feat]: SplitterWidget #9565
• Graduate _GeolocateWidget
  • Add option where the geocoder is just a small button and clicking on it opens the text field. Right now it permanently occupies a lot of space, not really fitting in to a column of widgets on the side.
• Graduate _InfoWidget -
  • support onHover
  • Define semantics of popups when using multiple viewports. @chrisgervang
• Custom widget developers guide @chrisgervang docs(widgets) Custom Widget Developer Guide #9304
• use CSS variables and add theming for these. --popup-background and --popup-padding @chrisgervang
• Add React Wrappers + Doc updates for new widgets feat(react): Add missing react widget wrappers #9589
• Add new widgets to the python sub-module
• Interactive examples or at least screenshots on each widget page
• Add InfoWidget @felixpalmer
• Modify widget example to include InfoWidget @felixpalmer
• Auto reposition the popup so it is not covered when at the edges of the canvas @ibgreen
• Add minOffset prop to keep the popup from "touching" the edge. @ibgreen
• Add a small "arrow" / "tip" extrusion to point to the selected point @ibgreen
• Ensure the improved positioning is recalculated when panning the view @ibgreen

Simple Widget Library Wish List

• ZoomWidget
• FullScreenWidget
• ScreenshotWidget feat(widgets) New ScreenshotWidget #9454
• CompassWidget (geospatial)
• ResetViewWidget (infovis: plotly style reset view ) feat(widgets): new ResetViewWidget (v9.1) #9478
• ThemeWidget feat(widgets): ThemeWidget #9471 - experimental version landed
• LoadingWidget feat(widgets): New LoadingWidget #9485 - experimental version landed
• ScaleWidget (geospatial) feat(widgets): New ScaleWidget #9491 - experimental _ScaleWidget landed
• GeocoderWidget (geospatial) feat(widgets): Simple GeolocateWidget #9488 - experimental GeolocateWidget landed
• GimbalWidget

"Advanced" Widgets Wish List

• "SplitterWidget" - Landed but address issues in [feat]: SplitterWidget #9565
• PopupWidget POC: InfoWidget #8958 - experimental _InfoWidget landed @felixpalmer
• TooltipWidget - (exists internally, expose?, deduplicate?)
• TimelineWidget** - even the most simple playback would be very valuable @chrisgervang
• "SelectRectToZoomWidget" (infovis: Rectangular selection to zoom - plotly style zoom )
• "SelectRectToSelectRowsWidget" - (infovis: Rectangular selection, lasso selection - plotly style selection widget)
• AI Assistant Widget [Widget] Ai Assistant Widget (Draft) #9428
• EditModeWidgets - editable-layer controls as widgets
• Data Widgets (CARTO proposal) [Feat] Incorporate data widgets to the new widgets module #8057

Components Wish List

• IconMenu
• IconToggle

Widget System Features

• position: 'top-center'| 'bottom-center' | 'center'? (E.g.often a permanent geocoder text field would be placed at top-center of the map.)
• Widgets module RFC, core plumbing [Feat] Widgets module #7946
• JSON support for widgets feat(json) support for deck.gl widgets #9314
• Pydeck support for widgets add(pydeck) support for deck.gl widgets #9342
• React wrappers widgets

Widget System Docs

General deck improvements that would benefit Widgets

The following improvements to deck.gl could benefit the widget system or enable useful widgets

• Add a declarative template system for creating tooltip / popup HTML. RFC in [Feat] tooltip template syntax #9551
• Allow views to set background color - Without it, ScreenshotWidget images are not as expected.
• Selection extension module? - Needed for "plotly style" selection widget?

PopupWidget tracker

A PoC was landed as _InfoWidget as a placeholder until we have a better solution, it attracted a lot of feedback: Given the amount of feedback, we may want to align on requirements / assumptions:

• Click?
• Hover?
• Programmatic creations (multiple popups?)?

Misc Feedback

@Pessimistress A "real" popup does the following

• control placement relative to the anchor, or automatically positioned to fit in the map container; @ibgreen
• have a tip that points to the anchor, like that from Google Maps or Maplibre; @ibgreen
• have a close button and/or
• closes when clicked outside; @felixpalmer
• can render multiple instances on map with the correct z order;

Tooltip tip/arrow