@carto/ps-react-ui 4.25.0 → 4.26.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 (67) hide show
  1. package/dist/{actions-B1ss030_.js → actions-DXfQMrll.js} +56 -46
  2. package/dist/actions-DXfQMrll.js.map +1 -0
  3. package/dist/item-color-C1cu6EJd.js +20 -0
  4. package/dist/item-color-C1cu6EJd.js.map +1 -0
  5. package/dist/types/widgets-v2/bar/types.d.ts +6 -0
  6. package/dist/types/widgets-v2/histogram/bins.d.ts +7 -0
  7. package/dist/types/widgets-v2/histogram/download.d.ts +2 -2
  8. package/dist/types/widgets-v2/histogram/index.d.ts +2 -1
  9. package/dist/types/widgets-v2/histogram/options.d.ts +1 -1
  10. package/dist/types/widgets-v2/histogram/transforms.d.ts +5 -4
  11. package/dist/types/widgets-v2/histogram/types.d.ts +22 -5
  12. package/dist/types/widgets-v2/index.d.ts +1 -1
  13. package/dist/types/widgets-v2/pie/types.d.ts +6 -0
  14. package/dist/types/widgets-v2/scatterplot/download.d.ts +2 -2
  15. package/dist/types/widgets-v2/scatterplot/index.d.ts +2 -1
  16. package/dist/types/widgets-v2/scatterplot/points.d.ts +7 -0
  17. package/dist/types/widgets-v2/scatterplot/transforms.d.ts +4 -3
  18. package/dist/types/widgets-v2/scatterplot/types.d.ts +21 -2
  19. package/dist/types/widgets-v2/timeseries/types.d.ts +6 -0
  20. package/dist/types/widgets-v2/utils/item-color.d.ts +26 -0
  21. package/dist/widgets-v2/actions.js +1 -1
  22. package/dist/widgets-v2/bar.js +66 -57
  23. package/dist/widgets-v2/bar.js.map +1 -1
  24. package/dist/widgets-v2/histogram.js +103 -71
  25. package/dist/widgets-v2/histogram.js.map +1 -1
  26. package/dist/widgets-v2/pie.js +98 -78
  27. package/dist/widgets-v2/pie.js.map +1 -1
  28. package/dist/widgets-v2/scatterplot.js +119 -79
  29. package/dist/widgets-v2/scatterplot.js.map +1 -1
  30. package/dist/widgets-v2/timeseries.js +70 -61
  31. package/dist/widgets-v2/timeseries.js.map +1 -1
  32. package/dist/widgets-v2.js +1 -1
  33. package/dist/widgets-v2.js.map +1 -1
  34. package/package.json +3 -3
  35. package/src/widgets-v2/actions/fullscreen/fullscreen-store.test.tsx +77 -13
  36. package/src/widgets-v2/actions/fullscreen/fullscreen.tsx +48 -5
  37. package/src/widgets-v2/bar/options.test.ts +106 -0
  38. package/src/widgets-v2/bar/options.ts +25 -14
  39. package/src/widgets-v2/bar/types.ts +6 -0
  40. package/src/widgets-v2/histogram/bins.ts +22 -0
  41. package/src/widgets-v2/histogram/download.test.ts +10 -0
  42. package/src/widgets-v2/histogram/download.ts +7 -3
  43. package/src/widgets-v2/histogram/index.ts +3 -0
  44. package/src/widgets-v2/histogram/options.test.ts +62 -0
  45. package/src/widgets-v2/histogram/options.ts +38 -17
  46. package/src/widgets-v2/histogram/transforms.test.ts +21 -7
  47. package/src/widgets-v2/histogram/transforms.ts +26 -12
  48. package/src/widgets-v2/histogram/types.ts +25 -5
  49. package/src/widgets-v2/index.ts +6 -1
  50. package/src/widgets-v2/pie/options.test.ts +91 -0
  51. package/src/widgets-v2/pie/options.ts +50 -20
  52. package/src/widgets-v2/pie/types.ts +6 -0
  53. package/src/widgets-v2/scatterplot/download.test.ts +9 -0
  54. package/src/widgets-v2/scatterplot/download.ts +5 -3
  55. package/src/widgets-v2/scatterplot/index.ts +3 -0
  56. package/src/widgets-v2/scatterplot/options.test.ts +78 -0
  57. package/src/widgets-v2/scatterplot/options.ts +35 -11
  58. package/src/widgets-v2/scatterplot/points.ts +35 -0
  59. package/src/widgets-v2/scatterplot/transforms.test.ts +19 -0
  60. package/src/widgets-v2/scatterplot/transforms.ts +23 -18
  61. package/src/widgets-v2/scatterplot/types.ts +25 -2
  62. package/src/widgets-v2/timeseries/options.test.ts +65 -0
  63. package/src/widgets-v2/timeseries/options.ts +32 -17
  64. package/src/widgets-v2/timeseries/types.ts +6 -0
  65. package/src/widgets-v2/utils/item-color.test.ts +74 -0
  66. package/src/widgets-v2/utils/item-color.ts +55 -0
  67. package/dist/actions-B1ss030_.js.map +0 -1
