diff --git a/vizro-core/examples/_chart-gallery/README.md b/vizro-core/examples/_chart-gallery/README.md index 1f2a4ca08..3d45dc1ed 100644 --- a/vizro-core/examples/_chart-gallery/README.md +++ b/vizro-core/examples/_chart-gallery/README.md @@ -6,66 +6,64 @@ to create them using Plotly and Vizro. Inspired by the [FT Visual Vocabulary](https://github.com/Financial-Times/chart-doctor/blob/main/visual-vocabulary/README.md): FT Graphics: Alan Smith, Chris Campbell, Ian Bott, Liz Faunce, Graham Parrish, Billy Ehrenberg, Paul McCallum, Martin Stabe - ## Chart types -The dashboard is still in development. Below is an overview of the chart types for which a completed page is available. - -| Chart Type | Status | Category | -|----------------------|---------|---------------------------| -| Arc | ❌ | Part-to-whole | -| Barcode | ❌ | Distribution | -| Bar | ✅ | Magnitude | -| Boxplot | ✅ | Distribution | -| Bubble | ❌ | Correlation, Magnitude | -| Bubble Map | ❌ | Spatial | -| Bubble Timeline | ❌ | Time | -| Bullet | ❌ | Magnitude | -| Butterfly | ✅ | Deviation, Distribution | -| Chord | ❌ | Flow | -| Choropleth | ✅ | Spatial | -| Column | ✅ | Magnitude, Time | -| Column-Line | ❌ | Correlation, Time | -| Cumulative Curve | ❌ | Distribution | -| Diverging Bar | ❌ | Deviation | -| Dot Map | ❌ | Spatial | -| Dot Plot | ❌ | Distribution | -| Donut | ✅ | Part-to-whole | -| Fan | ❌ | Time | -| Flow Map | ❌ | Spatial | -| Funnel | ❌ | Part-to-whole | -| Gantt | ❌ | Time | -| Heatmap | ❌ | Time | -| Heatmap-Matrix | ❌ | Correlation | -| Histogram | ❌ | Distribution | -| Line | ❌ | Time | -| Lollipop | ❌ | Ranking, Magnitude | -| Marimekko | ❌ | Magnitude, Part-to-whole | -| Ordered Bar | ✅ | Ranking | -| Ordered Bubble | ❌ | Ranking | -| Ordered Column | ✅ | Ranking | -| Parallel Coordinates | ❌ | Magnitude | -| Pictogram | ❌ | Magnitude | -| Pie | ✅ | Part-to-whole | -| Radar | ❌ | Magnitude | -| Radial | ❌ | Magnitude | -| Sankey | ✅ | Flow | -| Scatter | ✅ | Correlation | -| Scatter Matrix | ❌ | Correlation | -| Slope | ❌ | Ranking, Time | -| Sparkline | ❌ | Time | -| Stacked Bar | ❌ | Part-to-whole | -| Stacked Column | ❌ | Part-to-whole | -| Stepped Line | ❌ | Ranking | -| Surplus-Deficit-Line | ❌ | Deviation | -| Treemap | ✅ | Part-to-whole | -| Venn | ❌ | Part-to-whole | -| Violin | ✅ | Distribution | -| Waterfall | ❌ | Part-to-whole, Flow | +The dashboard is still in development. Below is an overview of the chart types for which a completed page is available. +| Chart Type | Status | Category | +| -------------------- | ------ | ------------------------ | +| Arc | ❌ | Part-to-whole | +| Barcode | ❌ | Distribution | +| Bar | ✅ | Magnitude | +| Boxplot | ✅ | Distribution | +| Bubble | ❌ | Correlation, Magnitude | +| Bubble Map | ❌ | Spatial | +| Bubble Timeline | ❌ | Time | +| Bullet | ❌ | Magnitude | +| Butterfly | ✅ | Deviation, Distribution | +| Chord | ❌ | Flow | +| Choropleth | ✅ | Spatial | +| Column | ✅ | Magnitude, Time | +| Column-Line | ❌ | Correlation, Time | +| Cumulative Curve | ❌ | Distribution | +| Diverging Bar | ❌ | Deviation | +| Dot Map | ❌ | Spatial | +| Dot Plot | ❌ | Distribution | +| Donut | ✅ | Part-to-whole | +| Fan | ❌ | Time | +| Flow Map | ❌ | Spatial | +| Funnel | ❌ | Part-to-whole | +| Gantt | ❌ | Time | +| Heatmap | ❌ | Time | +| Heatmap-Matrix | ❌ | Correlation | +| Histogram | ❌ | Distribution | +| Line | ❌ | Time | +| Lollipop | ❌ | Ranking, Magnitude | +| Marimekko | ❌ | Magnitude, Part-to-whole | +| Ordered Bar | ✅ | Ranking | +| Ordered Bubble | ❌ | Ranking | +| Ordered Column | ✅ | Ranking | +| Parallel Coordinates | ❌ | Magnitude | +| Pictogram | ❌ | Magnitude | +| Pie | ✅ | Part-to-whole | +| Radar | ❌ | Magnitude | +| Radial | ❌ | Magnitude | +| Sankey | ✅ | Flow | +| Scatter | ✅ | Correlation | +| Scatter Matrix | ❌ | Correlation | +| Slope | ❌ | Ranking, Time | +| Sparkline | ❌ | Time | +| Stacked Bar | ❌ | Part-to-whole | +| Stacked Column | ❌ | Part-to-whole | +| Stepped Line | ❌ | Ranking | +| Surplus-Deficit-Line | ❌ | Deviation | +| Treemap | ✅ | Part-to-whole | +| Venn | ❌ | Part-to-whole | +| Violin | ✅ | Distribution | +| Waterfall | ❌ | Part-to-whole, Flow | ## How to run the example locally -1. If you have `hatch` set up, run the example with the command `hatch run example charts`. -Otherwise, run the `app.py` file with your environment activated where `vizro` is installed. +1. If you have `hatch` set up, run the example with the command `hatch run example charts`. + Otherwise, run the `app.py` file with your environment activated where `vizro` is installed. 2. You should now be able to access the app locally via http://127.0.0.1:8050/.