S2/README.en-US.md at master · antvis/S2 · GitHub

1 year ago

source link: https://github.com/antvis/S2/blob/master/README.en-US.md
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

简体中文｜ English

A practical visualization library for tabular analysis.

S2 is a solution in multi-dimensional cross-analysis tables, which provides data-driven analysis table components. It supplements multi-dimensional analysis tables in the industry. By providing the core library, essential components, demo components and expansion capabilities, it allows developers to use it quickly and freely.

Homepage

Features

Multi-dimensional cross-analysis: Say goodbye to a single analysis dimension and fully embrace the free combination analysis of any dimension.
High performance: It can support rendering in less than 8s under the total amount of millions of data and achieve second-level rendering through partial drilling.
High scalability: Support any custom extensions (including but not limited to layout, style, interaction, data hook flow, etc.).
Out of the box: Provide out-of-the-box React and Vue3 table components and supporting analysis components in different analysis scenarios. You only need a simple configuration to realize the table rendering of complex scenes quickly.
High interaction: support rich interaction forms (single selection, circle selection, row selection, column selection, freeze line header, width and height dragging, custom interaction, etc.)

Installation

$ npm install @antv/s2
# yarn add @antv/s2

Getting Started

1. Data Preparation

s2DataConfig

2. Options Preparation

const s2Options = {
  width: 600,
  height: 600,
}

3. Component Rendering

<div id="container"></div>

import { PivotSheet } from '@antv/s2';

const container = document.getElementById('container');

const s2 = new PivotSheet(container, s2DataCfg, s2Options);

s2.render();

4. Preview

Packages

Author

@AntV

Contributing

Contributions, issues and feature requests are welcome. Feel free to check issues page if you want to contribute.

git clone [email protected]:antvis/S2.git

cd S2

yarn # or yarn bootstrap

# build all
yarn build

# debug s2-core
yarn core:start

# debug s2-react
yarn react:playground

# debug s2-vue
yarn vue:playground

# unit test
yarn test

# check the code style and the type definition
yarn lint

# start the website
yarn site:bootstrap
yarn site:start