@bicharts/chart-host 0.5.75 → 0.5.76

package/dist/react.mjs

@@ -51,6 +51,8 @@ function BicChart(props) {
     d3,
     geoKind,
     viewState,
+    labelContrast,
+    onLabelContrast,
     id,
     filteredBy,
     respondsWith,
@@ -74,6 +76,8 @@ function BicChart(props) {
   rowMapRef.current = built ? built.rowMap : null;
   const onSelectRef = useRef(onSelect);
   onSelectRef.current = onSelect;
+  const onLabelContrastRef = useRef(onLabelContrast);
+  onLabelContrastRef.current = onLabelContrast;
   const [geoTick, setGeoTick] = useState(0);
   useEffect(() => {
     if (!geoKind || geoFromCache(geoKind)) return;
@@ -91,7 +95,17 @@ function BicChart(props) {
   useLayoutEffect(() => {
     const el = ref.current;
     if (!el || !code && !renderFn || !data) return;
-    const host = createChartHost(el, { code, renderFn, data, options, d3, geoKind, viewState });
+    const host = createChartHost(el, {
+      code,
+      renderFn,
+      data,
+      options,
+      d3,
+      geoKind,
+      viewState,
+      labelContrast,
+      onLabelContrast: (r) => onLabelContrastRef.current?.(r)
+    });
     hostRef.current = host;
     const off = host.selection.onChange((payloadIdxs, source) => {
       if (source === "host") return;
@@ -106,7 +120,7 @@ function BicChart(props) {
       host.destroy();
       hostRef.current = null;
     };
-  }, [code, renderFn, d3, geoKind]);
+  }, [code, renderFn, d3, geoKind, labelContrast]);
   const optKey = useMemo(() => JSON.stringify(options ?? {}), [options]);
   useEffect(() => {
     if (hostRef.current && options) hostRef.current.setOptions(options);

package/dist/types/react.d.ts

@@ -25,6 +25,15 @@ export interface BicChartProps {
      * default could pick between them, which is why this is a prop rather than a flag.
      */
     viewState?: ChartHostConfig["viewState"];
+    /**
+     * CAN THE LABELS ON THE MARKS BE READ? Default on: after every render a label sitting on a
+     * mark it cannot be read against is recoloured black or white. Pass `false` for a page that
+     * owns its label colours, or `{ pageBg }` to name the canvas the chart sits on - a dark or
+     * themed page is not white, and readability is measured against it. See createChartHost.
+     */
+    labelContrast?: ChartHostConfig["labelContrast"];
+    /** What the label-contrast pass did after each render - counts, for a page that logs. */
+    onLabelContrast?: ChartHostConfig["onLabelContrast"];
     /** Identity within a <BicChartGroup> — the key other charts filter by. */
     id?: string;
     /** Take this group member's selection as a filter on THIS chart's rows. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bicharts/chart-host",
-  "version": "0.5.75",
+  "version": "0.5.76",
   "description": "Run a BIC-generated D3 chart in any web host: compiles the generated render() function, applies the shared option defaults, resolves mark clicks (through tooltip overlays), owns the selection affordance, and translates row indices between cross-filtered charts. The same contract the BIC Power BI visual implements, minus Power BI. React bindings at @bicharts/chart-host/react.",
   "license": "Apache-2.0",
   "type": "module",