@@ -36,15 +36,20 @@ describe('toRelativeHistogramData', () => {
36
36
  expect(out[0]?.[1]).toBeCloseTo(-49.74874, 4)
37
37
  })
38
38
 
39
- it('returns the input unchanged when shape does not match number[][]', () => {
39
+ it('returns the input unchanged when shape does not match HistogramBin[][]', () => {
40
40
  expect(toRelativeHistogramData(null)).toBe(null)
41
41
  expect(toRelativeHistogramData('not an array')).toBe('not an array')
42
- // Series that isn't a flat number array (e.g. named-value or tuple)
43
- // is returned as-is — keeps the transform safe to attach to a
44
- // widget whose shape changes through other actions.
45
- expect(toRelativeHistogramData([[{ name: 'a', value: 10 }]])).toEqual([
46
- [{ name: 'a', value: 10 }],
47
- ])
42
+ // Series that isn't a list of bins (e.g. strings or tuples) is returned
43
+ // as-is — keeps the transform safe to attach to a widget whose shape
44
+ // changes through other actions.
45
+ expect(toRelativeHistogramData([['a', 'b']])).toEqual([['a', 'b']])
46
+ expect(toRelativeHistogramData([[[1, 2]]])).toEqual([[[1, 2]]])
47
+ })
48
+
49
+ it('relativizes object bins, keeping their colour', () => {
50
+ expect(
51
+ toRelativeHistogramData([[{ value: 5, color: '#f00' }, 15]]),
52
+ ).toEqual([[{ value: 25, color: '#f00' }, 75]])
48
53
  })
49
54
  })
50
55
 
@@ -75,6 +80,15 @@ describe('filterHistogramByLockedBins', () => {
75
80
  ])
76
81
  })
77
82
 
83
+ it('zeroes non-locked object bins, keeping their colour', () => {
84
+ expect(
85
+ filterHistogramByLockedBins(
86
+ [[{ value: 10, color: '#f00' }, { value: 20 }, 30]],
87
+ [1],
88
+ ),
89
+ ).toEqual([[{ value: 0, color: '#f00' }, { value: 20 }, 0]])
90
+ })
91
+
78
92
  it('returns input unchanged when input is not array-shaped', () => {
79
93
  expect(filterHistogramByLockedBins('nope', [0])).toBe('nope')
80
94
  })
@@ -1,6 +1,14 @@
1
+ import {
2
+ getHistogramBinValue,
3
+ isHistogramBin,
4
+ withHistogramBinValue,
5
+ } from './bins'
6
+ import type { HistogramBin } from './types'
7
+
1
8
  /**
2
9
  * Histogram-specific `RelativeData` transform. Histogram data is
3
- * `number[][]` — each series is a flat list of bin counts. This
10
+ * `HistogramBin[][]` — each series is a flat list of bin counts (plain
11
+ * numbers or `{ value, color? }`, whose shape is kept). This
4
12
  * rewrites each count to its share of the series total (0–100), so
5
13
  * pairing with `createPercentFormatter` renders the y-axis as
6
14
  * percentages.
@@ -11,27 +19,31 @@
11
19
  * inputs produce sane signed shares-of-magnitude. A series whose total
12
20
  * magnitude is zero (all-zero or empty input) is returned unchanged so
13
21
  * a stalled or empty data set doesn't show misleading 0% values. Inputs
14
- * whose shape isn't `number[][]` fall through untouched (same defensive
22
+ * whose shape isn't `HistogramBin[][]` fall through untouched (same defensive
15
23
  * shape-check pattern as the default transform).
16
24
  */
17
25
  export const toRelativeHistogramData = (input: unknown): unknown => {
18
26
  if (!Array.isArray(input)) return input
19
27
  return input.map((series: unknown): unknown => {
20
- if (!isFlatNumberArray(series)) return series
21
- const total = series.reduce((acc, v) => acc + Math.abs(v), 0)
28
+ if (!isBinArray(series)) return series
29
+ const total = series.reduce<number>(
30
+ (acc, b) => acc + Math.abs(getHistogramBinValue(b)),
31
+ 0,
32
+ )
22
33
  if (total <= 0) return series
23
- return series.map((v) => (v / total) * 100)
34
+ return series.map((b) =>
35
+ withHistogramBinValue(b, (getHistogramBinValue(b) / total) * 100),
36
+ )
24
37
  })
25
38
  }
