bqplot.axes.Axis

class bqplot.axes.Axis(**kwargs)[source]

A line axis.

A line axis is the visual representation of a numerical or date scale.

icon

string (class-level attribute) – The font-awesome icon name for this object.

axis_types

dict (class-level attribute) – A registry of existing axis types.

orientation

{‘horizontal’, ‘vertical’} – The orientation of the axis, either vertical or horizontal

side

{‘bottom’, ‘top’, ‘left’, ‘right’} or None (default: None) – The side of the axis, either bottom, top, left or right.

label

string (default: ‘’) – The axis label

tick_format

string or None (default: ‘’) – The tick format for the axis, for dates use d3 string formatting.

scale

Scale – The scale represented by the axis

num_ticks

int or None (default: None) – If tick_values is None, number of ticks

tick_values

numpy.ndarray or None (default: None) – Tick values for the axis

offset

dict (default: {}) – Contains a scale and a value {‘scale’: scale or None, ‘value’: value of the offset} If offset[‘scale’] is None, the corresponding figure scale is used instead.

label_location

{‘middle’, ‘start’, ‘end’} – The location of the label along the axis, one of ‘start’, ‘end’ or ‘middle’

label_color

Color or None (default: None) – The color of the axis label

grid_lines

{‘none’, ‘solid’, ‘dashed’} – The display of the grid lines

grid_color

Color or None (default: None) – The color of the grid lines

color

Color or None (default: None) – The color of the line

label_offset

string or None (default: None) – Label displacement from the axis line. Units allowed are ‘em’, ‘px’ and ‘ex’. Positive values are away from the figure and negative values are towards the figure with resepect to the axis line.

visible

bool (default: True) – A visibility toggle for the axis

tick_style

Dict (default: {}) – Dictionary containing the CSS-style of the text for the ticks. For example: font-size of the text can be changed by passing {‘font-size’: 14}

__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

axis_types
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.
grid_color A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
grid_lines An enum whose value must be in a given sequence.
icon
keys An instance of a Python list.
label A trait for unicode strings.
label_color A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
label_location An enum whose value must be in a given sequence.
label_offset A trait for unicode strings.
log A trait whose value must be an instance of a specified class.
model_id Gets the model id of this widget.
num_ticks An int trait.
offset An instance of a Python dict.
orientation An enum whose value must be in a given sequence.
scale A trait whose value must be an instance of a specified class.
side An enum whose value must be in a given sequence.
tick_format A trait for unicode strings.
tick_style An instance of a Python dict.
tick_values A numpy array trait type.
visible A boolean (True, False) trait.
widget_types
widgets