lmiranda
b5d36865ee
Add single-line visual headers to 66 command files across 10 plugins: - clarity-assist (2 commands): 💬 - claude-config-maintainer (5 commands): ⚙️ - cmdb-assistant (11 commands): 🖥️ - code-sentinel (3 commands): 🔒 - contract-validator (5 commands): ✅ - data-platform (10 commands): 📊 - doc-guardian (5 commands): 📝 - git-flow (8 commands): 🔀 - pr-review (7 commands): 🔍 - viz-platform (10 commands): 🎨 Each command now displays a consistent header at execution start: ┌────────────────────────────────────────────────────────────────┐ │ [icon] PLUGIN-NAME · Command Description │ └────────────────────────────────────────────────────────────────┘ Addresses #275 (other plugin commands visual output) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
127 lines
3.3 KiB
Markdown
127 lines
3.3 KiB
Markdown
---
|
|
description: Export a Plotly chart to PNG, SVG, or PDF format
|
|
---
|
|
|
|
# Export Chart
|
|
|
|
## Visual Output
|
|
|
|
When executing this command, display the plugin header:
|
|
|
|
```
|
|
┌──────────────────────────────────────────────────────────────────┐
|
|
│ 🎨 VIZ-PLATFORM · Chart Export │
|
|
└──────────────────────────────────────────────────────────────────┘
|
|
```
|
|
|
|
Then proceed with the export.
|
|
|
|
Export a Plotly chart to static image formats for sharing, embedding, or printing.
|
|
|
|
## Usage
|
|
|
|
```
|
|
/chart-export {format}
|
|
```
|
|
|
|
## Arguments
|
|
|
|
- `format` (required): Output format - one of: png, svg, pdf
|
|
|
|
## Examples
|
|
|
|
```
|
|
/chart-export png
|
|
/chart-export svg
|
|
/chart-export pdf
|
|
```
|
|
|
|
## Tool Mapping
|
|
|
|
This command uses the `chart_export` MCP tool:
|
|
|
|
```python
|
|
chart_export(
|
|
figure=figure_json, # Plotly figure JSON from chart_create
|
|
format="png", # Output format: png, svg, pdf
|
|
width=1200, # Optional: image width in pixels
|
|
height=800, # Optional: image height in pixels
|
|
scale=2, # Optional: resolution scale factor
|
|
output_path=None # Optional: save to file path
|
|
)
|
|
```
|
|
|
|
## Workflow
|
|
|
|
1. **User invokes**: `/chart-export png`
|
|
2. **Agent asks**: Which chart to export? (if multiple charts in context)
|
|
3. **Agent asks**: Image dimensions? (optional, uses chart defaults)
|
|
4. **Agent exports**: Chart with `chart_export` tool
|
|
5. **Agent returns**: Base64 image data or file path
|
|
|
|
## Output Formats
|
|
|
|
| Format | Best For | File Size |
|
|
|--------|----------|-----------|
|
|
| `png` | Web, presentations, general use | Medium |
|
|
| `svg` | Scalable graphics, editing | Small |
|
|
| `pdf` | Print, documents, archival | Large |
|
|
|
|
## Resolution Options
|
|
|
|
### Width & Height
|
|
Specify exact pixel dimensions:
|
|
```python
|
|
chart_export(figure, format="png", width=1920, height=1080)
|
|
```
|
|
|
|
### Scale Factor
|
|
Increase resolution for high-DPI displays:
|
|
```python
|
|
chart_export(figure, format="png", scale=3) # 3x resolution
|
|
```
|
|
|
|
Common scale values:
|
|
- `1` - Standard resolution (72 DPI)
|
|
- `2` - Retina/HiDPI (144 DPI)
|
|
- `3` - Print quality (216 DPI)
|
|
- `4` - High-quality print (288 DPI)
|
|
|
|
## Output Options
|
|
|
|
### Return as Base64
|
|
Default behavior - returns base64-encoded image data:
|
|
```python
|
|
result = chart_export(figure, format="png")
|
|
# result["image_data"] contains base64 string
|
|
```
|
|
|
|
### Save to File
|
|
Specify output path to save directly:
|
|
```python
|
|
chart_export(figure, format="png", output_path="/path/to/chart.png")
|
|
# result["file_path"] contains the saved path
|
|
```
|
|
|
|
## Requirements
|
|
|
|
This tool requires the `kaleido` package for rendering:
|
|
```bash
|
|
pip install kaleido
|
|
```
|
|
|
|
Kaleido is a cross-platform library that renders Plotly figures without a browser.
|
|
|
|
## Error Handling
|
|
|
|
Common issues:
|
|
- **Kaleido not installed**: Install with `pip install kaleido`
|
|
- **Invalid figure**: Ensure figure is valid Plotly JSON
|
|
- **Permission denied**: Check write permissions for output path
|
|
|
|
## Related Commands
|
|
|
|
- `/chart {type}` - Create a chart
|
|
- `/theme {name}` - Apply theme before export
|
|
- `/dashboard` - Create layout containing charts
|