mbejda / plotlychartexport

Export Plot.ly charts on the server

Plot.ly Chart Export

PlotlyChartExport uses Phantom.js to render plot.ly charts on the server. It crops the chart, base64 encodes it and returns the encoded chart in a resolving promise. It does not rely on the filesystem nor does it rely on graphics libraries like Cairo making it an effective chart rendering solution for serverless environments.

• Only 1 Dependency
• Works in Serverless Environments
• Size < 10MB

Installation

npm install plotlychartexport --save

Usage

/// include library
const exp = require('plotlychartexport');

/// define plot.ly data properties
let trace1 = {
    x: [1, 2, 3, 4],
    y: [10, 15, 13, 17],
    type: 'scatter'
};
let trace2 = {
    x: [1, 2, 3, 4],
    y: [16, 5, 11, 9],
    type: 'scatter'
};

/// define plot.ly layout
let layout = {
    title: 'Line and Scatter Plot'
};

/// run render command
exp.render([trace1, trace2], layout).then((base) => {
    console.log(base); /// base64
}, (error) => {
    console.error(error);
})

Create a Serverless Chart Export

Checkout this tutorial I made on how to create serverless chart exports on AWS to see the module in action. https://www.mbejda.com/creating-serverless-plotly-chart-exports

If you are experiencing any issues with this module open up a ticket and send me a tweet. @notMiloBejda

plotlychartexport's Issues

Able to render charts client side just fine, when I try to export to the base64 image its returning null in my success

I followed the readme exactly as you laid it out, even with your sample data. No matter what I pass to the exp.render function, it always hits my .then but the param its passing back is always empty. If i console log, it returns nothing... if i upload it to s3 its a 0kb image. Any ideas on what would cause this? I'm assuming something is messing up when phantomjs is trying to grab me an image but if there was an error caused from phantomjs i would assume the render function wouldnt resolve?

plotly.js test mocks

Nice work!!

Not sure if you've seen these, but there is a big set of test mocks that is used in the plotly.js repo to test all of the different chart types: https://github.com/plotly/plotly.js/tree/master/test/image/mocks. You might be interested in running those mocks against the project to verify that all of the charts render appropriately.