@motionscript/charts 0.1.0-alpha.5 → 0.1.0-alpha.6

package/dist/pie-chart/pie-chart.d.ts

@@ -1,5 +1,5 @@
-import { Node2D, type Command, type CommandArgs, type DataRecord, type NodeConfig, type Node2DProps } from "@motionscript/sdk";
-import { type PieChartTheme, type PieLabelMode, type PieLabelPlacement } from "./shared.js";
+import { type DataRecord, type NodeOf, type Node2D, type Node2DProps } from "@motionscript/sdk";
+import { type PieChartConfig, type PieChartTheme, type PieLabelMode, type PieLabelPlacement } from "./shared.js";
 export interface PieChartProps extends Node2DProps {
     /** One row per slice — a plain record of field name to value. */
     data: DataRecord[];
@@ -21,156 +21,99 @@ export interface PieChartProps extends Node2DProps {
     showLegend?: boolean;
     /** Gap between the ring and the legend, in px. */
     gap?: number;
-    /** Text set in the ring's hole — see {@link revealCenter}. */
+    /** Text set in the ring's hole — see `revealCenter`. */
     centerLabel?: string;
     /** Smaller second line under {@link centerLabel}. */
     centerCaption?: string;
     /**
      * Whether the hole's summary is drawn at rest. `true` (the default) is the
      * plain answer; a scene that wants the conclusion to land on a later beat sets
-     * this `false` and calls {@link revealCenter} when it gets there.
+     * this `false` and runs `revealCenter` when it gets there.
      */
     showCenter?: boolean;
 }
-/** What the selection commands move: the chart's own {@link PieChart.pops}. */
-type SlicePops = {
-    pops: number[];
-};
+/** What the selection reads: the rows, how they are cut, and the pops the commands move. */
+export interface PieChartValues {
+    readonly data: DataRecord[];
+    readonly categoryField: string;
+    readonly valueField: string;
+    readonly theme: PieChartConfig;
+    readonly pops: number[];
+}
+/** Whether slice `index` is grown out past the ring's rim: past half way, so a slice mid-swell is not yet counted. */
+export declare function isSliceSelected(s: PieChartValues, index: number): boolean;
 /**
- * A pie or donut chart, composed from two independent parts rather than one
- * monolithic draw — the third of the chart family, built the same way as the
- * line and bar charts beside it:
+ * A pie or donut chart, composed from two parts laid out by a horizontal-flow
+ * {@link Rect} — the ring filling whatever the hugging legend leaves, both
+ * centred:
  *
  * - {@link PieRing} — the wedges, each sized by its share of the total, with its
- *   label set inside its own band or pinned outside on a leader line, and the
- *   summary in the hole. The only part of the family that draws a path.
+ *   label inside its own band or pinned outside on a leader line, and the
+ *   summary in the hole.
  * - {@link PieLegend} — a column of swatch-and-caption rows naming each slice.
  *
- * The two are laid out by a plain horizontal-flow {@link Rect}: the ring fills whatever the
- * hugging legend leaves, both centred, so the chart re-flows if its box changes.
- *
- * **One mark per row, not per column** — which is what makes this the odd one of
- * the three. A line or a bar chart plots *series*, so its colours belong to
- * columns and hiding one is a sensible thing to ask for. A pie plots rows, so its
- * palette is indexed by row and there is nothing to hide: dropping a slice would
- * silently re-cut every other wedge's share, which is a different chart rather
- * than the same chart with a series switched off. {@link selectSlice} and its
- * siblings are what a pie has instead — a slice swells out of the ring, its hole
- * edge staying put, and everything else dims behind it.
+ * **One mark per row, not per column**: a pie's palette is indexed by row and
+ * there is nothing to hide, since dropping a slice would re-cut every other
+ * wedge. `selectSlice` and its siblings are what a pie has instead — a slice
+ * swells out of the ring and everything else dims behind it.
  *
- * **Resting state is the finished chart** — the same bargain the other two make:
- * an editor paints a node's Initial state on a paused canvas, so a chart that
- * only appeared once a command had run would be edited blind. {@link enter} arms
- * every part back to its pre-entrance state before animating. The one exception
- * is the hole's summary, which a scene can hold back with `showCenter: false`
- * because it is usually the chart's *conclusion* rather than part of its setup.
+ * **Resting state is the finished chart**; `enter` arms every part on its first
+ * frame. The one exception is the hole's summary, which a scene can hold back
+ * with `showCenter: false`, because it is usually the chart's *conclusion*.
  */
-export declare class PieChart extends Node2D<PieChartProps> {
-    data: DataRecord[];
-    categoryField: string;
-    valueField: string;
-    theme: PieChartTheme;
-    labelMode: PieLabelMode;
-    labelPlacement: PieLabelPlacement;
-    gap: number;
-    centerLabel: string;
-    centerCaption: string;
-    /**
-     * How far each slice is currently pushed out of the ring, `0`–`1` per index.
-     *
-     * Held here rather than on the ring because two parts read it: the wedges grow
-     * out by it, and the legend entries dim by it. One signal, one tween, and the
-     * two can't drift.
-     */
-    pops: number[];
-    private ring;
-    private legend;
-    /** `this.theme` read back through its *resolved* shape — see `LineChart.theme`. */
-    private get resolvedTheme();
-    /** The slices the ring and the legend draw, resolved from the rows and the palette. */
-    private get slices();
-    /**
-     * How far each slice is dimmed by the current selection, one entry per slice —
-     * 1 while nothing is selected, and for the selected slice itself; falling
-     * toward the theme's `dimOpacity` for the rest in proportion to how far the
-     * selection has grown.
-     */
-    private sliceDims;
-    /** How far slice `index` is currently pushed out, in `[0, 1]`. */
-    private popAt;
-    constructor(props?: NodeConfig<PieChart, PieChartProps>);
-    /**
-     * Prime every part at its pre-entrance state — no wedges swept, no labels, the
-     * legend shifted and transparent.
-     *
-     * Called by {@link enter} before its first frame so nothing flashes ahead of
-     * its beat. Idempotent, and public so a scene can hide a chart ahead of time
-     * without starting the entrance. The hole's summary is deliberately untouched:
-     * it has its own signal, so a scene that set it up to land later keeps that.
-     */
-    arm(): void;
-    /**
-     * Animate the whole chart in: the wedges sweep in clockwise from the theme's
-     * `startAngle`, then the labels fade up and the legend staggers in together.
-     *
-     * `duration` is the **whole** entrance; the phases are shares of it.
-     */
-    enter(args: CommandArgs<Record<string, never>> & {
-        duration: number;
-    }): Command<Record<string, never>>;
-    /**
-     * Fade the hole's summary up.
-     *
-     * Held out of {@link enter} on purpose: what sits in a donut's hole is usually
-     * the chart's conclusion, so the scene lands it on the beat it belongs to
-     * rather than giving it away with the first frame. Pair it with
-     * `showCenter: false`, which is what leaves the hole clear to begin with.
-     */
-    revealCenter(args?: CommandArgs<Record<string, never>> & {
-        duration?: number;
-    }): Command<{
-        centerReveal: number;
-    }>;
-    /** True when slice `index` is currently grown out past the ring's rim. */
-    isSelected(index: number): boolean;
+export declare const PieChart: import("@motionscript/sdk").Component<"pieChart", import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly data: import("@motionscript/sdk").Type<DataRecord[], DataRecord[], false>;
+    readonly categoryField: "";
+    readonly valueField: "";
+    readonly theme: import("@motionscript/sdk").Type<PieChartTheme, PieChartConfig, false>;
+    readonly labelMode: import("@motionscript/sdk").Type<PieLabelMode, PieLabelMode, false>;
+    readonly labelPlacement: import("@motionscript/sdk").Type<PieLabelPlacement, PieLabelPlacement, false>;
+    readonly gap: 40;
+    readonly centerLabel: "";
+    readonly centerCaption: "";
     /**
-     * Grow slice `index` out past the ring's rim and dim the rest of the chart
-     * behind it, leaving any other selected slice where it is.
+     * How far each slice is pushed out of the ring, `0`–`1` per index. Held here
+     * rather than on the ring because two parts read it: the wedges grow out by
+     * it, and the legend entries dim by it. Seeded flush, one to a row.
      */
-    selectSlice(args: CommandArgs<{
-        sliceIndex: number;
-    }> & {
-        duration?: number;
-    }): Command<SlicePops>;
-    /** Settle slice `index` back flush with the ring. */
-    deselectSlice(args: CommandArgs<{
-        sliceIndex: number;
-    }> & {
-        duration?: number;
-    }): Command<SlicePops>;
-    /** Move the focus to slice `index` alone, settling whatever else was out. */
-    selectOnlySlice(args: CommandArgs<{
-        sliceIndex: number;
-    }> & {
-        duration?: number;
-    }): Command<SlicePops>;
-    /** Settle every slice flush and bring the whole chart back to full. */
-    clearSelection(args?: CommandArgs<Record<string, never>> & {
-        duration?: number;
-    }): Command<SlicePops>;
+    readonly pops: import("@motionscript/sdk").Type<number[], number[], false>;
+    /** Read as the chart is built: the legend is a part the chart builds or doesn't. */
+    readonly showLegend: import("@motionscript/sdk").Type<boolean, boolean, false>;
+    /** Read as the chart is built: whether the hole's summary is drawn at rest. */
+    readonly showCenter: import("@motionscript/sdk").Type<boolean, boolean, false>;
+}>, {
+    readonly enter: {};
+    readonly revealCenter: {};
+    readonly selectSlice: {
+        readonly sliceIndex: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly deselectSlice: {
+        readonly sliceIndex: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly selectOnlySlice: {
+        readonly sliceIndex: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly clearSelection: {};
+}, null, Node2D<Node2DProps>, import("@motionscript/sdk").CallProps<import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly data: import("@motionscript/sdk").Type<DataRecord[], DataRecord[], false>;
+    readonly categoryField: "";
+    readonly valueField: "";
+    readonly theme: import("@motionscript/sdk").Type<PieChartTheme, PieChartConfig, false>;
+    readonly labelMode: import("@motionscript/sdk").Type<PieLabelMode, PieLabelMode, false>;
+    readonly labelPlacement: import("@motionscript/sdk").Type<PieLabelPlacement, PieLabelPlacement, false>;
+    readonly gap: 40;
+    readonly centerLabel: "";
+    readonly centerCaption: "";
     /**
-     * Ease every slice's pop from where it is now to what `pop` asks for.
-     *
-     * Consumes its full duration even when nothing moves: in an editor a
-     * command's duration is what the timeline lays out and what its parallel
-     * siblings are timed against, so a no-op that took no frames would pull
-     * everything after it forward.
-     *
-     * `from` and the targets are read when the command is *built*, which for a
-     * driven scene is with the node in the state its own start time implies — so a
-     * select that follows another starts from where that one left the ring.
+     * How far each slice is pushed out of the ring, `0`–`1` per index. Held here
+     * rather than on the ring because two parts read it: the wedges grow out by
+     * it, and the legend entries dim by it. Seeded flush, one to a row.
      */
-    private tweenPops;
-}
-export {};
+    readonly pops: import("@motionscript/sdk").Type<number[], number[], false>;
+    /** Read as the chart is built: the legend is a part the chart builds or doesn't. */
+    readonly showLegend: import("@motionscript/sdk").Type<boolean, boolean, false>;
+    /** Read as the chart is built: whether the hole's summary is drawn at rest. */
+    readonly showCenter: import("@motionscript/sdk").Type<boolean, boolean, false>;
+}>, null>>;
+export type PieChart = NodeOf<typeof PieChart>;
 //# sourceMappingURL=pie-chart.d.ts.map

package/dist/pie-chart/pie-chart.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pie-chart.d.ts","sourceRoot":"","sources":["../../src/pie-chart/pie-chart.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,MAAM,EAGN,KAAK,OAAO,EACZ,KAAK,WAAW,EAChB,KAAK,UAAU,EAEf,KAAK,UAAU,EACf,KAAK,WAAW,EACjB,MAAM,mBAAmB,CAAA;AAK1B,OAAO,EAML,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EAEvB,MAAM,UAAU,CAAA;AAQjB,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,iEAAiE;IACjE,IAAI,EAAE,UAAU,EAAE,CAAA;IAClB,kFAAkF;IAClF,aAAa,EAAE,MAAM,CAAA;IACrB,iFAAiF;IACjF,UAAU,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,kCAAkC;IAClC,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,2EAA2E;IAC3E,cAAc,CAAC,EAAE,iBAAiB,CAAA;IAClC,iEAAiE;IACjE,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAWD,+EAA+E;AAC/E,KAAK,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAea,QAAS,SAAQ,MAAM,CAAC,aAAa,CAAC;IACQ,IAAI,EAAE,UAAU,EAAE,CAAA;IACxC,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAM7C,KAAK,EAAE,aAAa,CAAA;IACc,SAAS,EAAE,YAAY,CAAA;IACxB,cAAc,EAAE,iBAAiB,CAAA;IACvC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IAExD;;;;;;OAMG;IACkD,IAAI,EAAE,MAAM,EAAE,CAAA;IAGnE,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAyB;IAEvC,mFAAmF;IACnF,OAAO,KAAK,aAAa,GAExB;IAED,uFAAuF;IACvF,OAAO,KAAK,MAAM,GAOjB;IAED;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAYjB,kEAAkE;IAClE,OAAO,CAAC,KAAK;gBAID,KAAK,CAAC,EAAE,UAAU,CAAC,QAAQ,EAAE,aAAa,CAAC;IAqDvD;;;;;;;;OAQG;IACH,GAAG,IAAI,IAAI;IAKX;;;;;OAKG;IAEH,KAAK,CACH,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GAC9D,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAmBjC;;;;;;;OAOG;IAEH,YAAY,CACV,IAAI,GAAE,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GACpE,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAMpC,0EAA0E;IAC1E,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIlC;;;OAGG;IAEH,WAAW,CACT,IAAI,EAAE,WAAW,CAAC;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAChE,OAAO,CAAC,SAAS,CAAC;IAOrB,qDAAqD;IAErD,aAAa,CACX,IAAI,EAAE,WAAW,CAAC;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAChE,OAAO,CAAC,SAAS,CAAC;IAOrB,6EAA6E;IAE7E,eAAe,CACb,IAAI,EAAE,WAAW,CAAC;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAChE,OAAO,CAAC,SAAS,CAAC;IAOrB,uEAAuE;IAEvE,cAAc,CACZ,IAAI,GAAE,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GACpE,OAAO,CAAC,SAAS,CAAC;IAMrB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,SAAS;CAelB"}
+{"version":3,"file":"pie-chart.d.ts","sourceRoot":"","sources":["../../src/pie-chart/pie-chart.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,UAAU,EACf,KAAK,MAAM,EAEX,KAAK,MAAM,EACX,KAAK,WAAW,EAEjB,MAAM,mBAAmB,CAAA;AAO1B,OAAO,EAKL,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EAEvB,MAAM,UAAU,CAAA;AAEjB,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,iEAAiE;IACjE,IAAI,EAAE,UAAU,EAAE,CAAA;IAClB,kFAAkF;IAClF,aAAa,EAAE,MAAM,CAAA;IACrB,iFAAiF;IACjF,UAAU,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,kCAAkC;IAClC,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,2EAA2E;IAC3E,cAAc,CAAC,EAAE,iBAAiB,CAAA;IAClC,iEAAiE;IACjE,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,4FAA4F;AAC5F,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,CAAA;IAC3B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAA;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAA;CACxB;AAqBD,sHAAsH;AACtH,wBAAgB,eAAe,CAAC,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAEzE;AAsCD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;IAYjB;;;;OAIG;;IAEH,oFAAoF;;IAEpF,+EAA+E;;;;;;;;;;;;;;;;;;;;;;;;;IAR/E;;;;OAIG;;IAEH,oFAAoF;;IAEpF,+EAA+E;;UAsHjF,CAAA;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,QAAQ,CAAC,CAAA"}