@fusion.dev/helix-docs 0.194.0 → 0.196.0
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/content/charting.mdx +26 -18
- package/content/introduction.mdx +1 -0
- package/content/metrics.mdx +223 -223
- package/content/spatial-charts.mdx +30 -6
- package/dist/sources.generated.js +280 -247
- package/package.json +11 -9
package/content/charting.mdx
CHANGED
|
@@ -12,11 +12,11 @@ Helix has these chart families, and each one has its own API page:
|
|
|
12
12
|
- `Line Chart`
|
|
13
13
|
- `Area Chart`
|
|
14
14
|
- `Scatter Chart`
|
|
15
|
-
- `Spatial Scatter Chart`, drawn in three dimensions
|
|
16
|
-
- `Spatial Surface Chart`, drawn in three dimensions
|
|
15
|
+
- `Spatial Scatter Chart`, drawn in three dimensions
|
|
16
|
+
- `Spatial Surface Chart`, drawn in three dimensions
|
|
17
17
|
- `Donut Chart`
|
|
18
18
|
- `Heatmap`
|
|
19
|
-
- `Spatial Heatmap
|
|
19
|
+
- `Spatial Heatmap`, drawn in three dimensions
|
|
20
20
|
- `Sparkline`
|
|
21
21
|
- `Trend`
|
|
22
22
|
- `Legend`, which all of the charts share
|
|
@@ -40,20 +40,14 @@ Choose a chart by the question it answers.
|
|
|
40
40
|
overlaps the series, and `Area Chart` adds them.
|
|
41
41
|
- **Parts of one whole, at one moment.** `Donut Chart`.
|
|
42
42
|
- **Whether two measures relate.** `Scatter Chart`, with one point per row.
|
|
43
|
-
- **Where rows fall on three measures, and which gather together.** `
|
|
44
|
-
|
|
45
|
-
three dimensions, such as clusters or embeddings. Its table and its
|
|
46
|
-
|
|
47
|
-
- **How one measure rises and falls over two others.** `Spatial Surface Chart`,
|
|
48
|
-
row per place on a grid, drawn as a surface you can turn. Use it for
|
|
49
|
-
over two ranges, such as load by hour and by day. Its table carries
|
|
50
|
-
values.
|
|
51
|
-
|
|
52
|
-
The spatial charts and `Spatial Heatmap` draw themselves in 3D in SVG, which a
|
|
53
|
-
server, a print, and a page without WebGL all show. Shift with an arrow turns
|
|
54
|
-
the spatial charts' drawing. `@fusion.dev/helix-plot` draws all three with
|
|
55
|
-
three.js instead, lit and in perspective, in a view you can drag round and
|
|
56
|
-
zoom.
|
|
43
|
+
- **Where rows fall on three measures, and which gather together.** `Spatial
|
|
44
|
+
Scatter Chart`, with one point per row in a box you can turn. Use it for data
|
|
45
|
+
that has three dimensions, such as clusters or embeddings. Its table and its
|
|
46
|
+
tooltip carry the exact values.
|
|
47
|
+
- **How one measure rises and falls over two others.** `Spatial Surface Chart`,
|
|
48
|
+
with one row per place on a grid, drawn as a surface you can turn. Use it for
|
|
49
|
+
a measure over two ranges, such as load by hour and by day. Its table carries
|
|
50
|
+
the exact values.
|
|
57
51
|
- **How each day or check went.** `Heatmap`, for uptime, contributions, or
|
|
58
52
|
activity.
|
|
59
53
|
- **The same days, as a relief.** `Spatial Heatmap` reads the same table as
|
|
@@ -65,6 +59,12 @@ zoom.
|
|
|
65
59
|
Use `Trend` to show which way one measurement moved and whether that is good
|
|
66
60
|
news.
|
|
67
61
|
|
|
62
|
+
The three spatial charts draw themselves in 3D in SVG, which a
|
|
63
|
+
print and a page without WebGL show too, and a drag or Shift with an arrow
|
|
64
|
+
turns. `@fusion.dev/helix-plot` can also draw all three with three.js, lit and
|
|
65
|
+
in perspective, in a view you can drag round and zoom. The
|
|
66
|
+
[spatial charts guide](./spatial-charts) covers both.
|
|
67
|
+
|
|
68
68
|
## Charts read their data from a table
|
|
69
69
|
|
|
70
70
|
```html
|
|
@@ -127,8 +127,11 @@ reading a chart is usually read for:
|
|
|
127
127
|
- `Donut Chart`: each slice's share of the whole.
|
|
128
128
|
- `Scatter Chart`: each series' number of points and how strongly the two
|
|
129
129
|
measures relate.
|
|
130
|
+
- `Spatial Scatter Chart`: its three measures and its number of points.
|
|
131
|
+
- `Spatial Surface Chart`: its measures, its number of readings, and the range
|
|
132
|
+
of its heights.
|
|
130
133
|
|
|
131
|
-
`Heatmap`
|
|
134
|
+
`Heatmap` and `Spatial Heatmap` are each an image with that name. `Sparkline` takes a `label` of its own.
|
|
132
135
|
|
|
133
136
|
## Tables that change
|
|
134
137
|
|
|
@@ -184,6 +187,8 @@ These parts change direction:
|
|
|
184
187
|
right
|
|
185
188
|
- `Line Chart`, `Area Chart`, and `Sparkline`, with their end marks
|
|
186
189
|
- `Heatmap`'s weeks, which were already a grid laid out along the line
|
|
190
|
+
- `Spatial Heatmap`'s weeks in its SVG drawing. A three.js drawing keeps its
|
|
191
|
+
direction, and the chart's labels follow it.
|
|
187
192
|
- A half `Donut Chart`, which is read across
|
|
188
193
|
|
|
189
194
|
These parts keep their direction:
|
|
@@ -197,6 +202,9 @@ These parts keep their direction:
|
|
|
197
202
|
number line runs that way in every script. Its axis names read in their own
|
|
198
203
|
direction, so a name in Arabic reads right to left under the far end of the
|
|
199
204
|
plot. Its summary and tooltip follow the page's direction.
|
|
205
|
+
- `Spatial Scatter Chart` and `Spatial Surface Chart` are laid out as on a
|
|
206
|
+
left-to-right page, because all three of their axes are measures. Their
|
|
207
|
+
summaries and tooltips follow the page's direction.
|
|
200
208
|
|
|
201
209
|
To keep a chart left to right on a right-to-left page, such as a number line in
|
|
202
210
|
a mathematics text, set `dir="ltr"` on the chart element. You need nothing else.
|
package/content/introduction.mdx
CHANGED
|
@@ -64,6 +64,7 @@ each framework.
|
|
|
64
64
|
| `@fusion.dev/helix-icons` | You are drawing an icon outside a component |
|
|
65
65
|
| `@fusion.dev/helix-map` | You are drawing a map with MapLibre, Leaflet, or a renderer of your own. See [Maps](./maps) |
|
|
66
66
|
| `@fusion.dev/helix-graph` | You are drawing a graph with Sigma.js, cosmos.gl, three.js, or a renderer of your own. See [Graphs](./graphs) |
|
|
67
|
+
| `@fusion.dev/helix-plot` | You are drawing a spatial chart with three.js. See [Spatial charts](./spatial-charts) |
|
|
67
68
|
| `@fusion.dev/helix-core` | You are building a new Helix component |
|
|
68
69
|
|
|
69
70
|
React uses the elements directly. Helix ships a `jsx.d.ts` that types every
|