@ixfx/components 0.4.2 → 0.4.4

package/dist/{xy-axis-CEI7ojks.d.ts → xy-axis-5KhVTNoX.d.ts}

@@ -1,11 +1,13 @@
 import { LitElement, PropertyValues } from "lit";
-
 //#region src/plots/colour-map.d.ts
 type ColourMode = `fixed` | `opacity` | `hue` | `saturation` | `lightness` | `scale`;
 type ColourMapConfig = {
-  mode: ColourMode; /** Parsed colours for 'scale' mode. Must have ≥ 2 entries. */
-  palette: string[]; /** ixfx easing name — applied before the colour mode mapping. Takes precedence over valueMap. */
-  easingName: string; /** Custom value mapping fn (0..1 → 0..1). Used when easingName is empty. */
+  mode: ColourMode;
+  /** Parsed colours for 'scale' mode. Must have ≥ 2 entries. */
+  palette: string[];
+  /** ixfx easing name — applied before the colour mode mapping. Takes precedence over valueMap. */
+  easingName: string;
+  /** Custom value mapping fn (0..1 → 0..1). Used when easingName is empty. */
   valueMap: ((v: number) => number) | null;
 };
 type ColourResult = {
@@ -43,6 +45,10 @@ type PlotDataSeriesOptions = {
    * Default: true
    */
   persistentScaling: boolean;
+  fixedRange: {
+    min: number;
+    max: number;
+  } | null;
 };
 /**
  * A data series
@@ -50,19 +56,28 @@ type PlotDataSeriesOptions = {
 declare class PlotDataSeries {
   #private;
   values: number[];
-  range: {
-    min: number;
-    max: number;
-  };
   /**
    * Constructor.
    *
    * Default options:
    * - `capacityLimit`: 100
    * - `persistentScaling`: true
+   * - `fixedRange`: null
    * @param options
    */
   constructor(options?: Partial<PlotDataSeriesOptions>);
+  /**
+   * Sets a manual range, this disabled auto-scaling.
+   * Use {@link unsetRange} to re-enable auto-scaling.
+   * @param min
+   * @param max
+   */
+  setRange(min: number, max: number): void;
+  /**
+   * Disable the manual range
+   */
+  unsetRange(): void;
+  get isAutoRange(): boolean;
   /**
    * Adds a single value
    * @param valueOrValues Value to add
@@ -73,6 +88,13 @@ declare class PlotDataSeries {
    * @param values
    */
   set(values: number[]): void;
+  /**
+   * Returns the manual range if this is in effect, or the automatic
+   */
+  get range(): {
+    min: number;
+    max: number;
+  };
   /**
    * Clear all data and reset range. If `persistentScaling` is _false_, also resets scaling to initial state.
    * @returns _true_ if there was data to clear
@@ -98,6 +120,8 @@ declare class PlotSingleAxis extends LitElement {
   precise: boolean;
   tooltips: boolean;
   capacity: number;
+  rangeMin: number;
+  rangeMax: number;
   persistentScale: boolean;
   paused: boolean;
   clickPauses: boolean;
@@ -112,24 +136,6 @@ declare class PlotSingleAxis extends LitElement {
   private _height;
   /** Override to customize tooltip label. */
   valueFormat: (v: number | undefined) => string;
-  /**
-   * Get all values in the data series as a readonly array.
-   */
-  get values(): readonly number[];
-  /**
-   * Get length of data series
-   */
-  get dataCount(): number;
-  /**
-   * Get value at specific index of data series
-   * @param index
-   */
-  getValueAt(index: number): number | undefined;
-  /**
-   * Get value index based on client X position
-   * @param clientX
-   */
-  getIndexFromClientX(clientX: number): number;
   /**
    * Adds a value to the data series.
    *
@@ -161,6 +167,25 @@ declare class PlotSingleAxis extends LitElement {
   clear(): boolean;
   protected firstUpdated(_changed: PropertyValues): void;
   protected updated(changed: PropertyValues): void;
+  get series(): PlotDataSeries;
+  /**
+   * Get all values in the data series as a readonly array.
+   */
+  get values(): readonly number[];
+  /**
+   * Get length of data series
+   */
+  get dataLength(): number;
+  /**
+   * Get value at specific index of data series
+   * @param index
+   */
+  getValueAt(index: number): number | undefined;
+  /**
+   * Get value index based on client X position
+   * @param clientX
+   */
+  getIndexFromClientX(clientX: number): number;
   render(): import("lit").TemplateResult<1>;
   static styles: import("lit").CSSResult;
 }
