get_vizro_chart_or_dashboard_plan
Generate step-by-step instructions for building Vizro charts or dashboards. Start with basic configurations and use advanced mode for custom CSS, components, or actions when needed.
Instructions
Get instructions for creating a Vizro chart or dashboard. Call FIRST when asked to create Vizro things.
Must be ALWAYS called FIRST with advanced_mode=False, then call again with advanced_mode=True
if the JSON config does not suffice anymore.
Args:
user_plan: The type of Vizro thing the user wants to create
user_host: The host the user is using, if "ide" you can use the IDE/editor to run python code
advanced_mode: Only call if you need to use custom CSS, custom components or custom actions.
No need to call this with advanced_mode=True if you need advanced charts, use `custom_charts` in
the `validate_dashboard_config` tool instead.
Returns:
Instructions for creating a Vizro chart or dashboard
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| advanced_mode | No | ||
| user_host | Yes | ||
| user_plan | Yes |
Input Schema (JSON Schema)
{
"properties": {
"advanced_mode": {
"default": false,
"title": "Advanced Mode",
"type": "boolean"
},
"user_host": {
"enum": [
"generic_host",
"ide"
],
"title": "User Host",
"type": "string"
},
"user_plan": {
"enum": [
"chart",
"dashboard"
],
"title": "User Plan",
"type": "string"
}
},
"required": [
"user_plan",
"user_host"
],
"title": "get_vizro_chart_or_dashboard_planArguments",
"type": "object"
}