README.md · klose/ant-design-charts

# @ant-design/charts

A React chart library, based on [G2Plot](https://antv-g2plot.gitee.io/zh)

![npm](https://img.shields.io/npm/dm/@ant-design/charts) ![npm](https://img.shields.io/npm/v/@ant-design/charts) [![GitHub stars](https://img.shields.io/github/stars/ant-design/ant-design-charts)](https://github.com/ant-design/ant-design-charts/stargazers) ![Test CI](https://github.com/ant-design/ant-design-charts/workflows/Test%20CI/badge.svg)

</div>

## Features

- Easy to use
- TypeScript
- Pretty & Lightweight
- Responsive
- Storytelling

## Installation

### npm

```bash | pure
$ npm install @ant-design/charts
```

## Usage

```tsx | pure
import React from 'react';
import { Line } from '@ant-design/charts';

const Page: React.FC = () => {
  const data = [
    { year: '1991', value: 3 },
    { year: '1992', value: 4 },
    { year: '1993', value: 3.5 },
    { year: '1994', value: 5 },
    { year: '1995', value: 4.9 },
    { year: '1996', value: 6 },
    { year: '1997', value: 7 },
    { year: '1998', value: 9 },
    { year: '1999', value: 13 },
  ];

const config = {
    data,
    width: 800,
    height: 400,
    autoFit: false,
    xField: 'year',
    yField: 'value',
    point: {
      size: 5,
      shape: 'diamond',
    },
    label: {
      style: {
        fill: '#aaa',
      },
    },
  };

let chart;

// 导出图片
  const downloadImage = () => {
    chart?.downloadImage();
  };

// 获取图表 base64 数据
  const toDataURL = () => {
    console.log(chart?.toDataURL());
  };

return (
    <div>
      <button type="button" onClick={downloadImage} style={{ marginRight: 24 }}>
        导出图片
      </button>
      <button type="button" onClick={toDataURL}>
        获取图表信息
      </button>
      <Line {...config} onReady={(chartInstance) => (chart = chartInstance)} />
    </div>
  );
};
export default Page;
```

result：

## Gallery

[gallery](https://charts.ant.design/demos/global)

## Document

### API

See chart API for details.

Common props:

| Property | Description | Type | defaultValue |
| --- | --- | --- | --- |
| onReady | chart loaded callback | (chart)=> void | - |
| onEvent | chart events | (chart, event)=> void | - |
| loading | loading status | boolean | - |
| loadingTemplate | loading template | React.ReactElement | - |
| errorTemplate | custom error template | (e: Error) => React.ReactNode | - |
| className | container class | string | - |
| style | container style | React.CSSProperties | - |
| chartRef | chart ref | (React.MutableRefObject&lt;Chart&gt;)=> void | - |

[More usage](https://charts.ant.design/guide/case)

### [FAQ](https://github.com/ant-design/ant-design-charts/issues)

### Communication Group

They are DingTalk groups.

### License

Charts is available under the License MIT.

## develop

### depend

- install [nodejs](https://nodejs.org/en/)

### start

```bash | pure
# 安装依赖
$ npm install

# 开发 library
$ npm run dev
```

klose/ant-design-charts

简介

发行版

贡献者

近期动态

klose/ant-design-charts .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

klose/ant-design-charts