@aquera/nile-visualization 0.1.0 → 0.2.0

package/dist/src/nile-stacked-chart/nile-stacked-chart.js

@@ -0,0 +1,216 @@
+import { __decorate } from "tslib";
+import { customElement, property, query } from 'lit/decorators.js';
+import { html } from 'lit';
+import { getHighcharts } from '../internal/highcharts-provider.js';
+import NileElement from '../internal/nile-element.js';
+import { applySeparatedChartConfig } from '../internal/separated-chart-config.js';
+import { deepMerge } from '../internal/utils.js';
+import { styles } from './nile-stacked-chart.css.js';
+let NileStackedChart = class NileStackedChart extends NileElement {
+    constructor() {
+        super(...arguments);
+        this._hc = null;
+        this.chart = null;
+        this.resizeObserver = null;
+        /** Full chart configuration. Accepts separated `{ chart, aq }` input. */
+        this.config = null;
+        this.chartTitle = '';
+        this.chartSubtitle = '';
+        this.data = [];
+        this.categories = [];
+        this.options = {};
+        this.loading = false;
+        this.height = '400px';
+        this.yAxisTitle = '';
+        this.showLegend = true;
+        /** `normal` = stacked values; `percent` = 100% proportional stacks. */
+        this.stackMode = 'normal';
+        this.pointPadding = 0.05;
+    }
+    /** Apply `{ chart, aq }` config to individual properties. */
+    applyConfig(cfg) {
+        applySeparatedChartConfig(this, cfg);
+    }
+    connectedCallback() {
+        super.connectedCallback();
+        if (this.config)
+            this.applyConfig(this.config);
+    }
+    disconnectedCallback() {
+        super.disconnectedCallback();
+        this.destroyChart();
+        this.resizeObserver?.disconnect();
+        this.resizeObserver = null;
+    }
+    firstUpdated() {
+        this.initChart();
+        this.setupResizeObserver();
+    }
+    updated(changedProperties) {
+        if (changedProperties.has('config') && this.config) {
+            this.applyConfig(this.config);
+            return;
+        }
+        const props = [
+            'data',
+            'categories',
+            'chartTitle',
+            'chartSubtitle',
+            'options',
+            'height',
+            'yAxisTitle',
+            'loading',
+            'showLegend',
+            'stackMode',
+            'pointPadding',
+        ];
+        if (!props.some(p => changedProperties.has(p)))
+            return;
+        if (this.loading) {
+            this.destroyChart();
+            return;
+        }
+        if (this.chart) {
+            this.chart.update(this.buildOptions(), true, true);
+        }
+        else {
+            this.initChart();
+        }
+    }
+    setupResizeObserver() {
+        if (!this.chartContainer)
+            return;
+        this.resizeObserver = new ResizeObserver(() => {
+            this.chart?.reflow();
+        });
+        this.resizeObserver.observe(this.chartContainer);
+    }
+    stacking() {
+        return this.stackMode === 'percent' ? 'percent' : 'normal';
+    }
+    buildOptions() {
+        const self = this;
+        const stack = this.stacking();
+        const percentAxis = stack === 'percent'
+            ? {
+                min: 0,
+                max: 100,
+                title: { text: this.yAxisTitle || undefined },
+                labels: { format: '{value}%' },
+            }
+            : {
+                min: 0,
+                title: { text: this.yAxisTitle || undefined },
+            };
+        return deepMerge({
+            chart: { type: 'column', height: this.height },
+            title: { text: this.chartTitle || undefined },
+            subtitle: { text: this.chartSubtitle || undefined },
+            xAxis: { categories: this.categories },
+            yAxis: percentAxis,
+            legend: { enabled: this.showLegend },
+            tooltip: {
+                shared: true,
+                headerFormat: '<b>{point.key}</b><br/>',
+            },
+            plotOptions: {
+                column: {
+                    stacking: stack,
+                    grouping: false,
+                    pointPadding: this.pointPadding,
+                    borderWidth: 0,
+                    borderRadius: 2,
+                    dataLabels: { enabled: false },
+                },
+                series: {
+                    cursor: 'pointer',
+                    point: {
+                        events: {
+                            click() {
+                                self.emit('nile-chart-click', {
+                                    point: this,
+                                    category: this.category,
+                                    value: this.y,
+                                    seriesName: this.series.name,
+                                    percentage: this.percentage,
+                                });
+                            },
+                        },
+                    },
+                },
+            },
+            series: this.data.map(s => ({
+                type: 'column',
+                name: s.name,
+                data: s.data,
+                color: s.color,
+            })),
+            credits: { enabled: false },
+        }, this.options);
+    }
+    async initChart() {
+        if (this.loading || !this.chartContainer)
+            return;
+        if (!this._hc)
+            this._hc = await getHighcharts();
+        this.chart = this._hc.chart(this.chartContainer, this.buildOptions());
+        this.emit('nile-chart-ready', { chart: this.chart });
+    }
+    destroyChart() {
+        if (this.chart) {
+            this.chart.destroy();
+            this.chart = null;
+        }
+    }
+    render() {
+        if (this.loading) {
+            return html `<div class="chart-loading" style="height:${this.height}">Loading...</div>`;
+        }
+        return html `<div class="chart-container"></div>`;
+    }
+};
+NileStackedChart.styles = styles;
+__decorate([
+    query('.chart-container')
+], NileStackedChart.prototype, "chartContainer", void 0);
+__decorate([
+    property({ type: Object })
+], NileStackedChart.prototype, "config", void 0);
+__decorate([
+    property({ type: String, attribute: 'chart-title' })
+], NileStackedChart.prototype, "chartTitle", void 0);
+__decorate([
+    property({ type: String, attribute: 'chart-subtitle' })
+], NileStackedChart.prototype, "chartSubtitle", void 0);
+__decorate([
+    property({ type: Array })
+], NileStackedChart.prototype, "data", void 0);
+__decorate([
+    property({ type: Array })
+], NileStackedChart.prototype, "categories", void 0);
+__decorate([
+    property({ type: Object })
+], NileStackedChart.prototype, "options", void 0);
+__decorate([
+    property({ type: Boolean, reflect: true })
+], NileStackedChart.prototype, "loading", void 0);
+__decorate([
+    property({ type: String })
+], NileStackedChart.prototype, "height", void 0);
+__decorate([
+    property({ type: String, attribute: 'y-axis-title' })
+], NileStackedChart.prototype, "yAxisTitle", void 0);
+__decorate([
+    property({ type: Boolean, attribute: 'show-legend' })
+], NileStackedChart.prototype, "showLegend", void 0);
+__decorate([
+    property({ type: String, attribute: 'stack-mode' })
+], NileStackedChart.prototype, "stackMode", void 0);
+__decorate([
+    property({ type: Number, attribute: 'point-padding' })
+], NileStackedChart.prototype, "pointPadding", void 0);
+NileStackedChart = __decorate([
+    customElement('nile-stacked-chart')
+], NileStackedChart);
+export { NileStackedChart };
+//# sourceMappingURL=nile-stacked-chart.js.map

