ScatterViewerState3D

class glue.viewers.scatter3d.viewer_state.ScatterViewerState3D(**kwargs)

Bases: ViewerState3D

Attributes Summary

aspect
clip_data	A property that callback functions can be added to.
clip_limits
layers	A list property that calls callbacks when its contents are modified
layers_data
line_width	A property that callback functions can be added to.
native_aspect	A property that callback functions can be added to.
perspective_view	A property that callback functions can be added to.
title	The title of the viewer
visible_axes	A property that callback functions can be added to.
x_att
x_max	A property that callback functions can be added to.
x_min	A property that callback functions can be added to.
x_stretch	A property that callback functions can be added to.
y_att
y_max	A property that callback functions can be added to.
y_min	A property that callback functions can be added to.
y_stretch	A property that callback functions can be added to.
z_att
z_max	A property that callback functions can be added to.
z_min	A property that callback functions can be added to.
z_stretch	A property that callback functions can be added to.

Methods Summary

add_callback(name, callback[, echo_old, ...])	Add a callback that gets triggered when a callback property of the class changes.
add_global_callback(callback)	Add a global callback function, which is a callback that gets triggered when any callback properties on the class change.
as_dict()	Return the current state as a dictionary of attribute/value pairs.
callback_properties()	Return a list of all callback property names.
clear_callbacks()	Remove all global and property-specific callbacks.
flip_x()
flip_y()
flip_z()
is_alias(name)	Whether a property (identified by name) is a callback property alias.
is_callback_property(name)	Whether a property (identified by name) is a callback property.
iter_callback_properties()	Iterator to loop over all callback properties.
remove_callback(name, callback)	Remove a previously-added callback
remove_global_callback(callback)	Remove a global callback function.
reset()
reset_limits()
set_limits(x_min, x_max, y_min, y_max, ...)
update_from_dict(properties)	Update this state using the values from a dictionary of attributes.
update_from_state(state)	Update this state using the values from another state.

Attributes Documentation

aspect

clip_data

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

clip_limits

layers

A list property that calls callbacks when its contents are modified

layers_data

line_width

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

native_aspect

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

perspective_view

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

title

The title of the viewer

visible_axes

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

x_att

x_max

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

x_min

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

x_stretch

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

y_att

y_max

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

y_min

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

y_stretch

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

z_att

z_max

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

z_min

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

z_stretch

A property that callback functions can be added to.

When a callback property changes value, each callback function is called with information about the state change. Otherwise, callback properties behave just like normal instance variables.

CallbackProperties must be defined at the class level. Use the helper function add_callback() to attach a callback to a specific instance of a class with CallbackProperties

Parameters:

default

The initial value for the property

docstringstr

The docstring for the property

getter, setterfunc

Custom getter and setter functions (advanced)

Methods Documentation

add_callback(name, callback, echo_old=False, priority=0, validator=False)

Add a callback that gets triggered when a callback property of the class changes.

Parameters:

namestr

The instance to add the callback to.

callbackfunc

The callback function to add

echo_oldbool, optional

If True, the callback function will be invoked with both the old and new values of the property, as callback(old, new). If False (the default), will be invoked as callback(new)

priorityint, optional

This can optionally be used to force a certain order of execution of callbacks (larger values indicate a higher priority).

validatorbool, optional

Whether the callback is a validator, which is a special kind of callback that gets called before the property is set. The validator can return a modified value (for example it can be used to change the types of values or change properties in-place) or it can also raise an exception.

add_global_callback(callback)

Add a global callback function, which is a callback that gets triggered when any callback properties on the class change.

Parameters:

callbackfunc

The callback function to add

as_dict()

Return the current state as a dictionary of attribute/value pairs.

callback_properties()

Return a list of all callback property names.

Note: This does not include CallbackPropertyAlias instances, only actual CallbackProperty instances.

clear_callbacks()

Remove all global and property-specific callbacks.

flip_x()

flip_y()

flip_z()

is_alias(name)

Whether a property (identified by name) is a callback property alias.

Parameters:

namestr

The name of the property to check

is_callback_property(name)

Whether a property (identified by name) is a callback property.

Returns True for both CallbackProperty and CallbackPropertyAlias.

Parameters:

namestr

The name of the property to check

iter_callback_properties()

Iterator to loop over all callback properties.

Note: This does not include CallbackPropertyAlias instances, only actual CallbackProperty instances.

remove_callback(name, callback)

Remove a previously-added callback

Parameters:

namestr

The instance to remove the callback from.

funcfunc

The callback function to remove

remove_global_callback(callback)

Remove a global callback function.

Parameters:

callbackfunc

The callback function to remove

reset()

reset_limits()

set_limits(x_min, x_max, y_min, y_max, z_min, z_max)

update_from_dict(properties)

Update this state using the values from a dictionary of attributes.

Parameters:

propertiesdict

The dictionary containing attribute/value pairs.

update_from_state(state)

Update this state using the values from another state.

Parameters:

state~glue.core.state_objects.State

The state to use the values from