graphinglib.Scatter#

class graphinglib.Scatter(x_data: ArrayLike, y_data: ArrayLike, label: str | None = None, face_color: str | TypeAliasForwardRef('ArrayLike') | None | Inherit = Inherit, edge_color: str | TypeAliasForwardRef('ArrayLike') | None | Inherit = Inherit, color_map: str | Colormap | Inherit = Inherit, color_map_range: tuple[float, float] | None = None, show_color_bar: bool | Inherit = Inherit, marker_size: float | Inherit = Inherit, marker_edge_width: float | Inherit = Inherit, marker_style: str | Inherit = Inherit, alpha: float | Inherit = Inherit)[source]#

This class implements a general scatter plot.

Parameters:
x_data, y_dataArrayLike

Arrays of x and y values to be plotted.

labelstr, optional

Label to be displayed in the legend.

face_colorstr or ArrayLike or None

Face color of the points. If an array of intensities is provided, the values are mapped to the specified color map. If None, marker faces are transparent. Default depends on the figure_style configuration.

edge_colorstr or ArrayLike or None

Edge color of the points. If an array of intensities is provided, the values are mapped to the specified color map. If None, marker edges are transparent. Default depends on the figure_style configuration.

color_mapstr or Colormap

Color map used when face_color or edge_color is an array of intensity values. Examples include "viridis", "plasma", and "coolwarm". Default depends on the figure_style configuration.

color_map_range: tuple[float, float], optional

The data range covered by the color map, given as (minimum, maximum).

show_color_barbool

Whether or not to display the color bar next to the plot. Default depends on the figure_style configuration.

marker_sizefloat

Size of the points. Typical range is 10 to 100. Default depends on the figure_style configuration.

marker_edge_width: float

Line width of the marker edges. Typical range is 0 to 3 points. Default depends on the figure_style configuration.

marker_stylestr

Style of the points. Common values include ".", ",", "o", "v", "^", "<", ">", "s", "p", "*", "h", "H", "+", "x", "D", "d", "|", "_", "P", "X", "None", " ", and "". Default depends on the figure_style configuration.

alphafloat

Opacity of the scatter plot. Range is 0 (transparent) to 1 (opaque). Default depends on the figure_style configuration.

Notes

Color parameters accept Matplotlib color formats: named colors ("blue"), short color strings ("b"), hex strings ("#0000ff"), grayscale strings ("0.5"), and RGB/RGBA tuples with values between 0 and 1 ((0, 0, 1) or (0, 0, 1, 0.5)). They may also be arrays of intensity values, which are mapped through color_map.

Methods

__init__(x_data, y_data[, label, ...])

This class implements a general scatter plot.

add_errorbars([x_error, y_error, cap_width, ...])

Adds errorbars to the scatter plot.

copy()

Returns a deep copy of the Scatter object.

copy_with(**kwargs)

Returns a deep copy of the Plottable with specified attributes overridden.

create_point_at_x(x[, interpolation_method, ...])

Creates a Point on the curve at a given x value.

create_points_at_y(y[, ...])

Creates the Points on the curve at a given y value.

create_slice_x(x_min, x_max[, label, ...])

Creates a slice of the scatter plot between two x values.

create_slice_y(y_min, y_max[, label, ...])

Creates a slice of the scatter plot between two y values.

from_function(func, x_min, x_max[, label, ...])

Creates a scatter plot from a function and a range of x values.

get_coordinates_at_x(x[, interpolation_method])

Gets the coordinates of the point on the curve at a given x value.

get_coordinates_at_y(y[, interpolation_method])

Gets the coordinates the curve at a given y value.

set_color_bar_params([label, position])

Sets the color bar parameters.

to_desmos([decimal_precision, to_clipboard])

Gives the data points in a Desmos-readable format.
On this page