@techie_doubts/tui.chart.2026 4.6.1

package/dist/esm/charts/bulletChart.js

@@ -0,0 +1,278 @@
+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 Axis from "../component/axis";
+import BulletSeries from "../component/bulletSeries";
+import Plot from "../component/plot";
+import Tooltip from "../component/tooltip";
+import Legend from "../component/legend";
+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 DataLabels from "../component/dataLabels";
+import Background from "../component/background";
+import NoDataText from "../component/noDataText";
+import * as basicBrushes from "../brushes/basic";
+import * as axisBrushes from "../brushes/axis";
+import * as legendBrush from "../brushes/legend";
+import * as labelBrush from "../brushes/label";
+import * as dataLabelBrush from "../brushes/dataLabel";
+import * as exportMenuBrush from "../brushes/exportMenu";
+/**
+ * @class
+ * @classdesc Bullet Chart
+ * @param {Object} props
+ *   @param {HTMLElement} props.el - The target element to create chart.
+ *   @param {Object} props.data - Data for making Bullet 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 {Array<number>} props.data.series.markers - Series markers. It specifies the marker for comparing.
+ *       @param {Array<Array<number>>} props.data.series.ranges - Series ranges. It specifies the range of values that can be compared.
+ *   @param {Object} [props.options] - Options for making Bullet 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 {number} [props.options.series.vertical] - Whether to use vertical bullet 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.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} [props.options.yAxis]
+ *       @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|Bullets 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.xAxis] - X Axis theme.
+ *       @param {Object} [props.options.theme.yAxis] - Y Axis theme.
+ *       @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 BulletChart extends Chart {
+    constructor({ el, options, data: { series } }) {
+        super({
+            el,
+            options,
+            series: {
+                bullet: series,
+            },
+            modules: [dataRange, scale, axes, plot],
+        });
+        /**
+         * Hide tooltip.
+         * @api
+         * @example
+         * chart.hideTooltip();
+         */
+        this.hideTooltip = () => {
+            this.eventBus.emit('hideTooltip');
+        };
+    }
+    initialize() {
+        super.initialize();
+        this.componentManager.add(Background);
+        this.componentManager.add(Title);
+        this.componentManager.add(Plot);
+        this.componentManager.add(Legend);
+        this.componentManager.add(BulletSeries);
+        this.componentManager.add(Axis, { name: 'yAxis' });
+        this.componentManager.add(Axis, { name: 'xAxis' });
+        this.componentManager.add(AxisTitle, { name: 'xAxis' });
+        this.componentManager.add(AxisTitle, { name: 'yAxis' });
+        this.componentManager.add(ExportMenu, { chartEl: this.el });
+        this.componentManager.add(HoveredSeries);
+        this.componentManager.add(SelectedSeries);
+        this.componentManager.add(DataLabels);
+        this.componentManager.add(Tooltip, { chartEl: this.el });
+        this.componentManager.add(NoDataText);
+        this.painter.addGroups([
+            basicBrushes,
+            axisBrushes,
+            legendBrush,
+            labelBrush,
+            exportMenuBrush,
+            dataLabelBrush,
+        ]);
+    }
+    /**
+     * Add series.
+     * @param {Object} data - Data to be added
+     *   @param {string} data.name - Series name
+     *   @param {Array<<Array<number>>} data.data - Array of data to be added
+     *   @param {Array<number>} data.markers - Series markers. It specifies the marker for comparing.
+     *   @param {Array<Array<number>>} data.ranges - Series ranges. It specifies the range of values that can be compared.
+     * @api
+     * @example
+     * chart.addSeries({
+     *   name: 'newSeries',
+     *   data: 20,
+     *   markers: [28, 2, 15],
+     *   ranges: [
+     *     [-1, 10],
+     *     [10, 20],
+     *     [20, 30],
+     *   ],
+     * });
+     */
+    addSeries(data) {
+        this.resetSeries();
+        this.store.dispatch('addSeries', { data });
+    }
+    /**
+     * Convert the chart data to new data.
+     * @param {Object} data - Data to be set
+     * @api
+     * @example
+     * chart.setData({
+     *   series: [
+     *     {
+     *       name: 'newSeries',
+     *       data: 20,
+     *       markers: [28, 2, 15],
+     *       ranges: [
+     *         [-1, 10],
+     *         [10, 20],
+     *         [20, 30],
+     *       ],
+     *     }
+     *   ]
+     * });
+     */
+    setData(data) {
+        this.resetSeries();
+        this.store.dispatch('setData', { series: { bullet: data.series } });
+    }
+    /**
+     * Hide series data label.
+     * @api
+     * @example
+     * chart.hideSeriesDataLabel();
+     */
+    hideSeriesDataLabel() {
+        this.store.dispatch('updateOptions', {
+            options: { series: { dataLabels: { visible: false } } },
+        });
+    }
+    /**
+     * Show series data label.
+     * @api
+     * @example
+     * chart.showSeriesDataLabel();
+     */
+    showSeriesDataLabel() {
+        this.store.dispatch('updateOptions', {
+            options: { series: { dataLabels: { visible: true } } },
+        });
+    }
+    /**
+     * 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',
+     *   },
+     *   yAxis: {
+     *     title: 'Energy (kWh)',
+     *   },
+     *   series: {
+     *     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',
+     *   },
+     *   tooltip: {
+     *     formatter: (value) => `${value}kWh`,
+     *   },
+     * });
+     */
+    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.
+     * @api
+     * @example
+     * chart.showTooltip({seriesIndex: 1});
+     */
+    showTooltip(seriesInfo) {
+        this.eventBus.emit('showTooltip', Object.assign(Object.assign({}, seriesInfo), { state: this.store.state }));
+    }
+}

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

