stz-chart-maker 2.4.2 → 2.4.3

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ChartTypeRegistry, ChartType, ChartDataset, DefaultDataPoint, PointStyle, GridLineOptions, FontSpec, Tick, Chart as Chart$1, ChartOptions, PluginOptionsByType, ChartEvent, ActiveElement, LegendOptions, TooltipOptions, Plugin, TooltipItem } from 'chart.js';
+import { ChartTypeRegistry, ChartType, ChartDataset, DefaultDataPoint, PointStyle, Chart as Chart$1, GridLineOptions, FontSpec, Tick, ChartOptions, PluginOptionsByType, ChartEvent, ActiveElement, LegendOptions, TooltipOptions, Plugin, TooltipItem } from 'chart.js';
 import { TreemapControllerDatasetOptions } from 'chartjs-chart-treemap';
 import { ZoomOptions, PanOptions, LimitOptions, ScaleLimits } from 'chartjs-plugin-zoom/types/options';
 
@@ -175,6 +175,46 @@ interface ScatterAxisRangePadding {
     /** Y축 여유 비율입니다. `0.1` 이면 데이터 범위의 10%를 양쪽에 추가합니다. */
     y?: number;
 }
+interface ScatterEditablePoint {
+    x: number;
+    y: number;
+}
+interface ScatterEditablePointChangeContext {
+    chart: Chart$1<'scatter'>;
+    datasetIndex: number;
+    point: ScatterEditablePoint;
+    points: ScatterEditablePoint[];
+    replacedIndex?: number;
+}
+interface ScatterEditablePointLimitContext {
+    chart: Chart$1<'scatter'>;
+    datasetIndex: number;
+    point: ScatterEditablePoint;
+    points: ScatterEditablePoint[];
+    maxPoints: number;
+}
+interface ScatterEditablePointsOptions {
+    /** 입력 포인트를 넣을 데이터셋 인덱스입니다. `datasetLabel` 보다 우선합니다. */
+    datasetIndex?: number;
+    /** 입력 포인트를 넣을 데이터셋 라벨입니다. `datasetIndex` 가 없을 때 사용합니다. */
+    datasetLabel?: string;
+    /** 최대 입력 포인트 수입니다. 미지정 시 제한하지 않습니다. */
+    maxPoints?: number;
+    /** 기존 포인트와 X축 거리가 이 값 이하면 새로 추가하지 않고 교체합니다. */
+    replaceThreshold?: number;
+    /** 클릭 좌표를 축 min/max 안으로 보정합니다. 기본값은 `true` 입니다. */
+    clamp?: boolean;
+    /** 입력값 소수점 자리수입니다. 미지정 시 반올림하지 않습니다. */
+    precision?: number;
+    /** 포인트 정렬 기준입니다. 기본값은 `x` 입니다. `false` 를 주면 정렬하지 않습니다. */
+    sortBy?: 'x' | 'y' | false;
+    /** 차트 데이터를 직접 갱신하고 `chart.update()` 를 호출할지 여부입니다. 기본값은 `true` 입니다. */
+    updateChart?: boolean;
+    /** 포인트 추가/교체 후 호출됩니다. */
+    onChange?: (context: ScatterEditablePointChangeContext) => void;
+    /** 최대 포인트 수를 초과할 때 호출됩니다. */
+    onLimitExceeded?: (context: ScatterEditablePointLimitContext) => void;
+}
 
 /**
  * ═════════════════════════════════════════════════════════════
@@ -916,6 +956,7 @@ interface ScatterChartBuilder extends CartesianChartBuilder<'scatter'> {
     addQuadrant(options?: ScatterQuadrantOptions): this;
     addTrendLine(options?: ScatterTrendLineOptions): this;
     addCrosshair(options?: ScatterCrosshairOptions): this;
+    addEditablePoints(options?: ScatterEditablePointsOptions): this;
     highlightPoints(predicate: (point: ScatterPointContext) => boolean, style?: ScatterPointHighlightStyle): this;
     setAxisRangeFromData(padding?: number | ScatterAxisRangePadding): this;
 }
@@ -1062,6 +1103,10 @@ type Types_ScatterAxisRangePadding = ScatterAxisRangePadding;
 type Types_ScatterChartBuilder = ScatterChartBuilder;
 type Types_ScatterCrosshairOptions = ScatterCrosshairOptions;
 type Types_ScatterDataset = ScatterDataset;
+type Types_ScatterEditablePoint = ScatterEditablePoint;
+type Types_ScatterEditablePointChangeContext = ScatterEditablePointChangeContext;
+type Types_ScatterEditablePointLimitContext = ScatterEditablePointLimitContext;
+type Types_ScatterEditablePointsOptions = ScatterEditablePointsOptions;
 type Types_ScatterPointContext = ScatterPointContext;
 type Types_ScatterPointHighlightStyle = ScatterPointHighlightStyle;
 type Types_ScatterQuadrantOptions = ScatterQuadrantOptions;
@@ -1082,7 +1127,7 @@ type Types_TimeUnit = TimeUnit;
 type Types_TreemapChartBuilder = TreemapChartBuilder;
 type Types_UidImageMapping = UidImageMapping;
 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_CustomScatterChartOptions as CustomScatterChartOptions, Types_CustomTreemapChartOptions as CustomTreemapChartOptions, Types_CustomTreemapDataset as CustomTreemapDataset, Types_DeepPartial as DeepPartial, Types_DeepPartialCartesianAxes as DeepPartialCartesianAxes, Types_DeepPartialPluginOptions as DeepPartialPluginOptions, Types_DoughnutChartBuilder as DoughnutChartBuilder, Types_GaugeInternalOptions as GaugeInternalOptions, Types_GaugeNeedleOptions as GaugeNeedleOptions, Types_GaugeSegment as GaugeSegment, Types_GaugeValueTextOptions as GaugeValueTextOptions, Types_HierarchicalChartType as HierarchicalChartType, 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_ScatterAxisRangePadding as ScatterAxisRangePadding, Types_ScatterChartBuilder as ScatterChartBuilder, Types_ScatterCrosshairOptions as ScatterCrosshairOptions, Types_ScatterDataset as ScatterDataset, Types_ScatterPointContext as ScatterPointContext, Types_ScatterPointHighlightStyle as ScatterPointHighlightStyle, Types_ScatterQuadrantOptions as ScatterQuadrantOptions, Types_ScatterTrendLineOptions as ScatterTrendLineOptions, Types_SegmentImageConfig as SegmentImageConfig, Types_SettingOptions as SettingOptions, Types_SpinnerOverlayConfig as SpinnerOverlayConfig, Types_SpinnerOverlayOption as SpinnerOverlayOption, Types_SpinnerOverlayRenderContext as SpinnerOverlayRenderContext, Types_SpinnerOverlaySpinnerContent as SpinnerOverlaySpinnerContent, Types_SpinnerOverlayStyle as SpinnerOverlayStyle, Types_StzClickContext as StzClickContext, Types_StzClickHandler as StzClickHandler, Types_StzClickItem as StzClickItem, Types_TimeScaleConfig as TimeScaleConfig, Types_TimeScaleType as TimeScaleType, Types_TimeUnit as TimeUnit, Types_TreemapChartBuilder as TreemapChartBuilder, Types_UidImageMapping as UidImageMapping };
+  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_CustomScatterChartOptions as CustomScatterChartOptions, Types_CustomTreemapChartOptions as CustomTreemapChartOptions, Types_CustomTreemapDataset as CustomTreemapDataset, Types_DeepPartial as DeepPartial, Types_DeepPartialCartesianAxes as DeepPartialCartesianAxes, Types_DeepPartialPluginOptions as DeepPartialPluginOptions, Types_DoughnutChartBuilder as DoughnutChartBuilder, Types_GaugeInternalOptions as GaugeInternalOptions, Types_GaugeNeedleOptions as GaugeNeedleOptions, Types_GaugeSegment as GaugeSegment, Types_GaugeValueTextOptions as GaugeValueTextOptions, Types_HierarchicalChartType as HierarchicalChartType, 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_ScatterAxisRangePadding as ScatterAxisRangePadding, Types_ScatterChartBuilder as ScatterChartBuilder, Types_ScatterCrosshairOptions as ScatterCrosshairOptions, Types_ScatterDataset as ScatterDataset, Types_ScatterEditablePoint as ScatterEditablePoint, Types_ScatterEditablePointChangeContext as ScatterEditablePointChangeContext, Types_ScatterEditablePointLimitContext as ScatterEditablePointLimitContext, Types_ScatterEditablePointsOptions as ScatterEditablePointsOptions, Types_ScatterPointContext as ScatterPointContext, Types_ScatterPointHighlightStyle as ScatterPointHighlightStyle, Types_ScatterQuadrantOptions as ScatterQuadrantOptions, Types_ScatterTrendLineOptions as ScatterTrendLineOptions, Types_SegmentImageConfig as SegmentImageConfig, Types_SettingOptions as SettingOptions, Types_SpinnerOverlayConfig as SpinnerOverlayConfig, Types_SpinnerOverlayOption as SpinnerOverlayOption, Types_SpinnerOverlayRenderContext as SpinnerOverlayRenderContext, Types_SpinnerOverlaySpinnerContent as SpinnerOverlaySpinnerContent, Types_SpinnerOverlayStyle as SpinnerOverlayStyle, Types_StzClickContext as StzClickContext, Types_StzClickHandler as StzClickHandler, Types_StzClickItem as StzClickItem, Types_TimeScaleConfig as TimeScaleConfig, Types_TimeScaleType as TimeScaleType, Types_TimeUnit as TimeUnit, Types_TreemapChartBuilder as TreemapChartBuilder, Types_UidImageMapping as UidImageMapping };
 }
 
 interface ChartConfig {
@@ -2232,6 +2277,12 @@ declare class ScatterChart extends CartesianChart<'scatter'> implements ScatterC
     private applyPointOption;
     private collectScatterPoints;
     private resolveAxisBounds;
+    private resolveEditableDatasetIndex;
+    private resolveEditablePoint;
+    private clampEditablePointValue;
+    private isEditablePoint;
+    private resolveEditablePointSeq;
+    private upsertEditablePoint;
     /**
      * @description 값에 따라 포인트 색상을 정합니다.
      * @param {(point: ScatterPointContext) => string} resolver
@@ -2313,6 +2364,24 @@ declare class ScatterChart extends CartesianChart<'scatter'> implements ScatterC
      * });
      */
     addCrosshair(options?: ScatterCrosshairOptions): this;
