@visionaris-bruno/vs-echarts 7.2.0 → 8.2.3

package/index.d.ts

@@ -1,10 +1,17 @@
 import * as i0 from '@angular/core';
 import { OnChanges, OnDestroy, ElementRef, EventEmitter, SimpleChanges } from '@angular/core';
 import * as echarts from 'echarts';
-import { LineSeriesOption, BarSeriesOption, PieSeriesOption, ScatterSeriesOption, FunnelSeriesOption, SunburstSeriesOption, EChartsOption, SeriesOption } from 'echarts';
+import { LineSeriesOption, BarSeriesOption, PieSeriesOption, ScatterSeriesOption, FunnelSeriesOption, SunburstSeriesOption, SankeySeriesOption, EChartsOption, SeriesOption } from 'echarts';
 import { CategoryAxisBaseOption, ValueAxisBaseOption } from 'echarts/types/src/coord/axisCommonTypes.js';
 import { TooltipOption } from 'echarts/types/dist/shared';
 
+interface ISeriesLayoutOpts {
+    coordinateSystem?: 'cartesian2d' | 'polar';
+    axisTypes?: {
+        x: 'category' | 'value';
+        y: 'category' | 'value';
+    };
+}
 type ChartKey = keyof Omit<IOptionsOverridesWrapper, "axis" | "tooltip">;
 /** los recibira el director
  *
@@ -13,7 +20,7 @@ type VSEChartProduct = {
     chartKey: ChartKey;
     baseOptions: EChartsOption;
 };
-interface IEChartBuilder<SeriesType = SeriesOption> {
+interface IEChartBuilder<SeriesType = SeriesOption, OptsType = any> {
     /** producto base */
     baseProduct: VSEChartProduct;
     reset(): void;
