gnuplot for node

!TypeScript compatible

@rkesters/gnuplot is an easy to use node module to draw charts using gnuplot and ps2pdf. This module is based on Richard Meadows's node-plotter

Installation

Prerequisites:

``bash


ubuntu

`

To install package, just run:

`
npm install @rkesters/gnuplot
`

Usage

`javascript
import plot from "@srkesters/gnuplot";

// with callback
plot({
data: [3, 1, 2, 3, 4],
filename: "output.png",
finish: (error) => {},
});

// As promise
const plotted = await plot({
data: [3, 1, 2, 3, 4],
filename: "output1.png",
});
`

$3

This defaults to .png but specifing format: svg changes the output
to .svg and format: pdf changes
the output format to
.pdf.

`javascript
import plot from "@rkesters/gnuplot";

plot({
data: [3, 1, 2, 3, 4],
filename: "output.svg",
format: "svg",
});
`

$3

The following properties can be used:

- title : _Sets the title of the graph_
- xlabel : _Sets the label on the x axis of the graph_
- ylabel : _Sets the label on the y axis of the graph_
- logscale : _Makes the y axis of the graph appear in a log scale_
- style : _The style of the lines on the graph. Possibilites include
lines (default), points and linespoints_
- nokey : _Disables the graph key_
- hideSeriesTitle: _Indicates if plot should include legend_
- margin: _Sets margin if needed_
- xRange: _Sets max and min values for the X axis_
- yRange: _Sets max and min values for the Y axis_
- decimalsign: _Specifies a custom decimal sign_
- yFormat: _Specifies how to format values on the Y axis_
- font: _Specify a custom font_
- fontSize: _Font size_
- titleSize: _Title font size_
- width: _Plot width_
- height: _Plot height_
- locale: _Locale code (run 'set locale' for the exact value)_

The following example shows these in use:

`javascript
plot({
title: "example",
data: { t1: { 1357162672: 22.2, 1357162782: 23, 1357162892: 24 } },
time: "hours",
style: "line",
filename: "test/output14.png",
format: "png",
decimalsign: ",",
yFormat: "%.2f USD",
hideSeriesTitle: true,
xlabel: "Time",
ylabel: "Price",
margin: {
left: 10,
right: 3,
top: 3,
bottom: 4,
},
xRotate: {
value: 45,
yOffset: -1.5,
xOffset: -2,
},
hideSeriesTitle: true,
xRange: {
min: 0,
max: 100,
},
});
`

$3

`javascript
plot({
data: { line: { 1: 5, 5: 6 } },
filename: "output.png",
});
`

Instead of specifing an array for data, you can specify an object
with a named series inside.

$3

`javascript
plot({
data: { tick: [3, 1, 2, 3, 4], line: { 1: 5, 5: 6 } },
filename: "output.png",
});
`

$3

`javascript
plot({
data: { temperature: { 1357162672: 22, 1357162782: 23, 1357162892: 24 } },
time: "hours",
filename: "output.png",
});
`

The x axis can be formatted as a time series if the x values are given
as a unix time. The time
property can be specified with the gnuplot time format.

$3

The options object might additionally contain the following:

| Option | Description | Example |
| -------- | --------------------------------------------------- | ---------------------------------------------------------- |
| exec | Arguments for the gnuplot process | options.exec = { cwd : '/home/user/images' }; |
| finish | Callback executed when the gnuplot process finishes | options.finish = function(){ Console.log('Success!'); };` |