@carto/ps-react-ui 4.25.0 → 4.27.0

package/src/widgets-v2/histogram/transforms.test.ts

@@ -36,15 +36,20 @@ describe('toRelativeHistogramData', () => {
     expect(out[0]?.[1]).toBeCloseTo(-49.74874, 4)
   })
 
-  it('returns the input unchanged when shape does not match number[][]', () => {
+  it('returns the input unchanged when shape does not match HistogramBin[][]', () => {
     expect(toRelativeHistogramData(null)).toBe(null)
     expect(toRelativeHistogramData('not an array')).toBe('not an array')
-    // Series that isn't a flat number array (e.g. named-value or tuple)
-    // is returned as-is — keeps the transform safe to attach to a
-    // widget whose shape changes through other actions.
-    expect(toRelativeHistogramData([[{ name: 'a', value: 10 }]])).toEqual([
-      [{ name: 'a', value: 10 }],
-    ])
+    // Series that isn't a list of bins (e.g. strings or tuples) is returned
+    // as-is — keeps the transform safe to attach to a widget whose shape
+    // changes through other actions.
+    expect(toRelativeHistogramData([['a', 'b']])).toEqual([['a', 'b']])
+    expect(toRelativeHistogramData([[[1, 2]]])).toEqual([[[1, 2]]])
+  })
+
+  it('relativizes object bins, keeping their colour', () => {
+    expect(
+      toRelativeHistogramData([[{ value: 5, color: '#f00' }, 15]]),
+    ).toEqual([[{ value: 25, color: '#f00' }, 75]])
   })
 })
 
@@ -75,6 +80,15 @@ describe('filterHistogramByLockedBins', () => {
     ])
   })
 
+  it('zeroes non-locked object bins, keeping their colour', () => {
+    expect(
+      filterHistogramByLockedBins(
+        [[{ value: 10, color: '#f00' }, { value: 20 }, 30]],
+        [1],
+      ),
+    ).toEqual([[{ value: 0, color: '#f00' }, { value: 20 }, 0]])
+  })
+
   it('returns input unchanged when input is not array-shaped', () => {
     expect(filterHistogramByLockedBins('nope', [0])).toBe('nope')
   })

package/src/widgets-v2/histogram/transforms.ts

@@ -1,6 +1,14 @@
+import {
+  getHistogramBinValue,
+  isHistogramBin,
+  withHistogramBinValue,
+} from './bins'
+import type { HistogramBin } from './types'
+
 /**
  * Histogram-specific `RelativeData` transform. Histogram data is
- * `number[][]` — each series is a flat list of bin counts. This
+ * `HistogramBin[][]` — each series is a flat list of bin counts (plain
+ * numbers or `{ value, color? }`, whose shape is kept). This
  * rewrites each count to its share of the series total (0–100), so
  * pairing with `createPercentFormatter` renders the y-axis as
  * percentages.
@@ -11,27 +19,31 @@
  * inputs produce sane signed shares-of-magnitude. A series whose total
  * magnitude is zero (all-zero or empty input) is returned unchanged so
  * a stalled or empty data set doesn't show misleading 0% values. Inputs
- * whose shape isn't `number[][]` fall through untouched (same defensive
+ * whose shape isn't `HistogramBin[][]` fall through untouched (same defensive
  * shape-check pattern as the default transform).
  */
 export const toRelativeHistogramData = (input: unknown): unknown => {
   if (!Array.isArray(input)) return input
   return input.map((series: unknown): unknown => {
-    if (!isFlatNumberArray(series)) return series
-    const total = series.reduce((acc, v) => acc + Math.abs(v), 0)
+    if (!isBinArray(series)) return series
+    const total = series.reduce<number>(
+      (acc, b) => acc + Math.abs(getHistogramBinValue(b)),
+      0,
+    )
     if (total <= 0) return series
-    return series.map((v) => (v / total) * 100)
+    return series.map((b) =>
+      withHistogramBinValue(b, (getHistogramBinValue(b) / total) * 100),
+    )
   })
 }
 
