@ixfx/components 0.2.2 → 0.2.4

package/dist/charts/plot.d.ts

@@ -1,199 +0,0 @@
-import { LitElement, type PropertyValues } from "lit";
-import { type Ref } from "lit/directives/ref.js";
-import { CanvasHelper } 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)
- * * max-length: number (default: 500). How many data points per series to store
- * * data-width: when streaming, how much horizontal width per point
- * * fixed-max/fixed-min: global input scaling (default: NaN, ie. disabled)
- *
- * * line-width: stroke width of drawing line (default:2)
- *
- * * render: 'dot', 'line' or 'bar'(default: 'dot')
- * * hide-legend: If added, legend is not shown
- * * manual-draw: If added, automatic drawning is disabled
- *
- * Styling variables
- * * --legend-fg: legend foreground text
- */
-export declare class PlotElement extends LitElement {
-    #private;
-    hideLegend: 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>;
-    tooltipEl: Ref<HTMLDivElement>;
-    seriesColourGenerate: SeriesColourGenerator;
-    setDrawDebounce(millis: number): void;
-    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
-     * PlotElement.fromQuery(`#someplot`); // PlotElement
-     * ```
-     *
-     * Throws an error if query does not match.
-     * @param query
-     * @returns
-     */
-    static fromQuery(query: string): PlotElement;
-    /**
-     * Delete a series.
-     * Returns _true_ if there was a series to delete
-     * @param name
-     * @returns
-     */
-    deleteSeries(name: string): boolean;
-    /**
-     * Keeps the series, but deletes its data
-     * @param name
-     * @returns
-     */
-    clearSeries(name: string): boolean;
-    /**
-     * Delete all data & series
-     */
-    clear(): void;
-    /**
-     * Keeps all series, but deletes their data
-     */
-    clearData(): void;
-    connectedCallback(): void;
-    protected firstUpdated(_changedProperties: PropertyValues): void;
-    updateColours(): void;
-    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(force?: boolean): void;
-    drawLegend(cl: RectPositioned, d: DrawingHelper): void;
-    calculatePlotDataArea(c: CanvasHelper, plotHeight: number, axisYwidth: number, padding: number): {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-    computeAxisYWidth(_c: CanvasHelper): number;
-    computeLegend(c: CanvasHelper, maxWidth: number, padding: number): {
-        bounds: {
-            width: number;
-            height: number;
-        };
-        parts: {
-            width: number;
-            height: number;
-            x: number;
-            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 {
-    #private;
-    readonly name: string;
-    private plot;
-    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;
-}
-export type PlotAxisBounds = `auto-persistent` | `auto` | Numbers.NumericRange;
-export type PlotElementRenderStyle = `dot` | `line` | `bar`;
-declare global {
-    interface HTMLElementTagNameMap {
-        "ixfx-plot-element": PlotElement;
-    }
-}
-//# sourceMappingURL=plot.d.ts.map

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

@@ -1 +0,0 @@
-{"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;IAG7C,oBAAoB,EAAE,qBAAqB,CAI1C;IAED,eAAe,CAAC,MAAM,EAAE,MAAM;IAK9B,IAAI,MAAM,IAAI,UAAU,EAAE,CAEzB;IAED,IAAI,WAAW,WAEd;IAGD,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;IAuET,iBAAiB,IAAI,IAAI;IAIzB,SAAS,CAAC,YAAY,CAAC,kBAAkB,EAAE,cAAc,GAAG,IAAI;IAsBhE,aAAa;IAKb,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,IAAI,CAAC,KAAK,UAAQ;IA6ElB,UAAU,CAAC,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,aAAa;IAmO/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"}