@aquera/nile-visualization 1.5.0 → 1.6.0

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

@@ -15,8 +15,37 @@ import type { SplineChartSeriesData } from '../nile-spline-chart/nile-spline-cha
 import type { RadarChartSeriesData } from '../nile-radar-chart/nile-radar-chart.js';
 import type { GaugeBand } from '../nile-gauge-chart/nile-gauge-chart.js';
 import type { WaterfallDataPoint } from '../nile-waterfall-chart/nile-waterfall-chart.js';
+import type { KpiVariant, SparklineType, TrendDirection } from '../nile-kpi-chart/nile-kpi-chart.js';
 import type { MapChartDataPoint } from '../nile-map-chart/nile-map-chart.js';
 import type { NileDataGridColumn } from '@aquera/nile-data-grid';
+import type { StackedChartSeriesData } from '../nile-stacked-chart/nile-stacked-chart.js';
+import type { ClusterChartSeriesData } from '../nile-cluster-chart/nile-cluster-chart.js';
+import type { HistogramSamples } from '../nile-histogram-chart/nile-histogram-chart.js';
+import type { BellcurveSamples } from '../nile-bellcurve-chart/nile-bellcurve-chart.js';
+import type { BoxplotSeriesData } from '../nile-boxplot-chart/nile-boxplot-chart.js';
+import type { TimelineEvent } from '../nile-timeline-chart/nile-timeline-chart.js';
+import type { DumbbellPoint } from '../nile-dumbbell-chart/nile-dumbbell-chart.js';
+import type { FanLinePoint, FanUncertaintyBand } from '../nile-fan-chart/nile-fan-chart.js';
+import type { FunnelDataPoint } from '../nile-funnel-chart/nile-funnel-chart.js';
+import type { OrgChartNode, OrgChartLink } from '../nile-organization-chart/nile-organization-chart.js';
+import type { HeatmapCell } from '../nile-heatmap-chart/nile-heatmap-chart.js';
+import type { FlameChartPoint, FlameSunburstPoint, FlameChartLayout } from '../nile-flame-chart/nile-flame-chart.js';
+import type { SpiderwebChartSeriesData } from '../nile-spiderweb-chart/nile-spiderweb-chart.js';
+import type { ColumnPyramidSeriesData } from '../nile-column-pyramid-chart/nile-column-pyramid-chart.js';
+import type { LollipopSeriesData } from '../nile-lollipop-chart/nile-lollipop-chart.js';
+import type { InvertedAreaChartSeriesData } from '../nile-inverted-area-chart/nile-inverted-area-chart.js';
+import type { AreaSplineSeriesData } from '../nile-area-spline-chart/nile-area-spline-chart.js';
+import type { AreaNegativeSeriesData } from '../nile-area-negative-chart/nile-area-negative-chart.js';
+import type { AreaRangeSeriesData } from '../nile-area-range-chart/nile-area-range-chart.js';
+import type { ColumnRangeSeriesData } from '../nile-column-range-chart/nile-column-range-chart.js';
+import type { ColumnDrilldownParentPoint, ColumnDrilldownSeriesConfig } from '../nile-column-drilldown-chart/nile-column-drilldown-chart.js';
+import type { RadialBarSeriesData } from '../nile-radial-bar-chart/nile-radial-bar-chart.js';
+import type { VariablePieDataPoint } from '../nile-variable-pie-chart/nile-variable-pie-chart.js';
+import type { EulerVennDataPoint } from '../nile-euler-chart/nile-euler-chart.js';
+import type { PolygonSeriesConfig } from '../nile-polygon-chart/nile-polygon-chart.js';
+import type { VectorDataPoint } from '../nile-vector-chart/nile-vector-chart.js';
+import type { XrangeDataPoint } from '../nile-xrange-chart/nile-xrange-chart.js';
+import type { LineColumnSeriesPart } from '../nile-line-column-chart/nile-line-column-chart.js';
 export type SwitchAggregation = 'by-category' | 'by-series' | 'flatten';
 export interface NileAiConfig {
     /** Show the AI chat icon on the chart. Default: false. */
@@ -26,8 +55,7 @@ export interface NileAiConfig {
     /** Initial assistant message shown when the chat panel opens. */
     welcomeMessage?: string;
 }
-/** Fields merged from `aq` (and shared card chrome) onto `chart` for `<nile-chart>`. */
-/** Fields merged from `aq` (and shared card chrome) onto `chart` for `<nile-chart>`. */
+/** Fields shared by every chart config (card chrome, styling, loading). */
 export interface NileChartConfigBase {
     chartTitle?: string;
     chartSubtitle?: string;
@@ -39,10 +67,22 @@ export interface NileChartConfigBase {
     /** Chart types the user can switch to. Shows type-switch UI when set. */
     switchableTypes?: ChartType[];
     /** How to aggregate bar-like data when converting to pie. Default: 'by-category'. */
-    /** How to aggregate bar-like data when converting to pie. Default: 'by-category'. */
     switchAggregation?: SwitchAggregation;
     /** AI chat configuration. When ai.enabled is true, shows the allsearch icon. */
     ai?: NileAiConfig;
+    /** Show the chart legend. Each chart's default varies; set explicitly to override. */
+    showLegend?: boolean;
+    chartBg?: string;
+    chartBorderRadius?: string | number;
+    chartBorder?: string;
+    chartShadow?: string;
+    chartPadding?: string | number;
+    chartMinHeight?: string | number;
+    loadingText?: string;
+    loadingColor?: string;
+    loadingFontSize?: string | number;
+    loadingFontFamily?: string;
+    loadingBg?: string;
 }
 export interface NileBarChartConfig extends NileChartConfigBase {
     type: 'bar';
@@ -55,21 +95,6 @@ export interface NilePieChartConfig extends NileChartConfigBase {
     data: PieChartSeriesData[];
     seriesName?: string;
     showDataLabels?: boolean;
-    showLegend?: boolean;
-}
-export interface NileTrendlineChartConfig extends NileChartConfigBase {
-    type: 'trendline';
-    data: TrendlineSeriesData[];
-    categories?: string[];
-    yAxisTitle?: string;
-    forecast?: ForecastConfig;
-}
-export interface NileAnomalyChartConfig extends NileChartConfigBase {
-    type: 'anomaly';
-    data: AnomalySeriesData[];
-    categories?: string[];
-    yAxisTitle?: string;
-    anomaly?: AnomalyConfig;
 }
 export interface NileLineChartConfig extends NileChartConfigBase {
     type: 'line';
@@ -95,8 +120,8 @@ export interface NileDonutChartConfig extends NileChartConfigBase {
     data: DonutChartSeriesData[];
     seriesName?: string;
     innerSize?: string;
+    semiCircle?: boolean;
     showDataLabels?: boolean;
-    showLegend?: boolean;
 }
 export interface NileScatterChartConfig extends NileChartConfigBase {
     type: 'scatter';
@@ -137,25 +162,10 @@ export interface NileWaterfallChartConfig extends NileChartConfigBase {
 }
 export interface NileMapChartConfig extends NileChartConfigBase {
     type: 'map';
-    /** Array of data points joined against the map topology. */
     data: MapChartDataPoint[];
-    /**
-     * GeoJSON or Highcharts topology object for the map shapes.
-     * Obtain from https://code.highcharts.com/mapdata/ or supply your own.
-     */
     mapData?: object;
-    /**
-     * How to join data against mapData. Defaults to `['hc-key', 'hc-key']`.
-     * Pass a string to use the same key on both sides,
-     * or a two-element array `[mapKey, dataKey]` for different key names.
-     */
     joinBy?: string | string[];
-    /**
-     * Type of the primary series. Default: `'map'`.
-     * For multi-series or `tiledwebmap`, pass `options.series` directly.
-     */
     seriesType?: 'map' | 'mapline' | 'mappoint' | 'mapbubble' | 'tiledwebmap';
-    /** Enable mouse-wheel zoom, double-click zoom, and +/− buttons. Default: true. */
     zoom?: boolean;
 }
 export interface NileGridChartConfig extends NileChartConfigBase {
@@ -164,12 +174,295 @@ export interface NileGridChartConfig extends NileChartConfigBase {
     columns: NileDataGridColumn[];
     striped?: boolean;
     hoverable?: boolean;
+    stickyHeader?: boolean;
     emptyMessage?: string;
     loadingMessage?: string;
     noMatchMessage?: string;
 }
-/** Flat config for `<nile-chart>`: discriminated `chart` fields plus merged `aq` / card chrome. */
-export type NileChartConfig = ChartConfigType & NileChartConfigBase;
-export type NileKpiChartConfig = Extract<NileChartConfig, {
+export interface NileTrendlineChartConfig extends NileChartConfigBase {
+    type: 'trendline';
+    data: TrendlineSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    forecast?: ForecastConfig | null;
+}
+export interface NileAnomalyChartConfig extends NileChartConfigBase {
+    type: 'anomaly';
+    data: AnomalySeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    anomaly?: AnomalyConfig;
+}
+export interface NileHistogramChartConfig extends NileChartConfigBase {
+    type: 'histogram';
+    data: HistogramSamples;
+    xAxisTitle?: string;
+    yAxisTitle?: string;
+    histogramSeriesName?: string;
+    sourceSeriesName?: string;
+    histogramColor?: string;
+    binsNumber?: string;
+    binWidth?: number;
+}
+export interface NileBellcurveChartConfig extends NileChartConfigBase {
+    type: 'bellcurve';
+    data: BellcurveSamples;
+    xAxisTitle?: string;
+    yAxisTitle?: string;
+    bellcurveSeriesName?: string;
+    sourceSeriesName?: string;
+    bellcurveColor?: string;
+    bellcurveFill?: string;
+    intervals?: number;
+    pointsInInterval?: number;
+}
+export interface NileBoxplotChartConfig extends NileChartConfigBase {
+    type: 'boxplot';
+    data: BoxplotSeriesData[];
+    categories?: string[];
+    xAxisTitle?: string;
+    yAxisTitle?: string;
+    horizontal?: boolean;
+}
+export interface NileStackedChartConfig extends NileChartConfigBase {
+    type: 'stacked';
+    data: StackedChartSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    stackMode?: 'normal' | 'percent';
+    pointPadding?: number;
+}
+export interface NileClusterChartConfig extends NileChartConfigBase {
+    type: 'cluster';
+    data: ClusterChartSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    groupPadding?: number;
+    pointPadding?: number;
+}
+export interface NileColumnPyramidChartConfig extends NileChartConfigBase {
+    type: 'columnPyramid';
+    data: ColumnPyramidSeriesData[];
+    categories?: string[];
+}
+export interface NileColumnRangeChartConfig extends NileChartConfigBase {
+    type: 'columnRange';
+    data: ColumnRangeSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+}
+export interface NileColumnDrilldownChartConfig extends NileChartConfigBase {
+    type: 'columnDrilldown';
+    data: ColumnDrilldownParentPoint[];
+    drilldownSeries?: ColumnDrilldownSeriesConfig[];
+    seriesName?: string;
+    yAxisTitle?: string;
+}
+export interface NileLollipopChartConfig extends NileChartConfigBase {
+    type: 'lollipop';
+    data: LollipopSeriesData[];
+    categories?: string[];
+}
+export interface NileInvertedAreaChartConfig extends NileChartConfigBase {
+    type: 'invertedArea';
+    data: InvertedAreaChartSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    stacked?: boolean;
+}
+export interface NileAreaSplineChartConfig extends NileChartConfigBase {
+    type: 'areaSpline';
+    data: AreaSplineSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    stacked?: boolean;
+}
+export interface NileAreaNegativeChartConfig extends NileChartConfigBase {
+    type: 'areaNegative';
+    data: AreaNegativeSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    threshold?: number;
+}
+export interface NileAreaRangeChartConfig extends NileChartConfigBase {
+    type: 'areaRange';
+    data: AreaRangeSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+}
+export interface NileDumbbellChartConfig extends NileChartConfigBase {
+    type: 'dumbbell';
+    data: DumbbellPoint[];
+    yAxisTitle?: string;
+    seriesName?: string;
+    lowMarkerColor?: string;
+    connectorColor?: string;
+    horizontal?: boolean;
+}
+export type NileDumbbellLowerChartConfig = Omit<NileDumbbellChartConfig, 'type'> & {
+    type: 'dumbbellLower';
+};
+export type NileDumbbellUpperChartConfig = Omit<NileDumbbellChartConfig, 'type'> & {
+    type: 'dumbbellUpper';
+};
+export interface NileRadialBarChartConfig extends NileChartConfigBase {
+    type: 'radialBar';
+    data: RadialBarSeriesData[];
+    categories?: string[];
+    yAxisTitle?: string;
+    innerSize?: string;
+    paneSize?: string;
+}
+export interface NileSpiderwebChartConfig extends NileChartConfigBase {
+    type: 'spiderweb';
+    data: SpiderwebChartSeriesData[];
+    categories?: string[];
+    showArea?: boolean;
+}
+export interface NileTimelineChartConfig extends NileChartConfigBase {
+    type: 'timeline';
+    data: TimelineEvent[];
+    seriesName?: string;
+    datetimeAxis?: boolean;
+    inverted?: boolean;
+    alternateLabels?: boolean;
+}
+export interface NileFanChartConfig extends NileChartConfigBase {
+    type: 'fan';
+    lineData: FanLinePoint[];
+    bands?: FanUncertaintyBand[];
+    yAxisTitle?: string;
+    lineSeriesName?: string;
+    lineColor?: string;
+    forecastStartIndex?: number;
+    forecastBandLabel?: string;
+}
+export interface NileFunnelChartConfig extends NileChartConfigBase {
+    type: 'funnel';
+    data: FunnelDataPoint[];
+    seriesName?: string;
+    showDataLabels?: boolean;
+}
+export interface NileOrganizationChartConfig extends NileChartConfigBase {
+    type: 'organization';
+    nodes: OrgChartNode[];
+    links: OrgChartLink[];
+    seriesName?: string;
+    inverted?: boolean;
+}
+export interface NileHeatmapChartConfig extends NileChartConfigBase {
+    type: 'heatmap';
+    data: HeatmapCell[];
+    xCategories?: string[];
+    yCategories?: string[];
+    seriesName?: string;
+    colorMin?: number;
+    colorMax?: number;
+    minColor?: string;
+    maxColor?: string;
+    colorAxisTitle?: string;
+    showDataLabels?: boolean;
+}
+export interface NileFlameChartConfig extends NileChartConfigBase {
+    type: 'flame';
+    data?: FlameChartPoint[];
+    sunburstData?: FlameSunburstPoint[];
+    layout?: FlameChartLayout;
+}
+export interface NileVariablePieChartConfig extends NileChartConfigBase {
+    type: 'variablePie';
+    data: VariablePieDataPoint[];
+    seriesName?: string;
+    showDataLabels?: boolean;
+}
+export interface NileEulerChartConfig extends NileChartConfigBase {
+    type: 'euler';
+    data: EulerVennDataPoint[];
+}
+export interface NilePolygonChartConfig extends NileChartConfigBase {
+    type: 'polygon';
+    series: PolygonSeriesConfig[];
+    xAxisTitle?: string;
+    yAxisTitle?: string;
+}
+export interface NileVectorChartConfig extends NileChartConfigBase {
+    type: 'vector';
+    data: VectorDataPoint[];
+    seriesName?: string;
+    xAxisTitle?: string;
+    yAxisTitle?: string;
+}
+export interface NileXrangeChartConfig extends NileChartConfigBase {
+    type: 'xrange';
+    data: XrangeDataPoint[];
+    categories?: string[];
+    seriesName?: string;
+    datetimeAxis?: boolean;
+}
+export interface NileLineColumnChartConfig extends NileChartConfigBase {
+    type: 'line-column';
+    categories: string[];
+    columnSeries?: LineColumnSeriesPart;
+    lineSeries?: LineColumnSeriesPart;
+    columnAxisTitle?: string;
+    lineAxisTitle?: string;
+}
+export interface NileKpiChartConfig extends NileChartConfigBase {
     type: 'kpi';
-}>;
+    /** Display variant. Default: 'default'. */
+    variant?: KpiVariant;
+    label?: string;
+    value?: number | string;
+    prefix?: string;
+    suffix?: string;
+    description?: string;
+    trendValue?: number | null;
+    trendDirection?: TrendDirection;
+    trendLabel?: string;
+    trendUpColor?: string;
+    trendDownColor?: string;
+    trendNeutralColor?: string;
+    sparkline?: number[];
+    sparklineType?: SparklineType;
+    sparklineColor?: string;
+    sparklineFillOpacity?: number;
+    sparklineHeight?: number;
+    sparklineLineWidth?: number;
+    sparklineMarkers?: boolean;
+    gaugeValue?: number;
+    gaugeMin?: number;
+    gaugeMax?: number;
+    gaugeColor?: string;
+    gaugeTrackColor?: string;
+    gaugeStartAngle?: number;
+    gaugeEndAngle?: number;
+    gaugeInnerRadius?: string;
+    gaugeOuterRadius?: string;
+    gaugeRounded?: boolean;
+    gaugeHeight?: number;
+    gaugeLabelFontSize?: string | number;
+    gaugeLabelColor?: string;
+    gaugeLabelFontWeight?: string | number;
+    gaugeLabelYOffset?: number;
+    valueFontSize?: string | number;
+    valueColor?: string;
+    labelColor?: string;
+    labelFontSize?: string | number;
+    labelFontWeight?: string | number;
+    descriptionColor?: string;
+    descriptionFontSize?: string | number;
+    prefixSuffixColor?: string;
+    prefixSuffixFontSize?: string | number;
+    cardBackground?: string;
+    cardBorderColor?: string;
+    cardBorderWidth?: string | number;
+    cardBorderRadius?: string | number;
+    cardShadow?: string;
+    cardShadowHover?: string;
+    cardPaddingVertical?: string | number;
+    cardPaddingHorizontal?: string | number;
+    contentGap?: string | number;
+    tooltipEnabled?: boolean;
+}
+/** Discriminated union of every named chart config — use for typed `<nile-chart>` configs. */
+export type NileChartConfig = NileBarChartConfig | NilePieChartConfig | NileLineChartConfig | NileAreaChartConfig | NileColumnChartConfig | NileDonutChartConfig | NileScatterChartConfig | NileBubbleChartConfig | NileSplineChartConfig | NileRadarChartConfig | NileGaugeChartConfig | NileWaterfallChartConfig | NileMapChartConfig | NileGridChartConfig | NileTrendlineChartConfig | NileAnomalyChartConfig | NileHistogramChartConfig | NileBellcurveChartConfig | NileBoxplotChartConfig | NileStackedChartConfig | NileClusterChartConfig | NileColumnPyramidChartConfig | NileColumnRangeChartConfig | NileColumnDrilldownChartConfig | NileLollipopChartConfig | NileInvertedAreaChartConfig | NileAreaSplineChartConfig | NileAreaNegativeChartConfig | NileAreaRangeChartConfig | NileDumbbellChartConfig | NileDumbbellLowerChartConfig | NileDumbbellUpperChartConfig | NileRadialBarChartConfig | NileSpiderwebChartConfig | NileTimelineChartConfig | NileFanChartConfig | NileFunnelChartConfig | NileOrganizationChartConfig | NileHeatmapChartConfig | NileFlameChartConfig | NileVariablePieChartConfig | NileEulerChartConfig | NilePolygonChartConfig | NileVectorChartConfig | NileXrangeChartConfig | NileLineColumnChartConfig | NileKpiChartConfig;

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

@@ -85,12 +85,9 @@ export declare class NileChart extends NileElement {
     private hasHeaderSlotContent;
     /** True when elements are projected into `header-actions` (used to show the header row). */
     private hasHeaderActionsSlot;
-    /** True when elements are projected into the `header` slot (default title/subtitle hidden). */
-    /** True when elements are projected into `header-actions` (used to show the header row). */
     private aiPanel;
     private get effectiveSummary();
     /** AI panel shows when ai.enabled is true OR when a summary is provided. */
-    /** AI panel shows when ai.enabled is true OR when a summary is provided. */
     private get aiEnabled();
     private handleOutsideClick;
     connectedCallback(): void;