@motionscript/charts 0.1.0 → 0.1.1-alpha.1

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.
Files changed (215) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +98 -28
  3. package/dist/bar-chart/bar-chart.d.ts +242 -119
  4. package/dist/bar-chart/bar-chart.d.ts.map +1 -1
  5. package/dist/bar-chart/bar-chart.js +231 -260
  6. package/dist/bar-chart/bar-chart.js.map +1 -1
  7. package/dist/bar-chart/category-axis.d.ts +16 -38
  8. package/dist/bar-chart/category-axis.d.ts.map +1 -1
  9. package/dist/bar-chart/category-axis.js +59 -68
  10. package/dist/bar-chart/category-axis.js.map +1 -1
  11. package/dist/bar-chart/chart-bars.d.ts +60 -91
  12. package/dist/bar-chart/chart-bars.d.ts.map +1 -1
  13. package/dist/bar-chart/chart-bars.js +88 -125
  14. package/dist/bar-chart/chart-bars.js.map +1 -1
  15. package/dist/bar-chart/index.d.ts +5 -13
  16. package/dist/bar-chart/index.d.ts.map +1 -1
  17. package/dist/bar-chart/index.js +2 -9
  18. package/dist/bar-chart/index.js.map +1 -1
  19. package/dist/bar-chart/shared.d.ts +40 -132
  20. package/dist/bar-chart/shared.d.ts.map +1 -1
  21. package/dist/bar-chart/shared.js +70 -158
  22. package/dist/bar-chart/shared.js.map +1 -1
  23. package/dist/browser/chunks/chunk-R3Q5EE6E.js +2 -0
  24. package/dist/browser/chunks/chunk-R3Q5EE6E.js.map +7 -0
  25. package/dist/browser/index.js +1 -1
  26. package/dist/browser/index.js.map +4 -4
  27. package/dist/browser/kit.js +1 -1
  28. package/dist/browser/manifest.json +1 -1
  29. package/dist/engine.d.ts +8 -17
  30. package/dist/engine.d.ts.map +1 -1
  31. package/dist/engine.js +8 -17
  32. package/dist/engine.js.map +1 -1
  33. package/dist/index.d.ts +2 -0
  34. package/dist/index.d.ts.map +1 -1
  35. package/dist/index.js +2 -0
  36. package/dist/index.js.map +1 -1
  37. package/dist/kit/cartesian.d.ts +49 -35
  38. package/dist/kit/cartesian.d.ts.map +1 -1
  39. package/dist/kit/cartesian.js +80 -42
  40. package/dist/kit/cartesian.js.map +1 -1
  41. package/dist/kit/chart-canvas.d.ts +37 -40
  42. package/dist/kit/chart-canvas.d.ts.map +1 -1
  43. package/dist/kit/chart-canvas.js +53 -47
  44. package/dist/kit/chart-canvas.js.map +1 -1
  45. package/dist/kit/chart-legend.d.ts +16 -59
  46. package/dist/kit/chart-legend.d.ts.map +1 -1
  47. package/dist/kit/chart-legend.js +38 -76
  48. package/dist/kit/chart-legend.js.map +1 -1
  49. package/dist/kit/entries.d.ts +2 -0
  50. package/dist/kit/entries.d.ts.map +1 -1
  51. package/dist/kit/entries.js +2 -0
  52. package/dist/kit/entries.js.map +1 -1
  53. package/dist/kit/horizontal-axis.d.ts +77 -0
  54. package/dist/kit/horizontal-axis.d.ts.map +1 -0
  55. package/dist/kit/horizontal-axis.js +99 -0
  56. package/dist/kit/horizontal-axis.js.map +1 -0
  57. package/dist/kit/motion.d.ts +16 -3
  58. package/dist/kit/motion.d.ts.map +1 -1
  59. package/dist/kit/motion.js +15 -1
  60. package/dist/kit/motion.js.map +1 -1
  61. package/dist/{pie-chart → kit}/pie-legend.d.ts +14 -29
  62. package/dist/kit/pie-legend.d.ts.map +1 -0
  63. package/dist/kit/pie-legend.js +93 -0
  64. package/dist/kit/pie-legend.js.map +1 -0
  65. package/dist/kit/polar.d.ts +31 -0
  66. package/dist/kit/polar.d.ts.map +1 -0
  67. package/dist/kit/polar.js +33 -0
  68. package/dist/kit/polar.js.map +1 -0
  69. package/dist/kit/shared.d.ts +60 -214
  70. package/dist/kit/shared.d.ts.map +1 -1
  71. package/dist/kit/shared.js +91 -291
  72. package/dist/kit/shared.js.map +1 -1
  73. package/dist/kit/style.d.ts +254 -0
  74. package/dist/kit/style.d.ts.map +1 -0
  75. package/dist/kit/style.js +197 -0
  76. package/dist/kit/style.js.map +1 -0
  77. package/dist/kit/vertical-axis.d.ts +36 -45
  78. package/dist/kit/vertical-axis.d.ts.map +1 -1
  79. package/dist/kit/vertical-axis.js +69 -81
  80. package/dist/kit/vertical-axis.js.map +1 -1
  81. package/dist/line-chart/chart-line.d.ts +107 -40
  82. package/dist/line-chart/chart-line.d.ts.map +1 -1
  83. package/dist/line-chart/chart-line.js +172 -89
  84. package/dist/line-chart/chart-line.js.map +1 -1
  85. package/dist/line-chart/chart-region.d.ts +14 -27
  86. package/dist/line-chart/chart-region.d.ts.map +1 -1
  87. package/dist/line-chart/chart-region.js +13 -28
  88. package/dist/line-chart/chart-region.js.map +1 -1
  89. package/dist/line-chart/index.d.ts +5 -18
  90. package/dist/line-chart/index.d.ts.map +1 -1
  91. package/dist/line-chart/index.js +3 -16
  92. package/dist/line-chart/index.js.map +1 -1
  93. package/dist/line-chart/line-chart.d.ts +272 -119
  94. package/dist/line-chart/line-chart.d.ts.map +1 -1
  95. package/dist/line-chart/line-chart.js +309 -257
  96. package/dist/line-chart/line-chart.js.map +1 -1
  97. package/dist/line-chart/shared.d.ts +73 -130
  98. package/dist/line-chart/shared.d.ts.map +1 -1
  99. package/dist/line-chart/shared.js +195 -156
  100. package/dist/line-chart/shared.js.map +1 -1
  101. package/dist/line-chart/x-scale.d.ts +16 -55
  102. package/dist/line-chart/x-scale.d.ts.map +1 -1
  103. package/dist/line-chart/x-scale.js +44 -111
  104. package/dist/line-chart/x-scale.js.map +1 -1
  105. package/dist/nodes.d.ts +3 -13
  106. package/dist/nodes.d.ts.map +1 -1
  107. package/dist/nodes.js +9 -13
  108. package/dist/nodes.js.map +1 -1
  109. package/dist/pie-chart/index.d.ts +3 -15
  110. package/dist/pie-chart/index.d.ts.map +1 -1
  111. package/dist/pie-chart/index.js +1 -11
  112. package/dist/pie-chart/index.js.map +1 -1
  113. package/dist/pie-chart/pie-chart.d.ts +147 -85
  114. package/dist/pie-chart/pie-chart.d.ts.map +1 -1
  115. package/dist/pie-chart/pie-chart.js +65 -86
  116. package/dist/pie-chart/pie-chart.js.map +1 -1
  117. package/dist/pie-chart/pie-ring.d.ts +65 -196
  118. package/dist/pie-chart/pie-ring.d.ts.map +1 -1
  119. package/dist/pie-chart/pie-ring.js +154 -292
  120. package/dist/pie-chart/pie-ring.js.map +1 -1
  121. package/dist/pie-chart/shared.d.ts +78 -172
  122. package/dist/pie-chart/shared.d.ts.map +1 -1
  123. package/dist/pie-chart/shared.js +54 -177
  124. package/dist/pie-chart/shared.js.map +1 -1
  125. package/dist/radar-chart/index.d.ts +5 -0
  126. package/dist/radar-chart/index.d.ts.map +1 -0
  127. package/dist/radar-chart/index.js +5 -0
  128. package/dist/radar-chart/index.js.map +1 -0
  129. package/dist/radar-chart/radar-chart.d.ts +218 -0
  130. package/dist/radar-chart/radar-chart.d.ts.map +1 -0
  131. package/dist/radar-chart/radar-chart.js +224 -0
  132. package/dist/radar-chart/radar-chart.js.map +1 -0
  133. package/dist/radar-chart/radar-grid.d.ts +43 -0
  134. package/dist/radar-chart/radar-grid.d.ts.map +1 -0
  135. package/dist/radar-chart/radar-grid.js +61 -0
  136. package/dist/radar-chart/radar-grid.js.map +1 -0
  137. package/dist/radar-chart/radar-series.d.ts +59 -0
  138. package/dist/radar-chart/radar-series.d.ts.map +1 -0
  139. package/dist/radar-chart/radar-series.js +71 -0
  140. package/dist/radar-chart/radar-series.js.map +1 -0
  141. package/dist/radar-chart/shared.d.ts +73 -0
  142. package/dist/radar-chart/shared.d.ts.map +1 -0
  143. package/dist/radar-chart/shared.js +123 -0
  144. package/dist/radar-chart/shared.js.map +1 -0
  145. package/dist/radial-chart/index.d.ts +6 -0
  146. package/dist/radial-chart/index.d.ts.map +1 -0
  147. package/dist/radial-chart/index.js +4 -0
  148. package/dist/radial-chart/index.js.map +1 -0
  149. package/dist/radial-chart/radial-chart.d.ts +216 -0
  150. package/dist/radial-chart/radial-chart.d.ts.map +1 -0
  151. package/dist/radial-chart/radial-chart.js +174 -0
  152. package/dist/radial-chart/radial-chart.js.map +1 -0
  153. package/dist/radial-chart/radial-rings.d.ts +121 -0
  154. package/dist/radial-chart/radial-rings.d.ts.map +1 -0
  155. package/dist/radial-chart/radial-rings.js +273 -0
  156. package/dist/radial-chart/radial-rings.js.map +1 -0
  157. package/dist/radial-chart/shared.d.ts +73 -0
  158. package/dist/radial-chart/shared.d.ts.map +1 -0
  159. package/dist/radial-chart/shared.js +79 -0
  160. package/dist/radial-chart/shared.js.map +1 -0
  161. package/package.json +4 -4
  162. package/registry.json +21 -6
  163. package/src/bar-chart/bar-chart.ts +274 -315
  164. package/src/bar-chart/category-axis.ts +53 -88
  165. package/src/bar-chart/chart-bars.ts +108 -205
  166. package/src/bar-chart/index.ts +8 -19
  167. package/src/bar-chart/shared.ts +81 -309
  168. package/src/engine.ts +8 -17
  169. package/src/index.ts +2 -0
  170. package/src/kit/cartesian.ts +118 -55
  171. package/src/kit/chart-canvas.ts +50 -80
  172. package/src/kit/chart-legend.ts +36 -97
  173. package/src/kit/entries.ts +4 -1
  174. package/src/kit/horizontal-axis.ts +114 -0
  175. package/src/kit/motion.ts +18 -2
  176. package/src/{pie-chart → kit}/pie-legend.ts +25 -65
  177. package/src/kit/polar.ts +54 -0
  178. package/src/kit/shared.ts +104 -487
  179. package/src/kit/style.ts +257 -0
  180. package/src/kit/vertical-axis.ts +81 -115
  181. package/src/line-chart/chart-line.ts +185 -91
  182. package/src/line-chart/chart-region.ts +14 -31
  183. package/src/line-chart/index.ts +14 -22
  184. package/src/line-chart/line-chart.ts +377 -315
  185. package/src/line-chart/shared.ts +229 -304
  186. package/src/line-chart/x-scale.ts +44 -121
  187. package/src/nodes.ts +9 -13
  188. package/src/pie-chart/index.ts +3 -35
  189. package/src/pie-chart/pie-chart.ts +83 -134
  190. package/src/pie-chart/pie-ring.ts +162 -368
  191. package/src/pie-chart/shared.ts +92 -379
  192. package/src/radar-chart/index.ts +4 -0
  193. package/src/radar-chart/radar-chart.ts +287 -0
  194. package/src/radar-chart/radar-grid.ts +78 -0
  195. package/src/radar-chart/radar-series.ts +88 -0
  196. package/src/radar-chart/shared.ts +146 -0
  197. package/src/radial-chart/index.ts +5 -0
  198. package/src/radial-chart/radial-chart.ts +210 -0
  199. package/src/radial-chart/radial-rings.ts +328 -0
  200. package/src/radial-chart/shared.ts +114 -0
  201. package/dist/browser/chunks/chunk-TJNHLQGV.js +0 -2
  202. package/dist/browser/chunks/chunk-TJNHLQGV.js.map +0 -7
  203. package/dist/kit/chart-border.d.ts +0 -27
  204. package/dist/kit/chart-border.d.ts.map +0 -1
  205. package/dist/kit/chart-border.js +0 -28
  206. package/dist/kit/chart-border.js.map +0 -1
  207. package/dist/line-chart/horizontal-axis.d.ts +0 -79
  208. package/dist/line-chart/horizontal-axis.d.ts.map +0 -1
  209. package/dist/line-chart/horizontal-axis.js +0 -129
  210. package/dist/line-chart/horizontal-axis.js.map +0 -1
  211. package/dist/pie-chart/pie-legend.d.ts.map +0 -1
  212. package/dist/pie-chart/pie-legend.js +0 -117
  213. package/dist/pie-chart/pie-legend.js.map +0 -1
  214. package/src/kit/chart-border.ts +0 -50
  215. package/src/line-chart/horizontal-axis.ts +0 -151
