add_dashboard
Create a dashboard combining multiple worksheets.
Instructions
Create a dashboard combining multiple worksheets.
Recommended workflow for complex dashboards:
Call list_worksheets to lock worksheet names
Design layout with the user (KPI row, main chart, detail views, filters)
Call generate_layout_json to save the layout as a JSON or YAML file
Call add_dashboard with layout=<layout_file_path>
Layout options:
str (file path): Path to JSON or YAML layout file (recommended for complex layouts)
dict: Custom declarative layout tree passed inline Native set control (mode dropdown or checkdropdown): {"type": "set_control", "field": "Set name", "worksheet": "View", "mode": "dropdown"}
"auto" (default): Simple vertical fallback — use layout dict or layout file for mixed layouts
"vertical": All worksheets stacked vertically
"horizontal": All worksheets side-by-side
"grid-2x2": 2x2 grid layout
For dashboard design best practices, read: read_resource('cwtwb://skills/dashboard_designer')
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | ||
| height | No | ||
| layout | No | auto | |
| dashboard_name | Yes | ||
| worksheet_names | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |