Get the base url for a Jupyter application, or the base url of the page.
Returns the URL converting this notebook to a certain format with nbconvert.
Get the Notebook version info [major, minor, patch].
Get global configuration data for the Jupyter application.
The name of the configuration option.
The config value or an empty string if not found.
All values are treated as strings.
For browser based applications, it is assumed that the page HTML
includes a script tag with the id jupyter-config-data
containing the
configuration as valid JSON. In order to support the classic Notebook,
we fall back on checking for body
data of the given name
.
For node applications, it is assumed that the process was launched
with a --jupyter-config-data
option pointing to a JSON settings
file.
Get the base url for sharing links (usually baseUrl)
Get the authorization token for a Jupyter application.
Get the tree url for shareable links. Usually the same as treeUrl, but overrideable e.g. when sharing with JupyterHub.
Get the tree url for a JupyterLab application.
Create a new URL given an optional mode and tree path.
This is used to create URLS when the mode or tree path change as the user changes mode or the current document in the main area. If fields in options are omitted, the value in PageConfig will be used.
IGetUrlOptions for the new path.
Get the base websocket url for a Jupyter application, or an empty string.
Set global configuration data for the Jupyter application.
The name of the configuration option.
The value to set the option to.
The last config value or an empty string if it doesn't exist.
Generated using TypeDoc
The namespace for
PageConfig
functions.