Canvas graphics API backed by Cairo
$ npm install canvas
Unless previously installed you'll need Cairo. For system-specific installation view the Wiki.
You can quickly install the dependencies by using the command for your OS:
|Windows||Instructions on our wiki|
El Capitan users: If you have recently updated to El Capitan and are experiencing trouble when compiling, run the following command:
xcode-select --install. Read more about the problem on Stack Overflow.
var Canvas =Image = CanvasImagecanvas = 200 200ctx = canvas;ctxfont = '30px Impact';ctx;ctx;var te = ctx;ctxstrokeStyle = 'rgba(0,0,0,0.5)';ctx;ctx;ctx;ctx;console;
node-canvas extends the canvas API to provide interfacing with node, for example streaming PNG data, converting to a
Buffer instance, etc. Among the interfacing API, in some cases the drawing API has been extended for SSJS image manipulation / creation usage, however keep in mind these additions may fail to render properly within browsers.
Image#src=Buffer support, allowing you to read images from disc, redis, etc and apply them via
ctx.drawImage(). Below we draw scaled down squid png by reading it from the disk with node's I/O.
Below is an example of a canvas drawing it-self as the source several time:
var img = ;imgsrc = canvas;ctx;ctx;ctx;
Image#dataMode support, which can be used to opt-in to mime data tracking of images (currently only JPEGs).
When mime data is tracked, in PDF mode JPEGs can be embedded directly into the output, rather than being re-encoded into PNG. This can drastically reduce filesize, and speed up rendering.
var img = ;imgdataMode = ImageMODE_IMAGE; // Only image data trackedimgdataMode = ImageMODE_MIME; // Only mime data trackedimgdataMode = ImageMODE_MIME | ImageMODE_IMAGE; // Both are tracked
If image data is not tracked, and the Image is drawn to an image rather than a PDF canvas, the output will be junk. Enabling mime data tracking has no benefits (only a slow down) unless you are generating a PDF.
To create a
PNGStream simply call
canvas.pngStream(), and the stream will start to emit data events, finally emitting end when finished. If an exception occurs the error event is emitted.
var fs =out = fsstream = canvas;stream;stream;
Currently only sync streaming is supported, however we plan on supporting async streaming as well (of course :) ). Until then the
Canvas#toBuffer(callback) alternative is async utilizing
Canvas#jpegStream() and Canvas#syncJPEGStream()
You can likewise create a
JPEGStream by calling
some optional parameters; functionality is otherwise identical to
examples/crop.js for an example.
Note: At the moment,
jpegStream() is the same as
var stream = canvas;
A call to
Canvas#toBuffer() will return a node
Buffer instance containing image data.
// PNG Buffer, default settingsvar buf = canvas;// PNG Buffer, zlib compression level 3 (from 0-9), faster but biggervar buf2 = canvas;// ARGB32 Buffer, native-endianvar buf3 = canvas;var stride = canvasstride;// In memory, this is `canvas.height * canvas.stride` bytes long.// The top row of pixels, in ARGB order, left-to-right, is:var topPixelsARGBLeftToRight = buf3;var row3 = buf3;
Optionally we may pass a callback function to
Canvas#toBuffer(), and this process will be performed asynchronously, and will
Canvas#toDataURL() sync and async
The following syntax patterns are supported:
var dataUrl = canvas; // defaults to PNGvar dataUrl = canvas;canvas; // defaults to PNGcanvas;canvas; // sync JPEG is not supportedcanvas; // see Canvas#jpegStream for valid optionscanvas; // spec-following; quality from 0 to 1
Given one of the values below will alter pattern (gradients, images, etc) render quality, defaults to good.
Can be either
glyph is much faster than
path for drawing, and when using a PDF context will embed the text natively, so will be selectable and lower filesize. The downside is that cairo does not have any subpixel precision for
glyph, so this will be noticeably lower quality for text positioning in cases such as rotated text. Also, strokeText in
glyph will act the same as fillText, except using the stroke style for the fill.
Defaults to path.
This property is tracked as part of the canvas state in save/restore.
patternQuality, but applies to transformations effecting more than just patterns. Defaults to good.
Global Composite Operations
In addition to those specified and commonly implemented by browsers, the following have been added:
Set anti-aliasing mode
ctxantialias = 'none';
Basic PDF support was added in 0.11.0. Make sure to install cairo with
--enable-pdf=yes for the PDF backend. node-canvas must know that it is creating
a PDF on initialization, using the "pdf" string:
var canvas = 200 500 'pdf';
An additional method
.addPage() is then available to create
multiple page PDFs:
ctxfont = '22px Helvetica';ctx;ctx;ctxfont = '22px Helvetica';ctx;ctx;ctxfont = '22px Helvetica';ctx;ctx;
Just like PDF support, make sure to install cairo with
You also need to tell node-canvas that it is working on SVG upon its initialization:
var canvas = 200 500 'svg';// Use the normal primitives.fs;
Although node-canvas is extremely new, and we have not even begun optimization yet it is already quite fast. For benchmarks vs other node canvas implementations view this gist, or update the submodules and run
$ make benchmark yourself.
Want to contribute to node-canvas? patches for features, bug fixes, documentation, examples and others are certainly welcome. Take a look at the issue queue for existing issues.
Examples are placed in ./examples, be sure to check them out! most produce a png image of the same name, and others such as live-clock.js launch an http server to be viewed in the browser.
If you have not previously, init git submodules:
$ git submodule update --init
Install the node modules:
$ npm install
$ node-gyp rebuild
$ make test
$ make test-server
Tested with and designed for:
- node 0.4.2
- cairo 1.8.6
For node 0.2.x
node-canvas <= 0.4.3 may be used,
0.5.0 and above are designed for node 0.4.x only.
(The MIT License)
Copyright (c) 2010 LearnBoost, and contributors <email@example.com>
Copyright (c) 2014 Automattic, Inc and contributors <firstname.lastname@example.org>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.