package/src/kit/shared.ts CHANGED
@@ -1,110 +1,64 @@
1
1
  /**
2
- * The vocabulary every chart node shares: what a *series* is, how an axis is
3
- * scaled and formatted, and the theme leaves each chart's own theme is assembled
4
- * from.
2
+ * What every chart shares: series, axis scaling and formatting, and the theme
3
+ * leaves each chart's theme is assembled from. No `Node` imports, so a host's
4
+ * inspector mappings can build a partial theme without the components.
5
5
  *
6
- * This module exists because the three chart types are three ways of drawing the
7
- * same table. A line chart, a bar chart and a pie chart disagree about almost
8
- * everything visible — polylines against columns against wedges — and agree
9
- * about almost everything underneath: a series is a column with a caption and a
10
- * paint, a marker is a number formatted one way, a legend is a swatch beside a
11
- * label, and a theme is a tree of paints with one mapper and one tween. Writing
12
- * that three times would mean three answers to "how does a chart round its axis"
13
- * within one app.
14
- *
15
- * Kept renderer-agnostic (no `Node` imports) so a host's own inspector
16
- * mappings can build a partial theme without pulling the components in.
17
- *
18
- * **Two conventions run through every resolver and lerp below**, inherited from
19
- * the shape system's `resolveStroke`/`resolveShadow`:
20
- *
21
- * - A **mapper** merges the author's loose, partial input onto a `previous`
22
- * resolved value and resolves every leaf, so the tween always has resolved
23
- * data to interpolate. It is idempotent.
24
- * - A **tween** interpolates two resolved values leaf by leaf. Categorical
25
- * fields (`fontFamily`, `textAlign`) and fields that are `undefined` on either
26
- * side **step at the midpoint**, because there is no meaningful in-between and
27
- * defaulting the missing side to 0 would animate a font weight down to nothing
28
- * on the way to "unset".
6
+ * A mapper merges partial input onto a `previous` resolved value (idempotent). A
7
+ * tween interpolates two resolved values leaf by leaf, but categorical fields
8
+ * (`fontFamily`, `textAlign`) and any field `undefined` on either side step at
9
+ * the midpoint: defaulting the missing side to 0 would animate a font weight
10
+ * down to nothing on the way to "unset".
29
11
  */
