https://github.com/jupyter-widgets-contrib/ipycanvas

Interactive Canvas in Jupyter
https://github.com/jupyter-widgets-contrib/ipycanvas

canvas canvas2d interactive-visualizations jupyter jupyterlab

Last synced: about 1 month ago
JSON representation

Interactive Canvas in Jupyter

• Host: GitHub
• URL: https://github.com/jupyter-widgets-contrib/ipycanvas
• Owner: jupyter-widgets-contrib
• License: bsd-3-clause
• Created: 2019-07-06T12:55:29.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-05T18:12:15.000Z (8 months ago)
• Last Synced: 2025-04-11T14:21:33.180Z (2 months ago)
• Topics: canvas, canvas2d, interactive-visualizations, jupyter, jupyterlab
• Language: Python
• Homepage: https://ipycanvas.readthedocs.io/en/latest/
• Size: 6.25 MB
• Stars: 701
• Watchers: 9
• Forks: 63
• Open Issues: 62
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-jupyter-widgets - ipycanvas - interactive drawing canvas using the browser's canvas API (Interactive Widgets / Interactive Jupyter Widget Ecosystem)

README

        


ipycanvas

 Interactive Canvas in Jupyter 


[![Documentation](http://readthedocs.org/projects/ipycanvas/badge/?version=latest)](https://ipycanvas.readthedocs.io/en/latest/?badge=latest)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter-widgets-contrib/ipycanvas/stable?urlpath=lab%2Ftree%2Fexamples)

[![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge-launch.svg)](https://ipycanvas.readthedocs.io/en/latest/lite/lab)

[![Downloads](https://pepy.tech/badge/ipycanvas)](https://pepy.tech/project/ipycanvas)

[![Join the chat at https://gitter.im/jupyter-widgets-contrib/ipycanvas](https://badges.gitter.im/jupyter-widgets-contrib/ipycanvas.svg)](https://gitter.im/jupyter-widgets-contrib/ipycanvas?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

ipycanvas is a lightweight, fast and stable library exposing the [browser's Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) to IPython.

It allows you to draw simple primitives directly from Python like text, lines, polygons, arcs, images etc. This simple toolset allows you to draw literally anything!

## Try it online!

You can try it online by clicking on this badge:

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter-widgets-contrib/ipycanvas/stable?urlpath=lab%2Ftree%2Fexamples)

## Documentation

You can read the documentation following this link: https://ipycanvas.readthedocs.io

## Questions?

If you have any question, or if you want to share what you do with ipycanvas, [start a new discussion on Github](https://github.com/jupyter-widgets-contrib/ipycanvas/discussions/new)!

Or join the gitter channel: [![Join the chat at https://gitter.im/jupyter-widgets-contrib/ipycanvas](https://badges.gitter.im/jupyter-widgets-contrib/ipycanvas.svg)](https://gitter.im/jupyter-widgets-contrib/ipycanvas?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Installation

You can install using `pip`:

```bash

pip install ipycanvas orjson

```

Or using `conda`:

```bash

conda install -c conda-forge ipycanvas

```

And if you use jupyterlab <= 2:

```bash

conda install -c conda-forge yarn

jupyter labextension install @jupyter-widgets/jupyterlab-manager ipycanvas

```

A development installation guide, can be found [here](https://ipycanvas.readthedocs.io/en/latest/installation.html#development-installation)

## Examples

### Create John Conway's Game Of Life

![John Conway's Game Of Life](https://raw.githubusercontent.com/jupyter-widgets-contrib/ipycanvas/master/docs/images/ipycanvas_gameoflife.png)

### Give a "hand-drawn" style to your drawings using the RoughCanvas

![RoughCanvas](https://raw.githubusercontent.com/jupyter-widgets-contrib/ipycanvas/master/docs/images/ipycanvas_rough.png)

### Draw Particles from IPython

![Particles](https://raw.githubusercontent.com/jupyter-widgets-contrib/ipycanvas/master/docs/images/ipycanvas_particles.png)

### Custom Sprites

![Sprites](https://raw.githubusercontent.com/jupyter-widgets-contrib/ipycanvas/master/docs/images/ipycanvas_sprites.png)

### Draw data directly from a NumPy array

![NumPy](https://raw.githubusercontent.com/jupyter-widgets-contrib/ipycanvas/master/docs/images/ipycanvas_binary.png)

### Create your own plotting library **fully** in Python

![Plotting](https://raw.githubusercontent.com/jupyter-widgets-contrib/ipycanvas/master/docs/images/ipycanvas_scatter.png)