stz-chart-maker 1.3.1 → 1.3.3

package/README.md

@@ -6,8 +6,8 @@
 
 ## using npm :
   ```bash
-      npm install stz-chart-maker
-      npm install -D stz-chart-maker
+  npm install stz-chart-maker
+  npm install -D stz-chart-maker
   ```
 ## api Docs
 [📚 API 문서](https://stz-chart-maker.vercel.app)

package/dist/index.d.ts

@@ -76,6 +76,8 @@ interface ChartBuilder<TType extends ChartType> {
     }) => void): this;
     setTitle(titleOptions: CommonCartesianTitleConfig): this;
     setLegend(legendOptions: DeepPartial<LegendOptions<TType>>): this;
+    getChartData(uid: string): object;
+    setChartData(uid: string, data: CustomChartDatasets<TType>): void;
 }
 type Align = 'start' | 'center' | 'end';
 type Position = Align | 'left' | 'right' | 'top' | 'bottom';
@@ -88,6 +90,16 @@ type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends object ? (T[P] extends Function ? T[P] : DeepPartial<T[P]>) : T[P];
 };
 type Override<T, U> = Omit<T, keyof U> & U;
+type CustomChartDatasets<TType extends ChartType = ChartType> = ChartDataset<TType, (number | null)[]> & {
+    _aux?: any;
+    _uid?: string;
+    _group?: string | number;
+    _legendOrder?: number;
+    _visible?: boolean;
+    _tooltip?: string | ((context: any) => string);
+    _groupLabel?: string;
+    _toggleBehavior?: 'normal' | 'radio' | 'disabled';
+};
 interface SettingOptions {
     img: string;
     iconSize: {
@@ -126,7 +138,6 @@ interface CommonCartesianTitleConfig {
         bottom: number;
     };
 }
-
 interface CommonCartesianLegendConfig {
     display?: boolean;
     position?: 'top' | 'left' | 'bottom' | 'right' | 'center' | 'chartArea';
@@ -440,6 +451,7 @@ type Types_CustomArcChartOptions<TType extends ArcChartType = ArcChartType> = Cu
 type Types_CustomBarChartOptions = CustomBarChartOptions;
 type Types_CustomBubbleChartOptions = CustomBubbleChartOptions;
 type Types_CustomCartesianDataset<TType extends CartesianChartType = CartesianChartType> = CustomCartesianDataset<TType>;
+type Types_CustomChartDatasets<TType extends ChartType = ChartType> = CustomChartDatasets<TType>;
 type Types_CustomChartOptions<TType extends ChartType = ChartType> = CustomChartOptions<TType>;
 type Types_CustomDoughnutChartOptions = CustomDoughnutChartOptions;
 type Types_CustomLineChartOptions = CustomLineChartOptions;
@@ -458,7 +470,7 @@ type Types_RadarChartBuilder = RadarChartBuilder;
 type Types_RadialChartType = RadialChartType;
 type Types_SettingOptions = SettingOptions;
 declare namespace Types {
-  export type { Types_Align as Align, Types_ArcChartBuilder as ArcChartBuilder, Types_ArcChartType as ArcChartType, Types_ArcDataset as ArcDataset, Types_BarChartBuilder as BarChartBuilder, Types_BubbleChartBuilder as BubbleChartBuilder, Types_CartesianChartBuilder as CartesianChartBuilder, Types_CartesianChartType as CartesianChartType, Types_CartesianDataset as CartesianDataset, Types_ChartBuilder as ChartBuilder, Types_Color as Color, Types_CommonAxes as CommonAxes, Types_CommonAxesSacels as CommonAxesSacels, Types_CommonCartesian as CommonCartesian, Types_CommonCartesianAxes as CommonCartesianAxes, Types_CommonCartesianLegendConfig as CommonCartesianLegendConfig, Types_CommonCartesianTicks as CommonCartesianTicks, Types_CommonCartesianTitleConfig as CommonCartesianTitleConfig, Types_CommonTicks as CommonTicks, Types_Constructor as Constructor, Types_CustomArcChartOptions as CustomArcChartOptions, Types_CustomBarChartOptions as CustomBarChartOptions, Types_CustomBubbleChartOptions as CustomBubbleChartOptions, Types_CustomCartesianDataset as CustomCartesianDataset, Types_CustomChartOptions as CustomChartOptions, Types_CustomDoughnutChartOptions as CustomDoughnutChartOptions, Types_CustomLineChartOptions as CustomLineChartOptions, Types_CustomOptionPlugins as CustomOptionPlugins, Types_CustomPieChartOptions as CustomPieChartOptions, Types_DeepPartial as DeepPartial, Types_DeepPartialCartesianAxes as DeepPartialCartesianAxes, Types_DeepPartialPluginOptions as DeepPartialPluginOptions, Types_DoughnutChartBuilder as DoughnutChartBuilder, Types_HtmlLegendOptions as HtmlLegendOptions, Types_LineChartBuilder as LineChartBuilder, Types_Mode as Mode, Types_PieChartBuilder as PieChartBuilder, Types_Position as Position, Types_RadarChartBuilder as RadarChartBuilder, Types_RadialChartType as RadialChartType, Types_SettingOptions as SettingOptions };
+  export type { Types_Align as Align, Types_ArcChartBuilder as ArcChartBuilder, Types_ArcChartType as ArcChartType, Types_ArcDataset as ArcDataset, Types_BarChartBuilder as BarChartBuilder, Types_BubbleChartBuilder as BubbleChartBuilder, Types_CartesianChartBuilder as CartesianChartBuilder, Types_CartesianChartType as CartesianChartType, Types_CartesianDataset as CartesianDataset, Types_ChartBuilder as ChartBuilder, Types_Color as Color, Types_CommonAxes as CommonAxes, Types_CommonAxesSacels as CommonAxesSacels, Types_CommonCartesian as CommonCartesian, Types_CommonCartesianAxes as CommonCartesianAxes, Types_CommonCartesianLegendConfig as CommonCartesianLegendConfig, Types_CommonCartesianTicks as CommonCartesianTicks, Types_CommonCartesianTitleConfig as CommonCartesianTitleConfig, Types_CommonTicks as CommonTicks, Types_Constructor as Constructor, Types_CustomArcChartOptions as CustomArcChartOptions, Types_CustomBarChartOptions as CustomBarChartOptions, Types_CustomBubbleChartOptions as CustomBubbleChartOptions, Types_CustomCartesianDataset as CustomCartesianDataset, Types_CustomChartDatasets as CustomChartDatasets, Types_CustomChartOptions as CustomChartOptions, Types_CustomDoughnutChartOptions as CustomDoughnutChartOptions, Types_CustomLineChartOptions as CustomLineChartOptions, Types_CustomOptionPlugins as CustomOptionPlugins, Types_CustomPieChartOptions as CustomPieChartOptions, Types_DeepPartial as DeepPartial, Types_DeepPartialCartesianAxes as DeepPartialCartesianAxes, Types_DeepPartialPluginOptions as DeepPartialPluginOptions, Types_DoughnutChartBuilder as DoughnutChartBuilder, Types_HtmlLegendOptions as HtmlLegendOptions, Types_LineChartBuilder as LineChartBuilder, Types_Mode as Mode, Types_PieChartBuilder as PieChartBuilder, Types_Position as Position, Types_RadarChartBuilder as RadarChartBuilder, Types_RadialChartType as RadialChartType, Types_SettingOptions as SettingOptions };
 }
 
 interface ChartConfig {
@@ -482,12 +494,14 @@ type ChartBuilderMap = {
 declare abstract class ChartWrapper<TType extends ChartType, TOptions extends CustomChartOptions<TType> = CustomChartOptions<TType>> implements ChartBuilder<TType> {
     protected type: TType;
     protected labels: (string | number)[];
-    protected datasets: ChartDataset<TType, (number | null)[]>[];
+    private _datasets;
     protected options: TOptions;
     protected plugins?: any | undefined;
+    protected get datasets(): CustomChartDatasets<TType>[];
+    protected set datasets(value: CustomChartDatasets<TType>[]);
     static registry: Map<string, Constructor<any, any>>;
-    constructor(type: TType, labels: (string | number)[], datasets: ChartDataset<TType, (number | null)[]>[], options: TOptions, plugins?: any | undefined);
-    static create<TType extends ChartType>(type: TType, labels: (string | number)[], datasets: ChartDataset<TType, (number | null)[]>[], options?: CustomChartOptions<TType>, plugins?: Plugin$1): TType extends keyof ChartBuilderMap ? ChartBuilderMap[TType] : ChartBuilder<TType>;
+    constructor(type: TType, labels: (string | number)[], _datasets: CustomChartDatasets<TType>[], options: TOptions, plugins?: any | undefined);
+    static create<TType extends ChartType>(type: TType, labels: (string | number)[], datasets: CustomChartDatasets<TType>[], options?: CustomChartOptions<TType>, plugins?: Plugin$1): TType extends keyof ChartBuilderMap ? ChartBuilderMap[TType] : ChartBuilder<TType>;
     static register<TType extends ChartType, TInstance>(type: TType, wrapperClass: Constructor<TType, TInstance>): void;
     static has(type: ChartType): boolean;
     protected abstract normalize(): void;
@@ -576,6 +590,29 @@ declare abstract class ChartWrapper<TType extends ChartType, TOptions extends Cu
      * });
      */
     setLegend(legendOptions: DeepPartial<LegendOptions<TType>>): this;
+    /**
+     * @description 특정 데이터셋을 식별자(UID 또는 라벨)로 조회합니다.
+     * @param {string} uid
+     * @returns {CustomChartDatasets<TType>}
+     * @since 1.0.0
+     * @category dataset
+     * @example
+     * const dataset = chart.getChartData('dataset-uid-or-label');
+     * console.log(dataset);
+     * @beta
+     */
+    getChartData(uid: string): CustomChartDatasets<TType>;
+    /**
+     * @description 특정 데이터셋을 식별자(UID 또는 라벨)로 찾아 새로운 데이터셋으로 교체합니다.
+     * @param {string} uid
+     * @param {CustomChartDatasets<TType>} newDataset
+     * @since 1.0.0
+     * @category dataset
+     * @example
+     * chart.setChartData('dataset-uid-or-label', { label: 'New Dataset', data: [10, 20, 30] });
+     * @beta
+     */
+    setChartData(uid: string, newDataset: CustomChartDatasets<TType>): void;
 }
 
 interface AxisColors {
@@ -659,6 +696,7 @@ declare abstract class CartesianChartWrapper<TType extends CartesianChartType> e
     protected decorateDataset(ds: any, idx: number): void;
     protected mustHavePlugins(): {
         id: string;
+        _tooltips: WeakMap<WeakKey, any>;
         afterDraw(chart: any, args: any, options: any): void;
         afterInit(chart: any, args: any, options: any): void;
         beforeUpdate(chart: any, args: any, options: any): void;
@@ -666,8 +704,8 @@ declare abstract class CartesianChartWrapper<TType extends CartesianChartType> e
         _handleLegendClick(e: any, legendItem: any, legend: any, toggleBehavior: string): void;
         _setupLegendTooltip(chart: any): void;
         _hitTestLegend(chart: any, x: number, y: number): any;
-        _showTooltip(e: MouseEvent, tooltipContent: string | ((context: any) => string), legendItem: any): void;
-        _hideTooltip(): void;
+        _showTooltip(chart: any, e: MouseEvent, tooltipContent: string | ((context: any) => string), legendItem: any): void;
+        _hideTooltip(chart: any): void;
         afterDestroy(chart: any): void;
     }[];
     protected isLine(): boolean;
@@ -1443,6 +1481,7 @@ declare abstract class ArcChartWrapper<TType extends ArcChartType> extends Chart
     protected decorateDataset(ds: any, idx: number): void;
     protected mustHavePlugins(): {
         id: string;
+        _tooltips: WeakMap<WeakKey, any>;
         afterDraw(chart: any, args: any, options: any): void;
         afterInit(chart: any, args: any, options: any): void;
         beforeUpdate(chart: any, args: any, options: any): void;
@@ -1450,8 +1489,8 @@ declare abstract class ArcChartWrapper<TType extends ArcChartType> extends Chart
         _handleLegendClick(e: any, legendItem: any, legend: any, toggleBehavior: string): void;
         _setupLegendTooltip(chart: any): void;
         _hitTestLegend(chart: any, x: number, y: number): any;
-        _showTooltip(e: MouseEvent, tooltipContent: string | ((context: any) => string), legendItem: any): void;
-        _hideTooltip(): void;
+        _showTooltip(chart: any, e: MouseEvent, tooltipContent: string | ((context: any) => string), legendItem: any): void;
+        _hideTooltip(chart: any): void;
         afterDestroy(chart: any): void;
     }[];
     protected normalize(): void;
@@ -1801,8 +1840,12 @@ declare const customLegend: {
  *
  * @beta (aux 정상동작 , _group : 에러 , groupLabel : 정상 , _tooltip : 에러 , _toggleBehavior : 정상 , _visible : 정상 , _legendOrder : 확인중)
  */
+/**
+ * @description 차트가 마운트될 때 호출되는 플러그인입니다.
+ */
 declare const chartMountPlugin: {
     id: string;
+    _tooltips: WeakMap<WeakKey, any>;
     afterDraw(chart: any, args: any, options: any): void;
     afterInit(chart: any, args: any, options: any): void;
     beforeUpdate(chart: any, args: any, options: any): void;
@@ -1810,8 +1853,8 @@ declare const chartMountPlugin: {
     _handleLegendClick(e: any, legendItem: any, legend: any, toggleBehavior: string): void;
     _setupLegendTooltip(chart: any): void;
     _hitTestLegend(chart: any, x: number, y: number): any;
-    _showTooltip(e: MouseEvent, tooltipContent: string | ((context: any) => string), legendItem: any): void;
-    _hideTooltip(): void;
+    _showTooltip(chart: any, e: MouseEvent, tooltipContent: string | ((context: any) => string), legendItem: any): void;
+    _hideTooltip(chart: any): void;
     afterDestroy(chart: any): void;
 };
 declare const blinkPlugin: Plugin$1;
@@ -1942,7 +1985,7 @@ declare enum ChartTypes {
 
 declare const ChartToolBox: {
     setErrorLog(enabled?: boolean): void;
-    setErrorshield(enabled?: boolean): void;
+    setErrorShield(enabled?: boolean): void;
 };
 declare const T$: {
     readonly create: typeof ChartWrapper.create;
@@ -1958,9 +2001,9 @@ declare const T$: {
     readonly defaultsOptions: typeof LocalDefaults;
     readonly toolBox: {
         setErrorLog(enabled?: boolean): void;
-        setErrorshield(enabled?: boolean): void;
+        setErrorShield(enabled?: boolean): void;
     };
 };
 
 export { ArcChartWrapper, BarChartWrapper, BubbleChartWrapper, CartesianChartWrapper, ChartFactory, ChartInstance, ChartToolBox, ChartTypes, ChartWrapper, CreateZoomRangeSlider, DoughnutChartWrapper, LineChartWrapper, T$, barScaleImgPlugin, blinkPlugin, changeSetting, chartMountPlugin, createDefaultBarOptions, createDefaultBubbleOptions, createDefaultLineOptions, customLegend, T$ as default, defaultBarScales, defaultBarTooltipCallback, defaultBubbleScales, defaultBubbleTooltipCallback, defaultLineScales, defaultLineTooltipCallback, doughnutCenterTextPlugin, loadingPlugin, makeCenterHtml, noDataPlugin, sparkBarOptions, sparkBubbleOptions, sparkLineOptions, zoomRangeSlider, zoomResetPlugin };
-export type { Align, AllChartTypes, ArcChartBuilder, ArcChartType, ArcDataset, AxisColors, BarChartBuilder, BubbleChartBuilder, CartesianChartBuilder, CartesianChartType, CartesianDataset, ChartBuilder, ChartWithFocus, Color, CommonAxes, CommonAxesSacels, CommonCartesian, CommonCartesianAxes, CommonCartesianLegendConfig, CommonCartesianTicks, CommonCartesianTitleConfig, CommonTicks, Constructor, CustomArcChartOptions, CustomBarChartOptions, CustomBubbleChartOptions, CustomCartesianDataset, CustomChartOptions, CustomDoughnutChartOptions, CustomLineChartOptions, CustomOptionPlugins, CustomPieChartOptions, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, HtmlLegendOptions, LineChartBuilder, Mode, OriginalColors, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, SettingOptions, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar };
+export type { Align, AllChartTypes, ArcChartBuilder, ArcChartType, ArcDataset, AxisColors, BarChartBuilder, BubbleChartBuilder, CartesianChartBuilder, CartesianChartType, CartesianDataset, ChartBuilder, ChartWithFocus, Color, CommonAxes, CommonAxesSacels, CommonCartesian, CommonCartesianAxes, CommonCartesianLegendConfig, CommonCartesianTicks, CommonCartesianTitleConfig, CommonTicks, Constructor, CustomArcChartOptions, CustomBarChartOptions, CustomBubbleChartOptions, CustomCartesianDataset, CustomChartDatasets, CustomChartOptions, CustomDoughnutChartOptions, CustomLineChartOptions, CustomOptionPlugins, CustomPieChartOptions, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, HtmlLegendOptions, LineChartBuilder, Mode, OriginalColors, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, SettingOptions, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar };