ipyoverlay.widgets.DecoratedWidgetWrapper#

class ipyoverlay.widgets.DecoratedWidgetWrapper(**kwargs)#

Bases: VuetifyTemplate

A ‘windowed’ draggable and closeable wrapper for any ipywidget.

This renders a widget and places a bar above it with an exit button, and click and drag functionality only occurs when this bar is clicked. This allows un-conflicted interaction with the inner widget itself.

Parameters:: widget – The ipywidget to display inside this overlay.

Methods

`__init__`([widget])	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`()
`fire_on_closed`()	Trigger all registered on_closed callbacks.
`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_closed`(callback)	Register a callback to execute when the widget is closed
`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.
`overlay_container_should_handle_click`(e)	When the container detects a click on a widget, it calls this to determine if it should handle it (`True`, container will then handle dragging logic) or if this widget will handle it (`False`).
`recheck_position`()	Request the vue side to update/sync current_x and current_y values.
`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_handle_header_close_clicked`(e)	Event handler for when the vue component's x-button is clicked.

Attributes

`active`	A boolean (True, False) trait.
`active_header_color`	A trait for unicode strings.
`background_color`	A trait for unicode strings.
`class_component_serialization`
`clicked`	A boolean (True, False) trait.
`closable`	A boolean (True, False) trait.
`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.
`current_height`	A float trait.
`current_width`	A float trait.
`current_x`	A float trait.
`current_y`	A float trait.
`data`	A trait for unicode strings.
`decoration_height`	An int trait.
`default_border_color`	A trait for unicode strings.
`default_header_color`	A trait for unicode strings.
`events`	An instance of a Python list.
`height`	A trait which allows any value.
`hover_border_color`	A trait for unicode strings.
`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.
`tabbable`	Is widget tabbable?
`template`	A trait type representing a Union type.
`template_file`
`title`	A trait for unicode strings.
`tooltip`	A tooltip caption.
`widget`	A trait which allows any value.
`widget_types`
`widgets`
`width`	A trait which allows any value.
`wrapper_id`	A trait for unicode strings.
`z_index`	An int trait.

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

active_header_color#: A trait for unicode strings.

background_color#: A trait for unicode strings.

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

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

current_height#: A float trait.

current_width#: A float trait.

current_x#: A float trait.

current_y#: A float trait.

decoration_height#: An int trait.

default_border_color#: A trait for unicode strings.

default_header_color#: A trait for unicode strings.

fire_on_closed()#: Trigger all registered on_closed callbacks.

height#: A trait which allows any value.

hover_border_color#: A trait for unicode strings.

on_closed(callback)#

The callback will be passed this widget’s instance.

Parameters:: callback (Callable[[DecoratedWidgetWrapper], None]) –

overlay_container_should_handle_click(e)#

When the container detects a click on a widget, it calls this to determine if it should handle it (True, container will then handle dragging logic) or if this widget will handle it (False).

Return type:: bool

recheck_position()#: Request the vue side to update/sync current_x and current_y values. This reads from JS, doesn’t write.

title#: A trait for unicode strings.

vue_handle_header_close_clicked(e)#: Event handler for when the vue component’s x-button is clicked.

widget#: A trait which allows any value.

width#: A trait which allows any value.

wrapper_id#: A trait for unicode strings.

z_index#: An int trait.