bqplot.marks.GridHeatMap

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

GridHeatMap mark.

Alignment: The tiles can be aligned so that the data matches either the start, the end or the midpoints of the tiles. This is controlled by the align attribute.

Suppose the data passed is a m-by-n matrix. If the scale for the rows is Ordinal, then alignment is by default the mid points. For a non-ordinal scale, the data cannot be aligned to the mid points of the rectangles.

If it is not ordinal, then two cases arise. If the number of rows passed is m, then align attribute can be used. If the number of rows passed is m+1, then the data are the boundaries of the m rectangles.

If rows and columns are not passed, and scales for them are also not passed, then ordinal scales are generated for the rows and columns.

row_align

Enum([‘start’, ‘end’]) – This is only valid if the number of entries in row exactly match the number of rows in color and the row_scale is not OrdinalScale. start aligns the row values passed to be aligned with the start of the tiles and end aligns the row values to the end of the tiles.

column_align

Enum([‘start’, end’]) – This is only valid if the number of entries in column exactly match the number of columns in color and the column_scale is not OrdinalScale. start aligns the column values passed to be aligned with the start of the tiles and end aligns the column values to the end of the tiles.

anchor_style

dict (default: {‘fill’: ‘white’, ‘stroke’: ‘blue’}) – Controls the style for the element which serves as the anchor during selection.

Data Attributes
color

numpy.ndarray or None (default: None) – color of the data points (2d array). The number of elements in this array correspond to the number of cells created in the heatmap.

row

numpy.ndarray or None (default: None) – labels for the rows of the color array passed. The length of this can be no more than 1 away from the number of rows in color. This is a scaled attribute and can be used to affect the height of the cells as the entries of row can indicate the start or the end points of the cells. Refer to the property row_align. If this property is None, then a uniformly spaced grid is generated in the row direction.

column

numpy.ndarray or None (default: None) – labels for the columns of the color array passed. The length of this can be no more than 1 away from the number of columns in color This is a scaled attribute and can be used to affect the width of the cells as the entries of column can indicate the start or the end points of the cells. Refer to the property column_align. If this property is None, then a uniformly spaced grid is generated in the column direction.

__init__(**kwargs)[source]

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_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(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

anchor_style An instance of a Python dict.
apply_clip A boolean (True, False) trait.
color A numpy array trait type.
column A numpy array trait type.
column_align An enum whose value must be in a given sequence.
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.
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.
null_color A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
opacity A float trait.
preserve_domain An instance of a Python dict.
row A numpy array trait type.
row_align An enum whose value must be in a given sequence.
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.
unselected_style An instance of a Python dict.
visible A boolean (True, False) trait.
widget_types
widgets