/
index.html
95 lines (93 loc) · 4.71 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="Content-Type" name="viewport" content="width=device-width, initial-scale=1"/>
<title>d2recharts</title>
<link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/lib/normalize-4.2.0.min.css">
<link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/lib/github-markdown-2.3.0.min.css">
<link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/zfinder/markdown-previewer.css">
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1"
style="width:0;height:0;position:absolute;overflow:hidden;">
<defs>
<symbol id="si-zfinder-collapse-left" viewBox="0 0 38 38">
<path d="M38 0H0v38h38V0zM3 35V3h32v32H3zM5 5v28h17V21h-9.667L16 26h-4l-5-7 5-7h4l-3.667 5H22V5H5z"/>
</symbol>
<symbol id="si-zfinder-expand-right" viewBox="0 0 38 38">
<path d="M0 0h38v38H0V0zm35 35V3H3v32h32zM22 5v28H5V21h9.667L11 26h4l5-7-5-7h-4l3.667 5H5V5h17z"/>
</symbol>
<symbol id="si-zfinder-fullscreen" viewBox="0 0 28 28">
<path d="M4 18H0v10h10v-4H4v-6zm-4-8h4V4h6V0H0v10zm24 14h-6v4h10V18h-4v6zM18 0v4h6v6h4V0H18z"/>
</symbol>
<symbol id="si-zfinder-fullscreen-exit" viewBox="0 0 28 28">
<path d="M0 22h6v6h4V18H0v4zM6 6H0v4h10V0H6v6zm12 22h4v-6h6v-4H18v10zm4-22V0h-4v10h10V6h-6z"/>
</symbol>
</defs>
</svg>
<nav id="toc">
<div id="toc-body" class="toc-body"></div>
</nav>
<article id="markdown">
<nav id="markdown-header" class="markdown-header">
<svg class="si" id="toggle-toc" width="24" height="24">
<use xlink:href="#si-zfinder-collapse-left"></use>
</svg>
<svg class="si float-right" id="toggle-fullscreen-article" width="24" height="24">
<use xlink:href="#si-zfinder-fullscreen"></use>
</svg>
</nav>
<div id="markdown-body" class="markdown-body"><h1>d2recharts</h1>
<p><strong>Data Driven</strong> echarts wrapped as react components.</p>
<h2>what?</h2>
<figure><img src="doc/data-flow.png" alt="data-flow"></figure>
<h2>Why?</h2>
<p>To make the path from data to chart shorter.</p>
<h2>Install</h2>
<pre><code class="language-shell">npm i d2recharts --save
</code></pre>
<h2>Usage</h2>
<p>A typical use case is like:</p>
<pre><code class="language-jsx"><D2Pie
name=<span class="hljs-string">"访问来源"</span>
tooltip=<span class="hljs-string">"true"</span>
legend=<span class="hljs-string">"true"</span>
data={[
{<span class="hljs-attr">value</span>:<span class="hljs-number">335</span>, <span class="hljs-attr">name</span>:<span class="hljs-string">'直接访问'</span>},
{<span class="hljs-attr">value</span>:<span class="hljs-number">310</span>, <span class="hljs-attr">name</span>:<span class="hljs-string">'邮件营销'</span>},
{<span class="hljs-attr">value</span>:<span class="hljs-number">234</span>, <span class="hljs-attr">name</span>:<span class="hljs-string">'联盟广告'</span>},
{<span class="hljs-attr">value</span>:<span class="hljs-number">135</span>, <span class="hljs-attr">name</span>:<span class="hljs-string">'视频广告'</span>},
{<span class="hljs-attr">value</span>:<span class="hljs-number">1548</span>, <span class="hljs-attr">name</span>:<span class="hljs-string">'搜索引擎'</span>}
]}
/>
</code></pre>
<p>Simplest use case:</p>
<pre><code class="language-jsx"><span class="hljs-keyword">const</span> data = [
<span class="hljs-comment">// data goes here</span>
];
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">D2RechartsSmart</span> <span class="hljs-attr">data</span>=<span class="hljs-string">{data}</span> /></span>
</span></code></pre>
<p>If you want fully functionality of echarts:</p>
<pre><code class="language-jsx"><span class="hljs-keyword">const</span> option = {
<span class="hljs-comment">// echarts option goes here</span>
};
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">D2Recharts</span> <span class="hljs-attr">option</span>=<span class="hljs-string">{option}</span> /></span>
</span></code></pre>
<h2><a href="./demo">Demo</a></h2>
<h2><a href="./doc/api.html">API</a></h2>
<h2><a href="./doc/roadmap.html">Roadmap</a></h2>
<h2><a href="./doc/contributing.html">Contributing</a></h2>
</div>
</article>
<div id="loading">
<div class="sk-double-bounce">
<div class="sk-child sk-double-bounce1"></div>
<div class="sk-child sk-double-bounce2"></div>
</div>
</div>
<script src="https://leungwensen.github.io/zfinder/dist/lib/jquery-3.1.0.min.js"></script>
<script src="https://leungwensen.github.io/zfinder/dist/lib/screenfull-3.0.0.min.js"></script>
<script src="https://leungwensen.github.io/zfinder/dist/zfinder/markdown-previewer.js"></script>
</body>
</html>