stz-chart-maker 2.3.3 → 2.3.5

package/README.md

@@ -64,7 +64,15 @@ import { setChartConfig } from 'stz-chart-maker';
 setChartConfig({
   errorLogging: true,
   silentMode: false,
-  defaultColor: ['#FF6B6B', '#4ECDC4', '#45B7D1', '#FFA07A', '#98D8C8', '#F7DC6F']
+  defaultColor: ['#FF6B6B', '#4ECDC4', '#45B7D1', '#FFA07A', '#98D8C8', '#F7DC6F'],
+  zoom: true,
+  loading: true,
+  legend: {
+    position: 'top'
+  },
+  tooltip: {
+    enabled: true
+  }
 });
 ```
 
@@ -86,6 +94,26 @@ module.exports = {
 | `errorLogging` | `boolean` | `true` | 에러 로그 출력 여부 |
 | `silentMode` | `boolean` | `true` | 에러 발생 시 예외를 던지지 않고 처리 |
 | `defaultColor` | `string[]` | 내부 기본 팔레트 | 차트 전역 기본 색상 배열 |
+| `zoom` | `boolean \| object` | `false` | `line`, `bar`, `bubble` 차트에 전역 zoom 기본값 적용 |
+| `loading` | `boolean` | `false` | Cartesian 차트에 전역 loading 기본값 적용 |
+| `legend` | `object` | 차트 기본값 사용 | 차트 전역 legend 기본 옵션 적용 |
+| `tooltip` | `object` | 차트 기본값 사용 | 차트 전역 tooltip 기본 옵션 적용 |
+
+## Export / Empty State
+
+```tsx
+import { ChartWrapper, downloadChartAsImage, setChartConfig } from 'stz-chart-maker';
+
+setChartConfig({ loading: true });
+
+const chartConfig = ChartWrapper
+  .create('bar', [], [{ data: [] }], {
+    _noDataText: '데이터 없음',
+  })
+  .build('sales-chart');
+
+downloadChartAsImage('sales-chart');
+```
 
 ### 변경기록
 [CHANGELOG.md](./CHANGELOG.md) 파일을 참조하세요.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ChartTypeRegistry, ChartType, ChartDataset, GridLineOptions, FontSpec, Tick, PluginOptionsByType, Chart as Chart$1, ChartOptions, ChartEvent, ActiveElement, LegendOptions, Plugin as Plugin$1, TooltipItem } from 'chart.js';
+import { ChartTypeRegistry, ChartType, ChartDataset, GridLineOptions, FontSpec, Tick, PluginOptionsByType, Chart as Chart$1, ChartOptions, ChartEvent, ActiveElement, LegendOptions, TooltipOptions, Plugin as Plugin$1, TooltipItem } from 'chart.js';
 import { TreemapControllerDatasetOptions } from 'chartjs-chart-treemap';
 import { ZoomPluginOptions } from 'chartjs-plugin-zoom/types/options';
 
@@ -448,6 +448,7 @@ type CustomChartOptions<TType extends ChartType = ChartType> = Override<ChartOpt
     _mounted?: (chart: Chart$1<TType>) => void;
     _chartId?: string;
     _loading?: boolean;
+    _noDataText?: string;
 };
 type CustomArcChartOptions<TType extends ArcChartType = ArcChartType> = CustomChartOptions<TType> & {
     scales?: never;
@@ -494,6 +495,7 @@ interface ChartBuilder<TType extends ChartType> {
     }) => void): this;
     setTitle(titleOptions: CommonCartesianTitleConfig): this;
     setLegend(legendOptions: DeepPartial<LegendOptions<any>>): this;
+    setTooltip(tooltipOptions: DeepPartial<TooltipOptions<any>>): this;
     mergeOptions(options: DeepPartial<CustomChartOptions<TType>>): this;
     getChartData(uid: string): CustomChartDatasets<TType>;
     setChartData(uid: string, data: CustomChartDatasets<TType>): void;
@@ -515,6 +517,7 @@ interface CartesianChartBuilder<TType extends CartesianChartType> extends ChartB
         color?: string;
         lineWidth?: number;
     }): this;
+    setZoom(enabled: boolean, zoomOption?: DeepPartialZoomType): this;
     addZoom(defaultZoom?: boolean, zoomOption?: object): this;
     addDataLabels(defultDataLabels?: boolean, dataLabelsOptions?: PartialDataLabels): this;
     setYAxisForDataset(datasetIndex: number, axisId?: string): this;
@@ -731,6 +734,7 @@ declare abstract class Chart<TType extends ChartType, TOptions extends CustomCha
     static has(type: ChartType): boolean;
     protected cloneValue<T>(value: T): T;
     protected clonePlugins<TPlugins>(plugins: TPlugins): TPlugins;
+    protected applyGlobalPluginConfig(): void;
     protected requireDatasets(): CustomChartDatasets<TType>[];
     protected resolveDatasetIndex(uidOrIndex: string | number): number;
     protected getDatasetByTarget(uidOrIndex: string | number): CustomChartDatasets<TType>;
@@ -826,6 +830,20 @@ declare abstract class Chart<TType extends ChartType, TOptions extends CustomCha
      * });
      */
     setLegend(legendOptions: DeepPartial<LegendOptions<TType>>): this;
+    /**
+     * @description 차트의 툴팁을 설정합니다.
+     * 전역 `setChartConfig({ tooltip: ... })` 설정이 있으면 이를 기본값으로 사용하고, 이 메서드 호출값으로 병합합니다.
+     * @param {DeepPartial<TooltipOptions<TType>>} tooltipOptions
+     * @returns {this}
+     * @Since 2.4.0
+     * @category options
+     * @example
+     * chart.setTooltip({
+     *   enabled: true,
+     *   backgroundColor: 'rgba(8, 26, 61, 0.95)'
+     * });
+     */
+    setTooltip(tooltipOptions: DeepPartial<TooltipOptions<TType>>): this;
     /**
      * @description 기존 옵션에 부분 옵션을 병합합니다.
      * @param {DeepPartial<TOptions>} options
@@ -1054,9 +1072,13 @@ declare abstract class CartesianChart<TType extends CartesianChartType> extends
         _hideTooltip(chart: any): void;
         afterDestroy(chart: any): void;
     })[];
+    protected resolveMustHavePlugins(options?: CustomChartOptions<TType>): any[];
     protected isLine(): boolean;
     protected isScatter(): boolean;
     protected isBar(): boolean;
+    protected applyGlobalZoomConfig(): void;
+    protected ensureZoomResetPlugin(): void;
+    protected removeZoomResetPlugin(): void;
     protected normalize(): void;
     protected configAop(config: any): any;
     /**
@@ -1187,14 +1209,31 @@ declare abstract class CartesianChart<TType extends CartesianChartType> extends
         lineWidth?: number;
     }): this;
     /**
-     * @description 줌 기능을 추가합니다. 해당 기능은 플러그인 설치가 필요합니다.
-     * @param defaultZoom
-     * @param zoomOption
+     * @description 줌 기능을 설정합니다. `false`를 전달하면 현재 차트의 줌 설정을 제거합니다.
+     * 전역 `setChartConfig({ zoom: true })` 설정이 있더라도 이 메서드로 차트별 비활성화가 가능합니다.
+     * @param {boolean} enabled
+     * @param {CustomZoomType<TType>} zoomOption
+     * @returns {this}
+     * @since 2.4.0
+     * @category Plugins
+     */
+    setZoom(enabled: boolean, zoomOption?: DeepPartialZoomType): this;
+    /**
+     * @deprecated `setZoom(enabled, zoomOption)`을 사용하세요.
+     * @description 레거시 줌 설정 메서드입니다. 내부적으로 `setZoom(true, ...)`를 호출합니다.
+     * @param defaultZoom - `true`이면 기본 줌 옵션을 적용합니다.
+     * @param zoomOption - 사용자 정의 줌 옵션입니다.
      * @returns {this}
      * @since 1.0.0
      * @category Plugins
      * @defaultValue defaultZoom = false
+     * @example
+     * // 기존 방식
+     * chart.addZoom(true);
      *
+     * @example
+     * // 권장 방식
+     * chart.setZoom(true);
      */
     addZoom(defaultZoom?: boolean, zoomOption?: object): this;
     /**
@@ -1997,6 +2036,7 @@ declare abstract class ArcChart<TType extends ArcChartType> extends Chart<TType>
         afterDraw(chart: any, args: any, options: any): void;
         afterDestroy(chart: any): void;
     }[];
+    protected resolveMustHavePlugins(options?: CustomArcChartOptions<TType>): any[];
     protected normalize(): void;
     protected configAop(config: any): any;
     /**
@@ -2441,6 +2481,7 @@ declare class TreemapChart extends Chart<'treemap', CustomTreemapChartOptions> i
         afterDraw(chart: any, args: any, options: any): void;
         afterDestroy(chart: any): void;
     }[];
+    protected resolveMustHavePlugins(options?: CustomTreemapChartOptions): any[];
     protected configAop(config: any): any;
     /**
      * @Description 차트 설정 객체를 생성합니다.
@@ -3098,6 +3139,10 @@ interface StzConfig {
     errorLogging?: boolean;
     silentMode?: boolean;
     defaultColor?: string[];
+    zoom?: boolean | DeepPartialZoomType;
+    loading?: boolean;
+    legend?: DeepPartial<LegendOptions<any>>;
+    tooltip?: DeepPartial<TooltipOptions<any>>;
     /** @deprecated no-op. Built-in chart types are bootstrapped at package load time. */
     autoRegister?: boolean;
     /** @deprecated no-op. Built-in chart types are bootstrapped at package load time. */
@@ -3114,7 +3159,15 @@ interface StzConfig {
  * setChartConfig({
  *   errorLogging: true,
  *   silentMode: false,
- *   defaultColor: ['#111111', '#22c55e', '#3b82f6']
+ *   defaultColor: ['#111111', '#22c55e', '#3b82f6'],
+ *   zoom: true,
+ *   loading: true,
+ *   legend: {
+ *     position: 'top'
+ *   },
+ *   tooltip: {
+ *     enabled: true
+ *   }
  * });
  * ```
  *
