@dashspec/renderer 0.1.27 → 0.1.28
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/CHANGELOG.md +13 -0
- package/dist/{chunk-4OUWLEBB.js → chunk-DHZPR7K7.js} +13 -3
- package/dist/{chunk-4OUWLEBB.js.map → chunk-DHZPR7K7.js.map} +1 -1
- package/dist/{core-BHAqRR6L.d.ts → core-CwFVyxKt.d.ts} +1 -1
- package/dist/core.d.ts +1 -1
- package/dist/core.js +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +36 -11
- package/dist/index.js.map +1 -1
- package/docs/widgets.md +2 -2
- package/package.json +1 -1
package/docs/widgets.md
CHANGED
|
@@ -27,7 +27,7 @@ Icon, Divider, Button) accepts these in `spec`:
|
|
|
27
27
|
| `subtitle` | string | Smaller text under the title |
|
|
28
28
|
| `info` | string | Help text behind an ⓘ next to the title |
|
|
29
29
|
| `meta` | string | Short text on the right of the header, e.g. `"Total: ${datasources.summary.data.total}"` |
|
|
30
|
-
| `live` | boolean | Shows "● Live, updated just now" from the datasource's last update |
|
|
30
|
+
| `live`, `liveText` (`{time}`, `{ago}`) | boolean | Shows "● Live, updated just now" from the datasource's last update |
|
|
31
31
|
| `data` | binding | Where the data comes from (below) |
|
|
32
32
|
| `options` | object | Passed to the underlying library (charts: ECharts options), merged last |
|
|
33
33
|
| `highlight` | string | Hover group: widgets with the same group highlight together |
|
|
@@ -107,7 +107,7 @@ Field props such as `x`, `label` or `value` name a field of each data row; dot p
|
|
|
107
107
|
|
|
108
108
|
| Kind | What it shows | Main props | Events |
|
|
109
109
|
|---|---|---|---|
|
|
110
|
-
| `BarChart` | Bars, grouped, stacked or horizontal | `x` (required), `y` (field or list), `seriesBy`, `labels`, `seriesColors` (colour per y field or series value), `stacked`, `normalized`, `horizontal`, `range: { low, high }`, `pageSize`, `colorBy` (`average` / `none`), `partial`, `valueLabels`, `averageLine`, `legendLabels`, `target`, `targetLabel`, `valueAxis` (`min`, `max`, `atLeast`, `step`), `tooltip` (`{ title, lines }`, templates over the hovered `row`; `**bold**` for values), `unit`, `format` | `click`, `doubleClick`, `hover`, `hoverEnd`, `legendClick`, `brush`, `datazoom` (parts `bar`, `legend`, `axis`) |
|
|
110
|
+
| `BarChart` | Bars, grouped, stacked or horizontal | `x` (required), `y` (field or list), `seriesBy`, `labels`, `seriesColors` (colour per y field or series value), `legendStyle` (`chart` / `html`: legend list in the header row), `hideZeroLabels`, `maxDecimals` (labels with at most n decimals, trailing zeros dropped), `stacked`, `normalized`, `horizontal`, `range: { low, high }`, `pageSize`, `colorBy` (`average` / `none`), `partial`, `valueLabels`, `averageLine`, `legendLabels`, `target`, `targetLabel`, `valueAxis` (`min`, `max`, `atLeast`, `step`, `minStep`), `tooltip` (`{ title, lines }`, templates over the hovered `row`; `**bold**` for values), `unit`, `format` | `click`, `doubleClick`, `hover`, `hoverEnd`, `legendClick`, `brush`, `datazoom` (parts `bar`, `legend`, `axis`) |
|
|
111
111
|
| `LineChart` | Lines or areas over `x` | `x` (required), `y`, `seriesBy`, `area`, `gradient`, `smooth`, plus the bar chart's `labels`, `target`, `unit`, `format` | same as BarChart (parts `point`, `legend`, `axis`) |
|
|
112
112
|
| `PieChart` | A pie or donut | `label`, `value` (required), `donut`, `unit`, `format`, `decimals` | `click`, `hover`, `hoverEnd`, `legendClick` (parts `slice`, `legend`) |
|
|
113
113
|
| `Scatter` | Points by two numbers | `x`, `y` (required), `size`, `series`, `xLabel`, `yLabel` | `click`, `hover`, `hoverEnd`, `brush`, `legendClick` |
|