genome_spy.JupyterChart

class genome_spy.JupyterChart(*args, **kwargs)View on GitHub

Bases: AnyWidget

A lightweight anywidget wrapper around GenomeSpy’s embed API.

Methods

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_msg(callback[, remove])	(Un)Register a custom msg receive callback.
on_trait_change([handler, name, remove])	DEPRECATED: Setup a handler to be called when a trait changes.
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_data(data, *[, format])	Replace the only declared live dataset.
set_dataset(name, data, *[, format])	Replace one declared live dataset without recreating GenomeSpy.
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(*args, **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.

property dataset_namesView on GitHub

Return live dataset names in declaration order.

Description:

Names are taken from the widget’s fixed runtime dataset manifest. Repeated names indicate scoped declarations and require a unique name before they can be addressed through set_dataset().

Returns:

Dataset names in declaration order.

Raises:

No exceptions are raised directly here. –

Example

>>> chart.widget().dataset_names
('table',)

set_dataset(name, data, *, format='arrow')View on GitHub

Replace one declared live dataset without recreating GenomeSpy.

Description:

Arrow is the default and transfers supported dataframe/table inputs as a binary AnyWidget buffer. Use format="records" only for ordinary JSON-compatible record lists.

Parameters:

• name – Declared dataset name.

• data – Table or records used as the replacement value.

• format – Transport format, either "arrow" or "records".

Returns:

None after the synchronized transport state has been updated.

Raises:

• KeyError – If no declared dataset has name.

• ValueError – If name is ambiguous or cannot be addressed.

• TypeError – If data cannot be serialized using format.

Example

>>> view.set_dataset('table', dataframe)

set_data(data, *, format='arrow')View on GitHub

Replace the only declared live dataset.

Description:

This is a convenience alias for set_dataset() when the widget has exactly one live dataset.

Parameters:

• data – Table or records used as the replacement value.

• format – Transport format, either "arrow" or "records".

Returns:

None after the synchronized transport state has been updated.

Raises:

• ValueError – If the widget has zero or multiple live datasets.

• TypeError – If data cannot be serialized using format.

Example

>>> view.set_data(dataframe)