banquo

Banquo ===

Banquo

Banquo builds off of Depict, a node library designed to use PhantomJS to take screenshots of interactive visualizations. Banquo is slightly different in that it is built to be called on a Node.js server and returns a base64-encoded version of the screenshot as jsonp, as opposed to saving the screenshot to a file.

As a result, Banquo doesn't run on the command line, as Depict does, but instead is called like the example below from another Node.js script.

Banquo requires PhantomJS to be installed. Due to an unresolved bug with the latest version of PhantomJS (2.0), it currently works up to version 1.9.x. Here's how to install that version via Homebrew

brew install homebrew/versions/phantomjs198

npm install banquo

var banquo = require('banquo');
 
var opts = {
    mode: 'base64',
    url: 'america.aljazeera.com',
    viewport_width: 1440,
    delay: 1000,
    selector: '#articleHighlightList-0'
};
 
banquo.capture(opts, function(errorsimageData){
    console.log(imageData);
});

Or if mode is save and scrape is true you get the body markup. This behavior will be standardized in future versions. Pull request welcome.

var banquo = require('banquo');
 
var opts = {
    mode: 'save',
    url: 'america.aljazeera.com',
    viewport_width: 1440,
    delay: 1000,
    selector: '#articleHighlightList-0',
    scrape: true
};
 
banquo.capture(opts, function(errorsbodyMarkup){
    console.log(bodyMarkup);
});
KeyRequiredDefaultOptionsDescription
modenobase64save or base64The former will save a file to the out_file location and return a success string callback. The latter will return the image as a base64 string.
urlyesnullStringThe website you want to screenshot.
viewport_widthno1440Number (pixels)The desired browser width. Settings this to a higher number will increase processing time.
delayno1000Number (milliseconds)How long to wait after the page has loaded before taking the screenshot. PhantomJS apparently waits for the page to load but if you have a map or other data calculations going on, you'll need to specify a wait time.
selectornobodyCSS selectorThe div you want to screenshot.
css_hidenonullCSS selectorAny divs you want to hide, such as zoom buttons on map. Defaults to none.
out_filenonullStringThe name / location of the image file you want to save.
user_agentnonullStringSet a custom user-agent string.
scrapenofalseBooleanIf set to true and mode is save will return the HTML as a string. Does not work if mode is base64.

You can set up your own service with banquo by cloning banquo-server. Note: Banquo server uses an older version of Banquo. Pull request welcome.