roughViz 项目教程
2024-09-07 06:51:36作者:何举烈Damon
roughViz
Reusable JavaScript library for creating sketchy/hand-drawn styled charts in the browser.
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: 开发依赖项,包含了项目开发过程中需要用到的工具和库。
通过以上内容,您可以了解 roughViz 项目的目录结构、启动文件和配置文件的基本信息。
roughViz
Reusable JavaScript library for creating sketchy/hand-drawn styled charts in the browser.
热门项目推荐
相关项目推荐
- CangjieCommunity为仓颉编程语言开发者打造活跃、开放、高质量的社区环境Markdown6710
- redis-sdk仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。Cangjie32226
- Yi-CoderYi Coder 编程模型,小而强大的编程助手305
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTypeScript15.77 K1.48 K
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript76.1 K19.07 K
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript35.52 K4.79 K
- CommunityCangjie-TPC(Third Party Components)仓颉编程语言三方库社区资源汇总252
- Wwindows暂无简介Shell16.14 K1.35 K
- byzer-langByzer(以前的 MLSQL):一种用于数据管道、分析和人工智能的低代码开源编程语言。Scala1.88 K551
- AanacondaAnaconda turns your Sublime Text 3 in a full featured Python development IDE including autocompletion, code linting, IDE features, autopep8 formating, McCabe complexity checker Vagrant and Docker support for Sublime Text 3 using Jedi, PyFlakes, pep8, MyPy, PyLint, pep257 and McCabe that will never freeze your Sublime Text 3Python2.22 K263
热门内容推荐
展开
最新内容推荐
展开
项目优选
收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
12
7
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K