icat.table.TableContentsTemplate#

class icat.table.TableContentsTemplate(**kwargs)#

Bases: VuetifyTemplate

The primary table used in the DataManager class. This is a heavily modified vuetify DataTable, largely necessary for us to be able to put a more comprehensive set of action buttons in each row.

Methods

`__init__`(args, *kwargs)	Public constructor
`add_class`(className)	Adds a class to the top level element of the widget.
`add_traits`(**traits)	Dynamically add trait attributes to the Widget.
`blur`()	Blur the widget.
`class_own_trait_events`(name)	Get a dict of all event handlers defined on this class, not a parent.
`class_own_traits`(**metadata)	Get a dict of all the traitlets defined on this class, not a parent.
`class_trait_names`(**metadata)	Get a list of all the names of this class' traits.
`class_traits`(**metadata)	Get a `dict` of all the traits of this class.
`close`()	Close method.
`close_all`()
`focus`()	Focus on the widget.
`get_manager_state`([drop_defaults, widgets])	Returns the full state for a widget manager for embedding
`get_state`([key, drop_defaults])	Gets the widget state, or a piece of it.
`get_view_spec`()
`handle_comm_opened`(comm, msg)	Static method, called when a widget is constructed.
`handle_control_comm_opened`(comm, msg)	Class method, called when the comm-open message on the "jupyter.widget.control" comm channel is received
`has_trait`(name)	Returns True if the object has a trait with the specified name.
`hold_sync`()	Hold syncing any state until the outermost context manager exits
`hold_trait_notifications`()	Context manager for bundling trait change notifications and cross validation.
`notify_change`(change)	Called when a property has changed.
`observe`(handler[, names, type])	Setup a handler to be called when a trait changes.
`on_add_example`(callback)	Expect a point ID
`on_add_to_sample`(callback)	Expect a point id
`on_apply_label`(callback)	Expect a point id and a label value (0 or 1)
`on_msg`(callback[, remove])	(Un)Register a custom msg receive callback.
`on_point_hover`(callback)	Expect a point ID
`on_select_point`(callback)	Expect a point ID
`on_trait_change`([handler, name, remove])	DEPRECATED: Setup a handler to be called when a trait changes.
`on_update_options`(callback)	Expect a dictionary with:
`on_widget_constructed`(callback)	Registers a callback to be called when a widget is constructed.
`open`()	Open a comm to the frontend if one isn't already open.
`remove_class`(className)	Removes a class from the top level element of the widget.
`send`(content[, buffers])	Sends a custom msg to the widget model in the front-end.
`send_state`([key])	Sends the widget state, or a piece of it, to the front-end, if it exists.
`set_state`(sync_data)	Called when a state is received from the front-end.
`set_trait`(name, value)	Forcibly sets trait attribute, including read-only attributes.
`setup_instance`(**kwargs)	This is called before self.__init__ is called.
`trait_defaults`(names, *metadata)	Return a trait's default value or a dictionary of them
`trait_events`([name])	Get a `dict` of all the event handlers of this class.
`trait_has_value`(name)	Returns True if the specified trait has a value.
`trait_metadata`(traitname, key[, default])	Get metadata values for trait by key.
`trait_names`(**metadata)	Get a list of all the names of this class' traits.
`trait_values`(**metadata)	A `dict` of trait names and their values.
`traits`(**metadata)	Get a `dict` of all the traits of this class.
`unobserve`(handler[, names, type])	Remove a trait change handler.
`unobserve_all`([name])	Remove trait change handlers of any type for the specified name.
`vue_addSelectedText`(data)
`vue_addToExampleAnchor`(point_id)
`vue_addToSample`(point_id)
`vue_applyAbsoluteLabelInteresting`(point_id)
`vue_applyAbsoluteLabelUninteresting`(point_id)
`vue_applyAbsoluteLabelUnlabeled`(point_id)
`vue_hoverPoint`(point_id)
`vue_selectPoint`(point_id)
`vue_updateOptions`(data)

Attributes

`class_component_serialization`
`comm`	A trait which allows any value.
`components`	An instance of a Python dict.
`cross_validation_lock`	A contextmanager for running a block with our cross validation lock set to True.
`css`	A trait for unicode strings.
`data`	A trait for unicode strings.
`events`	An instance of a Python list.
`example_btn_color`	A trait for unicode strings.
`example_type_name`	A trait for unicode strings.
`headers`	An instance of a Python list.
`height`	An int trait.
`items`	An instance of a Python list.
`keys`	The traits which are synced.
`layout`	An instance trait which coerces a dict to an instance.
`log`	A trait whose value must be an instance of a specified class.
`methods`	A trait for unicode strings.
`model_id`	Gets the model id of this widget.
`options`	An instance of a Python dict.
`tabbable`	Is widget tabbable?
`template`	A trait type representing a Union type.
`template_file`
`tooltip`	A tooltip caption.
`total_length`	An int trait.
`widget_types`
`widgets`
`width`	An int trait.

example_btn_color#: A trait for unicode strings.

example_type_name#: A trait for unicode strings.

headers#: An instance of a Python list.

height#: An int trait.

items#: An instance of a Python list.

on_add_example(callback)#

Expect a point ID

Parameters:: callback (callable) –

on_add_to_sample(callback)#

Expect a point id

Parameters:: callback (callable) –

on_apply_label(callback)#

Expect a point id and a label value (0 or 1)

Parameters:: callback (callable) –

on_point_hover(callback)#

Expect a point ID

Parameters:: callback (callable) –

on_select_point(callback)#

Expect a point ID

Parameters:: callback (callable) –

on_update_options(callback)#

Expect a dictionary with:

page: int
itemsPerPage: int
sortBy: list[str]
sortDesc: list[bool]
groupBy: list[str]
groupDesc: list[bool]
multiSort: bool
mustSort: bool

so this will include page change events

Parameters:: callback (callable) –

options#

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

total_length#: An int trait.

vue_addSelectedText(data)#

vue_addToExampleAnchor(point_id)#

vue_addToSample(point_id)#

vue_applyAbsoluteLabelInteresting(point_id)#

vue_applyAbsoluteLabelUninteresting(point_id)#

vue_applyAbsoluteLabelUnlabeled(point_id)#

vue_hoverPoint(point_id)#

vue_selectPoint(point_id)#

vue_updateOptions(data)#

width#: An int trait.