javascript node wrapper for gnuplot
npm install gnu-plotnode-gnuplot
============
javascript node.js wrapper for gnuplot
js
var gnuplot = require('gnu-plot')
gnuplot().plot([{
data:[[0,0],[1,1],[2,0]]
}])
`
Breaking changes
Note: gnuplot.exe >=v5.4 mangles stdin on my Windows machine, I recommend staying on 5.2.8
Version 0.3.0
- plotsSettings.color renamed to plotsSettings.rgbcolor
Fix : color:"#FF0000" -> rgbcolor:"#FF0000"
---
Methods
gnuplot()
Spawn a new gnuplot process and return a plot object inheriting child_process.
` js
var plot = gnuplot()
`
plot.plot(plotsSettings)
Plots with plotsSettings Array.
$3
Array of plot settings objects corresponding to different data series
` js
[{
title:,
<br />
<br /> using:<using>,
<br /> smooth:<smooth>,
<br /> axes:<axes>,
<br /> bin:<using>,
<br />
<br /> style:<style>,
<br /> color:<color>,
<br /> rgbcolor:<rgbcolor>,
<br />
<br /> data:<data>,
<br />},...]
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />#### title
<br /><em>default: <index of setting object in plotsSettings array></em>
<br />Title of the data serie
<br />
<br />#### using
<br /><em>default: undefined</em>
<br />Used to tell gnuplot which data columns (or pseudo-column to use). Please refer to gnuplot documentation.
<br />Can be used to handle datetime data or change missing data handling.
<br />
<br />#### smooth
<br /><em>default: undefined</em>
<br />Used for interpolation and approximation of data. Please refer to gnuplot documentation.
<br />
<br />#### axes
<br /><em>default: </code>x1y1<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></em>
<br />Axes used for the data serie.
<br />Choose from </code>["x1y1","x1y2","x2y1","x2y2"]<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />The axes are positionned :
<br /> - </code>x1<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">: bottom
<br /> - </code>x2<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">: top
<br /> - </code>y1<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">: left
<br /> - </code>y2<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">: right
<br />
<br />#### bin
<br /><em>default: undefined</em>
<br />Used to bin data. Please refer to gnuplot documentation.
<br />You should calculate them in JS instead of with gnuplot.
<br />
<br />#### style
<br /><em>default: </code>"lines"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></em>
<br />Style of the data serie in :
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />lines
<br />points
<br />linespoints
<br />surface
<br />dots
<br />impulse
<br />boxes
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />see </code>with<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> clause of the plot command in gnuplot documentation for more.
<br />
<br />#### color
<br /><em>shorthand for </code>style:"linecolor <color>"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></em>
<br />Color setting of the data serie
<br />Used with
<br />
<br />#### rgbcolor
<br /><em>shorthand for </code>style:"linecolor rgbcolor \"<color>\""<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></em>
<br />Color of the data serie
<br />by name : execute </code>gnuplot -e "show colornames"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> to view all possible values
<br />by value : </code>#RRGGBB<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">, </code>#AARRGGBB<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />
<br />
<br />#### data
<br />Data Array with structure
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />[[x0,y0],[x1,y1],[x2,y2], ...]
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />Or mathematical formula
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />"2<em>x</em><em>2+3</em>x+4"
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br /><h3 class="text-lg font-medium mt-4 mb-2">$3</h3>
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.plot([{
<br /> title:"A",
<br /> rgbcolor:"#00FF00",
<br /> data:[
<br /> [0 , 10],
<br /> [0.5, 90],
<br /> [1 , 85],
<br /> [1.5, 20],
<br /> [2 , 25]
<br /> ]
<br />},{
<br /> title:"B",
<br /> rgbcolor:"red",
<br /> style:"linespoints",
<br /> data:[
<br /> [0.4,30],
<br /> [1.1,70],
<br /> [1.8,40]
<br /> ],
<br />},{
<br /> title:"C",
<br /> rgbcolor:"blue",
<br /> data: "-2<em>x</em><em>2+3</em>x+4",
<br />}])
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br /><h2 class="text-xl font-semibold mt-5 mb-3">plot.splot(plotsSettings)</h2>
<br />Same as </code>plot.plot(plotsSettings)<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> for 3D plots
<br />
<br />
<br />
<br /><h2 class="text-xl font-semibold mt-5 mb-3">plot.set(options)</h2>
<br />Set or unset some gnuplot options.
<br />
<br /><h3 class="text-lg font-medium mt-4 mb-2">$3</h3>
<br />Object containing options as key:values.
<br />See gnuplot documentation for a complete list of available options.
<br />
<br />Notable options:
<br />#### Axes label
<br /></code>{x|y|x2|y2|z}label:<label><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.set({xlabel:"'s'",yrange:"'°C'"})
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />#### Fixed axes
<br /></code>{x|y|x2|y2}range:"[[<min>]:[<max>]]"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.set({xrange:"[0:]",yrange:"[-5:5]"})
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />#### Line at origin
<br /></code>{x|y|x2|y2|z}zeroaxis: true<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.set({yzeroaxis:true})
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />#### Axes tics interval
<br /></code>{x|mx|y|my|x2|mx2|y2|my2|z|mz}tics:<interval><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.set({
<br /> xtics: 10, // major xtic every 10
<br /> mxtics: 2, // 2 minor xtics per major xtic
<br /> ytics: [
<br /> 10, // major ytic every 10
<br /> "add (42)", // add ytic at y=42
<br /> ],
<br /> y2tics: true, // show auto interval tics
<br />})
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />#### Log scale
<br /></code>logscale:"[x][x2][y][y2][z] <base>"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /><em>default base : 10</em>
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.set({
<br /> logscale:[
<br /> "x", // logscale for x axis with default base 10
<br /> "yy2 2", // logscale for y and y2 axes with base 2
<br /> ],
<br />})
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />#### Grid
<br /></code>grid: "[xtics] [mxtics] [ytics] [mytics] [ztics] [mztics] [<style>]"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.set({grid:"xtics ytics"})// default style
<br />plot.set({grid:"xtics mxtics ytics mytics lines -1 dashtype 2, lines 0"}) // dashed for tics, dotted for minor tics
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />#### output to image
<br /></code>term:"{png|jpeg} size <x>,<y>", output:"<file>"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.set({term:"png size 800,600", output:"plot.png"})
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />#### output to terminal
<br /></code>term:"dumb [size <x> <y>]"<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> js
<br />plot.stdout.pipe(process.stdout) //print gnuplot output to console
<br />// plot 200 characters wide & 50 chararcters tall
<br />plot.set({term:"dumb 200 50"})
<br />// or for a plot filling the terminal
<br />plot.set({term:"dumb "+process.stdout.columns+" "+process.stdout.rows})
<br /></code>``
<br />
<br />
<br /><h2 class="text-xl font-semibold mt-5 mb-3">plot.print(string)</h2>
<br />Write string to stdin of the gnuplot process.
<br /></p></div><div class="flex justify-center absolute inset-x-0 bottom-0 bg-gradient-to-t from-background via-background to-transparent pb-4 pt-16"><button data-slot="button" class="inline-flex items-center justify-center whitespace-nowrap text-sm font-medium transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-chevron-down mr-1 h-4 w-4"><path d="m6 9 6 6 6-6"></path></svg>Show more</button></div></div></div><template id="P:3"></template><template id="P:4"></template></div></div></div><div hidden id="S:3"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><div hidden id="S:4"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS("S:4","P:4")</script><script>$RC("B:1","S:1")</script></body></html>