Function widget_template

geemap/coreutils.py:488–618

Create a widget template. Args: widget: The widget to be displayed. opened: Whether to open the toolbar. show_close_button: Whether to show the close button. widget_icon: The icon name for the toolbar button. close_button_icon: The icon name for the close

(
    widget: ipywidgets.Widget | None = None,
    opened: bool = True,
    show_close_button: bool = True,
    widget_icon: str = "gear",
    close_button_icon: str = "times",
    widget_args: dict[str, Any] | None = None,
    close_button_args: dict[str, Any] | None = None,
    display_widget: ipywidgets.Widget | None = None,
    m: ipyleaflet.Map | None = None,
    position: str = "topright",
)

def widget_template(
    widget: ipywidgets.Widget | None = None,
    opened: bool = True,
    show_close_button: bool = True,
    widget_icon: str = "gear",
    close_button_icon: str = "times",
    widget_args: dict[str, Any] | None = None,
    close_button_args: dict[str, Any] | None = None,
    display_widget: ipywidgets.Widget | None = None,
    m: ipyleaflet.Map | None = None,
    position: str = "topright",
) -> ipywidgets.Widget | None:
    """Create a widget template.

    Args:
        widget: The widget to be displayed.
        opened: Whether to open the toolbar.
        show_close_button: Whether to show the close button.
        widget_icon: The icon name for the toolbar button.
        close_button_icon: The icon name for the close button.
        widget_args: Additional arguments to pass to the toolbar button.
        close_button_args: Additional arguments to pass to the close button.
        display_widget: The widget to be displayed when the toolbar is clicked.
        m: The ipyleaflet.Map instance.
        position: The position of the toolbar.

    Returns:
        The created widget template.
    """
    name = "_" + random_string()  # A random attribute name.

    if widget_args is None:
        widget_args = {}

    if close_button_args is None:
        close_button_args = {}

    if "value" not in widget_args:
        widget_args["value"] = False
    if "tooltip" not in widget_args:
        widget_args["tooltip"] = "Toolbar"
    if "layout" not in widget_args:
        widget_args["layout"] = ipywidgets.Layout(
            width="28px", height="28px", padding="0px 0px 0px 4px"
        )
    widget_args["icon"] = widget_icon

    if "value" not in close_button_args:
        close_button_args["value"] = False
    if "tooltip" not in close_button_args:
        close_button_args["tooltip"] = "Close the tool"
    if "button_style" not in close_button_args:
        close_button_args["button_style"] = "primary"
    if "layout" not in close_button_args:
        close_button_args["layout"] = ipywidgets.Layout(
            height="28px", width="28px", padding="0px 0px 0px 4px"
        )
    close_button_args["icon"] = close_button_icon