mirror of https://github.com/VisActor/VChart synced 2024-11-22 17:26:19 +00:00

History

kkxxkk2019 876ad2aaa1 chore: upgrade vrender version to latest 0.15.1		2023-09-13 11:59:52 +08:00
..
__tests__	feat: support a new type of markLine, which defined by `type: 'type-step'`	2023-09-12 22:30:36 +08:00
scripts
src	fix: `offsetX` and `offsetY` can not work in mark component	2023-09-13 09:33:16 +08:00
.eslintignore
.eslintrc.js
bundler.config.js
CHANGELOG.json
CHANGELOG.md
jest.config.js
package.json	chore: upgrade vrender version to latest 0.15.1	2023-09-13 11:59:52 +08:00
README.md
rollup.config.js
setup-mock.js
tsconfig.eslint.json
tsconfig.json
tsconfig.test.json

README.md

VChart

VChart is a charting component library in VisActor visualization system. It wraps the charting logic based on visual grammar library VGrammar and the component encapsulation based on visual rendering engine VRender. The core capabilities are as follows:

Cross-platform: Automatically adapt to desktop, H5, and multiple small program environments
Storytelling: Comprehensive annotation, animation, flow control, narrative templates, and other enhanced features for visual storytelling
Scenes: Deliver visual storytelling capabilities to end-users, unlock developer productivity

🔨 Usage

📦 Installation

# npm
$ npm install @visactor/vchart

# yarn
$ yarn add @visactor/vchart

📊 A Chart Example

import VChart from '@visactor/vchart';

const spec = {
  type: 'bar',
  data: [
    {
      id: 'barData',
      values: [
        { month: 'Monday', sales: 22 },
        { month: 'Tuesday', sales: 13 },
        { month: 'Wednesday', sales: 25 },
        { month: 'Thursday', sales: 29 },
        { month: 'Friday', sales: 38 }
      ]
    }
  ],
  xField: 'month',
  yField: 'sales',
  crosshair: {
    xField: { visible: true }
  }
};

// 'chart' is the id of your dom container, such as <div id="chart"></chart>
const vchart = new VChart(spec, { dom: 'chart' });
vchart.renderAsync();

⌨️ Development

First of all, please install @microsoft/rush

$ npm i --global @microsoft/rush

Then clone locally:

# clone
$ git clone git@github.com:VisActor/VChart.git
$ cd VChart
# install dependencies
$ rush update
# start vchart development server
$ rush start
# the another way to start react-vchart development server
$ rush run -p @visactor/vchart -s start
# unit test
$ rush run -p @visactor/vchart -s test