Skip to main content

Ctrl+K

User Guide
Developer Notes
API Reference
Examples Gallery

Github

User Guide
Developer Notes
API Reference
Examples Gallery

Github

Section Navigation

API Reference

Layouts
- ImguiFigure
  - fastplotlib.layouts.ImguiFigure
  - animations
  - cameras
  - canvas
  - controllers
  - default_imgui_font
  - guis
  - imgui_renderer
  - layout
  - names
  - renderer
  - shape
  - add_animations
  - add_gui
  - add_subplot
  - clear
  - clear_animations
  - close
  - export
  - export_numpy
  - get_pygfx_render_area
  - open_popup
  - register_popup
  - remove_animation
  - remove_subplot
  - show
- Figure
  - fastplotlib.layouts.Figure
  - animations
  - cameras
  - canvas
  - controllers
  - layout
  - names
  - renderer
  - shape
  - add_animations
  - add_subplot
  - clear
  - clear_animations
  - close
  - export
  - export_numpy
  - get_pygfx_render_area
  - open_popup
  - remove_animation
  - remove_subplot
  - show
- Subplot
  - fastplotlib.layouts._subplot.Subplot
  - ambient_light
  - animations
  - axes
  - background_color
  - camera
  - canvas
  - controller
  - directional_light
  - docks
  - frame
  - graphics
  - legends
  - name
  - objects
  - parent
  - renderer
  - scene
  - selectors
  - title
  - toolbar
  - tooltip
  - viewport
  - add_animations
  - add_graphic
  - add_image
  - add_image_volume
  - add_line
  - add_line_collection
  - add_line_stack
  - add_mesh
  - add_polygon
  - add_scatter
  - add_surface
  - add_text
  - add_vectors
  - auto_scale
  - center_graphic
  - center_scene
  - clear
  - clear_animations
  - delete_graphic
  - get_figure
  - get_pick_info
  - insert_graphic
  - map_screen_to_world
  - map_world_to_screen
  - remove_animation
  - remove_graphic
Graphics
Graphic Features
Selectors
Tools
- HistogramLUTTool
  - fastplotlib.HistogramLUTTool
  - alpha
  - alpha_mode
  - axes
  - block_events
  - cmap
  - deleted
  - event_handlers
  - images
  - name
  - offset
  - right_click_menu
  - rotation
  - scale
  - supported_events
  - tooltip_format
  - visible
  - vmax
  - vmin
  - world_object
  - add_axes
  - add_event_handler
  - clear_event_handlers
  - format_pick_info
  - map_model_to_world
  - map_world_to_model
  - remove_event_handler
  - rotate
  - set_data
- TextBox
  - fastplotlib.TextBox
  - background_color
  - font_size
  - outline_color
  - padding
  - position
  - text_color
  - visible
  - clear
  - display
- Tooltip
- Cursor
  - fastplotlib.Cursor
  - alpha
  - color
  - edge_color
  - edge_width
  - enabled
  - marker
  - mode
  - position
  - size
  - size_space
  - add_subplot
  - clear
  - remove_subplot
UI Bases
- BaseGUI
  - fastplotlib.ui.BaseGUI
  - update
- Window
  - fastplotlib.ui.Window
  - update
- EdgeWindow
  - fastplotlib.ui.EdgeWindow
  - height
  - location
  - size
  - width
  - x
  - y
  - draw_window
  - get_rect
  - update
- Popup
Widgets
- ImageWidget
fastplotlib
fastplotlib.utils

API Reference
Layouts
Figure
canvas

canvas#

property Figure.canvas: BaseRenderCanvas#: The canvas this Figure is drawn onto

Examples#

Cursor transform

Cursor transform

previous

cameras

next

controllers

On this page

Figure.canvas
Examples

This Page

Show Source

© Copyright 2025, Kushal Kolar, Caitlin Lewis.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.