LayerState

class glue.viewers.common.state.LayerState(viewer_state=None, **kwargs)

Bases: State

A base class for all layer states.

Attributes Summary

layer	The Data or Subset represented by the layer
visible	Whether the layer is currently visible
zorder	A value used to indicate which layers are shown in front of which (larger zorder values are on top of other layers)

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()
clear_callbacks()	Remove all global and property-specific callbacks.
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.
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

layer

The Data or Subset represented by the layer

visible

Whether the layer is currently visible

zorder

A value used to indicate which layers are shown in front of which (larger zorder values are on top of other layers)

Methods Documentation

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

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).

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()

clear_callbacks()

Remove all global and property-specific callbacks.

is_callback_property(name)

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

Parameters:

namestr

The name of the property to check

iter_callback_properties()

Iterator to loop over all callback properties.

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

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