Skip to content

bpostlethwaite/plotly-nodejs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#node.js + Plotly Streaming API Analyze and Visualize Data, Together.js ###Installation

npm install plotly

###Usage

var plotly = require('plotly')('username','api_key');

var data = [{x:[],y:[],stream:{token:'your_streamtoken',maxpoints:200}}];
var layout = {fileopt : "extend",filename : "node node"};

plotly.plot(data,layout,function() {
	var stream = plotly.stream('your_streamtoken', function(res){
	});
	someReadableStream.pipe(stream);
});

###Methods ####signup(desired_username,email[, callback]) callback(err,msg) where err is an error Object, and msg is the return response Object

The msg object has the following attributes : msg.un,msg.api_key,msg.tmp_pw,msg.message,msg.statusCode, msg.error

#####Example:

var plotly = require('plotly')();

var un = 'desired_username';
var email = 'your_email@email.com';

plotly.signup(un, email, function (err, msg) {
	console.log(msg);
});

####plot(data,layout[, callback]) callback(err,msg) where err is an error Object, and msg is the return response Object

The msg object has the following attributes : msg.url,msg.filename,msg.message,msg.warning,msg.error

#####Example:

var plotly = require('plotly')('your_username','your_apikey');

var data = [{x:[0,1,2],y:[3,2,1], type: 'bar'}];
var layout = {fileopt : "extend",filename : "node node node node"};
var options = { data : data, layout : layout };

plotly.plot(options, function (err, msg) {
	console.log(msg);
});

####stream(your_streamtoken[, callback]) callback(res) where res is a the response object with the following attributes : res.msg, res.statusCode

#####Example:

var plotly = require('plotly')('your_username','your_apikey');

var initdata = [{x:[],y:[],stream:{token:'your_streamtoken',maxpoints:200}}];
var initlayout = {fileopt : "extend",filename : "node node node node"};
var options = { data : data, layout : layout };

plotly.plot(initdata, initlayout, function (err, msg) {
	var stream1 = plotly.stream('your_streamtoken', function (res) {
		clearInterval(iv); // once stream is closed, stop writing
	});
	var i = 0;
	var loop = setInterval(function () {
			var streamObject = JSON.stringify({ x : i, y : i });
			stream1.write(streamObject+'\n');
			i++;
	}, 1000);
});

####Full REST API Documentation can be found here

Plotly REST Documentation

About

node.js wrapper for Plotly's Streaming and REST APIs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%