@techie_doubts/tui.chart.2026 4.6.1

package/dist/esm/charts/lineScatterChart.js

@@ -0,0 +1,285 @@
+import Chart from "./chart";
+import dataRange from "../store/dataRange";
+import scale from "../store/scale";
+import axes from "../store/axes";
+import plot from "../store/plot";
+import Tooltip from "../component/tooltip";
+import Plot from "../component/plot";
+import LineSeries from "../component/lineSeries";
+import ScatterSeries from "../component/scatterSeries";
+import Axis from "../component/axis";
+import Legend from "../component/legend";
+import DataLabels from "../component/dataLabels";
+import AxisTitle from "../component/axisTitle";
+import Title from "../component/title";
+import ExportMenu from "../component/exportMenu";
+import SelectedSeries from "../component/selectedSeries";
+import HoveredSeries from "../component/hoveredSeries";
+import RangeSelection from "../component/rangeSelection";
+import Background from "../component/background";
+import NoDataText from "../component/noDataText";
+import * as lineSeriesBrush from "../brushes/lineSeries";
+import * as basicBrush from "../brushes/basic";
+import * as axisBrush from "../brushes/axis";
+import * as legendBrush from "../brushes/legend";
+import * as labelBrush from "../brushes/label";
+import * as exportMenuBrush from "../brushes/exportMenu";
+import * as dataLabelBrush from "../brushes/dataLabel";
+import * as resetButtonBrush from "../brushes/resetButton";
+import * as scatterSeriesBrush from "../brushes/scatterSeries";
+/**
+ * @class
+ * @classdesc LineScatter Chart
+ * @param {Object} props
+ *   @param {HTMLElement} props.el - The target element to create chart.
+ *   @param {Object} props.data - Data for making LineArea Chart.
+ *     @param {Array<Object>} props.data.series - Series data.
+ *       @param {Array<Object>} props.data.series.line - Line series data. Only coordinate type data is possible.
+ *       @param {Array<Object>} props.data.series.scatter - Scatter series data.
+ *   @param {Object} [props.options] - Options for making LineScatter Chart.
+ *     @param {Object} [props.options.chart]
+ *       @param {string|Object} [props.options.chart.title] - Chart title text or options.
+ *         @param {string} [props.options.chart.title.text] - Chart title text.
+ *         @param {number} [props.options.chart.title.offsetX] - Offset value to move title horizontally.
+ *         @param {number} [props.options.chart.title.offsetY] - Offset value to move title vertically.
+ *         @param {string} [props.options.chart.title.align] - Chart text align. 'left', 'right', 'center' is available.
+ *       @param {boolean|Object} [props.options.chart.animation] - Whether to use animation and duration when rendering the initial chart.
+ *       @param {number|string} [props.options.chart.width] - Chart width. 'auto' or if not write, the width of the parent container is followed. 'auto' or if not created, the width of the parent container is followed.
+ *       @param {number|string} [props.options.chart.height] - Chart height. 'auto' or if not write, the width of the parent container is followed. 'auto' or if not created, the height of the parent container is followed.
+ *     @param {Object} [props.options.series] - Write common options in the upper depth and separate options to be applied to each chart.
+ *       @param {Object} [props.options.series.line] - Options to be applied to the line chart. 'spline', 'showDot' is available. For specific information, refer to the {@link https://github.com/nhn/tui.chart|Line Chart guide} on github.
+ *       @param {boolean} [props.options.series.selectable=false] - Whether to make selectable series or not.
+ *       @param {Object} [props.options.series.dataLabels] - Set the visibility, location, and formatting of dataLabel. For specific information, refer to the {@link https://github.com/nhn/tui.chart|DataLabels guide} on github.
+ *     @param {Object} [props.options.xAxis]
+ *       @param {string|Object} [props.options.xAxis.title] - Axis title.
+ *       @param {boolean} [props.options.xAxis.pointOnColumn=false] - Whether to move the start of the chart to the center of the column.
+ *       @param {boolean} [props.options.xAxis.rotateLabel=true] - Whether to allow axis label rotation.
+ *       @param {boolean|Object} [props.options.xAxis.date] - Whether the x axis label is of date type. Format option used for date type. Whether the x axis label is of date type. If use date type, format option used for date type.
+ *       @param {Object} [props.options.xAxis.tick] - Option to adjust tick interval.
+ *       @param {Object} [props.options.xAxis.label] - Option to adjust label interval.
+ *       @param {Object} [props.options.xAxis.scale] - Option to adjust axis minimum, maximum, step size.
+ *       @param {number} [props.options.xAxis.width] - Width of xAxis.
+ *       @param {number} [props.options.xAxis.height] - Height of xAxis.
+ *     @param {Object|Array<Object>} [props.options.yAxis] - If this option is an array type, use the secondary y axis.
+ *       @param {string|Object} [props.options.yAxis.title] - Axis title.
+ *       @param {Object} [props.options.yAxis.tick] - Option to adjust tick interval.
+ *       @param {Object} [props.options.yAxis.label] - Option to adjust label interval.
+ *       @param {Object} [props.options.yAxis.scale] - Option to adjust axis minimum, maximum, step size.
+ *       @param {number} [props.options.yAxis.width] - Width of yAxis.
+ *       @param {number} [props.options.yAxis.height] - Height of yAxis.
+ *     @param {Object} [props.options.plot]
+ *       @param {number} [props.options.plot.width] - Width of plot.
+ *       @param {number} [props.options.plot.height] - Height of plot.
+ *       @param {boolean} [props.options.plot.visible] - Whether to show plot line.
+ *     @param {Object} [props.options.legend]
+ *       @param {string} [props.options.legend.align] - Legend align. 'top', 'bottom', 'right', 'left' is available.
+ *       @param {string} [props.options.legend.showCheckbox] - Whether to show checkbox.
+ *       @param {boolean} [props.options.legend.visible] - Whether to show legend.
+ *       @param {number} [props.options.legend.width] - Width of legend.
+ *       @param {Object} [props.options.legend.item] - `width` and `overflow` options of the legend item. For specific information, refer to the {@link https://github.com/nhn/tui.chart|Legend guide} on github.
+ *     @param {Object} [props.options.exportMenu]
+ *       @param {boolean} [props.options.exportMenu.visible] - Whether to show export menu.
+ *       @param {string} [props.options.exportMenu.filename] - File name applied when downloading.
+ *     @param {Object} [props.options.tooltip]
+ *       @param {number} [props.options.tooltip.offsetX] - Offset value to move title horizontally.
+ *       @param {number} [props.options.tooltip.offsetY] - Offset value to move title vertically.
+ *       @param {Function} [props.options.tooltip.formatter] - Function to format data value.
+ *       @param {Function} [props.options.tooltip.template] - Function to create custom template. For specific information, refer to the {@link https://github.com/nhn/tui.chart|Tooltip guide} on github.
+ *     @param {Object} [props.options.responsive] - Rules for changing chart options. For specific information, refer to the {@link https://github.com/nhn/tui.chart|Responsive guide} on github.
+ *       @param {boolean|Object} [props.options.responsive.animation] - Animation duration when the chart is modified.
+ *       @param {Array<Object>} [props.options.responsive.rules] - Rules for the Chart to Respond.
+ *     @param {Object} [props.options.lang] - Options for changing the text displayed on the chart or i18n languages.
+ *       @param {Object} [props.options.lang.noData] - No Data Layer Text.
+ *     @param {Object} [props.options.theme] - Chart theme options. For specific information, refer to the {@link https://github.com/nhn/tui.chart|LineScatter Chart guide} on github.
+ *       @param {Object} [props.options.theme.chart] - Chart font theme.
+ *       @param {Object} [props.options.theme.noData] - No Data Layer Text theme.
+ *       @param {Object} [props.options.theme.series] - Series theme. Each theme to be applied to the two charts should be written separately.
+ *       @param {Object} [props.options.theme.title] - Title theme.
+ *       @param {Object} [props.options.theme.xAxis] - X Axis theme.
+ *       @param {Object|Array<Object>} [props.options.theme.yAxis] - Y Axis theme. In the case of an arrangement, the first is the main axis and the second is the theme for the secondary axis.
+ *       @param {Object} [props.options.theme.legend] - Legend theme.
+ *       @param {Object} [props.options.theme.tooltip] - Tooltip theme.
+ *       @param {Object} [props.options.theme.plot] - Plot theme.
+ *       @param {Object} [props.options.theme.exportMenu] - ExportMenu theme.
+ * @extends Chart
+ */
+export default class LineScatterChart extends Chart {
+    constructor(props) {
+        super({
+            el: props.el,
+            options: props.options,
+            series: props.data.series,
+            modules: [dataRange, scale, axes, plot],
+        });
+    }
+    initialize() {
+        super.initialize();
+        this.componentManager.add(Background);
+        this.componentManager.add(Title);
+        this.componentManager.add(Plot);
+        this.componentManager.add(Legend);
+        this.componentManager.add(LineSeries);
+        this.componentManager.add(ScatterSeries);
+        this.componentManager.add(Axis, { name: 'yAxis' });
+        this.componentManager.add(Axis, { name: 'xAxis' });
+        this.componentManager.add(Axis, { name: 'secondaryYAxis' });
+        this.componentManager.add(DataLabels);
+        this.componentManager.add(AxisTitle, { name: 'xAxis' });
+        this.componentManager.add(AxisTitle, { name: 'yAxis' });
+        this.componentManager.add(AxisTitle, { name: 'secondaryYAxis' });
+        this.componentManager.add(ExportMenu, { chartEl: this.el });
+        this.componentManager.add(HoveredSeries);
+        this.componentManager.add(SelectedSeries);
+        this.componentManager.add(Tooltip, { chartEl: this.el });
+        this.componentManager.add(RangeSelection);
+        this.componentManager.add(NoDataText);
+        this.painter.addGroups([
+            basicBrush,
+            axisBrush,
+            lineSeriesBrush,
+            legendBrush,
+            labelBrush,
+            exportMenuBrush,
+            dataLabelBrush,
+            resetButtonBrush,
+            scatterSeriesBrush,
+        ]);
+    }
+    /**
+     * Add data.
+     * @param {Array} data - Array of data to be added.
+     * @param {string} chartType - Which type of chart to add.
+     * @api
+     * @example
+     * chart.addData([{x: 10, y: 20}, {x: 30, y: 40}], 'line');
+     */
+    addData(data, chartType) {
+        this.animationControlFlag.updating = true;
+        this.resetSeries();
+        this.store.dispatch('addData', { data, chartType });
+    }
+    /**
+     * Add series.
+     * @param {Object} data - Data to be added.
+     *   @param {string} data.name - Series name.
+     *   @param {Array<Object>} data.data - Array of data to be added.
+     * @param {Object} dataInfo - Which type of chart to add.
+     *   @param {Object} dataInfo.chartType - Chart type.
+     * @api
+     * @example
+     * chart.addSeries(
+     *   {
+     *     name: 'newSeries',
+     *     data: [{x: 10, y: 20}, {x: 30, y: 40}],
+     *   },
+     *   {
+     *     chartType: 'line'
+     *   });
+     */
+    addSeries(data, dataInfo) {
+        this.resetSeries();
+        this.store.dispatch('addSeries', Object.assign({ data }, dataInfo));
+    }
+    /**
+     * Convert the chart data to new data.
+     * @param {Object} data - Data to be set
+     * @api
+     * @example
+     * chart.setData({
+     *   series: {
+     *     line: [
+     *       {
+     *         name: 'A',
+     *         data: [{x: 10, y: 20}, {x: 30, y: 40}],
+     *       }
+     *     ],
+     *     scatter: [
+     *       {
+     *         name: 'B',
+     *         data: [{x: 30, y: 20}, {x: 40, y: 40}],
+     *       }
+     *     ]
+     *   }
+     * });
+     */
+    setData(data) {
+        this.resetSeries();
+        this.store.dispatch('setData', data);
+    }
+    /**
+     * Convert the chart options to new options.
+     * @param {Object} options - Chart options
+     * @api
+     * @example
+     * chart.setOptions({
+     *   chart: {
+     *     width: 500,
+     *     height: 'auto',
+     *     title: 'Energy Usage',
+     *   },
+     *   xAxis: {
+     *     title: 'Month',
+     *     date: { format: 'yy/MM' },
+     *   },
+     *   yAxis: {
+     *     title: 'Energy (kWh)',
+     *   },
+     *   series: {
+     *     line: {
+     *       showDot: true,
+     *     },
+     *     selectable: true,
+     *   },
+     *   tooltip: {
+     *     formatter: (value) => `${value}kWh`,
+     *   },
+     * });
+     */
+    setOptions(options) {
+        this.resetSeries();
+        this.dispatchOptionsEvent('initOptions', options);
+    }
+    /**
+     * Update chart options.
+     * @param {Object} options - Chart options
+     * @api
+     * @example
+     * chart.updateOptions({
+     *   chart: {
+     *     height: 'auto',
+     *     title: 'Energy Usage',
+     *   },
+     *   series: {
+     *     line: {
+     *       showDot: true,
+     *     },
+     *   },
+     * });
+     */
+    updateOptions(options) {
+        this.resetSeries();
+        this.dispatchOptionsEvent('updateOptions', options);
+    }
+    /**
+     * Show tooltip.
+     * @param {Object} seriesInfo - Information of the series for the tooltip to be displayed
+     *      @param {number} seriesInfo.seriesIndex - Index of series
+     *      @param {number} seriesInfo.index - Index of data within series
+     *      @param {string} seriesInfo.chartType - Specify which chart to select.
+     * @api
+     * @example
+     * chart.showTooltip({index: 1, seriesIndex: 2, chartType: 'scatter'});
+     */
+    showTooltip(seriesInfo) {
+        this.eventBus.emit('showTooltip', Object.assign(Object.assign({}, seriesInfo), { state: this.store.state }));
+    }
+    /**
+     * Hide tooltip.
+     * @api
+     * @example
+     * chart.hideTooltip();
+     */
+    hideTooltip() {
+        this.eventBus.emit('hideTooltip');
+    }
+}

