Welcome to the jupyter_rfb docs!

The jupyter_rfb library provides a widget (an anywidget subclass) that can be used in various notebook environments to implement a remote frame-buffer.

Images that are generated at the server are streamed to the client (Jupyter) where they are shown. Events (such as mouse interactions) are streamed in the other direction, where the server can react by generating new images.

This remote frame-buffer approach can be an effective method for server-generated visualizations to be dispayed in Jupyter notebook/lab. For example visualization created by tools like vispy, datoviz or pygfx.

Contents

• Guide
  • Installation
  • Subclassing the widget
  • Logical vs physical pixels
  • Scheduling draws
  • Event throttling
  • Taking snapshots
  • Exceptions and logging
  • Measuring statistics
  • Performance tips
• Reference
  • RemoteFrameBuffer class
  • Event spec
• Examples
  • Grid Example
  • Hello world example
  • Interaction example
  • Interactive drawing example
  • Embedding in an ipywidgets app
  • Performance measurements
  • Push example
  • PyGfx cube example
  • PyGfx points and lines example
  • PyGfx picking example
  • Video example
  • Visibility check
  • Vispy example
• Contributor's guide
  • How can I contribute?
  • Install jupyter_rfb in development mode
  • Automated tools
  • Autocommit hook
  • Tips to test changes made to code

Indices and tables

• Index

• Module Index

• Search Page