@fundar/data-chart-telling 0.0.63 → 1.0.0

package/dist/types/markers/channels/commonMarkerConfig.d.ts

@@ -0,0 +1,26 @@
+import type { ChannelScalesConfig } from '../../layout/scales';
+import type { AxisValue } from '../../layout/mapping';
+import type { StatisticConfig } from '../../layout/statistics';
+import type { MarkerTransform } from '../../transforms';
+import type { MarkLegend } from '../../layout/legend';
+/** Props every marker kind shares: rows, grouping, series scope, position, statistics, transforms. */
+export type CommonMarkerConfig = {
+    data?: Record<string, unknown>[];
+    grouping?: string | ((d: any) => unknown);
+    series?: string;
+    /**
+     * With `series` set, whether the marker draws once over the whole series
+     * (the default) or once per segment, over that segment's rows and in its
+     * color - so a `selectMaxY` marks each segment's own peak.
+     */
+    scope?: 'series' | 'segment';
+    x?: AxisValue | ((d: any) => AxisValue);
+    y?: AxisValue | ((d: any) => AxisValue);
+    scales?: ChannelScalesConfig;
+    statistics?: StatisticConfig[];
+    transforms?: MarkerTransform[];
+    /** Clips the marker to the plot's frame. Unset, its kind's default applies. */
+    clip?: boolean;
+    /** Names the marker on its plot's automatic legend - see {@link MarkLegend}. */
+    legend?: MarkLegend;
+};

package/dist/types/markers/channels/commonMarkerConfig.js

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

package/dist/types/markers/channels/commonMarkerConfigWithArea.d.ts

@@ -0,0 +1,6 @@
+import type { CommonMarkerConfig } from './commonMarkerConfig';
+/** Common props plus the fill and opacity channels. */
+export type CommonMarkerConfigWithArea = CommonMarkerConfig & {
+    fill?: (d: any) => string;
+    opacity?: string | ((d: any) => unknown);
+};

package/dist/types/markers/channels/commonMarkerConfigWithArea.js

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

package/dist/types/markers/channels/commonMarkerConfigWithColor.d.ts

@@ -0,0 +1,5 @@
+import type { CommonMarkerConfig } from './commonMarkerConfig';
+/** Common props plus the color ramp channel. */
+export type CommonMarkerConfigWithColor = CommonMarkerConfig & {
+    color?: string | ((d: any) => unknown);
+};

package/dist/types/markers/channels/commonMarkerConfigWithColor.js

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

package/dist/types/markers/channels/commonMarkerConfigWithInterval.d.ts

@@ -0,0 +1,9 @@
+import type { AxisValue } from '../../layout/mapping';
+import type { CommonMarkerConfig } from './commonMarkerConfig';
+/** Common props plus the interval channels `x1`/`x2`/`y1`/`y2`. */
+export type CommonMarkerConfigWithInterval = CommonMarkerConfig & {
+    x1?: string | number | ((d: any) => AxisValue);
+    x2?: string | number | ((d: any) => AxisValue);
+    y1?: string | number | ((d: any) => AxisValue);
+    y2?: string | number | ((d: any) => AxisValue);
+};

package/dist/types/markers/channels/commonMarkerConfigWithInterval.js

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

package/dist/types/markers/channels/commonMarkerConfigWithRadius.d.ts

@@ -0,0 +1,5 @@
+import type { CommonMarkerConfigWithArea } from './commonMarkerConfigWithArea';
+/** Fill and opacity channels plus the per-row radius `r`. */
+export type CommonMarkerConfigWithRadius = CommonMarkerConfigWithArea & {
+    r?: number | string | ((d: any) => number);
+};

package/dist/types/markers/channels/commonMarkerConfigWithRadius.js

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

package/dist/types/markers/channels/commonMarkerConfigWithSymbol.d.ts

@@ -0,0 +1,5 @@
+import type { CommonMarkerConfig } from './commonMarkerConfig';
+/** Common props plus the categorical shape channel `symbol`. */
+export type CommonMarkerConfigWithSymbol = CommonMarkerConfig & {
+    symbol?: string | ((d: any) => unknown);
+};

package/dist/types/markers/channels/commonMarkerConfigWithSymbol.js

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

package/dist/types/markers/channels/commonMarkerConfigWithWeight.d.ts

@@ -0,0 +1,5 @@
+import type { CommonMarkerConfig } from './commonMarkerConfig';
+/** Common props plus the per-row weight channel used by density estimates. */
+export type CommonMarkerConfigWithWeight = CommonMarkerConfig & {
+    weight?: string | ((d: any) => number);
+};

package/dist/types/markers/channels/commonMarkerConfigWithWeight.js

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

package/dist/types/markers/common.d.ts

@@ -1,103 +1,30 @@
-import type { AxisValue } from '../layout/scales';
-import type { FontStyle, StrokeStyle, DotStyle, AreaStyle } from '../plots/styling';
-import type { HoverStrategy, HoverDisplayPoint } from '../layout/tooltip';
-import type { BaseMarkersConfig } from './base';
-export type { DotMarkerConfig } from './base';
-export type RuleMarkerConfig = {
-    type: 'rule';
-    axis: 'x' | 'y';
-    value: AxisValue;
-    style?: StrokeStyle;
-};
-/**
- * In-SVG hover highlight (crosshair + dot + label). Omitting `series`
- * applies it to all series; scoping follows the same fields as
- * {@link CustomComponentMarkerConfig}.
- */
-export type HoverMarkerConfig = {
-    type: 'hover';
-    series?: string;
-    scope?: 'series' | 'segment';
-    strategy?: HoverStrategy;
-    sync?: boolean;
-    ruleX?: boolean;
-    ruleY?: boolean;
-    /**
-     * Thickened area in place of a thin crosshair — sized to the hovered
-     * bar/cell's own width, spanning the full opposite axis. Off by default;
-     * meaningful only on a band (categorical) scale, so it renders nothing on
-     * a line/scatter plot's continuous axis.
-     */
-    areaX?: boolean;
-    areaY?: boolean;
-    showLabels?: boolean;
-    format?: (point: HoverDisplayPoint) => string;
-    ruleStyle?: StrokeStyle;
-    areaStyle?: AreaStyle;
-    dotStyle?: DotStyle;
-    fontStyle?: FontStyle;
-};
-/** A single line-segment stroke. Endpoint dots are a separate `'dot'` marker rather than a field here. */
-export type LineMarkerConfig = {
-    type: 'line';
-    data: Record<string, unknown>[];
-    x: (d: any) => AxisValue;
-    y: (d: any) => AxisValue;
-    style?: StrokeStyle;
-};
-/**
- * A single bar mark. `role: 'segment'` is a visible bar
- * (`x`/`y`/`x1`/`x2`/`y1`/`y2` map to svelteplot's `<BarX>`/`<BarY>` per
- * `isHorizontal`); `role: 'hitArea'` is an invisible per-category hit region
- * for hover, resolved against the live scale at render time; `role:
- * 'highlight'` is `HoverMarkerConfig`'s `areaX`/`areaY` highlight — a
- * visible, non-interactive rect centered on `category`, spanning the full
- * opposite axis, sized to the category band's own width plus 2px (or a
- * single series' own slice, via `insetTop`/etc.).
- */
-export type BarMarkerConfig = {
-    type: 'bar';
-    role: 'segment' | 'hitArea' | 'highlight';
-    isHorizontal: boolean;
-    data: Record<string, unknown>[];
-    x?: (d: any) => AxisValue;
-    y?: (d: any) => AxisValue;
-    x1?: number | ((d: any) => number);
-    x2?: number | ((d: any) => number);
-    y1?: number | ((d: any) => number);
-    y2?: number | ((d: any) => number);
-    insetTop?: number;
-    insetBottom?: number;
-    insetLeft?: number;
-    insetRight?: number;
-    style?: AreaStyle;
-    category?: AxisValue;
-    onpointerenter?: () => void;
-    onpointerleave?: () => void;
-};
-/** A single heatmap cell mark. `fill` stays a per-row accessor; the rest of the style is constant per call. */
-export type CellMarkerConfig = {
-    type: 'cell';
-    data: Record<string, unknown>[];
-    x: (d: any) => AxisValue;
-    y: (d: any) => AxisValue;
-    fill: (d: any) => string;
-    style?: AreaStyle;
-    inset?: number;
-};
-export type CustomComponentMarkerConfig = {
-    type: 'component';
-    series?: string;
-    component: any;
-    props?: Record<string, unknown>;
-    data?: any[];
-    scope?: 'series' | 'segment';
-};
-/**
- * Every marker kind any axis-based plot can render: {@link BaseMarkersConfig}
- * plus every axis-based-only kind. `BarPlot`/`HeatmapPlot`/`PyramidPlot` use
- * this directly as their `markers` prop type; `LinePlot`'s own
- * `LineMarkersConfig` (`types/markers/line.ts`) unions it with the line-only
- * `delta` annotation instead.
- */
-export type AxisBasedMarkersConfig = BaseMarkersConfig | RuleMarkerConfig | HoverMarkerConfig | LineMarkerConfig | BarMarkerConfig | CellMarkerConfig | CustomComponentMarkerConfig;
+export type { MarkerCurveName } from './axis/curveName';
+export * from './axis/line';
+export * from './axis/bar';
+export * from './axis/cell';
+export * from './axis/rect';
+export * from './axis/regression';
+export * from './axis/bollinger';
+export * from './axis/area';
+export * from './axis/density';
+export * from './axis/box';
+export * from './axis/hull';
+export * from './axis/difference';
+export * from './axis/arrow';
+export * from './axis/brush';
+export * from './axis/delaunayLink';
+export * from './axis/delaunayMesh';
+export * from './axis/voronoi';
+export * from './axis/voronoiMesh';
+export * from './axis/image';
+export * from './axis/raster';
+export * from './axis/tick';
+export * from './axis/trail';
+export * from './axis/waffle';
+export * from './axis/rule';
+export * from './axis/hover';
+export * from './axis/component';
+export * from './axis/axisBasedMarkersConfig';
+export * from './channels/commonMarkerConfig';
+export * from './basic/dot';
+export * from './basic/text';

