GuiDropdownHandle,
GuiEvent,
GuiFolderHandle,
+ GuiHtmlHandle,
GuiImageHandle,
GuiMarkdownHandle,
GuiModalHandle,
@@ -1041,6 +1042,47 @@ Source code for viser._gui_api
return handle
+
+[docs]
+ def add_html(
+ self,
+ content: str,
+ order: float | None = None,
+ visible: bool = True,
+ ) -> GuiHtmlHandle:
+ """Add HTML to the GUI.
+
+ Args:
+ content: HTML content to display.
+ order: Optional ordering, smallest values will be displayed first.
+ visible: Whether the component is visible.
+
+ Returns:
+ A handle that can be used to interact with the GUI element.
+ """
+ message = _messages.GuiHtmlMessage(
+ uuid=_make_uuid(),
+ container_uuid=self._get_container_uuid(),
+ props=_messages.GuiHtmlProps(
+ order=_apply_default_order(order),
+ content=content,
+ visible=visible,
+ ),
+ )
+ self._websock_interface.queue_message(message)
+
+ handle = GuiHtmlHandle(
+ _GuiHandleState(
+ message.uuid,
+ self,
+ None,
+ props=message.props,
+ parent_container_id=message.container_uuid,
+ ),
+ )
+ return handle
+
+
[docs]
def add_image(
diff --git a/main/_modules/viser/_gui_handles/index.html b/main/_modules/viser/_gui_handles/index.html
index 442b07c88..8064ffbf7 100644
--- a/main/_modules/viser/_gui_handles/index.html
+++ b/main/_modules/viser/_gui_handles/index.html
@@ -425,6 +425,7 @@ Source code for viser._gui_handles
GuiCloseModalMessage,
GuiDropdownProps,
GuiFolderProps,
+ GuiHtmlProps,
GuiImageProps,
GuiMarkdownProps,
GuiMultiSliderProps,
@@ -1271,6 +1272,13 @@ Source code for viser._gui_handles
+
+[docs]
+class GuiHtmlHandle(_GuiHandle[None], GuiHtmlProps):
+ """Handling for updating and removing HTML elements."""
+
+
+
[docs]
class GuiPlotlyHandle(_GuiHandle[None], GuiPlotlyProps):
diff --git a/main/_sources/gui_handles.md.txt b/main/_sources/gui_handles.md.txt
index 9cd30e41e..e79fff603 100644
--- a/main/_sources/gui_handles.md.txt
+++ b/main/_sources/gui_handles.md.txt
@@ -14,6 +14,8 @@
.. autoclass:: viser.GuiMarkdownHandle()
+.. autoclass:: viser.GuiHtmlHandle()
+
.. autoclass:: viser.GuiPlotlyHandle()
.. autoclass:: viser.GuiTabGroupHandle()
diff --git a/main/genindex/index.html b/main/genindex/index.html
index 08317db78..784ed5d02 100644
--- a/main/genindex/index.html
+++ b/main/genindex/index.html
@@ -497,6 +497,8 @@ A
add_glb() (viser.SceneApi method)
add_grid() (viser.SceneApi method)
+
+ add_html() (viser.GuiApi method)
add_icosphere() (viser.SceneApi method)
@@ -885,11 +887,11 @@ A
ARROW_AUTOFIT_RIGHT (viser.Icon attribute)
ARROW_AUTOFIT_UP (viser.Icon attribute)
-
- ARROW_AUTOFIT_WIDTH (viser.Icon attribute)
+ - ARROW_AUTOFIT_WIDTH (viser.Icon attribute)
+
- ARROW_BACK (viser.Icon attribute)
- ARROW_BACK_UP (viser.Icon attribute)
@@ -3658,9 +3660,11 @@
C
- container_uuid (viser.Gui3dContainerHandle attribute)
- - content (viser.GuiMarkdownHandle property)
+
- content (viser.GuiHtmlHandle attribute)
@@ -5545,6 +5549,8 @@ G
- GuiEvent (class in viser)
- GuiFolderHandle (class in viser)
+
+ - GuiHtmlHandle (class in viser)
- GuiInputHandle (class in viser)
@@ -7657,6 +7663,8 @@ O
- (viser.GuiDropdownHandle attribute)
- (viser.GuiFolderHandle attribute)
+
+ - (viser.GuiHtmlHandle attribute)
- (viser.GuiInputHandle attribute)
@@ -8485,6 +8493,8 @@ R
- (viser.GuiDropdownHandle method)
- (viser.GuiFolderHandle method)
+
+ - (viser.GuiHtmlHandle method)
- (viser.GuiInputHandle method)
@@ -10521,10 +10531,10 @@ V
- VIRUS_OFF (viser.Icon attribute)
-
-
viser.infra
@@ -10569,6 +10579,8 @@
V
- (viser.GuiDropdownHandle attribute)
- (viser.GuiFolderHandle attribute)
+
+ - (viser.GuiHtmlHandle attribute)
- (viser.GuiInputHandle attribute)
diff --git a/main/gui_api/index.html b/main/gui_api/index.html
index e22c5eaa6..d1dc754ce 100644
--- a/main/gui_api/index.html
+++ b/main/gui_api/index.html
@@ -534,6 +534,27 @@ GUI API¶
+
+-
+add_html(content: str, order: float | None = None, visible: bool = True) GuiHtmlHandle[source]¶
+Add HTML to the GUI.
+
+- Parameters:
+
+content (str) – HTML content to display.
order (float | None) – Optional ordering, smallest values will be displayed first.
visible (bool) – Whether the component is visible.
+- Returns:
+A handle that can be used to interact with the GUI element.
+- Return type:
+-
+
+
+
+
-
add_image(image: ndarray, label: str | None = None, format: Literal[‘png’, ‘jpeg’] = 'jpeg', jpeg_quality: int | None = None, order: float | None = None, visible: bool = True) GuiImageHandle[source]¶
@@ -1031,6 +1052,7 @@ GUI API¶
GuiApi.add_modal()GuiApi.add_tab_group()GuiApi.add_markdown()GuiApi.add_html()GuiApi.add_image()GuiApi.add_plotly()GuiApi.add_button()GUI Handles
+-
+class viser.GuiHtmlHandle[source]¶
+Handling for updating and removing HTML elements.
+
+-
+remove() None¶
+Permanently remove this GUI element from the visualizer.
+
+- Return type:
+None
+
+
+
+
+-
+order: float¶
+Order value for arranging GUI elements. Synchronized automatically when assigned.
+
+
+
+-
+content: str¶
+HTML content to be displayed. Synchronized automatically when assigned.
+
+
+
+-
+visible: bool¶
+Visibility state of the markdown element. Synchronized automatically when assigned.
+
+
+
+
-
class viser.GuiPlotlyHandle[source]¶
@@ -2180,6 +2215,13 @@ GUI HandlesGuiMarkdownHandle.content
+GuiHtmlHandle
+GuiPlotlyHandle
GuiPlotlyHandle.remove()GuiPlotlyHandle.order