README.md

April 1, 2022 ยท View on GitHub

๐Ÿž๐Ÿ“ˆ Spread your data on TOAST UI Chart. TOAST UI Chart is Beautiful Statistical Data Visualization library.

GitHub release npm GitHub license PRs welcome code with hearth by NHN Cloud lerna

๐Ÿ“ฆ Packages

The functionality of TOAST UI Chart is available when using the Plain JavaScript, React, Vue Component.

๐Ÿ“™ Documents

๐Ÿ˜ Why TOAST UI Chart?

Simple, Easy to Use, And It's Beautiful!

TOAST UI Chart makes your data pop and presents it in a manner that is easy to understand. Furthermore, it provides a wide range of theme options for customizing the charts to be suitable for all of your services. Chart components like the title, axes, legends, tooltips, plots, series, and more can be customized through the options.

image

Variety of powerful features!

Responsive

Add different options and animations according to the charts' sizes by using the responsive option.

responsive

Zoomable

Make the data presented in the Line, Area, and Treemap Charts zoomable with the zoomable option.

zoomable

Live Update

View and manage new data as they are added realtime with the addData API and the options.series.shift option.

AreaLineHeatmap
arealive update lineheatmap
LineAreaColumnColumnLine
lineAreacolumncolumnline

Synchronize Tooltip

Use and synchronize the tooltip features at the moment the cursor hovers over the chart with the showTooltip API and the on custom event.

synctooltip

๐ŸŽจ Features

Charts

The TOAST UI Chart provides many types of charts to visualize the various forms of data.

AreaLineBarColumn
area chartline chartbar chartcolumn chart
BulletBoxPlotTreemapHeatmap
bullet chartboxplot charttreemap chartheatmap chart
ScatterBubbleRadarPie
scatter chartbubble chartradar chartpie chart
LineAreaLineScatterColumnLineNestedPie
lineArea chartlineScatter chartcolumnLine chartnestedPie chart
RadialBarGauge
radialBar chartgauge chartcoming soonnext

In addition, a variety of powerful features can be found on the demo page below. ๐Ÿ‘‡๐Ÿ‘‡๐Ÿ‘‡

๐Ÿพ Examples

Here are more examples and play with TOAST UI Chart!

๐Ÿ”ง Pull Request Steps

TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.

Setup

Fork main branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to have any errors.

$ git clone https://github.com/{your-personal-repo}/tui.chart.git
$ npm install
$ cd apps/chart
$ npm install
$ npm run test

Develop

Let's start development! You can develop UI through webpack-dev-server or storybook, and you can write tests through Jest. Don't miss adding test cases and then make green rights.

Run webpack-dev-server

$ npm run serve

Run storybook

$ npm run storybook

Run test

$ npm run test

Pull Request

Before uploading your PR, run test one last time to check if there are any errors. If it has no errors, commit and then push it!

For more information on PR's steps, please see links in the Contributing section.

๐Ÿ’ฌ Contributing

๐ŸŒ Browser Support

Chrome ChromeIE Internet ExplorerEdge EdgeSafari SafariFirefox Firefox
Yes10+YesYesYes

๐Ÿž TOAST UI Family

๐Ÿš€ Used By

๐Ÿ“œ License

This software is licensed under the MIT ยฉ NHN Cloud.