@sophistry/charts 0.0.0-stage → 0.0.1

package/dist/frame/secondary.d.ts

@@ -0,0 +1,57 @@
+/**
+ * A `chart`'s secondary axes: `x2` on the top edge for the layers inside a
+ * `secondaryX`, `y2` on the right for a `secondaryY`. Continuous only.
+ */
+import type { AxisFit, AxisFitInput, GivenRange, MergedAxisOptions, ResolvedAxis } from "./fit";
+import type { ChartLayerExtent, ChartProps } from "./types";
+/** Which secondary axes a context maps through. */
+export interface SecondaryFlags {
+    x2: boolean;
+    y2: boolean;
+}
+/**
+ * A layer's report as a secondary axis sees it: `x` moved to `x2` and/or `y`
+ * to `y2`, the far end of a keyed transition too.
+ */
+export declare function onSecondary(report: ChartLayerExtent, flags: SecondaryFlags): ChartLayerExtent;
+/** What one update of a secondary axis's fit reads; every field keeps its identity while unchanged. */
+export interface SecondaryFitInput {
+    props: Readonly<ChartProps>;
+    /** The range given for this axis, numeric. */
+    given: GivenRange;
+    /** Whether a layer on this axis has read `Date`s. */
+    dates: boolean;
+    primaryOptions: MergedAxisOptions;
+    primaryGiven: GivenRange;
+    /** The primary axis's fitted ends (see `createAxisFit`). */
+    primaryFitted: {
+        from: ResolvedAxis;
+        to: ResolvedAxis;
+    } | undefined;
+    reports: readonly ChartLayerExtent[];
+    /** The reports the primary axis is fitted to. */
+    fitReports: readonly ChartLayerExtent[];
+    transitioning: boolean;
+}
+/** A secondary axis's state on one update. */
+export interface SecondaryState {
+    options: MergedAxisOptions;
+    /** Whether any layer maps through this axis. */
+    has: boolean;
+    /** The input its {@link AxisFit} reads. */
+    input: AxisFitInput;
+}
+/** A secondary axis's fit; see {@link secondaryFit}. */
+export interface SecondaryFit extends AxisFit {
+    /** This update's options, flags and fit input. */
+    state(input: SecondaryFitInput): SecondaryState;
+}
+/**
+ * A secondary axis's fit: its options, whether any layer maps through it,
+ * and both ends of a keyed transition. With `alignTicks` its range comes
+ * from the primary's range and ticks at each end instead of its own fit;
+ * everything here reads only steady inputs, never the blended axes. Make
+ * one per secondary axis in `setup`.
+ */
+export declare function secondaryFit(axis: "x" | "y"): SecondaryFit;
+//# sourceMappingURL=secondary.d.ts.map

package/dist/frame/secondary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secondary.d.ts","sourceRoot":"","sources":["../../src/frame/secondary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,KAAK,EACX,OAAO,EACP,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,YAAY,EACZ,MAAM,OAAO,CAAC;AAQf,OAAO,KAAK,EAGX,gBAAgB,EAChB,UAAU,EAEV,MAAM,SAAS,CAAC;AAEjB,mDAAmD;AACnD,MAAM,WAAW,cAAc;IAC9B,EAAE,EAAE,OAAO,CAAC;IACZ,EAAE,EAAE,OAAO,CAAC;CACZ;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAC1B,MAAM,EAAE,gBAAgB,EACxB,KAAK,EAAE,cAAc,GACnB,gBAAgB,CAgBlB;AAED,uGAAuG;AACvG,MAAM,WAAW,iBAAiB;IACjC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC5B,8CAA8C;IAC9C,KAAK,EAAE,UAAU,CAAC;IAClB,qDAAqD;IACrD,KAAK,EAAE,OAAO,CAAC;IACf,cAAc,EAAE,iBAAiB,CAAC;IAClC,YAAY,EAAE,UAAU,CAAC;IACzB,4DAA4D;IAC5D,aAAa,EAAE;QAAE,IAAI,EAAE,YAAY,CAAC;QAAC,EAAE,EAAE,YAAY,CAAA;KAAE,GAAG,SAAS,CAAC;IACpE,OAAO,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACrC,iDAAiD;IACjD,UAAU,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACxC,aAAa,EAAE,OAAO,CAAC;CACvB;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC9B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,gDAAgD;IAChD,GAAG,EAAE,OAAO,CAAC;IACb,2CAA2C;IAC3C,KAAK,EAAE,YAAY,CAAC;CACpB;AAED,wDAAwD;AACxD,MAAM,WAAW,YAAa,SAAQ,OAAO;IAC5C,kDAAkD;IAClD,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,cAAc,CAAC;CAChD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,YAAY,CA2I1D"}

