bqplot.marks.Scatter¶

class bqplot.marks.Scatter(**kwargs)[source]¶

Scatter mark.

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.

icon¶

Font-awesome icon for that mark

Type:	string (class-level attribute)

name¶

User-friendly name of the mark

Type:	string (class-level attribute)

marker¶

‘triangle-up’, ‘arrow’, ‘rectangle’, ‘ellipse’}

Marker shape

Type:	{‘circle’, ‘cross’, ‘diamond’, ‘square’, ‘triangle-down’,

colors¶

List of colors of the markers. If the list is shorter than the number of points, the colors are reused.

Type:	list of colors (default: [‘steelblue’])

default_colors¶

Same as colors, deprecated as of version 0.8.4

Type:	Deprecated

stroke¶

Stroke color of the marker

Type:	Color or None (default: None)

stroke_width¶

Stroke width of the marker

Type:	Float (default: 1.5)

default_opacities¶

Default opacities of the markers. If the list is shorter than the number of points, the opacities are reused.

Type:	list of floats (default: [1.0])

default_skew¶

Default skew of the marker. This number is validated to be between 0 and 1.

Type:	float (default: 0.5)

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:	nonnegative int (default: 64)

drag_size¶

Ratio of the size of the dragged scatter size to the default scatter size.

Type:	nonnegative float (default: 5.)

names¶

Labels for the points of the chart

Type:	numpy.ndarray (default: None)

display_names¶

Controls whether names are displayed for points in the scatter

Type:	bool (default: True)

enable_move¶

Controls whether points can be moved by dragging. Refer to restrict_x, restrict_y for more options.

Type:	bool (default: False)

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:	bool (default: False)

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:	bool (default: False)

Data Attributes

x: numpy.ndarray (default: []): abscissas of the data points (1d array)
y: numpy.ndarray (default: []): ordinates of the data points (1d array)
color: numpy.ndarray or None (default: None): color of the data points (1d array). Defaults to default_color when not provided or when a value is NaN
opacity: numpy.ndarray or None (default: None): opacity of the data points (1d array). Defaults to default_opacity when not provided or when a value is NaN
size: numpy.ndarray or None (default: None): size of the data points. Defaults to default_size when not provided or when a value is NaN
skew: numpy.ndarray or None (default: None): skewness of the markers representing the data points. Defaults to default_skew when not provided or when a value is NaN
rotation: numpy.ndarray or None (default: None): 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.

Notes

The fields which can be passed to the default tooltip are:: All the data attributes index: index of the marker being hovered on
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 add: add new points to the scatter (can only linked to click)

__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_drag`(callback[, remove])
`on_drag_end`(callback[, remove])
`on_drag_start`(callback[, remove])
`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.
`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.
`default_colors`
`default_opacities`	An instance of a Python list.
`default_size`	An int trait.
`default_skew`	A float trait.
`display_legend`	A boolean (True, False) trait.
`display_names`	A boolean (True, False) trait.
`drag_color`	A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
`drag_size`	A float trait.
`enable_delete`	A boolean (True, False) trait.
`enable_hover`	A boolean (True, False) trait.
`enable_move`	A boolean (True, False) trait.
`fill`	A boolean (True, False) trait.
`hovered_point`	An int trait.
`hovered_style`	An instance of a Python dict.
`icon`
`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`
`marker`	An enum whose value must be in a given sequence.
`model_id`	Gets the model id of this widget.
`name`
`names`	A numpy array trait type.
`names_unique`	A boolean (True, False) trait.
`opacity`	A numpy array trait type.
`preserve_domain`	An instance of a Python dict.
`restrict_x`	A boolean (True, False) trait.
`restrict_y`	A boolean (True, False) trait.
`rotation`	A numpy array trait type.
`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.
`size`	A numpy array trait type.
`skew`	A numpy array trait type.
`stroke`	A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
`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.
`unhovered_style`	An instance of a Python dict.
`unselected_style`	An instance of a Python dict.
`update_on_move`	A boolean (True, False) trait.
`visible`	A boolean (True, False) trait.
`widget_types`
`widgets`
`x`	A numpy array trait type.
`y`	A numpy array trait type.