PluginSubcomponent#

class jdaviz.core.template_mixin.PluginSubcomponent(**kwargs: Any)[source]#

Bases: VuetifyTemplate

Public constructor

Attributes Summary

`display_name`
`popout_button`	A trait which allows any value.

Methods Summary

`show`([loc, title])	Display the component UI.
`vue_popout`([data])

Attributes Documentation

display_name#

popout_button#: A trait which allows any value.

Methods Documentation

show(loc='inline', title=None)[source]#

Display the component UI.

Parameters:

locstr

The display location determines where to present the viz app. Supported locations:

“inline”: Display the component inline in a notebook.

“app”: Display below the viewers in the main app.

“sidecar”: Display the component in a separate JupyterLab window from the notebook, the location of which is decided by the ‘anchor.’ right is the default

Other anchors:

sidecar:right (The default, opens a tab to the right of display)

sidecar:tab-before (Full-width tab before the current notebook)

sidecar:tab-after (Full-width tab after the current notebook)

sidecar:split-right (Split-tab in the same window right of the notebook)

sidecar:split-left (Split-tab in the same window left of the notebook)

sidecar:split-top (Split-tab in the same window above the notebook)

sidecar:split-bottom (Split-tab in the same window below the notebook)

See jupyterlab-sidecar for the most up-to-date options.

“popout”: Display the component in a detached display. By default, a new window will open. Browser popup permissions required.

Other anchors:

popout:window (The default, opens Jdaviz in a new, detached popout)

popout:tab (Opens Jdaviz in a new, detached tab in your browser)

titlestr, optional

The title of the sidecar tab. Defaults to the name of the component.

NOTE: Only applicable to a “sidecar” display.

Notes

If “sidecar” is requested in the “classic” Jupyter notebook, the component will appear inline, as only JupyterLab has a mechanism to have multiple tabs.

vue_popout(data=None)[source]#