event_tables.rst

Event Tables

LineGraphic

data

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which vertex positions data were indexed/sliced
value	int \| float \| array-like	new data values for points that were changed

colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

colors

event info dict

dict key	type	description
value	str \| pygfx.Color \| np.ndarray \| Sequence[float]	new color value

cmap

event info dict

dict key	type	description
key	slice	key at cmap colors were sliced
value	str	new cmap to set at given slice

thickness

event info dict

dict key	type	description
value	float	new thickness value

size_space

event info dict

dict key	type	description
value	str	'screen' \| 'world' \| 'model'

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

ScatterGraphic

data

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which vertex positions data were indexed/sliced
value	int \| float \| array-like	new data values for points that were changed

sizes

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which point sizes were indexed/sliced
value	int \| float \| array-like	new size values for points that were changed

sizes

event info dict

dict key	type	description
value	float	new size value

colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

colors

event info dict

dict key	type	description
value	str \| pygfx.Color \| np.ndarray \| Sequence[float]	new color value

cmap

event info dict

dict key	type	description
key	slice	key at cmap colors were sliced
value	str	new cmap to set at given slice

markers

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which markers were indexed/sliced
value	str \| np.ndarray[str]	new marker values for points that were changed

markers

event info dict

dict key	type	description
value	str \| None	new marker value

edge_colors

event info dict

dict key	type	description
value	str \| np.ndarray \| pygfx.Color \| Sequence[float]	new edge_color

edge_colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

edge_width

event info dict

dict key	type	description
value	float	new edge_width

image

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	key at which image data was sliced/fancy indexed
value	np.ndarray \| float	new data values

size_space

event info dict

dict key	type	description
value	str	'screen' \| 'world' \| 'model'

point_rotations

event info dict

dict key	type	description
value	float	new edge_width

point_rotations

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which point rotations were indexed/sliced
value	int \| float \| array-like	new rotation values for points that were changed

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

ImageGraphic

data

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	key at which image data was sliced/fancy indexed
value	np.ndarray \| float	new data values

cmap

event info dict

dict key	type	description
value	str	new cmap name

vmin

event info dict

dict key	type	description
value	float	new vmin value

vmax

event info dict

dict key	type	description
value	float	new vmax value

interpolation

event info dict

dict key	type	description
value	str	new interpolation method, nearest \| linear

cmap_interpolation

event info dict

dict key	type	description
value	str	new cmap interpolatio method, nearest \| linear

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

ImageVolumeGraphic

data

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	key at which image data was sliced/fancy indexed
value	np.ndarray \| float	new data values

cmap

event info dict

dict key	type	description
value	str	new cmap name

vmin

event info dict

dict key	type	description
value	float	new vmin value

vmax

event info dict

dict key	type	description
value	float	new vmax value

interpolation

event info dict

dict key	type	description
value	str	new interpolation method, nearest \| linear

cmap_interpolation

event info dict

dict key	type	description
value	str	new cmap interpolatio method, nearest \| linear

mode

event info dict

dict key	type	description
value	str	volume rendering mode that has been set

threshold

event info dict

dict key	type	description
value	float	new isosurface threshold

step_size

event info dict

dict key	type	description
value	float	new isosurface step_size

substep_size

event info dict

dict key	type	description
value	float	new isosurface step_size

emissive

event info dict

dict key	type	description
value	pygfx.Color	new isosurface emissive color

shininess

event info dict

dict key	type	description
value	int	new isosurface shininess

plane

event info dict

dict key	type	description
value	tuple[float, float, float, float]	new plane slice

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

VectorsGraphic

positions

event info dict

dict key	type	description
value	np.ndarray	new vector positions

directions

event info dict

dict key	type	description
value	np.ndarray	new vector directions

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

MeshGraphic

positions

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which vertex positions data were indexed/sliced
value	int \| float \| array-like	new data values for points that were changed

indices

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which vertex indices were indexed/sliced
value	int \| float \| array-like	new data values for indices that were changed

colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

colors

event info dict

dict key	type	description
value	str \| pygfx.Color \| np.ndarray \| Sequence[float]	new color value

cmap

event info dict

dict key	type	description
value	str \| dict \| pygfx.TextureMap \| pygfx.Texture \| np.ndarray	new cmap

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

SurfaceGraphic

data

event info dict

dict key	type	description
value	np.ndarray	new surface data

colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

colors

event info dict

dict key	type	description
value	str \| pygfx.Color \| np.ndarray \| Sequence[float]	new color value

cmap

event info dict

