@ixfx/components 0.1.5 → 0.2.1

package/dist/charts/plot.d.ts

@@ -1,8 +1,30 @@
 import { LitElement, type PropertyValues } from "lit";
 import { type Ref } from "lit/directives/ref.js";
 import { CanvasHelper } from "ixfx/visual.js";
-import type { Rect, RectPositioned } from "ixfx/geometry.js";
-import { Colour, type DrawingHelper } from "ixfx/visual.js";
+import { type RectPositioned } from "ixfx/geometry.js";
+import * as Numbers from 'ixfx/numbers.js';
+import { type DrawingHelper } from "ixfx/visual.js";
+export type SeriesColourGenerator = (seriesName: string) => string;
+export declare class PlotAxis {
+    #private;
+    name: string;
+    bounds: PlotAxisBounds;
+    constructor(name: string);
+    humanFormatValue(value: number[]): string;
+    getRange(series: Iterable<PlotSeries>): Numbers.NumericRange;
+    getCurrentRange(): Readonly<{
+        min: number;
+        max: number;
+    }> | undefined;
+    getValueScaler(series: Iterable<PlotSeries>): (value: number) => number;
+    computeActualRange(seriesOnAxis: Iterable<PlotSeries>, column?: number): {
+        min: number;
+        max: number;
+    };
+}
+export type PlotSeriesDefault = {
+    limit: number;
+};
 /**
  * Attributes
  * * streaming: true/false (default: true)
@@ -12,7 +34,7 @@ import { Colour, type DrawingHelper } from "ixfx/visual.js";
  *
  * * line-width: stroke width of drawing line (default:2)
  *
- * * render: 'dot' or 'line' (default: 'dot')
+ * * render: 'dot', 'line' or 'bar'(default: 'dot')
  * * hide-legend: If added, legend is not shown
  * * manual-draw: If added, automatic drawning is disabled
  *
@@ -21,21 +43,29 @@ import { Colour, type DrawingHelper } from "ixfx/visual.js";
  */
 export declare class PlotElement extends LitElement {
     #private;
-    streaming: boolean;
     hideLegend: boolean;
-    maxLength: number;
-    dataWidth: number;
-    fixedMax: number;
-    fixedMin: number;
-    lineWidth: number;
-    renderStyle: string;
-    manualDraw: boolean;
+    renderStyle: PlotElementRenderStyle;
     padding: number;
+    readonly primaryAxis: PlotAxis;
+    readonly secondaryAxis: PlotAxis;
     paused: boolean;
+    plotAreaFormat: PlotObjectFormatting;
+    /**
+     * Settings used for automatically generating series colour
+     */
+    automaticSeriesColour: {
+        saturation: number;
+        lightness: number;
+        alpha: number;
+    };
+    seriesDefault: Partial<PlotSeriesDefault>;
     canvasEl: Ref<HTMLCanvasElement>;
-    seriesRanges: Map<string, [min: number, max: number]>;
+    tooltipEl: Ref<HTMLDivElement>;
+    seriesColourGenerate: SeriesColourGenerator;
     get series(): PlotSeries[];
     get seriesCount(): number;
+    getSeriesFormatting(seriesName: string, createIfNeeded: boolean): SeriesFormatting | undefined;
+    setSeriesFormatting(seriesName: string, formatting: Partial<SeriesFormatting>): void;
     /**
      * Returns a `PlotElement` instance based on a query
      * ```js
@@ -68,23 +98,24 @@ export declare class PlotElement extends LitElement {
      * Keeps all series, but deletes their data
      */
     clearData(): void;
-    render(): import("lit-html").TemplateResult<1>;
     connectedCallback(): void;
     protected firstUpdated(_changedProperties: PropertyValues): void;
     updateColours(): void;
-    plot(value: number, seriesName?: string, skipDrawing?: boolean): PlotSeries;
-    plotSeries(values: number[], seriesName?: string, skipDrawing?: boolean): PlotSeries;
+    setRawValues(values: number[], seriesName: string, automaticallyDraw: boolean): PlotSeries;
+    /**
+     * Treats each property of an object as the series name
+     * @param value
+     * @param automaticallyDraw
+     */
+    appendObjectBySeries(value: object, automaticallyDraw: boolean): void;
+    appendRawValues(values: number[] | number, seriesName: string, automaticallyDraw: boolean): void;
     /**
      * Draw a set of key-value pairs as a batch.
      * @param value
      */
-    plotObject(value: object): void;
-    colourGenerator(_series: string): Colour.Colourish;
     draw(): void;
     drawLegend(cl: RectPositioned, d: DrawingHelper): void;
-    drawLineSeries(data: number[], cp: Rect, d: DrawingHelper, colour: string): void;
-    drawDotSeries(data: number[], cp: Rect, d: DrawingHelper, colour: string): void;
-    computePlot(c: CanvasHelper, plotHeight: number, axisYwidth: number, padding: number): {
+    calculatePlotDataArea(c: CanvasHelper, plotHeight: number, axisYwidth: number, padding: number): {
         x: number;
         y: number;
         width: number;
@@ -103,29 +134,66 @@ export declare class PlotElement extends LitElement {
             y: number;
         }[];
     };
+    getOrCreateSeries(name: string): PlotSeries;
     getSeries(name: string): PlotSeries | undefined;
+    render(): import("lit-html").TemplateResult<1>;
     static styles: import("lit").CSSResult;
 }
+export type SolidColourDrawStyle = Readonly<{
+    type: `solid`;
+    colour: string;
+}>;
+export type NoneDrawStyle = Readonly<{
+    type: `none`;
+}>;
+export type FillDrawStyle = SolidColourDrawStyle | NoneDrawStyle;
+export type OutlineDrawStyle = SolidColourDrawStyle | NoneDrawStyle;
+export type SeriesFormatting = PlotObjectFormatting & Readonly<{
+    axis: `primary` | `secondary`;
+    bar: BarSeriesFormatting;
+    dot: DotSeriesFormatting;
+    line: LineSeriesFormatting;
+}>;
+export type PlotObjectFormatting = Readonly<{
+    fill: FillDrawStyle;
+    outline: OutlineDrawStyle;
+}>;
+export type BarSeriesFormatting = {
+    gapWidth: number;
+};
+export type DotSeriesFormatting = {
+    gapWidth: number;
+    radius: `automatic` | number;
+};
+export type LineSeriesFormatting = {
+    width: number;
+    cap: `round` | `butt` | `square`;
+    join: `bevel` | `miter` | `round`;
+};
 export declare class PlotSeries {
-    name: string;
-    colour: Colour.Colourish;
+    #private;
+    readonly name: string;
     private plot;
-    data: number[];
-    minSeen: number;
-    maxSeen: number;
-    constructor(name: string, colour: Colour.Colourish, plot: PlotElement);
+    constructor(name: string, plot: PlotElement);
+    get length(): number;
+    getValuesForColumn(column: number): Generator<[value: number, index: number]>;
+    getValue(index: number): number[] | undefined;
+    pushValue(value: number[] | number, automaticallyDraw: boolean): void;
+    setValues(values: number[][], automaticallyDraw: boolean): void;
+    humanFormatValue(value: number[]): string;
+    setRawValues(values: number[], automaticallyDraw: boolean): void;
+    setCapacityLimit(v: number): void;
+    unsetCapacityLimit(): void;
+    setFormatting(formatting: Partial<SeriesFormatting>): void;
+    getFormatting(): SeriesFormatting;
+    get isDirty(): boolean;
+    set isDirty(value: boolean);
+    get onPrimaryAxis(): boolean;
+    set onPrimaryAxis(value: boolean);
     clear(): void;
-    /**
-     * Returns a copy of the data scaled by the current
-     * range of the data
-     * @returns
-     */
-    getScaled(): number[];
-    getScaledBy(scaler: (v: number) => number): number[];
-    push(value: number): void;
-    setValues(values: number[]): void;
-    resetScale(): void;
 }
+export type PlotAxisBounds = `auto-persistent` | `auto` | Numbers.NumericRange;
+export type PlotElementRenderStyle = `dot` | `line` | `bar`;
 declare global {
     interface HTMLElementTagNameMap {
         "ixfx-plot-element": PlotElement;

package/dist/charts/plot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plot.d.ts","sourceRoot":"","sources":["../../src/charts/plot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,KAAK,CAAC;AAIjE,OAAO,EAAa,KAAK,GAAG,EAAO,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAG7D,OAAO,EAAW,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGrE;;;;;;;;;;;;;;;GAeG;AACH,qBACa,WAAY,SAAQ,UAAU;;IAEzC,SAAS,UAAQ;IAGjB,UAAU,UAAS;IAGnB,SAAS,SAAO;IAGhB,SAAS,SAAK;IAGd,QAAQ,SAAc;IAGtB,QAAQ,SAAc;IAGtB,SAAS,SAAK;IAGd,WAAW,SAAQ;IAGnB,UAAU,UAAS;IACnB,OAAO,SAAK;IAEZ,MAAM,UAAS;IAQf,QAAQ,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAe;IAC/C,YAAY,0CAAmD;IAE/D,IAAI,MAAM,IAAI,UAAU,EAAE,CAEzB;IAED,IAAI,WAAW,WAEd;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAO5C;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQnC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQlC;;OAEG;IACH,KAAK;IAIL;;OAEG;IACH,SAAS;IAMT,MAAM;IAeN,iBAAiB,IAAI,IAAI;IAKzB,SAAS,CAAC,YAAY,CAAC,kBAAkB,EAAE,cAAc,GAAG,IAAI;IAYhE,aAAa;IAIb,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,SAAK,EAAE,WAAW,UAAQ;IAaxD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,SAAK,EAAE,WAAW,UAAQ;IAYjE;;;OAGG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM;IAQxB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS;IAMlD,IAAI;IA4DJ,UAAU,CAAC,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,aAAa;IAyB/C,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM;IAuBzE,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM;IAmBxE,WAAW,CAAC,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;;;;;;IASpF,iBAAiB,CAAC,EAAE,EAAE,YAAY;IAMlC,aAAa,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;;;;;;;;;;;;IA2ChE,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAI/C,MAAM,CAAC,MAAM,0BAMZ;CACF;AAGD,qBAAa,UAAU;IAKF,IAAI,EAAE,MAAM;IAAS,MAAM,EAAE,MAAM,CAAC,SAAS;IAAE,OAAO,CAAC,IAAI;IAJ9E,IAAI,EAAE,MAAM,EAAE,CAAM;IACpB,OAAO,SAA2B;IAClC,OAAO,SAA2B;gBAEf,IAAI,EAAE,MAAM,EAAS,MAAM,EAAE,MAAM,CAAC,SAAS,EAAU,IAAI,EAAE,WAAW;IAE3F,KAAK;IAKL;;;;OAIG;IACH,SAAS;IAWT,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM;IAUzC,IAAI,CAAC,KAAK,EAAE,MAAM;IAUlB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE;IAO1B,UAAU;CAIX;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,mBAAmB,EAAE,WAAW,CAAC;KAClC;CACF"}
+{"version":3,"file":"plot.d.ts","sourceRoot":"","sources":["../../src/charts/plot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,KAAK,CAAC;AAGjE,OAAO,EAAa,KAAK,GAAG,EAAO,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAgC,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAErF,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAerE,MAAM,MAAM,qBAAqB,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAC;AAGnE,qBAAa,QAAQ;;IAWA,IAAI,EAAE,MAAM;IAV/B,MAAM,EAAE,cAAc,CAAU;gBAUb,IAAI,EAAE,MAAM;IAI/B,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE;IAOhC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,YAAY;IAU5D,eAAe;;;;IAIf,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,WA3BnB,MAAM,KAAK,MAAM;IAoCzC,kBAAkB,CAAC,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,SAAI;;;;CAelE;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBACa,WAAY,SAAQ,UAAU;;IAKzC,UAAU,UAAS;IAkBnB,WAAW,EAAE,sBAAsB,CAAQ;IAM3C,OAAO,SAAK;IAEZ,QAAQ,CAAC,WAAW,WAA2B;IAC/C,QAAQ,CAAC,aAAa,WAA6B;IAEnD,MAAM,UAAS;IACf,cAAc,EAAE,oBAAoB,CAGnC;IAED;;OAEG;IACH,qBAAqB;;;;MAIpB;IAED,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAK;IAa9C,QAAQ,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAe;IAC/C,SAAS,EAAE,GAAG,CAAC,cAAc,CAAC,CAAe;IAE7C,oBAAoB,EAAE,qBAAqB,CAI1C;IAED,IAAI,MAAM,IAAI,UAAU,EAAE,CAEzB;IAED,IAAI,WAAW,WAEd;IAED,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO;IA8B/D,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAW7E;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAO5C;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQnC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQlC;;OAEG;IACH,KAAK;IAML;;OAEG;IACH,SAAS;IAsET,iBAAiB,IAAI,IAAI;IAIzB,SAAS,CAAC,YAAY,CAAC,kBAAkB,EAAE,cAAc,GAAG,IAAI;IAoBhE,aAAa;IAqBb,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO;IAO7E;;;;OAIG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO;IAW9D,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO;IASzF;;;OAGG;IAeH,IAAI;IAoEJ,UAAU,CAAC,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,aAAa;IAqO/C,qBAAqB,CAAC,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;;;;;;IAS9F,iBAAiB,CAAC,EAAE,EAAE,YAAY;IAKlC,aAAa,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;;;;;;;;;;;;IA2ChE,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;IAiB3C,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK/C,MAAM;IAKN,MAAM,CAAC,MAAM,0BAwBZ;CACF;AAED,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;IAC1C,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAA;CACf,CAAC,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,oBAAoB,GAAG,aAAa,CAAC;AACjE,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,aAAa,CAAC;AAoBpE,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,QAAQ,CAAC;IAC7D,IAAI,EAAE,SAAS,GAAG,WAAW,CAAA;IAC7B,GAAG,EAAE,mBAAmB,CAAA;IACxB,GAAG,EAAE,mBAAmB,CAAA;IACxB,IAAI,EAAE,oBAAoB,CAAA;CAC3B,CAAC,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;IAC1C,IAAI,EAAE,aAAa,CAAA;IACnB,OAAO,EAAE,gBAAgB,CAAA;CAC1B,CAAC,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,WAAW,GAAG,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAA;IAChC,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAA;CAClC,CAAA;AA0BD,qBAAa,UAAU;;aAMO,IAAI,EAAE,MAAM;IAAE,OAAO,CAAC,IAAI;gBAA1B,IAAI,EAAE,MAAM,EAAU,IAAI,EAAE,WAAW;IAInE,IAAI,MAAM,WAET;IAEA,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAE,CAAC;IAYhF,QAAQ,CAAC,KAAK,EAAE,MAAM;IAItB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,iBAAiB,EAAE,OAAO;IAe9D,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,iBAAiB,EAAE,OAAO;IAQxD,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;IAWzC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,OAAO;IAIzD,gBAAgB,CAAC,CAAC,EAAE,MAAM;IAY1B,kBAAkB;IAIlB,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAInD,aAAa;IAIb,IAAI,OAAO,IAIQ,OAAO,CAFzB;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,aAAa,IAIQ,OAAO,CAF/B;IAED,IAAI,aAAa,CAAC,KAAK,EAAE,OAAO,EAI/B;IAED,KAAK;CAoCN;AAcD,MAAM,MAAM,cAAc,GAAG,iBAAiB,GAAG,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;AAE/E,MAAM,MAAM,sBAAsB,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;AAO5D,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,mBAAmB,EAAE,WAAW,CAAC;KAClC;CACF"}