Skip to main content

Ctrl+K

User Guide
imgui
Developer Notes
API Reference
Examples Gallery

Github

User Guide
imgui
Developer Notes
API Reference
Examples Gallery

Github

Section Navigation

API Reference

Layouts
Graphics
Graphic Features
Selectors
Tools
- 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
Axes
- Grid
- Grids
- Ruler
  - fastplotlib.axes.Ruler
  - cast_shadow
  - children
  - color
  - end_pos
  - end_value
  - geometry
  - id
  - label
  - line
  - line_width
  - material
  - min_tick_distance
  - nonlinear_transform
  - parent
  - points
  - receive_shadow
  - render_mask
  - render_order
  - start_pos
  - start_value
  - text
  - tick_format
  - tick_marker
  - tick_side
  - tick_size
  - ticks
  - ticks_at_end_points
  - up
  - visible
  - add
  - add_event_handler
  - clear
  - get_bounding_box
  - get_bounding_sphere
  - get_geometry_bounding_box
  - get_world_bounding_box
  - get_world_bounding_sphere
  - handle_event
  - iter
  - look_at
  - release_pointer_capture
  - remove
  - remove_event_handler
  - set_pointer_capture
  - traverse
  - update
- Axes
  - fastplotlib.axes.Axes
  - auto_grid
  - basis
  - color
  - colors
  - grids
  - intersection
  - offset
  - visible
  - world_object
  - x
  - y
  - z
  - update
  - update_using_bbox
  - update_using_camera
UI
- ImguiBase
  - fastplotlib.ui.ImguiBase
  - draw
- ImguiContainer
- ImguiWindow
  - fastplotlib.ui.ImguiWindow
  - collapsed
  - height
  - location
  - size
  - width
  - window_flags
  - x
  - y
  - draw
  - update
- ImguiPopup
  - fastplotlib.ui.ImguiPopup
  - graphic
  - is_open
  - parent
  - subplot
  - window_flags
  - draw
  - open
  - update
- ImguiColorbar
  - fastplotlib.ui.ImguiColorbar
  - bar_width
  - cmap
  - data_range
  - figure
  - gamma
  - graphics
  - height
  - histogram
  - title
  - vmax
  - vmin
  - draw
  - update
- Legend
  - fastplotlib.ui.Legend
  - collapsed
  - height
  - items
  - location
  - size
  - width
  - window_flags
  - x
  - y
  - add
  - draw
  - remove
  - update
- LegendItem
- LineLegendItem
- ScatterLegendItem
- LegendElement
- LineLegendElement
- ScatterLegendElement
Widgets
- RangeContinuous
  - fastplotlib.RangeContinuous
  - size
  - start
  - step
  - stop
  - throttle
- AutoRangeContinuous
  - fastplotlib.AutoRangeContinuous
  - size
  - start
  - step
  - stop
  - throttle
- ReferenceIndices
- NDSlicer
  - fastplotlib.NDSlicer
  - data
  - dims
  - display_dims
  - display_dims_indices
  - n_slider_dims
  - ndim
  - shape
  - slider_dims
  - slider_maps
  - spatial_func
  - tooltip
  - window_funcs
  - window_order
  - close
  - get
  - get_window_output
  - tooltip_format
- NDGraphic
  - fastplotlib.NDGraphic
  - data
  - dims
  - display_dims
  - graphic
  - indices
  - indices_displayed
  - name
  - ndim
  - pause
  - shape
  - slicer
  - slider_dims
  - slider_maps
  - spatial_func
  - window_funcs
  - window_order
- NDPositions
  - fastplotlib.NDPositions
  - cmap
  - cmap_range
  - cmap_transform
  - colors
  - data
  - datapoints_window_func
  - dims
  - display_dims
  - display_range
  - display_window
  - graphic
  - graphic_type
  - indices
  - indices_displayed
  - markers
  - max_display_datapoints
  - name
  - ndim
  - pause
  - shape
  - sizes
  - slicer
  - slider_dims
  - slider_maps
  - spatial_func
  - thickness
  - window_funcs
  - window_order
  - init
- NDPositionsSlicer
- NDTimeseries
  - fastplotlib.NDTimeseries
  - cmap
  - cmap_range
  - cmap_transform
  - colors
  - data
  - datapoints_window_func
  - dims
  - display_dims
  - display_range
  - display_window
  - graphic
  - graphic_type
  - indices
  - indices_displayed
  - markers
  - max_display_datapoints
  - name
  - ndim
  - pause
  - shape
  - sizes
  - slicer
  - slider_dims
  - slider_maps
  - spatial_func
  - thickness
  - window_funcs
  - window_order
  - x_range_mode
  - init
- NDImageSlicer
  - fastplotlib.NDImageSlicer
  - compute_histogram
  - data
  - dims
  - display_dims
  - display_dims_indices
  - histogram
  - n_slider_dims
  - ndim
  - rgb_dim
  - shape
  - slider_dims
  - slider_maps
  - spatial_func
  - tooltip
  - window_funcs
  - window_order
  - close
  - get
  - get_window_output
  - tooltip_format
- NDImage
  - fastplotlib.NDImage
  - clim_quantiles
  - compute_histogram
  - data
  - dims
  - display_dims
  - graphic
  - histogram_widget
  - indices
  - indices_displayed
  - name
  - ndim
  - pause
  - shape
  - slicer
  - slider_dims
  - slider_maps
  - spatial_func
  - window_funcs
  - window_order
- VideoSlicer
  - fastplotlib.VideoSlicer
  - compute_histogram
  - data
  - dims
  - display_dims
  - display_dims_indices
  - histogram
  - n_slider_dims
  - ndim
  - rgb_dim
  - shape
  - slider_dims
  - slider_maps
  - spatial_func
  - tooltip
  - window_funcs
  - window_order
  - close
  - get
  - get_window_output
  - tooltip_format
- NDVectorsSlicer
- NDVectors
  - fastplotlib.NDVectors
  - data
  - dims
  - display_dims
  - graphic
  - indices
  - indices_displayed
  - name
  - ndim
  - pause
  - shape
  - slicer
  - slider_dims
  - slider_maps
  - spatial_func
  - window_funcs
  - window_order
- NDWidget
  - fastplotlib.NDWidget
  - figure
  - indices
  - ndgraphics
  - ranges
  - ui_sliders
  - close
  - show
- NDWSubplot
- ImageWidget
ND Slicer Extras
- pandas
fastplotlib
fastplotlib.utils

API Reference
Widgets
NDPositionsSlicer
tooltip_format

tooltip_format#

NDPositionsSlicer.tooltip_format(*args)#

Override in subclass to format custom tooltips

Return type:: str | None

On this page

NDPositionsSlicer.tooltip_format()

Show Source

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.21.0.