roughViz 项目教程

2024-09-07 15:19:25作者：何举烈Damon

1. 项目的目录结构及介绍

roughViz 项目的目录结构如下：

roughViz/
├── dist/
│   ├── roughViz.min.js
│   └── roughViz.min.js.map
├── examples/
│   ├── bar.html
│   ├── donut.html
│   └── ...
├── src/
│   ├── bar.js
│   ├── donut.js
│   └── ...
├── package.json
├── README.md
└── ...

目录结构介绍

dist/: 该目录包含项目的打包文件，包括 roughViz.min.js 和 roughViz.min.js.map，这些文件是项目的核心库文件，用于在浏览器中加载和使用 roughViz。
examples/: 该目录包含多个示例文件，每个文件展示了如何使用 roughViz 创建不同类型的图表。例如 bar.html 展示了如何创建条形图，donut.html 展示了如何创建圆环图。
src/: 该目录包含项目的源代码文件，每个文件对应一个图表类型。例如 bar.js 是条形图的实现代码，donut.js 是圆环图的实现代码。
package.json: 该文件是项目的配置文件，包含了项目的依赖、脚本命令等信息。
README.md: 该文件是项目的说明文档，包含了项目的介绍、安装方法、使用示例等内容。

2. 项目的启动文件介绍

roughViz 项目的启动文件主要是 dist/roughViz.min.js。该文件是项目的核心库文件，包含了所有图表类型的实现代码。用户可以通过在 HTML 文件中引入该文件来使用 roughViz 创建图表。

使用示例

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>roughViz Example</title>
    <script src="https://unpkg.com/rough-viz@2.0.5"></script>
</head>
<body>
    <div id="viz0" style="width: 500px; height: 500px;"></div>
    <script>
        new roughViz.Bar({
            element: '#viz0',
            data: {
                labels: ['North', 'South', 'East', 'West'],
                values: [10, 5, 8, 3]
            },
            title: "Regions",
            roughness: 8,
            colors: ['red', 'orange', 'blue', 'skyblue'],
            stroke: 'black'
        });
    </script>
</body>
</html>

3. 项目的配置文件介绍

roughViz 项目的主要配置文件是 package.json。该文件包含了项目的元数据、依赖项、脚本命令等信息。

package.json 内容示例

{
  "name": "rough-viz",
  "version": "2.0.5",
  "description": "Reusable JavaScript library for creating sketchy/hand-drawn styled charts in the browser.",
  "main": "dist/roughViz.min.js",
  "scripts": {
    "build": "rollup -c",
    "watch": "rollup -c -w",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/jwilber/roughViz.git"
  },
  "keywords": [
    "chart",
    "sketchy",
    "hand-drawn",
    "rough",
    "viz"
  ],
  "author": "Jared Wilber",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/jwilber/roughViz/issues"
  },
  "homepage": "https://github.com/jwilber/roughViz#readme",
  "devDependencies": {
    "rollup": "^2.3.4",
    "rollup-plugin-terser": "^7.0.0"
  }
}

配置文件介绍

name: 项目的名称，这里是 rough-viz。
version: 项目的版本号，这里是 2.0.5。
description: 项目的描述，介绍了项目的主要功能。
main: 项目的入口文件，这里是 dist/roughViz.min.js。
scripts: 包含了一些常用的脚本命令，例如 build 用于构建项目，watch 用于监视文件变化并自动构建，test 用于运行测试。
repository: 项目的代码仓库地址。
keywords: 项目的关键词，用于描述项目的特性。
author: 项目的作者。
license: 项目的开源许可证，这里是 MIT 许可证。
devDependencies: 开发依赖项，包含了项目开发过程中需要用到的工具和库。