stz-chart-maker 1.5.0 → 1.5.2

package/dist/index.d.ts

@@ -43,6 +43,7 @@ type Override<T, U> = Omit<T, keyof U> & U;
  */
 
 interface DatasetExtensions {
+    label?: string;
     _aux?: any;
     _uid?: string;
     _group?: string | number;
@@ -253,6 +254,13 @@ type PartialDataLabels = Partial<DataLabels>;
  * ═════════════════════════════════════════════════════════════
  */
 
+interface SegmentImageConfig {
+    images: string[];
+    width?: number;
+    height?: number;
+    backgroundColor?: string;
+    borderRadius?: number;
+}
 interface SettingOptions {
     img: string;
     iconSize: {
@@ -548,9 +556,10 @@ type Types_PieChartBuilder = PieChartBuilder;
 type Types_Position = Position;
 type Types_RadarChartBuilder = RadarChartBuilder;
 type Types_RadialChartType = RadialChartType;
+type Types_SegmentImageConfig = SegmentImageConfig;
 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_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_Override as Override, 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_Override as Override, Types_PieChartBuilder as PieChartBuilder, Types_Position as Position, Types_RadarChartBuilder as RadarChartBuilder, Types_RadialChartType as RadialChartType, Types_SegmentImageConfig as SegmentImageConfig, Types_SettingOptions as SettingOptions };
 }
 
 interface ChartConfig {
@@ -1658,6 +1667,28 @@ declare abstract class ArcChartWrapper<TType extends ArcChartType> extends Chart
      * @beta
      */
     setAllBorderColor(borderColor: string | string[]): this;
+    /**
+     * @description 각 세그먼트에 이미지를 설정합니다.
+     * @param images - 이미지 URL 배열 (URL, Base64, SVG, Emoji 등)
+     * @param config - 이미지 설정 옵션
+     * @returns {this}
+     * @since 1.6.0
+     * @category Dataset
+     * @beta
+     * @example
+     * // URL 방식
+     * chart.setSegmentImages([
+     *   'https://example.com/icon1.png',
+     *   'https://example.com/icon2.png'
+     * ]);
+     *
+     * // 크기 조절
+     * chart.setSegmentImages(
+     *   ['image1.png', 'image2.png'],
+     *   { width: 40, height: 40, backgroundColor: 'transparent' }
+     * );
+     */
+    setSegmentImages(images: string[], config?: Partial<Omit<SegmentImageConfig, 'images'>>): this;
 }
 
 declare class DoughnutChartWrapper extends ArcChartWrapper<'doughnut'> implements DoughnutChartBuilder {
@@ -1972,18 +2003,6 @@ declare const zoomResetPlugin: {
     afterDraw(chart: any, args: any, options: any): void;
     afterEvent(chart: any, args: any): void;
 };
-declare function doughnutCenterTextPlugin(config: {
-    text: string | string[];
-    color?: string;
-    fontStyle?: string;
-    fontSize?: string;
-}): {
-    id: string;
-    afterInit(chart: Chart): void;
-    afterUpdate(chart: Chart): void;
-    updatePosition(chart: Chart): void;
-    destroy(chart: Chart): void;
-};
 declare const loadingPlugin: {
     id: string;
     beforeInit(chart: any, args: any, options: any): void;
@@ -2144,6 +2163,23 @@ declare const zoomRangeSlider: {
 };
 declare const CreateZoomRangeSlider: (colors?: ZoomRangeSliderColors) => ZoomRangeSliderPlugin;
 
+declare function doughnutCenterTextPlugin(config: {
+    text: string | string[];
+    color?: string;
+    fontStyle?: string;
+    fontSize?: string;
+}): {
+    id: string;
+    afterInit(chart: Chart): void;
+    afterUpdate(chart: Chart): void;
+    updatePosition(chart: Chart): void;
+    destroy(chart: Chart): void;
+};
+declare function segmentImagePlugin(config: SegmentImageConfig): {
+    id: string;
+    afterDatasetDraw(chart: Chart<"doughnut" | "pie">, args: any): void;
+};
+
 declare const defaultBarTooltipCallback: (context: TooltipItem<"bar">) => string;
 declare const defaultBarScales: CommonAxesSacels;
 declare const createDefaultBarOptions: (userOptions?: CustomBarChartOptions, defaultScales?: CommonAxesSacels) => CustomBarChartOptions;
@@ -2178,6 +2214,7 @@ declare const LocalDefaults_doughnutCenterTextPlugin: typeof doughnutCenterTextP
 declare const LocalDefaults_loadingPlugin: typeof loadingPlugin;
 declare const LocalDefaults_makeCenterHtml: typeof makeCenterHtml;
 declare const LocalDefaults_noDataPlugin: typeof noDataPlugin;
+declare const LocalDefaults_segmentImagePlugin: typeof segmentImagePlugin;
 declare const LocalDefaults_sparkBarOptions: typeof sparkBarOptions;
 declare const LocalDefaults_sparkBubbleOptions: typeof sparkBubbleOptions;
 declare const LocalDefaults_sparkLineOptions: typeof sparkLineOptions;
@@ -2204,6 +2241,7 @@ declare namespace LocalDefaults {
     LocalDefaults_loadingPlugin as loadingPlugin,
     LocalDefaults_makeCenterHtml as makeCenterHtml,
     LocalDefaults_noDataPlugin as noDataPlugin,
+    LocalDefaults_segmentImagePlugin as segmentImagePlugin,
     LocalDefaults_sparkBarOptions as sparkBarOptions,
     LocalDefaults_sparkBubbleOptions as sparkBubbleOptions,
     LocalDefaults_sparkLineOptions as sparkLineOptions,
@@ -2240,8 +2278,7 @@ declare enum ChartTypes {
     PIE = "pie",
     RADAR = "radar",
     BUBBLE = "bubble",
-    SCATTER = "scatter",
-    TREE = "tree"
+    SCATTER = "scatter"
 }
 
 interface StzConfig {
@@ -2281,6 +2318,66 @@ interface StzConfig {
  */
 declare function setChartConfig(config: StzConfig): void;
 
+interface ChartImageExportOptions {
+    format?: 'png' | 'jpeg' | 'webp';
+    quality?: number;
+    backgroundColor?: string;
+    filename?: string;
+    scale?: number;
+}
+/**
+ * @description 차트를 이미지로 다운로드합니다.
+ * @param chartId 차트 ID
+ * @param options 이미지 내보내기 옵션
+ * @since 1.5.0
+ * @category util
+ */
+declare function downloadChartAsImage(chartId: string, options?: ChartImageExportOptions): void;
+/**
+ * @description Chart 인스턴스를 이미지로 다운로드합니다.
+ * @param chart Chart 인스턴스
+ * @param options 이미지 내보내기 옵션
+ * @since 1.5.0
+ * @category util
+ */
+declare function downloadChartAsImageByInstance(chart: Chart, options?: ChartImageExportOptions): void;
+/**
+ * @description 차트를 Base64 문자열로 반환합니다.
+ * @param chartId 차트 ID
+ * @param options 이미지 내보내기 옵션
+ * @returns Base64 인코딩된 이미지 데이터 URL
+ * @since 1.5.0
+ * @category util
+ */
+declare function getChartAsBase64(chartId: string, options?: Omit<ChartImageExportOptions, 'filename'>): string;
+/**
+ * @description Chart 인스턴스를 Base64 문자열로 반환합니다.
+ * @param chart Chart 인스턴스
+ * @param options 이미지 내보내기 옵션
+ * @returns Base64 인코딩된 이미지 데이터 URL
+ * @since 1.5.0
+ * @category util
+ */
+declare function getChartAsBase64ByInstance(chart: Chart, options?: Omit<ChartImageExportOptions, 'filename'>): string;
+/**
+ * @description 차트를 Blob 객체로 반환합니다.
+ * @param chartId 차트 ID
+ * @param options 이미지 내보내기 옵션
+ * @returns Promise<Blob> 이미지 Blob
+ * @since 1.5.0
+ * @category util
+ */
+declare function getChartAsBlob(chartId: string, options?: Omit<ChartImageExportOptions, 'filename'>): Promise<Blob>;
+/**
+ * @description Chart 인스턴스를 Blob 객체로 반환합니다.
+ * @param chart Chart 인스턴스
+ * @param options 이미지 내보내기 옵션
+ * @returns Promise<Blob> 이미지 Blob
+ * @since 1.5.0
+ * @category util
+ */
+declare function getChartAsBlobByInstance(chart: Chart, options?: Omit<ChartImageExportOptions, 'filename'>): Promise<Blob>;
+
 declare const ChartToolBox: {
     setErrorLog(enabled?: boolean): void;
     setErrorShield(enabled?: boolean): void;
@@ -2304,5 +2401,5 @@ declare const T$: {
     };
 };
 
-export { ArcChartWrapper, BarChartWrapper, BubbleChartWrapper, CartesianChartWrapper, ChartFactory, ChartInstance, ChartToolBox, ChartTypes, ChartWrapper, CreateZoomRangeSlider, DoughnutChartWrapper, LineChartWrapper, PieChartWrapper, T$, barScaleImgPlugin, blinkPlugin, changeSetting, chartMountPlugin, createDefaultBarOptions, createDefaultBubbleOptions, createDefaultLineOptions, customLegend, T$ as default, defaultBarScales, defaultBarTooltipCallback, defaultBubbleScales, defaultBubbleTooltipCallback, defaultLineScales, defaultLineTooltipCallback, doughnutCenterTextPlugin, loadingPlugin, makeCenterHtml, noDataPlugin, setChartConfig, 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, CustomChartDatasets, CustomChartOptions, CustomDoughnutChartOptions, CustomLineChartOptions, CustomOptionPlugins, CustomPieChartOptions, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, HtmlLegendOptions, LineChartBuilder, Mode, OriginalColors, Override, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, SettingOptions, StzConfig, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar };
+export { ArcChartWrapper, BarChartWrapper, BubbleChartWrapper, CartesianChartWrapper, ChartFactory, ChartInstance, ChartToolBox, ChartTypes, ChartWrapper, CreateZoomRangeSlider, DoughnutChartWrapper, LineChartWrapper, PieChartWrapper, T$, barScaleImgPlugin, blinkPlugin, changeSetting, chartMountPlugin, createDefaultBarOptions, createDefaultBubbleOptions, createDefaultLineOptions, customLegend, T$ as default, defaultBarScales, defaultBarTooltipCallback, defaultBubbleScales, defaultBubbleTooltipCallback, defaultLineScales, defaultLineTooltipCallback, 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, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, HtmlLegendOptions, LineChartBuilder, Mode, OriginalColors, Override, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, SegmentImageConfig, SettingOptions, StzConfig, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar };