VChart/packages/vmind
2023-11-10 10:14:38 +00:00
..
__tests__ feat: manage the structure of vmind package 2023-10-31 21:19:13 +08:00
docs feat: vmind package 2023-10-26 19:05:55 +08:00
src fix: axios代替fetch 2023-11-07 10:35:49 +08:00
.eslintrc.cjs feat: manage the structure of vmind package 2023-10-31 21:19:13 +08:00
bundler.config.js fix: fix the json import for vmind 2023-11-07 10:35:51 +08:00
jest.config.js feat: manage the structure of vmind package 2023-10-31 21:19:13 +08:00
package.json build: prelease version 1.6.3 2023-11-10 10:14:38 +00:00
readme-zh.md typo: fix typo of typo 2023-10-30 15:49:31 +08:00
README.md typo: fix typo package name with capital VMind 2023-10-30 15:12:04 +08:00
tsconfig.eslint.json feat: manage the structure of vmind package 2023-10-31 21:19:13 +08:00
tsconfig.json feat: manage the structure of vmind package 2023-10-31 21:19:13 +08:00
tsconfig.test.json feat: manage the structure of vmind package 2023-10-31 21:19:13 +08:00

@visactor/vmind

English | 简体中文

@visactor/vmind is an intelligent chart component based on large models provided by VisActor, including dialog-based chart generation and editing capabilities. It provides a natural language interaction interface, allowing you to easily create chart narrative works with @visactor/VMind with just one sentence, and edit them through continuous dialogue, greatly improving your efficiency in creating data visualization works.

The main features of @visactor/vmind include:

  • Easy to use: Just provide the data you want to display and a sentence describing the information you want to display, and @visactor/vmind will automatically generate the chart for you. Based on the existing chart, describe the modifications you want to make to the chart in one sentence, and @visactor/VMind will help you achieve the desired effect.
  • Strong scalability: The components of @visactor/VMind can be easily extended and customized, and new functions and features can be added as needed. By default, the OpenAI GPT model is used, and you can easily replace it with any text large model.
  • Easy narrative: Based on the powerful chart narrative ability of @visactor/vchart, @visactor/VMind supports the generation of various types of charts, including line charts, bar charts, pie charts, etc., and can also generate dynamic bar charts and other dynamic charts, making it easy for you to narrate data. More chart types are being added. You can also use the dialog-based editing function to easily modify chart styles and animation effects, making it easy for you to create narratives.
  • One-click export: @visactor/VMind comes with a chart export module, and you can export the created chart narrative as a video or GIF for display.

Instructions for use

📦 Installation

# npm
$ npm install @visactor/vmind

# yarn
$ yarn add @visactor/vmind

📊 Usage example

Intelligent chart generation

import VMind from '@visactor/vmind'

const vmind = new VMind(openAIKey) //Pass in your openAI key

const { spec, time } = await (vmind.generateChart(csv, describe)); //Intelligent chart generation, pass in your csv format data and chart description, and return the chart spec and chart animation duration

Chart export

//Export video
const src = await vmind.exportVideo(spec, time); //Pass in the chart spec and video duration, and return ObjectURL
//Export GIF image
const src = await vmind.exportGIF(spec, time); //Pass in the chart spec and GIF duration, and return ObjectURL

Dialog-based editing

Under development, stay tuned

Effect display

Dynamic bar chart

Alt text

Bar chart

Alt text

Pie chart

Alt text