Catalogs

class jdaviz.configs.imviz.plugins.catalogs.catalogs.Catalogs(*args, **kwargs)[source] [edit on github]

Bases: PluginTemplateMixin, ViewerSelectMixin

See the Catalog Search Plugin Documentation for more details.

Only the following attributes and methods are available through the public plugin API:

Public constructor

Attributes Summary

catalog_items

An instance of a Python list.

catalog_selected

A trait for unicode strings.

from_file

A trait for unicode strings.

from_file_message

A trait for unicode strings.

number_of_results

An int trait.

results_available

A boolean (True, False) trait.

template_file

Methods Summary

clear([hide_only])

search()

Search the catalog, display markers on the viewer, and return a table of results (or None if no results available)

vue_do_clear(*args, **kwargs)

vue_do_search(*args, **kwargs)

vue_set_file_from_dialog(*args, **kwargs)

Attributes Documentation

catalog_items

An instance of a Python list.

catalog_selected

A trait for unicode strings.

from_file

A trait for unicode strings.

from_file_message

A trait for unicode strings.

number_of_results

An int trait.

results_available

A boolean (True, False) trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v3.5.0/lib/python3.9/site-packages/jdaviz/configs/imviz/plugins/catalogs/catalogs.py', 'catalogs.vue')

Methods Documentation

clear(hide_only=True)[source] [edit on github]
search()[source] [edit on github]

Search the catalog, display markers on the viewer, and return a table of results (or None if no results available)

vue_do_clear(*args, **kwargs)[source] [edit on github]
vue_set_file_from_dialog(*args, **kwargs)[source] [edit on github]