dict key	type	description
value	str \| dict \| pygfx.TextureMap \| pygfx.Texture \| np.ndarray	new cmap

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

PolygonGraphic

data

event info dict

dict key	type	description
value	np.ndarray	new surface data

colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

colors

event info dict

dict key	type	description
value	str \| pygfx.Color \| np.ndarray \| Sequence[float]	new color value

cmap

event info dict

dict key	type	description
value	str \| dict \| pygfx.TextureMap \| pygfx.Texture \| np.ndarray	new cmap

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

TextGraphic

text

event info dict

dict key	type	description
value	str	new text data

font_size

event info dict

dict key	type	description
value	float \| int	new font size

face_color

event info dict

dict key	type	description
value	str \| np.ndarray	new text color

outline_color

event info dict

dict key	type	description
value	str \| np.ndarray	new outline color

outline_thickness

event info dict

dict key	type	description
value	float	new text outline thickness

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

LineCollection

data

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which vertex positions data were indexed/sliced
value	int \| float \| array-like	new data values for points that were changed

colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

colors

event info dict

dict key	type	description
value	str \| pygfx.Color \| np.ndarray \| Sequence[float]	new color value

cmap

event info dict

dict key	type	description
key	slice	key at cmap colors were sliced
value	str	new cmap to set at given slice

thickness

event info dict

dict key	type	description
value	float	new thickness value

size_space

event info dict

dict key	type	description
value	str	'screen' \| 'world' \| 'model'

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

LineStack

data

event info dict

dict key	type	description
key	slice, index (int) or numpy-like fancy index	key at which vertex positions data were indexed/sliced
value	int \| float \| array-like	new data values for points that were changed

colors

event info dict

dict key	type	description
key	slice, index, numpy-like fancy index	index/slice at which colors were indexed/sliced
value	np.ndarray [n_points_changed, RGBA]	new color values for points that were changed
user_value	str or array-like	user input value that was parsed into the RGBA array

colors

event info dict

dict key	type	description
value	str \| pygfx.Color \| np.ndarray \| Sequence[float]	new color value

cmap

event info dict

dict key	type	description
key	slice	key at cmap colors were sliced
value	str	new cmap to set at given slice

thickness

event info dict

dict key	type	description
value	float	new thickness value

size_space

event info dict

dict key	type	description
value	str	'screen' \| 'world' \| 'model'

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

LinearSelector

selection

extra attributes

attribute	type	description
get_selected_index	callable	returns index under the selector

event info dict

dict key	type	description
value	float	new x or y value of selection

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

LinearRegionSelector

selection

extra attributes

attribute	type	description
get_selected_indices	callable	returns indices under the selector
get_selected_data	callable	returns data under the selector

event info dict

dict key	type	description
value	np.ndarray	new [min, max] of selection

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

RectangleSelector

selection

extra attributes

attribute	type	description
get_selected_indices	callable	returns indices under the selector
get_selected_data	callable	returns data under the selector

event info dict

dict key	type	description
value	np.ndarray	new [xmin, xmax, ymin, ymax] of selection

name

event info dict

dict key	type	description
value	str	user provided name

offset

event info dict

dict key	type	description
value	np.ndarray[float, float, float]	new offset (x, y, z)

rotation

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new rotation quaternion

scale

event info dict

dict key	type	description
value	np.ndarray[float, float, float, float]	new scale

alpha

event info dict

dict key	type	description
value	float	new alpha value

alpha_mode

event info dict

dict key	type	description
value	str	new alpha mode

visible

event info dict

dict key	type	description
value	bool	new visibility bool

deleted

event info dict

dict key	type	description
value	bool	True when graphic was deleted

FilesExpand file tree

event_tables.rst

Latest commit

History

event_tables.rst

File metadata and controls

Event Tables

LineGraphic

data

colors

colors

cmap

thickness

size_space

name

offset

rotation

scale

alpha

alpha_mode

visible

deleted

ScatterGraphic

data

sizes

sizes

colors

colors

cmap

markers

markers

edge_colors

edge_colors

edge_width

image

size_space

point_rotations

point_rotations

name

offset

rotation

scale

alpha

alpha_mode

visible

deleted

ImageGraphic

data

cmap

vmin

vmax

interpolation

cmap_interpolation

name

offset

rotation

scale

alpha

alpha_mode

visible

deleted

ImageVolumeGraphic

data

cmap

vmin

vmax

interpolation

cmap_interpolation

mode

threshold

step_size

substep_size

emissive

shininess

plane

name

offset

rotation

scale

alpha