package/dist/src/nile-timeline-chart/index.d.ts

@@ -0,0 +1,2 @@
+export { NileTimelineChart } from './nile-timeline-chart.js';
+export type { TimelineEvent } from './nile-timeline-chart.js';

package/dist/src/nile-timeline-chart/index.js

@@ -0,0 +1,2 @@
+export { NileTimelineChart } from './nile-timeline-chart.js';
+//# sourceMappingURL=index.js.map

package/dist/src/nile-timeline-chart/nile-timeline-chart.css.d.ts

@@ -0,0 +1 @@
+export declare const styles: import("lit").CSSResult;

package/dist/src/nile-timeline-chart/nile-timeline-chart.css.js

@@ -0,0 +1,28 @@
+import { css } from 'lit';
+export const styles = css `
+  :host {
+    display: block;
+    width: 100%;
+    position: relative;
+  }
+
+  :host([hidden]) {
+    display: none;
+  }
+
+  .chart-container {
+    width: 100%;
+    min-height: var(--nile-height-200px, var(--ng-height-200px));
+  }
+
+  .chart-loading {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    min-height: inherit;
+    color: var(--nile-colors-neutral-700, var(--ng-colors-text-secondary-700));
+    font-family: var(--nile-font-family-serif, var(--ng-font-family-body));
+    font-size: var(--nile-type-scale-3, var(--ng-font-size-text-sm));
+  }
+`;
+//# sourceMappingURL=nile-timeline-chart.css.js.map

