plot

KO | EN

gitlite — search

#react #go #android #machine-learning #rust #docker #windows #awesome #kubernetes #awesome-list #security #pytorch #ios #open-source

(★ 21)

The simplest plotting API for JavaScript and TypeScript.

plot Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Plot

The simplest and most forgiving plotting API for JavaScript and TypeScript.

Use plot to quickly and conveniently render charts for your data. It is an abstraction layer over JavaScript visualization libraries. Currently supporting [Apex Charts](https://apexcharts.com/), but intending to support more in the future.

[Click here for the API docs](https://data-forge-notebook.github.io/plot/docs)

[For various examples see this repo](https://github.com/data-forge-notebook/plot-examples).

Plot can be used from Node.js, from the browser and is specially designed to integrate with [Data-Forge Notebook](https://www.data-forge-notebook.com/).

[Click here to support the developer](https://www.codecapers.com.au/about#support-my-work)

## Aims

- To have a simple way to plot a chart.
- To be an abstraction over multiple code libraries for visualization in JavaScript.
- To have a plotting library that works well in Node.js, the browser and in [Data-Forge Notebook](https://www.data-forge-notebook.com/).
- To be able to define charts purely as data using a simple JSON format.
- To be able to serialize a chart to send it over the wire or save it to disk.
- To be able to separate chart configuration and chart data to make it easy to reuse the charts you create.

## Usage

Some instructions for using plot. These instructions are for JavaScript, but this library also works in TypeScript.

### Import plot

### Browser

npm install --save plot @plotex/render-dom

```javascript
const { plot } = require("plot");
require("@plotex/render-dom");

const data = [ /* your data */ ];
const parentEl = /* parent DOM to contain the chart */ ;
const chart = plot(data).renderDOM(parentEl);
```

### Node.js

npm install --save plot @plotex/render-image

```javascript
const { plot } = require("plot");
require("@plotex/render-image");

const data = [ /* your data */ ];
plot(data).renderImage("my-chart.png");
```

### Data-Forge Notebook

plot is integrated into [Data-Forge Notebook](https://www.data-forge-notebook.com/).

You can plot an array of JavaScript data like this:

```javascript
const data = [ /* your data */ ];
display.plot(data);
```

See more Data-Forge Notebook examples in [the exported example visualization notebook](https://github.com/data-forge-notebook/wiki/wiki/visualizing-data).

## Pass in configuration options

```javascript
const data = [ /* your data */ ];
const chartConfig = { chartType: "bar" };
const axisConfig = { x: "Date", y: "Close" };
plot(data, chartConfig, axisConfig)
    .renderDOM(parentEl);
```

## Multiple types of data

### Plot an array of numbers

```javascript
plot([10, 15, 30])
    .renderDOM(parentEl);
```

### Plot an array of JavaScirpt object

```javascript
plot([ { A: 10, B: 52 }, { A: 15, B: 37 }, A: 30, B: 45 }])
    .renderDOM(parentEl);
```

### Plot by column

```javascript
plot({ A: [10, 15, 30], B: [52, 37, 45] })
    .renderDOM(parentEl);
```

## Resources

- [API docs](https://data-forge-notebook.github.io/plot/docs/)
- [For TypeScript Node.js example see this repo](https://github.com/data-forge-notebook/plot-examples).

## Future

There's more work to be done!

Can you contribute, test or give feedback?

Email the developer on ashley@codecapers.com.au.

## Support the developer

<a target="_blank" href="https://www.codecapers.com.au/about#support-my-work">Click here to **support the developer.**</a>

## Development stuff

### Rebuilding the docs

```bash
npm run docs
```

plot

plot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

plot

plot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README