Skip to content

Commit 2b7a0b8

Browse files
committed
Updated readme.
1 parent 32f0c55 commit 2b7a0b8

1 file changed

Lines changed: 16 additions & 15 deletions

File tree

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The forgiving plotting API designed for use with [Data-Forge](https://github.com/data-forge/data-forge-ts).
44

5-
Use Data-Forge Plot to quickly and conveniently render charts from your data in JavaScript or TypeScript. It is an interface to other JS charting libraries such as C3.
5+
Use Data-Forge Plot to quickly and conveniently render charts from your data in JavaScript or TypeScript. It is an abstraction layer that connects Data-Forge with JavaScript visualization libraries so that it's easy to plot charts from your data.
66

77
Why not do your data wrangling, analysis and visualization entirely in JavaScript? To support my effort please buy or help promote my book
88
[Data Wrangling with JavaScript](http://bit.ly/2t2cJu2).
@@ -11,25 +11,20 @@ Or check out my blog: [The Data Wrangler](http://www.the-data-wrangler.com/).
1111

1212
Do your prototyping and exploratory data analysis in JavaScript with [Data-Forge Notebook](http://www.data-forge-notebook.com/).
1313

14-
THIS JS LIBRARY IS A WORK IN PROGRESS
15-
16-
If you want to understand and give feedback on this new API, [please first read my introductory blog post](http://www.the-data-wrangler.com/introducing-data-forge-plot/).
17-
1814
Please join the conversation on [Gitter](https://gitter.im/data-forge)
1915

2016
## Project Goals
2117

22-
- To go as simple and conveniently as possible from a series or dataframe to chart.
23-
- To be able to output charts and visualizations directly from Node.js to image files.
24-
- To be able to export an web-based interactive chart from Node.js that could easily be hosted under a web-server.
25-
- To integrate with a Juptyr Notebook style application for Node.js / JavaScript.
18+
- To simply and conveniently from a series or dataframe to chart.
19+
- To create charts and visualizations in Node.js and the browser.
20+
- To export web-based interactive charts that can easily be hosted under a web-server.
2621
- To be able to serialize a chart to JSON and then reinstantiate it from the JSON in a web-app.
27-
- To separate chart definition and data definition so that chart definitions can easily be reused with different data sets.
28-
- To configure charts either via JSON or via the fluent API, ultimately though it should be able to be expressed in JSON but with fluent API as syntactic sugar.
22+
- To separate configuration and data definition to make it easy to reuse charts.
23+
- To configure charts in JSON or fluent API.
2924

3025
## Usage
3126

32-
Some instructions for using Data-Forge Plot. These instructions are for JavaScript but this library also works in TypeScript.
27+
Some instructions for using Data-Forge Plot. These instructions are for JavaScript, but this library also works in TypeScript.
3328

3429
### Install
3530

@@ -43,13 +38,20 @@ Some instructions for using Data-Forge Plot. These instructions are for JavaScri
4338
require('data-forge-plot'); // Extends Data-Forge with the 'plot' function.
4439
```
4540

46-
### Rendering a chart from a CSV file
41+
### Rendering a chart from a CSV file to an image file
4742

4843
```javascript
4944
const dataFrame = await dataForge.readFile("my-data-file.csv").parseCSV();
5045
await dataFrame.plot().renderImage("my-chart.png");
5146
```
5247

48+
### Exporting a chart from a CSV file to an interactive web visualization
49+
50+
```javascript
51+
const dataFrame = await dataForge.readFile("my-data-file.csv").parseCSV();
52+
await dataFrame.plot().exportWeb("./output-path");
53+
```
54+
5355
### More docs coming soon
5456

5557
It's early days for DFP. I'll be working on more docs soon.
@@ -59,11 +61,10 @@ To see examples of API usage please see my blog posts:
5961
- http://www.the-data-wrangler.com/data-forge-plot-update/
6062
- http://www.the-data-wrangler.com/data-forge-plot-update2/
6163

62-
6364
There's also a first example of DFP here (JavaScript):
6465

6566
https://github.com/data-forge/data-forge-plot-first-example
6667

6768
There's a bunch of TypeScript examples in DFP's GitHub repo:
6869

69-
https://github.com/data-forge/data-forge-plot/tree/master/examples/c3
70+
https://github.com/data-forge/data-forge-plot/tree/master/examples/

0 commit comments

Comments
 (0)