ipyoverlay.connection.Connection#

class ipyoverlay.connection.Connection(**kwargs)#

Bases: VuetifyTemplate

SVG connection line, can be used to help track what an overlaid widget is referring to in an underlying component.

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`()
`connect_to_mpl`(side, axis, data_x, data_y)	Start any necessary tracking so matplotlib figure changes keep the connection line endpoint updated.
`connect_to_plotly`(side, fig_widget, data_x, ...)	Start any necessary tracking so plotly figure changes keep the connection line endpoint updated.
`disconnect_mpl`()	Since each connection adds its own draw_event listener, we need to make sure to remove it once a connection is removed, otherwise it will continue to try updating a non-existant svg.
`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.
`recheck_position`()	Ask JS to update python values for the current x1,y1,x2,y2.
`refresh_mpl_location`()	If using matplotlib, update endpoint with current pixel values for associated data.
`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.

Attributes

`class_component_serialization`
`comm`	A trait which allows any value.
`components`	An instance of a Python dict.
`conn_type_1`	An int trait.
`conn_type_2`	An int trait.
`connection_id`	A trait for unicode strings.
`container_id`	A trait for unicode strings.
`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.
`data_x`	A float trait.
`data_y`	A float trait.
`events`	An instance of a Python list.
`height`	Height of the SVG container to draw this connection within.
`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.
`mpl_div_class`	A trait for unicode strings.
`plotly_div_class`	A trait for unicode strings.
`tabbable`	Is widget tabbable?
`template`	A trait type representing a Union type.
`template_file`
`tooltip`	A tooltip caption.
`widget_types`
`widgets`
`width`	Width of the SVG container to draw this connection within.
`x1`	X coordinate of first endpoint.
`x2`	X coordinate of second endpoint.
`y1`	Y coordinate of first endpoint.
`y2`	Y coordinate of second endpoint.

conn_type_1#: An int trait.

conn_type_2#: An int trait.

connect_to_mpl(side, axis, data_x, data_y)#

Start any necessary tracking so matplotlib figure changes keep the connection line endpoint updated.

Parameters:

side (int) – Which end of the connection refers to the MPL axis (1 or 2.)
fig_widget (Axes) – The matplotlib axis object being connected to.
data_x (float) – The x-value within the axis to show the connection endpoint.
data_y (float) – The y-value within the axis to show the connection endpoint.
axis (Axes) –

connect_to_plotly(side, fig_widget, data_x, data_y)#

Start any necessary tracking so plotly figure changes keep the connection line endpoint updated.

Parameters:

side (int) – ??? TODO: unused currently
fig_widget (FigureWidget) – The plotly widget being connected to.
data_x (float) – The x-value within the widget to show the connection endpoint.
data_y (float) – The y-value within the widget to show the connection endpoint.

connection_id#: A trait for unicode strings.

container_id#: A trait for unicode strings.

data_x#: A float trait.

data_y#: A float trait.

disconnect_mpl()#: Since each connection adds its own draw_event listener, we need to make sure to remove it once a connection is removed, otherwise it will continue to try updating a non-existant svg.

height#: Height of the SVG container to draw this connection within. Should match OverlayContainer height.

mpl_div_class#: A trait for unicode strings.

plotly_div_class#: A trait for unicode strings.

recheck_position()#: Ask JS to update python values for the current x1,y1,x2,y2.

refresh_mpl_location()#: If using matplotlib, update endpoint with current pixel values for associated data.

width#: Width of the SVG container to draw this connection within. Should match OverlayContainer width.

x1#: X coordinate of first endpoint. This attribute is only used to send a value to the JS side, it won’t necessarily reflect the current value.

x2#: X coordinate of second endpoint. This attribute is only used to send a value to the JS side, it won’t necessarily reflect the current value.

y1#: Y coordinate of first endpoint. This attribute is only used to send a value to the JS side, it won’t necessarily reflect the current value.

y2#: Y coordinate of second endpoint. This attribute is only used to send a value to the JS side, it won’t necessarily reflect the current value.