@@ -3139,6 +3192,19 @@ interface ChartImageExportOptions {
     filename?: string;
     scale?: number;
 }
+type ChartTarget = string | Chart$1;
+declare function getChartInstance(chart: Chart$1): Chart$1;
+declare function getChartInstance(chartId: string): Chart$1;
+declare function resetChartZoom(chart: Chart$1): void;
+declare function resetChartZoom(chartId: string): void;
+declare function updateChart(chart: Chart$1, mode?: Parameters<Chart$1['update']>[0]): void;
+declare function updateChart(chartId: string, mode?: Parameters<Chart$1['update']>[0]): void;
+declare function resizeChart(chart: Chart$1): void;
+declare function resizeChart(chartId: string): void;
+declare function setChartActiveElements(chart: Chart$1, activeElements: ActiveElement[]): void;
+declare function setChartActiveElements(chartId: string, activeElements: ActiveElement[]): void;
+declare function getChartDatasetMeta(chart: Chart$1, datasetIndex: number): ReturnType<Chart$1['getDatasetMeta']>;
+declare function getChartDatasetMeta(chartId: string, datasetIndex: number): ReturnType<Chart$1['getDatasetMeta']>;
 /**
  * @description 차트를 이미지로 다운로드합니다.
  * @param chartId 차트 ID
@@ -3146,6 +3212,7 @@ interface ChartImageExportOptions {
  * @since 1.5.0
  * @category util
  */