package/dist/src/nile-timeline-chart/nile-timeline-chart.d.ts

@@ -0,0 +1,58 @@
+import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
+import type Highcharts from 'highcharts';
+import NileElement from '../internal/nile-element.js';
+import type { SeparatedChartConfigInputType } from '../internal/types/separated-chart-config-input.type.js';
+export interface TimelineEvent {
+    /** Shown on axis / tooltip header (e.g. date string). */
+    name: string;
+    /** Short label on the timeline. */
+    label: string;
+    /** Longer copy; tooltip uses this by default. */
+    description?: string;
+    /** Unix timestamp (ms) when `datetime-axis` is true; omit for evenly spaced events. */
+    x?: number;
+    color?: string;
+}
+export declare class NileTimelineChart extends NileElement {
+    static styles: CSSResultGroup;
+    private _hc;
+    private chart;
+    private resizeObserver;
+    private chartContainer;
+    /** Full chart configuration. Accepts separated `{ chart, aq }` input. */
+    config: SeparatedChartConfigInputType | null;
+    chartTitle: string;
+    chartSubtitle: string;
+    data: TimelineEvent[];
+    options: Highcharts.Options;
+    loading: boolean;
+    height: string;
+    seriesName: string;
+    /**
+     * When true (default), `x` on each event is a Unix ms timestamp and the axis is `datetime`.
+     * When false, events are spaced evenly (no `x` required).
+     */
+    datetimeAxis: boolean;
+    /** Vertical timeline (categories on the horizontal edge). */
+    inverted: boolean;
+    /** Alternate data-label sides along the line. */
+    alternateLabels: boolean;
+    showLegend: boolean;
+    /** Apply `{ chart, aq }` config to individual properties. */
+    private applyConfig;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected firstUpdated(): void;
+    protected updated(changedProperties: PropertyValues): void;
+    private setupResizeObserver;
+    private mapData;
+    private buildOptions;
+    private initChart;
+    private destroyChart;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-timeline-chart': NileTimelineChart;
+    }
+}

package/dist/src/nile-timeline-chart/nile-timeline-chart.js