30
12
 
31
13
  import {
32
- fillOps,
33
14
  lerpNumber,
34
- shadowOps,
35
- strokeOps,
36
- insetsOps,
37
- textOps,
38
15
  type DataRecord,
39
16
  type Fill,
40
- type FillResolved,
41
17
  type Insets,
42
- type InsetsResolved,
43
18
  type Shadow,
44
- type ShadowResolved,
45
19
  type Stroke,
46
- type StrokeResolved,
47
20
  type TextStyle,
48
21
  } from "@motionscript/sdk"
22
+ import { niceStep } from "@motionscript/sdk/component"
49
23
 
50
- /**
51
- * One series of a chart: a column of the table, captioned and painted.
52
- *
53
- * `field` names the column carrying this series' values. What that becomes is
54
- * the chart's business — a traced polyline, a column of bars, a wedge — but the
55
- * three questions asked of it are the same everywhere: which column, what to
56
- * call it, what to paint it, and whether it is currently drawn.
57
- *
58
- * `fill` is an **override**: omit it and the series takes the theme palette's
59
- * entry for its own index, which is what makes a chart nobody has themed come
60
- * out in five distinct colours rather than five identical ones.
61
- */
24
+ /** One series of a chart: a column of the table, captioned and painted. */
62
25
  export interface ChartSeries {
63
26
  /** Key into each data row for this series' value. */
64
27
  field: string
65
- /** Legend caption for this series. */
66
- label: string
67
- /**
68
- * Paint override for this series' mark and its legend swatch. Omit to take
69
- * the theme palette's entry for this series' index.
70
- */
28
+ /** The legend caption; empty or absent shows `field`. */
29
+ label?: string
30
+ /** Overrides the theme palette's entry for this series' index, for its mark and legend swatch. */
71
31
  fill?: Fill
72
- /** Whether the series shows by default. Defaults to `true`. */
32
+ /** Defaults to `true`. */
73
33
  enabled?: boolean
74
34
  }
75
35
 
76
36
  /** A `[min, max]` numeric range in data units. */
77
37
  export type Range = [min: number, max: number]
78
38
 
