JdavizViewerMixin#

class jdaviz.configs.default.plugins.viewers.JdavizViewerMixin(*args, **kwargs)[source]#

Bases: WithCache

Attributes Summary

`active_cube_layer`	Active cube layer in the viewer, if available.
`active_image_layer`	Active image layer in the viewer, if available.
`custom_marks`	Return all marks that are not Lines/LinesGL objects (but can be subclasses)
`data_labels_loaded`
`data_labels_visible`
`data_menu`
`hub`
`jdaviz_app`	The Jdaviz application tied to the viewer.
`jdaviz_helper`	The Jdaviz configuration helper tied to the viewer.
`native_marks`	Return all marks that are Lines/LinesGL objects (and not subclasses)
`reference`
`reference_id`
`toolbar`
`tools`
`tools_nested`
`user_api`

Methods Summary

`apply_roi`(roi[, use_current])	Apply an ROI to the viewer.
`clone_viewer`()
`get_limits`()	Return current viewer axes limits.
`initialize_toolbar`([default_tool_priority])
`reset_limits`()	Reset viewer axes limits.
`set_limits`([x_min, x_max, y_min, y_max])	Set viewer axes limits.
`set_plot_axes`()
`set_tick_format`(fmt, axis)	Manually set the tick format of one of the axes.

Attributes Documentation

active_cube_layer#: Active cube layer in the viewer, if available.

active_image_layer#: Active image layer in the viewer, if available.

custom_marks#: Return all marks that are not Lines/LinesGL objects (but can be subclasses)

data_labels_loaded#

Deprecated since version 4.1: The data_labels_loaded function is deprecated and may be removed in a future version. Use viewer.data_menu.data_labels_loaded instead.

List of data labels loaded in this viewer.

Returns:

data_labelslist: list of strings

data_labels_visible#

Deprecated since version 4.1: The data_labels_visible function is deprecated and may be removed in a future version. Use viewer.data_menu.data_labels_visible instead.

List of data labels visible in this viewer.

Returns:

data_labelslist: list of strings

data_menu#

hub#

jdaviz_app#: The Jdaviz application tied to the viewer.

jdaviz_helper#: The Jdaviz configuration helper tied to the viewer.

native_marks#: Return all marks that are Lines/LinesGL objects (and not subclasses)

reference#

reference_id#

toolbar = None#

tools#

tools_nested = []#

user_api#

Methods Documentation

apply_roi(roi, use_current=False)[source]#

Apply an ROI to the viewer.

Detects whether the user is resizing or moving an existing subset. When detected and mode is NewMode, temporarily switches to ReplaceMode so the subset is modified in-place rather than duplicated.

clone_viewer()[source]#

get_limits()[source]#

Return current viewer axes limits.

Returns:

x_min, x_max, y_min, y_maxfloat: Lower/upper X/Y limits, respectively.

initialize_toolbar(default_tool_priority=[])[source]#

reset_limits()[source]#: Reset viewer axes limits.

set_limits(x_min=None, x_max=None, y_min=None, y_max=None)[source]#

Set viewer axes limits.

Parameters:

x_minfloat or None, optional: lower-limit of x-axis (in current axes units)
x_max: float or None, optional: upper-limit of x-axis (in current axes units)
y_minfloat or None, optional: lower-limit of y-axis (in current axes units)
y_max: float or None, optional: upper-limit of y-axis (in current axes units)

set_plot_axes()[source]#

set_tick_format(fmt, axis)[source]#

Manually set the tick format of one of the axes.

Parameters:

fmtstr: Format of tick marks. For example, '0.1e' to set scientific notation or '0.2f' to turn it off.
axis{x, y}: The viewer axis.