@@ -0,0 +1,239 @@
+import { __decorate } from "tslib";
+import { customElement, property, query } from 'lit/decorators.js';
+import { html } from 'lit';
+import { getHighcharts } from '../internal/highcharts-provider.js';
+import NileElement from '../internal/nile-element.js';
+import { applySeparatedChartConfig } from '../internal/separated-chart-config.js';
+import { deepMerge } from '../internal/utils.js';
+import { styles } from './nile-timeline-chart.css.js';
+let NileTimelineChart = class NileTimelineChart extends NileElement {
+    constructor() {
+        super(...arguments);
+        this._hc = null;
+        this.chart = null;
+        this.resizeObserver = null;
+        /** Full chart configuration. Accepts separated `{ chart, aq }` input. */
+        this.config = null;
+        this.chartTitle = '';
+        this.chartSubtitle = '';
+        this.data = [];
+        this.options = {};
+        this.loading = false;
+        this.height = '420px';
+        this.seriesName = '';
+        /**
+         * When true (default), `x` on each event is a Unix ms timestamp and the axis is `datetime`.
+         * When false, events are spaced evenly (no `x` required).
+         */
+        this.datetimeAxis = true;
+        /** Vertical timeline (categories on the horizontal edge). */
+        this.inverted = false;
+        /** Alternate data-label sides along the line. */
+        this.alternateLabels = true;
+        this.showLegend = false;
+    }
+    /** Apply `{ chart, aq }` config to individual properties. */
+    applyConfig(cfg) {
+        applySeparatedChartConfig(this, cfg);
+    }
+    connectedCallback() {
+        super.connectedCallback();
+        if (this.config)
+            this.applyConfig(this.config);
+    }
+    disconnectedCallback() {
+        super.disconnectedCallback();
+        this.destroyChart();
+        this.resizeObserver?.disconnect();
+        this.resizeObserver = null;
+    }
+    firstUpdated() {
+        this.initChart();
+        this.setupResizeObserver();
+    }
+    updated(changedProperties) {
+        if (changedProperties.has('config') && this.config) {
+            this.applyConfig(this.config);
+            return;
+        }
+        const props = [
+            'data',
+            'chartTitle',
+            'chartSubtitle',
+            'options',
+            'height',
+            'seriesName',
+            'datetimeAxis',
+            'inverted',
+            'alternateLabels',
+            'showLegend',
+            'loading',
+        ];
+        if (!props.some(p => changedProperties.has(p)))
+            return;
+        if (this.loading) {
+            this.destroyChart();
+            return;
+        }
+        if (this.chart) {
+            this.chart.update(this.buildOptions(), true, true);
+        }
+        else {
+            this.initChart();
+        }
+    }
+    setupResizeObserver() {
+        if (!this.chartContainer)
+            return;
+        this.resizeObserver = new ResizeObserver(() => {
+            this.chart?.reflow();
+        });
+        this.resizeObserver.observe(this.chartContainer);
+    }
+    mapData() {
+        return this.data.map(d => {
+            const row = {
+                name: d.name,
+                label: d.label,
+                description: d.description ?? d.label,
+            };
+            if (d.color)
+                row.color = d.color;
+            if (this.datetimeAxis && d.x != null)
+                row.x = d.x;
+            return row;
+        });
+    }
+    buildOptions() {
+        const self = this;
+        const dlFormat = this.datetimeAxis
+            ? '<span style="font-weight:600;color:#334155">{point.x:%e %b %Y}</span><br/>{point.label}'
+            : '<span style="font-weight:600;color:#334155">{point.name}</span><br/>{point.label}';
+        return deepMerge({
+            chart: {
+                type: 'timeline',
+                height: this.height,
+                inverted: this.inverted,
+            },
+            title: { text: this.chartTitle || undefined },
+            subtitle: { text: this.chartSubtitle || undefined },
+            legend: { enabled: this.showLegend },
+            tooltip: {
+                headerFormat: '',
+                pointFormat: '<span style="color:{point.color}">●</span> <b>{point.label}</b><br/>{point.description}',
+            },
+            xAxis: {
+                type: this.datetimeAxis ? 'datetime' : 'linear',
+                visible: false,
+            },
+            yAxis: {
+                visible: false,
+                title: { text: undefined },
+                labels: { enabled: false },
+            },
+            plotOptions: {
+                timeline: {
+                    cursor: 'pointer',
+                    dataLabels: {
+                        allowOverlap: false,
+                        alternate: this.alternateLabels,
+                        format: dlFormat,
+                    },
+                    marker: {
+                        symbol: 'circle',
+                        radius: 6,
+                        lineWidth: 2,
+                        lineColor: '#ffffff',
+                    },
+                    point: {
+                        events: {
+                            click() {
+                                self.emit('nile-chart-click', {
+                                    point: this,
+                                    name: this.name,
+                                    label: this.label,
+                                    description: this.description,
+                                    x: this.x,
+                                    seriesName: this.series.name,
+                                });
+                            },
+                        },
+                    },
+                },
+            },
+            series: [
+                {
+                    type: 'timeline',
+                    name: this.seriesName || 'Timeline',
+                    data: this.mapData(),
+                },
+            ],
+            credits: { enabled: false },
+        }, this.options);
+    }
+    async initChart() {
+        if (this.loading || !this.chartContainer)
+            return;
+        if (!this._hc)
+            this._hc = await getHighcharts();
+        this.chart = this._hc.chart(this.chartContainer, this.buildOptions());
+        this.emit('nile-chart-ready', { chart: this.chart });
+    }
+    destroyChart() {
+        if (this.chart) {
+            this.chart.destroy();
+            this.chart = null;
+        }
+    }
+    render() {
+        if (this.loading) {
+            return html `<div class="chart-loading" style="height:${this.height}">Loading...</div>`;
+        }
+        return html `<div class="chart-container"></div>`;
+    }
+};
+NileTimelineChart.styles = styles;
+__decorate([
+    query('.chart-container')
+], NileTimelineChart.prototype, "chartContainer", void 0);
+__decorate([
+    property({ type: Object })
+], NileTimelineChart.prototype, "config", void 0);
+__decorate([
+    property({ type: String, attribute: 'chart-title' })
+], NileTimelineChart.prototype, "chartTitle", void 0);
+__decorate([
+    property({ type: String, attribute: 'chart-subtitle' })
+], NileTimelineChart.prototype, "chartSubtitle", void 0);
+__decorate([
+    property({ type: Array })
+], NileTimelineChart.prototype, "data", void 0);
+__decorate([
+    property({ type: Object })
+], NileTimelineChart.prototype, "options", void 0);
+__decorate([
+    property({ type: Boolean, reflect: true })
+], NileTimelineChart.prototype, "loading", void 0);
+__decorate([
+    property({ type: String })
+], NileTimelineChart.prototype, "height", void 0);
+__decorate([
+    property({ type: String, attribute: 'series-name' })
+], NileTimelineChart.prototype, "seriesName", void 0);
+__decorate([
+    property({ type: Boolean, attribute: 'datetime-axis' })
+], NileTimelineChart.prototype, "datetimeAxis", void 0);
+__decorate([
+    property({ type: Boolean, reflect: true })
+], NileTimelineChart.prototype, "inverted", void 0);
+__decorate([
+    property({ type: Boolean, attribute: 'alternate-labels' })
+], NileTimelineChart.prototype, "alternateLabels", void 0);
+__decorate([
+    property({ type: Boolean, attribute: 'show-legend' })
+], NileTimelineChart.prototype, "showLegend", void 0);
+NileTimelineChart = __decorate([
+    customElement('nile-timeline-chart')
+], NileTimelineChart);
+export { NileTimelineChart };
+//# sourceMappingURL=nile-timeline-chart.js.map

