@opendata-ai/openchart-engine 8.0.0-rc.8 → 8.0.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.
Files changed (271) hide show
  1. package/dist/index.d.ts +149 -12
  2. package/dist/index.js +894 -171
  3. package/dist/index.js.map +1 -1
  4. package/package.json +3 -4
  5. package/src/__test-fixtures__/specs.ts +0 -182
  6. package/src/__tests__/__snapshots__/compile-snapshot.test.ts.snap +0 -2339
  7. package/src/__tests__/annotation-behavior.test.ts +0 -852
  8. package/src/__tests__/axes.test.ts +0 -1579
  9. package/src/__tests__/compile-animation.test.ts +0 -161
  10. package/src/__tests__/compile-chart.test.ts +0 -1303
  11. package/src/__tests__/compile-footnotes.test.ts +0 -277
  12. package/src/__tests__/compile-layer.test.ts +0 -969
  13. package/src/__tests__/compile-snapshot.test.ts +0 -156
  14. package/src/__tests__/compound-labels.test.ts +0 -147
  15. package/src/__tests__/dimensions.test.ts +0 -918
  16. package/src/__tests__/encoding-sugar.test.ts +0 -390
  17. package/src/__tests__/facet.test.ts +0 -215
  18. package/src/__tests__/helpers/invariants.ts +0 -299
  19. package/src/__tests__/known-bugs.test.ts +0 -566
  20. package/src/__tests__/layout-fuzz.test.ts +0 -358
  21. package/src/__tests__/layout-invariants.test.ts +0 -535
  22. package/src/__tests__/legend.test.ts +0 -721
  23. package/src/__tests__/mark-keys.test.ts +0 -294
  24. package/src/__tests__/ranking-recipes.test.ts +0 -260
  25. package/src/__tests__/rotation.test.ts +0 -83
  26. package/src/__tests__/scales.test.ts +0 -323
  27. package/src/__tests__/series-search.test.ts +0 -92
  28. package/src/__tests__/spec-sugar.test.ts +0 -801
  29. package/src/__tests__/you-draw-it.test.ts +0 -160
  30. package/src/annotations/__tests__/compute.test.ts +0 -1672
  31. package/src/annotations/__tests__/geometry.test.ts +0 -66
  32. package/src/annotations/__tests__/placement-fuzz.test.ts +0 -256
  33. package/src/annotations/__tests__/placement-invariants.test.ts +0 -345
  34. package/src/annotations/__tests__/placement.test.ts +0 -316
  35. package/src/annotations/__tests__/resolve-text.test.ts +0 -788
  36. package/src/annotations/__tests__/rich-text.test.ts +0 -91
  37. package/src/annotations/__tests__/thinning.test.ts +0 -285
  38. package/src/annotations/collisions.ts +0 -326
  39. package/src/annotations/compute.ts +0 -333
  40. package/src/annotations/constants.ts +0 -162
  41. package/src/annotations/geometry.ts +0 -376
  42. package/src/annotations/move.ts +0 -135
  43. package/src/annotations/placement.ts +0 -636
  44. package/src/annotations/position.ts +0 -131
  45. package/src/annotations/resolve-range.ts +0 -117
  46. package/src/annotations/resolve-refline.ts +0 -157
  47. package/src/annotations/resolve-text.ts +0 -545
  48. package/src/annotations/rich-text.ts +0 -65
  49. package/src/annotations/thinning.ts +0 -190
  50. package/src/barlist/__tests__/compile-barlist.test.ts +0 -200
  51. package/src/barlist/compile-barlist.ts +0 -391
  52. package/src/barlist/types.ts +0 -28
  53. package/src/charts/__tests__/post-process.test.ts +0 -237
  54. package/src/charts/__tests__/registry.test.ts +0 -116
  55. package/src/charts/__tests__/utils.test.ts +0 -195
  56. package/src/charts/_shared/__tests__/density-filter.test.ts +0 -32
  57. package/src/charts/_shared/density-filter.ts +0 -26
  58. package/src/charts/_shared/format-label-value.ts +0 -16
  59. package/src/charts/bar/__tests__/compute.test.ts +0 -934
  60. package/src/charts/bar/__tests__/gradient-orient.test.ts +0 -127
  61. package/src/charts/bar/__tests__/labels.test.ts +0 -292
  62. package/src/charts/bar/compute.ts +0 -539
  63. package/src/charts/bar/index.ts +0 -60
  64. package/src/charts/bar/labels.ts +0 -311
  65. package/src/charts/beeswarm/__tests__/compute.test.ts +0 -280
  66. package/src/charts/beeswarm/__tests__/dodge.test.ts +0 -148
  67. package/src/charts/beeswarm/compute.ts +0 -203
  68. package/src/charts/beeswarm/dodge.ts +0 -155
  69. package/src/charts/beeswarm/index.ts +0 -32
  70. package/src/charts/builtin.ts +0 -75
  71. package/src/charts/calendar/__tests__/compute.test.ts +0 -417
  72. package/src/charts/calendar/compute.ts +0 -319
  73. package/src/charts/calendar/index.ts +0 -32
  74. package/src/charts/column/__tests__/compute.test.ts +0 -540
  75. package/src/charts/column/__tests__/labels.test.ts +0 -179
  76. package/src/charts/column/compute.ts +0 -493
  77. package/src/charts/column/index.ts +0 -53
  78. package/src/charts/column/labels.ts +0 -229
  79. package/src/charts/dot/__tests__/compute.test.ts +0 -380
  80. package/src/charts/dot/__tests__/labels.test.ts +0 -98
  81. package/src/charts/dot/compute.ts +0 -285
  82. package/src/charts/dot/index.ts +0 -62
  83. package/src/charts/dot/labels.ts +0 -121
  84. package/src/charts/line/__tests__/compute.test.ts +0 -1194
  85. package/src/charts/line/__tests__/curves.test.ts +0 -51
  86. package/src/charts/line/__tests__/labels.test.ts +0 -94
  87. package/src/charts/line/__tests__/mark-options.test.ts +0 -175
  88. package/src/charts/line/area.ts +0 -484
  89. package/src/charts/line/compute.ts +0 -356
  90. package/src/charts/line/curves.ts +0 -85
  91. package/src/charts/line/index.ts +0 -176
  92. package/src/charts/line/labels.ts +0 -177
  93. package/src/charts/parliament/__tests__/compute.test.ts +0 -411
  94. package/src/charts/parliament/compute.ts +0 -313
  95. package/src/charts/parliament/index.ts +0 -32
  96. package/src/charts/pie/__tests__/compute.test.ts +0 -384
  97. package/src/charts/pie/__tests__/labels.test.ts +0 -132
  98. package/src/charts/pie/compute.ts +0 -324
  99. package/src/charts/pie/index.ts +0 -49
  100. package/src/charts/pie/labels.ts +0 -143
  101. package/src/charts/post-process.ts +0 -229
  102. package/src/charts/range/__tests__/compute.test.ts +0 -486
  103. package/src/charts/range/compute.ts +0 -273
  104. package/src/charts/range/index.ts +0 -82
  105. package/src/charts/range/labels.ts +0 -169
  106. package/src/charts/rect/__tests__/compute.test.ts +0 -120
  107. package/src/charts/rect/index.ts +0 -127
  108. package/src/charts/registry.ts +0 -72
  109. package/src/charts/rule/index.ts +0 -139
  110. package/src/charts/scatter/__tests__/compute.test.ts +0 -488
  111. package/src/charts/scatter/__tests__/trendline.test.ts +0 -191
  112. package/src/charts/scatter/compute.ts +0 -192
  113. package/src/charts/scatter/index.ts +0 -46
  114. package/src/charts/scatter/trendline.ts +0 -100
  115. package/src/charts/text/__tests__/compute.test.ts +0 -307
  116. package/src/charts/text/index.ts +0 -141
  117. package/src/charts/tick/__tests__/compute.test.ts +0 -75
  118. package/src/charts/tick/index.ts +0 -99
  119. package/src/charts/utils.ts +0 -170
  120. package/src/charts/waffle/__tests__/compute.test.ts +0 -305
  121. package/src/charts/waffle/compute.ts +0 -197
  122. package/src/charts/waffle/index.ts +0 -31
  123. package/src/compile/__tests__/color-scale-range.test.ts +0 -158
  124. package/src/compile/__tests__/color-scale-reverse.test.ts +0 -89
  125. package/src/compile/__tests__/data-clip.test.ts +0 -127
  126. package/src/compile/__tests__/fill-patterns.test.ts +0 -154
  127. package/src/compile/__tests__/size-scale.test.ts +0 -108
  128. package/src/compile/__tests__/watermark-obstacle.test.ts +0 -93
  129. package/src/compile/color-scale-range.ts +0 -101
  130. package/src/compile/data-clip.ts +0 -48
  131. package/src/compile/fill-patterns.ts +0 -74
  132. package/src/compile/layer.ts +0 -626
  133. package/src/compile/size-scale.ts +0 -141
  134. package/src/compile/spec-sugar.ts +0 -758
  135. package/src/compile/watermark-obstacle.ts +0 -54
  136. package/src/compile/you-draw-it.ts +0 -123
  137. package/src/compile.ts +0 -1450
  138. package/src/compiler/__tests__/a11y-warnings.test.ts +0 -148
  139. package/src/compiler/__tests__/animation.test.ts +0 -177
  140. package/src/compiler/__tests__/compile.test.ts +0 -87
  141. package/src/compiler/__tests__/fixtures/vl-parity/axis-null.json +0 -19
  142. package/src/compiler/__tests__/fixtures/vl-parity/color-value.json +0 -20
  143. package/src/compiler/__tests__/fixtures/vl-parity/count-aggregate.json +0 -22
  144. package/src/compiler/__tests__/fixtures/vl-parity/data-values.json +0 -19
  145. package/src/compiler/__tests__/fixtures/vl-parity/layer-axis-null.json +0 -14
  146. package/src/compiler/__tests__/fixtures/vl-parity/layer-count.json +0 -34
  147. package/src/compiler/__tests__/fixtures/vl-parity/layer-data-values.json +0 -22
  148. package/src/compiler/__tests__/fixtures/vl-parity/layer-legend-null.json +0 -41
  149. package/src/compiler/__tests__/fixtures/vl-parity/layer-scheme.json +0 -38
  150. package/src/compiler/__tests__/fixtures/vl-parity/layer-sort.json +0 -28
  151. package/src/compiler/__tests__/fixtures/vl-parity/layer-theta.json +0 -28
  152. package/src/compiler/__tests__/fixtures/vl-parity/layer-title.json +0 -30
  153. package/src/compiler/__tests__/fixtures/vl-parity/layer-value-def.json +0 -29
  154. package/src/compiler/__tests__/fixtures/vl-parity/legend-null.json +0 -32
  155. package/src/compiler/__tests__/fixtures/vl-parity/scheme.json +0 -25
  156. package/src/compiler/__tests__/fixtures/vl-parity/sort-by-value.json +0 -19
  157. package/src/compiler/__tests__/fixtures/vl-parity/theta-arc.json +0 -19
  158. package/src/compiler/__tests__/fixtures/vl-parity/title-subtitle.json +0 -21
  159. package/src/compiler/__tests__/fixtures/vl-parity/width-height.json +0 -23
  160. package/src/compiler/__tests__/keys.test.ts +0 -83
  161. package/src/compiler/__tests__/normalize-highlight.test.ts +0 -103
  162. package/src/compiler/__tests__/normalize.test.ts +0 -399
  163. package/src/compiler/__tests__/sparkline-defaults.test.ts +0 -153
  164. package/src/compiler/__tests__/validate-did-you-mean.test.ts +0 -170
  165. package/src/compiler/__tests__/validate-highlight.test.ts +0 -112
  166. package/src/compiler/__tests__/validate-near-miss.test.ts +0 -251
  167. package/src/compiler/__tests__/validate.test.ts +0 -629
  168. package/src/compiler/__tests__/vl-parity.test.ts +0 -68
  169. package/src/compiler/a11y-warnings.ts +0 -110
  170. package/src/compiler/animation.ts +0 -142
  171. package/src/compiler/index.ts +0 -47
  172. package/src/compiler/keys.ts +0 -55
  173. package/src/compiler/normalize.ts +0 -734
  174. package/src/compiler/sparkline-defaults.ts +0 -138
  175. package/src/compiler/types.ts +0 -241
  176. package/src/compiler/validate.ts +0 -2041
  177. package/src/endpoint-labels/__tests__/compute.test.ts +0 -587
  178. package/src/endpoint-labels/compute.ts +0 -621
  179. package/src/endpoint-labels/constants.ts +0 -54
  180. package/src/endpoint-labels/format.ts +0 -60
  181. package/src/endpoint-labels/predict.ts +0 -139
  182. package/src/format/__tests__/field-format.test.ts +0 -164
  183. package/src/format/field-format.ts +0 -27
  184. package/src/geo/__tests__/compile-map.test.ts +0 -1004
  185. package/src/geo/compile-map.ts +0 -1341
  186. package/src/geo/join.ts +0 -115
  187. package/src/geo/projections.ts +0 -45
  188. package/src/geo/types.ts +0 -26
  189. package/src/graphs/__tests__/community.test.ts +0 -228
  190. package/src/graphs/__tests__/compile-graph.test.ts +0 -396
  191. package/src/graphs/__tests__/encoding.test.ts +0 -415
  192. package/src/graphs/community.ts +0 -92
  193. package/src/graphs/compile-graph.ts +0 -329
  194. package/src/graphs/encoding.ts +0 -356
  195. package/src/graphs/types.ts +0 -106
  196. package/src/index.ts +0 -177
  197. package/src/layout/__tests__/metrics.test.ts +0 -97
  198. package/src/layout/__tests__/scales-highlight.test.ts +0 -192
  199. package/src/layout/axes/rotation.ts +0 -152
  200. package/src/layout/axes/thinning.ts +0 -98
  201. package/src/layout/axes/ticks.ts +0 -409
  202. package/src/layout/axes.ts +0 -757
  203. package/src/layout/dimensions.ts +0 -912
  204. package/src/layout/facet.ts +0 -91
  205. package/src/layout/gridlines.ts +0 -84
  206. package/src/layout/metrics.ts +0 -132
  207. package/src/layout/plan.ts +0 -631
  208. package/src/layout/scales.ts +0 -1053
  209. package/src/layout/shared.ts +0 -44
  210. package/src/legend/__tests__/continuous.test.ts +0 -318
  211. package/src/legend/__tests__/redundancy.test.ts +0 -108
  212. package/src/legend/__tests__/size.test.ts +0 -348
  213. package/src/legend/__tests__/suppression.test.ts +0 -382
  214. package/src/legend/compute.ts +0 -747
  215. package/src/legend/continuous.ts +0 -327
  216. package/src/legend/size.ts +0 -407
  217. package/src/legend/suppression.ts +0 -226
  218. package/src/legend/wrap.ts +0 -117
  219. package/src/sankey/__tests__/compile-sankey.test.ts +0 -458
  220. package/src/sankey/__tests__/layout.test.ts +0 -165
  221. package/src/sankey/__tests__/node-label-wrap.test.ts +0 -114
  222. package/src/sankey/__tests__/node-sort.test.ts +0 -45
  223. package/src/sankey/compile-sankey.ts +0 -706
  224. package/src/sankey/layout.ts +0 -184
  225. package/src/sankey/types.ts +0 -41
  226. package/src/tables/__tests__/bar-column.test.ts +0 -147
  227. package/src/tables/__tests__/category-colors.test.ts +0 -230
  228. package/src/tables/__tests__/compile-table.test.ts +0 -236
  229. package/src/tables/__tests__/format-cells.test.ts +0 -143
  230. package/src/tables/__tests__/heatmap.test.ts +0 -148
  231. package/src/tables/__tests__/pagination.test.ts +0 -78
  232. package/src/tables/__tests__/search.test.ts +0 -94
  233. package/src/tables/__tests__/sort.test.ts +0 -107
  234. package/src/tables/__tests__/sparkline.test.ts +0 -122
  235. package/src/tables/bar-column.ts +0 -94
  236. package/src/tables/category-colors.ts +0 -78
  237. package/src/tables/compile-table.ts +0 -427
  238. package/src/tables/format-cells.ts +0 -115
  239. package/src/tables/heatmap.ts +0 -141
  240. package/src/tables/pagination.ts +0 -46
  241. package/src/tables/search.ts +0 -66
  242. package/src/tables/sort.ts +0 -69
  243. package/src/tables/sparkline.ts +0 -113
  244. package/src/tables/utils.ts +0 -16
  245. package/src/tilemap/__tests__/compile-tilemap.test.ts +0 -576
  246. package/src/tilemap/compile-tilemap.ts +0 -755
  247. package/src/tilemap/layout.ts +0 -172
  248. package/src/tilemap/types.ts +0 -33
  249. package/src/tooltips/__tests__/compute.test.ts +0 -582
  250. package/src/tooltips/compute.ts +0 -700
  251. package/src/transforms/__tests__/aggregate.test.ts +0 -159
  252. package/src/transforms/__tests__/bin.test.ts +0 -88
  253. package/src/transforms/__tests__/calculate.test.ts +0 -146
  254. package/src/transforms/__tests__/conditional.test.ts +0 -127
  255. package/src/transforms/__tests__/filter-relative.test.ts +0 -202
  256. package/src/transforms/__tests__/filter.test.ts +0 -59
  257. package/src/transforms/__tests__/fold.test.ts +0 -79
  258. package/src/transforms/__tests__/index.test.ts +0 -93
  259. package/src/transforms/__tests__/predicates.test.ts +0 -193
  260. package/src/transforms/__tests__/timeunit.test.ts +0 -129
  261. package/src/transforms/__tests__/window.test.ts +0 -286
  262. package/src/transforms/aggregate.ts +0 -131
  263. package/src/transforms/bin.ts +0 -87
  264. package/src/transforms/calculate.ts +0 -60
  265. package/src/transforms/conditional.ts +0 -46
  266. package/src/transforms/filter.ts +0 -122
  267. package/src/transforms/fold.ts +0 -49
  268. package/src/transforms/index.ts +0 -60
  269. package/src/transforms/predicates.ts +0 -123
  270. package/src/transforms/timeunit.ts +0 -88
  271. package/src/transforms/window.ts +0 -185
