Skip to content

Commit 94fee7b

Browse files
graphierosgraphieros
committed
Update docs
1 parent 260ce18 commit 94fee7b

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

‎README.md‎

100644100755
Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88

99
# vue-data-ui
1010

11-
![npm](https://img.shields.io/npm/v/vue-data-ui)
12-
![Static Badge](https://img.shields.io/badge/components-56-blue)
13-
![GitHub issues](https://img.shields.io/github/issues/graphieros/vue-data-ui)
14-
[![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE)
11+
[![npm](https://img.shields.io/npm/v/vue-data-ui)](https://github.com/graphieros/vue-data-ui)
12+
[![Static Badge](https://img.shields.io/badge/components-57-blue)](https://github.com/graphieros/vue-data-ui)
13+
[![GitHub issues](https://img.shields.io/github/issues/graphieros/vue-data-ui)](https://github.com/graphieros/vue-data-ui/issues)
14+
[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/graphieros/vue-data-ui?tab=MIT-1-ov-file#readme)
1515
[![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/4526-shield.svg)](https://madewithvuejs.com/p/vue-data-ui/shield-link)
16-
![npm](https://img.shields.io/npm/dt/vue-data-ui)
16+
[![npm](https://img.shields.io/npm/dt/vue-data-ui)](https://github.com/graphieros/vue-data-ui)
1717

1818
[Interactive documentation](https://vue-data-ui.graphieros.com/)
1919

@@ -44,6 +44,7 @@ Available components
4444
- [VueUiRelationCircle](https://vue-data-ui.graphieros.com/docs#vue-ui-relation-circle)
4545
- [VueUiRings](https://vue-data-ui.graphieros.com/docs#vue-ui-rings)
4646
- [VueUiScatter](https://vue-data-ui.graphieros.com/docs#vue-ui-scatter)
47+
- [VueUiStackbar](https://vue-data-ui.graphieros.com/docs#vue-ui-stackbar)
4748
- [VueUiStripPlot](https://vue-data-ui.graphieros.com/docs#vue-ui-strip-plot)
4849
- [VueUiThermometer](https://vue-data-ui.graphieros.com/docs#vue-ui-thermometer)
4950
- [VueUiTiremarks](https://vue-data-ui.graphieros.com/docs#vue-ui-tiremarks)
@@ -249,6 +250,7 @@ The following charts bear these slots:
249250
- VueUiRadar
250251
- VueUiRings
251252
- VueUiScatter
253+
- VueUiStackbar
252254
- VueUiTreemap
253255
- VueUiVerticalBar
254256
- VueUiXy \*
@@ -390,8 +392,8 @@ From the dataset you pass into the props, this component will produce the most a
390392
| `VueUiAgePyramid` | `Array<Array<string / number>>` | `VueUiSparklineConfig` | `generatePdf`, `generateImage`, `generateCsv`, `toggleTable`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#watermark` | ✅ | ✅ |
391393
| `VueUiCandlestick` | `Array<Array<string / number>>` | `VueUiCandlestickConfig` | `generatePdf`, `generateImage`, `generateCsv`, `toggleTable`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#reset-action`, `#watermark` | ✅ | ✅ |
392394
| `VueUiChestnut` | `VueUiChestnutDatasetRoot[]` | `VueUiChestnutConfig` | `@selectRoot`, `@selectBranch`, `@selectNut`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable` | `#svg`, `#legend`, `#watermark` | ❌ | ✅ |
393-
| `VueUiDonut` | `VueUiDonutDatasetItem[]` | `VueUiDonutConfig` | `@selectDatapoint`, `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleLabels`, `toggleTooltip` | `#svg`, `#legend`, `#dataLabel`, `#tooltip-before`, `#tooltip-after`, `#plot-comment`, `#watermark` | ✅ | ✅ |
394395
| `VueUiDonutEvolution` | `VueUiDonutEvolutionDatasetItem[]` | `VueUiDonutEvolutionConfig` | `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable` | `#svg`, `#legend`, `#reset-action`, `#watermark` | ❌ | ✅ |
396+
| `VueUiDonut` | `VueUiDonutDatasetItem[]` | `VueUiDonutConfig` | `@selectDatapoint`, `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleLabels`, `toggleTooltip` | `#svg`, `#legend`, `#dataLabel`, `#tooltip-before`, `#tooltip-after`, `#plot-comment`, `#watermark` | ✅ | ✅ |
395397
| `VueUiDumbbell` | `VueUiDumbbellDataset[]` | `VueUiDumbbellConfig` | `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable` | `#svg`, `#legend`, `#watermark` | ❌ | ✅ |
396398
| `VueUiFlow` | `VueUiFlowDatasetItem[]` | `VueUiFlowConfig` | `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable` | `#svg`,, `#watermark` | ❌ | ✅ |
397399
| `VueUiGalaxy` | `VueUiGalaxyDatasetItem[]` | `VueUiGalaxyConfig` | `@selectDatapoint`, `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleTooltip` | `#svg`, `#legend`,`#tooltip-before`, `#tooltip-after` | ✅ | ✅ |
@@ -406,6 +408,7 @@ From the dataset you pass into the props, this component will produce the most a
406408
| `VueUiRadar` | `VueUiRadarDataset` | `VueUiRadarConfig` | `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#watermark` | ✅ | ✅ |
407409
| `VueUiRings` | `VueUiRingsDatasetItem[]` | `VueUiRingsConfig` | `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#watermark` | ✅ | ✅ |
408410
| `VueUiScatter` | `VueUiScatterDatasetItem[]` | `VueUiScatterConfig` | `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#watermark` | ✅ | ✅ |
411+
| `VueUiStackbar` | `VueUiStackbarDatasetItem[]` | `VueUiStackbarConfig` | `@selectLegend`, `@selectDatapoint`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleLabels`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#reset-action`, `#watermark` | ✅ | ✅ |
409412
| `VueUiStripPlot` | `VueUiStripPlotDataset[]` | `VueUiStripPlotConfig` | `@selectDatapoint`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleLabels`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#watermark` | ✅ | ✅ |
410413
| `VueUiThermometer` | `VueUiThermometerDataset` | `VueUiThermometerConfig` | `generatePdf`, `generateImage` | `#svg`, `#watermark` | ❌ | ✅ |
411414
| `VueUiTiremarks` | `VueUiTiremarksDataset` | `VueUiTiremarksConfig` | `generatePdf`, `generateImage` | `#svg`, `#legend`, `#watermark` | ❌ | ✅ |
@@ -414,8 +417,8 @@ From the dataset you pass into the props, this component will produce the most a
414417
| `VueUiWaffle` | `VueUiWaffleDatasetItem[]` | `VueUiWaffleConfig` | `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#watermark` | ✅ | ✅ |
415418
| `VueUiWheel` | `VueUiWheelDataset` | `VueUiWheelConfig` | `generatePdf`, `generateImage` | `#svg`, `#watermark` | ❌ | ✅ |
416419
| `VueUiWordCloud` | `VueUiWordCloudDatasetItem[] / string` | `VueUiWordCloudConfig` | `getData`, `generatePdf`, `generateImage`, `generateCsv` | `#svg`, `#watermark` | ❌ | ✅ |
417-
| `VueUiXy` | `VueUiXyDatasetItem[]` | `VueUiXyConfig` | `@selectLegend`, `@selectX`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleLabels`, `toggleStack`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#reset-action`, `#plot-comment`,`#watermark` | ✅ | ✅ |
418420
| `VueUiXyCanvas` | `VueUiXyCanvasDatasetItem[]` | `VueUiXyCanvasConfig` | `@selectLegend`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleLabels`, `toggleStack`, `toggleTooltip` | `#legend`, `#tooltip-before`, `#tooltip-after`, `#reset-action`, `#watermark` | ✅ | ✅ |
421+
| `VueUiXy` | `VueUiXyDatasetItem[]` | `VueUiXyConfig` | `@selectLegend`, `@selectX`, `getData`, `generatePdf`, `generateCsv`, `generateImage`, `toggleTable`, `toggleLabels`, `toggleStack`, `toggleTooltip` | `#svg`, `#legend`, `#tooltip-before`, `#tooltip-after`, `#reset-action`, `#plot-comment`,`#watermark` | ✅ | ✅ |
419422

420423
### 3D charts
421424

@@ -545,6 +548,7 @@ User options actions available per chart:
545548
| VueUiSparkbar | (no user options menu) |
546549
| VueUiSparkgauge | (no user options menu) |
547550
| VueUiSparkline | (no user options menu) |
551+
| VueUiStackbar | optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen |
548552
| VueUiStripPlot | optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen |
549553
| VueUiTableHeatmap | optionPdf, optionImg, optionCsv, optionFullscreen |
550554
| VueUiTableSparkline | optionPdf, optionImg, optionCsv, optionFullscreen |
@@ -581,6 +585,7 @@ It is possible to provide a custom palette in the config prop through config.cus
581585
- VueUiScatter
582586
- VueUiSparkStackbar
583587
- VueUiSparkbar
588+
- VueUiStackbar
584589
- VueUiStripPlot
585590
- VueUiTableSparkline
586591
- VueUiThermometer
@@ -630,6 +635,7 @@ However the folowing charts can be made fully responsive, making them better to
630635
| VueUiSparkbar | - |
631636
| VueUiSparkgauge | - |
632637
| VueUiSparkline | - |
638+
| VueUiStackbar | ✅ |
633639
| VueUiStripPlot | ✅ |
634640
| VueUiTableHeatmap | - |
635641
| VueUiTableSparkline | - |

0 commit comments

Comments
 (0)