package/dist/src/nile-trendline-chart/nile-trendline-chart.d.ts

@@ -1,6 +1,7 @@
 import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
 import type Highcharts from 'highcharts';
 import NileElement from '../internal/nile-element.js';
+import type { NileChartConfigInputType } from '../internal/types/index.js';
 export interface TrendlineSeriesData {
     name: string;
     data: number[];
@@ -20,6 +21,8 @@ export declare class NileTrendlineChart extends NileElement {
     private chart;
     private resizeObserver;
     private chartContainer;
+    /** Full chart configuration. Accepts separated { chart, aq } input. */
+    config: NileChartConfigInputType | null;
     /** The chart title displayed above the chart. */
     chartTitle: string;
     /** The subtitle displayed below the title. */
@@ -38,6 +41,9 @@ export declare class NileTrendlineChart extends NileElement {
     height: string;
     /** Y-axis title text. */
     yAxisTitle: string;
+    /** Apply { chart, aq } config to individual properties. */
+    private applyConfig;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     protected firstUpdated(): void;
     protected updated(changedProperties: PropertyValues): void;

package/dist/src/nile-trendline-chart/nile-trendline-chart.js

@@ -11,6 +11,8 @@ let NileTrendlineChart = class NileTrendlineChart extends NileElement {
         this._hc = null;
         this.chart = null;
         this.resizeObserver = null;
+        /** Full chart configuration. Accepts separated { chart, aq } input. */
+        this.config = null;
         /** The chart title displayed above the chart. */
         this.chartTitle = '';
         /** The subtitle displayed below the title. */
@@ -30,6 +32,38 @@ let NileTrendlineChart = class NileTrendlineChart extends NileElement {
         /** Y-axis title text. */
         this.yAxisTitle = '';
     }
+    /** Apply { chart, aq } config to individual properties. */
+    applyConfig(cfg) {
+        const { chart: c, aq } = cfg;
+        if (c) {
+            const trend = c;
+            if (trend.data)
+                this.data = trend.data;
+            if (trend.categories)
+                this.categories = trend.categories;
+            if (trend.yAxisTitle)
+                this.yAxisTitle = trend.yAxisTitle;
+            if (trend.height)
+                this.height = trend.height;
+            if (trend.loading !== undefined)
+                this.loading = trend.loading;
+            if (trend.options)
+                this.options = trend.options;
+            if (trend.forecast)
+                this.forecast = trend.forecast;
+        }
+        if (aq) {
+            if (aq.chartTitle)
+                this.chartTitle = aq.chartTitle;
+            if (aq.chartSubtitle)
+                this.chartSubtitle = aq.chartSubtitle;
+        }
+    }
+    connectedCallback() {
+        super.connectedCallback();
+        if (this.config)
+            this.applyConfig(this.config);
+    }
     disconnectedCallback() {
         super.disconnectedCallback();
         this.destroyChart();
@@ -41,6 +75,10 @@ let NileTrendlineChart = class NileTrendlineChart extends NileElement {
         this.setupResizeObserver();
     }
     updated(changedProperties) {
+        if (changedProperties.has('config') && this.config) {
+            this.applyConfig(this.config);
+            return;
+        }
         const chartProps = [
             'data',
             'categories',
@@ -212,6 +250,9 @@ NileTrendlineChart.styles = styles;
 __decorate([
     query('.chart-container')
 ], NileTrendlineChart.prototype, "chartContainer", void 0);
+__decorate([
+    property({ type: Object })
+], NileTrendlineChart.prototype, "config", void 0);
 __decorate([
     property({ type: String, attribute: 'chart-title' })
 ], NileTrendlineChart.prototype, "chartTitle", void 0);

package/dist/src/nile-waterfall-chart/nile-waterfall-chart.d.ts

@@ -1,6 +1,7 @@
 import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
 import type Highcharts from 'highcharts';
 import NileElement from '../internal/nile-element.js';
+import type { NileChartConfigInputType } from '../internal/types/index.js';
 export interface WaterfallDataPoint {
     name: string;
     y: number;
@@ -14,6 +15,8 @@ export declare class NileWaterfallChart extends NileElement {
     private chart;
     private resizeObserver;
     private chartContainer;
+    /** Full chart configuration. Accepts separated { chart, aq } input. */
+    config: NileChartConfigInputType | null;
     chartTitle: string;
     chartSubtitle: string;
     data: WaterfallDataPoint[];
@@ -21,6 +24,9 @@ export declare class NileWaterfallChart extends NileElement {
     loading: boolean;
     height: string;
     yAxisTitle: string;
+    /** Apply { chart, aq } config to individual properties. */
+    private applyConfig;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     protected firstUpdated(): void;
     protected updated(changedProperties: PropertyValues): void;