26
39
 
27
- function isFlatNumberArray(v: unknown): v is number[] {
28
- if (!Array.isArray(v)) return false
29
- return v.every((item) => typeof item === 'number' && Number.isFinite(item))
40
+ function isBinArray(v: unknown): v is HistogramBin[] {
41
+ return Array.isArray(v) && v.every(isHistogramBin)
30
42
  }
31
43
 
32
44
  /**
33
- * `LockSelection` filter for Histogram. Data is `number[][]` — a flat list
34
- * of bin counts per series, positionally paired with `ticks` (bin `i` covers
45
+ * `LockSelection` filter for Histogram. Data is `HistogramBin[][]` — a flat
46
+ * list of bin counts per series, positionally paired with `ticks` (bin `i` covers
35
47
  * `[ticks[i], ticks[i+1])`). Unlike name-keyed widgets, locked-out bins can't
36
48
  * be REMOVED — that would shift every later bin's index and desync it from
37
49
  * its `ticks` range. Zeroing them out instead preserves array length/position,
@@ -47,7 +59,9 @@ export function filterHistogramByLockedBins(
47
59
  if (!Array.isArray(input)) return input
48
60
  const locked = new Set<number>(lockedItems.map(Number))
49
61
  return input.map((series: unknown): unknown => {
50
- if (!isFlatNumberArray(series)) return series
51
- return series.map((count, i) => (locked.has(i) ? count : 0))
62
+ if (!isBinArray(series)) return series
63
+ return series.map((bin, i) =>
64
+ locked.has(i) ? bin : withHistogramBinValue(bin, 0),
65
+ )
52
66
  })
53
67
  }
@@ -3,12 +3,32 @@ import type { EChartsOption } from 'echarts'
3
3
  import type { WidgetSeries } from '../types'
4
4
 
5
5
  /**
6
- * Histogram widget data — array of series, each a flat array of bin counts.
7
- * The option factory's merge phase (see {@link createHistogramOptionFactory})
8
- * combines this with `ticks` to produce a 2-column dataset (`[binLabel, count]`)
9
- * for ECharts.
6
+ * One histogram bin: either its count, or `{ value, color? }` to give the
7
+ * bar its own colour (CSS colour or theme palette path such as
8
+ * `'primary.main'`). A bin `color` wins over the template's
9
+ * `itemStyle.color` and the series colour; selection dimming still applies.
10
10
  */
11
- export type HistogramWidgetData = readonly (readonly number[])[]
11
+ export type HistogramBin = number | HistogramBinObject
12
+
13
+ /** Object form of a {@link HistogramBin}. */
14
+ export interface HistogramBinObject {
15
+ value: number
16
+ color?: string
17
+ }
18
+
19
+ /**
20
+ * Histogram widget data — array of series, each a flat array of bins. The
21
+ * option factory's merge phase (see {@link createHistogramOptionFactory})
22
+ * combines this with `ticks` to produce a 2-column dataset
23
+ * (`[binLabel, count]`) for ECharts.
24
+ *
25
+ * Defaults to plain counts (`number[][]`) so existing code that reads bins
26
+ * as numbers keeps type-checking; use `HistogramWidgetData<HistogramBin>`
27
+ * to also accept `{ value, color? }` bins. Every histogram API (option
28
+ * factory, transforms, download) accepts both forms.
29
+ */
30
+ export type HistogramWidgetData<B extends HistogramBin = number> =
31
+ readonly (readonly B[])[]
12
32
 
13
33
  /** Inputs to the structural-only {@link histogramOptions} builder. */
14
34
  export interface HistogramOptionsInput {
@@ -175,7 +175,12 @@ export type {
175
175
  export type { MarkdownUIProps, MarkdownWidgetData } from './markdown'
176
176
  export type { PieDatum, PieWidgetData } from './pie'
177
177
  export type { TimeseriesDatum, TimeseriesWidgetData } from './timeseries'
178
- export type { ScatterplotDatum, ScatterplotWidgetData } from './scatterplot'
178
+ export type {
179
+ ScatterplotDatum,
180
+ ScatterplotPoint,
181
+ ScatterplotItem,
182
+ ScatterplotWidgetData,
183
+ } from './scatterplot'
179
184
  export type {
180
185
  SpreadUIProps,
181
186
  SpreadDataItem,
@@ -1,4 +1,5 @@
1
1
  import { describe, it, expect } from 'vitest'
2
+ import * as echarts from 'echarts'
2
3
  import { createTheme, type Theme } from '@mui/material'
3
4
  import { createPieOptionFactory, pieOptions } from './options'
4
5
 
@@ -936,3 +937,93 @@ describe('createPieOptionFactory — multi-series fallback (horizontal bar)', ()
936
937
  })
937
938
  })
938
939
  })
