@tangle-network/charts 0.4.0 → 0.7.0

package/dist/react/index.d.ts

@@ -1,3 +1,4 @@
+import { a as BandKind, c as MarkKind, m as Figure, o as ChartBand, r as TimelineSpan, s as ChartMark, t as TimelineLane, y as Refusal } from "../timeline-BAjzF-wL.js";
 import { ReactElement, ReactNode } from "react";
 //#region src/react/sparkline.d.ts
 type SparklineDirection = "rising" | "falling" | "flat";
@@ -65,6 +66,12 @@ interface StackedBarBucket {
   readonly total: number | null;
   /** Stack order is input order. Charts neither groups nor sorts. */
   readonly segments: readonly StackedBarSegment[];
+  /**
+   * Caller-owned text about this bucket that the chart cannot derive, such as
+   * request counts. Appended to the bar's name, the live readout and the
+   * pointer tooltip; never parsed.
+   */
+  readonly description?: string;
 }
 interface StackedBarChartProps {
   label: string;
@@ -131,6 +138,10 @@ interface WaterfallHeaderProps extends WaterfallTimeAxisProps {
 }
 export declare function WaterfallHeader({ label, attribution, durationLabel, ...axis }: WaterfallHeaderProps): import("react").JSX.Element;
 //#endregion
+//#region src/svg.d.ts
+/** Point shapes: the second channel that keeps series distinct without colour. */
+type MarkerShape = "circle" | "square" | "triangle" | "diamond";
+//#endregion
 //#region src/react/live.d.ts
 export declare const LIVE_SERIES: readonly ['#8b7cf6', '#0ea5a0', '#c98500', '#e2508f', '#4a90e2'];
 export declare const formatCompact: (value: number | null | undefined) => string;
@@ -177,25 +188,41 @@ export declare function Histogram({ bins, format, color, unit, rows }: {
 }): import("react").JSX.Element;
 /** Lines over time on one axis (at most four series); the crosshair readout lists each series at the nearest time. A
  * `dots` series draws its points as marks (checkpoints) instead of a line; `axis` labels the time axis (default MM-DD). */
-export declare function Lines({ series, format, rows, axis }: {
-  series: {
-    name: string;
-    color: string;
-    points: [number, number][];
-    dots?: boolean;
-    label?: (t: number) => string;
-  }[];
+export declare function Lines({ series, format, rows, axis, marks, bands }: {
+  series: LineSeries[];
   format?: (v: number) => string;
   rows?: number;
   axis?: (t: number) => string;
+  marks?: ChartMark[];
+  bands?: ChartBand[];
 }): import("react").JSX.Element;
-/** A used-of-total meter with its numbers. */
-export declare function Meter({ used, total, format, tone, text }: {
-  used: number | null | undefined;
+/** A line series. `dash` and `marker` are a second channel, so arms stay distinct without colour. */
+interface LineSeries {
+  name: string;
+  color: string;
+  points: [number, number][];
+  dots?: boolean;
+  label?: (t: number) => string;
+  dash?: 'solid' | 'dash' | 'dot';
+  marker?: MarkerShape;
+}
+/** One part of a whole. A null value is listed as not recorded and takes no width; `untraced` parts are hatched. */
+interface MeterSegment {
+  label: string;
+  value: number | null;
+  color?: string;
+  kind?: 'measured' | 'untraced';
+}
+/** A used-of-total meter with its numbers. With `segments` it is a part-of-whole bar: the remainder of `total` that no
+ * segment accounts for is drawn hatched and labelled `untraced`, and a missing total hatches the whole track. */
+export declare function Meter({ used, total, format, tone, text, segments, untraced }: {
+  used?: number | null | undefined;
   total: number | null | undefined;
   format?: (v: number) => string;
   tone?: string;
   text?: string;
+  segments?: MeterSegment[];
+  untraced?: string;
 }): import("react").JSX.Element;
 /** A small line of one series for a row in a list (one hue; the row's label carries identity). */
 export declare function Spark({ points, max, color }: {
@@ -204,18 +231,32 @@ export declare function Spark({ points, max, color }: {
   color?: string;
 }): import("react").JSX.Element;
 /** One bar per row on a shared time axis (who worked when): each row's bar spans its start to its end, coloured by its
- * state; hovering a row names it, its state and its span. Times are epoch ms; `axis` labels the time axis. */
-export declare function Gantt({ rows, colors, axis, span }: {
-  rows: {
+ * state; hovering a span names it, its state and its span. Times are epoch ms; `axis` labels the time axis.
+ * `lanes` give a row several spans (the same shape as the static `timeline`); a span with `end: null` is open and runs
+ * to `now`. `marks` draw recorded events across every lane, and states in `hatch` are drawn hatched (no data). */
+export declare function Gantt({ rows, lanes: laneInput, colors, axis, span, marks, now, hatch }: {
+  rows?: {
     label: string;
     start: number;
     end: number;
     state: string;
     note?: string;
   }[];
+  lanes?: TimelineLane[];
   colors: Record<string, string>;
   axis: (t: number) => string;
   span: (start: number, end: number) => string;
+  marks?: ChartMark[];
+  now?: number;
+  hatch?: string[];
 }): import("react").JSX.Element;
 //#endregion
-export type { SparklineDirection, SparklineGeometry, SparklineGeometryOptions, SparklineLabelOptions, SparklinePoint, SparklineProps, SparklineValues, StackedBarBucket, StackedBarChartProps, StackedBarSegment, StackedBarSeries, WaterfallBarProps, WaterfallHeaderProps, WaterfallRowProps, WaterfallSpanGeometry, WaterfallTimeAxisProps, WaterfallWindow };
+//#region src/react/figure-view.d.ts
+interface FigureViewProps {
+  figure: Figure | Refusal;
+  /** `chart` (default) keeps the lede, reading and method in the disclosure; `report` also shows the finding and lede. */
+  presentation?: 'chart' | 'report';
+}
+export declare function FigureView({ figure, presentation }: FigureViewProps): import("react").JSX.Element;
+//#endregion
+export type { BandKind, ChartBand, ChartMark, Figure, FigureViewProps, LineSeries, MarkKind, MarkerShape, MeterSegment, Refusal, SparklineDirection, SparklineGeometry, SparklineGeometryOptions, SparklineLabelOptions, SparklinePoint, SparklineProps, SparklineValues, StackedBarBucket, StackedBarChartProps, StackedBarSegment, StackedBarSeries, TimelineLane, TimelineSpan, WaterfallBarProps, WaterfallHeaderProps, WaterfallRowProps, WaterfallSpanGeometry, WaterfallTimeAxisProps, WaterfallWindow };