bqplot.marks.Lines

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

Lines mark.

In the case of the Lines mark, scales for ‘x’ and ‘y’ MUST be provided.

icon

string (class-level attribute) – Font-awesome icon for the respective mark

name

string (class-level attribute) – User-friendly name of the mark

colors

list of colors (default: CATEGORY10) – List of colors of the Lines. If the list is shorter than the number of lines, the colors are reused.

close_path

bool (default: False) – Whether to close the paths or not.

fill

{‘none’, ‘bottom’, ‘top’, ‘inside’, ‘between’} – Fill in the area defined by the curves

fill_colors

list of colors (default: []) – Fill colors for the areas. Defaults to stroke-colors when no color provided

opacities

list of floats (default: []) – 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.

fill_opacities

list of floats (default: []) – Opacity for the areas. Defaults to 1 when the list is too short, or the element of the list is set to None.

stroke_width

float (default: 2) – Stroke width of the Lines

labels_visibility

{‘none’, ‘label’} – Visibility of the curve labels

curves_subset

list of integers or None (default: []) – 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.

line_style

{‘solid’, ‘dashed’, ‘dotted’, ‘dash_dotted’} – Line style.

interpolation

{‘linear’, ‘basis’, ‘cardinal’, ‘monotone’} – 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

{‘circle’, ‘cross’, ‘diamond’, ‘square’, ‘triangle-down’, – ‘triangle-up’, ‘arrow’, ‘rectangle’, ‘ellipse’} Marker shape

marker_size

nonnegative int (default: 64) – Default marker size in pixels

Data Attributes
x

numpy.ndarray (default: []) – abscissas of the data points (1d or 2d array)

y

numpy.ndarray (default: []) – ordinates of the data points (1d or 2d array)

color

numpy.ndarray (default: None) – 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.

Notes

The fields which can be passed to the default tooltip are:
name: label of the line index: index of the line being hovered on color: data attribute for the color of the line
The following are the events which can trigger interactions:
click: left click of the mouse hover: mouse-over an element
The following are the interactions which can be linked to the above events:
tooltip: display tooltip
__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_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

apply_clip A boolean (True, False) trait.
close_path 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.
curves_subset An instance of a Python list.
display_legend A boolean (True, False) trait.
enable_hover A boolean (True, False) trait.
fill An enum whose value must be in a given sequence.
fill_colors An instance of a Python list.
fill_opacities An instance of a Python list.
icon
interactions An instance of a Python dict.
interpolation An enum whose value must be in a given sequence.
keys An instance of a Python list.
labels An instance of a Python list.
labels_visibility An enum whose value must be in a given sequence.
line_style An enum whose value must be in a given sequence.
log A trait whose value must be an instance of a specified class.
mark_types
marker An enum whose value must be in a given sequence.
marker_size An int trait.
model_id Gets the model id of this widget.
name
opacities An instance of a Python list.
preserve_domain An instance of a Python dict.
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_width A float trait.
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
x A numpy array trait type.
y A numpy array trait type.