@@ -260,6 +285,12 @@ interface PlotMultiAxis {
 //#endregion
 //#region src/plots/plot-histogram.d.ts
 type PlotHistogramOrientation = `horizontal` | `vertical`;
+/**
+ * - `hover`: floating `ixfx-tooltip` bubble, shown/hidden with a debounce delay.
+ * - `inline`: the title overlay-text switches to the hovered bucket's value, instantly.
+ * - `none`: no hover feedback.
+ */
+type PlotHistogramValueTooltips = `hover` | `inline` | `none`;
 type PlotHistogramBucketClickDetail = {
   readonly bucketIndex: number;
   readonly valueMin: number;
@@ -277,15 +308,30 @@ declare class PlotHistogram extends LitElement {
   min?: number;
   max?: number;
   capacity: number;
+  /**
+   * Fallback overlay-text, shown when nothing is hovered.
+   * Not reflected to the native `title` attribute, so the browser's own hover tooltip doesn't show.
+   */
   title: string;
   paused: boolean;
+  /** How hovering a bucket is communicated: a floating tooltip, the inline overlay-text, or nothing. */
+  valueTooltips: PlotHistogramValueTooltips;
+  /** Delay (ms) before the `hover` tooltip appears/disappears. Switching directly between buckets is instant. */
+  tooltipDelay: number;
+  /** Max rate (ms) at which an already-shown value display refreshes to match live-changing bucket data. */
+  valueUpdateInterval: number;
+  /** Override to customize the value/frequency label used by the tooltip and overlay text. */
+  valueFormat: (valueMin: number, valueMax: number, frequency: number) => string;
   private _width;
   private _height;
+  private _hoveredIndex;
+  private _inlineOverlayText;
   add(v: number): void;
   set(values: number[]): void;
   clear(): void;
   protected firstUpdated(_changed: PropertyValues): void;
   protected updated(changed: PropertyValues): void;
+  disconnectedCallback(): void;
   render(): import("lit").TemplateResult<1>;
   static styles: import("lit").CSSResult;
 }
@@ -336,7 +382,7 @@ declare global {
   interface HTMLElementTagNameMap {
     'ixfx-plot-xy-axis': PlotXyAxis;
   }
-} //# sourceMappingURL=xy-axis.d.ts.map
+}
 //#endregion
-export { ColourMode as C, parseColourScaleAttr as D, computeColour as E, readBaseColour as O, ColourMapConfig as S, applyAgeModification as T, PlotSingleAxisPointerMoveEvent as _, PlotHistogramBucketClickDetail as a, PlotDataSeries as b, PlotHistogramOrientation as c, PlotMultiAxisDataPointClickEvent as d, PlotMultiAxisElementEventMap as f, PlotSingleAxisPointerMoveDetail as g, PlotSingleAxisElementEventMap as h, PlotHistogram as i, PlotMultiAxis as l, PlotSingleAxis as m, XyAgeStyle as n, PlotHistogramBucketClickEvent as o, PlotMultiAxisLayout as p, XyDrawStyle as r, PlotHistogramElementEventMap as s, PlotXyAxis as t, PlotMultiAxisDataPointClickDetail as u, SingleAxisAgeStyle as v, ColourResult as w, PlotDataSeriesOptions as x, SingleAxisDrawStyle as y };
-//# sourceMappingURL=xy-axis-CEI7ojks.d.ts.map
+export { ColourMapConfig as C, computeColour as D, applyAgeModification as E, parseColourScaleAttr as O, PlotDataSeriesOptions as S, ColourResult as T, PlotSingleAxisPointerMoveDetail as _, PlotHistogramBucketClickDetail as a, SingleAxisDrawStyle as b, PlotHistogramOrientation as c, PlotMultiAxisDataPointClickDetail as d, PlotMultiAxisDataPointClickEvent as f, PlotSingleAxisElementEventMap as g, PlotSingleAxis as h, PlotHistogram as i, readBaseColour as k, PlotHistogramValueTooltips as l, PlotMultiAxisLayout as m, XyAgeStyle as n, PlotHistogramBucketClickEvent as o, PlotMultiAxisElementEventMap as p, XyDrawStyle as r, PlotHistogramElementEventMap as s, PlotXyAxis as t, PlotMultiAxis as u, PlotSingleAxisPointerMoveEvent as v, ColourMode as w, PlotDataSeries as x, SingleAxisAgeStyle as y };
+//# sourceMappingURL=xy-axis-5KhVTNoX.d.ts.map

package/dist/xy-axis-5KhVTNoX.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xy-axis-5KhVTNoX.d.ts","names":[],"sources":["../src/plots/colour-map.ts","../src/plots/data.ts","../src/plots/single-axis.ts","../src/plots/multi-axis.ts","../src/plots/plot-histogram.ts","../src/plots/xy-axis.ts"],"mappings":";;KAeY;KAEA;EACV,MAAM;;EAEN;;EAEA;;EAEA,YAAY;;KAGF;EAAiB;EAAc;;;iBA2C3B,eAAe,IAAI;;iBAMnB,qBAAqB;;;;;;;iBAuCrB,cAAc,qBAAqB,oBAAoB,QAAQ,kBAAkB;;;;;iBAkDjF,qBAAqB,MAAM,cAAc,qBAAqB,mBAAmB;;;KCnKrF;;;;;EAKV;;;;;;;EAOA;EAEA;IAAc;IAAa;;;;;;cAMhB;;EACX;;;;;;;;;;EAeY,YAAA,UAAS,QAAQ;;;;;;;EAkB7B,SAAS,aAAa;;;;EAOtB;MAKI;;;;;EAQJ,IAAI;;;;;EAmCJ,IAAI;;;;MAWA;IAhGiB;IAAa;;;;;;EA0GlC;;;;KC1HU;KAWA;;;;;;;;cAyHC,uBAAuB;;EAElC,WAAW;EAGX,UAAU;EAEE;EAEiB;EACA;EACD;EAEA;EACA;EAG5B;EAE4C;EACY;EAGxD;EAGA;EAGuC,WAAW;EACT;EACD;;EAExC,iBAAiB;UAEA;UACA;;EAiBjB,cAAc;;;;;;;;;;EAWd,IAAI,kCAAkC;;;;;EActC;;;;;;;;;;EAcA,IAAI,kBAAkB;;;;EAatB;YAMmB,aAAa,UAAU;YAkBvB,QAAQ,SAAS;MA0FhC,UAAM;;;;MAON;;;;MAOA;;;;;EAQJ,WAAW;;;;;EAQX,oBAAoB;EAyCX,wBAAM;SA8EC,sBAAM;;KAwBZ;WACD;WACA;WACA;;KAGC,iCAAiC,YAAY;UAExC;EACf,qBAAqB;EACrB,sBAAsB;;QAGhB;YACI;IACR,yBAAyB;;;UAKZ;EACf;KACG,gBAAgB,+BACf,MAAM,GACN,WAAW,MAAM,gBAAgB,OAAO,8BAA8B,aACtE,oBAAoB;KAGpB,cACA,UAAU,oCACV,oBAAoB;;;;;KC7iBd;KAEA;WACD;WACA;WACA;;KAGC,mCAAmC,YAAY;UAE1C;EACf,wBAAwB;;cAgBb,sBAAsB;;EACrB,QAAQ;EAGpB;;EAGA,cAAc;;;;;;;EAad,QAAQ,cAAc,eAAe,0BAAwB;EAS7D,QAAQ,cAAc,kBAAkB,0BAAwB;EAchE,WAAW,MAAM,0BAA0B;;;;EAc3C;;;;;;EAWA,UAAU,MAAM,mCAAmC;;;;;;EAgBnD,YAAY,cAAc,QAAQ;;;;;EAoBlC;;;;;;EAaA,YAAY;;;;MAYR;YA4Fe,wBAAM;SAmBT,sBAAM;;QAkDhB;YACI;IACR,wBAAwB;;;UAKX;EACf;KACG,gBAAgB,8BACf,MAAM,GACN,WAAW,MAAM,eAAe,OAAO,6BAA6B,aACpE,oBAAoB;KAGpB,cACA,UAAU,oCACV,oBAAoB;;;;;KC7Ud;;;;;;KAOA;KAEA;WACD;WACA;WACA;WACA;;KAGC,gCAAgC,YAAY;UAEvC;EACf,qBAAqB;;cAeV,sBAAsB;;EAEjC,aAAa;EAGb;EAGA;EAGA;EAGA;;;;;EAOA;EAGA;;EAIA,eAAe;;EAIf;;EAIA;;EAGA,cAAc,kBAAkB,kBAAkB;UAGjC;UACA;UACA;UACA;EAYjB,IAAI;EAQJ,IAAI;EAQJ;YAKmB,aAAa,UAAU;YA2BvB,QAAQ,SAAS;EAc3B;EAuRA,wBAAM;SA8BC,sBAAM;;QAmChB;YACI;IACR,uBAAuB;;;UAIV;EACf,oBAAoB,gBAAgB,8BAClC,MAAM,GACN,WAAW,MAAM,eAAe,OAAO,6BAA6B,aACpE,oBAAoB,sCAEpB,cACA,UAAU,oCACV,oBAAoB;;;;KC9fZ;KACA;cAOC,mBAAmB;;EAE9B,WAAW;EAGX,UAAU;EAEE;EACiB;EACA;EACD;EAG5B;EAE4C;EACY;EAGjB,WAAW;EACT;EACD;;;;;EAKxC,iBAAiB;UAEA;UACA;;EAMjB,cAAc,WAAW;EAEzB,IAAI,WAAW;EASf,MAAM,cAAc;EASpB;YAMmB,aAAa,UAAU;YAWvB,QAAQ,SAAS;EA8G3B,wBAAM;SAkEC,sBAAM;;QAuBhB;YACI;IACR,qBAAqB"}