Introduction

VTable is based on visual rendering engine VRender.

The core capabilities are as follows:

1. Extreme performance: Supports fast computation and rendering of millions of data points.
2. Multidimensional analysis: Automatically analyzes and presents multidimensional data.
3. Strong expressiveness: Provides flexible and powerful graphic capabilities, seamlessly integrating with charts of VChart.

Repository Introduction

This repository includes the following packages:

1. packages/vtable: The core code repository of VTable
2. packages/vtable-gantt: Gantt chart component code
3. packages/vtable-editors: Table editor component code
4. packages/vtable-export: Table export tool code
5. packages/vtable-search: Table search tool code
6. packages/react-vtable: React version of the table component
7. packages/vue-vtable: Vue version of the table component
8. docs: Include VTable site tutorials, demos,apis and options, and also contains all Chinese and English documents.

Usage

Installation

npm package

1// npm
2npm install @visactor/vtable
3
4// yarn
5yarn add @visactor/vtable

Quick Start

1// this demo you can run on codesanbox https://codesandbox.io/s/vtable-simple-demo-g8q738
2import * as VTable from '@visactor/vtable';
3
4const columns = [
5  {
6    field: 'Order ID',
7    caption: 'Order ID'
8  },
9  {
10    field: 'Customer ID',
11    caption: 'Customer ID'
12  },
13  {
14    field: 'Product Name',
15    caption: 'Product Name'
16  },
17  {
18    field: 'Sales',
19    caption: 'Sales'
20  },
21  {
22    field: 'Profit',
23    caption: 'Profit'
24  }
25];
26
27const option = {
28  container: document.getElementById(CONTAINER_ID),
29  records: [
30    {
31      'Order ID': 'CA-2018-156720',
32      'Customer ID': 'JM-15580',
33      'Product Name': 'Bagged Rubber Bands',
34      Sales: '3.024',
35      Profit: '-0.605'
36    },
37    {
38      'Order ID': 'CA-2018-115427',
39      'Customer ID': 'EB-13975',
40      'Product Name': 'GBC Binding covers',
41      Sales: '20.72',
42      Profit: '6.475'
43    }
44    // ...
45  ],
46  columns
47};
48const tableInstance = new VTable.ListTable(option);

More demos and detailed tutorials

⌨️ Development

First of all, please install @microsoft/rush

1$ npm i --global @microsoft/rush

Then clone locally:

1# clone
2$ git clone git@github.com:VisActor/VTable.git
3$ cd VTable
4# install dependencies
5$ rush update
6# start vtable demo
7$ cd packages/vtable
8# execute in file path: ./packages/vtable
9$ rushx demo
10# start site development server, execute in file path: ./
11$ rush docs
12# after execut git commit, please run the following command to update the change log. Please execute in file path: ./
13$ rush change-all

📖 Documents

After installation & clone & update, run docs to preview VTable documents locally.

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

🔗 Related Links

• Official website
• Usage Trend

💫 Ecosystem

Project	Description
React-VTable	VTable in React component

⭐️ Star History

🤝 Contribution

If you would like to contribute, please read the Code of Conduct and Guide first。

Small streams converge to make great rivers and seas!

License

MIT License