w.dashboard_widgets
: Dashboard Widgets¶
- class databricks.sdk.service.sql.DashboardWidgetsAPI¶
This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace. Data structures may change over time.
- create(dashboard_id: str, options: WidgetOptions, width: int [, text: Optional[str], visualization_id: Optional[str]]) Widget ¶
Add widget to a dashboard.
- Parameters:
dashboard_id – str Dashboard ID returned by :method:dashboards/create.
options –
WidgetOptions
width – int Width of a widget
text – str (optional) If this is a textbox widget, the application displays this text. This field is ignored if the widget contains a visualization in the visualization field.
visualization_id – str (optional) Query Vizualization ID returned by :method:queryvisualizations/create.
- Returns:
- delete(id: str)¶
Remove widget.
- Parameters:
id – str Widget ID returned by :method:dashboardwidgets/create
- update(id: str, dashboard_id: str, options: WidgetOptions, width: int [, text: Optional[str], visualization_id: Optional[str]]) Widget ¶
Update existing widget.
- Parameters:
id – str Widget ID returned by :method:dashboardwidgets/create
dashboard_id – str Dashboard ID returned by :method:dashboards/create.
options –
WidgetOptions
width – int Width of a widget
text – str (optional) If this is a textbox widget, the application displays this text. This field is ignored if the widget contains a visualization in the visualization field.
visualization_id – str (optional) Query Vizualization ID returned by :method:queryvisualizations/create.
- Returns: