savyg
v1.2.4
Published
A savvy library to create svg elements and charts with ease
Downloads
29
Maintainers
Readme
savyg
A savvy library to create svg elements and charts with ease.
SVG is awesome. But writing SVG on a low level can be tedious. This library is designed to make SVG coding more declarative and enjoyable.
This Typescript library also comes with built-in charts, you can tailor to your needs. It is lowely opinionated.
This project just started. The basic blocks are there. Many more charts are on the cards.
Installation
npm install savyg
yarn add savyg
pnpm add savyg
bun add savyg
charts
Making charts is easy. Here is how you can create a progression chart, with lines, bars and plots:
import { chartXy } from "savyg";
chartXy({
dataset: [
{
name: 'serie 1',
values: [0, -1, -1, -2, -3, -5, -8.13, -13.54, -21, -34, -55, -89],
type: "bar",
rounding: 1,
plotRadius: 0,
gradientFrom: "#FF000033",
gradientTo: "#0000FF33",
rx: 3
},
{
name: 'serie 2',
values: [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89],
type: "line",
fill: "#FF000033"
},
{
name: 'serie 3',
values: [89, 55, 34, 21],
type: "plot",
plotRadius: 3
},
],
// The HTML element where the chart will be inserted:
parent: document.querySelector('#myDiv'),
options: {
barSpacing: 2,
showAxis: true,
xAxisLabels: ["JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"],
title: "Title",
}
})
Here is how you can create a donut chart:
import { chartDonut } from "savyg";
chartDonut({
dataset: [
{
name: "serie 1",
value: 20,
},
{
name: "serie 2",
value: 10,
},
{
name: "serie 3",
value: 10,
},
{
name: "serie 4",
value: 20,
},
],
// The HTML element where the chart will be inserted:
parent: document.querySelector('#myDiv'),
options: {
title: "Title",
}
})
Here is how you can create a gauge chart:
import { chartGauge } from "savyg";
chartGauge({
value: 66.7,
segments: [
{
from: -100,
to: 0,
color: "red"
},
{
from: 0,
to: 100,
color: "green"
}
],
// The HTML element where the chart will be inserted:
parent: document.querySelector('#myDiv'),
options: {
title: "Title",
valueRounding: 1
}
})
Here is how you can create a sparkline chart:
import { chartSparkline } from "savyg";
chartSparkline({
dataset : {
name: 'Title',
values: [1, 2, 3, 5, 8, 13],
periods: ['JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN']
},
// The HTML element where the chart will be inserted:
parent: document.querySelector('#myDiv'),
options: {
titleFontSize: 8,
showArea: true
}
});
SVG api
If you need to write SVG close to the metal but want to spare the hassle, this api is for you.
Need a circle ?
import { circle } from "savyg";
circle({
options: {
x: 10,
y: 10,
r: 5,
fill: "red"
},
parent: document.querySelector('#mySvg')
})
...or a rectangle, to be used later ?
import { rect } from "savyg";
const myGreenRect = rect({
options: {
x: 0,
y: 0,
height: 10,
width: 10,
fill: "green"
}
})
alreadyDeclaredSvg.appendChild(myGreenRect)
Headless
savyg does not ship css files.
To further customize your charts, css classes are exposed.