bqplot.toolbar.Toolbar

class bqplot.toolbar.Toolbar(**kwargs)[source]

Default toolbar for bqplot figures.

The default toolbar provides three buttons:

  • A Panzoom toggle button which enables panning and zooming the figure.
  • A Save button to save the figure as a png image.
  • A Reset button, which resets the figure position to its original state.

When the Panzoom button is toggled to True for the first time, a new instance of PanZoom widget is created. The created PanZoom widget uses the scales of all the marks that are on the figure at this point. When the PanZoom widget is toggled to False, the figure retrieves its previous interaction. When the Reset button is pressed, the PanZoom widget is deleted and the figure scales reset to their initial state. We are back to the case where the PanZoom widget has never been set.

If new marks are added to the figure after the panzoom button is toggled, and these use new scales, those scales will not be panned or zoomed, unless the reset button is clicked.

figure

instance of Figure – The figure to which the toolbar will apply.

__init__(**kwargs)

Public constructor

Methods

__init__(**kwargs) Public constructor
add_class(className) Adds a class to the top level element of the widget.
add_traits(**traits) Dynamically add trait attributes to the Widget.
class_own_trait_events(name) Get a dict of all event handlers defined on this class, not a parent.
class_own_traits(**metadata) Get a dict of all the traitlets defined on this class, not a parent.
class_trait_names(**metadata) Get a list of all the names of this class’ traits.
class_traits(**metadata) Get a dict of all the traits of this class.
close() Close method.
close_all()
get_manager_state([drop_defaults, widgets]) Returns the full state for a widget manager for embedding
get_state([key, drop_defaults]) Gets the widget state, or a piece of it.
get_view_spec()
handle_comm_opened(comm, msg) Static method, called when a widget is constructed.
has_trait(name) Returns True if the object has a trait with the specified name.
hold_sync() Hold syncing any state until the outermost context manager exits
hold_trait_notifications() Context manager for bundling trait change notifications and cross validation.
notify_change(change) Called when a property has changed.
observe(handler[, names, type]) Setup a handler to be called when a trait changes.
on_displayed(callback[, remove]) (Un)Register a widget displayed callback.
on_msg(callback[, remove]) (Un)Register a custom msg receive callback.
on_trait_change([handler, name, remove]) DEPRECATED: Setup a handler to be called when a trait changes.
on_widget_constructed(callback) Registers a callback to be called when a widget is constructed.
open() Open a comm to the frontend if one isn’t already open.
remove_class(className) Removes a class from the top level element of the widget.
send(content[, buffers]) Sends a custom msg to the widget model in the front-end.
send_state([key]) Sends the widget state, or a piece of it, to the front-end, if it exists.
set_state(sync_data) Called when a state is received from the front-end.
set_trait(name, value) Forcibly sets trait attribute, including read-only attributes.
setup_instance(*args, **kwargs) This is called before self.__init__ is called.
trait_events([name]) Get a dict of all the event handlers of this class.
trait_metadata(traitname, key[, default]) Get metadata values for trait by key.
trait_names(**metadata) Get a list of all the names of this class’ traits.
traits(**metadata) Get a dict of all the traits of this class.
unobserve(handler[, names, type]) Remove a trait change handler.
unobserve_all([name]) Remove trait change handlers of any type for the specified name.

Attributes

comm A trait whose value must be an instance of a specified class.
cross_validation_lock A contextmanager for running a block with our cross validation lock set to True.
figure A trait whose value must be an instance of a specified class.
keys An instance of a Python list.
layout An instance trait which coerces a dict to an instance.
log A trait whose value must be an instance of a specified class.
model_id Gets the model id of this widget.
widget_types
widgets