updated search index

website/static/search_index.json

@@ -144,6 +144,11 @@
     "content": "Using NiceGUI as web interface for a ROS2 robot",
     "url": "https://github.com/zauberzeug/nicegui/tree/main/examples/ros2/"
   },
+  {
+    "title": "Example: Docker Image",
+    "content": "Demonstrate using the official[zauberzeug/nicegui](https://hub.docker.com/r/zauberzeug/nicegui) docker image",
+    "url": "https://github.com/zauberzeug/nicegui/tree/main/examples/docker_image/main.py"
+  },
   {
     "title": "Example: Download Text as File",
     "content": "providing in-memory data like strings as file download",
@@ -316,7 +321,7 @@
   },
   {
     "title": "Server Hosting",
-    "content": "To deploy your NiceGUI app on a server, you will need to execute your main.py (or whichever file contains your ui.run(...)) on your cloud infrastructure. You can, for example, just install the NiceGUI python package via pip and use systemd or similar service to start the main script. In most cases, you will set the port to 80 (or 443 if you want to use HTTPS) with the ui.run command to make it easily accessible from the outside.  A convenient alternative is the use of our pre-built multi-arch Docker image which contains all necessary dependencies. With this command you can launch the script main.py in the current directory on the public port 80: bash docker run -p 80:8080 -v $(pwd)/:/app/ \\ -d --restart always zauberzeug/nicegui:latest The demo assumes main.py uses the port 8080 in the ui.run command (which is the default). The -d tells docker to run in background and --restart always makes sure the container is restarted if the app crashes or the server reboots. Of course this can also be written in a Docker compose file: yaml app: image: zauberzeug/nicegui:latest restart: always ports: - 80:8080 volumes: - ./:/app/ You can provide SSL certificates directly using FastAPI. In production we also like using reverse proxies like Traefik or NGINX to handle these details for us. See our docker-compose.yml as an example.  You may also have a look at our demo for using a custom FastAPI app. This will allow you to do very flexible deployments as described in the FastAPI documentation. Note that there are additional steps required to allow multiple workers.",
+    "content": "To deploy your NiceGUI app on a server, you will need to execute your main.py (or whichever file contains your ui.run(...)) on your cloud infrastructure. You can, for example, just install the NiceGUI python package via pip and use systemd or similar service to start the main script. In most cases, you will set the port to 80 (or 443 if you want to use HTTPS) with the ui.run command to make it easily accessible from the outside.  A convenient alternative is the use of our pre-built multi-arch Docker image which contains all necessary dependencies. With this command you can launch the script main.py in the current directory on the public port 80: bash docker run -it --restart always \\ -p 80:8080 \\ -e PUID=$(id -u) \\ -e PGID=$(id -g) \\ -v $(pwd)/:/app/ \\ zauberzeug/nicegui:latest The demo assumes main.py uses the port 8080 in the ui.run command (which is the default). The -d tells docker to run in background and --restart always makes sure the container is restarted if the app crashes or the server reboots. Of course this can also be written in a Docker compose file: yaml app: image: zauberzeug/nicegui:latest restart: always ports: - 80:8080 environment: - PUID=1000 # change this to your user id - PGID=1000 # change this to your group id volumes: - ./:/app/ There are other handy features in the Docker image like non-root user execution and signal pass-through. For more details we recommend to have a look at our Docker example. You can provide SSL certificates directly using FastAPI. In production we also like using reverse proxies like Traefik or NGINX to handle these details for us. See our development docker-compose.yml as an example.  You may also have a look at our demo for using a custom FastAPI app. This will allow you to do very flexible deployments as described in the FastAPI documentation. Note that there are additional steps required to allow multiple workers.",
     "url": "/documentation/#server_hosting"
   },
   {
@@ -691,7 +696,7 @@
   },
   {
     "title": "Table",
-    "content": "A table based on Quasar's QTable <https://quasar.dev/vue-components/table>_ component.  :param columns: list of column objects :param rows: list of row objects :param row_key: name of the column containing unique data identifying the row (default: \"id\") :param title: title of the table :param selection: selection type (\"single\" or \"multiple\"; default: None) :param pagination: number of rows per page (None hides the pagination, 0 means \"infinite\"; default: None) :param on_select: callback which is invoked when the selection changes  If selection is 'single' or 'multiple', then a selected property is accessible containing the selected rows. add_rows Add rows to the table.remove_rows Remove rows from the table.",
+    "content": "A table based on Quasar's QTable <https://quasar.dev/vue-components/table>_ component.  :param columns: list of column objects :param rows: list of row objects :param row_key: name of the column containing unique data identifying the row (default: \"id\") :param title: title of the table :param selection: selection type (\"single\" or \"multiple\"; default: None) :param pagination: number of rows per page (None hides the pagination, 0 means \"infinite\"; default: None) :param on_select: callback which is invoked when the selection changes  If selection is 'single' or 'multiple', then a selected property is accessible containing the selected rows. set_fullscreen Set fullscreen mode.toggle_fullscreen Toggle fullscreen mode.add_rows Add rows to the table.remove_rows Remove rows from the table.",
     "url": "/documentation/table"
   },
   {
@@ -724,6 +729,11 @@
     "content": "You can define dynamic column attributes using a : prefix. This way you can define custom sorting and formatting functions.  The following example allows sorting the name column by length. The age column is formatted to show the age in years.",
     "url": "/documentation/table#custom_sorting_and_formatting"
   },
