bqplot.Axis
+
+
+
+ Bases: BaseAxis
A line axis.
+A line axis is the visual representation of a numerical or date scale.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
icon |
+
+ The font-awesome icon name for this object. +
+
+ TYPE:
+ |
+
axis_types |
+
+ A registry of existing axis types. +
+
+ TYPE:
+ |
+
orientation |
+
+ The orientation of the axis, either vertical or horizontal +
+
+ TYPE:
+ |
+
side |
+
+ The side of the axis, either bottom, top, left or right. +
+
+ TYPE:
+ |
+
label |
+
+ The axis label +
+
+ TYPE:
+ |
+
tick_format |
+
+ The tick format for the axis, for dates use d3 string formatting. +
+
+ TYPE:
+ |
+
scale |
+
+ The scale represented by the axis +
+
+ TYPE:
+ |
+
num_ticks |
+
+ If tick_values is None, number of ticks +
+
+ TYPE:
+ |
+
tick_values |
+
+ Tick values for the axis +
+
+ TYPE:
+ |
+
tick_labels |
+
+ Override the tick labels with a dictionary of {value: label}. +Entries are optional, and if not provided, the default tick labels +will be used. +
+
+ TYPE:
+ |
+
offset |
+
+ 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. +
+
+ TYPE:
+ |
+
label_location |
+
+ The location of the label along the axis, one of 'start', 'end' or +'middle' +
+
+ TYPE:
+ |
+
label_color |
+
+ The color of the axis label +
+
+ TYPE:
+ |
+
grid_lines |
+
+ The display of the grid lines +
+
+ TYPE:
+ |
+
grid_color |
+
+ The color of the grid lines +
+
+ TYPE:
+ |
+
color |
+
+ The color of the line +
+
+ TYPE:
+ |
+
label_offset |
+
+ 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 respect to the axis line. +
+
+ TYPE:
+ |
+
visible |
+
+ A visibility toggle for the axis +
+
+ TYPE:
+ |
+
tick_style |
+
+ Dictionary containing the CSS-style of the text for the ticks.
+For example: font-size of the text can be changed by passing
+
+
+ TYPE:
+ |
+
tick_rotate |
+
+ Degrees to rotate tick labels by. +
+
+ TYPE:
+ |
+
bqplot.ColorAxis
+
+
+
+ Bases: Axis
A colorbar axis.
+A color axis is the visual representation of a color scale.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale |
+
+ The scale represented by the axis +
+
+ TYPE:
+ |
+
bqplot.Figure
+
+
+
+ Bases: DOMWidget
Main canvas for drawing a chart.
+The Figure object holds the list of Marks and Axes. It also holds an +optional Interaction object that is responsible for figure-level mouse +interactions, the "interaction layer".
+Besides, the Figure object has two reference scales, for positioning items +in an absolute fashion in the figure canvas.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
title |
+
+ title of the figure +
+
+ TYPE:
+ |
+
axes |
+
+ list containing the instances of the axes for the figure +
+
+ TYPE:
+ |
+
marks |
+
+ list containing the marks which are to be appended to the figure +
+
+ TYPE:
+ |
+
interaction |
+
+ optional interaction layer for the figure +
+
+ TYPE:
+ |
+
scale_x |
+
+ Scale representing the x values of the figure +
+
+ TYPE:
+ |
+
scale_y |
+
+ Scale representing the y values of the figure +
+
+ TYPE:
+ |
+
padding_x |
+
+ Padding to be applied in the horizontal direction of the figure +around the data points, proportion of the horizontal length +
+
+ TYPE:
+ |
+
padding_y |
+
+ Padding to be applied in the vertical direction of the figure +around the data points, proportion of the vertical length +
+
+ TYPE:
+ |
+
legend_location |
+
+ 'bottom-left', 'bottom', 'bottom-right', 'right'} +location of the legend relative to the center of the figure +
+
+ TYPE:
+ |
+
background_style |
+
+ CSS style to be applied to the background of the figure +
+
+ TYPE:
+ |
+
legend_style |
+
+ CSS style to be applied to the SVG legend e.g, {'fill': 'white'} +
+
+ TYPE:
+ |
+
legend_text |
+
+ CSS style to be applied to the legend text e.g., {'font-size': 20} +
+
+ TYPE:
+ |
+
title_style |
+
+ CSS style to be applied to the title of the figure +
+
+ TYPE:
+ |
+
animation_duration |
+
+ Duration of transition on change of data attributes, in milliseconds. +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
pixel_ratio |
+
+ Pixel ratio of the WebGL canvas (2 on retina screens). Set to 1 for better performance, +but less crisp edges. If set to None it will use the browser's window.devicePixelRatio. ++ + |
+
display_toolbar |
+
+ Show or hide the integrated toolbar. +
+
+ TYPE:
+ |
+
fig_margin |
+
+ 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. +
+
+ TYPE:
+ |
+
min_aspect_ratio |
+
+ minimum width / height ratio of the figure +
+
+ TYPE:
+ |
+
max_aspect_ratio |
+
+ maximum width / height ratio of the figure +
+
+ TYPE:
+ |
+
Note
+The aspect ratios stand for width / height ratios.
+Default min and max aspect ratio are both equal to 16 / 9.
+get_png_data(callback, scale=None)
+
+Gets the Figure as a PNG memory view
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
callback |
+
+ Called with the PNG data as the only positional argument. ++ + |
+
scale |
+
+ Scale up the png resolution when scale > 1, when not given base this on the screen pixel ratio. +
+
+ DEFAULT:
+ |
+
save_png(filename='bqplot.png', scale=None)
+
+Saves the Figure as a PNG file
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
filename |
+
+ name of the saved file +
+
+ DEFAULT:
+ |
+
scale |
+
+ Scale up the png resolution when scale > 1, when not given base this on the screen pixel ratio. +
+
+ DEFAULT:
+ |
+
save_svg(filename='bqplot.svg')
+
+Saves the Figure as an SVG file
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
filename |
+
+ name of the saved file +
+
+ DEFAULT:
+ |
+
bqplot.interacts.BrushIntervalSelector
+
+
+
+ Bases: OneDSelector
Brush interval selector interaction.
+This 1-D selector interaction enables the user to select an interval using +the brushing action of the mouse. A mouse-down marks the start of the +interval. The drag after the mouse down in the x-direction selects the +extent and a mouse-up signifies the end of the interval.
+Once an interval is drawn, the selector can be moved to a new interval by +dragging the selector to the new interval.
+A double click at the same point without moving the mouse in the +x-direction will result in the entire interval being selected.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
selected |
+
+ Two element array containing the start and end of the interval selected
+in terms of the scale of the selector.
+This attribute changes while the selection is being made with the
+
+
+ TYPE:
+ |
+
brushing |
+
+ Boolean attribute to indicate if the selector is being dragged. +It is True when the selector is being moved and False when it is not. +This attribute can be used to trigger computationally intensive code +which should be run only on the interval selection being completed as +opposed to code which should be run whenever selected is changing. +
+
+ TYPE:
+ |
+
orientation |
+
+ The orientation of the interval, either vertical or horizontal +
+
+ TYPE:
+ |
+
color |
+
+ Color of the rectangle representing the brush selector. +
+
+ TYPE:
+ |
+
bqplot.interacts.BrushSelector
+
+
+
+ Bases: TwoDSelector
Brush interval selector interaction.
+This 2-D selector interaction enables the user to select a rectangular +region using the brushing action of the mouse. A mouse-down marks the +starting point of the interval. The drag after the mouse down selects the +rectangle of interest and a mouse-up signifies the end point of +the interval.
+Once an interval is drawn, the selector can be moved to a new interval by +dragging the selector to the new interval.
+A double click at the same point without moving the mouse will result in +the entire interval being selected.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
selected_x |
+
+ Two element array containing the start and end of the interval selected
+in terms of the x_scale of the selector.
+This attribute changes while the selection is being made with the
+
+
+ TYPE:
+ |
+
selected_y |
+
+ Two element array containing the start and end of the interval selected
+in terms of the y_scale of the selector.
+This attribute changes while the selection is being made with the
+
+
+ TYPE:
+ |
+
selected |
+
+ A 2x2 array containing the coordinates :: +[[selected_x[0], selected_y[0]], +[selected_x[1], selected_y[1]]] +
+
+ TYPE:
+ |
+
brushing |
+
+ boolean attribute to indicate if the selector is being dragged. +It is True when the selector is being moved and False when it is not. +This attribute can be used to trigger computationally intensive code +which should be run only on the interval selection being completed as +opposed to code which should be run whenever selected is changing. +
+
+ TYPE:
+ |
+
color |
+
+ Color of the rectangle representing the brush selector. +
+
+ TYPE:
+ |
+
bqplot.interacts.HandDraw
+
+
+
+ Bases: Interaction
A hand-draw interaction.
+This can be used to edit the 'y' value of an existing line using the mouse. +The minimum and maximum x values of the line which can be edited may be +passed as parameters. +The y-values for any part of the line can be edited by drawing the desired +path while holding the mouse-down. +y-values corresponding to x-values smaller than min_x or greater than max_x +cannot be edited by HandDraw.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
lines |
+
+ The instance of Lines which is edited using the hand-draw interaction. +The 'y' values of the line are changed according to the path of the +mouse. If the lines has multi dimensional 'y', then the 'line_index' +attribute is used to selected the 'y' to be edited. +
+
+ TYPE:
+ |
+
line_index |
+
+ For a line with multi-dimensional 'y', this indicates the index of the +'y' to be edited by the handdraw. +
+
+ TYPE:
+ |
+
min_x |
+
+ The minimum value of 'x' which should be edited via the handdraw. +
+
+ TYPE:
+ |
+
max_x |
+
+ The maximum value of 'x' which should be edited via the handdraw. +
+
+ TYPE:
+ |
+
bqplot.interacts.IndexSelector
+
+
+
+ Bases: OneDSelector
Index selector interaction.
+This 1-D selector interaction uses the mouse x-coordinate to select the +corresponding point in terms of the selector scale.
+Index Selector has two modes: + 1. default mode: The mouse controls the x-position of the selector. + 2. frozen mode: In this mode, the selector is frozen at a point and + does not respond to mouse events.
+A single click switches between the two modes.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
selected |
+
+ A single element array containing the point corresponding the +x-position of the mouse. This attribute is updated as you move the +mouse along the x-direction on the figure. +
+
+ TYPE:
+ |
+
color |
+
+ Color of the line representing the index selector. +
+
+ TYPE:
+ |
+
line_width |
+
+ Width of the line representing the index selector. +
+
+ TYPE:
+ |
+
bqplot.interacts.FastIntervalSelector
+
+
+
+ Bases: OneDSelector
Fast interval selector interaction.
+This 1-D selector is used to select an interval on the x-scale +by just moving the mouse (without clicking or dragging). The +x-coordinate of the mouse controls the mid point of the interval selected +while the y-coordinate of the mouse controls the the width of the interval. +The larger the y-coordinate, the wider the interval selected.
+Interval selector has three modes: + 1. default mode: This is the default mode in which the mouse controls + the location and width of the interval. + 2. fixed-width mode: In this mode the width of the interval is frozen + and only the location of the interval is controlled with the + mouse. + A single click from the default mode takes you to this mode. + Another single click takes you back to the default mode. + 3. frozen mode: In this mode the selected interval is frozen and the + selector does not respond to mouse move. + A double click from the default mode takes you to this mode. + Another double click takes you back to the default mode.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
selected |
+
+ Two-element array containing the start and end of the interval selected +in terms of the scale of the selector. +
+
+ TYPE:
+ |
+
color |
+
+ color of the rectangle representing the interval selector +
+
+ TYPE:
+ |
+
size |
+
+ if not None, this is the fixed pixel-width of the interval selector +
+
+ TYPE:
+ |
+
bqplot.interacts.MultiSelector
+
+
+
+ Bases: BrushIntervalSelector
Multi selector interaction.
+This 1-D selector interaction enables the user to select multiple intervals +using the mouse. A mouse-down marks the start of the interval. The drag +after the mouse down in the x-direction selects the extent and a mouse-up +signifies the end of the interval.
+The current selector is highlighted with a green border and the inactive +selectors are highlighted with a red border.
+The multi selector has three modes: + 1. default mode: In this mode the interaction behaves exactly as the + brush selector interaction with the current selector. + 2. add mode: In this mode a new selector can be added by clicking at + a point and dragging over the interval of interest. Once a new + selector has been added, the multi selector is back in the + default mode. + From the default mode, ctrl+click switches to the add mode. + 3. choose mode: In this mode, any of the existing inactive selectors + can be set as the active selector. When an inactive selector is + selected by clicking, the multi selector goes back to the + default mode. + From the default mode, shift+click switches to the choose mode.
+A double click at the same point without moving the mouse in the +x-direction will result in the entire interval being selected for the +current selector.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
selected |
+
+ A dictionary with keys being the names of the intervals and values +being the two element arrays containing the start and end of the +interval selected by that particular selector in terms of the scale of +the selector. +This is a read-only attribute. +This attribute changes while the selection is being made with the +MultiSelectorinteraction. +
+
+ TYPE:
+ |
+
brushing |
+
+ A boolean attribute to indicate if the selector is being dragged. +It is True when the selector is being moved and false when it is not. +This attribute can be used to trigger computationally intensive code +which should be run only on the interval selection being completed as +opposed to code which should be run whenever selected is changing. +
+
+ TYPE:
+ |
+
names |
+
+ A list of strings indicating the keys of the different intervals. +Default values are 'int1', 'int2', 'int3' and so on. +
+
+ TYPE:
+ |
+
show_names |
+
+ Attribute to indicate if the names of the intervals are to be displayed +along with the interval. +
+
+ TYPE:
+ |
+
bqplot.interacts.OneDSelector
+
+
+
+ Bases: Selector
One-dimensional selector interaction
+Base class for all selectors which select data in one dimension, i.e.,
+either the x or the y direction. The scale attribute should
+be provided.
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale |
+
+ This is the scale which is used for inversion from the pixels to data +coordinates. This scale is used for setting the selected attribute for +the selector. +
+
+ TYPE:
+ |
+
bqplot.interacts.Interaction
+
+
+
+ Bases: Widget
The base interaction class.
+An interaction is a mouse interaction layer for a figure that requires the +capture of all mouse events on the plot area. A consequence is that one can +allow only one interaction at any time on a figure.
+An interaction can be associated with features such as selection or +manual change of specific mark. Although, they differ from the so called +'mark interactions' in that they do not rely on knowing whether a specific +element of the mark are hovered by the mouse.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
types |
+
+ A registry of existing interaction types. +
+
+ TYPE:
+ |
+
bqplot.interacts.PanZoom
+
+
+
+ Bases: Interaction
An interaction to pan and zoom wrt scales.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
allow_pan |
+
+ Toggle the ability to pan. +
+
+ TYPE:
+ |
+
allow_zoom |
+
+ Toggle the ability to zoom. +
+
+ TYPE:
+ |
+
scales |
+
+ Dictionary with keys such as 'x' and 'y' and values being the scales in +the corresponding direction (dimensions) which should be panned or +zoomed. +
+
+ TYPE:
+ |
+
bqplot.interacts.Selector
+
+
+
+ Bases: Interaction
Selector interaction. A selector can be used to select a subset of data
+Base class for all the selectors.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
marks |
+
+ list of marks for which the
+
+ TYPE:
+ |
+
bqplot.interacts.TwoDSelector
+
+
+
+ Bases: Selector
Two-dimensional selector interaction.
+Base class for all selectors which select data in both the x and y +dimensions. The attributes 'x_scale' and 'y_scale' should be provided.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x_scale |
+
+ This is the scale which is used for inversion from the pixels to data
+coordinates in the x-direction. This scale is used for setting the
+selected attribute for the selector along with
+
+ TYPE:
+ |
+
y_scale |
+
+ This is the scale which is used for inversion from the pixels to data
+coordinates in the y-direction. This scale is used for setting the
+selected attribute for the selector along with
+
+ TYPE:
+ |
+
bqplot.market_map.MarketMap
+
+
+
+ Bases: DOMWidget
Waffle wrapped map. A MarketMap is not a Mark, it's a custom Figure!
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
names |
+
+ 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 +
+
+ TYPE:
+ |
+
groups |
+
+ attribute on which the groupby is run. If this is an empty array, then +there is no group by for the map. +
+
+ TYPE:
+ |
+
display_text |
+
+ data to be displayed on each rectangle of the map.If this is empty it +defaults to the names attribute. +
+
+ TYPE:
+ |
+
ref_data |
+
+ Additional data associated with each element of the map. The data in +this data frame can be displayed as a tooltip. +
+
+ TYPE:
+ |
+
color |
+
+ 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 +
+
+ TYPE:
+ |
+
scales |
+
+ If the map has data being passed as color, then a corresponding color +scale is required +
+
+ TYPE:
+ |
+
axes |
+
+ Ability to add an axis for the scales which are used to scale data +represented in the map +
+
+ TYPE:
+ |
+
on_hover |
+
+ 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. +
+
+ TYPE:
+ |
+
tooltip_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. +
+
+ TYPE:
+ |
+
tooltip_fields |
+
+ names of the fields from the ref_data dataframe which should be +displayed in the tooltip. +
+
+ TYPE:
+ |
+
tooltip_formats |
+
+ formats for each of the fields for the tooltip data. Order should match +the order of the tooltip_fields +
+
+ TYPE:
+ |
+
freeze_tooltip_location |
+
+ if True, freezes the location of the tooltip. If False, tooltip will +follow the mouse +
+
+ TYPE:
+ |
+
show_groups |
+
+ attribute to determine if the groups should be displayed. If set to +True, the finer elements are blurred +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
cols |
+
+ Suggestion for no of columns in the map.If not specified, value is +inferred from the no of rows and no of cells +
+
+ TYPE:
+ |
+
rows |
+
+ 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. +
+
+ TYPE:
+ |
+
row_groups |
+
+ No of groups the rows should be divided into. This can be used to draw +more square cells for each of the groups +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
map_margin |
+
+ 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. +
+
+ TYPE:
+ |
+
min_aspect_ratio |
+
+ minimum width / height ratio of the figure +
+
+ TYPE:
+ |
+
max_aspect_ratio |
+
+ maximum width / height ratio of the figure +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
colors |
+
+ Colors for each of the groups which are cycled over to cover all the +groups +
+
+ TYPE:
+ |
+
title |
+
+ Title of the Market Map +
+
+ TYPE:
+ |
+
title_style |
+
+ CSS style for the title of the Market Map +
+
+ TYPE:
+ |
+
stroke |
+
+ Stroke of each of the cells of the market map +
+
+ TYPE:
+ |
+
group_stroke |
+
+ Stroke of the border for the group of cells corresponding to a group +
+
+ TYPE:
+ |
+
selected_stroke |
+
+ stroke for the selected cells +
+
+ TYPE:
+ |
+
hovered_stroke |
+
+ stroke for the cell being hovered on +
+
+ TYPE:
+ |
+
font_style |
+
+ CSS style for the text of each cell +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
enable_select |
+
+ boolean to control the ability to select the cells of the map by +clicking +
+
+ TYPE:
+ |
+
enable_hover |
+
+ 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 +
+
+ TYPE:
+ |
+
Note
+The aspect ratios stand for width / height ratios.
+Default min and max aspect ratio are both equal to 16 / 9.
+bqplot.Mark
+
+
+
+ Bases: Widget
The base mark class.
+Traitlet mark attributes may be decorated with metadata.
+Data Attribute Decoration
+Data attributes are decorated with the following values:
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
display_name |
+
+ Holds a user-friendly name for the trait attribute. +
+
+ TYPE:
+ |
+
mark_types |
+
+ A registry of existing mark types. +
+
+ TYPE:
+ |
+
scales |
+
+ A dictionary of scales holding scales for each data attribute. +- If a mark holds a scaled attribute named 'x', the scales dictionary +must have a corresponding scale for the key 'x'. +- The scale's range type should be equal to the scaled attribute's +range type (rtype). +
+
+ TYPE:
+ |
+
scales_metadata |
+
+ A dictionary of dictionaries holding metadata on the way scales are +used by the mark. For example, a linear scale may be used to count +pixels horizontally or vertically. The content of this dictionary +may change dynamically. It is an instance-level attribute. +
+
+ TYPE:
+ |
+
preserve_domain |
+
+ Indicates if this mark affects the domain(s) of the specified scale(s). +The keys of this dictionary are the same as the ones of the "scales" +attribute, and values are boolean. If a key is missing, it is +considered as False. +
+
+ TYPE:
+ |
+
display_legend |
+
+ Display toggle for the mark legend in the general figure legend +
+
+ TYPE:
+ |
+
labels |
+
+ Labels of the items of the mark. This attribute has different meanings +depending on the type of mark. +
+
+ TYPE:
+ |
+
apply_clip |
+
+ Indicates whether the items that are beyond the limits of the chart +should be clipped. +
+
+ TYPE:
+ |
+
visible |
+
+ Visibility toggle for the mark. +
+
+ TYPE:
+ |
+
selected_style |
+
+ CSS style to be applied to selected items in the mark. +
+
+ TYPE:
+ |
+
unselected_style |
+
+ CSS style to be applied to items that are not selected in the mark, +when a selection exists. +
+
+ TYPE:
+ |
+
selected |
+
+ Indices of the selected items in the mark. +
+
+ TYPE:
+ |
+
tooltip |
+
+ Widget to be displayed as tooltip when elements of the scatter are +hovered on +
+
+ TYPE:
+ |
+
tooltip_style |
+
+ Styles to be applied to the tooltip widget +
+
+ TYPE:
+ |
+
enable_hover |
+
+ Boolean attribute to control the hover interaction for the scatter. If +this is false, the on_hover custom mssg is not sent back to the python +side +
+
+ TYPE:
+ |
+
interactions |
+
+ Dictionary listing the different interactions for each mark. The key is +the event which triggers the interaction and the value is the kind of +interactions. Keys and values can only take strings from separate enums +for each mark. +
+
+ TYPE:
+ |
+
tooltip_location |
+
+ Enum specifying the location of the tooltip. 'mouse' places the tooltip +at the location of the mouse when the tooltip is activated and 'center' +places the tooltip at the center of the figure. If tooltip is linked to +a click event, 'mouse' places the tooltip at the location of the click +that triggered the tooltip to be visible. +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
on_hover(callback, remove=False) |
+
+ Register a callback that will be triggered on hover. ++ + |
+
on_click(callback, remove=False) |
+
+ Register a callback that will be triggered on click. ++ + |
+
on_legend_hover(callback, remove=False) |
+
+ Register a callback that will be triggered on legend hover. ++ + |
+
on_legend_click(callback, remove=False) |
+
+ Register a callback that will be triggered on legend click. ++ + |
+
on_element_click(callback, remove=False) |
+
+ Register a callback that will be triggered on element click. ++ + |
+
on_background_click(callback, remove=False) |
+
+ Register a callback that will be triggered on background click. ++ + |
+
bqplot.Lines
+
+
+
+ Bases: Mark
Lines mark.
+Warning
+In the case of the Lines mark, scales for 'x' and 'y' must be provided.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x |
+
+ abscissas of the data points (1d or 2d array) +
+
+ TYPE:
+ |
+
y |
+
+ ordinates of the data points (1d or 2d array) +
+
+ TYPE:
+ |
+
color |
+
+ colors of the different lines based on data. If it is [], then the +colors from the colors attribute are used. Each line has a single color +and if the size of colors is less than the number of lines, the +remaining lines are given the default colors. +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
icon |
+
+ Font-awesome icon for the respective mark +
+
+ TYPE:
+ |
+
name |
+
+ User-friendly name of the mark +
+
+ TYPE:
+ |
+
colors |
+
+ List of colors of the Lines. If the list is shorter than the number +of lines, the colors are reused. +
+
+ TYPE:
+ |
+
close_path |
+
+ Whether to close the paths or not. +
+
+ TYPE:
+ |
+
fill |
+
+ Fill in the area defined by the curves +
+
+ TYPE:
+ |
+
fill_colors |
+
+ Fill colors for the areas. Defaults to stroke-colors when no +color provided +
+
+ TYPE:
+ |
+
opacities |
+
+ Opacity for the lines and patches. Defaults to 1 when the list is too +short, or the element of the list is set to None. +
+
+ TYPE:
+ |
+
fill_opacities |
+
+ Opacity for the areas. Defaults to 1 when the list is too +short, or the element of the list is set to None. +
+
+ TYPE:
+ |
+
stroke_width |
+
+ Stroke width of the Lines +
+
+ TYPE:
+ |
+
labels_visibility |
+
+ Visibility of the curve labels +
+
+ TYPE:
+ |
+
curves_subset |
+
+ If set to None, all the lines are displayed. Otherwise, only the items +in the list will have full opacity, while others will be faded. +
+
+ TYPE:
+ |
+
line_style |
+
+ Line style. +
+
+ TYPE:
+ |
+
interpolation |
+
+
+
+
+ TYPE:
+ |
+
'cardinal-closed', 'monotone', 'step-before', 'step-after'} |
+
+ Interpolation scheme used for interpolation between the data points +provided. Please refer to the svg interpolate documentation for details +about the different interpolation schemes. ++ + |
+
marker |
+
+ Marker shape +
+
+ TYPE:
+ |
+
marker_size |
+
+ Default marker size in pixels +
+
+ TYPE:
+ |
+
Note
+bqplot.FlexLine
+
+
+
+ Bases: Mark
Lines mark with the possibility to change the line width and color for each segment.
+Warning
+In the case of the FlexLines mark, scales for 'x' and 'y' must be provided. +Scales for the color and width 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.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x |
+
+ abscissas of the data points (1d array) +
+
+ TYPE:
+ |
+
y |
+
+ ordinates of the data points (1d array) +
+
+ TYPE:
+ |
+
color |
+
+ Array controlling the color of the data points +
+
+ TYPE:
+ |
+
width |
+
+ Array controlling the widths of the Lines. +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
name |
+
+ user-friendly name of the mark +
+
+ TYPE:
+ |
+
colors |
+
+ List of colors for the Lines +
+
+ TYPE:
+ |
+
stroke_width |
+
+ Default stroke width of the Lines +
+
+ TYPE:
+ |
+
bqplot.Scatter
+
+
+
+ Bases: _ScatterBase
Scatter mark.
+Warning
+In the case of the Scatter 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.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x |
+
+ abscissas of the data points (1d array) +
+
+ TYPE:
+ |
+
y |
+
+ ordinates of the data points (1d array) +
+
+ TYPE:
+ |
+
color |
+
+ color of the data points (1d array). Defaults to default_color when not +provided or when a value is NaN +
+
+ TYPE:
+ |
+
opacity |
+
+ opacity of the data points (1d array). Defaults to default_opacity when +not provided or when a value is NaN +
+
+ TYPE:
+ |
+
size |
+
+ size of the data points. Defaults to default_size when not provided or +when a value is NaN +
+
+ TYPE:
+ |
+
skew |
+
+ skewness of the markers representing the data points. Defaults to +default_skew when not provided or when a value is NaN +
+
+ TYPE:
+ |
+
rotation |
+
+ orientation of the markers representing the data points. +The rotation scale's range is [0, 180] +Defaults to 0 when not provided or when a value is NaN. +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
icon |
+
+ Font-awesome icon for that mark +
+
+ TYPE:
+ |
+
name |
+
+ User-friendly name of the mark +
+
+ TYPE:
+ |
+
marker |
+
+ Marker shape +
+
+ TYPE:
+ |
+
colors |
+
+ List of colors of the markers. If the list is shorter than the number +of points, the colors are reused. +
+
+ TYPE:
+ |
+
default_colors |
+
+ Same as
+
+ TYPE:
+ |
+
fill |
+
+ Whether to fill the markers or not +
+
+ TYPE:
+ |
+
stroke |
+
+ Stroke color of the marker +
+
+ TYPE:
+ |
+
stroke_width |
+
+ Stroke width of the marker +
+
+ TYPE:
+ |
+
opacities |
+
+ Default opacities of the markers. If the list is shorter than +the number +of points, the opacities are reused. +
+
+ TYPE:
+ |
+
default_skew |
+
+ Default skew of the marker. +This number is validated to be between 0 and 1. +
+
+ TYPE:
+ |
+
default_size |
+
+ Default marker size in pixel. +If size data is provided with a scale, default_size stands for the +maximal marker size (i.e. the maximum value for the 'size' scale range) +
+
+ TYPE:
+ |
+
drag_size |
+
+ Ratio of the size of the dragged scatter size to the default +scatter size. +
+
+ TYPE:
+ |
+
names |
+
+ Labels for the points of the chart +
+
+ TYPE:
+ |
+
display_names |
+
+ Controls whether names are displayed for points in the scatter +
+
+ TYPE:
+ |
+
label_display_horizontal_offset |
+
+ Adds an offset, in pixels, to the horizontal positioning of the 'names' +label above each data point +
+
+ TYPE:
+ |
+
label_display_vertical_offset |
+
+ Adds an offset, in pixels, to the vertical positioning of the 'names' +label above each data point +
+
+ TYPE:
+ |
+
enable_move |
+
+ Controls whether points can be moved by dragging. Refer to restrict_x, +restrict_y for more options. +
+
+ TYPE:
+ |
+
restrict_x |
+
+ Restricts movement of the point 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 point cannot be moved. +
+
+ TYPE:
+ |
+
restrict_y |
+
+ Restricts movement of the point 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 point cannot be moved. +
+
+ TYPE:
+ |
+
Note
+bqplot.Hist
+
+
+
+ Bases: Mark
Histogram mark.
+Warning
+In the case of the Hist mark, scales for 'sample' and 'count' must be provided.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
sample |
+
+ sample of which the histogram must be computed. +
+
+ TYPE:
+ |
+
count |
+
+ number of sample points per bin. It is a read-only attribute. +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
icon |
+
+ font-awesome icon for that mark +
+
+ TYPE:
+ |
+
name |
+
+ user-friendly name of the mark +
+
+ TYPE:
+ |
+
bins |
+
+ number of bins in the histogram +
+
+ TYPE:
+ |
+
normalized |
+
+ Boolean attribute to return normalized values which
+sum to 1 or direct counts for the
+
+ TYPE:
+ |
+
colors |
+
+ List of colors of the Histogram. If the list is shorter than the number +of bins, the colors are reused. +
+
+ TYPE:
+ |
+
stroke |
+
+ Stroke color of the histogram +
+
+ TYPE:
+ |
+
opacities |
+
+ Opacity for the bins of the histogram. Defaults to 1 when the list +is too short, or the element of the list is set to None. +
+
+ TYPE:
+ |
+
midpoints |
+
+ midpoints of the bins of the histogram. It is a read-only attribute. +
+
+ TYPE:
+ |
+
Note
+bqplot.Bars
+
+
+
+ Bases: Mark
Bar mark.
+Warning
+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.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x |
+
+ abscissas of the data points (1d array) +
+
+ TYPE:
+ |
+
y |
+
+ ordinates of the values for the data points +
+
+ TYPE:
+ |
+
color |
+
+ color of the data points (1d array). Defaults to default_color when not +provided or when a value is NaN +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
icon |
+
+ font-awesome icon for that mark +
+
+ TYPE:
+ |
+
name |
+
+ user-friendly name of the mark +
+
+ TYPE:
+ |
+
color_mode |
+
+ Specify how default colors are applied to bars. +The 'group' mode means colors are assigned per group. If the list +of colors is shorter than the number of groups, colors are reused. +The 'element' mode means colors are assigned per group element. If the list +of colors is shorter than the number of bars in a group, colors are reused. +The 'no_group' mode means colors are assigned per bar, discarding the fact +that there are groups or stacks. If the list of colors is shorter than the +total number of bars, colors are reused. +
+
+ TYPE:
+ |
+
opacity_mode |
+
+ Same as the
+
+ TYPE:
+ |
+
type |
+
+ whether 2-dimensional bar charts should appear grouped or stacked. +
+
+ TYPE:
+ |
+
colors |
+
+ list of colors for the bars. +
+
+ TYPE:
+ |
+
orientation |
+
+ Specifies whether the bar chart is drawn horizontally or vertically. +If a horizontal bar chart is drawn, the x data is drawn vertically. +
+
+ TYPE:
+ |
+
padding |
+
+ Attribute to control the spacing between the bars value is specified +as a percentage of the width of the bar +
+
+ TYPE:
+ |
+
fill |
+
+ Whether to fill the bars or not +
+
+ TYPE:
+ |
+
stroke |
+
+ Stroke color for the bars +
+
+ TYPE:
+ |
+
stroke_width |
+
+ Stroke width of the bars +
+
+ TYPE:
+ |
+
opacities |
+
+ Opacities for the bars. Defaults to 1 when the list is too +short, or the element of the list is set to None. +
+
+ TYPE:
+ |
+
base |
+
+ reference value from which the bars are drawn. defaults to 0.0 +
+
+ TYPE:
+ |
+
align |
+
+ alignment of bars with respect to the tick value +
+
+ TYPE:
+ |
+
label_display |
+
+ whether or not to display bar data labels +
+
+ TYPE:
+ |
+
label_display_format |
+
+ format for displaying values. +
+
+ TYPE:
+ |
+
label_font_style |
+
+ CSS style for the text of each cell +
+
+ TYPE:
+ |
+
label_display_vertical_offset |
+
+ vertical offset value for the label display +
+
+ TYPE:
+ |
+
label_display_horizontal_offset |
+
+ horizontal offset value for the label display +
+
+ TYPE:
+ |
+
Note
+bqplot.Graph
+
+
+
+ Bases: Mark
Graph with nodes and links.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x |
+
+ abscissas of the node data points (1d array) +
+
+ TYPE:
+ |
+
y |
+
+ ordinates of the node data points (1d array) +
+
+ TYPE:
+ |
+
color |
+
+ color of the node data points (1d array). +
+
+ TYPE:
+ |
+
link_color |
+
+ link data passed as 2d matrix +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
node_data |
+
+ list of node attributes for the graph +
+
+ TYPE:
+ |
+
link_matrix |
+
+ link data passed as 2d matrix +
+
+ TYPE:
+ |
+
link_data |
+
+ list of link attributes for the graph +
+
+ TYPE:
+ |
+
charge |
+
+ charge of force layout. Will be ignored when x and y data attributes +are set +
+
+ TYPE:
+ |
+
static |
+
+ whether the graph is static or not +
+
+ TYPE:
+ |
+
link_distance |
+
+ link distance in pixels between nodes. Will be ignored when x and y +data attributes are set +
+
+ TYPE:
+ |
+
link_type |
+
+ Enum representing link type +
+
+ TYPE:
+ |
+
directed |
+
+ directed or undirected graph +
+
+ TYPE:
+ |
+
highlight_links |
+
+ highlights incoming and outgoing links when hovered on a node +
+
+ TYPE:
+ |
+
colors |
+
+ list of node colors +
+
+ TYPE:
+ |
+
bqplot.GridHeatMap
+
+
+
+ Bases: Mark
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.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
color |
+
+ color of the data points (2d array). The number of elements in +this array correspond to the number of cells created in the heatmap. +
+
+ TYPE:
+ |
+
row |
+
+ labels for the rows of the
+
+ TYPE:
+ |
+
column |
+
+ labels for the columns of the
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
row_align |
+
+ This is only valid if the number of entries in
+
+ TYPE:
+ |
+
column_align |
+
+ This is only valid if the number of entries in
+
+ TYPE:
+ |
+
anchor_style |
+
+ Controls the style for the element which serves as the anchor during +selection. +
+
+ TYPE:
+ |
+
display_format |
+
+ format for displaying values. If None, then values are not displayed +
+
+ TYPE:
+ |
+
font_style |
+
+ CSS style for the text of each cell +
+
+ TYPE:
+ |
+
bqplot.HeatMap
+
+
+
+ Bases: Mark
HeatMap mark.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
color |
+
+ color of the data points (2d array). +
+
+ TYPE:
+ |
+
x |
+
+ labels for the columns of the
+
+ TYPE:
+ |
+
y |
+
+ labels for the rows of the
+
+ TYPE:
+ |
+
bqplot.Label
+
+
+
+ Bases: _ScatterBase
Label mark.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x |
+
+ horizontal position of the labels, in data coordinates or in +figure coordinates +
+
+ TYPE:
+ |
+
y |
+
+ vertical position of the labels, in data coordinates or in +figure coordinates +
+
+ TYPE:
+ |
+
color |
+
+ label colors +
+
+ TYPE:
+ |
+
size |
+
+ label sizes +
+
+ TYPE:
+ |
+
rotation |
+
+ label rotations +
+
+ TYPE:
+ |
+
opacity |
+
+ label opacities +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x_offset |
+
+ horizontal offset in pixels from the stated x location +
+
+ TYPE:
+ |
+
y_offset |
+
+ vertical offset in pixels from the stated y location +
+
+ TYPE:
+ |
+
text |
+
+ text to be displayed +
+
+ TYPE:
+ |
+
default_size |
+
+ font size in px, em or ex +
+
+ TYPE:
+ |
+
font_weight |
+
+ font weight of the caption +
+
+ TYPE:
+ |
+
drag_size |
+
+ Ratio of the size of the dragged label font size to the default +label font size. +
+
+ TYPE:
+ |
+
align |
+
+ 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. +
+
+ TYPE:
+ |
+
restrict_x |
+
+ 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. +
+
+ TYPE:
+ |
+
restrict_y |
+
+ 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. +
+
+ TYPE:
+ |
+
bqplot.OHLC
+
+
+
+ Bases: Mark
Open/High/Low/Close marks.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
x |
+
+ abscissas of the data points (1d array) +
+
+ TYPE:
+ |
+
y |
+
+ Open/High/Low/Close ordinates of the data points (2d array) +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
icon |
+
+ font-awesome icon for that mark +
+
+ TYPE:
+ |
+
name |
+
+ user-friendly name of the mark +
+
+ TYPE:
+ |
+
marker |
+
+ marker type +
+
+ TYPE:
+ |
+
stroke |
+
+ stroke color of the marker +
+
+ TYPE:
+ |
+
stroke_width |
+
+ stroke width of the marker +
+
+ TYPE:
+ |
+
colors |
+
+ fill colors for the markers (up/down) +
+
+ TYPE:
+ |
+
opacities |
+
+ Opacities for the markers of the OHLC mark. Defaults to 1 when +the list is too short, or the element of the list is set to None. +
+
+ TYPE:
+ |
+
format |
+
+ description of y data being passed +supports all permutations of the strings 'ohlc', 'oc', and 'hl' +
+
+ TYPE:
+ |
+
Note
+bqplot.Pie
+
+
+
+ Bases: Mark
Piechart mark.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
sizes |
+
+ proportions of the pie slices +
+
+ TYPE:
+ |
+
color |
+
+ color of the data points. Defaults to colors when not provided. +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
colors |
+
+ list of colors for the slices. +
+
+ TYPE:
+ |
+
stroke |
+
+ stroke color for the marker +
+
+ TYPE:
+ |
+
opacities |
+
+ Opacities for the slices of the Pie mark. Defaults to 1 when the list +is too short, or the element of the list is set to None. +
+
+ TYPE:
+ |
+
sort |
+
+ sort the pie slices by descending sizes +
+
+ TYPE:
+ |
+
x |
+
+ horizontal position of the pie center, in data coordinates or in figure +coordinates +
+
+ TYPE:
+ |
+
y |
+
+ vertical y position of the pie center, in data coordinates or in figure +coordinates +
+
+ TYPE:
+ |
+
radius |
+
+ radius of the pie, in pixels +
+
+ TYPE:
+ |
+
inner_radius |
+
+ inner radius of the pie, in pixels +
+
+ TYPE:
+ |
+
start_angle |
+
+ start angle of the pie (from top), in degrees +
+
+ TYPE:
+ |
+
end_angle |
+
+ end angle of the pie (from top), in degrees +
+
+ TYPE:
+ |
+
display_labels |
+
+ label display options +
+
+ TYPE:
+ |
+
display_values |
+
+ if True show values along with labels +
+
+ TYPE:
+ |
+
values_format |
+
+ format for displaying values +
+
+ TYPE:
+ |
+
label_color |
+
+ color of the labels +
+
+ TYPE:
+ |
+
font_size |
+
+ label font size in px, em or ex +
+
+ TYPE:
+ |
+
font_weight |
+
+ label font weight +
+
+ TYPE:
+ |
+
bqplot.Map
+
+
+
+ Bases: Mark
Map mark.
+| ATTRIBUTE | +DESCRIPTION | +
|---|---|
color |
+
+ dictionary containing the data associated with every country for the +color scale +
+
+ TYPE:
+ |
+
| ATTRIBUTE | +DESCRIPTION | +
|---|---|
colors |
+
+ default colors for items of the map when no color data is passed.
+The dictionary should be indexed by the id of the element and have
+the corresponding colors as values. The key
+
+ TYPE:
+ |
+
selected_styles |
+
+
+
+
+ TYPE:
+ |
+
selected_stroke |
+
+ Dictionary containing the styles for selected subunits +
+
+ TYPE:
+ |
+
hovered_styles |
+
+
+
+
+ TYPE:
+ |
+
hovered_stroke |
+
+ Dictionary containing the styles for hovered subunits +
+
+ TYPE:
+ |
+
hover_highlight |
+
+ boolean to control if the map should be aware of which country is being +hovered on. +
+
+ TYPE:
+ |
+
map_data |
+
+ a topojson-formatted dictionary with the objects to map under the key +'subunits'. +
+
+ TYPE:
+ |
+
bqplot.pyplot.figure(key=None, fig=None, **kwargs)
+
+Creates figures and switches between figures.
+If a bqplot.Figure object is provided via the fig optional argument,
+this figure becomes the current context figure.
Otherwise:
+Besides, optional arguments allow to set or modify Attributes +of the selected context figure.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
key |
+
+ Any variable that can be used as a key for a dictionary +
+
+ DEFAULT:
+ |
+
fig |
+
+ A bqplot Figure +
+
+ DEFAULT:
+ |
+
bqplot.pyplot.show(key=None, display_toolbar=True)
+
+Shows the current context figure in the output area.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
key |
+
+ Any variable that can be used as a key for a dictionary. +
+
+ TYPE:
+ |
+
display_toolbar |
+
+ If True, a toolbar for different mouse interaction is displayed with +the figure. +
+
+ DEFAULT:
+ |
+
| RAISES | +DESCRIPTION | +
|---|---|
+
+ KeyError
+
+ |
+
+ When no context figure is associated with the provided key. + |
+
Examples:
+>>> import numpy as np
+>>> import pyplot as plt
+>>> n = 100
+>>> x = np.arange(n)
+>>> y = np.cumsum(np.random.randn(n))
+>>> plt.plot(x,y)
+>>> plt.show()
+bqplot.pyplot.axes(mark=None, options={}, **kwargs)
+
+Draws axes corresponding to the scales of a given mark.
+It also returns a dictionary of drawn axes. If the mark is not provided, +the last drawn mark is used.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
mark |
+
+ The mark to inspect to create axes. If None, the last mark drawn is +used instead. +
+
+ DEFAULT:
+ |
+
options |
+
+ Options for the axes to be created. If a scale labeled 'x' is required +for that mark, options['x'] contains optional keyword arguments for the +constructor of the corresponding axis type. +
+
+ DEFAULT:
+ |
+
bqplot.pyplot.plot(*args, **kwargs)
+
+Draw lines in the current context figure.
+Signature: plot(x, y, **kwargs) or plot(y, **kwargs), depending of the
+length of the list of positional arguments. In the case where the x array
+is not provided.
| PARAMETER | +DESCRIPTION | +
|---|---|
x |
+
+ The x-coordinates of the plotted line. When not provided, the function
+defaults to + + |
+
y |
+
+ The y-coordinates of the plotted line. If argument + + |
+
marker_str |
+
+ string representing line_style, marker and color. +For e.g. 'g--o', 'sr' etc ++ + |
+
options |
+
+ Options for the scales to be created. If a scale labeled 'x' is +required for that mark, options['x'] contains optional keyword +arguments for the constructor of the corresponding scale type. ++ + |
+
axes_options |
+
+ Options for the axes to be created. If an axis labeled 'x' is required +for that mark, axes_options['x'] contains optional keyword arguments +for the constructor of the corresponding axis type. ++ + |
+
figure |
+
+ The figure to which the line is to be added. +If the value is None, the current figure is used. ++ + |
+
bqplot.pyplot.scatter(x, y, **kwargs)
+
+Draw a scatter in the current context figure.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
x |
+
+ The x-coordinates of the data points. ++ + |
+
y |
+
+ The y-coordinates of the data points. ++ + |
+
options |
+
+ Options for the scales to be created. If a scale labeled 'x' is +required for that mark, options['x'] contains optional keyword +arguments for the constructor of the corresponding scale type. ++ + |
+
axes_options |
+
+ Options for the axes to be created. If an axis labeled 'x' is required +for that mark, axes_options['x'] contains optional keyword arguments +for the constructor of the corresponding axis type. ++ + |
+
bqplot.pyplot.hist(sample, options={}, **kwargs)
+
+Draw a histogram in the current context figure.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
sample |
+
+ The sample for which the histogram must be generated. ++ + |
+
options |
+
+ Options for the scales to be created. If a scale labeled 'counts' +is required for that mark, options['counts'] contains optional keyword +arguments for the constructor of the corresponding scale type. +
+
+ DEFAULT:
+ |
+
axes_options |
+
+ Options for the axes to be created. If an axis labeled 'counts' is +required for that mark, axes_options['counts'] contains optional +keyword arguments for the constructor of the corresponding axis type. ++ + |
+
bqplot.pyplot.bar(x, y, **kwargs)
+
+Draws a bar chart in the current context figure.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
x |
+
+ The x-coordinates of the data points. ++ + |
+
y |
+
+ The y-coordinates of the data pints. ++ + |
+
options |
+
+ Options for the scales to be created. If a scale labeled 'x' is +required for that mark, options['x'] contains optional keyword +arguments for the constructor of the corresponding scale type. ++ + |
+
axes_options |
+
+ Options for the axes to be created. If an axis labeled 'x' is required +for that mark, axes_options['x'] contains optional keyword arguments +for the constructor of the corresponding axis type. ++ + |
+
bqplot.pyplot.ohlc(*args, **kwargs)
+
+Draw OHLC bars or candle bars in the current context figure.
+Signature: ohlc(x, y, **kwargs) or ohlc(y, **kwargs), depending of the
+length of the list of positional arguments. In the case where the x array
+is not provided
| PARAMETER | +DESCRIPTION | +
|---|---|
x |
+
+ The x-coordinates of the plotted line. When not provided, the function
+defaults to + + |
+
y |
+
+ The ohlc (open/high/low/close) information. A two dimensional array. y +must have the shape (n, 4). ++ + |
+
options |
+
+ Options for the scales to be created. If a scale labeled 'x' is +required for that mark, options['x'] contains optional keyword +arguments for the constructor of the corresponding scale type. ++ + |
+
axes_options |
+
+ Options for the axes to be created. If an axis labeled 'x' is required +for that mark, axes_options['x'] contains optional keyword arguments +for the constructor of the corresponding axis type. ++ + |
+
bqplot.pyplot.geo(map_data, **kwargs)
+
+Draw a map in the current context figure.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
map_data |
+
+ Name of the map or json file required for the map data. ++ + |
+
options |
+
+ Options for the scales to be created. If a scale labeled 'x' is +required for that mark, options['x'] contains optional keyword +arguments for the constructor of the corresponding scale type. ++ + |
+
axes_options |
+
+ Options for the axes to be created. If an axis labeled 'x' is required +for that mark, axes_options['x'] contains optional keyword arguments +for the constructor of the corresponding axis type. ++ + |
+
bqplot.pyplot.clear()
+
+Clears the current context figure of all marks axes and grid lines.
+ +bqplot.pyplot.close(key)
+
+Closes and unregister the context figure corresponding to the key.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
key |
+
+ Any variable that can be used as a key for a dictionary ++ + |
+
bqplot.pyplot.current_figure()
+
+Returns the current context figure.
+ +bqplot.pyplot.scales(key=None, scales={})
+
+Creates and switches between context scales.
+If no key is provided, a new blank context is created.
+If a key is provided for which a context already exists, the existing +context is set as the current context.
+If a key is provided and no corresponding context exists, a new context is +created for that key and set as the current context.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
key |
+
+ Any variable that can be used as a key for a dictionary +
+
+ DEFAULT:
+ |
+
scales |
+
+ Dictionary of scales to be used in the new context +
+
+ DEFAULT:
+ |
+
>>> scales(scales={
+>>> 'x': Keep,
+>>> 'color': ColorScale(min=0, max=1)
+>>> })
+This creates a new scales context, where the 'x' scale is kept from the +previous context, the 'color' scale is an instance of ColorScale +provided by the user. Other scales, potentially needed such as the 'y' +scale in the case of a line chart will be created on the fly when +needed.
+Every call to the function figure triggers a call to scales.
+The scales parameter is ignored if the key argument is not Keep and
+context scales already exist for that key.
bqplot.pyplot.xlim(min, max)
+
+Set the domain bounds of the current 'x' scale.
+ +bqplot.pyplot.ylim(min, max)
+
+Set the domain bounds of the current 'y' scale.
+ +bqplot.pyplot.axes(mark=None, options={}, **kwargs)
+
+Draws axes corresponding to the scales of a given mark.
+It also returns a dictionary of drawn axes. If the mark is not provided, +the last drawn mark is used.
+ +| PARAMETER | +DESCRIPTION | +
|---|---|
mark |
+
+ The mark to inspect to create axes. If None, the last mark drawn is +used instead. +
+
+ DEFAULT:
+ |
+
options |
+
+ Options for the axes to be created. If a scale labeled 'x' is required +for that mark, options['x'] contains optional keyword arguments for the +constructor of the corresponding axis type. +
+
+ DEFAULT:
+ |
+
bqplot.pyplot.xlabel(label=None, mark=None, **kwargs)
+
+Sets the value of label for an axis whose associated scale has the
+dimension x.
| PARAMETER | +DESCRIPTION | +
|---|---|
label |
+
+ The label for x axis +
+
+ DEFAULT:
+ |
+
bqplot.pyplot.ylabel(label=None, mark=None, **kwargs)
+
+Sets the value of label for an axis whose associated scale has the
+dimension y.
| PARAMETER | +DESCRIPTION | +
|---|---|
label |
+
+ The label for y axis +
+
+ DEFAULT:
+ |
+
bqscales.Scale
+
+
+
+ Bases: Widget
The base scale class.
+Scale objects represent a mapping between data (the domain) and a visual +quantity (The range).
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_types |
+
+ A registry of existing scale types. +
+
+ TYPE:
+ |
+
domain_class |
+
+ traitlet type used to validate values in of the domain of the scale. +
+
+ TYPE:
+ |
+
reverse |
+
+ whether the scale should be reversed. +
+
+ TYPE:
+ |
+
allow_padding |
+
+ indicates whether figures are allowed to add data padding to this scale +or not. +
+
+ TYPE:
+ |
+
precedence |
+
+ attribute used to determine which scale takes precedence in cases when +two or more scales have the same rtype and dtype. +
+
+ TYPE:
+ |
+
bqscales.LinearScale
+
+
+
+ Bases: Scale
A linear scale.
+An affine mapping from a numerical domain to a numerical range.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
min |
+
+ if not None, min is the minimal value of the domain +
+
+ TYPE:
+ |
+
max |
+
+ if not None, max is the maximal value of the domain +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified. The range type of a linear +scale is numerical. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
precedence |
+
+ attribute used to determine which scale takes precedence in cases when +two or more scales have the same rtype and dtype. +default_value is 2 because for the same range and domain types, +LinearScale should take precedence. +
+
+ TYPE:
+ |
+
stabilized |
+
+ if set to False, the domain of the scale is tied to the data range +if set to True, the domain of the scale is updated only when +the data range is beyond certain thresholds, given by the attributes +mid_range and min_range. +
+
+ TYPE:
+ |
+
mid_range |
+
+ Proportion of the range that is spanned initially. +Used only if stabilized is True. +
+
+ TYPE:
+ |
+
min_range |
+
+ Minimum proportion of the range that should be spanned by the data. +If the data span falls beneath that level, the scale is reset. +min_range must be <= mid_range. +Used only if stabilized is True. +
+
+ TYPE:
+ |
+
bqscales.LogScale
+
+
+
+ Bases: Scale
A log scale.
+A logarithmic mapping from a numerical domain to a numerical range.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
min |
+
+ if not None, min is the minimal value of the domain +
+
+ TYPE:
+ |
+
max |
+
+ if not None, max is the maximal value of the domain +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified by the user. +The range type of a linear scale is numerical. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.DateScale
+
+
+
+ Bases: Scale
A date scale, with customizable formatting.
+An affine mapping from dates to a numerical range.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
min |
+
+ if not None, min is the minimal value of the domain +
+
+ TYPE:
+ |
+
max |
+
+ if not None, max is the maximal value of the domain +
+
+ TYPE:
+ |
+
domain_class |
+
+ traitlet type used to validate values in of the domain of the scale. +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified by the user. +The range type of a linear scale is numerical. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.OrdinalScale
+
+
+
+ Bases: Scale
An ordinal scale.
+A mapping from a discrete set of values to a numerical range.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
domain |
+
+ The discrete values mapped by the ordinal scale +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified by the user. +The range type of a linear scale is numerical. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.ColorScale
+
+
+
+ Bases: Scale
A color scale.
+A mapping from numbers to colors. The relation is affine by part.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_type |
+
+ scale type +
+
+ TYPE:
+ |
+
colors |
+
+ list of colors +
+
+ TYPE:
+ |
+
min |
+
+ if not None, min is the minimal value of the domain +
+
+ TYPE:
+ |
+
max |
+
+ if not None, max is the maximal value of the domain +
+
+ TYPE:
+ |
+
mid |
+
+ if not None, mid is the value corresponding to the mid color. +
+
+ TYPE:
+ |
+
scheme |
+
+ Colorbrewer color scheme of the color scale. +
+
+ TYPE:
+ |
+
extrapolation |
+
+ How to extrapolate values outside the [min, max] domain. +
+
+ TYPE:
+ |
+
rtype |
+
+ The range type of a color scale is 'Color'. This should not be modified. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.DateColorScale
+
+
+
+ Bases: ColorScale
A date color scale.
+A mapping from dates to a numerical domain.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
min |
+
+ if not None, min is the minimal value of the domain +
+
+ TYPE:
+ |
+
max |
+
+ if not None, max is the maximal value of the domain +
+
+ TYPE:
+ |
+
mid |
+
+ if not None, mid is the value corresponding to the mid color. +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified by the user. +The range type of a color scale is 'Color'. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.OrdinalColorScale
+
+
+
+ Bases: ColorScale
An ordinal color scale.
+A mapping from a discrete set of values to colors.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
domain |
+
+ The discrete values mapped by the ordinal scales. +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified by the user. +The range type of a color scale is 'color'. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.GeoScale
+
+
+
+ Bases: Scale
The base projection scale class for Map marks.
+The GeoScale represents a mapping between topographic data and a +2d visual representation.
+ + + + + +bqscales.Orthographic
+
+
+
+ Bases: GeoScale
A perspective projection that depicts a hemisphere as it appears from outer space.
+The projection is neither equal-area nor conformal.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_factor |
+
+ Specifies the scale value for the projection +
+
+ TYPE:
+ |
+
center |
+
+ Specifies the longitude and latitude where the map is centered. +
+
+ TYPE:
+ |
+
rotate |
+
+ Degree of rotation in each axis. +
+
+ TYPE:
+ |
+
clip_angle |
+
+ Specifies the clipping circle radius to the specified angle in degrees. +
+
+ TYPE:
+ |
+
precision |
+
+ Specifies the threshold for the projections adaptive resampling to the +specified value in pixels. +
+
+ TYPE:
+ |
+
bqscales.Mercator
+
+
+
+ Bases: GeoScale
A geographical projection scale commonly used for world maps.
+The Mercator projection is a cylindrical map projection which ensures that +any course of constant bearing is a straight line.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_factor |
+
+ Specifies the scale value for the projection +
+
+ TYPE:
+ |
+
center |
+
+ Specifies the longitude and latitude where the map is centered. +
+
+ TYPE:
+ |
+
rotate |
+
+ Degree of rotation in each axis. +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified. The range type of a geo +scale is a tuple. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.Albers
+
+
+
+ Bases: GeoScale
A geographical scale which is an alias for a conic equal area projection.
+The Albers projection is a conic equal area map. It does not preserve scale +or shape, though it is recommended for chloropleths since it preserves the +relative areas of geographic features. Default values are US-centric.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_factor |
+
+ Specifies the scale value for the projection +
+
+ TYPE:
+ |
+
rotate |
+
+ Degree of rotation in each axis. +
+
+ TYPE:
+ |
+
parallels |
+
+ Sets the two parallels for the conic projection. +
+
+ TYPE:
+ |
+
center |
+
+ Specifies the longitude and latitude where the map is centered. +
+
+ TYPE:
+ |
+
precision |
+
+ Specifies the threshold for the projections adaptive resampling to the +specified value in pixels. +
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified. The range type of a geo +scale is a tuple. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.AlbersUSA
+
+
+
+ Bases: GeoScale
A composite projection of four Albers projections meant specifically for the United States.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_factor |
+
+ Specifies the scale value for the projection +
+
+ TYPE:
+ |
+
translate |
+
+
+
+
+ TYPE:
+ |
+
rtype |
+
+ This attribute should not be modified. The range type of a geo +scale is a tuple. +
+
+ TYPE:
+ |
+
dtype |
+
+ the associated data type / domain type +
+
+ TYPE:
+ |
+
bqscales.Gnomonic
+
+
+
+ Bases: GeoScale
A perspective projection which displays great circles as straight lines.
+The projection is neither equal-area nor conformal.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_factor |
+
+ Specifies the scale value for the projection +
+
+ TYPE:
+ |
+
center |
+
+ Specifies the longitude and latitude where the map is centered. +
+
+ TYPE:
+ |
+
precision |
+
+ Specifies the threshold for the projections adaptive resampling to the +specified value in pixels. +
+
+ TYPE:
+ |
+
clip_angle |
+
+ Specifies the clipping circle radius to the specified angle in degrees. +
+
+ TYPE:
+ |
+
bqscales.Stereographic
+
+
+
+ Bases: GeoScale
A perspective projection that uses a bijective and smooth map at every point except the projection point.
+The projection is not an equal-area projection but it is conformal.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_factor |
+
+ Specifies the scale value for the projection +
+
+ TYPE:
+ |
+
rotate |
+
+ Degree of rotation in each axis. +
+
+ TYPE:
+ |
+
center |
+
+ Specifies the longitude and latitude where the map is centered. +
+
+ TYPE:
+ |
+
precision |
+
+ Specifies the threshold for the projections adaptive resampling to the +specified value in pixels. +
+
+ TYPE:
+ |
+
clip_angle |
+
+ Specifies the clipping circle radius to the specified angle in degrees. +
+
+ TYPE:
+ |
+
bqscales.EquiRectangular
+
+
+
+ Bases: GeoScale
An elementary projection that uses the identity function.
+The projection is neither equal-area nor conformal.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
scale_factor |
+
+ Specifies the scale value for the projection +
+
+ TYPE:
+ |
+
center |
+
+ Specifies the longitude and latitude where the map is centered. +
+
+ TYPE:
+ |
+
bqplot.toolbar.Toolbar
+
+
+
+ Bases: DOMWidget
Default toolbar for bqplot figures.
+The default toolbar provides three buttons:
+When the Panzoom button is toggled to True for the first time, a new
+instance of PanZoom widget is created.
+The created PanZoom widget uses the scales of all the marks that are on
+the figure at this point.
+When the PanZoom widget is toggled to False, the figure retrieves its
+previous interaction.
+When the Reset button is pressed, the PanZoom widget is deleted and
+the figure scales reset to their initial state. We are back to the case
+where the PanZoom widget has never been set.
If new marks are added to the figure after the panzoom button is toggled, +and these use new scales, those scales will not be panned or zoomed, +unless the reset button is clicked.
+ +| ATTRIBUTE | +DESCRIPTION | +
|---|---|
figure |
+
+ The figure to which the toolbar will apply. +
+
+ TYPE:
+ |
+