Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgervang committed Jan 8, 2025
1 parent 77790be commit 575fb79
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions bindings/pydeck/pydeck/bindings/widget.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@

class Widget(JSONMixin):
"""
Represents a widget
Represents a deck.gl widget, which are UI components around the WebGL2/WebGPU canvas
to offer controls and information for a better user experience.
Parameters
---------
type : str, default None
deck.gl widget to display, e.g., CompassWidget
deck.gl widget to display, e.g., 'CompassWidget'
id : str, default None
Unique name for layer
Unique name for widget
placement : string, default 'top-left'
Placement of the widget on the map. Options are 'top-left', 'top-right', 'bottom-left', 'bottom-right', and 'fill'.
Note that not all widgets support custom placement.
view_id : string, default null
ID of the view to which the widget should be added.
view_id : string, default None
ID of the view to which the widget should be added. The widget will be added to the default view if not specified.
Note that not all widgets support custom view_id.
**kwargs
Any of the parameters passable to a deck.gl Widget
Expand Down

0 comments on commit 575fb79

Please # to comment.