README.zh-CN.md

VTable

VTable，不只是一款高性能的多维数据分析表格，更是一个在行列间创作的方格艺术家。

简介 • demo • 教程 • API•

English | 简体中文 | 日本語

（video）

简介

VTable 是 VisActor 可视化体系中的表格组件库，基于可视化渲染引擎 VRender 进行封装。 核心能力如下：

1. 性能极致：支持百万级数据快速运算与渲染
2. 多维分析：多维数据自动分析与呈现
3. 表现力强：提供灵活强大的图形能力，无缝融合VChart

仓库简介

本仓库包含如下 package

1. packages/vtable：表格组件代码
2. packages/vtable-gantt: 甘特图组件代码
3. packages/vtable-editors: 表格编辑器组件代码
4. packages/vtable-export: 表格导出工具代码
5. packages/vtable-search: 表格搜索工具代码
6. packages/react-vtable: React 版本的表格组件
7. packages/vue-vtable: Vue 版本的表格组件
8. docs: 教程文档

Usage 使用

安装

npm package

// npm
npm install @visactor/vtable

// yarn
yarn add @visactor/vtable

快速上手

// this demo you can run on codesanbox https://codesandbox.io/s/vtable-simple-demo-g8q738
import * as VTable from '@visactor/vtable';

const columns = [
  {
    field: 'Order ID',
    caption: 'Order ID'
  },
  {
    field: 'Customer ID',
    caption: 'Customer ID'
  },
  {
    field: 'Product Name',
    caption: 'Product Name'
  },
  {
    field: 'Sales',
    caption: 'Sales'
  },
  {
    field: 'Profit',
    caption: 'Profit'
  }
];

const option = {
  container: document.getElementById(CONTAINER_ID),
  records: [
    {
      'Order ID': 'CA-2018-156720',
      'Customer ID': 'JM-15580',
      'Product Name': 'Bagged Rubber Bands',
      Sales: '3.024',
      Profit: '-0.605'
    },
    {
      'Order ID': 'CA-2018-115427',
      'Customer ID': 'EB-13975',
      'Product Name': 'GBC Binding covers',
      Sales: '20.72',
      Profit: '6.475'
    }
    // ...
  ],
  columns
};
const tableInstance = new VTable.ListTable(option);

更多 demo 和详细教程

⌨️ 开发

首先，全局安装 @microsoft/rush

$ npm i --global @microsoft/rush

接着将代码 clone 至本地：

# clone
$ git clone git@github.com:VisActor/VTable.git
$ cd VTable
# install dependencies
$ rush update
# start vtable demo
$ cd packages/vtable
# execute in file path: ./packages/vtable
$ rushx demo
# start site development server, execute in file path: ./
$ rush docs
# after execut git commit, please run the following command to update the change log. Please execute in file path: ./
$ rush change-all

📖 Documents

安装并且更新依赖后，可以执行 docs 命令，开启 VTable 的本地文档预览

# start vtable document server. execute in file path: ./
$ rush docs

🔗 相关链接

• 官网
• 使用趋势

💫 生态系统

Project	Description
React-VTable	VTable React 组件

⭐️ Star History

🤝 参与贡献

如想参与贡献，请先阅读 行为准则 和 贡献指南。

细流成河，终成大海！

许可证

MIT 协议