@@ -1,91 +0,0 @@
1
- import type { Rect } from '@opendata-ai/openchart-core';
2
-
3
- const MIN_PANEL_WIDTH = 200;
4
- export const MIN_PANEL_HEIGHT = 100;
5
- const PANEL_GAP = 12;
6
- const HEADER_HEIGHT = 20;
7
- const X_AXIS_HEIGHT = 24;
8
-
9
- export interface FacetGridPanel {
10
- key: string;
11
- area: Rect;
12
- headerPos: { x: number; y: number };
13
- row: number;
14
- col: number;
15
- }
16
-
17
- export interface FacetGridResult {
18
- panels: FacetGridPanel[];
19
- columns: number;
20
- rows: number;
21
- }
22
-
23
- export function autoColumns(panelCount: number, availableWidth: number): number {
24
- const sqrtCols = Math.ceil(Math.sqrt(panelCount));
25
- const fitCols = Math.max(1, Math.floor(availableWidth / MIN_PANEL_WIDTH));
26
- return Math.min(sqrtCols, fitCols, panelCount);
27
- }
28
-
29
- export function facetMinHeight(panelCount: number, columns: number): number {
30
- const rows = Math.ceil(panelCount / columns);
31
- return rows * (MIN_PANEL_HEIGHT + HEADER_HEIGHT + X_AXIS_HEIGHT) + (rows - 1) * PANEL_GAP;
32
- }
33
-
34
- export function computeFacetGrid(
35
- facetValues: string[],
36
- requestedColumns: number | undefined,
37
- totalArea: Rect,
38
- outerAxisReservation: { left: number; bottom: number },
39
- ): FacetGridResult {
40
- const n = facetValues.length;
41
- if (n === 0) return { panels: [], columns: 0, rows: 0 };
42
-
43
- const usableWidth = totalArea.width - outerAxisReservation.left;
44
- let columns = Math.min(requestedColumns ?? autoColumns(n, usableWidth), n);
45
-
46
- // Responsive degradation: reduce columns until panels are wide enough
47
- while (columns > 1) {
48
- const panelWidth = (usableWidth - (columns - 1) * PANEL_GAP) / columns;
49
- if (panelWidth >= MIN_PANEL_WIDTH) break;
50
- columns--;
51
- }
52
-
53
- const rows = Math.ceil(n / columns);
54
- const panelWidth = Math.max(0, (usableWidth - (columns - 1) * PANEL_GAP) / columns);
55
- // Every row includes its own x-axis labels, so the bottom reservation
56
- // applies per-row (as overhead), not just at the grid bottom.
57
- const xAxisPerRow = outerAxisReservation.bottom;
58
- const usableHeight = totalArea.height;
59
- const panelHeight = Math.max(
60
- 0,
61
- (usableHeight - rows * (HEADER_HEIGHT + xAxisPerRow) - (rows - 1) * PANEL_GAP) / rows,
62
- );
63
-
64
- const rowStride = HEADER_HEIGHT + panelHeight + xAxisPerRow + PANEL_GAP;
65
- const panels: FacetGridPanel[] = [];
66
-
67
- for (let i = 0; i < n; i++) {
68
- const col = i % columns;
69
- const row = Math.floor(i / columns);
70
- const x = totalArea.x + outerAxisReservation.left + col * (panelWidth + PANEL_GAP);
71
- const y = totalArea.y + row * rowStride;
72
-
73
- panels.push({
74
- key: facetValues[i],
75
- area: {
76
- x,
77
- y: y + HEADER_HEIGHT,
78
- width: panelWidth,
79
- height: panelHeight,
80
- },
81
- headerPos: {
82
- x: x + panelWidth / 2,
83
- y: y + HEADER_HEIGHT * 0.6,
84
- },
85
- row,
86
- col,
87
- });
88
- }
89
-
90
- return { panels, columns, rows };
91
- }
@@ -1,84 +0,0 @@
1
- /**
2
- * Gridline computation.
3
- *
4
- * Produces horizontal gridlines at y-axis tick positions and optional
5
- * vertical gridlines at x-axis tick positions.
6
- */
7
-
8
- import type { Rect } from '@opendata-ai/openchart-core';
9
- import type { AxesResult } from './axes';
10
-
11
- // ---------------------------------------------------------------------------
12
- // Types
13
- // ---------------------------------------------------------------------------
14
-
15
- /** A single gridline with start/end positions. */
16
- export interface GridlineSpec {
17
- /** Start x. */
18
- x1: number;
19
- /** Start y. */
20
- y1: number;
21
- /** End x. */
22
- x2: number;
23
- /** End y. */
24
- y2: number;
25
- /** Whether this is a major gridline. */
26
- major: boolean;
27
- }
28
-
29
- /** Complete gridline layout. */
30
- export interface GridlineLayout {
31
- horizontal: GridlineSpec[];
32
- vertical: GridlineSpec[];
33
- }
34
-
35
- // ---------------------------------------------------------------------------
36
- // Public API
37
- // ---------------------------------------------------------------------------
38
-
39
- /**
40
- * Compute gridlines from axis layouts.
41
- *
42
- * Horizontal gridlines span the chart width at y-axis tick positions.
43
- * Vertical gridlines span the chart height at x-axis tick positions.
44
- *
45
- * @param axes - Computed axis layouts.
46
- * @param chartArea - The chart drawing area.
47
- * @param showVertical - Whether to include vertical gridlines (default: false).
48
- */
49
- export function computeGridlines(
50
- axes: AxesResult,
51
- chartArea: Rect,
52
- showVertical = false,
53
- ): GridlineLayout {
54
- const horizontal: GridlineSpec[] = [];
55
- const vertical: GridlineSpec[] = [];
56
-
57
- // Horizontal gridlines at y-axis ticks
58
- if (axes.y) {
59
- for (const gridline of axes.y.gridlines) {
60
- horizontal.push({
61
- x1: chartArea.x,
62
- y1: gridline.position,
63
- x2: chartArea.x + chartArea.width,
64
- y2: gridline.position,
65
- major: gridline.major,
66
- });
67
- }
68
- }
69
-
70
- // Vertical gridlines at x-axis ticks (off by default)
71
- if (showVertical && axes.x) {
72
- for (const gridline of axes.x.gridlines) {
73
- vertical.push({
74
- x1: gridline.position,
75
- y1: chartArea.y,
76
- x2: gridline.position,
77
- y2: chartArea.y + chartArea.height,
78
- major: gridline.major,
79
- });
80
- }
81
- }
82
-
83
- return { horizontal, vertical };
84
- }
@@ -1,132 +0,0 @@
1
- /**
2
- * Metric bar layout: a row of KPI cells rendered above the chart area.
3
- *
4
- * Cells lay out evenly across the chart width. The bar is auto-stripped when
5
- * the container is too narrow, when the chart area would be left too short,
6
- * or when value text would overflow its allotted cell width. Sparkline mode
7
- * never reserves space for metrics.
8
- */
9
- import type {
10
- MeasureTextFn,
11
- Metric,
12
- ResolvedMetricBar,
13
- ResolvedMetricCell,
14
- } from '@opendata-ai/openchart-core';
15
- import { estimateTextWidth } from '@opendata-ai/openchart-core';
16
-
17
- // Font sizes default to the editorial KPI mock (10px uppercase label above a
18
- // 22px primary value) but are theme-driven so charts can scale the row. The
19
- // label/value sizes flow in from `theme.fonts.sizes.metricLabel/metricValue`.
20
- const DEFAULT_LABEL_FONT_SIZE = 10;
21
- const DEFAULT_VALUE_FONT_SIZE = 22;
22
- const LABEL_LINE_HEIGHT_RATIO = 1.4;
23
- const VALUE_LINE_HEIGHT_RATIO = 1.15;
24
- const INTER_ROW_GAP = 4;
25
- // Breathing room above labels (separates metric row from the subtitle).
26
- const TOP_GAP = 16;
27
- // Breathing room below values (separates metric row from legend / chart top).
28
- const BOTTOM_GAP = 20;
29
-
30
- /** Font sizes the metric layout reserves space for. */
31
- export interface MetricFontSizes {
32
- /** Uppercase label size (px). */
33
- label: number;
34
- /** Primary value size (px). */
35
- value: number;
36
- }
37
-
38
- const DEFAULT_METRIC_FONT_SIZES: MetricFontSizes = {
39
- label: DEFAULT_LABEL_FONT_SIZE,
40
- value: DEFAULT_VALUE_FONT_SIZE,
41
- };
42
-
43
- /** Minimum container width that can fit a metric bar. */
44
- const MIN_BAR_WIDTH = 480;
45
- /** Minimum chart-area height after metric reservation. */
46
- const MIN_CHART_HEIGHT = 150;
47
- /** Inner cell gutter so adjacent cells don't visually touch. */
48
- const CELL_INNER_PAD = 8;
49
-
50
- /**
51
- * Total height the metric bar reserves above the chart area. Derived from the
52
- * font sizes (theme-driven) plus the fixed gaps; never hardcoded at the call site.
53
- */
54
- export function metricBarHeight(fonts: MetricFontSizes = DEFAULT_METRIC_FONT_SIZES): number {
55
- const labelLine = fonts.label * LABEL_LINE_HEIGHT_RATIO;
56
- const valueLine = fonts.value * VALUE_LINE_HEIGHT_RATIO;
57
- return TOP_GAP + labelLine + INTER_ROW_GAP + valueLine + BOTTOM_GAP;
58
- }
59
-
60
- /**
61
- * Concatenate the visible value text used for overflow detection. Joined with
62
- * single spaces because the renderer separates the spans with `dx` attributes
63
- * that consume roughly a space's worth of width.
64
- */
65
- function valueRunText(metric: Metric): string {
66
- const parts = [metric.value];
67
- if (metric.delta) parts.push(metric.delta);
68
- if (metric.secondary) parts.push(metric.secondary);
69
- return parts.join(' ');
70
- }
71
-
72
- /**
73
- * Compute the metric bar layout. Returns `undefined` when the bar should be
74
- * stripped (too narrow, chart too short, or any cell would overflow).
75
- */
76
- export function computeMetricBar(
77
- metrics: Metric[] | undefined,
78
- metricsTopY: number,
79
- metricsArea: { x: number; width: number },
80
- remainingChartHeight: number,
81
- measureText?: MeasureTextFn,
82
- fonts: MetricFontSizes = DEFAULT_METRIC_FONT_SIZES,
83
- ): ResolvedMetricBar | undefined {
84
- if (!metrics || metrics.length === 0) return undefined;
85
- if (metricsArea.width < MIN_BAR_WIDTH) return undefined;
86
- if (remainingChartHeight < MIN_CHART_HEIGHT) return undefined;
87
-
88
- const cellWidth = metricsArea.width / metrics.length;
89
-
90
- // Bail if any cell's value run can't fit. Half-rendered metric rows look
91
- // worse than no row at all on small viewports.
92
- for (const metric of metrics) {
93
- const text = valueRunText(metric);
94
- const measured = measureText
95
- ? measureText(text, fonts.value, 510).width
96
- : estimateTextWidth(text, fonts.value, 510);
97
- if (measured > cellWidth - CELL_INNER_PAD) return undefined;
98
- }
99
-
100
- const labelLine = fonts.label * LABEL_LINE_HEIGHT_RATIO;
101
- const labelY = metricsTopY + TOP_GAP + fonts.label; // baseline for uppercase label
102
- const valueY = metricsTopY + TOP_GAP + labelLine + INTER_ROW_GAP + fonts.value;
103
-
104
- const cells: ResolvedMetricCell[] = metrics.map((metric, i) => ({
105
- x: metricsArea.x + i * cellWidth,
106
- cellWidth,
107
- labelY,
108
- valueY,
109
- metric,
110
- overflowed: false,
111
- }));
112
-
113
- return {
114
- y: metricsTopY,
115
- height: metricBarHeight(fonts),
116
- cells,
117
- };
118
- }
119
-
120
- // Exposed for tests and consumers needing the same constants.
121
- export const METRIC_BAR_INTERNALS = {
122
- DEFAULT_LABEL_FONT_SIZE,
123
- DEFAULT_VALUE_FONT_SIZE,
124
- LABEL_LINE_HEIGHT_RATIO,
125
- VALUE_LINE_HEIGHT_RATIO,
126
- INTER_ROW_GAP,
127
- TOP_GAP,
128
- BOTTOM_GAP,
129
- MIN_BAR_WIDTH,
130
- MIN_CHART_HEIGHT,
131
- CELL_INNER_PAD,
132
- };