+  {
+    "title": "Table: Toggle fullscreen",
+    "content": "You can toggle the fullscreen mode of a table using the toggle_fullscreen() method.",
+    "url": "/documentation/table#toggle_fullscreen"
+  },
   {
     "title": "Notification",
     "content": "Displays a notification on the screen.  :param message: content of the notification :param position: position on the screen (\"top-left\", \"top-right\", \"bottom-left\", \"bottom-right\", \"top\", \"bottom\", \"left\", \"right\" or \"center\", default: \"bottom\") :param close_button: optional label of a button to dismiss the notification (default: False) :param type: optional type (\"positive\", \"negative\", \"warning\", \"info\" or \"ongoing\") :param color: optional color name :param multi_line: enable multi-line notifications  Note: You can pass additional keyword arguments according to Quasar's Notify API <https://quasar.dev/quasar-plugins/notify#notify-api>_.",
@@ -1039,9 +1049,14 @@
     "content": "You can use the on_click argument to ui.scene to handle click events. The callback receives a SceneClickEventArguments object with the following attributes:  - click_type: the type of click (\"click\" or \"dblclick\"). - button: the button that was clicked (1, 2, or 3). - alt, ctrl, meta, shift: whether the alt, ctrl, meta, or shift key was pressed. - hits: a list of SceneClickEventHit objects, sorted by distance from the camera.  The SceneClickEventHit object has the following attributes:  - object_id: the id of the object that was clicked. - object_name: the name of the object that was clicked. - x, y, z: the x, y and z coordinates of the click.",
     "url": "/documentation/scene#handling_click_events"
   },