+    /**
+     * @description 클릭한 축 좌표를 지정 데이터셋에 포인트로 추가하거나 교체합니다.
+     * @param options
+     * @returns {this}
+     * @since 2.4.3
+     * @example
+     * chart.addEditablePoints({
+     *   datasetIndex: 1,
+     *   maxPoints: 10,
+     *   replaceThreshold: 5,
+     *   precision: 2,
+     *   onChange: ({ point, points }) => {
+     *     console.log('added point', point);
+     *     console.log('all points', points);
+     *   },
+     * });
+     */
+    addEditablePoints(options?: ScatterEditablePointsOptions): this;
     /**
      * @description 데이터 강조를 합니다.
      * @param predicate
@@ -4211,4 +4280,4 @@ 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, ScatterChart, ScatterChart as ScatterChartWrapper, T$, TreemapChart, TreemapChart as TreemapChartWrapper, barScaleImgPlugin, blinkPlugin, changeSetting, chartMountPlugin, clearChartActiveElements, createAssignedTasksPlugin, createDefaultBarOptions, createDefaultBubbleOptions, createDefaultCartesianScales, createDefaultDoughnutOptions, createDefaultLineOptions, createDefaultPieOptions, createDefaultScatterOptions, createDefaultTreemapOptions, createScatterCrosshairPlugin, createScatterQuadrantPlugin, createScatterTrendLinePlugin, createStatusPlugin, createTodayLinePlugin, createWeekendPlugin, customDatasetPlugins, customLegend, T$ as default, defaultBarScales, defaultBarTooltipCallback, defaultBubbleScales, defaultBubbleTooltipCallback, defaultDoughnutTooltipCallback, defaultLineScales, defaultLineTooltipCallback, defaultPieTooltipCallback, defaultScatterScales, defaultScatterTooltipCallback, defaultTreemapTooltipCallback, doughnutCenterTextPlugin, downloadChartAsImage, downloadChartAsImageByInstance, gaugeOverlayPlugin, getChartAsBase64, getChartAsBase64ByInstance, getChartAsBlob, getChartAsBlobByInstance, getChartDatasetMeta, getChartInstance, hideChartTooltip, isChartDatasetVisible, loadingPlugin, makeCenterHtml, mountChart, noDataPlugin, resetChartZoom, resizeChart, segmentImagePlugin, setChartActiveElements, setChartConfig, setChartDatasetVisibility, showChartTooltip, sparkBarOptions, sparkBubbleOptions, sparkLineOptions, toggleChartDatasetVisibility, updateChart, zoomRangeSlider, zoomResetPlugin };
-export type { Align, AllChartTypes, ArcChartBuilder, ArcChartType, ArcDataset, AutoZoomLimitMode, AutoZoomLimits, 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, CustomScatterChartOptions, CustomTreemapChartOptions, CustomTreemapDataset, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, GaugeInternalOptions, GaugeNeedleOptions, GaugeSegment, GaugeValueTextOptions, HierarchicalChartType, HtmlLegendOptions, LineChartBuilder, Mode, MountChartHandle, OriginalColors, Override, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, ScatterAxisRangePadding, ScatterChartBuilder, ScatterCrosshairOptions, ScatterDataset, ScatterPointContext, ScatterPointHighlightStyle, ScatterQuadrantOptions, ScatterTrendLineOptions, SegmentImageConfig, SettingOptions, SpinnerOverlayConfig, SpinnerOverlayOption, SpinnerOverlayRenderContext, SpinnerOverlaySpinnerContent, SpinnerOverlayStyle, StzClickContext, StzClickHandler, StzClickItem, StzConfig, TimeScaleConfig, TimeScaleType, TimeUnit, TreemapChartBuilder, UidImageMapping, ZoomLimitOptions, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar, ZoomScaleLimits };
+export type { Align, AllChartTypes, ArcChartBuilder, ArcChartType, ArcDataset, AutoZoomLimitMode, AutoZoomLimits, 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, CustomScatterChartOptions, CustomTreemapChartOptions, CustomTreemapDataset, CustomZoomType, DataLabels, DataLabelsContext, DatasetWithPrevColors, DeepPartial, DeepPartialCartesianAxes, DeepPartialPluginOptions, DeepPartialZoomType, DoughnutChartBuilder, FocusCallback, GaugeInternalOptions, GaugeNeedleOptions, GaugeSegment, GaugeValueTextOptions, HierarchicalChartType, HtmlLegendOptions, LineChartBuilder, Mode, MountChartHandle, OriginalColors, Override, PartialDataLabels, PieChartBuilder, Position, RadarChartBuilder, RadialChartType, ScaleWithOriginalColors, ScatterAxisRangePadding, ScatterChartBuilder, ScatterCrosshairOptions, ScatterDataset, ScatterEditablePoint, ScatterEditablePointChangeContext, ScatterEditablePointLimitContext, ScatterEditablePointsOptions, ScatterPointContext, ScatterPointHighlightStyle, ScatterQuadrantOptions, ScatterTrendLineOptions, SegmentImageConfig, SettingOptions, SpinnerOverlayConfig, SpinnerOverlayOption, SpinnerOverlayRenderContext, SpinnerOverlaySpinnerContent, SpinnerOverlayStyle, StzClickContext, StzClickHandler, StzClickItem, StzConfig, TimeScaleConfig, TimeScaleType, TimeUnit, TreemapChartBuilder, UidImageMapping, ZoomLimitOptions, ZoomRangeSliderColors, ZoomRangeSliderPlugin, ZoomRangeSliderVar, ZoomScaleLimits };