940
+
941
+ describe('createPieOptionFactory — per-item colour', () => {
942
+ interface Out {
943
+ series: { itemStyle: { color: (p: unknown) => string } }[]
944
+ }
945
+ const dim = (c: string) => echarts.color.modifyAlpha(c, 0.15)
946
+ const palette = ['#p0', '#p1', '#p2']
947
+
948
+ it('donut: slice colour wins over the palette; template next', () => {
949
+ const merge = createPieOptionFactory({ theme, selection: ['A', 'B'] })
950
+ const out = merge(
951
+ {
952
+ color: palette,
953
+ series: [{ type: 'pie', itemStyle: { color: '#123456' } }],
954
+ },
955
+ [
956
+ [
957
+ { name: 'A', value: 1, color: '#00ff00' },
958
+ { name: 'B', value: 2 },
959
+ { name: 'C', value: 3 },
960
+ ],
961
+ ],
962
+ ) as Out
963
+ const colorFn = out.series[0]!.itemStyle.color
964
+ expect(colorFn({ dataIndex: 0, name: 'A', color: '#x' })).toBe('#00ff00')
965
+ expect(colorFn({ dataIndex: 1, name: 'B', color: '#x' })).toBe('#123456')
966
+ expect(colorFn({ dataIndex: 2, name: 'C', color: '#x' })).toBe(
967
+ dim('#123456'),
968
+ )
969
+ })
970
+
971
+ it('donut: keeps the per-data palette when no item colour is given', () => {
972
+ const merge = createPieOptionFactory({ theme })
973
+ const out = merge({ color: palette }, [
974
+ [
975
+ { name: 'A', value: 1, color: '#00ff00' },
976
+ { name: 'B', value: 2 },
977
+ ],
978
+ ]) as Out
979
+ const colorFn = out.series[0]!.itemStyle.color
980
+ expect(colorFn({ dataIndex: 0, name: 'A', color: '#x' })).toBe('#00ff00')
981
+ expect(colorFn({ dataIndex: 1, name: 'B', color: '#x' })).toBe('#p1')
982
+ })
983
+
984
+ it('donut: template itemStyle.color callback via optionsOverride', () => {
985
+ const factory = createPieOptionFactory({
986
+ theme,
987
+ optionsOverride: {
988
+ series: [
989
+ {
990
+ type: 'pie',
991
+ itemStyle: {
992
+ color: (p: { dataIndex: number }) => `#c${p.dataIndex}`,
993
+ },
994
+ },
995
+ ],
996
+ },
997
+ })
998
+ const out = factory(factory(undefined, undefined), [
999
+ [{ name: 'A', value: 1 }],
1000
+ ]) as Out
1001
+ expect(
1002
+ out.series[0]!.itemStyle.color({ dataIndex: 0, name: 'A', color: '#x' }),
1003
+ ).toBe('#c0')
1004
+ })
1005
+
1006
+ it('multi-series bar fallback: datum colour wins over the series palette', () => {
1007
+ const merge = createPieOptionFactory({ theme, selection: ['B'] })
1008
+ const out = merge({ color: palette }, [
1009
+ [{ name: 'A', value: 1, color: '#00ff00' }],
1010
+ [{ name: 'A', value: 2 }],
1011
+ ]) as Out
1012
+ expect(
1013
+ out.series[0]!.itemStyle.color({
1014
+ dataIndex: 0,
1015
+ seriesIndex: 0,
1016
+ name: 'A',
1017
+ color: '#x',
1018
+ }),
1019
+ ).toBe(dim('#00ff00'))
1020
+ expect(
1021
+ out.series[1]!.itemStyle.color({
1022
+ dataIndex: 0,
1023
+ seriesIndex: 1,
1024
+ name: 'B',
1025
+ color: '#x',
1026
+ }),
1027
+ ).toBe('#p1')
1028
+ })
1029
+ })
@@ -12,6 +12,7 @@ import {
12
12
  } from '../../widgets/utils/chart-config'
13
13
  import type { OptionFactory, OptionFactoryContext } from '../echart'
14
14
  import { mergeOptions, resolveThemeColor } from '../utils'
15
+ import { createItemColorResolver } from '../utils/item-color'
15
16
  import type { WidgetSeries } from '../types'
