![From Academia to Industry](https://cdn.sanity.io/images/cgdhsj6q/production/70501690bf807891573e259da9719cf24302c7e3-4288x2848.jpg?w=400&fit=max&auto=format)
Employee Spotlight
From Academia to Industry
Philipp Burckhardt recounts his journey from childhood computer fascinations, to building an e-learning platform at Carnegie Mellon University, and on to his current role at Socket.
node-chartist
Advanced tools
Readme
SVG Charts on the server.
Node Chartist is a functional server-side wrapper for the popular Chartist library. It generates static svg charts and adds support for a few useful features such as axis titles and chart legends.
npm install node-chartist
The accompanying CSS can be found at dist/main.css
after installation.
const co = require('co');
const generate = require('node-chartist');
co(function * () {
// options object
const options = {width: 400, height: 200};
const data = {
labels: ['a','b','c','d','e'],
series: [
[1, 2, 3, 4, 5],
[3, 4, 5, 6, 7]
]
};
const bar = yield generate('bar', options, data); //=> chart HTML
// options function
const options = (Chartist) => ({width: 400, height: 200, axisY: { type: Chartist.FixedScaleAxis } });
const data = {
labels: ['a','b','c','d','e'],
series: [
[1, 2, 3, 4, 5],
[3, 4, 5, 6, 7]
]
};
const bar = yield generate('bar', options, data); //=> chart HTML
});
A curried function that generates a static svg chart.
Returns a Promise
that is fulfilled with the static chart HTML.
Arguments
type
- A string used to determine what type of chart to generate. Supported values are:
bar
line
pie
options
- An object or a function that returns an object of chart options. If a function is used, it will be called with the Chartist
object.
Options are dependent on the chart type
. All options in the Chartist Api Documentation are supported. In addition to those, the following options are supported by node-chartist:
axisX.title
- A string to use as the x axis title.
axisY.title
- A string to use as the y axis title.
legend
- A boolean used to determine whether a legend should be generated. Defaults to true
.
data
- An object containing data used to generate the chart. The structure of this object depends on chart type
. Please refer to the Chartist Api Documentation for complete details.
For bar and line charts, this object contains the following properties
labels
- An array of string labels to apply to each value.
series
- An array of arrays or objects containing the values to plot. If objects are used, the following properties are supported:
name
- A string specifying the name of the series. The name will be used in the legend and will be set as the ct:series-name attribute on the series group.
value
- An array of values for the series.
className
- A string to override the CSS class name for the series group.
meta
- Meta data is serialized and written to a ct:meta attribute on the series group.
Examples:
const data = {
labels: ['a', 'b', 'c', 'd', 'e'],
series: [
[1, 2, 3, 4, 5],
[3, 4, 5, 6, 7]
]
};
const data = {
labels: ['a', 'b', 'c', 'd', 'e'],
series: [
{name: 'Series 1', value: [1, 2, 3, 4, 5]},
{name: 'Series 2', value: [3, 4, 5, 6, 7]}
]
};
For pie charts, this object contains the following properties:
series
- An array of values or objects containing values to plot. If objects are used, the following properties are supported:
name
- A string specifying the name of the series. The name will be used in the legend and will be set as the ct:series-name attribute on the series group.
value
- An array of values for the series.
className
- A string to override the CSS class name for the series group.
meta
- Meta data is serialized and written to a ct:meta attribute on the series group.
Examples:
const data = {
series: [ 15, 25 ]
};
const data = {
series: [
{name: 'Series 1', value: 15 },
{name: 'Series 2', value: 25 }
]
};
Examples
Bar:
co(function * () {
const options = {
width: 400,
height: 200,
axisX: { title: 'X Axis (units)' },
axisY: { title: 'Y Axis (units)' }
};
const bar = yield generate('bar', options, {
labels: ['a', 'b', 'c', 'd', 'e'],
series: [
{name: 'Series 1', value: [1, 2, 3, 4, 5]},
{name: 'Series 2', value: [3, 4, 5, 6, 7]}
]
});
})
Line:
co(function * () {
const options = {
width: 400,
height: 200,
axisX: { title: 'X Axis (units)' },
axisY: { title: 'Y Axis (units)' }
};
const line = yield generate('line', options, {
labels: ['a', 'b', 'c', 'd', 'e'],
series: [
{name: 'Series 1', value: [1, 2, 3, 4, 5]},
{name: 'Series 2', value: [3, 4, 5, 6, 7]}
]
});
})
Pie:
co(function * () {
const options = { width: 400, height: 200 };
const pie2 = yield generate('pie', options, {
series: [
{name: 'Series 1', value: 15 },
{name: 'Series 2', value: 25 }
]
});
})
FAQs
SVG Charts on the server.
The npm package node-chartist receives a total of 8,278 weekly downloads. As such, node-chartist popularity was classified as popular.
We found that node-chartist demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Employee Spotlight
Philipp Burckhardt recounts his journey from childhood computer fascinations, to building an e-learning platform at Carnegie Mellon University, and on to his current role at Socket.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.