HistogramLayerState¶
-
class
glue.viewers.histogram.state.
HistogramLayerState
(viewer_state=None, **kwargs)[source]¶ Bases:
glue.viewers.matplotlib.state.MatplotlibLayerState
A state class that includes all the attributes for layers in a histogram plot.
Attributes Summary
The transparency used to display the data
The color used to display the data
Whether the layer is currently visible
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
(self, name, callback[, …])Add a callback that gets triggered when a callback property of the class changes.
add_global_callback
(self, callback)Add a global callback function, which is a callback that gets triggered when any callback properties on the class change.
as_dict
(self)Return the current state as a dictionary of attribute/value pairs.
callback_properties
(self)clear_callbacks
(self)Remove all global and property-specific callbacks.
is_callback_property
(self, name)Whether a property (identified by name) is a callback property.
iter_callback_properties
(self)Iterator to loop over all callback properties.
remove_callback
(self, name, callback)Remove a previously-added callback
remove_global_callback
(self, callback)Remove a global callback function.
reset_cache
(self, \*args)update_from_dict
(self, properties)Update this state using the values from a dictionary of attributes.
update_from_state
(self, state)Update this state using the values from another state.
update_histogram
(self)Attributes Documentation
-
alpha
¶ The transparency used to display the data
-
color
¶ The color used to display the data
-
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
(self, 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 ascallback(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
(self, 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
(self)¶ Return the current state as a dictionary of attribute/value pairs.
-
callback_properties
(self)¶
-
clear_callbacks
(self)¶ Remove all global and property-specific callbacks.
-
is_callback_property
(self, name)¶ Whether a property (identified by name) is a callback property.
- Parameters
- namestr
The name of the property to check
-
iter_callback_properties
(self)¶ Iterator to loop over all callback properties.
-
remove_callback
(self, 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
(self, callback)¶ Remove a global callback function.
- Parameters
- callbackfunc
The callback function to remove
-
update_from_dict
(self, properties)¶ Update this state using the values from a dictionary of attributes.
- Parameters
- propertiesdict
The dictionary containing attribute/value pairs.
-
update_from_state
(self, state)¶ Update this state using the values from another state.
- Parameters
- state~glue.core.state_objects.State
The state to use the values from
-