16
17
  import type {
17
18
  PieEChartsOption,
@@ -168,6 +169,7 @@ export function createPieOptionFactory(
168
169
  return buildSingleSeriesPieFusion(
169
170
  option,
170
171
  seriesArr,
172
+ theme,
171
173
  radius,
172
174
  series,
173
175
  ctx,
@@ -185,6 +187,7 @@ export function createPieOptionFactory(
185
187
  function buildSingleSeriesPieFusion(
186
188
  option: EChartsOption,
187
189
  seriesArr: PieWidgetData,
190
+ theme: Theme,
188
191
  radius: readonly [string, string],
189
192
  series: readonly WidgetSeries[] | undefined,
190
193
  ctx: OptionFactoryContext | undefined,
@@ -231,14 +234,25 @@ function buildSingleSeriesPieFusion(
231
234
  // empty Set — the collapse above (`selection.length === 0 → null`) rules
232
235
  // that out — so there's no "dim everything" case here, unlike a widget
233
236
  // that gives `[]` its own "selected down to nothing" meaning.
234
- const colorFn = (params: CallbackDataParams): string => {
235
- const base = resolvePaletteColor(params)
236
- if (!selectionSet) return base
237
- const datum = params.value as { name?: string | number } | undefined
238
- const name = datum?.name ?? params.name
239
- return name != null && selectionSet.has(name)
240
- ? base
241
- : echarts.color.modifyAlpha(base, 0.15)
237
+ //
238
+ // The base colour is the slice's own `color`, else the template's
239
+ // `itemStyle.color`, else the per-data palette swatch.
240
+ const makeColorFn = (datums: readonly object[], template: unknown) => {
241
+ const baseColor = createItemColorResolver({
242
+ theme,
243
+ datums,
244
+ template,
245
+ fallback: resolvePaletteColor,
246
+ })
247
+ return (params: CallbackDataParams): string => {
248
+ const base = baseColor(params)
249
+ if (!selectionSet) return base
250
+ const datum = params.value as { name?: string | number } | undefined
251
+ const name = datum?.name ?? params.name
252
+ return name != null && selectionSet.has(name)
253
+ ? base
254
+ : echarts.color.modifyAlpha(base, 0.15)
255
+ }
242
256
  }
243
257
 
244
258
  // ECharts anchors EVERY slice's `position: 'center'` label at the same
@@ -316,7 +330,7 @@ function buildSingleSeriesPieFusion(
316
330
  return {
317
331
  ...option,
318
332
  dataset: seriesArr.map((s) => ({ source: s as readonly object[] })),
319
- series: seriesArr.map((_, i) => {
333
+ series: seriesArr.map((s, i) => {
320
334
  const template =
321
335
  (seriesTemplates[i] as object | undefined) ??
322
336
  (broadcastTemplate as object)
@@ -344,7 +358,7 @@ function buildSingleSeriesPieFusion(
344
358
  },
345
359
  itemStyle: {
346
360
  ...templateItemStyle,
347
- color: colorFn,
361
+ color: makeColorFn(s, templateObj),
348
362
  },
349
363
  }
350
364
  }),
@@ -419,17 +433,31 @@ function buildMultiSeriesBarFusion(
419
433
  const palette = Array.isArray(option.color)
420
434
  ? (option.color as readonly (string | undefined)[])
421
435
  : []
422
- const barColorFn = (params: CallbackDataParams): string => {
436
+ // The base colour is the datum's own `color`, else the template's
437
+ // `itemStyle.color`, else the per-series palette swatch.
438
+ const seriesTemplates = Array.isArray(option.series) ? option.series : []
439
+ const paletteColor = (params: CallbackDataParams): string => {
423
440
  const seriesIdx = params.seriesIndex ?? 0
424
441
  const seriesSwatch =
425
442
  palette.length > 0 ? palette[seriesIdx % palette.length] : undefined
426
- const base = (seriesSwatch ?? params.color) as string
427
- if (!selectionSet) return base
428
- const datum = params.value as { name?: string | number } | undefined
429
- const name = datum?.name ?? params.name
430
- return name != null && selectionSet.has(name)
431
- ? base
432
- : echarts.color.modifyAlpha(base, 0.15)
443
+ return (seriesSwatch ?? params.color) as string
444
+ }
445
+ const makeBarColorFn = (datums: readonly object[], template: unknown) => {
446
+ const baseColor = createItemColorResolver({
447
+ theme,
448
+ datums,
449
+ template,
450
+ fallback: paletteColor,
451
+ })
452
+ return (params: CallbackDataParams): string => {
453
+ const base = baseColor(params)
454
+ if (!selectionSet) return base
455
+ const datum = params.value as { name?: string | number } | undefined
456
+ const name = datum?.name ?? params.name
457
+ return name != null && selectionSet.has(name)
458
+ ? base
459
+ : echarts.color.modifyAlpha(base, 0.15)
460
+ }
433
461
  }
434
462
 
435
463
  return {
@@ -444,7 +472,7 @@ function buildMultiSeriesBarFusion(
444
472
  // Drop pie-specific structural keys that shouldn't render in the
445
473
  // bar fallback. ECharts ignores undefined keys, so this is a clean
446
474
  // override.
447
- series: seriesArr.map((_, i) => {
475
+ series: seriesArr.map((s, i) => {
448
476
  const overrideColor = resolveThemeColor(theme, series?.[i]?.color)
449
477
  return {
450
478
  datasetIndex: i,
@@ -454,7 +482,9 @@ function buildMultiSeriesBarFusion(
454
482
  legendHoverLink: false,
455
483
  emphasis: { focus: 'series' },
456
484
  ...buildSeriesLabelConfig(formatter, 'x'),
457
- itemStyle: { color: barColorFn },
485
+ itemStyle: {
486
+ color: makeBarColorFn(s, seriesTemplates[i] ?? seriesTemplates[0]),
487
+ },
458
488
  ...(overrideColor ? { color: overrideColor } : {}),
459
489
  }
460
490
  }),
@@ -6,6 +6,12 @@ import type { WidgetSeries } from '../types'
6
6
  export interface PieDatum {
7
7
  name: string | number
8
8
  value: number
9
+ /**
10
+ * Optional colour for this item (CSS colour or theme palette path such as
11
+ * `'primary.main'`). Wins over the template's `itemStyle.color` and the
12
+ * series colour; selection dimming still applies on top.
13
+ */
14
+ color?: string
9
15
  }
10
16
 
11
17
  /** Pie widget data — one slice array per series (rendered as side-by-side donuts). */
@@ -61,6 +61,15 @@ describe('createScatterplotDownloadConfig', () => {
61
61
  )
62
62
  })
63
63
 
64
+ it('CSV writes x/y of object points (colour is not exported)', async () => {
65
+ const items = createScatterplotDownloadConfig({
66
+ filename: 's',
67
+ getData: () => [[{ x: 1, y: 10, color: '#f00' }, [2, 20]]],
68
+ })
69
+ await items.find((i) => i.id === 'csv')!.resolve({ id: null })
70
+ expect(csvText).toBe('series,x,y\nseries_1,1,10\nseries_1,2,20')
71
+ })
72
+
64
73
  it('CSV honours supplied seriesNames', async () => {
65
74
  const items = createScatterplotDownloadConfig({
66
75
  filename: 's',
@@ -4,7 +4,8 @@ import {
4
4
  type DownloadContext,
5
5
  type DownloadItem,
6
6
  } from '../actions/download'
7
- import type { ScatterplotWidgetData } from './types'
7
+ import { getScatterplotXY } from './points'
8
+ import type { ScatterplotItem, ScatterplotWidgetData } from './types'
8
9
 
9
10
  /**
10
11
  * Download menu items for the Scatterplot widget. Always includes a CSV
@@ -14,7 +15,7 @@ import type { ScatterplotWidgetData } from './types'
14
15
  */
15
16
  export function createScatterplotDownloadConfig(args: {
16
17
  filename: string
17
- getData: (ctx: DownloadContext) => ScatterplotWidgetData
18
+ getData: (ctx: DownloadContext) => ScatterplotWidgetData<ScatterplotItem>
18
19
  seriesNames?: readonly string[]
19
20
  getCaptureEl?: (ctx: DownloadContext) => HTMLElement | null
20
21
  pngPixelRatio?: number
@@ -39,7 +40,8 @@ export function createScatterplotDownloadConfig(args: {
39
40
  const rows: unknown[][] = [['series', 'x', 'y']]
40
41
  for (const [i, series] of data.entries()) {
41
42
  const seriesName = args.seriesNames?.[i] ?? `series_${i + 1}`
42
- for (const [x, y] of series) {
43
+ for (const point of series) {
44
+ const [x, y] = getScatterplotXY(point)
43
45
  rows.push([seriesName, x, y])
44
46
  }
45
47
  }
@@ -5,8 +5,11 @@ export {
5
5
  toRelativeScatterplotData,
6
6
  filterScatterplotByLockedPoints,
7
7
  } from './transforms'
8
+ export { getScatterplotXY } from './points'
8
9
  export type {
9
10
  ScatterplotDatum,
11
+ ScatterplotPoint,
12
+ ScatterplotItem,
10
13
  ScatterplotWidgetData,
11
14
  ScatterplotOptionsInput,
12
15
  ScatterplotOptionFactoryInput,
@@ -1,4 +1,5 @@
1
1
  import { describe, it, expect } from 'vitest'
2
+ import * as echarts from 'echarts'
2
3
  import { createTheme, type Theme } from '@mui/material'
3
4
  import { createScatterplotOptionFactory, scatterplotOptions } from './options'
4
5
 
@@ -409,3 +410,80 @@ describe('createScatterplotOptionFactory', () => {
409
410
  expect(insideOnly.grid.right).toBe(baseline.grid.right)
410
411
  })
411
412
  })
413
+
414
+ describe('createScatterplotOptionFactory — per-item colour', () => {
415
+ interface Out {
416
+ dataset: { source: number[][] }[]
417
+ series: { itemStyle: { color: (p: unknown) => string } }[]
418
+ xAxis: { min: number; max: number }
419
+ yAxis: { min: number; max: number }
420
+ }
421
+ const dim = (c: string) => echarts.color.modifyAlpha(c, 0.15)
422
+ const data = [
423
+ [{ x: 1, y: 2, color: '#00ff00' }, [3, 4] as const, { x: -5, y: 60 }],
424
+ ]
425
+
426
+ it('flattens object points to [x, y] rows and bounds them', () => {
427
+ const merge = createScatterplotOptionFactory({ theme })
428
+ const out = merge({}, data) as Out
429
+ expect(out.dataset[0]!.source).toEqual([
430
+ [1, 2],
431
+ [3, 4],
432
+ [-5, 60],
433
+ ])
434
+ expect(out.xAxis.min).toBeLessThanOrEqual(-5)
435
+ expect(out.xAxis.max).toBeGreaterThanOrEqual(3)
436
+ expect(out.yAxis.max).toBeGreaterThanOrEqual(60)
437
+ })
438
+
439
+ it('keeps tuple-only series as the dataset source', () => {
440
+ const merge = createScatterplotOptionFactory({ theme })
441
+ const series = [[1, 2] as const, [3, 4] as const]
442
+ const out = merge({}, [series]) as Out
443
+ expect(out.dataset[0]!.source).toBe(series)
444
+ })
445
+
446
+ it('point colour wins over the series colour; template next; dims', () => {
447
+ const merge = createScatterplotOptionFactory({
448
+ theme,
449
+ series: [{ name: 'S', color: '#0000ff' }],
450
+ selection: ['0:0', '0:1'],
451
+ })
452
+ const out = merge(
453
+ { series: [{ type: 'scatter', itemStyle: { color: '#123456' } }] },
454
+ data,
455
+ ) as Out
456
+ const colorFn = out.series[0]!.itemStyle.color
457
+ expect(colorFn({ dataIndex: 0, color: '#0000ff' })).toBe('#00ff00')
458
+ expect(colorFn({ dataIndex: 1, color: '#0000ff' })).toBe('#123456')
459
+ expect(colorFn({ dataIndex: 2, color: '#0000ff' })).toBe(dim('#123456'))
460
+ })
461
+
462
+ it('calls a function template itemStyle.color via optionsOverride', () => {
463
+ const factory = createScatterplotOptionFactory({
464
+ theme,
465
+ optionsOverride: {
466
+ series: [
467
+ {
468
+ type: 'scatter',
469
+ itemStyle: {
470
+ color: (p: { dataIndex: number }) => `#c${p.dataIndex}`,
471
+ },
472
+ },
473
+ ],
474
+ },
475
+ })
476
+ const out = factory(factory(undefined, undefined), [[[1, 2]]]) as Out
477
+ expect(out.series[0]!.itemStyle.color({ dataIndex: 0, color: '#x' })).toBe(
478
+ '#c0',
479
+ )
480
+ })
481
+
482
+ it('keeps the series / palette colour for plain tuples', () => {
483
+ const merge = createScatterplotOptionFactory({ theme })
484
+ const out = merge({}, [[[1, 2]]]) as Out
485
+ expect(
486
+ out.series[0]!.itemStyle.color({ dataIndex: 0, color: '#abc' }),
487
+ ).toBe('#abc')
488
+ })
489
+ })
@@ -12,10 +12,13 @@ import {
12
12
  import { ZOOM_LAYOUT } from '../actions/zoom-toggle'
13
13
  import type { OptionFactory } from '../echart'
14
14
  import { mergeOptions, resolveThemeColor } from '../utils'
15
+ import { createItemColorResolver } from '../utils/item-color'
16
+ import { getScatterplotXY } from './points'
15
17
  import type {
16
18
  ScatterplotEChartsOption,
17
19
  ScatterplotOptionFactoryInput,
18
20
  ScatterplotOptionsInput,
21
+ ScatterplotItem,
19
22
  ScatterplotWidgetData,
20
23
  } from './types'
21
24
 
@@ -156,7 +159,9 @@ export function createScatterplotOptionFactory(
156
159
  : structural
157
160
  }
158
161
 
159
- const seriesArr = Array.isArray(data) ? (data as ScatterplotWidgetData) : []
162
+ const seriesArr = Array.isArray(data)
163
+ ? (data as ScatterplotWidgetData<ScatterplotItem>)
164
+ : []
160
165
  if (seriesArr.length === 0) {
161
166
  return { ...option, dataset: [], series: [] }
162
167
  }
@@ -198,15 +203,26 @@ export function createScatterplotOptionFactory(
198
203
  // Keeping the key always-present means a plain setOption merge swaps
199
204
  // the callback in place, no `replaceMerge` and no entry-animation
200
205
  // flash on selection on/off.
201
- const makeDimColor =
202
- (seriesIdx: number) => (params: CallbackDataParams) => {
203
- const base = params.color as string
206
+ //
207
+ // The base colour is the point's own `color` (object points), else the
208
+ // template's `itemStyle.color`, else the series colour / palette.
209
+ const seriesTemplates = Array.isArray(option.series) ? option.series : []
210
+ const makeDimColor = (seriesIdx: number, datums: readonly unknown[]) => {
211
+ const baseColor = createItemColorResolver({
212
+ theme,
213
+ datums,
214
+ template: seriesTemplates[seriesIdx] ?? seriesTemplates[0],
215
+ fallback: (params) => params.color as string,
216
+ })
217
+ return (params: CallbackDataParams) => {
218
+ const base = baseColor(params)
204
219
  if (!selectionSet) return base
205
220
  const key = `${seriesIdx}:${params.dataIndex}`
206
221
  return selectionSet.has(key)
207
222
  ? base
208
223
  : echarts.color.modifyAlpha(base, 0.15)
209
224
  }
225
+ }
210
226
 
211
227
  // Zoom slider layout: when ZoomToggle has installed `dataZoom`,
212
228
  // reserve grid space and lift any x-slider above the legend (if
@@ -232,9 +248,15 @@ export function createScatterplotOptionFactory(
232
248
  return {
233
249
  ...option,
234
250
  // ECharts dataset.source wants a mutable [number, number][] shape; we
235
- // hold readonly tuples internally, so cast at the boundary.
236
- dataset: seriesArr.map((s) => ({ source: s as unknown as number[][] })),
237
- series: seriesArr.map((_, i) => {
251
+ // hold readonly tuples internally, so cast at the boundary. Object
252
+ // points are flattened to `[x, y]` so the positional encode and the
253
+ // tooltip keep reading tuples.
254
+ dataset: seriesArr.map((s) => ({
255
+ source: (s.every(Array.isArray)
256
+ ? s
257
+ : s.map(getScatterplotXY)) as unknown as number[][],
258
+ })),
259
+ series: seriesArr.map((s, i) => {
238
260
  const overrideColor = resolveThemeColor(theme, series?.[i]?.color)
239
261
  return {
240
262
  type: 'scatter' as const,
@@ -243,7 +265,7 @@ export function createScatterplotOptionFactory(
243
265
  encode: { x: 0, y: 1 },
244
266
  symbolSize,
245
267
  emphasis: { focus: 'series' },
246
- itemStyle: { color: makeDimColor(i) },
268
+ itemStyle: { color: makeDimColor(i, s) },
247
269
  ...(overrideColor ? { color: overrideColor } : {}),
248
270
  }
249
271
  }),
@@ -386,7 +408,9 @@ function buildScatterTooltipFormatter(
386
408
  })
387
409
  }
388
410
 
389
- function computeScatterBounds(seriesArr: ScatterplotWidgetData): {
411
+ function computeScatterBounds(
412
+ seriesArr: ScatterplotWidgetData<ScatterplotItem>,
413
+ ): {
390
414
  niceMinX: number
391
415
  niceMaxX: number
392
416
  niceMinY: number
@@ -398,8 +422,8 @@ function computeScatterBounds(seriesArr: ScatterplotWidgetData): {
398
422
  let maxY = -Infinity
399
423
  for (const series of seriesArr) {
400
424
  for (const point of series) {
401
- const x = point?.[0]
402
- const y = point?.[1]
425
+ if (point == null) continue
426
+ const [x, y] = getScatterplotXY(point)
403
427
  if (typeof x === 'number' && Number.isFinite(x)) {
404
428
  if (x < minX) minX = x
405
429
  if (x > maxX) maxX = x