+  {
+    "title": "Scene: Rendering point clouds",
+    "content": "You can render point clouds using the point_cloud method. The points argument is a list of point coordinates, and the colors argument is a list of RGB colors (0..1).",
+    "url": "/documentation/scene#rendering_point_clouds"
+  },
   {
     "title": "ui.run",
-    "content": "You can call ui.run() with optional arguments:  :param host: start server with this host (defaults to '127.0.0.1 in native mode, otherwise '0.0.0.0') :param port: use this port (default: 8080) :param title: page title (default: 'NiceGUI', can be overwritten per page) :param viewport: page meta viewport content (default: 'width=device-width, initial-scale=1', can be overwritten per page) :param favicon: relative filepath, absolute URL to a favicon (default: None, NiceGUI icon will be used) or emoji (e.g. '\ud83d\ude80', works for most browsers) :param dark: whether to use Quasar's dark mode (default: False, use None for \"auto\" mode) :param language: language for Quasar elements (default: 'en-US') :param binding_refresh_interval: time between binding updates (default: 0.1 seconds, bigger is more CPU friendly) :param show: automatically open the UI in a browser tab (default: True) :param on_air: tech preview: allows temporary remote access <https://nicegui.io/documentation#nicegui_on_air>_ if set to True (default: disabled) :param native: open the UI in a native window of size 800x600 (default: False, deactivates show, automatically finds an open port) :param window_size: open the UI in a native window with the provided size (e.g. (1024, 786), default: None, also activates native) :param fullscreen: open the UI in a fullscreen window (default: False, also activates native) :param reload: automatically reload the UI on file changes (default: True) :param uvicorn_logging_level: logging level for uvicorn server (default: 'warning') :param uvicorn_reload_dirs: string with comma-separated list for directories to be monitored (default is current working directory only) :param uvicorn_reload_includes: string with comma-separated list of glob-patterns which trigger reload on modification (default: '.py') :param uvicorn_reload_excludes: string with comma-separated list of glob-patterns which should be ignored for reload (default: '.*, .py[cod], .sw.*, ~*') :param tailwind: whether to use Tailwind (experimental, default: True) :param storage_secret: secret key for browser based storage (default: None, a value is required to enable ui.storage.individual and ui.storage.browser) :param kwargs: additional keyword arguments are passed to uvicorn.run",
+    "content": "You can call ui.run() with optional arguments:  :param host: start server with this host (defaults to '127.0.0.1 in native mode, otherwise '0.0.0.0') :param port: use this port (default: 8080) :param title: page title (default: 'NiceGUI', can be overwritten per page) :param viewport: page meta viewport content (default: 'width=device-width, initial-scale=1', can be overwritten per page) :param favicon: relative filepath, absolute URL to a favicon (default: None, NiceGUI icon will be used) or emoji (e.g. '\ud83d\ude80', works for most browsers) :param dark: whether to use Quasar's dark mode (default: False, use None for \"auto\" mode) :param language: language for Quasar elements (default: 'en-US') :param binding_refresh_interval: time between binding updates (default: 0.1 seconds, bigger is more CPU friendly) :param show: automatically open the UI in a browser tab (default: True) :param on_air: tech preview: allows temporary remote access <https://nicegui.io/documentation#nicegui_on_air>_ if set to True (default: disabled) :param native: open the UI in a native window of size 800x600 (default: False, deactivates show, automatically finds an open port) :param window_size: open the UI in a native window with the provided size (e.g. (1024, 786), default: None, also activates native) :param fullscreen: open the UI in a fullscreen window (default: False, also activates native) :param reload: automatically reload the UI on file changes (default: True) :param uvicorn_logging_level: logging level for uvicorn server (default: 'warning') :param uvicorn_reload_dirs: string with comma-separated list for directories to be monitored (default is current working directory only) :param uvicorn_reload_includes: string with comma-separated list of glob-patterns which trigger reload on modification (default: '.py') :param uvicorn_reload_excludes: string with comma-separated list of glob-patterns which should be ignored for reload (default: '.*, .py[cod], .sw.*, ~*') :param tailwind: whether to use Tailwind (experimental, default: True) :param prod_js: whether to use the production version of Vue and Quasar dependencies (default: True) :param endpoint_documentation: control what endpoints appear in the autogenerated OpenAPI docs (default: 'none', options: 'none', 'internal', 'page', 'all') :param storage_secret: secret key for browser based storage (default: None, a value is required to enable ui.storage.individual and ui.storage.browser) :param kwargs: additional keyword arguments are passed to uvicorn.run",
     "url": "/documentation/run"
   },
   {
@@ -1121,7 +1136,7 @@
   },
   {
     "title": "Line Plot",
-    "content": "Create a line plot using pyplot. The push method provides live updating when utilized in combination with ui.timer.  :param n: number of lines :param limit: maximum number of datapoints per line (new points will displace the oldest) :param update_every: update plot only after pushing new data multiple times to save CPU and bandwidth :param close: whether the figure should be closed after exiting the context; set to False if you want to update it later (default: True) :param kwargs: arguments like figsize which should be passed to pyplot.figure <https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.figure.html>_ with_legend push",
+    "content": "Create a line plot using pyplot. The push method provides live updating when utilized in combination with ui.timer.  :param n: number of lines :param limit: maximum number of datapoints per line (new points will displace the oldest) :param update_every: update plot only after pushing new data multiple times to save CPU and bandwidth :param close: whether the figure should be closed after exiting the context; set to False if you want to update it later (default: True) :param kwargs: arguments like figsize which should be passed to pyplot.figure <https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.figure.html>_ with_legend push clear Clear the line plot.",
     "url": "/documentation/line_plot"
   },
   {