plopp.backends.pythreejs.scatter3d.Scatter3d#

class plopp.backends.pythreejs.scatter3d.Scatter3d(*, canvas, x, y, z, data, uid=None, size=1, color=None, colormapper=None, artist_number=0, opacity=1, pixel_size=None, mask_color=None)[source]#

Artist to represent a three-dimensional point cloud/scatter plot.

Parameters:

  • canvas (Canvas) – The canvas that will display the scatter plot.

  • x (str) – The name of the coordinate that is to be used for the X positions.

  • y (str) – The name of the coordinate that is to be used for the Y positions.

  • z (str) – The name of the coordinate that is to be used for the Z positions.

  • data (DataArray) – The initial data to create the line from.

  • uid (str | None, default: None) – The unique identifier of the artist. If None, a random UUID is generated.

  • size (Variable | float, default: 1) – The size of the markers.

  • color (str | None, default: None) – The color of the markers (this is ignored if a colorbar is used).

  • colormapper (ColorMapper | None, default: None) – The colormapper to use for the scatter plot.

  • artist_number (int, default: 0) – Number of the artist (can be used to set the color of the artist).

  • opacity (float, default: 1) – The opacity of the points.

  • pixel_size (Variable | float | None, default: None) – The size of the pixels in the plot. Deprecated (use size instead).

  • mask_color (str | None, default: None) – The color of the masked points. TODO: not yet implemented.

__init__(*, canvas, x, y, z, data, uid=None, size=1, color=None, colormapper=None, artist_number=0, opacity=1, pixel_size=None, mask_color=None)[source]#

Methods

__init__(*, canvas, x, y, z, data[, uid, ...])

bbox(xscale, yscale, zscale)

The bounding box of the scatter points.

notify_artist(message)

Receive notification from the colormapper that its state has changed.

remove()

Remove the point cloud from the canvas.

update(new_values)

Update point cloud array with new values.

Attributes

data

Get the point cloud data.

opacity

The scatter points opacity.

visible

The visibility of the scatter points.