AntV Infographic
Home
Learn
Reference
Gallery
Icon
Editor
AI
Enterprise

目录

  • Overview
  • 目录结构
  • 主要功能模块
  • 快速开发
  • 提交 PR
  • 开源计划
  • 快速开始
    • 入门指南
    • 信息图语法
  • 核心概念
    • 设计
    • 模版
    • 数据
    • 主题
    • 编辑器
    • 资源
  • 自定义设计
    • 自定义结构
    • 自定义数据项
    • 自定义模版
    • 自定义主题
    • 自定义色板
    • 自定义字体
    • 自定义资源加载器
    • 自定义图案
  • 信息图理论
    • 信息图分类
    • 核心理论
    • 信息图构成要素
    • 信息图设计
  • 参与贡献
文档

项目介绍

AntV Infographic 的源代码托管在 GitHub,npm 包发布在 npm。本页帮助你快速熟悉仓库结构和核心模块,方便上手开发与贡献。

目录结构

主要目录及用途:

TEXT
. ├── __tests__ 单元与工具测试 ├── dev 开发环境与调试 └── src ├── constants 常量定义 ├── designs 设计资产(结构、数据项、布局、组件、装饰、标题等) ├── jsx JSX 引擎(原语组件、类型、布局与渲染) ├── options 信息图语法定义与解析 ├── editor 编辑器(插件、交互、命令、状态管理) ├── renderer 核心渲染器与风格化能力 ├── resource 资源加载体系 ├── runtime 运行时逻辑 ├── templates 模板注册 ├── themes 主题配置 ├── types 通用类型 └── utils 工具函数

主要功能模块

  • JSX 引擎:在不依赖 React 的情况下解析 JSX,输出 SVG。
  • 设计资产:结构、数据项、装饰等视觉积木的实现集合。
  • 语法解析:解析信息图语法,组合出可复用的模板。
  • 编辑器:交互式修改画布元素的能力,包含插件体系、交互与命令/状态管理。
  • 渲染器:将模板与数据渲染为最终 SVG 输出,并支持导出。
  • 风格化:提供手绘、纹理等多种风格化效果。
  • 资源加载:加载外部图标、插图等资源,并提供自定义扩展。

快速开发

  1. 克隆代码:
BASH
git clone git@github.com:antvis/infographic.git
  1. 安装依赖:
BASH
cd infographic npm install cd dev npm install
  1. 启动开发环境:
BASH
# 位于 dev 目录下运行 npm run dev

提交 PR

欢迎任何形式的贡献——修复 bug、补充文档、添加功能都很宝贵。

  1. 创建分支:
BASH
git checkout -b feature/your-feature-name
  1. 提交更改:
BASH
git commit -m "Add your feature description"
  1. 推送分支:
BASH
git push origin feature/your-feature-name
  1. 创建 Pull Request:

在 GitHub 提交 Pull Request,并简要说明变更目的和影响。

开源计划

AntV Infographic 将持续开放更多能力,欢迎社区参与共建。下面是下一阶段的开源计划:

open source plan
Previous信息图设计

AntV Infographic
Copyright © Ant Group Co.
Docs
Quick Start
Core Concepts
Custom Design
Infographic Theory
API Reference
JSX
API
Design Assets
More
More Examples
AI Generated Infographics
GitHub
Contribute
Friendly Links
AntV
G2
G6
L7
TEXT
.
├── __tests__ 单元与工具测试
├── dev 开发环境与调试
└── src
├── constants 常量定义
├── designs 设计资产(结构、数据项、布局、组件、装饰、标题等)
├── jsx JSX 引擎(原语组件、类型、布局与渲染)
├── options 信息图语法定义与解析
├── editor 编辑器(插件、交互、命令、状态管理)
├── renderer 核心渲染器与风格化能力
├── resource 资源加载体系
├── runtime 运行时逻辑
├── templates 模板注册
├── themes 主题配置
├── types 通用类型
└── utils 工具函数
BASH
git clone git@github.com:antvis/infographic.git
BASH
cd infographic
npm install
cd dev
npm install
BASH
# 位于 dev 目录下运行
npm run dev
BASH
git checkout -b feature/your-feature-name
BASH
git commit -m "Add your feature description"
BASH
git push origin feature/your-feature-name