-function isFlatNumberArray(v: unknown): v is number[] {
-  if (!Array.isArray(v)) return false
-  return v.every((item) => typeof item === 'number' && Number.isFinite(item))
+function isBinArray(v: unknown): v is HistogramBin[] {
+  return Array.isArray(v) && v.every(isHistogramBin)
 }
 
 /**
- * `LockSelection` filter for Histogram. Data is `number[][]` — a flat list
- * of bin counts per series, positionally paired with `ticks` (bin `i` covers
+ * `LockSelection` filter for Histogram. Data is `HistogramBin[][]` — a flat
+ * list of bin counts per series, positionally paired with `ticks` (bin `i` covers
  * `[ticks[i], ticks[i+1])`). Unlike name-keyed widgets, locked-out bins can't
  * be REMOVED — that would shift every later bin's index and desync it from
  * its `ticks` range. Zeroing them out instead preserves array length/position,
@@ -47,7 +59,9 @@ export function filterHistogramByLockedBins(
   if (!Array.isArray(input)) return input
   const locked = new Set<number>(lockedItems.map(Number))
   return input.map((series: unknown): unknown => {
-    if (!isFlatNumberArray(series)) return series
-    return series.map((count, i) => (locked.has(i) ? count : 0))
+    if (!isBinArray(series)) return series
+    return series.map((bin, i) =>
+      locked.has(i) ? bin : withHistogramBinValue(bin, 0),
+    )
   })
 }

package/src/widgets-v2/histogram/types.ts

@@ -3,12 +3,32 @@ import type { EChartsOption } from 'echarts'
 import type { WidgetSeries } from '../types'
 
 /**
- * Histogram widget data — array of series, each a flat array of bin counts.
- * The option factory's merge phase (see {@link createHistogramOptionFactory})
- * combines this with `ticks` to produce a 2-column dataset (`[binLabel, count]`)
- * for ECharts.
+ * One histogram bin: either its count, or `{ value, color? }` to give the
+ * bar its own colour (CSS colour or theme palette path such as
+ * `'primary.main'`). A bin `color` wins over the template's
+ * `itemStyle.color` and the series colour; selection dimming still applies.
  */
-export type HistogramWidgetData = readonly (readonly number[])[]
+export type HistogramBin = number | HistogramBinObject
+
+/** Object form of a {@link HistogramBin}. */
+export interface HistogramBinObject {
+  value: number
+  color?: string
+}
+
+/**
+ * Histogram widget data — array of series, each a flat array of bins. The
+ * option factory's merge phase (see {@link createHistogramOptionFactory})
+ * combines this with `ticks` to produce a 2-column dataset
+ * (`[binLabel, count]`) for ECharts.
+ *
+ * Defaults to plain counts (`number[][]`) so existing code that reads bins
+ * as numbers keeps type-checking; use `HistogramWidgetData<HistogramBin>`
+ * to also accept `{ value, color? }` bins. Every histogram API (option
+ * factory, transforms, download) accepts both forms.
+ */
+export type HistogramWidgetData<B extends HistogramBin = number> =
+  readonly (readonly B[])[]
 
 /** Inputs to the structural-only {@link histogramOptions} builder. */
 export interface HistogramOptionsInput {

package/src/widgets-v2/index.ts

@@ -155,6 +155,7 @@ export type {
   ZoomToggleProps,
   BrushToggleProps,
   RelativeDataProps,
+  RelativeScale,
   DownloadProps,
   DownloadItem,
   DownloadContext,
@@ -175,7 +176,12 @@ export type {
 export type { MarkdownUIProps, MarkdownWidgetData } from './markdown'
 export type { PieDatum, PieWidgetData } from './pie'
 export type { TimeseriesDatum, TimeseriesWidgetData } from './timeseries'
-export type { ScatterplotDatum, ScatterplotWidgetData } from './scatterplot'
+export type {
+  ScatterplotDatum,
+  ScatterplotPoint,
+  ScatterplotItem,
+  ScatterplotWidgetData,
+} from './scatterplot'
 export type {
   SpreadUIProps,
   SpreadDataItem,

package/src/widgets-v2/pie/options.test.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect } from 'vitest'
+import * as echarts from 'echarts'
 import { createTheme, type Theme } from '@mui/material'
 import { createPieOptionFactory, pieOptions } from './options'
 
@@ -936,3 +937,93 @@ describe('createPieOptionFactory — multi-series fallback (horizontal bar)', ()
     })
   })
 })
