bqplot.marks.Label

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

Label mark.

x_offset

int (default: 0) – horizontal offset in pixels from the stated x location

y_offset

int (default: 0) – vertical offset in pixels from the stated y location

text

string (default: ‘’) – text to be displayed

default_size

string (default: ‘14px’) – font size in px, em or ex

font_weight

{‘bold’, ‘normal’, ‘bolder’} – font weight of the caption

drag_size

nonnegative float (default: 1.) – Ratio of the size of the dragged label font size to the default label font size.

align

{‘start’, ‘middle’, ‘end’} – alignment of the text with respect to the provided location enable_move: Bool (default: False) Enable the label to be moved by dragging. Refer to restrict_x, restrict_y for more options.

restrict_x

bool (default: False) – Restricts movement of the label to only along the x axis. This is valid only when enable_move is set to True. If both restrict_x and restrict_y are set to True, the label cannot be moved.

restrict_y

bool (default: False) – Restricts movement of the label to only along the y axis. This is valid only when enable_move is set to True. If both restrict_x and restrict_y are set to True, the label cannot be moved.

Data Attributes
x

numpy.ndarray (default: []) – horizontal position of the labels, in data coordinates or in figure coordinates

y

numpy.ndarray (default: []) – vertical position of the labels, in data coordinates or in figure coordinates

color

numpy.ndarray or None (default: None) – label colors

size

numpy.ndarray or None (default: None) – label sizes

rotation

numpy.ndarray or None (default: None) – label rotations

opacity

numpy.ndarray or None (default: None) – label opacities

__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_drag(callback[, remove])
on_drag_end(callback[, remove])
on_drag_start(callback[, remove])
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.
color A numpy array trait type.
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.
default_opacities An instance of a Python list.
default_size A float trait.
display_legend A boolean (True, False) trait.
drag_size A float trait.
enable_delete A boolean (True, False) trait.
enable_hover A boolean (True, False) trait.
enable_move A boolean (True, False) trait.
font_unit An enum whose value must be in a given sequence.
font_weight An enum whose value must be in a given sequence.
hovered_point An int trait.
hovered_style An instance of a Python dict.
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
opacity A numpy array trait type.
preserve_domain An instance of a Python dict.
restrict_x A boolean (True, False) trait.
restrict_y A boolean (True, False) trait.
rotate_angle A float trait.
rotation A numpy array trait type.
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.
size A numpy array trait type.
text A numpy array trait type.
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.
unhovered_style An instance of a Python dict.
unselected_style An instance of a Python dict.
update_on_move A boolean (True, False) trait.
visible A boolean (True, False) trait.
widget_types
widgets
x A numpy array trait type.
x_offset An int trait.
y A numpy array trait type.
y_offset An int trait.