Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@toast-ui/react-chart
Advanced tools
Readme
This is a React component wrapping TOAST UI Chart.
React Wrapper of TOAST UI Chart applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Chart is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected, and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the usageStatistics
props like the example below.
const options = {
//...
usageStatistics: false,
};
npm install --save @toast-ui/react-chart
You can use Toast UI Chart for React as a ECMAScript module or a CommonJS module. As this module does not contain CSS files, you should import toastui-chart.min.css
from @toastui/chart
manually.
import '@toast-ui/chart/dist/toastui-chart.min.css';
import { BarChart, LineChart } from '@toast-ui/react-chart';
require('@toast-ui/chart/dist/toastui-chart.min.css');
const toastui = require('@toast-ui/react-chart');
const BarChart = toastui.BarChart;
const LineChart = toastui.LineChart;
You can use all kinds of charts in TOAST UI chart. React Components for each chart types are:
AreaChart
LineChart
BarChart
BoxPlotChart
BubbleChart
BulletChart
ColumnChart
ColumnLineChart
HeatmapChart
LineAreaChart
LineScatterChart
NestedPieChart
PieChart
RadarChart
ScatterChart
TreemapChart
All the options of the TOAST UI Chart are supported in the form of props. Note that data and columns props are required and other props are optional.
const data = {
categories: ['June', 'July', 'Aug', 'Sep', 'Oct', 'Nov'],
series: [
{
name: 'Budget',
data: [5000, 3000, 5000, 7000, 6000, 4000],
},
{
name: 'Income',
data: [8000, 1000, 7000, 2000, 5000, 3000],
},
],
};
const options = {
chart: {
width: 1160,
height: 650,
title: 'Monthly Revenue',
},
yAxis: {
title: 'Month',
},
xAxis: {
title: 'Amount',
},
};
const containerStyle = {
width: '600px',
height: '600px',
};
const MyComponent = () => <BarChart data={data} options={options} style={containerStyle} />;
Name | Type | Required | Description |
---|---|---|---|
data | Object | O | This prop is for data of the chart. When you change data, chart is rendering for changing data. |
options | Object | X | This prop is for options of TOAST UI chart. You can set the configuration of the chart. |
style | Object | X | This prop is for container style of TOAST UI chart. You can set the style of the chart container. To use responsive layout, the width or height of the container must be specified as a value such as "%" or "vh", "vw". |
For using instance methods of TOAST UI Chart, first thing to do is creating Refs of wrapper component using createRef()
. But the wrapper component does not provide a way to call instance methods of TOAST UI Chart directly. Instead, you can call getInstance()
method of the wrapper component to get the instance, and call the methods on it.
import { useRef } from 'React';
function MyComponent() {
const chartRef = useRef(null);
const handleClickButton = () => {
console.log('type:', chartRef.current.getInstance().showSeriesDataLabel());
};
return (
<>
<BarChart ref={chartRef} data={data} options={options} />
<button onClick={handleClickButton}>showSeriesDataLabel</button>
</>
);
}
An instance of the wrapper component also provides a handy method for getting the root element. If you want to manipulate the root element directly, you can call getRootElement
to get the element.
import { useRef } from 'React';
function MyComponent() {
const chartRef = useRef(null);
const handleClickButton = () => {
chartRef.current.getRootElement().classList.add('my-chart-root');
};
return (
<>
<BarChart ref={chartRef} data={data} options={options} />
<button onClick={handleClickButton}>Click!</button>
</>
);
}
All the events of TOAST UI Chart are supported in the form of on[EventName]
props. The first letter of each event name should be capitalized. For example, for using click
event you can use onClick
prop like the example below.
import { useRef } from 'React';
function MyComponent() {
const chartRef = useRef(null);
const handleClick = () => {
console.log('click!!');
};
return <BarChart ref={chartRef} data={data} options={options} onSelectLegend={handleClick} />;
}
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.
Fork develop
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}/[[repo name]].git
$ cd [[repo name]]
$ npm install
Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!
For more information on PR's step, please see links of Contributing section.
FAQs
TOAST UI Chart for React
The npm package @toast-ui/react-chart receives a total of 641 weekly downloads. As such, @toast-ui/react-chart popularity was classified as not popular.
We found that @toast-ui/react-chart demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.