bqplot.interacts.MultiSelector

class bqplot.interacts.MultiSelector(**kwargs)[source]

Multi selector interaction.

This 1-D selector interaction enables the user to select multiple intervals using the mouse. A mouse-down marks the start of the interval. The drag after the mouse down in the x-direction selects the extent and a mouse-up signifies the end of the interval.

The current selector is highlighted with a green border and the inactive selectors are highlighted with a red border.

The multi selector has three modes:
  1. default mode: In this mode the interaction behaves exactly as the
    brush selector interaction with the current selector.
  2. add mode: In this mode a new selector can be added by clicking at
    a point and dragging over the interval of interest. Once a new selector has been added, the multi selector is back in the default mode. From the default mode, ctrl+click switches to the add mode.
  3. choose mode: In this mode, any of the existing inactive selectors
    can be set as the active selector. When an inactive selector is selected by clicking, the multi selector goes back to the default mode. From the default mode, shift+click switches to the choose mode.

A double click at the same point without moving the mouse in the x-direction will result in the entire interval being selected for the current selector.

selected

dict – A dictionary with keys being the names of the intervals and values being the two element arrays containing the start and end of the interval selected by that particular selector in terms of the scale of the selector. This is a read-only attribute. This attribute changes while the selection is being made with the MultiSelectorinteraction.

brushing

bool (default: False) – A boolean attribute to indicate if the selector is being dragged. It is True when the selector is being moved and false when it is not. This attribute can be used to trigger computationally intensive code which should be run only on the interval selection being completed as opposed to code which should be run whenever selected is changing.

names

list – A list of strings indicating the keys of the different intervals. Default values are ‘int1’, ‘int2’, ‘int3’ and so on.

show_names

bool (default: True) – Attribute to indicate if the names of the intervals are to be displayed along with the interval.

__init__(**kwargs)[source]

Public constructor

Methods

__init__(**kwargs) Public constructor
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.
hidden_selected_changed(name, selected)
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.
reset()
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

brushing A boolean (True, False) trait.
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.
keys An instance of a Python list.
log A trait whose value must be an instance of a specified class.
marks An instance of a Python list.
model_id Gets the model id of this widget.
names An instance of a Python list.
scale A trait whose value must be an instance of a specified class.
selected An instance of a Python dict.
show_names A boolean (True, False) trait.
types
widget_types
widgets