ipyoverlay.widgets.ContextMenuArea#

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

Bases: VuetifyTemplate

Widget wrapper that displays a specified context menu when the widget is right clicked.

Methods

`__init__`([widget, menu, force_right_click])	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_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_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_set_menu_visible`(visible)	Vue-accessible function for displaying or hiding the menu.

Attributes

`area_id`	A trait for unicode strings.
`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.
`enabled`	Get/set whether the context menu area is actually active (if False, right click will follow normal browser behavior).
`events`	An instance of a Python list.
`force_right_click`	Whether to enforce all right-clicks opening a context menu.
`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.
`menu`	The context menu widget to use on right click.
`menu_id`	A trait for unicode strings.
`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`
`tooltip`	A tooltip caption.
`widget`	The widget/layout that this context menu area applies to.
`widget_types`
`widgets`

Parameters:

menu (ContextMenu) –
force_right_click (bool) –

area_id#: A trait for unicode strings.

enabled#: Get/set whether the context menu area is actually active (if False, right click will follow normal browser behavior).

force_right_click#: Whether to enforce all right-clicks opening a context menu. This is necessary when wrapping ipympl matplotlib canvas plots, since they disable right click triggering the browser’s contextmenu event.

menu#: The context menu widget to use on right click.

menu_id#: A trait for unicode strings.

vue_set_menu_visible(visible)#

Vue-accessible function for displaying or hiding the menu.

Parameters:: visible (bool) –

widget#: The widget/layout that this context menu area applies to.