+
+describe('createPieOptionFactory — per-item colour', () => {
+  interface Out {
+    series: { itemStyle: { color: (p: unknown) => string } }[]
+  }
+  const dim = (c: string) => echarts.color.modifyAlpha(c, 0.15)
+  const palette = ['#p0', '#p1', '#p2']
+
+  it('donut: slice colour wins over the palette; template next', () => {
+    const merge = createPieOptionFactory({ theme, selection: ['A', 'B'] })
+    const out = merge(
+      {
+        color: palette,
+        series: [{ type: 'pie', itemStyle: { color: '#123456' } }],
+      },
+      [
+        [
+          { name: 'A', value: 1, color: '#00ff00' },
+          { name: 'B', value: 2 },
+          { name: 'C', value: 3 },
+        ],
+      ],
+    ) as Out
+    const colorFn = out.series[0]!.itemStyle.color
+    expect(colorFn({ dataIndex: 0, name: 'A', color: '#x' })).toBe('#00ff00')
+    expect(colorFn({ dataIndex: 1, name: 'B', color: '#x' })).toBe('#123456')
+    expect(colorFn({ dataIndex: 2, name: 'C', color: '#x' })).toBe(
+      dim('#123456'),
+    )
+  })
+
+  it('donut: keeps the per-data palette when no item colour is given', () => {
+    const merge = createPieOptionFactory({ theme })
+    const out = merge({ color: palette }, [
+      [
+        { name: 'A', value: 1, color: '#00ff00' },
+        { name: 'B', value: 2 },
+      ],
+    ]) as Out
+    const colorFn = out.series[0]!.itemStyle.color
+    expect(colorFn({ dataIndex: 0, name: 'A', color: '#x' })).toBe('#00ff00')
+    expect(colorFn({ dataIndex: 1, name: 'B', color: '#x' })).toBe('#p1')
+  })
+
+  it('donut: template itemStyle.color callback via optionsOverride', () => {
+    const factory = createPieOptionFactory({
+      theme,
+      optionsOverride: {
+        series: [
+          {
+            type: 'pie',
+            itemStyle: {
+              color: (p: { dataIndex: number }) => `#c${p.dataIndex}`,
+            },
+          },
+        ],
+      },
+    })
+    const out = factory(factory(undefined, undefined), [
+      [{ name: 'A', value: 1 }],
+    ]) as Out
+    expect(
+      out.series[0]!.itemStyle.color({ dataIndex: 0, name: 'A', color: '#x' }),
+    ).toBe('#c0')
+  })
+
+  it('multi-series bar fallback: datum colour wins over the series palette', () => {
+    const merge = createPieOptionFactory({ theme, selection: ['B'] })
+    const out = merge({ color: palette }, [
+      [{ name: 'A', value: 1, color: '#00ff00' }],
+      [{ name: 'A', value: 2 }],
+    ]) as Out
+    expect(
+      out.series[0]!.itemStyle.color({
+        dataIndex: 0,
+        seriesIndex: 0,
+        name: 'A',
+        color: '#x',
+      }),
+    ).toBe(dim('#00ff00'))
+    expect(
+      out.series[1]!.itemStyle.color({
+        dataIndex: 0,
+        seriesIndex: 1,
+        name: 'B',
+        color: '#x',
+      }),
+    ).toBe('#p1')
+  })
+})

package/src/widgets-v2/pie/options.ts

@@ -12,6 +12,7 @@ import {
 } from '../../widgets/utils/chart-config'
 import type { OptionFactory, OptionFactoryContext } from '../echart'
 import { mergeOptions, resolveThemeColor } from '../utils'
