echarts-for-react
- Version 3.0.2
- Published
- 74.6 kB
- 2 dependencies
- MIT license
Install
npm i echarts-for-react
yarn add echarts-for-react
pnpm add echarts-for-react
Overview
Apache Echarts components for React.
Index
Classes
Type Aliases
Classes
class EChartsReact
class EChartsReact extends EChartsReactCore {}
constructor
constructor(props: EChartsReactProps);
Type Aliases
type EChartsInstance
type EChartsInstance = any;
type EChartsOption
type EChartsOption = any;
type EChartsReactProps
type EChartsReactProps = { /** * echarts library entry, use it for import necessary. */ readonly echarts?: any; /** * `className` for container */ readonly className?: string; /** * `style` for container */ readonly style?: CSSProperties; /** * echarts option */ readonly option: EChartsOption; /** * echarts theme config, can be: * 1. theme name string * 2. theme object */ readonly theme?: string | Record<string, any>; /** * notMerge config for echarts, default is `false` */ readonly notMerge?: boolean; /** * lazyUpdate config for echarts, default is `false` */ readonly lazyUpdate?: boolean; /** * showLoading config for echarts, default is `false` */ readonly showLoading?: boolean; /** * loadingOption config for echarts, default is `null` */ readonly loadingOption?: any; /** * echarts opts config, default is `{}` */ readonly opts?: Opts; /** * when after chart reander, do the callback widht echarts instance */ readonly onChartReady?: (instance: EChartsInstance) => void; /** * bind events, default is `{}` */ readonly onEvents?: Record<string, Function>; /** * should update echarts options */ readonly shouldSetOption?: ( prevProps: EChartsReactProps, props: EChartsReactProps ) => boolean;};
Package Files (2)
Dependencies (2)
Dev Dependencies (31)
- @commitlint/cli
- @commitlint/config-angular
- @types/jest
- @types/node
- @types/react
- @typescript-eslint/eslint-plugin
- @typescript-eslint/parser
- cross-env
- dumi
- dumi-theme-default
- echarts
- echarts-gl
- eslint
- eslint-config-prettier
- eslint-plugin-import
- eslint-plugin-prettier
- gh-pages
- husky
- jest
- jest-canvas-mock
- jest-electron
- lint-md-cli
- lint-staged
- lodash.clonedeep
- miz
- npm-run-all
- prettier
- rimraf
- ts-jest
- ts-loader
- typescript
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/echarts-for-react
.
- Markdown[](https://www.jsdocs.io/package/echarts-for-react)
- HTML<a href="https://www.jsdocs.io/package/echarts-for-react"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1919 ms. - Missing or incorrect documentation? Open an issue for this package.