79
- /**
80
- * One axis's *data* domain — what it shows — as opposed to {@link AxisConfig},
81
- * which is how it's *styled*. Every field is optional: `range`/`ticks` derive
82
- * from the plotted data when omitted, and `label` defaults to `""`.
83
- */
39
+ /** One axis's *data* domain, as opposed to {@link AxisConfig}, which is how it is styled. */
84
40
  export interface AxisDomainConfig {
85
- /** Caption drawn alongside the axis. Pass `""` (the default) to hide it. */
41
+ /** Caption drawn alongside the axis; `""` hides it. */
86
42
  label?: string
87
- /** `[min, max]` of the scale. Derived from the data bounds when omitted. */
43
+ /** Derived from the data bounds when omitted. */
88
44
  range?: Range
89
- /** Tick values (in data units). Derived (five evenly-spaced) when omitted. */
45
+ /** Derived (five evenly spaced) when omitted. */
90
46
  ticks?: number[]
91
47
  /**
92
- * How a tick value is written down — a `number-format` pattern such as
93
- * `#,##0.00` or `$#,##0`.
94
- *
95
- * Here rather than in {@link AxisConfig} because it is a statement about the
96
- * *numbers*, not about the ink they are set in: `$` on a revenue axis says
97
- * what the column holds, and it has to survive a re-theme. It sits beside
98
- * `range` and `ticks` for the same reason those do.
48
+ * A `number-format` pattern such as `#,##0.00` or `$#,##0`. It lives here, not
49
+ * in {@link AxisConfig}, because it says what the column holds and has to
50
+ * survive a re-theme.
99
51
  */
100
52
  format?: string
101
53
  }
102
54
 
55
+ /** An {@link AxisDomainConfig} with `range` and `ticks` worked out. */
56
+ export type ResolvedAxisDomain = AxisDomainConfig & { readonly range: Range; readonly ticks: number[] }
57
+
103
58
  /**
104
- * An axis domain entry's resolve: merges the author's partial input onto
105
- * `previous`, so a later partial `.set({ yAxis: {...} })` patches
106
- * `label`/`range`/`ticks` independently. `range`/`ticks` staying `undefined`
107
- * after the merge is the auto-derive signal the scale getters read.
59
+ * Merges partial input onto `previous`, so a later `.set({ yAxis: {...} })`
60
+ * patches `label`/`range`/`ticks` independently. An unset `range`/`ticks` is the
61
+ * auto-derive signal.
108
62
  */
