bqplot.interacts.HandDraw

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

A hand-draw interaction.

This can be used to edit the ‘y’ value of an existing line using the mouse. The minimum and maximum x values of the line which can be edited may be passed as parameters. The y-values for any part of the line can be edited by drawing the desired path while holding the mouse-down. y-values corresponding to x-values smaller than min_x or greater than max_x cannot be edited by HandDraw.

lines

an instance Lines mark or None (default: None) – The instance of Lines which is edited using the hand-draw interaction. The ‘y’ values of the line are changed according to the path of the mouse. If the lines has multi dimensional ‘y’, then the ‘line_index’ attribute is used to selected the ‘y’ to be edited.

line_index

nonnegative integer (default: 0) – For a line with multi-dimensional ‘y’, this indicates the index of the ‘y’ to be edited by the handdraw.

min_x

float or Date or None (default: None) – The minimum value of ‘x’ which should be edited via the handdraw.

max_x

float or Date or None (default: None) – The maximum value of ‘x’ which should be edited via the handdraw.

__init__(**kwargs)

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.
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.
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.
keys An instance of a Python list.
line_index An int trait.
lines A trait whose value must be an instance of a specified class.
log A trait whose value must be an instance of a specified class.
max_x A trait type representing a Union type.
min_x A trait type representing a Union type.
model_id Gets the model id of this widget.
types
widget_types
widgets