@@ -0,0 +1,133 @@
+import Store from "../store/store";
+import EventEmitter from "../eventEmitter";
+import ComponentManager from "../component/componentManager";
+import Animator from "../animator";
+import { ChartProps, Point, SeriesDataInput, Size, DataInput } from "../../types/options";
+import { RespondersModel } from "../component/component";
+import { ChartState, Options, StoreModule } from "../../types/store/store";
+import Component from "../component/component";
+import { CheckedLegendType } from "../../types/components/legend";
+import { SelectSeriesInfo, AddSeriesDataInfo } from "../../types/charts";
+import { CustomEventType, EventListener } from "../../types/eventEmitter";
+export declare const DEFAULT_ANIM_DURATION = 500;
+export interface SelectSeriesHandlerParams<T extends Options> extends SelectSeriesInfo {
+    state: ChartState<T>;
+}
+/**
+ * @class
+ * @abstract
+ * Abstract class used to implement each chart.
+ */
+export default abstract class Chart<T extends Options> {
+    store: Store<T>;
+    ___animId___: null;
+    animator: Animator;
+    readonly containerEl: HTMLElement;
+    el: HTMLDivElement;
+    ctx: CanvasRenderingContext2D;
+    painter: any;
+    readonly eventBus: EventEmitter;
+    readonly componentManager: ComponentManager<T>;
+    modules: StoreModule[];
+    enteredComponents: Component[];
+    animationControlFlag: {
+        resizing: boolean;
+        updating: boolean;
+    };
+    resizeObserver: ResizeObserver | null;
+    private getAnimationDuration;
+    createChartWrapper(): HTMLDivElement;
+    constructor(props: ChartProps<T>);
+    resizeChartSize(containerWidth?: number, containerHeight?: number): void;
+    private debounceResizeEvent;
+    setResizeEvent(): void;
+    clearResizeEvent(): void;
+    handleCanvasMouseEvent(eventType: string, mousePosition: Point): void;
+    handleResponderEvent(event: MouseEvent, mousePosition: Point): void;
+    handleEvent(event: MouseEvent): void;
+    protected initStore(): void;
+    protected initialize(): void;
+    draw(): void;
+    update(delta: number): void;
+    initUpdate(delta: number): void;
+    protected handleEventForAllResponders?(event: MouseEvent, responderModels: RespondersModel, delegationMethod: string, mousePosition: Point): void;
+    /**
+     * Get checked legend chart type and label, checked state.
+     * @returns {Array<{checked: boolean, chartType: string, label: string}>} Array data that whether series has checked
+     * @api
+     * @example
+     * const checkedLegend = chart.getCheckedLegend()
+     */
+    getCheckedLegend: () => CheckedLegendType;
+    abstract updateOptions(options: Options): void;
+    abstract setOptions(options: Options): void;
+    abstract showTooltip(info: SelectSeriesInfo): void;
+    abstract hideTooltip(): void;
+    /**
+     * Returns the currently applied chart options.
+     * @returns {Object} options
+     * @api
+     * @example
+     * const options = chart.getOptions();
+     */
+    getOptions: () => any;
+    abstract addSeries(data: SeriesDataInput, dataInfo?: AddSeriesDataInfo): void;
+    /**
+     * Register of user custom event.
+     * @param {string} eventName - Event name. 'clickLegendLabel', 'clickLegendCheckbox', 'selectSeries', 'unselectSeries', 'hoverSeries', 'unhoverSeries', 'zoom', 'resetZoom' is available.
+     * @param {Function} handler - Event handler
+     * @api
+     */
+    on: (eventName: CustomEventType, handler: EventListener) => void;
+    abstract setData(data: DataInput): void;
+    /**
+     * Destroys the instance.
+     * @api
+     * @example
+     * chart.destroy();
+     */
+    destroy: () => void;
+    private isSelectableSeries;
+    /**
+     * Select series. It works only when the selectable option is true.
+     * @param {Object} seriesInfo - Information of the series to be selected
+     *      @param {number} [seriesInfo.seriesIndex] - Index of series
+     *      @param {number} [seriesInfo.index] - Index of data within series
+     *      @param {string} [seriesInfo.name] - Specify name for NestedPie Chart
+     *      @param {string} [seriesInfo.chartType] - Specify which chart to select when using LineArea, LineScatter, and ColumnLine charts.specifies which chart to select when using LineArea, LineScatter, and ColumnLine charts.
+     * @api
+     * @example
+     * chart.selectSeries({index: 1, seriesIndex: 2});
+     */
+    selectSeries: (seriesInfo: SelectSeriesInfo) => void;
+    /**
+     * Unselect selected series. It works only when the selectable option is true.
+     * @api
+     * @example
+     * chart.unselectSeries();
+     */
+    unselectSeries: () => void;
+    /**
+     * Resize chart size.
+     * @param {Object} size Chart size
+     *   @param {number} [size.width] Width
+     *   @param {number} [size.height] Height
+     * @api
+     * @example
+     * chart.resize({height: 100, width: 200});
+     */
+    resize: (size: Partial<Size>) => void;
+    /**
+     * Set tooltip offset.
+     * @param {Object} offset - Offset size
+     *   @param {number} [offset.x] Offset value to move title horizontally
+     *   @param {number} [offset.y] Offset value to move title vertically
+     * @api
+     * @example
+     * chart.setTooltipOffset({x: 10, y: -20});
+     */
+    setTooltipOffset(offset: Partial<Point>): void;
+    resetSeries: () => void;
+    private setResizeEventListeners;
+    protected dispatchOptionsEvent(eventName: 'initOptions' | 'updateOptions', options: Options): void;
+}