Skip to content

Commit

Permalink
Feat: apply tui doc (#180)
Browse files Browse the repository at this point in the history
* chore: add react wrapper link on README.md

* feat: apply tut-doc

* chore: add comment for ES6 class detecting

* chore: update example page, README.md link
  • Loading branch information
한정 committed Feb 25, 2019
1 parent 7db8bef commit c64da8c
Show file tree
Hide file tree
Showing 75 changed files with 1,262 additions and 1,726 deletions.
13 changes: 7 additions & 6 deletions README.md
@@ -1,11 +1,12 @@
## ![Toast UI Chart](https://user-images.githubusercontent.com/35218826/37320160-c4d6dec4-26b5-11e8-9a91-79bb2b882410.png)
# ![Toast UI Chart](https://user-images.githubusercontent.com/35218826/37320160-c4d6dec4-26b5-11e8-9a91-79bb2b882410.png)

> 🍞📈 Spread your data on TOAST UI Chart. TOAST UI Chart is Beautiful Statistical Data Visualization library
[![GitHub release](https://img.shields.io/github/release/nhnent/tui.chart.svg)](https://github.com/nhnent/tui.chart/releases/latest) [![npm](https://img.shields.io/npm/v/tui-chart.svg)](https://www.npmjs.com/package/tui-chart) [![GitHub license](https://img.shields.io/github/license/nhnent/tui.chart.svg)](https://github.com/nhnent/tui.chart/blob/production/LICENSE) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhnent/tui.chart/pulls) [![code with hearth by NHN Entertainment](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN%20Entertainment-ff1414.svg)](https://github.com/nhnent)

## Wrappers
- [toast-ui.vue-chart](https://github.com/nhnent/toast-ui.vue-chart): Vue wrapper component is powered by [NHN Entertainment](https://github.com/nhnent).
- [toast-ui.react-chart](https://github.com/nhnent/toast-ui.react-chart): React wrapper component is powered by [NHN Entertainment](https://github.com/nhnent).

![chart_animation](https://user-images.githubusercontent.com/35218826/37018282-2a792584-2157-11e8-835f-fac1275d31e0.gif)
![all](https://user-images.githubusercontent.com/35218826/37026890-1e2bcfe0-2173-11e8-9b06-3db329d5f477.png)
Expand Down Expand Up @@ -90,11 +91,11 @@ With over 50 releases since June 2015 under MIT License, the TOAST UI Chart is t

The TOAST UI Chart provides many types of charts to visualize the various forms of data.

| [Bar](https://nhnent.github.io/tui.chart/latest/tutorial-example01-01-bar-chart-basic.html)<br>[Column](https://nhnent.github.io/tui.chart/latest/tutorial-example02-01-column-chart-basic.html) | [Line](https://nhnent.github.io/tui.chart/latest/tutorial-example03-01-line-chart-basic.html)<br>[Area](https://nhnent.github.io/tui.chart/latest/tutorial-example04-01-area-chart-basic.html)<br>[Radial](https://nhnent.github.io/tui.chart/latest/tutorial-example13-01-radial-chart-basic.html) | [Bubble](https://nhnent.github.io/tui.chart/latest/tutorial-example05-01-bubble-chart-basic.html)<br>[Scatter](https://nhnent.github.io/tui.chart/latest/tutorial-example06-01-scatter-chart-basic.html) | [Pie](https://nhnent.github.io/tui.chart/latest/tutorial-example07-01-pie-chart-basic.html)(General)<br>[Pie](https://nhnent.github.io/tui.chart/latest/tutorial-example07-04-pie-chart-donut.html)(Donut) |
| [Bar](https://nhnent.github.io/tui.chart/latest/tutorial-example01-01-bar-chart-basic)<br>[Column](https://nhnent.github.io/tui.chart/latest/tutorial-example02-01-column-chart-basic) | [Line](https://nhnent.github.io/tui.chart/latest/tutorial-example03-01-line-chart-basic)<br>[Area](https://nhnent.github.io/tui.chart/latest/tutorial-example04-01-area-chart-basic)<br>[Radial](https://nhnent.github.io/tui.chart/latest/tutorial-example13-01-radial-chart-basic) | [Bubble](https://nhnent.github.io/tui.chart/latest/tutorial-example05-01-bubble-chart-basic)<br>[Scatter](https://nhnent.github.io/tui.chart/latest/tutorial-example06-01-scatter-chart-basic) | [Pie](https://nhnent.github.io/tui.chart/latest/tutorial-example07-01-pie-chart-basic)(General)<br>[Pie](https://nhnent.github.io/tui.chart/latest/tutorial-example07-04-pie-chart-donut)(Donut) |
| --- | --- | --- | --- |
| ![2018-03-13 10 33 49](https://user-images.githubusercontent.com/35218826/37317756-151ad090-26aa-11e8-9fa0-74f9d1029bd9.png) | ![2018-03-13 10 44 51](https://user-images.githubusercontent.com/35218826/37318036-9770729c-26ab-11e8-9329-f30bb149e8e7.png) | ![2018-03-13 10 46 31](https://user-images.githubusercontent.com/35218826/37318092-d5c9737c-26ab-11e8-8975-dc6fb56fe99d.png) | ![2018-03-13 10 43 07](https://user-images.githubusercontent.com/35218826/37317996-60189a4a-26ab-11e8-9d5f-bcf5984ee971.png) |

| [Heatmap](https://nhnent.github.io/tui.chart/latest/tutorial-example10-01-heatmap-chart-basic.html)<br>[Treemap](https://nhnent.github.io/tui.chart/latest/tutorial-example11-01-treemap-chart-basic.html) | [Map](https://nhnent.github.io/tui.chart/latest/tutorial-example09-01-map-chart-world-map.html) | [Boxplot](https://nhnent.github.io/tui.chart/latest/tutorial-example14-01-boxplot-chart-basic.html) | [Bullet](https://nhnent.github.io/tui.chart/latest/tutorial-example15-01-bullet-chart-basic.html) |
| [Heatmap](https://nhnent.github.io/tui.chart/latest/tutorial-example10-01-heatmap-chart-basic)<br>[Treemap](https://nhnent.github.io/tui.chart/latest/tutorial-example11-01-treemap-chart-basic) | [Map](https://nhnent.github.io/tui.chart/latest/tutorial-example09-01-map-chart-world-map) | [Boxplot](https://nhnent.github.io/tui.chart/latest/tutorial-example14-01-boxplot-chart-basic) | [Bullet](https://nhnent.github.io/tui.chart/latest/tutorial-example15-01-bullet-chart-basic) |
| --- | --- | --- | --- |
| ![2018-03-13 10 47 56](https://user-images.githubusercontent.com/35218826/37318126-07ba5158-26ac-11e8-8a71-3737d2050412.png) | ![2018-03-13 10 51 01](https://user-images.githubusercontent.com/35218826/37318186-76c13c56-26ac-11e8-9e41-5c4ba1bce610.png) | ![2018-03-13 10 59 27](https://user-images.githubusercontent.com/35218826/37318409-a5b03426-26ad-11e8-958f-b497fad5492b.png) | ![2018-03-13 11 01 46](https://user-images.githubusercontent.com/35218826/37318459-f4c7b35e-26ad-11e8-942b-6de4f7f2bb4c.png) |

Expand All @@ -104,7 +105,7 @@ The TOAST UI Chart provides many types of charts to visualize the various forms

The TOAST UI Chart covers complex data visualization.

| [Column-Line](https://nhnent.github.io/tui.chart/latest/tutorial-example08-01-combo-chart-column-and-line.html) | [Pie-Donut](https://nhnent.github.io/tui.chart/latest/tutorial-example08-02-combo-chart-pie-and-donut.html) | [Line-Area](https://nhnent.github.io/tui.chart/latest/tutorial-example08-03-combo-chart-line-and-area.html) | [Line-Scatter](https://nhnent.github.io/tui.chart/latest/tutorial-example08-04-combo-chart-line-and-scatter.html) |
| [Column-Line](https://nhnent.github.io/tui.chart/latest/tutorial-example08-01-combo-chart-column-and-line) | [Pie-Donut](https://nhnent.github.io/tui.chart/latest/tutorial-example08-02-combo-chart-pie-and-donut) | [Line-Area](https://nhnent.github.io/tui.chart/latest/tutorial-example08-03-combo-chart-line-and-area) | [Line-Scatter](https://nhnent.github.io/tui.chart/latest/tutorial-example08-04-combo-chart-line-and-scatter) |
| --- | --- | --- | --- |
| ![2018-03-13 11 04 48](https://user-images.githubusercontent.com/35218826/37318532-63adea7c-26ae-11e8-9033-d24f7379a0be.png) | ![2018-03-13 11 06 16](https://user-images.githubusercontent.com/35218826/37318577-980a1a3e-26ae-11e8-87d4-ff6d015839b7.png) | ![2018-03-13 11 07 44](https://user-images.githubusercontent.com/35218826/37318606-cbbf59d4-26ae-11e8-8ec8-9766279346cc.png) | ![2018-03-13 11 19 42](https://user-images.githubusercontent.com/35218826/37318993-80728378-26b0-11e8-929e-389995fd9694.png) |

Expand All @@ -120,11 +121,11 @@ Visualize the data in different styles by customizing the details of the charts.
### And More From Examples

* [Load Data from a table](https://github.com/nhnent/tui.chart/blob/production/docs/wiki/import-chart-data-from-existing-table-element.md)
* [Add data dynamically](https://nhnent.github.io/tui.chart/latest/tutorial-example12-01-dynamic-chart-append-and-shift-data-dynamically.html)
* [Add data dynamically](https://nhnent.github.io/tui.chart/latest/tutorial-example12-01-dynamic-chart-append-and-shift-data-dynamically)
* [Apply themes](https://github.com/nhnent/tui.chart/blob/production/docs/wiki/theme.md)
* [Map Data Attribution](https://www.amcharts.com/svg-maps/)

Check out [Example](https://nhnent.github.io/tui.chart/latest/tutorial-example01-01-bar-chart-basic.html) and [wiki](https://github.com/nhnent/tui.chart/tree/production/docs/wiki#tutorial) to discover more.
Check out [Example](https://nhnent.github.io/tui.chart/latest/tutorial-example01-01-bar-chart-basic) and [wiki](https://github.com/nhnent/tui.chart/tree/production/docs/wiki#tutorial) to discover more.

## 💾 Install

Expand Down
33 changes: 28 additions & 5 deletions examples/css/example.css
Expand Up @@ -7,21 +7,21 @@ body > div {
float: left;
}
.custom-area {
margin-top: 5px;
width: 650px;
position:relative;
padding: 0 52px;
}

.apply-btn-area {
width: 100%;
height: 35px;
position: relative;
text-align: right;
}

.apply-btn-area .btn {
font-weight: bold;
font-size: 14px;
margin: 5px 0 0 0;
margin: 5px 0 0;
border: 1px solid #ccc;
cursor: pointer;
}

.custom-area > div {
Expand Down Expand Up @@ -83,3 +83,26 @@ div#error-dim.show {
div#go-to-dev-tool {

}

/* tui-example-style */
body {
margin: 0;
padding: 0;
}

.code-description {
padding: 22px 52px;
background-color: rgba(81, 92, 230, 0.1);
line-height: 1.4em;
}

.code-description,
.code-description a {
font-family: Arial;
font-size: 14px;
color: #515ce6;
}

.code-html {
padding: 20px 52px;
}
45 changes: 23 additions & 22 deletions examples/example01-01-bar-chart-basic.html
Expand Up @@ -5,31 +5,32 @@
<meta http-equiv='X-UA-Compatible' content='IE=Edge'/>
<title>1.1 [Bar Chart] basic</title>
<link rel='stylesheet' type='text/css' href='../dist/tui-chart.css'/>
<link rel='stylesheet' type='text/css' href='../node_modules/codemirror/lib/codemirror.css'/>
<link rel='stylesheet' type='text/css' href='../node_modules/codemirror/addon/lint/lint.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/codemirror.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/lint.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/theme/neo.css'/>
<link rel='stylesheet' type='text/css' href='./css/example.css'/>
</head>
<body>
<div class='wrap'>
<div class='code-html' id='code-html'>
<div id='chart-area'></div>
</div>
</div>
<div class='custom-area'>
<div id='error-dim'>
<span id='error-text'></span>
<div id='error-stack'></div>
<span id='go-to-dev-tool'>For more detail, open browser's developer tool and check it out.</span>
</div>
<div style='border: 0.2px solid #aaa;'>
<textarea id='code'></textarea>
</div>

<div class='apply-btn-area' style='width: 600px;'>
<button class="btn" style='position: absolute; right: 0px;' onclick='evaluationCode(chartCM, codeString);'>Run it!</button>
<button class="btn" onclick="window.open('https://github.com/nhnent/tui.chart/wiki/theme')">More Theme</button>
<div class='custom-area'>
<div id='error-dim'>
<span id='error-text'></span>
<div id='error-stack'></div>
<span id='go-to-dev-tool'>For more detail, open browser's developer tool and check it out.</span>
</div>
<div class="try-it-area">
<h3>try it</h3>
<textarea id="code"></textarea>
<div class="apply-btn-area">
<button class="btn" onclick='evaluationCode(chartCM, codeString);'>Run it!</button>
</div>
</div>
</div>
</div>

<!--Import chart.js and dependencies-->
<script type='text/javascript' src='https://cdnjs.cloudflare.com/ajax/libs/core-js/2.5.7/core.js'></script>
<script type='text/javascript' src='https://uicdn.toast.com/tui.code-snippet/v1.5.0/tui-code-snippet.min.js'></script>
Expand Down Expand Up @@ -89,12 +90,12 @@

<!--For tutorial page-->
<script src='//ajax.aspnetcdn.com/ajax/jshint/r07/jshint.js'></script>
<script src='../node_modules/codemirror/lib/codemirror.js'></script>
<script src='../node_modules/codemirror/addon/edit/matchbrackets.js'></script>
<script src='../node_modules/codemirror/addon/selection/active-line.js'></script>
<script src='../node_modules/codemirror/mode/javascript/javascript.js'></script>
<script src='../node_modules/codemirror/addon/lint/lint.js'></script>
<script src='../node_modules/codemirror/addon/lint/javascript-lint.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/codemirror.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/edit/matchbrackets.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/selection/active-line.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/mode/javascript/javascript.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/lint.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/javascript-lint.js'></script>
<script src='./js/example.js'></script>
</body>
</html>
43 changes: 22 additions & 21 deletions examples/example01-02-bar-chart-negative-data.html
Expand Up @@ -5,28 +5,29 @@
<meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
<title>1.2 [Bar Chart] negative data</title>
<link rel="stylesheet" type="text/css" href="../dist/tui-chart.css" />
<link rel='stylesheet' type='text/css' href='../node_modules/codemirror/lib/codemirror.css'/>
<link rel='stylesheet' type='text/css' href='../node_modules/codemirror/addon/lint/lint.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/codemirror.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/lint.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/theme/neo.css'/>
<link rel="stylesheet" type="text/css" href="./css/example.css" />
</head>
<body>
<div class='wrap'>
<div class='code-html' id='code-html'>
<div id='chart-area'></div>
</div>
</div>
<div class="custom-area">
<div id='error-dim'>
<span id='error-text'></span>
<div id='error-stack'></div>
<span id='go-to-dev-tool'>For more detail, open browser's developer tool and check it out.</span>
</div>
<div style='border: 0.2px solid #aaa;'>
<textarea id="code"></textarea>
</div>
<div class='apply-btn-area' style='width: 600px;'>
<button class="btn" style='position: absolute; right: 0px;' onclick='evaluationCode(chartCM, codeString);'>Run it!</button>
<button class="btn" onclick="window.open('https://github.com/nhnent/tui.chart/wiki/theme')">More Theme</button>
<div class='custom-area'>
<div id='error-dim'>
<span id='error-text'></span>
<div id='error-stack'></div>
<span id='go-to-dev-tool'>For more detail, open browser's developer tool and check it out.</span>
</div>
<div class="try-it-area">
<h3>try it</h3>
<textarea id="code"></textarea>
<div class="apply-btn-area">
<button class="btn" onclick='evaluationCode(chartCM, codeString);'>Run it!</button>
</div>
</div>
</div>
</div>
<!--Import chart.js and dependencies-->
Expand Down Expand Up @@ -90,13 +91,13 @@
</script>

<!--For tutorial page-->
<script src='../node_modules/codemirror/lib/codemirror.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/codemirror.js'></script>
<script src='//ajax.aspnetcdn.com/ajax/jshint/r07/jshint.js'></script>
<script src='../node_modules/codemirror/addon/edit/matchbrackets.js'></script>
<script src='../node_modules/codemirror/addon/selection/active-line.js'></script>
<script src='../node_modules/codemirror/mode/javascript/javascript.js'></script>
<script src='../node_modules/codemirror/addon/lint/lint.js'></script>
<script src='../node_modules/codemirror/addon/lint/javascript-lint.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/edit/matchbrackets.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/selection/active-line.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/mode/javascript/javascript.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/lint.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/javascript-lint.js'></script>
<script src="./js/example.js"></script>
</body>
</html>
43 changes: 22 additions & 21 deletions examples/example01-03-bar-chart-normal-stack.html
Expand Up @@ -5,28 +5,29 @@
<meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
<title>1.3 [Bar Chart] normal stack</title>
<link rel="stylesheet" type="text/css" href="../dist/tui-chart.css" />
<link rel='stylesheet' type='text/css' href='../node_modules/codemirror/lib/codemirror.css'/>
<link rel='stylesheet' type='text/css' href='../node_modules/codemirror/addon/lint/lint.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/codemirror.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/lint.css'/>
<link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/theme/neo.css'/>
<link rel="stylesheet" type="text/css" href="./css/example.css" />
</head>
<body>
<div class='wrap'>
<div class='code-html' id='code-html'>
<div id='chart-area'></div>
</div>
</div>
<div class="custom-area">
<div id='error-dim'>
<span id='error-text'></span>
<div id='error-stack'></div>
<span id='go-to-dev-tool'>For more detail, open browser's developer tool and check it out.</span>
</div>
<div style='border: 0.2px solid #aaa;'>
<textarea id='code'></textarea>
</div>
<div class='apply-btn-area' style='width: 600px;'>
<button class="btn" style='position: absolute; right: 0px;' onclick='evaluationCode(chartCM, codeString);'>Run it!</button>
<button class="btn" onclick="window.open('https://github.com/nhnent/tui.chart/wiki/theme')">More Theme</button>
<div class='custom-area'>
<div id='error-dim'>
<span id='error-text'></span>
<div id='error-stack'></div>
<span id='go-to-dev-tool'>For more detail, open browser's developer tool and check it out.</span>
</div>
<div class="try-it-area">
<h3>try it</h3>
<textarea id="code"></textarea>
<div class="apply-btn-area">
<button class="btn" onclick='evaluationCode(chartCM, codeString);'>Run it!</button>
</div>
</div>
</div>
</div>
<!--Import chart.js and dependencies-->
Expand Down Expand Up @@ -92,13 +93,13 @@
tui.chart.barChart(container, data, options);
</script>
<!--For tutorial page-->
<script src='../node_modules/codemirror/lib/codemirror.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/codemirror.js'></script>
<script src='//ajax.aspnetcdn.com/ajax/jshint/r07/jshint.js'></script>
<script src='../node_modules/codemirror/addon/edit/matchbrackets.js'></script>
<script src='../node_modules/codemirror/addon/selection/active-line.js'></script>
<script src='../node_modules/codemirror/mode/javascript/javascript.js'></script>
<script src='../node_modules/codemirror/addon/lint/lint.js'></script>
<script src='../node_modules/codemirror/addon/lint/javascript-lint.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/edit/matchbrackets.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/selection/active-line.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/mode/javascript/javascript.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/lint.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.43.0/addon/lint/javascript-lint.js'></script>
<script src='./js/example.js'></script>
</body>
</html>

0 comments on commit c64da8c

Please sign in to comment.