109
63
  export function resolveAxisDomain(
110
64
  domain: AxisDomainConfig | undefined,
@@ -119,10 +73,9 @@ export function resolveAxisDomain(
119
73
  }
120
74
 
121
75
  /**
122
- * An axis domain entry's lerp: interpolates `range`/`ticks` numerically
123
- * (pairwise by index for `ticks`), so a `to` command that restates a range
124
- * rescales the plot smoothly. `label`, and either field when one side is in
125
- * auto-derive mode, step at the midpoint.
76
+ * Interpolates `range` and `ticks` numerically (ticks pairwise by index).
77
+ * `label`, `format`, and either field when one side is auto, step at the
78
+ * midpoint: there is no halfway between `$#,##0` and `0.0%`.
126
79
  */
127
80
  export function lerpAxisDomain(
128
81
  from: AxisDomainConfig,
@@ -133,8 +86,6 @@ export function lerpAxisDomain(
133
86
  label: t < 0.5 ? from.label : to.label,
134
87
  range: lerpOptionalRange(from.range, to.range, t),
135
88
  ticks: lerpOptionalTicks(from.ticks, to.ticks, t),
136
- // Steps at the midpoint with the caption, for the same reason: there is no
137
- // halfway between `$#,##0` and `0.0%`.
138
89
  format: t < 0.5 ? from.format : to.format,
139
90
  }
140
91
  }
@@ -162,32 +113,6 @@ function lerpOptionalTicks(
162
113
  return out
163
114
  }
164
115
 
165
- /**
166
- * Where a generic `to()` of an axis domain should land, given the domain as it
167
- * is *drawn* (`drawn`, with `range` and `ticks` resolved off the data), or
168
- * `undefined` when the request states neither a `range` nor `ticks` and the
169
- * plain property tween will do.
170
- *
171
- * The stored domain of an auto axis has no `range` and no `ticks`, and
172
- * {@link lerpAxisDomain} steps an unset side at the midpoint, so tweening the
173
- * stored value from an auto axis is a cut. The charts therefore tween between
174
- * resolved domains, as their zoom does; this builds the destination. A `range`
175
- * given without `ticks` keeps the tick *count* the axis already draws, so each
176
- * marker slides from its old value to its new one instead of the row popping.
177
- */
178
- export function axisTweenTarget(
179
- drawn: AxisDomainConfig,
180
- requested: AxisDomainConfig | undefined
181
- ): AxisDomainConfig | undefined {
182
- if (requested?.range === undefined && requested?.ticks === undefined) return undefined
183
- const target = resolveAxisDomain(requested, drawn)
184
- if (requested.ticks === undefined && requested.range !== undefined) {
185
- const count = Math.max(2, drawn.ticks?.length ?? 2)
186
- target.ticks = markerValues(requested.range, count - 1)
187
- }
188
- return target
189
- }
190
-
191
116
  /**
192
117
  * An axis domain part-way through a tween that leaves or reaches a `range` or
193
118
  * `ticks` left to the data: both ends as stored, and how far along. Only the
@@ -204,12 +129,11 @@ function blendOf(domain: AxisDomainConfig): AxisDomainBlend["blend"] | undefined
204
129
  }
205
130
 
206
131
  /**
207
- * A chart's axis entry tween: what `to({ yAxis: { range } })` moves through.
208
- * Between two explicit domains it is {@link lerpAxisDomain}, and a restated
209
- * `range` without `ticks` spreads explicit ticks across it, keeping their count.
210
- * When either end leaves `range` or `ticks` to the data, the value between is an
211
- * {@link AxisDomainBlend}, which the chart draws as the blend of what each end
212
- * draws: a rescale from an auto axis is continuous, not a cut at the midpoint.
132
+ * The axis entry tween behind `to({ yAxis: { range } })`. Between explicit
133
+ * domains it is {@link lerpAxisDomain}, and a restated `range` without `ticks`
134
+ * spreads ticks across it, keeping their count. When either end leaves `range`
135
+ * or `ticks` to the data, the value between is an {@link AxisDomainBlend}, so a
136
+ * rescale from an auto axis is continuous rather than a cut at the midpoint.
213
137
  */
214
138
  export function lerpAxisEntry(from: AxisDomainConfig, to: AxisDomainConfig, t: number): AxisDomainConfig {
215
139
  // The mapper merged the request onto `from`, so a field it left unstated is `from`'s own, by identity.
@@ -227,62 +151,30 @@ export function lerpAxisEntry(from: AxisDomainConfig, to: AxisDomainConfig, t: n
227
151
  return blend
228
152
  }
229
153
 
230
- /**
231
- * `domain` as the chart draws it: `drawn` resolves a plain domain's auto `range`
232
- * and `ticks` off the data, and a blend is the lerp of what its two ends draw.
233
- */
154
+ /** `domain` as drawn: `drawn` resolves a plain domain's auto `range` and `ticks`; a blend is the lerp of what its ends draw. */
234
155
  export function settleAxisDomain(domain: AxisDomainConfig, drawn: (domain: AxisDomainConfig) => AxisDomainConfig): AxisDomainConfig {
235
156
  const blend = blendOf(domain)
236
157
  if (!blend) return drawn(domain)
237
158
  return lerpAxisDomain(settleAxisDomain(blend.from, drawn), settleAxisDomain(blend.to, drawn), blend.t)
238
159
  }
239
160
 
240
- /**
241
- * The low-level colour tokens the default themes are built from — a dark plot
242
- * panel with warm-grey axis furniture.
243
- */
244
- export const CHART_PALETTE = {
245
- /** Fill of the plot panel behind the marks. */
161
+ /** The colour tokens the default themes are built from: a dark plot panel with warm-grey axis furniture. */
162
+ const CHART_PALETTE = {
246
163
  plotFill: "#15130e",
247
- /** Colour of the plot's thick border. */
248
164
  borderColor: "#4a4036",
249
- /** Colour of the faint grid lines spanning the plot. */
250
165
  gridColor: "#2c2820",
251
- /** Colour of the numeric axis markers, axis captions, and legend labels. */
166
+ /** Axis markers, axis captions and legend labels. */
252
167
  markerColor: "#8a7f70",
253
- /** Colour of a spotlit region's dashed rules and its wash. */
168
+ /** A spotlit region's dashed rules and wash. */
254
169
  regionColor: "#d99a3a",
255
170
  } as const
256
171
 
257
- /** The out-of-the-box series palette, cycled by series index. */
258
- export const DEFAULT_SERIES_COLORS = [
259
- "#d9603b",
260
- "#8194ad",
261
- "#e0a93b",
262
- "#5e9d6b",
263
- "#9ec85a",
264
- ] as const
265
-
266
- /**
267
- * Opacity an *un*-spotlighted series fades to — its mark and its legend entry
268
- * alike, so the two dim together.
269
- */
172
+ /** Opacity an un-spotlighted series fades to, mark and legend entry alike. */
270
173
  export const SPOTLIGHT_DIM = 0.2
271
174
 
272
- /** Clamp a number into `[0, 1]` — the range every reveal signal here runs in. */
273
- export function clampUnit(value: number): number {
274
- return value < 0 ? 0 : value > 1 ? 1 : value
275
- }
276
-
277
- // ---- Row readers ---------------------------------------------------------
278
-
279
175
  /**
280
- * Read a numeric field off a row, defaulting missing, non-numeric and non-finite
281
- * values to 0.
282
- *
283
- * A column left as strings silently plots as 0, which is why the CSV parser's
284
- * numeric auto-coercion matters — a quoted or unit-suffixed column won't plot
285
- * until it's coerced.
176
+ * Reads a numeric field off a row. A string column plots as 0, so a quoted or
177
+ * unit-suffixed column needs the CSV parser's numeric coercion first.
286
178
  */
287
179
  export function num(row: DataRecord, field: string | undefined): number {
288
180
  if (field === undefined) return 0
@@ -292,12 +184,7 @@ export function num(row: DataRecord, field: string | undefined): number {
292
184
  return typeof v === "number" && Number.isFinite(v) ? v : 0
293
185
  }
294
186
 
295
- /**
296
- * Read a field off a row as its caption — the counterpart to {@link num} for
297
- * the columns a chart *names* things by rather than measures them by (a bar's
298
- * category, a wedge's slice). A missing cell reads as empty rather than as the
299
- * string `"undefined"`.
300
- */
187
+ /** The counterpart to {@link num} for the columns a chart names things by; a missing cell reads as empty, not `"undefined"`. */
301
188
  export function text(row: DataRecord, field: string | undefined): string {
302
189
  if (field === undefined || field === "") return ""
303
190
  const v = row[field]
@@ -305,13 +192,9 @@ export function text(row: DataRecord, field: string | undefined): string {
305
192
  }
306
193
 
307
194
  /**
308
- * Every column that holds numbers across `data`, in header order, skipping the
309
- * names in `exclude` (typically the category column).
310
- *
311
- * A column counts as numeric only if every non-empty cell in it is a number, so
312
- * a stray text cell leaves the column out rather than plotting zeros. This is
313
- * what lets a chart plot "every other column" without the author naming twenty
314
- * fields.
195
+ * Every numeric column of `data` in header order, skipping `exclude`. A column
196
+ * is numeric only if every non-empty cell is a number, so a stray text cell
197
+ * drops the column rather than plotting zeros.
315
198
  */
316
199
  export function numericFields(
317
200
  data: DataRecord[],
@@ -340,29 +223,20 @@ export function numericFields(
340
223
  })
341
224
  }
342
225
 
343
- // ---- Theme branches ------------------------------------------------------
344
-
345
226
  /** One axis's (x or y) style vocabulary. */
346
227
  export interface AxisConfig {
347
228
  /** Style of each marker along the axis. */
348
229
  labelStyle: TextStyle
349
- /** Style of the axis caption. */
350
230
  titleStyle: TextStyle
351
- /**
352
- * This axis's direction of the plot's internal grid — weight+fill honoured,
353
- * dash/cap/join ignored (grid lines are drawn as filled rects).
354
- */
231
+ /** This axis's grid lines: weight and fill honoured, dash/cap/join ignored (they are filled rects). */
355
232
  lineStyle: Stroke
356
- /**
357
- * Gap between the plot and the marker row. Only the side facing the plot is
358
- * read — `.top` for a horizontal axis, `.right` for a vertical one.
359
- */
233
+ /** Gap between the plot and the marker row; only the side facing the plot is read (`.top` horizontal, `.right` vertical). */
360
234
  tickPadding: Insets
361
235
  /** Gap between the marker row and the caption, read the same side. */
362
236
  titlePadding: Insets
363
237
  }
364
238
 
365
- /** A legend's per-series colour swatch — a rounded chip, not the caption. */
239
+ /** A legend's per-series colour swatch. */
366
240
  export interface LegendMarkerConfig {
367
241
  width: number
368
242
  height: number
@@ -371,23 +245,14 @@ export interface LegendMarkerConfig {
371
245
  shadow: Shadow
372
246
  }
373
247
 
374
- /** A legend's visual theme. */
375
248
  export interface LegendConfig {
376
249
  padding: Insets
377
- /** Caption style — only the swatch carries the series colour. */
250
+ /** Only the swatch carries the series colour. */
378
251
  textStyle: TextStyle
379
- /** Gap between legend entries. */
380
252
  itemGap: number
381
253
  markerStyle: LegendMarkerConfig
382
254
  }
383
255
 
384
- /** The plot panel a cartesian chart draws its marks over. */
385
- export interface PlotAreaConfig {
386
- stroke: Stroke
387
- fill: Fill
388
- shadow: Shadow
389
- }
390
-
391
256
  const AXIS_LABEL_STYLE: TextStyle = {
392
257
  fontSize: 24,
393
258
  fontWeight: 700,
@@ -402,7 +267,6 @@ const AXIS_TITLE_STYLE: TextStyle = {
402
267
  }
403
268
  const AXIS_LINE_STYLE: Stroke = { weight: 2, fill: CHART_PALETTE.gridColor }
404
269
 
405
- /** The default styling of a horizontal (marker row beneath the plot) axis. */
406
270
  export const DEFAULT_X_AXIS: AxisConfig = {
407
271
  labelStyle: AXIS_LABEL_STYLE,
408
272
  titleStyle: AXIS_TITLE_STYLE,
@@ -411,7 +275,6 @@ export const DEFAULT_X_AXIS: AxisConfig = {
411
275
  titlePadding: 4,
412
276
  }
413
277
 
414
- /** The default styling of a vertical (marker column beside the plot) axis. */
415
278
  export const DEFAULT_Y_AXIS: AxisConfig = {
416
279
  labelStyle: { ...AXIS_LABEL_STYLE, fontWeight: 500, textAlign: "right" },
417
280
  titleStyle: AXIS_TITLE_STYLE,
@@ -420,18 +283,6 @@ export const DEFAULT_Y_AXIS: AxisConfig = {
420
283
  titlePadding: 24,
421
284
  }
422
285
 
423
- /**
424
- * The default plot panel: **unpainted**, framed. A chart reads against the
425
- * stage rather than punching a panel into it, which is the look the family was
426
- * designed at.
427
- */
428
- export const DEFAULT_PLOT_AREA: PlotAreaConfig = {
429
- fill: [],
430
- stroke: { weight: 6, fill: CHART_PALETTE.borderColor },
431
- shadow: [],
432
- }
433
-
434
- /** The default legend styling, shared by every chart that draws one. */
435
286
  export const DEFAULT_LEGEND: LegendConfig = {
436
287
  padding: 0,
437
288
  textStyle: {
@@ -450,290 +301,10 @@ export const DEFAULT_LEGEND: LegendConfig = {
450
301
  },
451
302
  }
452
303
 
453
- /** The default per-series stroke palette — {@link DEFAULT_SERIES_COLORS}, drawn 4px. */
454
- export const DEFAULT_SERIES_STROKES: Stroke[] = DEFAULT_SERIES_COLORS.map(
455
- (fill) => ({ weight: 4, fill })
456
- )
457
-
458
- /** The default per-series fill palette — the same colours, as solid paint. */
459
- export const DEFAULT_SERIES_FILLS: Fill[] = DEFAULT_SERIES_COLORS.map(
460
- (fill) => fill
461
- )
462
-
463
- // ---- Theme branch resolvers ----------------------------------------------
464
- // Each chart type assembles its own theme out of these, so "the axis furniture"
465
- // means one thing across the family and each chart still declares only the
466
- // branches it actually draws.
467
-
468
- export function resolveAxisConfig(
469
- axis: Partial<AxisConfig> | undefined,
470
- previous: AxisConfig
471
- ): AxisConfig {
472
- return {
473
- labelStyle: textOps.resolveStyle(axis?.labelStyle, previous.labelStyle),
474
- titleStyle: textOps.resolveStyle(axis?.titleStyle, previous.titleStyle),
475
- lineStyle: strokeOps.resolve(axis?.lineStyle ?? previous.lineStyle),
476
- tickPadding: insetsOps.resolve(
477
- axis?.tickPadding ?? previous.tickPadding,
478
- previous.tickPadding as InsetsResolved
479
- ),
480
- titlePadding: insetsOps.resolve(
481
- axis?.titlePadding ?? previous.titlePadding,
482
- previous.titlePadding as InsetsResolved
483
- ),
484
- }
485
- }
486
-
487
- export function lerpAxisConfig(
488
- from: AxisConfig,
489
- to: AxisConfig,
490
- t: number
491
- ): AxisConfig {
492
- return {
493
- labelStyle: textOps.lerpStyle(from.labelStyle, to.labelStyle, t),
494
- titleStyle: textOps.lerpStyle(from.titleStyle, to.titleStyle, t),
495
- lineStyle: strokeOps.lerp(
496
- from.lineStyle as StrokeResolved[],
497
- to.lineStyle as StrokeResolved[],
498
- t
499
- ),
500
- tickPadding: insetsOps.lerp(
501
- from.tickPadding as InsetsResolved,
502
- to.tickPadding as InsetsResolved,
503
- t
504
- ),
505
- titlePadding: insetsOps.lerp(
506
- from.titlePadding as InsetsResolved,
507
- to.titlePadding as InsetsResolved,
508
- t
509
- ),
510
- }
511
- }
512
-
513
- export function resolvePlotArea(
514
- plotArea: Partial<PlotAreaConfig> | undefined,
515
- previous: PlotAreaConfig
516
- ): PlotAreaConfig {
517
- return {
518
- fill: fillOps.resolve(plotArea?.fill ?? previous.fill),
519
- stroke: strokeOps.resolve(plotArea?.stroke ?? previous.stroke),
520
- shadow: shadowOps.resolve(plotArea?.shadow ?? previous.shadow),
521
- }
522
- }
523
-
524
- export function lerpPlotArea(
525
- from: PlotAreaConfig,
526
- to: PlotAreaConfig,
527
- t: number
528
- ): PlotAreaConfig {
529
- return {
530
- fill: fillOps.lerp(
531
- from.fill as FillResolved[],
532
- to.fill as FillResolved[],
533
- t
534
- ),
535
- stroke: strokeOps.lerp(
536
- from.stroke as StrokeResolved[],
537
- to.stroke as StrokeResolved[],
538
- t
539
- ),
540
- shadow: shadowOps.lerp(
541
- from.shadow as ShadowResolved[],
542
- to.shadow as ShadowResolved[],
543
- t
544
- ),
545
- }
546
- }
547
-
548
- function resolveLegendMarkerConfig(
549
- marker: Partial<LegendMarkerConfig> | undefined,
550
- previous: LegendMarkerConfig
551
- ): LegendMarkerConfig {
552
- return {
553
- width: marker?.width ?? previous.width,
554
- height: marker?.height ?? previous.height,
555
- borderRadius: marker?.borderRadius ?? previous.borderRadius,
556
- stroke: strokeOps.resolve(marker?.stroke ?? previous.stroke),
557
- shadow: shadowOps.resolve(marker?.shadow ?? previous.shadow),
558
- }
559
- }
560
-
561
- function lerpLegendMarkerConfig(
562
- from: LegendMarkerConfig,
563
- to: LegendMarkerConfig,
564
- t: number
565
- ): LegendMarkerConfig {
566
- return {
567
- width: lerpNumber(from.width, to.width, t),
568
- height: lerpNumber(from.height, to.height, t),
569
- borderRadius: lerpNumber(from.borderRadius, to.borderRadius, t),
570
- stroke: strokeOps.lerp(
571
- from.stroke as StrokeResolved[],
572
- to.stroke as StrokeResolved[],
573
- t
574
- ),
575
- shadow: shadowOps.lerp(
576
- from.shadow as ShadowResolved[],
577
- to.shadow as ShadowResolved[],
578
- t
579
- ),
580
- }
581
- }
582
-
583
- /** A legend theme as the author may state it — every branch optional. */
584
- export type LegendTheme = Partial<Omit<LegendConfig, "markerStyle">> & {
585
- markerStyle?: Partial<LegendMarkerConfig>
586
- }
587
-
588
- export function resolveLegendConfig(
589
- legend: LegendTheme | undefined,
590
- previous: LegendConfig
591
- ): LegendConfig {
592
- return {
593
- padding: insetsOps.resolve(
594
- legend?.padding ?? previous.padding,
595
- previous.padding as InsetsResolved
596
- ),
597
- textStyle: textOps.resolveStyle(legend?.textStyle, previous.textStyle),
598
- itemGap: legend?.itemGap ?? previous.itemGap,
599
- markerStyle: resolveLegendMarkerConfig(
600
- legend?.markerStyle,
601
- previous.markerStyle
602
- ),
603
- }
604
- }
605
-
606
- export function lerpLegendConfig(
607
- from: LegendConfig,
608
- to: LegendConfig,
609
- t: number
610
- ): LegendConfig {
611
- return {
612
- padding: insetsOps.lerp(
613
- from.padding as InsetsResolved,
614
- to.padding as InsetsResolved,
615
- t
616
- ),
617
- textStyle: textOps.lerpStyle(from.textStyle, to.textStyle, t),
618
- itemGap: lerpNumber(from.itemGap, to.itemGap, t),
619
- markerStyle: lerpLegendMarkerConfig(from.markerStyle, to.markerStyle, t),
620
- }
621
- }
622
-
623
- /** A whole-palette override replaces the previous palette outright. */
624
- export function resolveSeriesStrokes(
625
- styles: Stroke[] | undefined,
626
- previous: Stroke[]
627
- ): Stroke[] {
628
- return (styles ?? previous).map((s) => strokeOps.resolve(s))
629
- }
630
-
631
- /** Pairwise by index; a palette that grows/shrinks holds the longer side's tail. */
632
- export function lerpSeriesStrokes(
633
- from: Stroke[],
634
- to: Stroke[],
635
- t: number
636
- ): Stroke[] {
637
- const n = Math.max(from.length, to.length)
638
- const out: Stroke[] = []
639
- for (let i = 0; i < n; i++) {
640
- const a = (from[i] ?? to[i]) as StrokeResolved[]
641
- const b = (to[i] ?? from[i]) as StrokeResolved[]
642
- out.push(strokeOps.lerp(a, b, t))
643
- }
644
- return out
645
- }
646
-
647
- /** The fill-palette twin of {@link resolveSeriesStrokes}, for filled marks. */
648
- export function resolveSeriesFills(
649
- fills: Fill[] | undefined,
650
- previous: Fill[]
651
- ): Fill[] {
652
- return (fills ?? previous).map((f) => fillOps.resolve(f))
653
- }
654
-
655
- /** The fill-palette twin of {@link lerpSeriesStrokes}. */
656
- export function lerpSeriesFills(from: Fill[], to: Fill[], t: number): Fill[] {
657
- const n = Math.max(from.length, to.length)
658
- const out: Fill[] = []
659
- for (let i = 0; i < n; i++) {
660
- const a = (from[i] ?? to[i]) as FillResolved[]
661
- const b = (to[i] ?? from[i]) as FillResolved[]
662
- out.push(fillOps.lerp(a, b, t))
663
- }
664
- return out
665
- }
666
-
667
- // ---- Per-series paint ----------------------------------------------------
668
-
669
- /**
670
- * The effective stroke for series `index`: the palette's entry at
671
- * `index % palette.length`, with the series' own `fill`, if set, overriding just
672
- * the last (topmost) layer's colour.
673
- */
674
- export function resolveSeriesStroke(
675
- palette: Stroke[],
676
- series: ChartSeries,
677
- index: number
678
- ): Stroke {
679
- const entry: Stroke =
680
- palette.length > 0
681
- ? palette[index % palette.length]
682
- : { weight: 4, fill: "white" }
683
- if (series.fill == null) return entry
684
- const layers = strokeOps.resolve(entry)
685
- if (layers.length === 0) return { weight: 4, fill: series.fill }
686
- const next = [...layers]
687
- next[next.length - 1] = {
688
- ...next[next.length - 1],
689
- fill: fillOps.resolve(series.fill),
690
- }
691
- return next
692
- }
693
-
694
- /**
695
- * The effective *colour* for series `index` — the same colour
696
- * {@link resolveSeriesStroke} draws its line in — for contexts (a legend
697
- * swatch) that only need the fill.
698
- */
699
- export function resolveSeriesFill(
700
- palette: Stroke[],
701
- series: ChartSeries,
702
- index: number
703
- ): Fill {
704
- const layers = strokeOps.resolve(resolveSeriesStroke(palette, series, index))
705
- return layers[layers.length - 1]?.fill ?? "white"
706
- }
707
-
708
- /**
709
- * The effective paint for mark `index` of a **filled** chart (a bar, a wedge):
710
- * the series' own `fill` when it carries one, else the palette's entry for its
711
- * index, cycled.
712
- *
713
- * The stroke twin above has to reach inside a stroke to swap one layer's colour;
714
- * a filled mark has no such geometry wrapped around its paint, so an override is
715
- * simply the whole answer.
716
- */
717
- export function resolvePalettePaint(
718
- palette: Fill[],
719
- override: Fill | undefined,
720
- index: number
721
- ): Fill {
722
- if (override != null) return override
723
- if (palette.length === 0) return "white"
724
- return palette[index % palette.length]
725
- }
726
-
727
- // ---- Scales and formatting -----------------------------------------------
728
-
729
-
730
304
  /**
731
- * Format a marker value: integers plain, otherwise trimmed to one decimal, or to
732
- * as many as the axis's tick `step` needs to tell neighbouring ticks apart.
733
- *
734
- * One decimal is the floor, so a step of 0.1 or more reads exactly as it always
735
- * has; a finer step (a unit axis ticked every 0.05) gets two, instead of five
736
- * ticks captioned `0.1 0.1 0.2 0.2 0.3`. Trailing zeros are dropped either way.
305
+ * Format a marker value: integers plain, otherwise one decimal, or as many as
306
+ * the tick `step` needs to tell neighbours apart (a unit axis ticked every 0.05
307
+ * gets two, not `0.1 0.1 0.2 0.2 0.3`). Trailing zeros are dropped.
737
308
  */
738
309
  export function formatMarker(value: number, step?: number): string {
739
310
  if (Number.isInteger(value)) return String(value)
@@ -776,7 +347,53 @@ export function markerValues([min, max]: Range, markerCount: number): number[] {
776
347
  return Array.from({ length: n + 1 }, (_, i) => min + ((max - min) / n) * i)
777
348
  }
778
349
 
779
- // Lifted into the engine, because a graph and a diagram want them too — see
780
- // `@motionscript/sdk/component`. Re-exported so a chart, and anything that
781
- // copied one, still reaches them where it always did.
782
- export { niceStep, enterBudget } from "@motionscript/sdk/component"
350
+ /** `[lo, hi]` nudged out to bounds a whole number of tidy steps apart, about `divisions` of them. */
351
+ export function niceRange([lo, hi]: Range, divisions: number): Range {
352
+ const segments = Math.max(1, Math.round(divisions))
353
+ if (hi === lo) return constantScale(lo, segments)
354
+ const step = niceStep((hi - lo) / segments)
355
+ return [Math.floor(lo / step) * step, Math.ceil(hi / step) * step]
356
+ }
357
+
358
+ /**
359
+ * The scale for constant data. A zero-width scale would put every tick on one
360
+ * value and the line on the floor, so it widens by a step sized to the
361
+ * magnitude (`5` gets `[3, 7]`), or `[0, 1]` for zero.
362
+ */
363
+ function constantScale(value: number, segments: number): Range {
364
+ if (value === 0) return [0, 1]
365
+ const step = niceStep(Math.abs(value) / segments)
366
+ return [value - step, value + step]
367
+ }
368
+
369
+ /**
370
+ * Ticks for a range worked out from the data: every multiple of the tidiest
371
+ * step (1, 2 or 5 times a power of ten) that divides it into about `divisions`
372
+ * parts, so zero is a tick whenever the range spans it. A range no such step
373
+ * divides (an author's) is split evenly instead.
374
+ */
375
+ export function niceTicks([lo, hi]: Range, divisions: number): number[] {
376
+ const span = hi - lo
377
+ const target = Math.max(1, Math.round(divisions))
378
+ if (!(span > 0)) return markerValues([lo, hi], target)
379
+ const whole = (v: number) => Math.abs(v - Math.round(v)) < 1e-6
380
+ const base = niceStep(span / target)
381
+ let best: number | undefined
382
+ for (const step of ladder(base)) {
383
+ const parts = span / step
384
+ if (!whole(parts) || !whole(lo / step) || parts < 2 || parts > 8) continue
385
+ if (best === undefined || Math.abs(parts - target) < Math.abs(span / best - target)) best = step
386
+ }
387
+ if (best === undefined) return markerValues([lo, hi], target)
388
+ const first = Math.round(lo / best)
389
+ return Array.from({ length: Math.round(span / best) + 1 }, (_, k) => Number(((first + k) * best).toPrecision(12)))
390
+ }
391
+
392
+ /** `step` and its neighbours on the 1-2-5 ladder, two either side. */
393
+ function ladder(step: number): number[] {
394
+ const mag = 10 ** Math.floor(Math.log10(step))
395
+ const rungs: number[] = []
396
+ for (const m of [mag / 10, mag, mag * 10]) for (const k of [1, 2, 5]) rungs.push(k * m)
397
+ const at = rungs.findIndex((r) => Math.abs(r - step) < step * 1e-9)
398
+ return rungs.slice(Math.max(0, at - 2), at + 3)
399
+ }