@fundar/data-chart-telling 0.0.28 → 0.0.30

package/dist/types/layout/styles.d.ts

@@ -1,6 +1,7 @@
 import type { ValueAnchor } from '../plots/constants';
 import type { FontStyle, StrokeStyle, AreaStyle } from '../plots/styling';
 import type { GeoFeature } from '../plots/data/geo';
+import type { GapsConfig } from '../plots/gaps';
 /**
  * Controls if and how value labels are rendered on a plot. The high-level
  * `anchor` sets sensible defaults for placement; `fontStyle` (`dx`, `dy`,
@@ -47,16 +48,34 @@ export type FrameStyle = AreaStyle & {
 };
 /** Author-facing `styles.frame` prop — see {@link FrameStyle}. */
 export type FrameProp = boolean | FrameStyle;
+/**
+ * The fields every plot kind's own `styles` shape shares, regardless of
+ * whether it's built on axes ({@link AxisBasedStylesConfig}) or geometry
+ * ({@link GeoStylesConfig}) — the true common parent of the two, unlike the
+ * name `AxisBasedStylesConfig` might suggest before this split existed.
+ */
+export type BasePlotStylesConfig = {
+    /** Decorative border around the plot's content box — see {@link FrameStyle}. Available on every plot kind. */
+    frame?: FrameProp;
+};
 /**
  * Top-level rendering style overrides shared by the non-geo plot kinds.
  * Passed as the `styles` prop. Each plot reads only the fields it cares
  * about.
  */
