figurebokeh

FigureBokeh(fig, light_theme='light_minimal', dark_theme='dark_minimal', dependencies=None)

Generates a Bokeh figure as a solara Jupyter widget.

Note

This is very experimental. You may notice render issues.

Warning

We never use this dependencies prop. We do callbacks ourselves for performance.

Parameters:

Name	Type	Description	Default
fig	Plot | figure	figure object	required
light_theme	str | Theme	theme to use in light mode	'light_minimal'
dark_theme	str | Theme	theme to use in dark mode	'dark_minimal'
dependencies	list[str] | None	dependencies to trigger data updates on.	None

Source code in src/sdss_explorer/dashboard/components/views/figurebokeh.py

@sl.component
def FigureBokeh(
    fig: Plot | figure,
    light_theme: str | Theme = "light_minimal",
    dark_theme: str | Theme = "dark_minimal",
    dependencies=None,
):
    """Generates a Bokeh figure as a solara Jupyter widget.

    Note:
        This is very experimental. You may notice render issues.

    Warning:
        We never use this `dependencies` prop. We do callbacks ourselves for performance.

    Args:
        fig: figure object
        light_theme: theme to use in light mode
        dark_theme: theme to use in dark mode
        dependencies (list[str] | None): dependencies to trigger data updates on.
    """
    loaded = sl.use_reactive(False)
    dark = sl.lab.use_dark_effective()
    BokehLoaded(loaded=loaded.value, on_loaded=loaded.set)
    fig_element = BokehModel.element(model=fig)

    def update_data():
        fig_widget: BokehModel = sl.get_widget(fig_element)
        fig_model: Plot = fig_widget._model  # base class for figure
        if fig != fig_model:  # don't do on first startup
            # pause until all updates complete
            with fig_model.hold(render=True):
                # extend renderer set and cull previous
                length = len(fig_model.renderers)
                fig_model.renderers.extend(fig.renderers)
                fig_model.renderers = fig_model.renderers[length:]

                # similarly update plot layout properties
                places = ["above", "below", "center", "left", "right"]
                for place in places:
                    attr = getattr(fig_model, place)
                    newattr = getattr(fig, place)
                    length = len(attr)
                    attr.extend(newattr)
                    setattr(fig_model, place, attr[length:])

    def update_theme():
        # NOTE: using bokeh.io.curdoc and this model._document prop will point to the same object
        fig_widget: BokehModel = sl.get_widget(fig_element)
        if dark:
            fig_widget._document.theme = dark_theme
        else:
            fig_widget._document.theme = light_theme

    sl.use_effect(update_data, dependencies or fig)
    sl.use_effect(update_theme, [dark, loaded.value])

    def set_init_theme():
        curdoc().theme = dark_theme if dark else light_theme

    sl.use_memo(set_init_theme, dependencies=[])

    if loaded.value:
        # t.sleep(0.5)  # FORCE LOCKOUT for theme rendering
        return fig_element