ScatterViewerState#
- class glue.viewers.scatter.state.ScatterViewerState(**kwargs)[source]#
Bases:
MatplotlibDataViewerState
A state class that includes all the attributes for a scatter viewer.
Attributes Summary
Whether to use radians or degrees for any angular coordinates
Aspect ratio for the axes
The resolution (in dots per inch) of density maps, if present
A collection of all layers in the viewer
Whether to plot the data in cartesian, polar or another projection
Whether the axes are shown
The title of the viewer
The attribute to show on the x-axis
Label for the x-axis
Size of the x-axis label
Weight of the x-axis label
Percentile to use when automatically determining x limits
Whether the x axis is logarithmic
Upper limit of the visible x range
Lower limit of the visible x range
Size of the x-axis tick labels
The attribute to show on the y-axis
Label for the y-axis
Size of the y-axis label
Weight of the y-axis label
Percentile to use when automatically determining y limits
Whether the y axis is logarithmic
Upper limit of the visible y range
Lower limit of the visible y range
Size of the y-axis tick labels
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.
Remove all global and property-specific callbacks.
flip_x
()Flip the x_min/x_max limits.
flip_y
()Flip the y_min/y_max limits.
is_callback_property
(name)Whether a property (identified by name) is a callback property.
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_axes_settings_from
(state)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
- angle_unit#
Whether to use radians or degrees for any angular coordinates
- aspect#
Aspect ratio for the axes
- dpi#
The resolution (in dots per inch) of density maps, if present
- layers#
A collection of all layers in the viewer
- layers_data#
- plot_mode#
Whether to plot the data in cartesian, polar or another projection
- show_axes#
Whether the axes are shown
- title#
The title of the viewer
- x_att#
The attribute to show on the x-axis
- x_axislabel#
Label for the x-axis
- x_axislabel_size#
Size of the x-axis label
- x_axislabel_weight#
Weight of the x-axis label
- x_limits_percentile#
Percentile to use when automatically determining x limits
- x_log#
Whether the x axis is logarithmic
- x_max#
Upper limit of the visible x range
- x_min#
Lower limit of the visible x range
- x_ticklabel_size#
Size of the x-axis tick labels
- y_att#
The attribute to show on the y-axis
- y_axislabel#
Label for the y-axis
- y_axislabel_size#
Size of the y-axis label
- y_axislabel_weight#
Weight of the y-axis label
- y_limits_percentile#
Percentile to use when automatically determining y limits
- y_log#
Whether the y axis is logarithmic
- y_max#
Upper limit of the visible y range
- y_min#
Lower limit of the visible y range
- y_ticklabel_size#
Size of the y-axis tick labels
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 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(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_axes_settings_from(state)#
- 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