bqplot.market_map.MarketMap

class bqplot.market_map.MarketMap(**kwargs)[source]

Waffle wrapped map.

names

numpy.ndarray of strings (default: []) – The elements can also be objects convertible to string primary key for the map data. A rectangle is created for each unique entry in this array

groups

numpy.ndarray (default: []) – attribute on which the groupby is run. If this is an empty arrray, then there is no group by for the map.

display_text

numpy.ndarray or None(default: None) – data to be displayed on each rectangle of the map.If this is empty it defaults to the names attribute.

ref_data

pandas.DataDrame or None (default: None) – Additional data associated with each element of the map. The data in this data frame can be displayed as a tooltip.

color

numpy.ndarray (default: []) – Data to represent the color for each of the cells. If the value of the data is NaN for a cell, then the color of the cell is the color of the group it belongs to in absence of data for color

scales

Dictionary of scales holding a scale for each data attribute – If the map has data being passed as color, then a corresponding color scale is required

axes

List of axes – Ability to add an axis for the scales which are used to scale data represented in the map

on_hover[source]

custom event – This event is received when the mouse is hovering over a cell. Returns the data of the cell and the ref_data associated with the cell.

tooltip_widget

Instance of a widget – Widget to be displayed as the tooltip. This can be combined with the on_hover event to display the chart corresponding to the cell being hovered on.

tooltip_fields

list – names of the fields from the ref_data dataframe which should be displayed in the tooltip.

tooltip_formats

list – formats for each of the fields for the tooltip data. Order should match the order of the tooltip_fields

show_groups

bool – attribute to determine if the groups should be displayed. If set to True, the finer elements are blurred

Map Drawing Attributes
cols

int – Suggestion for no of columns in the map.If not specified, value is inferred from the no of rows and no of cells

rows

int – No of rows in the map.If not specified, value is inferred from the no of cells and no of columns. If both rows and columns are not specified, then a square is constructed basing on the no of cells. The above two attributes are suggestions which are respected unless they are not feasible. One required condition is that, the number of columns is odd when row_groups is greater than 1.

row_groups

int – No of groups the rows should be divided into. This can be used to draw more square cells for each of the groups

Layout Attributes
map_margin

dict (default: {top=50, bottom=50, left=50, right=50}) – Dictionary containing the top, bottom, left and right margins. The user is responsible for making sure that the width and height are greater than the sum of the margins.

min_aspect_ratio

float – minimum width / height ratio of the figure

max_aspect_ratio

float – maximum width / height ratio of the figure

Display Attributes

colors: list of colors
Colors for each of the groups which are cycled over to cover all the groups
title: string
Title of the Market Map
title_style: dict
CSS style for the title of the Market Map
stroke: color
Stroke of each of the cells of the market map
group_stroke: color
Stroke of the border for the group of cells corresponding to a group
selected_stroke: color
stroke for the selected cells
hovered_stroke: color
stroke for the cell being hovered on
font_style: dict
CSS style for the text of each cell

Other Attributes

enable_select: bool
boolean to control the ability to select the cells of the map by clicking
enable_hover: bool
boolean to control if the map should be aware of which cell is being hovered on. If it is set to False, tooltip will not be displayed

Note

The aspect ratios stand for width / height ratios.

  • If the available space is within bounds in terms of min and max aspect ratio, we use the entire available space.
  • If the available space is too oblong horizontally, we use the client height and the width that corresponds max_aspect_ratio (maximize width under the constraints).
  • If the available space is too oblong vertically, we use the client width and the height that corresponds to min_aspect_ratio (maximize height under the constraint). This corresponds to maximizing the area under the constraints.

Default min and max aspect ratio are both equal to 16 / 9.

__init__(**kwargs)[source]

Public constructor

Methods

__init__(**kwargs) Public constructor
add_class(className) Adds a class to the top level element of the widget.
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_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.
remove_class(className) Removes a class from the top level element of the widget.
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

axes An instance of a Python list.
color A numpy array trait type.
colors An instance of a Python list.
cols An int trait.
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_text A numpy array trait type.
enable_hover A boolean (True, False) trait.
enable_select A boolean (True, False) trait.
font_style An instance of a Python dict.
group_stroke A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
groups A numpy array trait type.
hovered_stroke A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
keys An instance of a Python list.
layout A trait whose value must be an instance of a specified class.
log A trait whose value must be an instance of a specified class.
map_margin An instance of a Python dict.
max_aspect_ratio A float trait.
min_aspect_ratio A float trait.
model_id Gets the model id of this widget.
names A numpy array trait type.
ref_data A pandas dataframe trait type.
row_groups An int trait.
rows An int trait.
scales An instance of a Python dict.
selected An instance of a Python list.
selected_stroke A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
show_groups A boolean (True, False) trait.
stroke A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
title A trait for unicode strings.
title_style An instance of a Python dict.
tooltip_fields An instance of a Python list.
tooltip_formats An instance of a Python list.
tooltip_widget A trait whose value must be an instance of a specified class.
widget_types
widgets