Table#

class jdaviz.core.template_mixin.Table(**kwargs: Any)[source]#

Bases: PluginSubcomponent

Table subcomponent. For most cases where a plugin only requires a single table, use the mixin instead.

To use in a plugin, define plugin.table = Table(plugin), create a table_widget Unicode traitlet, and set plugin.table_widget = 'IPY_MODEL_'+self.table.model_id.

To render in the plugin’s vue file:

<jupyter-widget :widget="table_widget"></jupyter-widget>

Public constructor

Attributes Summary

`headers_avail`	An instance of a Python list.
`headers_visible`	An instance of a Python list.
`item_key`	A trait for unicode strings.
`items`	An instance of a Python list.
`selected_rows`	An instance of a Python list.
`show_rowselect`	A boolean (True, False) trait.
`template_file`
`user_api`

Methods Summary

`add_item`(item)	Add an item/row to the table.
`clear_table`()	Clear all entries/markers from the current table.
`default_value_for_column`([colname, value])
`export_table`([filename, overwrite])	Export the QTable representation of the table.
`vue_clear_table`([data])

Attributes Documentation

headers_avail#: An instance of a Python list.

headers_visible#: An instance of a Python list.

item_key#: A trait for unicode strings.

items#: An instance of a Python list.

selected_rows#: An instance of a Python list.

show_rowselect#: A boolean (True, False) trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/camipacifici/envs/latest/lib/python3.11/site-packages/jdaviz/core/template_mixin.py', '../components/plugin_table.vue')#

user_api#

Methods Documentation

add_item(item)[source]#

Add an item/row to the table.

Parameters:

itemQTable, QTableRow, or dictionary of row-name, value pairs

clear_table()[source]#: Clear all entries/markers from the current table.

default_value_for_column(colname=None, value=None)[source]#

export_table(filename=None, overwrite=False)[source]#

Export the QTable representation of the table.

Parameters:

filenamestr, optional: If provided, will write to the file, otherwise will just return the QTable object.
overwritebool, optional: If filename already exists, should it be overwritten.

vue_clear_table(data=None)[source]#