@bicharts/chart-host 0.6.115 → 0.6.117

package/dist/types/filterScope.d.ts

@@ -16,7 +16,11 @@ export interface FilterOptions {
     display?: string | readonly string[];
     /** A stable id for this filter within its scope. Generated when absent. */
     id?: string;
-    /** Its name in a saved view (scope.save / a link). Defaults to the key columns joined with "+". */
+    /**
+     * Its name in a saved view (scope.save / a link). Defaults to the key columns joined with "+". Two filters in one
+     * scope never share a name there: the second with one name is saved as "<name>-2", the third "<name>-3", in the order
+     * they joined the scope, so each puts back its own pick (FilterScope.keyOf says which name a filter has).
+     */
     key?: string;
     /**
      * LINKED HOVER: hovering a mark on a chart bound to this filter lights the marks with the same key on every other
@@ -124,6 +128,11 @@ export interface FilterScope {
     save(): PageView;
     /** Put a saved view back: each filter set (or cleared when the view doesn't name it), each controls set. */
     restore(view: PageView | null | undefined): void;
+    /**
+     * A filter's name in this scope's saved views: its key, or "<key>-2", "<key>-3"... for the second and later filters
+     * with one key, in the order they joined the scope. Null for a filter not in the scope.
+     */
+    keyOf?(filter: Filter): string | null;
 }
 /** A saved page view: what save() returns and restore() takes. */
 export interface PageView {

package/dist/types/fit.d.ts

@@ -90,11 +90,16 @@ export type AxisPinEdge = "top" | "bottom";
  * one drawn over it.
  */
 export declare function axisPinPlacement(band: AxisBand, scrollTop: number, viewportH: number): AxisPinEdge | null;
-/** A reader's scroll offsets and the identity of the chart they were made on. */
+/** A reader's scroll offsets and the identity of the chart they were made on. `inner` holds the offsets of the chart's own
+ *  scrollers (TABLE_SCROLLER_CLASS), in document order, when any of them was scrolled; absent otherwise. */
 export interface ScrollMemory {
     key: unknown;
     x: number;
     y: number;
+    inner?: ReadonlyArray<{
+        x: number;
+        y: number;
+    }>;
 }
 /** What the container reports once the overflow is decided. */
 export interface ScrollMetrics {

package/dist/types/fitDom.d.ts

@@ -113,8 +113,21 @@ export declare function unpinScrolledAxis(container: HTMLElement | null | undefi
  * Remember where the container is scrolled, BEFORE the container is cleared. A memory already waiting is kept: a second render that
  * starts before the first one restored sees an emptied (unscrolled) container, and must not overwrite what the reader really did.
  * A diagram that scrolls inside itself remembers its own position, so it is left alone.
+ * A table scrolls its rows inside its own frame (TABLE_SCROLLER_CLASS) while the container stays at the top, so those offsets
+ * are kept too, in document order, whenever one of them is scrolled; restoreInnerScroll puts them back.
  */
 export declare function rememberScroll(container: HTMLElement | null | undefined, key: unknown): void;
+/**
+ * Put a table's own scroll back after the SAME chart has drawn again: each element carrying TABLE_SCROLLER_CLASS gets the
+ * offsets its counterpart (by document order) had in `memory`. Nothing happens for a different chart (another key), a memory
+ * with no inner offsets, or a chart with no such element, so a new chart opens at the top. The browser clamps an offset the new
+ * layout cannot reach. Call it once the chart has drawn, with the memory takeScroll returned. Returns the offsets the scrollers
+ * report afterwards, or null when nothing was restored. Never throws.
+ */
+export declare function restoreInnerScroll(container: HTMLElement | null | undefined, memory: ScrollMemory | null | undefined, key: unknown): Array<{
+    x: number;
+    y: number;
+}> | null;
 /** The waiting memory, removed. The one place it is consumed, so a stale memory can never outlive a render. */
 export declare function takeScroll(container: HTMLElement | null | undefined): ScrollMemory | null;
 export declare function pinScrolledAxis(container: HTMLElement | null | undefined, svg: SVGSVGElement | null | undefined): AxisPinReport;

package/dist/types/host.d.ts

@@ -23,6 +23,7 @@ export interface SelectionPaintReport {
 import { type MarkCensus } from "./blankRender";
 import { type HitBandCensus } from "./hitBands";
 import { type ColourSpreadCensus } from "./colourSpread";
+import type { CategoryColourCensus } from "./categoryColours";
 import { type ClippedTextCensus } from "./clippedText";
 import { type ValuePlacementCensus } from "./valuePlacement";
 import { type FitRenderedChartOptions, type FitRenderedChartResult } from "./fitDom";
@@ -150,6 +151,15 @@ export interface ChartHostConfig {
      * own skew is measured on the raw column while the ramp encodes an aggregate.
      */
     onColourSpreadCensus?: (census: ColourSpreadCensus) => void;
+    /**
+     * HOW CLOSE ARE THE TWO CLOSEST CATEGORY COLOURS, AS PAINTED? Runs after every render, counts only, never repaints;
+     * the census loads on first use, so the report arrives a tick after the render rather than inside it.
+     * One colour per category (the legend's swatches, else the marks' distinct colours), the closest pair by CIEDE2000
+     * at full strength, over the page at each element's own opacity, and at the dim level a selection applies. Generated
+     * code can build its own scale or draw at partial opacity, so the palette that was checked is not always what a
+     * reader compares. Declines on a sequential ramp or a continuous colour channel.
+     */
+    onCategoryColourCensus?: (census: CategoryColourCensus) => void;
     /**
      * IS ANY TEXT CUT OFF BY THE FRAME? Runs after every render, counts only, and never moves anything: a title
      * drawn above its own origin is clipped without anything throwing, so only a measurement against the SVG box

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { HOST_CONTRACT_VERSION, GEO_POINT_PRECISIONS, MARK_CLASS, LEGEND_MARK_CLASS, AXIS_FILTER_CLASS, ROW_IDX_ATTR, LIFT_SELECTED_CLASS, CONTROL_CLASS, NO_ROW_MARKS_ATTR, NOTE_STYLE_ATTR, SELECTION_RULE_ATTR, SELECTION_RULE_CLICKED_MARKS, MARK_KEY_ATTR, CONTAINER_SLOT_CLICKED_MARKS, SNAPSHOT_SVG_ATTR, XFILTER_REFRESH_EVENT, CONTAINER_SLOT_ANIM_STOP, CONTAINER_SLOT_XF_CLEAR, CONTAINER_SLOT_INITIAL_XF_MARK, CONTAINER_SLOT_UI_STATE, CONTAINER_SLOT_SCROLL, CONTAINER_SLOT_HOST_SELECTION, VIEW_ONLY_UI_STATE_KEYS, withoutViewOnlyKeys, HOST_CONTAINER_CLASS, SELECTION_ACTIVE_CLASS, MARK_SELECTED_CLASS, MARKS_INERT_CLASS, ACTIVE_TICK_CLASS, DIM_OPACITY_VAR, DIM_OPACITY_DEFAULT, DIM_OPACITY_MIN, chartOwnsTimeline, periodTickSuppressesFeedback, ANIM_PLAY_SPEED_DEFAULT, ANIM_PLAY_SPEED_MIN, ANIM_PLAY_SPEED_MAX, ANIM_LOOP_DELAY_DEFAULT, ANIM_LOOP_DELAY_MIN, ANIM_MAX_IDEAL_FRAMES_DEFAULT, ANIM_MAX_IDEAL_FRAMES_MIN, ANIM_MAX_IDEAL_FRAMES_MAX, ANIMATION_OPTION_KEYS, COLOR_SCALE_SELF_CLAMP_PCT_DEFAULT, COLOR_SCALE_SELF_CLAMP_PCT_MIN, COLOR_SCALE_SELF_CLAMP_PCT_MAX, FLIP_MODE_DEFAULT, FLIP_INTERVAL_MIN_MS, FLIP_INTERVAL_MAX_MS, FLIP_DIRECTION_DEFAULT, APPROXIMATE_POSITIONS_DEFAULT, VALUE_AXIS_BASELINE_DEFAULT, SEASONAL_MARKERS_DEFAULT, MAX_MAP_POINTS_DEFAULT, type GeoPointPrecision, type GeoMapKind, type TimelineStyle, type FlipMode, type FlipDirection, type ApproximatePositions, type ValueAxisBaseline, type SeasonalMarkers, type ColorScaleScope, type RenderOptions, type ViewStateProvider, type ChartControlChange, type XfilterRefreshDetail, type HostSelectionFact, type FilterScopeFact, } from "./contract";
+export { HOST_CONTRACT_VERSION, GEO_POINT_PRECISIONS, MARK_CLASS, LEGEND_MARK_CLASS, AXIS_FILTER_CLASS, ROW_IDX_ATTR, LIFT_SELECTED_CLASS, CONTROL_CLASS, NO_ROW_MARKS_ATTR, NOTE_STYLE_ATTR, SELECTION_RULE_ATTR, SELECTION_RULE_CLICKED_MARKS, MARK_KEY_ATTR, CONTAINER_SLOT_CLICKED_MARKS, SNAPSHOT_SVG_ATTR, XFILTER_REFRESH_EVENT, CONTAINER_SLOT_ANIM_STOP, CONTAINER_SLOT_XF_CLEAR, CONTAINER_SLOT_INITIAL_XF_MARK, CONTAINER_SLOT_UI_STATE, CONTAINER_SLOT_SCROLL, TABLE_SCROLLER_CLASS, CONTAINER_SLOT_HOST_SELECTION, VIEW_ONLY_UI_STATE_KEYS, withoutViewOnlyKeys, HOST_CONTAINER_CLASS, SELECTION_ACTIVE_CLASS, MARK_SELECTED_CLASS, MARKS_INERT_CLASS, ACTIVE_TICK_CLASS, DIM_OPACITY_VAR, DIM_OPACITY_DEFAULT, DIM_OPACITY_MIN, CATEGORY_DELTA_E_FLOOR, chartOwnsTimeline, periodTickSuppressesFeedback, ANIM_PLAY_SPEED_DEFAULT, ANIM_PLAY_SPEED_MIN, ANIM_PLAY_SPEED_MAX, ANIM_LOOP_DELAY_DEFAULT, ANIM_LOOP_DELAY_MIN, ANIM_MAX_IDEAL_FRAMES_DEFAULT, ANIM_MAX_IDEAL_FRAMES_MIN, ANIM_MAX_IDEAL_FRAMES_MAX, ANIMATION_OPTION_KEYS, COLOR_SCALE_SELF_CLAMP_PCT_DEFAULT, COLOR_SCALE_SELF_CLAMP_PCT_MIN, COLOR_SCALE_SELF_CLAMP_PCT_MAX, FLIP_MODE_DEFAULT, FLIP_INTERVAL_MIN_MS, FLIP_INTERVAL_MAX_MS, FLIP_DIRECTION_DEFAULT, APPROXIMATE_POSITIONS_DEFAULT, VALUE_AXIS_BASELINE_DEFAULT, SEASONAL_MARKERS_DEFAULT, MAX_MAP_POINTS_DEFAULT, type GeoPointPrecision, type GeoMapKind, type TimelineStyle, type FlipMode, type FlipDirection, type ApproximatePositions, type ValueAxisBaseline, type SeasonalMarkers, type ColorScaleScope, type RenderOptions, type ViewStateProvider, type ChartControlChange, type XfilterRefreshDetail, type HostSelectionFact, type FilterScopeFact, } from "./contract";
 export { resolveOptions, cleanHostSelection, cleanFilterScope, type ResolveOptionsInput } from "./defaults";
 export { hostLinkServices, type HostLinkServices, type ClipboardLike } from "./hostLinks";
 export { tableToCsv, tableToXlsx, buildExportFile, exportFileName, sheetName as exportSheetName, excelNumberFormat, excelSerial, bytesToBase64, exportFormatsFor, exportTableService, browserSaveFile, EXPORT_FORMATS, XLSX_MIME, CSV_MIME, type ExportTable, type ExportColumn, type ExportColumnType, type ExportCell, type ExportFormat, type ExportFile, type SaveFileService, type ExportTableService, } from "./exportTable";
@@ -31,7 +31,7 @@ export { mountShareRateLine, shareRateLineModel, type ShareRateLine, type ShareR
 export { qualifyGroupHeadingFor, newQualifyGroupState, type QualifyGroupRow, type QualifyGroupState, type QualifyGroupHeading, orderRefusalsForDisplay, refusalIsSelectable, hasRefusalsToShow, qualifyRefusalHeadingFor, newQualifyRefusalGroupState, qualifyRefusalReason, QUALIFY_REFUSAL_UNSPECIFIED, refusalIsTileBound, QUALIFY_TILE_REFUSAL_CODES, QUALIFY_TOO_SMALL_HEADING, type QualifyRefusalRow, type QualifyRefusalGroupState, type QualifyRefusalHeading, } from "./qualifyGroups";
 export { qualifyPick, qualifyAuto, qualifyCancel, launchGenerates, launchFavorStyle, chooserFitsViewport, shouldOpenChooserOnGenerate, shouldOpenInlineChooserOnGenerate, canConfirmLaunch, confirmLaunch, qualifyFailureFallsOpen, CHOOSER_MIN_WIDTH_PX, CHOOSER_MIN_HEIGHT_PX, type QualifyLaunchOutcome, type ChooserGateInput, } from "./qualifyLaunch";
 export { normalizeFilterTerm, filterQualifyRows, readQualifyChartRow, readQualifyRefusalRow, DEFAULT_FILTER_MATCH_STYLE, filterMatchStyleOf, type FilterMatchStyle, filterFitsChooser, listNeedsFilter, qualifyFilterGate, inlineFilterGate, FILTER_MIN_TERM_CHARS, FILTER_ROW_PX, FILTER_MIN_WIDTH_PX, FILTER_MIN_HEIGHT_PX, INLINE_FILTER_MIN_ROWS, computeQualifyFilterView, qualifyFilterCountText, type QualifyFilterTier, type QualifyFilterResult, type QualifyFilterRead, type QualifyFilterGateReason, type QualifyFilterGateInput, type QualifyFilterRow, type QualifyFilterGroup, type QualifyFilterView, type QualifyFilterNoteKind, } from "./qualifyFilter";
-export { qualifyTableRows, type QualifyTableRow, type QualifyTableSource } from "./qualifyTable";
+export { qualifyTableRows, type QualifyTableRow, type QualifyTableSource, QUALIFY_KIND_BADGES, qualifyKindBadgeStyle, type QualifyKind, type QualifyKindBadge, type QualifyKindBadgeColours, type QualifyKindPane, type QualifyKindBadgeStyle, } from "./qualifyTable";
 export { computeSelectionCard, normaliseAggregation, type SelectionCardModel, type SelectionCardLine, type SelectionCardOptions, } from "./selectionCard";
 export { formatSourceDate, formatSourceDateFor, isExcelDateFormat, type SourceFormats, type SourceFormatDialect, type SourceDateOptions, } from "./sourceDateFormat";
 export { composeSummaryText } from "./summaryText";
@@ -45,13 +45,14 @@ export { rowGrowthNotice, ROW_GROWTH_MIN_RATIO, ROW_GROWTH_MIN_EXTRA, type RowGr
 export { censusHitBands, hitBandFlag, MIN_HIT_BAND_PX, type HitBandCensus } from "./hitBands";
 export { censusClippedText, clippedTextFlag, CLIP_TOLERANCE_PX, type ClippedTextCensus, type ClippedText } from "./clippedText";
 export { censusColourSpread, colourSpreadFlag, SAME_SHADE_DELTA_E, MIN_RAMP_FILLS, type ColourSpreadCensus } from "./colourSpread";
+export type { CategoryColourCensus, CategoryColourCensusOptions } from "./categoryColours";
 export { censusValuePlacement, valuePlacementFlag, VALUE_AXIS_MIN_FIT, type ValuePlacementCensus } from "./valuePlacement";
 export { SCROLL_SLACK_PX, MAX_FRAME_GROW_FACTOR, PHANTOM_FRACTION, FIT_CONTENT_SELECTOR, needsScroll, contentExtentOf, scrollFitFor, planFrameGrow, isPhantomBox, type MeasuredBox, type ContentExtent, type ScrollFit, type FrameGrowPlan, } from "./fit";
 export { fitRenderedChart, fitReadingFor, measureContainerBoxes, svgInkReach, ctmScaleOf, type FitReading, type InkReach, type FitRenderedChartOptions, type FitRenderedChartResult, } from "./fitDom";
 export { AXIS_PIN_MIN_LABELS, AXIS_PIN_BAND_PAD_PX, AXIS_PIN_MAX_BAND_FRACTION, AXIS_PIN_TRACK_REACH_PX, isHorizontalLabelRow, labelBand, planAxisPin, axisPinPlacement, type LabelRowBox, type AxisBand, type AxisPinCandidate, type AxisPinPlan, type AxisPinEdge, } from "./fit";
 export { pinScrolledAxis, unpinScrolledAxis, type AxisPinReport } from "./fitDom";
 export { planScrollRestore, type ScrollMemory, type ScrollMetrics } from "./fit";
-export { rememberScroll, takeScroll } from "./fitDom";
+export { rememberScroll, takeScroll, restoreInnerScroll } from "./fitDom";
 export { MIN_DELTA_E, pickDistinctColorFromSeed, buildPalette, buildPaletteFromSeed, orderMostDistinct, LEGIBLE_LIGHTNESS, type PaletteResult, type SeedForSlot, type PaletteOptions, } from "./palette";
 export { deltaEHex } from "./deltaE";
 export { resolveAutoColorScale, autoRampMinStep, autoRampCanvas, AUTO_RAMP_CLASSES, AUTO_RAMP_DRAWN_OPACITY, AUTO_RAMP_MIN_STEP_DELTA_E, type AutoColorScale, type AutoColorScaleInput } from "./autoRamp";

package/dist/types/qualifyTable.d.ts

@@ -1,3 +1,51 @@
+/**
+ * What kind of thing a chart type is, beyond a plain chart, in the chart gallery's own families: an app (a type with
+ * its own controls or logic), a table, a map or a KPI card. A plain chart has no kind and no badge. The same four
+ * strings shape-core's qualify parse accepts (a test pins the two lists equal).
+ */
+export type QualifyKind = "app" | "table" | "map" | "kpi";
+/** A colour pair for one badge: the chip's fill and its text. */
+export interface QualifyKindBadgeColours {
+    background: string;
+    text: string;
+}
+/** How one kind is badged: its word, and its colours on a light pane and on a dark pane. */
+export interface QualifyKindBadge {
+    /** The word on the badge. The word is the signal; colour only repeats it. */
+    label: string;
+    /** On a light pane: the gallery family's own light tint, with the family's colour darkened to 75% as the text. */
+    light: QualifyKindBadgeColours;
+    /** On a dark pane: the family's colour at 50% as the fill, with the gallery's light tint as the text. */
+    dark: QualifyKindBadgeColours;
+}
+/**
+ * The four badges, in the gallery's family order (apps, tables, maps, KPIs). Each host draws them in its own widget,
+ * after the name and before a Preview badge, and a badge never reorders, hides or gates a row.
+ *
+ * The light fills are the chart gallery's family tints exactly. The gallery's own family text colour does not reach
+ * 4.5:1 on three of its tints (about 3.6 to 4.5), so the text is that colour darkened to 75%, which keeps the hue and
+ * clears 5.7:1 on every fill. The dark fills are the family colour at 50%, with the tint as text (above 9:1). Light
+ * tints sit close to each other by nature (the nearest pair is about 8.5 apart by CIEDE2000), so the claim is that
+ * the badges are distinct with the word on them, not that colour alone tells them apart.
+ */
+export declare const QUALIFY_KIND_BADGES: Readonly<Record<QualifyKind, QualifyKindBadge>>;
+/** The pane a badge is drawn on. In high contrast the host's own foreground colour is the only colour used. */
+export type QualifyKindPane = "light" | "dark" | {
+    highContrastForeground: string;
+};
+/** What a host sets on a badge element: its word, fill, text colour and border, as CSS values. */
+export interface QualifyKindBadgeStyle {
+    label: string;
+    background: string;
+    color: string;
+    border: string;
+}
+/**
+ * The style for one kind's badge on one pane, or null for no kind (a plain chart, or a kind this version does not
+ * know). In high contrast the badge has no fill: the text and a 1px border take the host's foreground colour, so the
+ * system's colours decide and the word stays the signal.
+ */
+export declare function qualifyKindBadgeStyle(kind: string | null | undefined, pane: QualifyKindPane): QualifyKindBadgeStyle | null;
 /** What a what-fits row must carry to become a table row (the shape-core parse result satisfies it). */
 export interface QualifyTableSource {
     name: string;
@@ -8,6 +56,8 @@ export interface QualifyTableSource {
     recommended?: boolean | null;
     isPreview?: boolean | null;
     alsoWorthALook?: boolean | null;
+    /** The server's kind for the type ("app", "table", "map", "kpi"); absent or anything else is a plain chart. */
+    kind?: string | null;
 }
 export interface QualifyTableRow {
     /** The position in the order asked for, or null for a row the server did not rank. */
@@ -22,6 +72,8 @@ export interface QualifyTableRow {
     renderer: string | null;
     /** One of the "something different" picks drawn from below the top fits. */
     alsoWorthALook: boolean;
+    /** The type's kind, for its badge (QUALIFY_KIND_BADGES); null for a plain chart. qualifyTableRows always sets it. */
+    kind?: QualifyKind | null;
 }
 /** The rows as table rows, in the order given (the server's order IS the ranking). */
 export declare function qualifyTableRows(rows: readonly QualifyTableSource[]): QualifyTableRow[];

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-VPFP35XI.mjs";
+} from "./chunk-K2TH7D5V.mjs";
 import "./chunk-GHODWOAL.mjs";
 
 // src/zoomMemory/zoomMemory.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bicharts/chart-host",
-  "version": "0.6.115",
+  "version": "0.6.117",
   "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",
@@ -74,6 +74,11 @@
       "import": "./dist/zoom-memory.mjs",
       "default": "./dist/zoom-memory.mjs"
     },
+    "./category-colours": {
+      "types": "./dist/types/categoryColours.d.ts",
+      "import": "./dist/category-colours.mjs",
+      "default": "./dist/category-colours.mjs"
+    },
     "./dax": {
       "types": "./dist/types/dax.d.ts",
       "import": "./dist/dax.mjs",