@@ -22,15 +29,11 @@ interface IEChartBuilder<SeriesType = SeriesOption> {
      * @param data
      * @param overrides
      */
-    addSeries(data: IEChartData, overrides: SeriesType): void;
+    addSeries(data: IEChartData, overrides: SeriesType, opts?: OptsType): void;
     addTooltip(data: IEChartData, overrides: ITooltipOptionsOverrides): void;
     addPolar(): void;
-    addXAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
-    addYAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addXAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addYAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
     addRadiusAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addAngleAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addLegend(): void;
@@ -79,6 +82,9 @@ interface IFunnelOptionsOverrides {
 interface ISunburstOptionsOverrides {
     series?: Partial<SunburstSeriesOption>;
 }
+interface ISankeyOptionsOverrides {
+    series?: Partial<SankeySeriesOption>;
+}
 interface IAxisOptionsOverrides {
     categoryAxis: CategoryAxisBaseOption[];
     valueAxis: ValueAxisBaseOption[];
@@ -107,6 +113,8 @@ interface IOptionsOverrides {
     funnel: IFunnelOptionsOverrides;
     /** sunburst options overrides */
     sunburst: ISunburstOptionsOverrides;
+    /** sankey options overrides */
+    sankey: ISankeyOptionsOverrides;
 }
 type NGXEchartsSelectChangeEventData = {
     type: string;
@@ -127,35 +135,28 @@ type NGXEchartsSelectChangeEventData = {
 };
 
 /**
- * IEChartCategoryNode
+ * IEChartDataNode
  *
- * Representa un nodo en el árbol de categorías (filas).
+ * Representa un nodo/fila en el arreglo de objetos jerárquico.
  */
-interface IEChartCategoryNode {
-    name: string;
-    key?: string;
-    children?: IEChartCategoryNode[];
+interface IEChartDataNode {
+    category: string;
+    [key: string]: any;
+    children?: IEChartDataNode[];
 }
-/**
- * IEChartSeriesNode
- *
- * Representa un nodo en el árbol de series (columnas/medidas).
- */
-interface IEChartSeriesNode {
+interface IEChartDimension {
     name: string;
-    originalKey?: string;
-    data: number[];
-    children?: IEChartSeriesNode[];
+    displayName?: string;
 }
 /**
  * IEChartData
  *
- * Interfaz unificada para el paso de datos a componentes de ECharts.
+ * Interfaz unificada para el paso de datos basados en dataset a componentes de ECharts.
  *
  */
 interface IEChartData {
-    categories: IEChartCategoryNode[];
-    series: IEChartSeriesNode[];
+    dimensions: IEChartDimension[];
+    source: IEChartDataNode[];
 }
 /**
  * EChartValueFormatter
@@ -208,7 +209,7 @@ type MakeScatterOpts = MakeOpts;
  */
 declare class VSECDirector {
     private builder;
-    constructor(builder: IEChartBuilder<any>);
+    constructor(builder: IEChartBuilder<any, ISeriesLayoutOpts>);
     makeBar(data: IEChartData, overrides: IOptionsOverridesWrapper, opts?: MakeBarOpts): void;
     makeBarRadial(data: IEChartData, overrides: IOptionsOverridesWrapper, opts?: MakeBarOpts): void;
     makeLine(data: IEChartData, overrides: IOptionsOverridesWrapper, opts?: MakeLineOpts): void;
@@ -217,6 +218,7 @@ declare class VSECDirector {
     makePie(data: IEChartData, overrides: IOptionsOverridesWrapper, opts?: MakeOpts): void;
     makeFunnel(data: IEChartData, overrides: IOptionsOverridesWrapper, opts?: MakeOpts): void;
     makeSunburst(data: IEChartData, overrides: IOptionsOverridesWrapper, opts?: MakeOpts): void;
+    makeSankey(data: IEChartData, overrides: IOptionsOverridesWrapper, opts?: MakeOpts): void;
 }
 
 declare abstract class BaseEchartsComponent implements OnChanges, OnDestroy {
@@ -335,12 +337,8 @@ declare class RingBuilder implements IEChartBuilder<PieSeriesOption> {
     addTooltip(data: IEChartData, overrides: ITooltipOptionsOverrides): void;
     addLegend(): void;
     addPolar(): void;
-    addXAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
-    addYAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addXAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addYAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
     addRadiusAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addAngleAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     setValueFormatter(formatter: EChartValueFormatter | undefined): void;
@@ -402,12 +400,8 @@ declare class PieBuilder implements IEChartBuilder<PieSeriesOption> {
     addTooltip(data: IEChartData, overrides: ITooltipOptionsOverrides): void;
     addLegend(): void;
     addPolar(): void;
-    addXAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
-    addYAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addXAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addYAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
     addRadiusAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addAngleAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addGraphic(): void;
@@ -454,12 +448,8 @@ declare class FunnelBuilder implements IEChartBuilder<FunnelSeriesOption> {
     addTooltip(data: IEChartData, overrides: ITooltipOptionsOverrides): void;
     addLegend(): void;
     addPolar(): void;
-    addXAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
-    addYAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addXAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
+    addYAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: 'category' | 'value'): void;
     addRadiusAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addAngleAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addGraphic(): void;
@@ -493,7 +483,7 @@ declare class EchartsFunnelComponent extends BaseEchartsComponent {
  *
  * Puede verse utilizado en graficos como Lineas y Bars. Siempre que se pueda priorizar utilizar este.
  */
-declare class EChartBuilder implements IEChartBuilder<SeriesOption & BarSeriesOption & LineSeriesOption & ScatterSeriesOption> {
+declare class EChartBuilder implements IEChartBuilder<SeriesOption & BarSeriesOption & LineSeriesOption & ScatterSeriesOption, ISeriesLayoutOpts> {
     baseProduct: VSEChartProduct;
     protected valueFormatter: EChartValueFormatter;
     protected palette: string[];
@@ -508,7 +498,7 @@ declare class EChartBuilder implements IEChartBuilder<SeriesOption & BarSeriesOp
      * @param overrides
      * @returns
      */
-    addSeries(data: IEChartData, overrides: SeriesOption & BarSeriesOption & LineSeriesOption & ScatterSeriesOption): void;
+    addSeries(data: IEChartData, overrides: SeriesOption & BarSeriesOption & LineSeriesOption & ScatterSeriesOption, opts?: ISeriesLayoutOpts): void;
     /**
      * TODO: Mejorar funcion, no me convence como se implemento el tooltip formatter.
      * @param data
@@ -516,12 +506,8 @@ declare class EChartBuilder implements IEChartBuilder<SeriesOption & BarSeriesOp
      */
     addTooltip(data: IEChartData, overrides: ITooltipOptionsOverrides): void;
     addPolar(): void;
-    addXAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type?: 'category' | 'value'): void;
-    addYAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type?: 'category' | 'value'): void;
+    addXAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type?: 'category' | 'value'): void;
+    addYAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type?: 'category' | 'value'): void;
     addRadiusAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addAngleAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addLegend(): void;
@@ -543,12 +529,8 @@ declare class EChartBuilder implements IEChartBuilder<SeriesOption & BarSeriesOp
      * Permite inyectar un resolver de colores dinámico.
      */
     setColorResolver(resolver: ChartColorResolver): void;
-    protected getCategoryAxisOptions(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"]): CategoryAxisBaseOption;
-    protected getValueAxisOptions(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"]): any;
+    protected getCategoryAxisOptions(data: IEChartData, overrides: IOptionsOverrides["axis"]): CategoryAxisBaseOption;
+    protected getValueAxisOptions(data: IEChartData, overrides: IOptionsOverrides["axis"]): any;
 }
 
 declare abstract class EchartsBarComponent extends BaseEchartsComponent {
@@ -673,12 +655,8 @@ declare class SunburstBuilder implements IEChartBuilder<SunburstSeriesOption> {
     addSeries(data: IEChartData, overrides: SunburstSeriesOption): void;
     addTooltip(data: IEChartData, overrides: ITooltipOptionsOverrides): void;
     addPolar(): void;
-    addXAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: "category" | "value"): void;
-    addYAxis(data: {
-        categories: IEChartData["categories"];
-    }, overrides: IOptionsOverrides["axis"], type: "category" | "value"): void;
+    addXAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: "category" | "value"): void;
+    addYAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: "category" | "value"): void;
     addRadiusAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addAngleAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
     addLegend(): void;
@@ -709,5 +687,44 @@ declare class EChartsSunburstComponent extends BaseEchartsComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<EChartsSunburstComponent, "vs-echarts-sunburst", never, {}, {}, never, never, true, never>;
 }
 
-export { BaseEchartsComponent, EChartsAreaComponent, EChartsAreaStackComponent, EChartsBarStackedComponent, EChartsBarStackedRadialComponent, EChartsHBarComponent, EChartsHBarStackedComponent, EChartsSunburstComponent, EchartsBarComponent, EchartsFunnelComponent, EchartsLineComponent, EchartsPieComponent, EchartsRingComponent, EchartsScatterComponent, defaultOptionsOverrides, initializeEcharts, provideVSEcharts };
-export type { ChartColorResolver, ChartOrientation, EChartClickType, EChartValueFormatter, IAreaOptionsOverrides, IAreaStackOptionsOverrides, IAxisOptionsOverrides, IBarOptionsOverrides, IBarStackedOptionsOverrides, IBarStackedRadialOptionsOverrides, IEChartBuilder, IEChartCategoryNode, IEChartData, IEChartSeriesNode, IFunnelOptionsOverrides, IHBarOptionsOverrides, IHBarStackedOptionsOverrides, ILineOptionsOverrides, IOptionsOverrides, IOptionsOverridesWrapper, IPieOptionsOverrides, IRingOptionsOverrides, IScatterOptionsOverrides, ISunburstOptionsOverrides, ITooltipOptionsOverrides, NGXEchartsSelectChangeEventData, VSEChartProduct };
+/**
+ * SankeyBuilder
+ *
+ * Builder concreto para el gráfico Sankey (diagrama de flujos de izquierda a derecha).
+ */
+declare class SankeyBuilder implements IEChartBuilder<SankeySeriesOption> {
+    baseProduct: VSEChartProduct;
+    protected valueFormatter: EChartValueFormatter;
+    protected palette: string[];
+    protected colorResolver?: ChartColorResolver;
+    protected result: EChartsOption;
+    constructor(baseProduct: VSEChartProduct);
+    reset(): void;
+    addSeries(data: IEChartData, overrides: SankeySeriesOption): void;
+    addTooltip(data: IEChartData, overrides: ITooltipOptionsOverrides): void;
+    addPolar(): void;
+    addXAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: "category" | "value"): void;
+    addYAxis(data: IEChartData, overrides: IOptionsOverrides["axis"], type: "category" | "value"): void;
+    addRadiusAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
+    addAngleAxis(data: IEChartData, overrides: IOptionsOverrides["axis"]): void;
+    addLegend(): void;
+    addCommons(): void;
+    addGraphic(): void;
+    getResult(): EChartsOption;
+    setValueFormatter(formatter: EChartValueFormatter | undefined): void;
+    setPalette(palette: string[] | undefined): void;
+    setColorResolver(resolver: ChartColorResolver | undefined): void;
+}
+
+declare class EchartsSankeyComponent extends BaseEchartsComponent {
+    protected baseSeriesOptions: SankeySeriesOption;
+    protected baseProduct: VSEChartProduct;
+    protected builder: SankeyBuilder;
+    protected director: VSECDirector;
+    protected make(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EchartsSankeyComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EchartsSankeyComponent, "vs-echarts-sankey", never, {}, {}, never, never, true, never>;
+}
+
+export { BaseEchartsComponent, EChartsAreaComponent, EChartsAreaStackComponent, EChartsBarStackedComponent, EChartsBarStackedRadialComponent, EChartsHBarComponent, EChartsHBarStackedComponent, EChartsSunburstComponent, EchartsBarComponent, EchartsFunnelComponent, EchartsLineComponent, EchartsPieComponent, EchartsRingComponent, EchartsSankeyComponent, EchartsScatterComponent, defaultOptionsOverrides, initializeEcharts, provideVSEcharts };
+export type { ChartColorResolver, ChartOrientation, EChartClickType, EChartValueFormatter, IAreaOptionsOverrides, IAreaStackOptionsOverrides, IAxisOptionsOverrides, IBarOptionsOverrides, IBarStackedOptionsOverrides, IBarStackedRadialOptionsOverrides, IEChartBuilder, IEChartData, IEChartDataNode, IEChartDimension, IFunnelOptionsOverrides, IHBarOptionsOverrides, IHBarStackedOptionsOverrides, ILineOptionsOverrides, IOptionsOverrides, IOptionsOverridesWrapper, IPieOptionsOverrides, IRingOptionsOverrides, ISankeyOptionsOverrides, IScatterOptionsOverrides, ISeriesLayoutOpts, ISunburstOptionsOverrides, ITooltipOptionsOverrides, NGXEchartsSelectChangeEventData, VSEChartProduct };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visionaris-bruno/vs-echarts",
-  "version": "7.2.0",
+  "version": "8.2.3",
   "peerDependencies": {
     "@angular/common": "^20.3.0",
     "@angular/core": "^20.3.0",