IGetUrlOptions | @jupyterlab

Options for getUrl

Hierarchy

IGetUrlOptions

Index

Properties

mode
treePath
workspace

Properties

Optional mode

mode: string

The optional mode as a string 'single-document' or 'multiple-document'. If the mode argument is missing, it will be provided from the PageConfig.

Optional treePath

treePath: string

The optional tree path as as string. If treePath is not provided it will be provided from the PageConfig. If an empty string, the resulting path will not contain a tree portion.

Optional workspace

workspace: string

The optional workspace as a string. If this argument is missing, the value will be pulled from PageConfig. To use the default workspace (no /workspaces/ URL segment will be included) pass the string PageConfig.defaultWorkspace.