@bicharts/chart-host 0.6.113 → 0.6.115

package/dist/types/selectionMarker.d.ts

@@ -0,0 +1,92 @@
+/** The reader's choice for every chart. */
+export type SelectionMarkerChoice = "auto" | "none" | "dot" | "check" | "outline";
+/** The reader's choice for region maps. */
+export type MapSelectionMarkerChoice = "none" | "dot" | "check" | "outline";
+/** What a chart is given, once the choice meets the chart. */
+export type SelectionMarker = "none" | "dot" | "check" | "outline";
+/** The default for every chart: an outline where the chart's ramp has a neutral centre, nothing elsewhere. */
+export declare const SELECTION_MARKER_DEFAULT: SelectionMarkerChoice;
+/** The default for region maps: an outline. */
+export declare const MAP_SELECTION_MARKER_DEFAULT: MapSelectionMarkerChoice;
+/** The choice for every chart from an untrusted value: one of the five words in any case, else the default. */
+export declare function readSelectionMarker(raw: unknown): SelectionMarkerChoice;
+/** The choice for region maps from an untrusted value: one of the four words in any case, else the default. */
+export declare function readMapSelectionMarker(raw: unknown): MapSelectionMarkerChoice;
+/** The column the host adds to a region map's rows: each row's region code, joined to the geometry. */
+export declare const REGION_JOIN_COLUMN = "__geoIso__";
+/** Whether the chart's data joins its rows to regions (a choropleth, a cartogram, a province map). */
+export declare function isRegionMapData(data: {
+    columns?: readonly ({
+        name?: unknown;
+    } | null | undefined)[] | null;
+} | null | undefined): boolean;
+/** The legend the shared value ramp draws for a diverging scale: its centre colour is a neutral just off the canvas. */
+export declare const NEUTRAL_CENTRE_RAMP_SELECTOR = ".llm-value-ramp[data-kind=\"diverging\"]";
+/** Whether the drawn chart declares a colour ramp with a neutral centre. */
+export declare function hasNeutralCentreRamp(container: Element | null | undefined): boolean;
+/** What marks this chart's selection: the map choice on a region map, else the general choice with "auto" decided. */
+export declare function selectionMarkerFor(facts: {
+    choice?: unknown;
+    mapChoice?: unknown;
+    regionMap: boolean;
+    neutralCentreRamp: boolean;
+}): SelectionMarker;
+/** The class on the host's outline layer (one svg in the overlay). */
+export declare const SELECTION_OUTLINE_CLASS = "lch-sel-outline";
+/** Whether `el` is an AREA mark: a path, rect or polygon whose interior is painted. A line (fill none), a point
+ *  (a circle or an ellipse) and a group are not. Reads the computed fill where the platform resolves it, else the
+ *  element's own attribute and inline style; an element with no fill at all is filled, as SVG paints it. */
+export declare function isAreaMark(el: Element): boolean;
+/** Which selected marks get an outline, for a host that draws its own layer: `shown` drops a mark the reader can't see. */
+export interface OutlineMarkFilter {
+    shown?(mark: Element): boolean;
+}
+/**
+ * The selected area marks in `container`, in document order. A selected mark that is a group stands for the filled
+ * shapes inside it. A selected mark whose box strictly encloses another selected mark is a hierarchy's backdrop (a
+ * treemap's parent tile), whose children carry the outlines, and is left out - checked up to 300 marks, as the glyphs
+ * check it.
+ */
+export declare function collectOutlineMarks(container: Element, filter?: OutlineMarkFilter): Element[];
+type ClientWindow = {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+};
+/** The window a mark is seen through, in client coordinates: its outermost svg's box, narrowed by every clip-path on
+ *  the way up to `stop`. Null when nothing measures (the outline then draws unclipped). */
+export declare function outlineWindowOf(mark: Element, stop?: Element | null): ClientWindow | null;
+export interface SelectionOutlineStyle {
+    /** The outline's colour: the chart's text colour. */
+    color: string;
+    /** The halo under it, in the canvas colour, so it reads on a dark and a light region alike. */
+    halo: string;
+    /** The outline's width in screen pixels. Default 2. */
+    width?: number;
+    /** At most this many are drawn. Default 600, which keeps the DOM light on a huge selection. */
+    max?: number;
+    /** The window each outline is clipped to, in client coordinates, or null for none. Default: outlineWindowOf. */
+    windowOf?(mark: Element): ClientWindow | null;
+    /** Boxes the outline never paints over, in client coordinates: the chart's own controls (controlBoxesIn). */
+    avoid?: readonly ClientWindow[];
+}
+/**
+ * Where a chart's OWN CONTROLS are, in client coordinates: every element it declares a control (CONTROL_CLASS - a map's
+ * zoom pad, a pager, a flip arrow), grown by `pad` px, and boxes within `join` px of each other merged, so a pad of
+ * buttons is one box and no sliver of an outline shows between its buttons. A selection outline is never painted over
+ * them: a mark on the reader's chart must not cover the button that moves it.
+ */
+export declare function controlBoxesIn(root: Element | null | undefined, opts?: {
+    pad?: number;
+    join?: number;
+}): ClientWindow[];
+/**
+ * Draws an outline around each mark (up to `max`) into `overlay`: one svg layer positioned from the overlay's own
+ * top-left corner, never hit-tested and hidden from assistive technology. Each outline is the mark's own shape, placed
+ * through the mark's screen matrix, so it lands on the mark however the chart transformed it; its stroke keeps its
+ * width at any zoom. Returns how many it drew: a mark with no screen matrix or no geometry is skipped. It does not
+ * clear the overlay first: a host clears it (clearSelectionGlyphs) before deciding whether to paint at all.
+ */
+export declare function paintSelectionOutlines(overlay: Element, marks: readonly Element[], style: SelectionOutlineStyle): number;
+export {};

package/dist/zoom-memory.mjs

@@ -1,7 +1,7 @@
 /*! @bicharts/chart-host — Apache-2.0. Bundled reference data: GeoNames (https://www.geonames.org/) CC BY 4.0; Natural Earth and US Census/TIGER (public domain). Full text: NOTICE in this package. */
 import {
   K
-} from "./chunk-FIG5DIW7.mjs";
+} from "./chunk-VPFP35XI.mjs";
 import "./chunk-GHODWOAL.mjs";
 
 // src/zoomMemory/zoomMemory.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bicharts/chart-host",
-  "version": "0.6.113",
+  "version": "0.6.115",
   "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",