vue-data-ui 2.0.57 → 2.0.59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -182,16 +182,16 @@ The svg slot also works when using the VueDataUi universal component, if the com
182
182
 
183
183
  All charts expose a #legend slot except for:
184
184
 
185
- - VueUiWheel
186
- - VueUiTiremarks
187
185
  - VueUiHeatmap
188
186
  - VueUiRelationCircle
189
- - VueUiThermometer
190
- - VueUiSparkline
191
- - VueUiSparkbar
187
+ - VueUiSparkHistogram
192
188
  - VueUiSparkStackbar
189
+ - VueUiSparkbar
193
190
  - VueUiSparkgauge
194
- - VueUiSparkHistogram
191
+ - VueUiSparkline
192
+ - VueUiThermometer
193
+ - VueUiTiremarks
194
+ - VueUiWheel
195
195
 
196
196
  The legend slot also works when using the VueDataUi universal component, if the component it wraps supports it.
197
197
  It is recommended to set the show legend config attribute to false, to hide the default legend.
@@ -209,14 +209,25 @@ It is recommended to set the show legend config attribute to false, to hide the
209
209
  ## Tooltip #tooltip-before & #tooltip-after slots
210
210
 
211
211
  Since v.2.0.57, it is possible to further customize tooltip contents with #tooltip-before and #tooltip-after slots.
212
- It is that easy to include an image, another chart or any other content into your tooltips.
213
- These slots do not expose any data, as you can create your own custom data content using the config option tooltip.customFormat.
212
+ It is that easy to include an image, another chart or any other content into your tooltips. It's an alternative to the config option tooltip.customFormat, in case richer tooltip content is needed.
213
+
214
+ Both slots expose the following object:
215
+
216
+ ```
217
+ {
218
+ datapoint,
219
+ seriesIndex,
220
+ series,
221
+ config,
222
+ }
223
+ ```
214
224
 
215
225
  The following charts bear these slots:
216
226
 
217
227
  - VueUiAgePyramid
218
228
  - VueUiCandlestick
219
229
  - VueUiDonut
230
+ - VueUiGalaxy
220
231
  - VueUiHeatmap
221
232
  - VueUiMolecule
222
233
  - VueUiNestedDonuts
@@ -226,17 +237,29 @@ The following charts bear these slots:
226
237
  - VueUiRings
227
238
  - VueUiScatter
228
239
  - VueUiVerticalBar
229
- - VueUiXy
240
+ - VueUiXy \*
230
241
  - VueUiwaffle
231
242
 
243
+ \* VueUiXy slots specifically expose the following additional attributes:
244
+
232
245
  ```
246
+
247
+ {
248
+ ...,
249
+ bars,
250
+ lines,
251
+ plots
252
+ }
253
+
254
+ ```
255
+
233
256
  <VueUiDonut :config="config" :dataset="dataset">
234
- <template #tooltip-before">
257
+ <template #tooltip-before={ datapoint, seriesIndex, dataset, config }">
235
258
  <div>
236
259
  This content shows first
237
260
  </div>
238
261
  </template>
239
- <template #tooltip-after">
262
+ <template #tooltip-after={ datapoint, seriesIndex, dataset, config }">
240
263
  <div>
241
264
  This content shows last
242
265
  </div>