stz-chart-maker 1.0.16 → 1.0.17

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ChartType, PluginOptionsByType, ChartOptions, GridLineOptions, FontSpec, Tick, Chart, ChartDataset, ChartTypeRegistry, Plugin as Plugin$1, TooltipItem } from 'chart.js';
+import { ChartType, PluginOptionsByType, ChartOptions, GridLineOptions, FontSpec, Tick, Chart, ChartEvent, ActiveElement, ChartDataset, Plugin as Plugin$1, TooltipItem, ChartTypeRegistry } from 'chart.js';
 import { ZoomPluginOptions } from 'chartjs-plugin-zoom/types/options';
 import { DeepPartial as DeepPartial$1 } from 'chart.js/dist/types/utils';
 
@@ -210,6 +210,12 @@ type CustomChartOptions<TType extends ChartType = ChartType> = Override<ChartOpt
             right?: number;
         };
     };
+    onResize?: (this: Chart<TType>, chart: Chart<TType>, size: {
+        width: number;
+        height: number;
+    }) => void;
+    onClick?: (this: Chart<TType>, event: ChartEvent, elements: ActiveElement[]) => void;
+    onHover?: (this: Chart<TType>, event: ChartEvent, elements: ActiveElement[]) => void;
 }> & {
     _mounted?: (chart: Chart<TType>) => void;
     _chartId?: string;
@@ -350,9 +356,11 @@ declare abstract class ChartWrapper<TType extends ChartType> implements ChartBui
     static registry: Map<string, Constructor<any, any>>;
     constructor(type: TType, labels: (string | number)[], datasets: ChartDataset<TType, (number | null)[]>[], options: CustomChartOptions<TType>, plugins?: any | undefined);
     static create<TType extends ChartType>(type: TType, labels: (string | number)[], datasets: ChartDataset<TType, (number | null)[]>[], options?: CustomChartOptions<TType>, plugins?: any): TType extends CartesianChartType ? CartesianChartBuilder<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;
     protected abstract configAop(config: any): any;
-    static register<TType extends ChartType, TInstance>(type: TType, wrapperClass: Constructor<TType, TInstance>): void;
+    abstract build(id?: string): ChartConfig;
     /**
      * 플러그인을 추가합니다.
      * @param plugin
@@ -377,7 +385,19 @@ declare abstract class ChartWrapper<TType extends ChartType> implements ChartBui
      * @param pluginId
      */
     hasPlugin(pluginId: string): boolean;
-    abstract build(id?: string): ChartConfig;
+    /**
+     *
+     * @param callback
+     * @description 차트 리사이즈 이벤트 콜백 함수를 설정합니다.
+     * @Since 1.0.0
+     * @category options
+     * @beta (기능 개발 중)
+     *
+     */
+    onResize(callback: (chart: Chart<TType>, size: {
+        width: number;
+        height: number;
+    }) => void): this;
 }
 
 interface AxisColors {
@@ -459,6 +479,15 @@ declare abstract class CartesianChartWrapper<TType extends CartesianChartType> e
     protected isBar(): boolean;
     protected normalize(): void;
     protected configAop(config: any): any;
+    /**
+     * 차트 설정 객체를 생성합니다.
+     * @param id
+     * @returns {ChartConfig}
+     * @Description 차트 설정 객체를 생성합니다. 이 메소드는 차트의 구성 요소를 종합하여 Chart.js에서 사용할 수 있는 형식으로 반환합니다.
+     * @Since 1.0.0
+     * @category Chart
+     *
+     */
     build(id?: string): ChartConfig;
     makeConfig(id?: string): {
         _chartId: any;
@@ -645,20 +674,8 @@ declare abstract class CartesianChartWrapper<TType extends CartesianChartType> e
     customLegend(obj: HtmlLegendOptions): this;
 }
 
-type AllChartTypes = keyof ChartTypeRegistry;
-declare enum ChartTypes {
-    BAR = "bar",
-    LINE = "line",
-    DOUGHNUT = "doughnut",
-    PIE = "pie",
-    RADAR = "radar",
-    BUBBLE = "bubble",
-    SCATTER = "scatter",
-    TREE = "tree"
-}
-
 declare class BarChartWrapper extends CartesianChartWrapper<'bar'> implements BarChartBuilder {
-    constructor(type: ChartTypes.BAR, labels: (string | number)[], datasets: CartesianDataset<ChartTypes.BAR>[], options?: CustomBarChartOptions, plugins?: any);
+    constructor(type: 'bar', labels: (string | number)[], datasets: CartesianDataset<'bar'>[], options?: CustomBarChartOptions, plugins?: any);
     protected requireLabels(): boolean;
     makeConfig(id?: string): {
         _chartId: any;
@@ -789,8 +806,27 @@ declare class BarChartWrapper extends CartesianChartWrapper<'bar'> implements Ba
 }
 
 declare class LineChartWrapper extends CartesianChartWrapper<'line'> implements LineChartBuilder {
-    constructor(type: ChartTypes.LINE, labels: (string | number)[], datasets: CartesianDataset<'line'>[], options?: CustomChartOptions<'line'>);
+    constructor(type: 'line', labels: (string | number)[], datasets: CartesianDataset<'line'>[], options?: CustomChartOptions<'line'>);
+    /**
+     *
+     * @protected
+     * @returns {boolean}
+     * @description 라인 차트는 카테고리형 x축일 때 라벨이 필수입니다.
+     * @Since 1.0.0
+     * @category config
+     * @override
+     */
     protected requireLabels(): boolean;
+    /**
+     *
+     * @param id
+     * @returns {ChartConfiguration}
+     * @description 차트 설정 객체를 생성합니다.
+     * @Since 1.0.0
+     * @category config
+     * @override
+     * @Deprecated use build() Method
+     */
     makeConfig(id?: string): {
         _chartId: any;
         type: any;
@@ -879,6 +915,58 @@ declare class LineChartWrapper extends CartesianChartWrapper<'line'> implements
      *
      */
     setAllPointHoverRadius(hoverRadius: number): this;
+    /**
+     *
+     * @param {number} datasetIndex - 대상 데이터셋 인덱스
+     * @param {number} steps - 그라디언트 단계 (2단계면 0,1 / 3단계면 0,0.5,1)
+     * @param {string[]} colors - 색상 배열 (steps와 같은 길이여야 함)
+     * @param {'vertical' | 'horizontal'} direction - 그라디언트 방향 (기본값: vertical)
+     * @description 지정된 데이터셋에 단계별 그라디언트를 적용합니다.
+     * @remarks step 인자는 2 이상만 지원할것입니다.
+     * @Since 1.0.0
+     * @category dataset
+     * @beta (기능 테스트 중)
+     */
+    setGradient(datasetIndex: number, steps: number, colors: string[], direction?: 'vertical' | 'horizontal'): this;
+    /**
+     *
+     * @param {number} steps - 그라디언트 단계
+     * @param {string[]} colors - 색상 배열
+     * @param {'vertical' | 'horizontal'} direction - 그라디언트 방향 (기본값: vertical)
+     * @description 모든 데이터셋에 동일한 그라디언트를 적용합니다.
+     * @Since 1.0.0
+     * @category dataset
+     * @beta (기능 테스트 중)
+     */
+    setAllGradient(steps: number, colors: string[], direction?: 'vertical' | 'horizontal'): this;
+    /**
+     *
+     * @param {number} datasetIndex - 대상 데이터셋 인덱스
+     * @description 지정된 데이터셋의 그라디언트를 제거합니다.
+     * @Since 1.0.0
+     * @category dataset
+     * @beta (기능 테스트 중)
+     */
+    removeGradient(datasetIndex: number): this;
+    /**
+     *
+     * @description 모든 데이터셋의 그라디언트를 제거합니다.
+     * @Since 1.0.0
+     * @category dataset
+     * @beta (기능 테스트 중)
+     */
+    removeAllGradients(): this;
+    /**
+     *
+     * @param {number} steps - 단계 수
+     * @returns {number[]} 0부터 1까지의 위치 배열
+     * @description 주어진 단계 수에 따라 그라디언트 위치를 계산합니다.
+     * @Since 1.0.0
+     * @category utility
+     * @private
+     * @beta (기능 테스트 중)
+     */
+    private calculateGradientPositions;
 }
 
 declare const noDataPlugin: {
@@ -1022,7 +1110,7 @@ declare namespace LocalDefaults {
 declare class ChartFactory {
     private static registry;
     static register<TType extends ChartType, TInstance>(type: TType, wrapperClass: Constructor<TType, TInstance>): void;
-    static create<TType extends ChartType>(type: TType, ...args: ConstructorParameters<Constructor<TType, any>>): any;
+    static create<TType extends ChartType>(type: TType, labels: (string | number)[], datasets: ChartDataset<TType, (number | null)[]>[], options?: CustomChartOptions<TType>, plugins?: any): any;
     static has(type: ChartType): boolean;
     static clear(): void;
 }
@@ -1039,9 +1127,20 @@ declare class ChartInstance {
     static resize(id: string): void;
 }
 
+type AllChartTypes = keyof ChartTypeRegistry;
+declare enum ChartTypes {
+    BAR = "bar",
+    LINE = "line",
+    DOUGHNUT = "doughnut",
+    PIE = "pie",
+    RADAR = "radar",
+    BUBBLE = "bubble",
+    SCATTER = "scatter",
+    TREE = "tree"
+}
+
 declare const ChartToolBox: {
     setErrorLog(enabled: boolean): void;
-    setDebugLog(enabled: boolean): void;
 };
 declare const T$: {
     readonly create: typeof ChartWrapper.create;
@@ -1054,7 +1153,6 @@ declare const T$: {
     readonly defaultsOptions: typeof LocalDefaults;
     readonly toolBox: {
         setErrorLog(enabled: boolean): void;
-        setDebugLog(enabled: boolean): void;
     };
 };