package/dist/types/markers/common.js

@@ -1 +1,29 @@
-export {};
+export * from './axis/line';
+export * from './axis/bar';
+export * from './axis/cell';
+export * from './axis/rect';
+export * from './axis/regression';
+export * from './axis/bollinger';
+export * from './axis/area';
+export * from './axis/density';
+export * from './axis/box';
+export * from './axis/hull';
+export * from './axis/difference';
+export * from './axis/arrow';
+export * from './axis/brush';
+export * from './axis/delaunayLink';
+export * from './axis/delaunayMesh';
+export * from './axis/voronoi';
+export * from './axis/voronoiMesh';
+export * from './axis/image';
+export * from './axis/raster';
+export * from './axis/tick';
+export * from './axis/trail';
+export * from './axis/waffle';
+export * from './axis/rule';
+export * from './axis/hover';
+export * from './axis/component';
+export * from './axis/axisBasedMarkersConfig';
+export * from './channels/commonMarkerConfig';
+export * from './basic/dot';
+export * from './basic/text';

package/dist/types/markers/geo/contour.d.ts

@@ -0,0 +1,27 @@
+import type { Accessor } from '../../plots/data/common';
+/**
+ * Marching-squares contours from a scalar field (svelteplot's `Contour`).
+ * Pass `data` with `x`/`y`/`value` to interpolate samples, or omit `data` and
+ * pass `value` as an `(x, y) => number` sampler.
+ */
+export type GeoContourMarkerConfig<TRow extends Record<string, unknown> = Record<string, unknown>> = {
+    type: 'contour';
+    data?: TRow[];
+    x?: Accessor<TRow, number>;
+    y?: Accessor<TRow, number>;
+    value?: Accessor<TRow, number> | ((x: number, y: number) => number);
+    thresholds?: number | number[];
+    fill?: 'value' | string;
+    stroke?: 'value' | string;
+    blur?: number;
+    interpolate?: 'none' | 'nearest' | 'barycentric' | 'random-walk';
+    styles?: {
+        strokeWidth?: number;
+        fillOpacity?: number;
+        strokeOpacity?: number;
+    };
+    /** Masks the contour to the base map's land or water. */
+    clip?: 'land' | 'ocean';
+    /** Draws behind the base map instead of over it. */
+    behind?: boolean;
+};

package/dist/types/markers/geo/contour.js

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

