show#

jdaviz.show(loc='inline', title=None, height=None, tray=None)#

Display the Jdaviz application.

Parameters:
locstr

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

“inline”: Display the Jdaviz application inline in a notebook. Note this is functionally equivalent to displaying the cell viz._app in the notebook.

“sidecar”: Display the Jdaviz application 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 Jdaviz application 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 application; e.g., “specviz”.

NOTE: Only applicable to a “sidecar” display.

height: int, optional

The height of the top-level application widget, in pixels. Applies to all instances of the same application in the notebook.

tray: str, optional

Override the default open sidebar in the tray. If not provided, will default to loaders if no data is loaded, or plugins if data is loaded.

Notes

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