-export type BasePlotStylesConfig = {
+export type AxisBasedStylesConfig = BasePlotStylesConfig & {
     values?: ValuesStyle;
     colors?: ColorsStyle;
-    /** Decorative border around the plot's content box — see {@link FrameStyle}. Available on every plot kind. */
-    frame?: FrameProp;
+};
+/**
+ * `AxisBasedStylesConfig` extended with `gaps` — the interpolated
+ * missing-data bridge fill available to plot kinds with an inherent
+ * category/sequence ordering (`LinePlot`, `BarPlot`, `PyramidPlot`).
+ * Resolved per series like `segments`, at zone granularity — see
+ * {@link GapsConfig}.
+ */
+export type GapsAwarePlotStylesConfig<TSegmentStyle extends object> = AxisBasedStylesConfig & {
+    gaps?: GapsConfig<TSegmentStyle>;
 };
 export type GeoTileLayerConfig = {
     /** XYZ tile URL template, e.g. `'https://tile.openstreetmap.org/{z}/{x}/{y}.png'`. */
@@ -69,12 +88,13 @@ export type GeoTileLayerConfig = {
     tileSize?: number;
 };
 /**
- * `styles` prop for GeoPlot — the geo analog of `BasePlotStylesConfig`.
- * Unlike the other plot kinds, GeoPlot's styling needs (base map, choropleth
- * ramp, tile background, click handling) are unlike anything x/y plots need,
- * so this is its own type rather than a reuse of `BasePlotStylesConfig`.
+ * `styles` prop for GeoPlot — the geo analog of `AxisBasedStylesConfig`,
+ * sharing only {@link BasePlotStylesConfig}'s common ground with it. Unlike
+ * the other plot kinds, GeoPlot's styling needs (base map, choropleth ramp,
+ * tile background, click handling) are unlike anything x/y plots need, so
+ * this is its own type rather than a reuse of `AxisBasedStylesConfig`.
  */
-export type GeoStylesConfig<TProps extends Record<string, unknown> = Record<string, unknown>> = {
+export type GeoStylesConfig<TProps extends Record<string, unknown> = Record<string, unknown>> = BasePlotStylesConfig & {
     /** Base map fill, used when a feature isn't styled by `segments` or the choropleth ramp. */
     fill?: string;
     fillOpacity?: number;
@@ -86,8 +106,6 @@ export type GeoStylesConfig<TProps extends Record<string, unknown> = Record<stri
     tileLayer?: GeoTileLayerConfig;
     /** Fired when a base-map feature is clicked. */
     onFeatureClick?: (feature: GeoFeature<TProps>, event: Event) => void;
-    /** Decorative border around the plot's content box — see {@link FrameStyle}. Available on every plot kind. */
-    frame?: FrameProp;
 };
 /**
  * `GeoTileLayerConfig`, plus `features` — never author-facing (the public
@@ -103,7 +121,7 @@ type GeoTileLayerConfigWithFeatures = GeoTileLayerConfig & {
 };
 /**
  * The minimal slice of a plot kind's own `styles` prop `StylesLayout` reads —
- * every concrete `styles` type ({@link BasePlotStylesConfig},
+ * every concrete `styles` type ({@link AxisBasedStylesConfig},
  * {@link GeoStylesConfig}) structurally satisfies this whether or not it
  * declares `tileLayer` at all (a missing optional field type-checks fine).
  */

package/dist/types/plots/gaps.d.ts

@@ -0,0 +1,54 @@
+import type { EasingName } from '../charts/interpolate';
+import type { AxisValue } from '../layout/scales';
+/**
+ * How one gap zone bridges its hole: `interpolate` eases the synthetic
+ * segment's value between its two endpoints (defaults to `'linear'`, a
+ * straight line); `style` is the per-mark shape drawn for it
+ * ({@link LineSegmentStyle} for `LinePlot`), independent of that plot
+ * kind's own default marker style unless the caller repeats it.
+ */
+export type GapZoneConfig<TStyle> = {
+    interpolate?: EasingName;
+    style?: TStyle;
+};
+/**
+ * A leading/trailing gap has only one real boundary — `x` (required to opt
+ * in) is the domain value the synthetic segment extends to, and `y` is the
+ * value it reaches there (defaults to holding the nearest real point's
+ * value, i.e. a flat extrapolation). Omitting the zone entirely leaves that
+ * end of the series unfilled — extrapolating without an explicit target
+ * would imply data that doesn't exist.
+ *
+ * On `LinePlot`, `x`'s value is the actual spatial target the bridge draws
+ * out to (its axis is continuous). On `BarPlot`/`PyramidPlot`, each gap row
+ * already has its own real category, so `x`'s *presence* is only the opt-in
+ * gate — its value isn't read; `y` is what drives the fill.
+ */
+export type OpenGapZoneConfig<TStyle> = GapZoneConfig<TStyle> & {
+    x: AxisValue;
+    y?: AxisValue;
+};
+/**
+ * One series' gap-fill config: `start` (before its first real point),
+ * `middle` (any internal run of missing rows, bounded by real data on both
+ * sides) and `end` (after its last real point). A row counts as missing
+ * when its resolved value is `null`, `undefined`, or `NaN` — the same
+ * convention svelteplot's own `Line` mark already uses to break the line
+ * there. See {@link GapsConfig} for how this is keyed per series on a
+ * gap-aware plot kind's `styles.gaps`.
+ */
+export type GapZonesConfig<TStyle> = {
+    start?: OpenGapZoneConfig<TStyle>;
+    middle?: GapZoneConfig<TStyle>;
+    end?: OpenGapZoneConfig<TStyle>;
+};
+/**
+ * The `gaps` field a gap-aware plot kind's `styles` accepts (see
+ * {@link GapsAwarePlotStylesConfig}, `types/layout/styles.ts`) — series name
+ * (or `'default'` for all series) to that series' {@link GapZonesConfig}.
+ * Mirrors `SegmentsConfig`'s series-keyed shape: a named entry applies only
+ * to that series; `'default'` fills in whichever of its zones
+ * (`start`/`middle`/`end`) the named entry itself leaves unset, at zone
+ * granularity rather than a merged style.
+ */
+export type GapsConfig<TStyle> = Record<string, GapZonesConfig<TStyle>>;

package/dist/types/plots/gaps.js

@@ -0,0 +1 @@
+export {};

package/dist/types/plots/props.d.ts

@@ -3,7 +3,7 @@ import type { Segment } from './segments/config';
 import type { AxisBasedScalesConfig } from '../layout/scales';
 import type { GeoScalesConfig } from '../layout/coordinates';
 /** The `styles` prop accepted by every plot kind — its own
- * styles shape ({@link BasePlotStylesConfig}, `GeoStylesConfig`, …). */
+ * styles shape ({@link AxisBasedStylesConfig}, `GeoStylesConfig`, …). */
 export type StylesConfig<TStyles extends object> = TStyles;
 /** The `markers` prop accepted by every plot kind — a list of that kind's own marker union. */
 export type MarkersConfig<TMarker> = TMarker[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fundar/data-chart-telling",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "type": "module",
   "files": [
     "dist"