@toast-ui/chart
Version:
TOAST UI Application: Chart
206 lines (205 loc) • 11.1 kB
TypeScript
import Chart from "./chart";
import { ColumnChartOptions, BoxSeriesData, BoxSeriesDataType, BoxSeriesInput } from "../../types/options";
import { ColumnChartProps, SelectSeriesInfo } from "../../types/charts";
/**
* @class
* @classdesc Column Chart
* @param {Object} props
* @param {HTMLElement} props.el - The target element to create chart.
* @param {Object} props.data - Data for making Column 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 {string} props.data.series.colorByCategories - Paint Rect with color based on categories.
* @param {Array<number|Array<number>>} props.data.series.data - Series data.
* @param {Object} [props.options] - Options for making Column 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 {boolean} [props.options.series.rangeSelectable=false] - Whether to use range selection feature or not.
* @param {number} [props.options.series.barWidth] - Bar width.
* @param {boolean} [props.options.series.diverging] - Whether to use diverging chart or not.
* @param {Object} [props.options.series.stack] - Option to use the stack chart or, if so, what type of stack to use.
* @param {string} [props.options.series.eventDetectType] - Event detect type. 'grouped', 'point' is available.
* @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 {boolean} [props.options.series.shift=false] - Whether to use shift when addData or not.
* @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|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|Bar 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|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 ColumnChart extends Chart<ColumnChartOptions> {
constructor({ el, options, data }: ColumnChartProps);
protected initialize(): void;
/**
* Add data.
* @param {Array<number|Array<number>>} data - Array of data to be added
* @param {string} category - Category to be added
* @api
* @example
* chart.addData([10, 20], '6');
*/
addData(data: BoxSeriesDataType[], category: string): void;
/**
* Add series.
* @param {Object} data - Data to be added
* @param {string} data.name - Series name
* @param {Array<number|Array<number>>} data.data - Array of data to be added
* @api
* @example
* chart.addSeries({
* name: 'newSeries',
* data: [10, 100, 50, 40, 70, 55, 33, 70, 90, 110],
* });
*/
addSeries(data: BoxSeriesInput<BoxSeriesDataType>): void;
/**
* Convert the chart data to new data.
* @param {Object} data - Data to be set
* @api
* @example
* chart.setData({
* categories: ['1', '2', '3'],
* series: [
* {
* name: 'new series',
* data: [1, 2, 3],
* },
* {
* name: 'new series2',
* data: [4, 5, 6],
* }
* ]
* });
*/
setData(data: BoxSeriesData): 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',
* },
* xAxis: {
* title: 'Month',
* date: { format: 'yy/MM' },
* },
* yAxis: {
* title: 'Energy (kWh)',
* },
* series: {
* selectable: true,
* },
* tooltip: {
* formatter: (value) => `${value}kWh`,
* },
* });
*/
setOptions(options: ColumnChartOptions): void;
/**
* 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: ColumnChartOptions): void;
/**
* Show tooltip.
* @param {Object} seriesInfo - Information of the series for the tooltip to be displayed.
* @param {number} seriesInfo.index - Index of data within series. If 'series.eventDetectType' is "grouped", only seriesIndex is needed.
* @param {number} [seriesInfo.seriesIndex] - Index of series.
* @api
* @example
* chart.showTooltip({index: 1, seriesIndex: 2});
*/
showTooltip(seriesInfo: SelectSeriesInfo): void;
/**
* Hide tooltip.
* @api
* @example
* chart.hideTooltip();
*/
hideTooltip(): void;
}