+import { createItemColorResolver } from '../utils/item-color'
 import type { WidgetSeries } from '../types'
 import type {
   PieEChartsOption,
@@ -168,6 +169,7 @@ export function createPieOptionFactory(
     return buildSingleSeriesPieFusion(
       option,
       seriesArr,
+      theme,
       radius,
       series,
       ctx,
@@ -185,6 +187,7 @@ export function createPieOptionFactory(
 function buildSingleSeriesPieFusion(
   option: EChartsOption,
   seriesArr: PieWidgetData,
+  theme: Theme,
   radius: readonly [string, string],
   series: readonly WidgetSeries[] | undefined,
   ctx: OptionFactoryContext | undefined,
@@ -231,14 +234,25 @@ function buildSingleSeriesPieFusion(
   // empty Set — the collapse above (`selection.length === 0 → null`) rules
   // that out — so there's no "dim everything" case here, unlike a widget
   // that gives `[]` its own "selected down to nothing" meaning.
-  const colorFn = (params: CallbackDataParams): string => {
-    const base = resolvePaletteColor(params)
-    if (!selectionSet) return base
-    const datum = params.value as { name?: string | number } | undefined
-    const name = datum?.name ?? params.name
-    return name != null && selectionSet.has(name)
-      ? base
-      : echarts.color.modifyAlpha(base, 0.15)
+  //
+  // The base colour is the slice's own `color`, else the template's
+  // `itemStyle.color`, else the per-data palette swatch.
+  const makeColorFn = (datums: readonly object[], template: unknown) => {
+    const baseColor = createItemColorResolver({
+      theme,
+      datums,
+      template,
+      fallback: resolvePaletteColor,
+    })
+    return (params: CallbackDataParams): string => {
+      const base = baseColor(params)
+      if (!selectionSet) return base
+      const datum = params.value as { name?: string | number } | undefined
+      const name = datum?.name ?? params.name
+      return name != null && selectionSet.has(name)
+        ? base
+        : echarts.color.modifyAlpha(base, 0.15)
+    }
   }
 
   // ECharts anchors EVERY slice's `position: 'center'` label at the same
@@ -316,7 +330,7 @@ function buildSingleSeriesPieFusion(
   return {
     ...option,
     dataset: seriesArr.map((s) => ({ source: s as readonly object[] })),
-    series: seriesArr.map((_, i) => {
+    series: seriesArr.map((s, i) => {
       const template =
         (seriesTemplates[i] as object | undefined) ??
         (broadcastTemplate as object)
@@ -344,7 +358,7 @@ function buildSingleSeriesPieFusion(
         },
         itemStyle: {
           ...templateItemStyle,
-          color: colorFn,
+          color: makeColorFn(s, templateObj),
         },
       }
     }),
@@ -419,17 +433,31 @@ function buildMultiSeriesBarFusion(
   const palette = Array.isArray(option.color)
     ? (option.color as readonly (string | undefined)[])
     : []
-  const barColorFn = (params: CallbackDataParams): string => {
+  // The base colour is the datum's own `color`, else the template's
+  // `itemStyle.color`, else the per-series palette swatch.
+  const seriesTemplates = Array.isArray(option.series) ? option.series : []
+  const paletteColor = (params: CallbackDataParams): string => {
     const seriesIdx = params.seriesIndex ?? 0
     const seriesSwatch =
       palette.length > 0 ? palette[seriesIdx % palette.length] : undefined
-    const base = (seriesSwatch ?? params.color) as string
-    if (!selectionSet) return base
-    const datum = params.value as { name?: string | number } | undefined
-    const name = datum?.name ?? params.name
-    return name != null && selectionSet.has(name)
-      ? base
-      : echarts.color.modifyAlpha(base, 0.15)
+    return (seriesSwatch ?? params.color) as string
+  }
+  const makeBarColorFn = (datums: readonly object[], template: unknown) => {
+    const baseColor = createItemColorResolver({
+      theme,
+      datums,
+      template,
+      fallback: paletteColor,
+    })
+    return (params: CallbackDataParams): string => {
+      const base = baseColor(params)
+      if (!selectionSet) return base
+      const datum = params.value as { name?: string | number } | undefined
+      const name = datum?.name ?? params.name
+      return name != null && selectionSet.has(name)
+        ? base
+        : echarts.color.modifyAlpha(base, 0.15)
+    }
   }
 
   return {
@@ -444,7 +472,7 @@ function buildMultiSeriesBarFusion(
     // Drop pie-specific structural keys that shouldn't render in the
     // bar fallback. ECharts ignores undefined keys, so this is a clean
     // override.
-    series: seriesArr.map((_, i) => {
+    series: seriesArr.map((s, i) => {
       const overrideColor = resolveThemeColor(theme, series?.[i]?.color)
       return {
         datasetIndex: i,
@@ -454,7 +482,9 @@ function buildMultiSeriesBarFusion(
         legendHoverLink: false,
         emphasis: { focus: 'series' },
         ...buildSeriesLabelConfig(formatter, 'x'),
-        itemStyle: { color: barColorFn },
+        itemStyle: {
+          color: makeBarColorFn(s, seriesTemplates[i] ?? seriesTemplates[0]),
+        },
         ...(overrideColor ? { color: overrideColor } : {}),
       }
     }),

package/src/widgets-v2/pie/types.ts

@@ -6,6 +6,12 @@ import type { WidgetSeries } from '../types'
 export interface PieDatum {
   name: string | number
   value: number
+  /**
+   * Optional colour for this item (CSS colour or theme palette path such as
+   * `'primary.main'`). Wins over the template's `itemStyle.color` and the
+   * series colour; selection dimming still applies on top.
+   */
+  color?: string
 }
 
 /** Pie widget data — one slice array per series (rendered as side-by-side donuts). */

package/src/widgets-v2/scatterplot/download.test.ts

@@ -61,6 +61,15 @@ describe('createScatterplotDownloadConfig', () => {
     )
   })
 
+  it('CSV writes x/y of object points (colour is not exported)', async () => {
+    const items = createScatterplotDownloadConfig({
+      filename: 's',
+      getData: () => [[{ x: 1, y: 10, color: '#f00' }, [2, 20]]],
+    })
+    await items.find((i) => i.id === 'csv')!.resolve({ id: null })
+    expect(csvText).toBe('series,x,y\nseries_1,1,10\nseries_1,2,20')
+  })
+
   it('CSV honours supplied seriesNames', async () => {
     const items = createScatterplotDownloadConfig({
       filename: 's',

package/src/widgets-v2/scatterplot/download.ts

@@ -4,7 +4,8 @@ import {
   type DownloadContext,
   type DownloadItem,
 } from '../actions/download'
-import type { ScatterplotWidgetData } from './types'
+import { getScatterplotXY } from './points'
+import type { ScatterplotItem, ScatterplotWidgetData } from './types'
 
 /**
  * Download menu items for the Scatterplot widget. Always includes a CSV
@@ -14,7 +15,7 @@ import type { ScatterplotWidgetData } from './types'
  */
 export function createScatterplotDownloadConfig(args: {
   filename: string
-  getData: (ctx: DownloadContext) => ScatterplotWidgetData
+  getData: (ctx: DownloadContext) => ScatterplotWidgetData<ScatterplotItem>
   seriesNames?: readonly string[]
   getCaptureEl?: (ctx: DownloadContext) => HTMLElement | null
   pngPixelRatio?: number
@@ -39,7 +40,8 @@ export function createScatterplotDownloadConfig(args: {
         const rows: unknown[][] = [['series', 'x', 'y']]
         for (const [i, series] of data.entries()) {
           const seriesName = args.seriesNames?.[i] ?? `series_${i + 1}`
-          for (const [x, y] of series) {
+          for (const point of series) {
+            const [x, y] = getScatterplotXY(point)
             rows.push([seriesName, x, y])
           }
         }

package/src/widgets-v2/scatterplot/index.ts

@@ -5,8 +5,11 @@ export {
   toRelativeScatterplotData,
   filterScatterplotByLockedPoints,
 } from './transforms'
+export { getScatterplotXY } from './points'
 export type {
   ScatterplotDatum,
+  ScatterplotPoint,
+  ScatterplotItem,
   ScatterplotWidgetData,
   ScatterplotOptionsInput,
   ScatterplotOptionFactoryInput,

package/src/widgets-v2/scatterplot/options.test.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect } from 'vitest'
+import * as echarts from 'echarts'
 import { createTheme, type Theme } from '@mui/material'
 import { createScatterplotOptionFactory, scatterplotOptions } from './options'
 
@@ -212,6 +213,18 @@ describe('createScatterplotOptionFactory', () => {
     expect(out.yAxis.min).toBe(0)
   })
 
+  it("pins the y ends a config transform set (RelativeData 'total')", () => {
+    const merge = createScatterplotOptionFactory({ theme })
+    const out = merge({ yAxis: { min: -100, max: 100 } }, [
+      [
+        [1, 47],
+        [2, 3],
+      ],
+    ]) as { yAxis: { min: number; max: number } }
+    expect(out.yAxis.max).toBe(100)
+    expect(out.yAxis.min).toBe(0)
+  })
+
   it('always emits itemStyle.color as a callback (passthrough when no selection)', () => {
     const merge = createScatterplotOptionFactory({ theme })
     const out = merge({}, [[[1, 2]]]) as {
@@ -409,3 +422,80 @@ describe('createScatterplotOptionFactory', () => {
     expect(insideOnly.grid.right).toBe(baseline.grid.right)
   })
 })
+
+describe('createScatterplotOptionFactory — per-item colour', () => {
+  interface Out {
+    dataset: { source: number[][] }[]
+    series: { itemStyle: { color: (p: unknown) => string } }[]
+    xAxis: { min: number; max: number }
+    yAxis: { min: number; max: number }
+  }
+  const dim = (c: string) => echarts.color.modifyAlpha(c, 0.15)
+  const data = [
+    [{ x: 1, y: 2, color: '#00ff00' }, [3, 4] as const, { x: -5, y: 60 }],
+  ]
+
+  it('flattens object points to [x, y] rows and bounds them', () => {
+    const merge = createScatterplotOptionFactory({ theme })
+    const out = merge({}, data) as Out
+    expect(out.dataset[0]!.source).toEqual([
+      [1, 2],
+      [3, 4],
+      [-5, 60],
+    ])
+    expect(out.xAxis.min).toBeLessThanOrEqual(-5)
+    expect(out.xAxis.max).toBeGreaterThanOrEqual(3)
+    expect(out.yAxis.max).toBeGreaterThanOrEqual(60)
+  })
+
+  it('keeps tuple-only series as the dataset source', () => {
+    const merge = createScatterplotOptionFactory({ theme })
+    const series = [[1, 2] as const, [3, 4] as const]
+    const out = merge({}, [series]) as Out
+    expect(out.dataset[0]!.source).toBe(series)
+  })
+
+  it('point colour wins over the series colour; template next; dims', () => {
+    const merge = createScatterplotOptionFactory({
+      theme,
+      series: [{ name: 'S', color: '#0000ff' }],
+      selection: ['0:0', '0:1'],
+    })
+    const out = merge(
+      { series: [{ type: 'scatter', itemStyle: { color: '#123456' } }] },
+      data,
+    ) as Out
+    const colorFn = out.series[0]!.itemStyle.color
+    expect(colorFn({ dataIndex: 0, color: '#0000ff' })).toBe('#00ff00')
+    expect(colorFn({ dataIndex: 1, color: '#0000ff' })).toBe('#123456')
+    expect(colorFn({ dataIndex: 2, color: '#0000ff' })).toBe(dim('#123456'))
+  })
+
+  it('calls a function template itemStyle.color via optionsOverride', () => {
+    const factory = createScatterplotOptionFactory({
+      theme,
+      optionsOverride: {
+        series: [
+          {
+            type: 'scatter',
+            itemStyle: {
+              color: (p: { dataIndex: number }) => `#c${p.dataIndex}`,
+            },
+          },
+        ],
+      },
+    })
+    const out = factory(factory(undefined, undefined), [[[1, 2]]]) as Out
+    expect(out.series[0]!.itemStyle.color({ dataIndex: 0, color: '#x' })).toBe(
+      '#c0',
+    )
+  })
+
+  it('keeps the series / palette colour for plain tuples', () => {
+    const merge = createScatterplotOptionFactory({ theme })
+    const out = merge({}, [[[1, 2]]]) as Out
+    expect(
+      out.series[0]!.itemStyle.color({ dataIndex: 0, color: '#abc' }),
+    ).toBe('#abc')
+  })
+})