A lightweight and zero-dependencies pure Node.js sparkline generator.
node-sparkline is a sparkline generator written in pure Node.js using ES6 and ES7 features with no dependency. It calculates points based on values to finally generate a polyline in a pure SVG (Scalable Vector Graphics) format. These values could be prices during the last 7 fays for an example.
The aim of this project is to provide a very simple, lightweight, zero-dependency, fast and fully-tested sparkline generator in SVG format and let user tune height, width, stroke color, stroke width and stroke opacity.
npm install node-sparkline
npm i -S node-sparkline
- Language: JavaScript ES6/ES7
- VM: Node.js >=10.0.0
- Own debugger embedded that writes on process.stderr when the DEBUG environment variable is set. See Environment variables.
Command to run all tests:
npm test
ESLint with Airbnb base rules. See Airbnb JavaScript Style Guide.
npm run test:lint
Mocha and Chai.
npm run test:unit
node-sparkline module exports one function named sparkline.
const sparkline = require('node-sparkline');-
options<Object>:values* <Array> An array of values to draw the sparkline.width<Number> The width in pixels to fix for the generated SVG. Default:135height<Number> The height in pixels to fix for the generated SVG. Default:50stroke<String> The stroke color. An hexadecimal value or one of these generic names. Default:#57bd0fstrokeWidth<Number> The stroke width in pixels. Min:0Default:1.25strokeOpacity<Number> The stroke opacity. Min:0Max:1Default:1
-
Returns: <String> The SVG tags of the generated SVG image
-
Throws: <InputError>
You can find examples here: doc/examples
In these examples please prefer a well-known and tested asynchronous logger over the use of console module.
const sparkline = require('node-sparkline');
const values = require('./values'); // values is an array
try {
const svg = sparkline({
values,
width: 135,
height: 50,
stroke: '#57bd0f',
strokeWidth: 1.25,
strokeOpacity: 1,
});
// svg is a string with SVG + polyline tags
// ...
} catch (e) {
console.error(e.toString());
}
-
DEBUG: used to debug node-sparkline.
Examples:
DEBUG=node-sparkline:*will debug all node-sparkline modules that could use the debugger.DEBUG=-node-sparkline:*will disable debugging any node-sparkline modules that could use the debugger.DEBUG=*will debug all node-sparkline modules that could use the debugger plus other modules used in your project if they use an equivalent debugger.
Errors emitted by node-sparkline inherit the native Error prototype.
{
name,
code,
message,
stack,
toString(),
}| name | code | description | module |
|---|---|---|---|
| InputError | |||
| MISSING_VALUES | The values to draw the sparkline are missing. | lib/index | |
| INVALID_VALUES | values parameter must be an array. | lib/index |
All contributions are greatly welcome :)
Please follow Git flow, ES6/7, ESLint Airbnb base rules.
node-sparkline is released under the MIT license.
Copyright (C) 2020 Adrien Valcke
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.