package/dist/types/markers/geo/features.d.ts

@@ -0,0 +1,12 @@
+/** The base choropleth mark, one per resolved feature style. Built internally, never authored. */
+export type GeoFeaturesMarkerConfig = {
+    type: 'geo';
+    data: Record<string, unknown>[];
+    fill: (d: any) => string;
+    fillOpacity?: number;
+    stroke?: string;
+    strokeWidth?: number;
+    onclick?: (e: Event, d: any) => void;
+    /** The features the pointer can match as the plot's hover, by `__id`. */
+    hover?: Map<string, Record<string, unknown>>;
+};

package/dist/types/markers/geo/features.js

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

package/dist/types/markers/geo/geoComponent.d.ts

@@ -0,0 +1,7 @@
+/** Mounts an arbitrary Svelte component as a geo mark. */
+export type GeoCustomComponentMarkerConfig = {
+    type: 'geo-component';
+    component: any;
+    props?: Record<string, unknown>;
+    data?: any[];
+};

package/dist/types/markers/geo/geoComponent.js

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

package/dist/types/markers/geo/geoHover.d.ts

@@ -0,0 +1,6 @@
+import type { AreaStyle } from '../../plots/styling';
+/** The in-map hover highlight, restyling the hovered feature's own shape. */
+export type GeoHoverMarkerConfig = {
+    type: 'geo-hover';
+    styles?: AreaStyle;
+};

package/dist/types/markers/geo/geoHover.js

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

package/dist/types/markers/geo/geoMarkersConfig.d.ts

@@ -0,0 +1,11 @@
+import type { BasicMarkersConfig } from '../basic/basicMarkersConfig';
+import type { GeoGraticuleMarkerConfig } from './graticule';
+import type { GeoSphereMarkerConfig } from './sphere';
+import type { GeoVectorMarkerConfig } from './vector';
+import type { GeoLinkMarkerConfig } from './link';
+import type { GeoContourMarkerConfig } from './contour';
+import type { GeoHoverMarkerConfig } from './geoHover';
+import type { GeoCustomComponentMarkerConfig } from './geoComponent';
+import type { GeoInsetMarkerConfig } from './inset';
+/** Every marker a geo plot accepts. */
+export type GeoMarkersConfig = BasicMarkersConfig | GeoGraticuleMarkerConfig | GeoSphereMarkerConfig | GeoVectorMarkerConfig | GeoLinkMarkerConfig | GeoContourMarkerConfig | GeoHoverMarkerConfig | GeoCustomComponentMarkerConfig | GeoInsetMarkerConfig;

package/dist/types/markers/geo/geoMarkersConfig.js

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

package/dist/types/markers/geo/graticule.d.ts

@@ -0,0 +1,11 @@
+import type { StrokeStyle } from '../../plots/styling';
+/** Longitude and latitude gridlines (svelteplot's `Graticule`). */
+export type GeoGraticuleMarkerConfig = {
+    type: 'graticule';
+    step?: number;
+    stepX?: number;
+    stepY?: number;
+    styles?: StrokeStyle;
+    /** Draws behind the base map instead of over it. */
+    behind?: boolean;
+};

package/dist/types/markers/geo/graticule.js

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

package/dist/types/markers/geo/inset.d.ts

