bqplot.interacts.BrushSelector¶

class bqplot.interacts.BrushSelector(**kwargs)[source]¶

Brush interval selector interaction.

This 2-D selector interaction enables the user to select a rectangular region using the brushing action of the mouse. A mouse-down marks the starting point of the interval. The drag after the mouse down selects the rectangle of interest and a mouse-up signifies the end point of the interval.

Once an interval is drawn, the selector can be moved to a new interval by dragging the selector to the new interval.

A double click at the same point without moving the mouse will result in the entire interval being selected.

selected_x¶

Two element array containing the start and end of the interval selected in terms of the x_scale of the selector. This attribute changes while the selection is being made with the BrushSelector.

Type:	numpy.ndarray

selected_y¶

Two element array containing the start and end of the interval selected in terms of the y_scale of the selector. This attribute changes while the selection is being made with the BrushSelector.

Type:	numpy.ndarray

selected¶

Readonly 2x2 array containing the coordinates [[selected_x[0], selected_y[0]],

[selected_x[1], selected_y[1]]]

Type:	list

brushing¶

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.

Type:	bool (default: False)

color¶

Color of the rectangle representing the brush selector.

Type:	Color or None (default: None)

__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.
`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.
`clear`	A boolean (True, False) trait.
`color`	A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
`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.
`selected`
`selected_x`	A numpy array trait type.
`selected_y`	A numpy array trait type.
`types`
`widget_types`
`widgets`
`x_scale`	A trait whose value must be an instance of a specified class.
`y_scale`	A trait whose value must be an instance of a specified class.