bqplot.marks.Bars

class bqplot.marks.Bars(**kwargs)[source]

Bar mark.

In the case of the Bars mark, scales for ‘x’ and ‘y’ MUST be provided. The scales of other data attributes are optional. In the case where another data attribute than ‘x’ or ‘y’ is provided but the corresponding scale is missing, the data attribute is ignored.

icon

string (class-level attribute) – font-awesome icon for that mark

name

string (class-level attribute) – user-friendly name of the mark

color_mode

{‘auto’, ‘group’, ‘element’} – enum attribute to specify if color should be the same for all bars with the same x or for all bars which belong to the same array in Y ‘group’ means for every x all bars have same color. ‘element’ means for every dimension of y, all bars have same color. ‘auto’ picks ‘group’ and ‘element’ for 1-d and 2-d values of Y respectively.

type

{‘stacked’, ‘grouped’} – whether 2-dimensional bar charts should appear grouped or stacked.

colors

list of colors (default: [‘steelblue’]) – list of colors for the bars.

orientation

{‘horizontal’, ‘vertical’} – Specifies whether the bar chart is drawn horizontally or vertically. If a horizontal bar chart is drawn, the x data is drawn vertically.

padding

float (default: 0.05) – attribute to control the spacing between the bars value is specified as a percentage of the width of the bar

stroke

Color or None (default: None) – stroke color for the bars

opacities

list of floats (default: []) – Opacities for the bars. Defaults to 1 when the list is too short, or the element of the list is set to None.

base

float (default: 0.0) – reference value from which the bars are drawn. defaults to 0.0

align

{‘center’, ‘left’, ‘right’} – alignment of bars with respect to the tick value

Data Attributes
x

numpy.ndarray (default: []) – abscissas of the data points (1d array)

y

numpy.ndarray (default: []) – ordinates of the values for the data points

color

numpy.ndarray or None (default: None) – color of the data points (1d array). Defaults to default_color when not provided or when a value is NaN

Notes

The fields which can be passed to the default tooltip are:
All the data attributes index: index of the bar being hovered on sub_index: if data is two dimensional, this is the minor index
__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([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(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_background_click(callback[, remove])
on_click(callback[, remove])
on_displayed(callback[, remove]) (Un)Register a widget displayed callback.
on_element_click(callback[, remove])
on_hover(callback[, remove])
on_legend_click(callback[, remove])
on_legend_hover(callback[, remove])
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() 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

align An enum whose value must be in a given sequence.
apply_clip A boolean (True, False) trait.
base A float trait.
color A numpy array trait type.
color_mode An enum whose value must be in a given sequence.
colors An instance of a Python list.
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.
display_legend A boolean (True, False) trait.
enable_hover A boolean (True, False) trait.
icon
interactions An instance of a Python dict.
keys An instance of a Python list.
labels An instance of a Python list.
log A trait whose value must be an instance of a specified class.
mark_types
model_id Gets the model id of this widget.
name
opacities An instance of a Python list.
orientation An enum whose value must be in a given sequence.
padding A float trait.
preserve_domain An instance of a Python dict.
scales An instance of a Python dict.
scales_metadata An instance of a Python dict.
selected An instance of a Python list.
selected_style An instance of a Python dict.
stroke A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
tooltip A trait whose value must be an instance of a specified class.
tooltip_location An enum whose value must be in a given sequence.
tooltip_style An instance of a Python dict.
type An enum whose value must be in a given sequence.
unselected_style An instance of a Python dict.
visible A boolean (True, False) trait.
widget_types
widgets
x A numpy array trait type.
y A numpy array trait type.