@kymoscope/sdk 0.2.0 → 0.3.0

package/dist/types/components/GaugeChart.d.ts

@@ -12,16 +12,26 @@ export interface GaugeReading {
     alarm?: AlarmLine | null;
     color: string;
     style: 'arc' | 'linear';
+    /** The filled part starts at 0 (marked on the scale) instead of at `min`. */
+    fromZero?: boolean;
     /** Colours by value (see GaugeItem.colorMode). */
     colorMode?: GaugeColorMode;
     stops?: GaugeColorStop[];
+    /** 'last' follows `live` every frame (when given). */
+    stat?: 'last' | 'mean' | 'min' | 'max';
 }
 export interface GaugeChartProps {
     gauges: GaugeReading[];
+    /** A live stream read every frame (no React at data rate): its newest sample's
+     *  time, and a column's value at a time (the sample at or before it). */
+    live?: {
+        latestT: () => number;
+        valueAt: (column: string, t: number) => number;
+    };
     backgroundToken?: string;
     onPlotContextMenu?: (e: {
         clientX: number;
         clientY: number;
     }) => void;
 }
-export declare function GaugeChart({ gauges, backgroundToken, onPlotContextMenu }: GaugeChartProps): import("react/jsx-runtime").JSX.Element;
+export declare function GaugeChart({ gauges, live, backgroundToken, onPlotContextMenu }: GaugeChartProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/data/liveDataSource.d.ts

@@ -54,7 +54,7 @@ export declare class LiveDataSource implements DataSource {
     /** Time of the newest sample (NaN if empty). */
     latestTimeSync(): number;
     /** Value of `column` at time `t` (see LiveBuffer.xAtTime). */
-    xAtTimeSync(column: string, t: number): number;
+    xAtTimeSync(column: string, t: number, hold?: boolean): number;
     /** The newest sample's value of `column` (NaN if none): the live position on X. */
     latestSync(column: string): number;
     /** Newest received value of each column it has (finite values only). */

package/dist/types/lib/live/buffer.d.ts

@@ -247,8 +247,9 @@ export declare class LiveBuffer {
      * Value of `key` at time `t`: interpolated between the samples around it, but
      * never across a drop (a lap-distance wrap), where it holds the earlier sample.
      * Clamped to the buffered range; NaN if empty or the time column steps back.
+     * `hold`: the sample at or before `t`, never interpolated (a gauge's reading).
      */
-    xAtTime(key: string, t: number): number;
+    xAtTime(key: string, t: number, hold?: boolean): number;
     private boundsCache;
     /** Min/max of a column over the ring (the chart asks every frame): the ends of
      *  an ascending time axis, else a scan once per data change. */

package/dist/types/lib/panelChartSettings.d.ts

@@ -325,6 +325,9 @@ export interface GaugeItem {
     /** What it shows of its column: the latest value (follows a live stream), or the mean, minimum or maximum. */
     value: 'last' | 'mean' | 'min' | 'max';
     style: 'arc' | 'linear';
+    /** Where the filled part starts: the scale's minimum (missing), or zero (a value
+     *  of -300…300 fills left or right of 0). */
+    fill?: 'min' | 'zero';
     /** Scale ends ('' = from the column's data, rounded). */
     min: string;
     max: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kymoscope/sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The Kymoscope data engine and charts for the browser: import large measurement files, plot them, stream live data end-to-end encrypted.",
   "license": "SEE LICENSE IN LICENSE.md",
   "homepage": "https://kymoscope.com/docs/introduction",