new PieChart(props)
EXTENDS
- Chart
PARAMETERS
Name Type Description props
Object
PROPERTIES
Name Type Description el
HTMLElement
The target element to create chart.
options
[ Object ]
Options for making Pie Chart.
PROPERTIES
Name Type Description chart
[ Object ]
PROPERTIES
Name Type Description title
[ stringObject ]
Chart title text or options.
animation
[ booleanObject ]
Whether to use animation and duration when rendering the initial chart.
width
[ numberstring ]
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.
height
[ numberstring ]
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.
series
[ Object ]
PROPERTIES
Name Type Description selectable
boolean = false
Whether to make selectable series or not.
dataLabels
[ Object ]
Set the visibility, location, and formatting of dataLabel. For specific information, refer to the DataLabels guide on github.
radiusRange
[ Array.<number>Array.<string> ]
Specifies the radius of the circle drawn. It is specified by entering a number or percent string value in start and end.
angleRange
[ Array ]
The range of angles to which the circle will be drawn. It is specified by putting number in start and end.
clockwise
[ boolean ]
Whether it will be drawn clockwise.
legend
[ Object ]
PROPERTIES
Name Type Description align
[ string ]
Legend align. 'top', 'bottom', 'right', 'left' is available.
showCheckbox
[ string ]
Whether to show checkbox.
visible
[ boolean ]
Whether to show legend.
width
[ number ]
Width of legend.
item
[ Object ]
and options of the legend item. For specific information, refer to the Legend guide on github.
exportMenu
[ Object ]
PROPERTIES
Name Type Description visible
[ boolean ]
Whether to show export menu.
filename
[ string ]
File name applied when downloading.
tooltip
[ Object ]
PROPERTIES
Name Type Description offsetX
[ number ]
Offset value to move title horizontally.
offsetY
[ number ]
Offset value to move title vertically.
formatter
[ Function ]
Function to format data value.
template
[ Function ]
Function to create custom template. For specific information, refer to the Tooltip guide on github.
responsive
[ Object ]
Rules for changing chart options. For specific information, refer to the Responsive guide on github.
PROPERTIES
Name Type Description animation
[ booleanObject ]
Animation duration when the chart is modified.
rules
[ Array ]
Rules for the Chart to Respond.
lang
[ Object ]
Options for changing the text displayed on the chart or i18n languages.
PROPERTIES
Name Type Description noData
[ Object ]
No Data Layer Text.
theme
[ Object ]
Chart theme options. For specific information, refer to the Pie Chart guide on github.
PROPERTIES
Name Type Description chart
[ Object ]
Chart font theme.
noData
[ Object ]
No Data Layer Text theme.
series
[ Object ]
Series theme.
title
[ Object ]
Title theme.
legend
[ Object ]
Legend theme.
tooltip
[ Object ]
Tooltip theme.
exportMenu
[ Object ]
ExportMenu theme.
data
Object
Data for making Pie Chart.
PROPERTIES
Name Type Description categories
[ Array ]
Categories.
series
Array.<Object>
Series data.
PROPERTIES
Name Type Description name
string
Series name.
data
number
Series data.
Instance Methods
addSeries(data)
Add series.
PARAMETERS
Name Type Description data
Object
Data to be added.
PROPERTIES
Name Type Description name
string
Series name.
data
Array.<Object>
Array of data to be added.
EXAMPLES
chart.addSeries({ name: 'newSeries', data: 10, });
hideSeriesDataLabel()
Hide series data label.
EXAMPLES
chart.hideSeriesDataLabel();
hideTooltip()
Hide tooltip.
EXAMPLES
chart.hideTooltip();
setData(data)
Convert the chart data to new data.
PARAMETERS
Name Type Description data
Object
Data to be set.
EXAMPLES
chart.setData({ categories: ['A'], series: [ {name: 'a', data: 10}, {name: 'b', data: 20}, ] });
setOptions(options)
Convert the chart options to new options.
PARAMETERS
Name Type Description options
Object
Chart options.
EXAMPLES
chart.setOptions({ chart: { width: 500, height: 'auto', title: 'Energy Usage', }, series: { selectable: true, }, tooltip: { formatter: (value) => `${value}kWh`, }, });
showSeriesDataLabel()
Show series data label.
EXAMPLES
chart.showSeriesDataLabel();
showTooltip(seriesInfo)
Show tooltip.
PARAMETERS
Name Type Description seriesInfo
Object
Information of the series for the tooltip to be displayed.
PROPERTIES
Name Type Description seriesIndex
number
Index of series.
alias
number
alias name.
EXAMPLES
chart.showTooltip({seriesIndex: 1, alias: 'name'});
updateOptions(options)
Update chart options.
PARAMETERS
Name Type Description options
Object
Chart options.
EXAMPLES
chart.updateOptions({ chart: { height: 'auto', title: 'Energy Usage', }, tooltip: { formatter: (value) => `${value}kWh`, }, });