echarts-rc
v0.0.9
Published
Apache Echarts component for React.
Downloads
9
Maintainers
Readme
echarts-rc
The React wrapper for Apache ECharts.
Purpose
Why we have one more wrapper for echarts?
- Use of the Resize Observer API to auto resize.
- Full access to all echarts features.
- Use of modern react.
Attributes
- option - the echarts option config, can see https://echarts.apache.org/option.html.
- opts - merge option setup (
opts
parameter ofsetOption
function) https://echarts.apache.org/en/api.html#echartsInstance.setOption - theme - theme to be applied. https://echarts.apache.org/en/api.html#echarts.init.
- initOpts - init options (
opts
parameter ofinit
function) https://echarts.apache.org/en/api.html#echarts.init - onInit - when the chart is init, will callback the function with the
echartsInstance
as it's paramter. - onUpdate - will callback after
setOption
. - onResize - will callback after
resize
. - ...htmlProps[] - html attributes (className, styles, ...)
How to Use
Step 1.
npm i echarts-rc
# `echarts` is the peerDependence of `echarts-rc`, you can install echarts with your own version.
npm i echarts
Step 2.
import { useMemo } from "react";
import EChartsComponent, { EChartsOption } from "echarts-rc";
function App() {
const options: EChartsOption = useMemo(
() => ({
xAxis: {
type: "category",
data: ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"],
},
yAxis: {
type: "value",
},
series: [
{
data: [150, 230, 224, 218, 135, 147, 260],
type: "line",
},
],
}),
[]
);
return (
<EChartsComponent
option={options}
opts={{ notMerge: true }}
style={{ height: 500 }}
onInit={(instance) => {
instance.on("click", (e) => {
console.log(e);
});
}}
/>
);
}
export default App;