@arcfusionz/arc-analytic-ui 0.0.0

package/dist/components/HighlightCard/HighlightCard.chart.d.ts

@@ -0,0 +1,122 @@
+import { ChartTokens } from "../../lib/vega/tokens.js";
+import { HighlightMark, HighlightScale, HighlightXType } from "./HighlightCard.model.js";
+import { TopLevelSpec } from "vega-lite";
+//#region src/components/HighlightCard/HighlightCard.chart.d.ts
+/** Context plot: every reading, with `hl` and the window's `tone`. */
+declare const HIGHLIGHT_TABLE_DATASET = "table";
+/** Context plot: the readings outside the window with a `seg` of `before` or `after` — the gray runs. */
+declare const HIGHLIGHT_OUTSIDE_DATASET = "outside";
+/** Context plot: the readings inside the window — the coloured segment. */
+declare const HIGHLIGHT_INSIDE_DATASET = "inside";
+/** Context plot: the window's start and end readings — the two dots. */
+declare const HIGHLIGHT_ENDPOINTS_DATASET = "endpoints";
+/** Context plot: one row `{ start, end, tone }` — the band wash and the axis anchors. */
+declare const HIGHLIGHT_BAND_DATASET = "band";
+/** Peer strip: one row per compared window, `{ change, isHighlight, … }`. */
+declare const HIGHLIGHT_PEERS_DATASET = "peers";
+/** Peer strip: one row `{ low, high }` — the typical-range wash. */
+declare const HIGHLIGHT_TYPICAL_DATASET = "typical";
+/** Peer strip and drivers: one row `{ value: 0 }` — the hairline at no change. */
+declare const HIGHLIGHT_ZERO_DATASET = "zero";
+/** Drivers: one row per contributor, `{ key, label, value, tone, role }`. */
+declare const HIGHLIGHT_DRIVERS_DATASET = "drivers";
+/** Context plot: the nearest-reading hover selection. */
+declare const HIGHLIGHT_HOVER_PARAM = "hover";
+/** Peer strip: the hovered window. */
+declare const HIGHLIGHT_PEER_HOVER_PARAM = "peer_hover";
+/** Drivers: the hovered bar. */
+declare const HIGHLIGHT_DRIVER_HOVER_PARAM = "driver_hover";
+/** Context plot: responsive x tick values, recomputed by Vega when the domain or width changes. */
+declare const HIGHLIGHT_X_TICKS_PARAM = "highlight_x_ticks";
+/** Context plot: the window's snapped bounds, read from the `band` dataset — the x axis labels them. */
+declare const HIGHLIGHT_START_PARAM = "highlight_start";
+declare const HIGHLIGHT_END_PARAM = "highlight_end";
+/** Bars stay ≤ 24px however tall the rows are. */
+declare const MAX_DRIVER_BAR_HEIGHT = 24;
+interface HighlightContextSpecOptions {
+  mark: HighlightMark;
+  scale: HighlightScale;
+  xType: HighlightXType;
+  height: number;
+  /** Draw both axes with labels — a hairline x domain and hairline y grid lines. */
+  axes: boolean;
+  /** Wire the nearest-reading hover selection and the tooltip channel. */
+  tooltip: boolean;
+  /** Tooltip titles. */
+  xTitle: string;
+  yTitle: string;
+  /** `arcNumber` grammar for values (`currency:THB:compact@en-US`). */
+  valueFormat: string;
+  /** `arcTime` grammar for temporal x in tooltips (`day@en-US@Asia/Bangkok`). */
+  timeFormat: string;
+  /** `arcTime` grammar for x-axis tick labels — the axis-length form. */
+  axisTimeFormat: string;
+  locale?: string;
+  timeZone?: string;
+}
+/**
+ * The window inside the whole series: a quiet band washes its extent, the
+ * readings outside it draw in the context gray, the window itself draws in its
+ * polarity hue, its start and end are dotted, and the x axis labels the
+ * window's bounds before the domain's ends. Lines may crop (`scale: "auto"`);
+ * areas and bars keep a zero baseline whatever `scale` says — proportional ink
+ * is not negotiable. Gaps stay gaps: Vega-Lite's default `invalid` handling
+ * breaks the path at a null reading.
+ */
+declare function buildHighlightContextSpec(options: HighlightContextSpecOptions, tokens: ChartTokens): TopLevelSpec;
+interface HighlightPeersSpecOptions {
+  height: number;
+  /** Wire the hover selection and the tooltip channel. */
+  tooltip: boolean;
+  /** Tooltip titles. */
+  windowTitle: string;
+  changeTitle: string;
+  /** `arcNumber` grammar for the change axis — `percent:1` for a relative comparison, the value's own format for an absolute one. */
+  changeFormat: string;
+  /** Localised title for the typical-range wash. */
+  typicalTitle: string;
+  locale?: string;
+  timeZone?: string;
+}
+/**
+ * Every comparable window's change on ONE shared position scale, as a strip
+ * plot: the typical range as a quiet wash, a hairline at no change, one thin
+ * tick per compared window in the context gray, and the highlighted window as
+ * a solid dot in its polarity hue.
+ *
+ * A strip plot, not a summary statistic, because showing the peers is the
+ * honest way to say "unusual" — the reader sees the spread they are being
+ * asked to accept, the crowd near zero and the tail this window sits in.
+ * Every tick is also a row in the panel's table, so nothing lives only here.
+ */
+declare function buildHighlightPeersSpec(options: HighlightPeersSpecOptions, tokens: ChartTokens): TopLevelSpec;
+interface HighlightDriversSpecOptions {
+  /** Bar thickness in pixels, capped at 24. Centered in each row's band. */
+  barHeight: number;
+  /** Initial plot height — rows × step. The live value rides the View API. */
+  height: number;
+  /** Wire the hover selection and the tooltip channel. */
+  tooltip: boolean;
+  /** Tooltip titles. */
+  driverTitle: string;
+  contributionTitle: string;
+  shareTitle: string;
+  /** `arcNumber` grammar for contributions — the value's own format, signed. */
+  valueFormat: string;
+  locale?: string;
+  timeZone?: string;
+}
+/**
+ * The window's change decomposed: one horizontal bar per contributor from a
+ * shared zero, positive to the right and negative to the left, in the
+ * diverging polarity hues. Sorted by absolute contribution upstream, so the
+ * biggest mover is the first row.
+ *
+ * Bars only — the names, amounts and shares are DOM text beside the plot, so
+ * every band has no padding and the bar centers line up with the rows that
+ * carry the text. A hairline at zero is always drawn: these values are signed
+ * by nature, and the reader must see which side of no-change each one is on.
+ */
+declare function buildHighlightDriversSpec(options: HighlightDriversSpecOptions, tokens: ChartTokens): TopLevelSpec;
+//#endregion
+export { HIGHLIGHT_BAND_DATASET, HIGHLIGHT_DRIVERS_DATASET, HIGHLIGHT_DRIVER_HOVER_PARAM, HIGHLIGHT_ENDPOINTS_DATASET, HIGHLIGHT_END_PARAM, HIGHLIGHT_HOVER_PARAM, HIGHLIGHT_INSIDE_DATASET, HIGHLIGHT_OUTSIDE_DATASET, HIGHLIGHT_PEERS_DATASET, HIGHLIGHT_PEER_HOVER_PARAM, HIGHLIGHT_START_PARAM, HIGHLIGHT_TABLE_DATASET, HIGHLIGHT_TYPICAL_DATASET, HIGHLIGHT_X_TICKS_PARAM, HIGHLIGHT_ZERO_DATASET, HighlightContextSpecOptions, HighlightDriversSpecOptions, HighlightPeersSpecOptions, MAX_DRIVER_BAR_HEIGHT, buildHighlightContextSpec, buildHighlightDriversSpec, buildHighlightPeersSpec };