A Base Class for DOM Widgets

This is a base class for all widgets that are supposed to be part of the document object model

Usage

DOMWidget(...)

Arguments

...

Arguments passed to the inializer

Functions

• DOMWidget(): The DOM widget constructor function

Super classes

HasTraits -> Widget -> DOMWidget

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_dom_classes

A set of character strings that indicate the DOM classes the widget is assigned to

layout

The layout, a "LayoutClass" Widget

Methods

Public methods

• DOMWidget$add_class()

• DOMWidget$remove_class()

• DOMWidget$has_class()

• DOMWidget$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$initialize()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()

---

DOMWidget$add_class()

Add a class attribute to the DOM element

Usage

DOMWidget$add_class(className)

Arguments

className

Name of the class attribute

---

DOMWidget$remove_class()

Remove a class attribute to the DOM element

Usage

DOMWidget$remove_class(className)

Arguments

className

Name of the class attribute

---

DOMWidget$has_class()

Check whether the DOM element has a class attribute

Usage

DOMWidget$has_class(className)

Arguments

className

Name of the class attribute

---

DOMWidget$clone()

The objects of this class are cloneable with this method.

Usage

DOMWidget$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.