package/dist/frame/tooltip-overlay.d.ts

@@ -0,0 +1,65 @@
+/**
+ * The panel a chart's tooltip is drawn on: `tooltipOverlay` draws a
+ * {@link TooltipState}'s active tooltip by the pointer or above its datum,
+ * kept inside the view, and in nearest-x mode the shared tooltip and its
+ * crosshair while the pointer is over the plotting area.
+ *
+ * The chart creates one overlay and binds its `active`, `pointsVersion`,
+ * `pointer` and `view` props to the tooltip state's and scene's `Readable`s,
+ * so it updates exactly when one of them changes and costs nothing
+ * otherwise.
+ */
+import type { ScenePointer } from "@sophistry/core";
+import type { Bounds } from "@sophistry/core/geometry";
+import type { ActiveTooltip, TooltipContent, TooltipState } from "../tooltip";
+/** A tooltip's content laid out at the origin: its lines, columns and size. */
+export interface TooltipLayout {
+    width: number;
+    height: number;
+    items: {
+        name: string;
+        value: string;
+        /** Offsets from the panel's top-left corner. */
+        nameX: number;
+        valueX: number;
+        y: number;
+        color?: string;
+    }[];
+}
+/**
+ * Lays a tooltip's content out: rows in two columns (names, values), a
+ * swatch column when any row has a colour, an optional heading line.
+ *
+ * @internal
+ */
+export declare function layoutTooltip(content: TooltipContent, fontFamily: string, heading?: string): TooltipLayout;
+/**
+ * Props for {@link tooltipOverlay}.
+ *
+ * @category Extending
+ */
+export interface TooltipOverlayProps {
+    /** The tooltip state to draw. */
+    state: TooltipState | null;
+    /** The plotting area, for nearest-x mode. */
+    area?: Bounds;
+    /** Bind to `state.active`. */
+    active?: ActiveTooltip | null;
+    /** Bind to `state.pointsVersion`. */
+    pointsVersion?: number;
+    /** Bind to the scene's pointer (`pointerContext`). */
+    pointer?: ScenePointer | null;
+    /** Bind to the scene's view (`frameContext`): the panel stays inside it. */
+    view?: Bounds;
+    zIndex?: number;
+}
+/**
+ * Draws a {@link TooltipState}'s active tooltip on a small panel, by the
+ * pointer or above its datum, kept inside the view; in nearest-x mode, the
+ * shared tooltip and crosshair while the pointer is over `area`. A chart
+ * makes one; make your own for a tooltip state you keep yourself.
+ *
+ * @category Extending
+ */
+export declare const tooltipOverlay: import("@sophistry/core").Definition<TooltipOverlayProps, import("@sophistry/core/internal").CompositeNode<TooltipOverlayProps>, keyof TooltipOverlayProps>;
+//# sourceMappingURL=tooltip-overlay.d.ts.map

package/dist/frame/tooltip-overlay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tooltip-overlay.d.ts","sourceRoot":"","sources":["../../src/frame/tooltip-overlay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAGX,YAAY,EACZ,MAAM,iBAAiB,CAAC;AAUzB,OAAO,KAAK,EAAE,MAAM,EAAS,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EACX,aAAa,EACb,cAAc,EAGd,YAAY,EACZ,MAAM,YAAY,CAAC;AAepB,+EAA+E;AAC/E,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,gDAAgD;QAChD,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACJ;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC5B,OAAO,EAAE,cAAc,EACvB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,GACd,aAAa,CAiDf;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC,iCAAiC;IACjC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3B,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAC9B,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sDAAsD;IACtD,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAC9B,4EAA4E;IAC5E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAuND;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,6JAazB,CAAC"}