package/dist/esm/charts/nestedPieChart.d.ts

@@ -0,0 +1,192 @@
+import Chart from "./chart";
+import { NestedPieChartOptions, NestedPieSeriesData, NestedPieSeriesType } from "../../types/options";
+import { NestedPieChartProps, AddSeriesDataInfo, SelectSeriesInfo } from "../../types/charts";
+/**
+ * @class
+ * @classdesc NestedPie Chart
+ * @param {Object} props
+ *   @param {HTMLElement} props.el - The target element to create chart.
+ *   @param {Object} props.data - Data for making NestedPie Chart.
+ *     @param {Array<string>} [props.data.categories] - Categories.
+ *     @param {Array<Object>} props.data.series - Series data.
+ *       @param {string} props.data.series.name - Series name.
+ *       @param {number} props.data.series.data - Series data.
+ *       @param {string} [props.data.series.parentName] - Value specifying parent data when using group nested pie chart.
+ *   @param {Object} [props.options] - Options for making NestedPie Chart.
+ *     @param {Object} [props.options.chart]
+ *       @param {string|Object} [props.options.chart.title] - Chart title text or options.
+ *         @param {string} [props.options.chart.title.text] - Chart title text.
+ *         @param {number} [props.options.chart.title.offsetX] - Offset value to move title horizontally.
+ *         @param {number} [props.options.chart.title.offsetY] - Offset value to move title vertically.
+ *         @param {string} [props.options.chart.title.align] - Chart text align. 'left', 'right', 'center' is available.
+ *       @param {boolean|Object} [props.options.chart.animation] - Whether to use animation and duration when rendering the initial chart.
+ *       @param {number|string} [props.options.chart.width] - Chart width. 'auto' or if not write, the width of the parent container is followed. 'auto' or if not created, the width of the parent container is followed.
+ *       @param {number|string} [props.options.chart.height] - Chart height. 'auto' or if not write, the width of the parent container is followed. 'auto' or if not created, the height of the parent container is followed.
+ *     @param {Object} [props.options.series]
+ *       @param {boolean} [props.options.series.selectable=false] - Whether to make selectable series or not.
+ *       @param {Object} [props.options.series.dataLabels] - Set the visibility, location, and formatting of dataLabel. For specific information, refer to the {@link https://github.com/nhn/tui.chart|DataLabels guide} on github.
+ *       @param {Object} [props.options.series.aliasName] - Chart options are specified based on the alias name. 'radiusRange', 'angleRange', 'clockwise', 'dataLabels' is available. For specific information, refer to the {@link https://github.com/nhn/tui.chart|NestedPie Chart guide} on github.
+ *     @param {Object} [props.options.legend]
+ *       @param {string} [props.options.legend.align] - Legend align. 'top', 'bottom', 'right', 'left' is available.
+ *       @param {string} [props.options.legend.showCheckbox] - Whether to show checkbox.
+ *       @param {boolean} [props.options.legend.visible] - Whether to show legend.
+ *       @param {number} [props.options.legend.width] - Width of legend.
+ *       @param {Object} [props.options.legend.item] - `width` and `overflow` options of the legend item. For specific information, refer to the {@link https://github.com/nhn/tui.chart|Legend guide} on github.
+ *     @param {Object} [props.options.exportMenu]
+ *       @param {boolean} [props.options.exportMenu.visible] - Whether to show export menu.
+ *       @param {string} [props.options.exportMenu.filename] - File name applied when downloading.
+ *     @param {Object} [props.options.tooltip]
+ *       @param {number} [props.options.tooltip.offsetX] - Offset value to move title horizontally.
+ *       @param {number} [props.options.tooltip.offsetY] - Offset value to move title vertically.
+ *       @param {Function} [props.options.tooltip.formatter] - Function to format data value.
+ *       @param {Function} [props.options.tooltip.template] - Function to create custom template. For specific information, refer to the {@link https://github.com/nhn/tui.chart|Tooltip guide} on github.
+ *     @param {Object} [props.options.responsive] - Rules for changing chart options. For specific information, refer to the {@link https://github.com/nhn/tui.chart|Responsive guide} on github.
+ *       @param {boolean|Object} [props.options.responsive.animation] - Animation duration when the chart is modified.
+ *       @param {Array<Object>} [props.options.responsive.rules] - Rules for the Chart to Respond.
+ *     @param {Object} [props.options.lang] - Options for changing the text displayed on the chart or i18n languages.
+ *       @param {Object} [props.options.lang.noData] - No Data Layer Text.
+ *     @param {Object} [props.options.theme] - Chart theme options. For specific information, refer to the {@link https://github.com/nhn/tui.chart|NestedPie Chart guide} on github.
+ *       @param {Object} [props.options.theme.chart] - Chart font theme.
+ *       @param {Object} [props.options.theme.noData] - No Data Layer Text theme.
+ *       @param {Object} [props.options.theme.series] - Series theme.
+ *       @param {Object} [props.options.theme.title] - Title theme.
+ *       @param {Object} [props.options.theme.legend] - Legend theme.
+ *       @param {Object} [props.options.theme.tooltip] - Tooltip theme.
+ *       @param {Object} [props.options.theme.exportMenu] - ExportMenu theme.
+ * @extends Chart
+ */
+export default class NestedPieChart extends Chart<NestedPieChartOptions> {
+    constructor({ el, options, data: { series, categories } }: NestedPieChartProps);
+    protected initialize(): void;
+    /**
+     * Add series.
+     * @param {Object} data - Data to be added.
+     *   @param {string} data.name - Series name.
+     *   @param {Array<Object>} data.data - Array of data to be added.
+     * @param {Object} dataInfo - Which name of chart to add.
+     *   @param {string} dataInfo.name - Chart series name.
+     * @api
+     * @example
+     * chart.addSeries(
+     *   {
+     *     name: 'newSeries',
+     *     data: [
+     *       { name: 'A', data: 10 },
+     *       { name: 'B', data: 20 },
+     *     ],
+     *   },
+     *   {
+     *     name: 'series name'
+     *   });
+     */
+    addSeries(data: NestedPieSeriesType, dataInfo?: AddSeriesDataInfo): void;
+    /**
+     * Convert the chart data to new data.
+     * @param {Object} data - Data to be set
+     * @api
+     * @example
+     * chart.setData({
+     *   categories: ['A', 'B'],
+     *   series: [
+     *     {
+     *       name: 'browsers',
+     *       data: [
+     *         {
+     *           name: 'Chrome',
+     *           data: 50,
+     *         },
+     *         {
+     *           name: 'Safari',
+     *           data: 20,
+     *         },
+     *       ]
+     *     },
+     *     {
+     *       name: 'versions',
+     *       data: [
+     *         {
+     *           name: '1',
+     *           data: 50,
+     *         },
+     *         {
+     *           name: '2',
+     *           data: 20,
+     *         },
+     *       ]
+     *     }
+     *   ]
+     * });
+     */
+    setData(data: NestedPieSeriesData): void;
+    /**
+     * Hide series data label.
+     * @api
+     * @example
+     * chart.hideSeriesDataLabel();
+     */
+    hideSeriesDataLabel(): void;
+    /**
+     * Show series data label.
+     * @api
+     * @example
+     * chart.showSeriesDataLabel();
+     */
+    showSeriesDataLabel(): void;
+    /**
+     * Convert the chart options to new options.
+     * @param {Object} options - Chart options.
+     * @api
+     * @example
+     * chart.setOptions({
+     *   chart: {
+     *     width: 500,
+     *     height: 'auto',
+     *     title: 'Energy Usage',
+     *   },
+     *   series: {
+     *     alias2: {
+     *       radiusRange: [20%, 50%],
+     *     },
+     *   },
+     *   tooltip: {
+     *     formatter: (value) => `${value}kWh`,
+     *   },
+     * });
+     */
+    setOptions(options: NestedPieChartOptions): void;
+    /**
+     * Update chart options.
+     * @param {Object} options - Chart options.
+     * @api
+     * @example
+     * chart.updateOptions({
+     *   chart: {
+     *     height: 'auto',
+     *     title: 'Energy Usage',
+     *   },
+     *   series: {
+     *     alias1: {
+     *       showDot: true,
+     *     },
+     *   },
+     * });
+     */
+    updateOptions(options: NestedPieChartOptions): void;
+    /**
+     * Show tooltip.
+     * @param {Object} seriesInfo - Information of the series for the tooltip to be displayed.
+     *      @param {number} seriesInfo.seriesIndex - Index of series.
+     *      @param {number} seriesInfo.alias - alias name.
+     * @api
+     * @example
+     * chart.showTooltip({seriesIndex: 1, alias: 'name'});
+     */
+    showTooltip(seriesInfo: SelectSeriesInfo): void;
+    /**
+     * Hide tooltip.
+     * @api
+     * @example
+     * chart.hideTooltip();
+     */
+    hideTooltip(): void;
+}