stz-chart-maker 1.4.5 → 1.5.1

package/dist/index.d.ts

@@ -462,6 +462,17 @@ interface ArcChartBuilder<TType extends ArcChartType> extends ChartBuilder<TType
     setAllBorderColor(borderColor: string | string[]): this;
 }
 interface PieChartBuilder extends ArcChartBuilder<'pie'> {
+    setSegmentColors(colors: string[]): this;
+    setSegmentOffset(dataIndex: number, offset: number): this;
+    setHalfPieTop(): this;
+    setHalfPieBottom(): this;
+    setHalfPieLeft(): this;
+    setHalfPieRight(): this;
+    highlightMaxSegment(offset?: number): this;
+    highlightMinSegment(offset?: number): this;
+    setAllSegmentOffsets(offsets: number[] | number): this;
+    setGradientColors(startColor: string, endColor: string): this;
+    setSegmentColorWhere(filterFn: (value: number, index: number) => boolean, color: string): this;
 }
 interface DoughnutChartBuilder extends ArcChartBuilder<'doughnut'> {
     convertToPie(): this;
@@ -1769,6 +1780,187 @@ declare class DoughnutChartWrapper extends ArcChartWrapper<'doughnut'> implement
     }): this;
 }
 
+declare class PieChartWrapper extends ArcChartWrapper<'pie'> implements PieChartBuilder {
+    constructor(type: 'pie', labels: (string | number)[], datasets: ChartDataset<'pie', (number | null)[]>[], options?: CustomPieChartOptions, plugins?: any);
+    protected requireLabels(): boolean;
+    /**
+     * @description 레거시 지원용 차트 설정 객체를 생성합니다.
+     * @param {string} id
+     * @returns {ChartConfig}
+     * @Since 1.0.0
+     * @category config
+     * @beta
+     */
+    makeConfig(id?: string): ChartConfig;
+    /**
+     * @description 모든 세그먼트의 색상을 설정합니다.
+     * @param colors - 색상 배열
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     */
+    setSegmentColors(colors: string[]): this;
+    /**
+     * @description 특정 세그먼트만 분리해서 표시합니다.
+     * @param dataIndex - 분리할 데이터 인덱스
+     * @param offset - 분리 거리 (픽셀)
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     */
+    setSegmentOffset(dataIndex: number, offset: number): this;
+    /**
+     * @description 차트의 시작 각도를 설정합니다.
+     * @param rotation - 회전 각도 (도 단위)
+     * @returns {this}
+     * @since 1.0.0
+     * @category Options
+     * @beta
+     */
+    setRotation(rotation: number): this;
+    /**
+     * @description 차트의 원주각을 설정합니다.
+     * @param circumference - 원주각 (도 단위, 360 = 완전한 원)
+     * @returns {this}
+     * @since 1.0.0
+     * @category Options
+     * @beta
+     */
+    setCircumference(circumference: number): this;
+    /**
+     * @description 차트의 반지름을 설정합니다.
+     * @param radius - 반지름 ('90%', '100%' 또는 픽셀값)
+     * @returns {this}
+     * @since 1.0.0
+     * @category Options
+     * @beta
+     */
+    setRadius(radius: string | number): this;
+    /**
+     * @description 모든 데이터셋의 경계선 너비를 설정합니다.
+     * @param borderWidth - 경계선 너비
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     */
+    setAllBorderWidth(borderWidth: number): this;
+    /**
+     * @description 모든 데이터셋의 경계선 색상을 설정합니다.
+     * @param borderColor - 경계선 색상
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     */
+    setAllBorderColor(borderColor: string | string[]): this;
+    /**
+     * @description 상단 반원형 파이 차트를 생성합니다.
+     * @returns {this}
+     * @since 1.0.0
+     * @category Options
+     * @beta
+     */
+    setHalfPieTop(): this;
+    /**
+     * @description 하단 반원형 파이 차트를 생성합니다.
+     * @returns {this}
+     * @since 1.0.0
+     * @category Options
+     * @beta
+     */
+    setHalfPieBottom(): this;
+    /**
+     * @description 좌측 반원형 파이 차트를 생성합니다.
+     * @returns {this}
+     * @since 1.0.0
+     * @category Options
+     * @beta
+     */
+    setHalfPieLeft(): this;
+    /**
+     * @description 우측 반원형 파이 차트를 생성합니다.
+     * @returns {this}
+     * @since 1.0.0
+     * @category Options
+     * @beta
+     */
+    setHalfPieRight(): this;
+    /**
+     * @description 가장 큰 값을 가진 세그먼트를 자동으로 분리합니다.
+     * @param offset - 분리 거리 (픽셀, 기본값: 10)
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     */
+    highlightMaxSegment(offset?: number): this;
+    /**
+     * @description 가장 작은 값을 가진 세그먼트를 자동으로 분리합니다.
+     * @param offset - 분리 거리 (픽셀, 기본값: 10)
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     */
+    highlightMinSegment(offset?: number): this;
+    /**
+     * @description 여러 세그먼트를 한번에 분리합니다.
+     * @param offsets - 각 세그먼트의 offset 배열 또는 모든 세그먼트에 적용할 단일 값
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     * @example
+     * // 각 세그먼트마다 다른 offset
+     * chart.setAllSegmentOffsets([10, 0, 5, 0]);
+     *
+     * // 모든 세그먼트에 동일한 offset (exploded pie chart)
+     * chart.setAllSegmentOffsets(10);
+     */
+    setAllSegmentOffsets(offsets: number[] | number): this;
+    /**
+     * @description 그라데이션 색상 팔레트를 자동으로 생성합니다.
+     * @param startColor - 시작 색상 (hex 형식, 예: '#FF6384')
+     * @param endColor - 종료 색상 (hex 형식, 예: '#36A2EB')
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     */
+    setGradientColors(startColor: string, endColor: string): this;
+    /**
+     * @description 특정 조건을 만족하는 세그먼트만 색상을 변경합니다.
+     * @param filterFn - 조건 함수
+     * @param color - 적용할 색상
+     * @returns {this}
+     * @since 1.0.0
+     * @category Dataset
+     * @beta
+     * @example
+     * // 값이 100 이상인 세그먼트만 빨간색으로
+     * chart.setSegmentColorWhere((value) => value >= 100, '#FF0000');
+     */
+    setSegmentColorWhere(filterFn: (value: number, index: number) => boolean, color: string): this;
+    /**
+     * @description hex 색상을 RGB로 변환합니다.
+     * @private
+     */
+    private hexToRgb;
+    /**
+     * @description RGB를 hex 색상으로 변환합니다.
+     * @private
+     */
+    private rgbToHex;
+    /**
+     * @description 그라데이션 색상 배열을 생성합니다.
+     * @private
+     */
+    private generateGradientColors;
+}
+
 declare const noDataPlugin: {
     id: string;
     beforeUpdate: (chart: any) => void;
@@ -2052,6 +2244,103 @@ declare enum ChartTypes {
     TREE = "tree"
 }
 
+interface StzConfig {
+    errorLogging?: boolean;
+    silentMode?: boolean;
+    defaultColor?: string[];
+    autoRegister?: boolean;
+    registerTypes?: ChartType[];
+}
+/**
+ * @description 브라우저 환경이나 Vite/Webpack 환경에서 직접 설정을 전달합니다.
+ * @param config 설정 객체
+ * @example
+ * ```typescript
+ * // React 앱의 main.tsx에서 호출
+ * import { setChartConfig } from 'stz-chart-maker';
+ *
+ * setChartConfig({
+ *   errorLogging: true,
+ *   silentMode: false,
+ *   autoRegister: true,
+ *   registerTypes: ['line', 'bar']
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Vite 플러그인과 함께 사용
+ * import { setChartConfig } from 'stz-chart-maker';
+ * import config from 'virtual:stz-config'; // Vite 플러그인이 주입
+ *
+ * if (config) {
+ *   setChartConfig(config);
+ * }
+ * ```
+ * @since 1.4.5
+ */
+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;
@@ -2066,6 +2355,7 @@ declare const T$: {
     readonly BubbleChartWrapper: typeof BubbleChartWrapper;
     readonly ArcChartWrapper: typeof ArcChartWrapper;
     readonly DoughnutChartWrapper: typeof DoughnutChartWrapper;
+    readonly PieChartWrapper: typeof PieChartWrapper;
     readonly defaultTypes: typeof Types;
     readonly defaultsOptions: typeof LocalDefaults;
     readonly toolBox: {
@@ -2074,5 +2364,5 @@ declare const T$: {
     };
 };
 
-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, 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, 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, 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, SettingOptions, StzConfig, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar };