Skip to content

Commit e8fb170

Browse files
authored
Merge branch 'master' into master
2 parents 7ac9e16 + f9ec847 commit e8fb170

4 files changed

Lines changed: 45 additions & 42 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
v1.0.0 - March 11, 2019
22

3-
* Deploy: v1.0.0 (Mohammed Odunayo)
3+
* [545e717](https://github.com/factman/GraphUI/tree/545e717eccef534fdd14f137be25e361c8522a9e) Deploy: v1.0.0 (Mohammed Odunayo)
44
* Start development of 1.0.0 (Mohammed Odunayo)

README.md

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# GraphUI
1+
# Welcome to the GraphUI
22

33
[![NPM version][GraphUI-image]](https://github.com/factman/GraphUI#readme)
44
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ffactman%2FGraphUI.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Ffactman%2FGraphUI?ref=badge_shield)
55

6-
[Website](https://github.com/factman/GraphUI#readme) |
7-
[Installation](https://github.com/factman/GraphUI#installation) |
8-
[Usage](https://github.com/factman/GraphUI#usage) |
9-
[Live Demo](https://github.com/factman/GraphUI#live-demo) |
10-
[Options](https://github.com/factman/GraphUI#options) |
11-
[Team](https://github.com/factman/GraphUI#team) |
12-
[Sponsor](https://github.com/factman/GraphUI#sponsor)
6+
[Website](https://factman.github.io/GraphUI/) |
7+
[Installation](#installation) |
8+
[Usage](#usage) |
9+
[Live Demo](https://factman.github.io/GraphUI/docs/) |
10+
[Options](#options) |
11+
[Team](#team) |
12+
[Sponsor](#sponsor)
1313

1414
GraphUI is a JavaScript extension for plotting graphs for any website project.
1515

@@ -43,7 +43,7 @@ git clone https://github.com/factman/GraphUI.git
4343
Install from NPM:
4444

4545
```bash
46-
npm install graph-ui
46+
npm install @factman/graph-ui
4747
```
4848

4949
Note: use the CSS and JS files in the `dist` folder.
@@ -92,12 +92,12 @@ Initialize GraphUI in a JavaScript file or within a `<script>` tag below GraphUI
9292
</script>
9393
```
9494

95-
Option `elementId` is optional if you used the default `#id` `"graph"` read more about GraphUI [Options](https://github.com/factman/GraphUI#options)
95+
Option `elementId` is optional if you used the default `#id` `"graph"` read more about GraphUI [Options](#options)
9696

9797
## Live Demo
9898

9999
View
100-
[Live Demo](https://github.com/factman/GraphUI#live-demo)
100+
[Live Demo](https://factman.github.io/GraphUI/docs/)
101101
and examples.
102102

103103
## Options
@@ -113,7 +113,7 @@ and examples.
113113
</thead>
114114
<tbody>
115115
<tr>
116-
<th>data</th>
116+
<td>data</td>
117117
<td>
118118
{}<small>(required)</small>
119119
</td>
@@ -130,127 +130,127 @@ and examples.
130130
</td>
131131
</tr>
132132
<tr>
133-
<th>elementId</th>
133+
<td>elementId</td>
134134
<td>"graph"</td>
135135
<td>{elementId: "graphId"}</td>
136136
<td>Element #id to plot the graph.</td>
137137
</tr>
138138
<tr>
139-
<th>height</th>
139+
<td>height</td>
140140
<td>300</td>
141141
<td>{height: 300}</td>
142142
<td>Height of the graph in px.</td>
143143
</tr>
144144
<tr>
145-
<th>backgroundColor</th>
145+
<td>backgroundColor</td>
146146
<td>"#111111"</td>
147147
<td>{backgroundColor: "#111111"}</td>
148148
<td>Background color of the graph in as (<b>Hex</b>: "#111111" or <b>Color Name</b>: "darkblue" or <b>RGB|RGBA</b>: "rgba(0,0,0,0.5)").</td>
149149
</tr>
150150
<tr>
151-
<th>gridColor</th>
151+
<td>gridColor</td>
152152
<td>"rgba(255,255,255,0.1)"</td>
153153
<td>{gridColor: "rgba(255,255,255,0.1)"}</td>
154154
<td>Color for the grid lines in the graph.</td>
155155
</tr>
156156
<tr>
157-
<th>textColor</th>
157+
<td>textColor</td>
158158
<td>"rgba(255,255,255,0.8)"</td>
159159
<td>{textColor: "rgba(255,255,255,0.8)"}</td>
160160
<td>Color for the texts in the graph.</td>
161161
</tr>
162162
<tr>
163-
<th>lineColor</th>
163+
<td>lineColor</td>
164164
<td>"rgb(255,255,255)"</td>
165165
<td>{lineColor: "rgb(255,255,255)"}</td>
166166
<td>Color for the plotted line in the graph.</td>
167167
</tr>
168168
<tr>
169-
<th>nodeColor</th>
169+
<td>nodeColor</td>
170170
<td>{backgroundColor}</td>
171171
<td>{nodeColor: "black"}</td>
172172
<td>Color for each node on the plotted line in the graph.</td>
173173
</tr>
174174
<tr>
175-
<th>nodeStroke</th>
175+
<td>nodeStroke</td>
176176
<td>{lineColor}</td>
177177
<td>{nodeStroke: "white"}</td>
178178
<td>Stroke Color for each node on the plotted line in the graph.</td>
179179
</tr>
180180
<tr>
181-
<th>precision</th>
181+
<td>precision</td>
182182
<td>1</td>
183183
<td>{precision: 2}</td>
184184
<td>Number of decimals of each value plotted.</td>
185185
</tr>
186186
<tr>
187-
<th>prefix</th>
187+
<td>prefix</td>
188188
<td>""</td>
189189
<td>{prefix: "$"}</td>
190190
<td>A string to prepends at the beginning of each value plotted.</td>
191191
</tr>
192192
<tr>
193-
<th>suffix</th>
193+
<td>suffix</td>
194194
<td>""</td>
195195
<td>{suffix: "km/h"}</td>
196196
<td>A string to append at the end of each value plotted.</td>
197197
</tr>
198198
<tr>
199-
<th>horizontalGrids</th>
199+
<td>horizontalGrids</td>
200200
<td>5</td>
201201
<td>{horizontalGrids: 10}</td>
202202
<td>Number of horizontal grid lines to display.</td>
203203
</tr>
204204
<tr>
205-
<th>showHorizontalGrids</th>
205+
<td>showHorizontalGrids</td>
206206
<td>true</td>
207207
<td>{showHorizontalGrids: true}</td>
208208
<td>Show or hide horizontal grid lines on the graph.</td>
209209
</tr>
210210
<tr>
211-
<th>showVerticalGrids</th>
211+
<td>showVerticalGrids</td>
212212
<td>false</td>
213213
<td>{showVerticalGrids: true}</td>
214214
<td>Show or hide vertical grid lines on the graph.</td>
215215
</tr>
216216
<tr>
217-
<th>showYAxisLabel</th>
217+
<td>showYAxisLabel</td>
218218
<td>true</td>
219219
<td>{showYAxisLabel: true}</td>
220220
<td>Show or hide YAxis Labels on the graph.</td>
221221
</tr>
222222
<tr>
223-
<th>showXAxisLabel</th>
223+
<td>showXAxisLabel</td>
224224
<td>true</td>
225225
<td>{showXAxisLabel: true}</td>
226226
<td>Show or hide XAxis Labels on the graph.</td>
227227
</tr>
228228
<tr>
229-
<th>showInlineLabel</th>
229+
<td>showInlineLabel</td>
230230
<td>false</td>
231231
<td>{showInlineLabel: true}</td>
232232
<td>Show or hide inline Labels on each node of the graph.</td>
233233
</tr>
234234
<tr>
235-
<th>inlineLabelColor</th>
235+
<td>inlineLabelColor</td>
236236
<td>{textColor}</td>
237237
<td>{inlineLabelColor: "gray"}</td>
238238
<td>Color of the inline Labels on each node of the graph.</td>
239239
</tr>
240240
<tr>
241-
<th>showInlineLabelValueOnly</th>
241+
<td>showInlineLabelValueOnly</td>
242242
<td>false</td>
243243
<td>{showInlineLabelValueOnly: true}</td>
244244
<td>Show or hide graph labels for inline Label values (<b>false</b> Label 1: $20.00 | <b>true</b> $20.00).</td>
245245
</tr>
246246
<tr>
247-
<th>enableOptionDropdown</th>
247+
<td>enableOptionDropdown</td>
248248
<td>true</td>
249249
<td>{enableOptionDropdown: true}</td>
250250
<td>Enable or disable the graph option dropdown menu.</td>
251251
</tr>
252252
<tr>
253-
<th>dropdownOptions</th>
253+
<td>dropdownOptions</td>
254254
<td>"ALL"</td>
255255
<td>
256256
<pre>{
@@ -259,24 +259,24 @@ and examples.
259259
"JSON | Download as Json file",
260260
"CSV | Download as CSV file"
261261
]
262-
}
262+
}</pre>
263263
</td>
264264
<td>Enable specific option in the dropdown menu by specifying it in an array of string (["IMAGE","JSON","CSV"]) the label after the pipe character (|) is optional.</td>
265265
</tr>
266266
<tr>
267-
<th>showTable</th>
267+
<td>showTable</td>
268268
<td>true</td>
269269
<td>{showTable: true}</td>
270270
<td>Show or hide the graph table.</td>
271271
</tr>
272272
<tr>
273-
<th>tableBackgroundColor</th>
273+
<td>tableBackgroundColor</td>
274274
<td>"white"</td>
275275
<td>{tableBackgroundColor: "white"}</td>
276276
<td>Background color for the graph table.</td>
277277
</tr>
278278
<tr>
279-
<th>tableTextColor</th>
279+
<td>tableTextColor</td>
280280
<td>"#444444"</td>
281281
<td>{tableTextColor: "#444444"}</td>
282282
<td>Text color for the graph table.</td>
@@ -286,7 +286,9 @@ and examples.
286286

287287
## License
288288

289-
MIT
289+
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Ffactman%2FGraphUI?ref=badge_large">
290+
<img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffactman%2FGraphUI.svg?type=large" alt="licence" />
291+
</a>
290292

291293

292294
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ffactman%2FGraphUI.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Ffactman%2FGraphUI?ref=badge_large)
@@ -332,4 +334,4 @@ The following company support GraphUI ongoing maintenance and development. [Beco
332334
</tbody>
333335
</table>
334336

335-
[GraphUI-image]: https://img.shields.io/badge/GraphUI-v1.0.0-blue.svg
337+
[GraphUI-image]: https://img.shields.io/badge/GraphUI-v1.0.0-blue.svg

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "graph-ui",
2+
"name": "@factman/graph-ui",
33
"version": "1.0.0",
44
"description": "GraphUI is a JavaScript extension for plotting graphs for any website project.",
55
"main": "./src/app.js",
66
"scripts": {
7-
"start": "echo GraphUI",
7+
"start": "echo GraphUI"
88
},
99
"keywords": [
1010
"graph",

0 commit comments

Comments
 (0)