@@ -0,0 +1,50 @@
+import type { Snippet } from 'svelte';
+import type { GeoFeature, GeoJsonInput } from '../../plots/data/geo';
+import type { GeoSegmentStyle } from '../../plots/segments/common';
+import type { GeoProjectionName } from '../../layout/coordinates';
+import type { TooltipAnchorX, TooltipAnchorY } from '../../layout/tooltip';
+/** Which frame edge an inset is anchored to, and where along it. */
+export type GeoInsetLocation = 'top-left' | 'left-top' | 'top-middle' | 'middle-top' | 'top-right' | 'right-top' | 'middle-left' | 'left-middle' | 'middle-middle' | 'middle-right' | 'right-middle' | 'bottom-left' | 'left-bottom' | 'bottom-middle' | 'middle-bottom' | 'bottom-right' | 'right-bottom';
+/** Named projections an inset can use, minus those with no scale to auto-fit. */
+export type GeoInsetProjectionName = Exclude<GeoProjectionName, 'identity' | 'reflect-y'>;
+/** Projection for an inset; insets always auto-fit to their own content. */
+export type GeoInsetProjectionConfig = GeoInsetProjectionName | {
+    type?: GeoInsetProjectionName;
+    rotate?: [number, number] | [number, number, number];
+    center?: [number, number];
+    parallels?: [number, number];
+    clip?: boolean | null | number | 'frame';
+};
+/** An inset's own hover tooltip, matched by nearest projected centroid. */
+export type GeoInsetTooltipConfig = {
+    format: (feature: GeoFeature<Record<string, unknown>>) => string;
+    content?: Snippet<[{
+        rows: GeoFeature<Record<string, unknown>>[];
+    }]>;
+    anchorX?: TooltipAnchorX;
+    anchorY?: TooltipAnchorY;
+};
+/** A small, independently projected map panel anchored to an edge of the plot. */
+export type GeoInsetMarkerConfig<TProps extends Record<string, unknown> = Record<string, unknown>> = {
+    type: 'inset';
+    location: GeoInsetLocation;
+    /** Feature ids to filter from the plot's own `data`; ignored when `data` is set. */
+    features?: string[];
+    /** Narrows each matched feature to the geometry parts that pass this predicate. */
+    featurePartsFilter?: (part: {
+        centroid: [number, number];
+        geometry: GeoJSON.Geometry;
+    }, feature: GeoFeature<TProps> & {
+        __id: string;
+    }) => boolean;
+    /** A separate GeoJSON dataset rendered inside the inset. */
+    data?: GeoJsonInput<TProps>;
+    projection?: GeoInsetProjectionConfig;
+    /** Inset width and height as fractions of the plot's own. */
+    width?: number;
+    height?: number;
+    /** Gap between the inset and the plot's edge, in pixels. */
+    margin?: number;
+    styles?: GeoSegmentStyle;
+    tooltip?: GeoInsetTooltipConfig;
+};

package/dist/types/markers/geo/inset.js

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

package/dist/types/markers/geo/link.d.ts

@@ -0,0 +1,13 @@
+import type { Accessor } from '../../plots/data/common';
+import type { StrokeStyle } from '../../plots/styling';
+/** Lines between point pairs (svelteplot's `Link`); `curve: 'auto'` traces great-circle arcs. */
+export type GeoLinkMarkerConfig<TRow extends Record<string, unknown> = Record<string, unknown>> = {
+    type: 'link';
+    data: TRow[];
+    x1: Accessor<TRow, number>;
+    y1: Accessor<TRow, number>;
+    x2: Accessor<TRow, number>;
+    y2: Accessor<TRow, number>;
+    curve?: 'auto' | 'linear';
+    styles?: StrokeStyle;
+};

package/dist/types/markers/geo/link.js

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

package/dist/types/markers/geo/sphere.d.ts

@@ -0,0 +1,11 @@
+import type { StrokeStyle } from '../../plots/styling';
+/** The outer globe outline (svelteplot's `Sphere`), for orthographic-type projections. */
+export type GeoSphereMarkerConfig = {
+    type: 'sphere';
+    styles?: StrokeStyle & {
+        fill?: string;
+        fillOpacity?: number;
+    };
+    /** Draws behind the base map instead of over it. */
+    behind?: boolean;
+};

package/dist/types/markers/geo/sphere.js

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

package/dist/types/markers/geo/vector.d.ts

@@ -0,0 +1,17 @@
+import type { Accessor } from '../../plots/data/common';
+/** Arrows or spikes at points (svelteplot's `Vector`). */
+export type GeoVectorMarkerConfig<TRow extends Record<string, unknown> = Record<string, unknown>> = {
+    type: 'vector';
+    data: TRow[];
+    x: Accessor<TRow, number>;
+    y: Accessor<TRow, number>;
+    length?: Accessor<TRow, number> | number;
+    rotate?: Accessor<TRow, number> | number;
+    shape?: 'arrow' | 'spike' | 'arrow-filled';
+    anchor?: 'start' | 'middle' | 'end';
+    styles?: {
+        fill?: string;
+        stroke?: string;
+        strokeWidth?: number;
+    };
+};

package/dist/types/markers/geo/vector.js

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