+declare function downloadChartAsImage(chart: Chart$1, options?: ChartImageExportOptions): void;
 declare function downloadChartAsImage(chartId: string, options?: ChartImageExportOptions): void;
 /**
  * @description Chart 인스턴스를 이미지로 다운로드합니다.
@@ -3163,6 +3230,7 @@ declare function downloadChartAsImageByInstance(chart: Chart$1, options?: ChartI
  * @since 1.5.0
  * @category util
  */
+declare function getChartAsBase64(chart: Chart$1, options?: Omit<ChartImageExportOptions, 'filename'>): string;
 declare function getChartAsBase64(chartId: string, options?: Omit<ChartImageExportOptions, 'filename'>): string;
 /**
  * @description Chart 인스턴스를 Base64 문자열로 반환합니다.
@@ -3181,6 +3249,7 @@ declare function getChartAsBase64ByInstance(chart: Chart$1, options?: Omit<Chart
  * @since 1.5.0
  * @category util
  */
+declare function getChartAsBlob(chart: Chart$1, options?: Omit<ChartImageExportOptions, 'filename'>): Promise<Blob>;
 declare function getChartAsBlob(chartId: string, options?: Omit<ChartImageExportOptions, 'filename'>): Promise<Blob>;
 /**
  * @description Chart 인스턴스를 Blob 객체로 반환합니다.
@@ -3225,5 +3294,5 @@ declare const T$: {
     };
 };
 
-export { ArcChart, ArcChart as ArcChartWrapper, BarChart, BarChart as BarChartWrapper, BubbleChart, BubbleChart as BubbleChartWrapper, CartesianChart, CartesianChart as CartesianChartWrapper, Chart, ChartFactory, ChartInstance, ChartToolBox, ChartTypes, Chart as ChartWrapper, CreateZoomRangeSlider, DefaultArcRadius, DefaultDataLabelsOptions, DefaultHiddenLegendTopOptions, DefaultHiddenSparkScales, DefaultResponsiveChartOptions, DefaultSparkPluginOptions, DefaultTimeScaleOptions, DefaultTopLegendOptions, DefaultZoomOptions, DoughnutChart, DoughnutChart as DoughnutChartWrapper, LineChart, LineChart as LineChartWrapper, PieChart, PieChart as PieChartWrapper, T$, TreemapChart, TreemapChart as TreemapChartWrapper, barScaleImgPlugin, blinkPlugin, changeSetting, chartMountPlugin, createAssignedTasksPlugin, createDefaultBarOptions, createDefaultBubbleOptions, createDefaultCartesianScales, createDefaultDoughnutOptions, createDefaultLineOptions, createDefaultPieOptions, createDefaultTreemapOptions, createStatusPlugin, createTodayLinePlugin, createWeekendPlugin, customDatasetPlugins, customLegend, T$ as default, defaultBarScales, defaultBarTooltipCallback, defaultBubbleScales, defaultBubbleTooltipCallback, defaultDoughnutTooltipCallback, defaultLineScales, defaultLineTooltipCallback, defaultPieTooltipCallback, defaultTreemapTooltipCallback, doughnutCenterTextPlugin, downloadChartAsImage, downloadChartAsImageByInstance, getChartAsBase64, getChartAsBase64ByInstance, getChartAsBlob, getChartAsBlobByInstance, loadingPlugin, makeCenterHtml, noDataPlugin, segmentImagePlugin, setChartConfig, sparkBarOptions, sparkBubbleOptions, sparkLineOptions, zoomRangeSlider, zoomResetPlugin };
-export type { Align, AllChartTypes, ArcChartBuilder, ArcChartType, ArcDataset, AxisColors, BarChartBuilder, BubbleChartBuilder, CartesianChartBuilder, CartesianChartType, CartesianDataset, ChartBuilder, ChartImageExportOptions, ChartWithFocus, Color, CommonAxes, CommonAxesSacels, CommonCartesian, CommonCartesianAxes, CommonCartesianLegendConfig, CommonCartesianTicks, CommonCartesianTitleConfig, CommonTicks, Constructor, CustomArcChartOptions, CustomBarChartOptions, CustomBubbleChartOptions, CustomCartesianDataset, CustomChartDatasets, CustomChartOptions, CustomDoughnutChartOptions, CustomLineChartOptions, CustomOptionPlugins, CustomPieChartOptions, CustomTreemapChartOptions, CustomTreemapDataset, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, HierarchicalChartType, HtmlLegendOptions, LineChartBuilder, Mode, OriginalColors, Override, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, SegmentImageConfig, SettingOptions, StzConfig, TimeScaleConfig, TimeScaleType, TimeUnit, TreemapChartBuilder, UidImageMapping, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar };
+export { ArcChart, ArcChart as ArcChartWrapper, BarChart, BarChart as BarChartWrapper, BubbleChart, BubbleChart as BubbleChartWrapper, CartesianChart, CartesianChart as CartesianChartWrapper, Chart, ChartFactory, ChartInstance, ChartToolBox, ChartTypes, Chart as ChartWrapper, CreateZoomRangeSlider, DefaultArcRadius, DefaultDataLabelsOptions, DefaultHiddenLegendTopOptions, DefaultHiddenSparkScales, DefaultResponsiveChartOptions, DefaultSparkPluginOptions, DefaultTimeScaleOptions, DefaultTopLegendOptions, DefaultZoomOptions, DoughnutChart, DoughnutChart as DoughnutChartWrapper, LineChart, LineChart as LineChartWrapper, PieChart, PieChart as PieChartWrapper, T$, TreemapChart, TreemapChart as TreemapChartWrapper, barScaleImgPlugin, blinkPlugin, changeSetting, chartMountPlugin, createAssignedTasksPlugin, createDefaultBarOptions, createDefaultBubbleOptions, createDefaultCartesianScales, createDefaultDoughnutOptions, createDefaultLineOptions, createDefaultPieOptions, createDefaultTreemapOptions, createStatusPlugin, createTodayLinePlugin, createWeekendPlugin, customDatasetPlugins, customLegend, T$ as default, defaultBarScales, defaultBarTooltipCallback, defaultBubbleScales, defaultBubbleTooltipCallback, defaultDoughnutTooltipCallback, defaultLineScales, defaultLineTooltipCallback, defaultPieTooltipCallback, defaultTreemapTooltipCallback, doughnutCenterTextPlugin, downloadChartAsImage, downloadChartAsImageByInstance, getChartAsBase64, getChartAsBase64ByInstance, getChartAsBlob, getChartAsBlobByInstance, getChartDatasetMeta, getChartInstance, loadingPlugin, makeCenterHtml, noDataPlugin, resetChartZoom, resizeChart, segmentImagePlugin, setChartActiveElements, setChartConfig, sparkBarOptions, sparkBubbleOptions, sparkLineOptions, updateChart, zoomRangeSlider, zoomResetPlugin };
+export type { Align, AllChartTypes, ArcChartBuilder, ArcChartType, ArcDataset, AxisColors, BarChartBuilder, BubbleChartBuilder, CartesianChartBuilder, CartesianChartType, CartesianDataset, ChartBuilder, ChartImageExportOptions, ChartTarget, ChartWithFocus, Color, CommonAxes, CommonAxesSacels, CommonCartesian, CommonCartesianAxes, CommonCartesianLegendConfig, CommonCartesianTicks, CommonCartesianTitleConfig, CommonTicks, Constructor, CustomArcChartOptions, CustomBarChartOptions, CustomBubbleChartOptions, CustomCartesianDataset, CustomChartDatasets, CustomChartOptions, CustomDoughnutChartOptions, CustomLineChartOptions, CustomOptionPlugins, CustomPieChartOptions, CustomTreemapChartOptions, CustomTreemapDataset, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, HierarchicalChartType, HtmlLegendOptions, LineChartBuilder, Mode, OriginalColors, Override, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, SegmentImageConfig, SettingOptions, StzConfig, TimeScaleConfig, TimeScaleType, TimeUnit, TreemapChartBuilder, UidImageMapping, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar };