API#
TypeScript API
- @jupyterlite
- Packages
- Index
- @jupyterlite/application
- Class:
LiteRouter - Class:
SingleWidgetApp- Extends
- Constructors
- Properties
- Accessors
- Methods
activateDeferredPlugins()activatePlugin()addEventListeners()attachShell()contextMenuHitTest()deactivatePlugin()deregisterPlugin()evtContextMenu()evtKeydown()evtKeyup()evtResize()getPluginDescription()handleEvent()hasPlugin()isPluginActivated()listPlugins()registerPlugin()registerPlugins()resolveOptionalService()resolveRequiredService()start()
- Class:
SingleWidgetShell- Extends
- Extended by
- Implements
- Constructors
- Properties
- Accessors
- Methods
activate()activateById()add()addClass()children()clearFlag()close()contains()dispose()fit()hasClass()hide()notifyLayout()onActivateRequest()onAfterAttach()onAfterDetach()onAfterHide()onAfterShow()onBeforeAttach()onBeforeDetach()onBeforeHide()onBeforeShow()onChildAdded()onChildRemoved()onCloseRequest()onFitRequest()onResize()onUpdateRequest()processMessage()removeClass()setFlag()setHidden()show()testFlag()toggleClass()update()widgets()
- Interface:
ILiteRouter - Interface:
ISingleWidgetShell- Extends
- Properties
- Accessors
- Methods
activate()activateById()add()addClass()children()clearFlag()close()contains()dispose()fit()hasClass()hide()notifyLayout()onActivateRequest()onAfterAttach()onAfterDetach()onAfterHide()onAfterShow()onBeforeAttach()onBeforeDetach()onBeforeHide()onBeforeShow()onChildAdded()onChildRemoved()onCloseRequest()onFitRequest()onResize()onUpdateRequest()processMessage()removeClass()setFlag()setHidden()show()testFlag()toggleClass()update()widgets()
- Interface:
IURLTransformer - Shell
- Type Alias:
Area - SingleWidgetApp
- Interface:
IInfo - Interface:
IOptions - Interface:
IPluginModule - Variable:
ILiteRouter - Variable:
ISingleWidgetShell - @jupyterlite/application-extension
- Variable:
default - @jupyterlite/apputils
- Class:
IndexedDBDataConnector\<T\> - Class:
LiteLicensesClient - Class:
LitePluginListModel - Class:
LiteTranslatorConnector - Class:
LiteWorkspaceManager - Class:
ServiceWorkerManager - Interface:
IServiceWorkerManager - Interface:
IWorkspaceRouter - IServiceWorkerManager
- Interface:
IOptions - Interface:
IStdinHandler() - IWorkspaces
- Interface:
IWorkspacesBundle - IndexedDBDataConnector
- Interface:
IOptions - LiteWorkspaceManager
- Interface:
IOptions - Variable:
IServiceWorkerManager - Variable:
IWorkspaceRouter - Variable:
SERVICE_WORKER_BROADCAST_CHANNEL_ID - Variable:
THIRD_PARTY_LICENSES - Variable:
WORKER_NAME - @jupyterlite/apputils-extension
- Variable:
default - Variable:
pluginManagerPlugin - @jupyterlite/contents
- Class:
BrowserStorageDrive- Implements
- Constructors
- Properties
- Accessors
- Methods
clearStorage()copy()createCheckpoint()createDefaultCheckpoints()createDefaultCounters()createDefaultStorage()delete()deleteCheckpoint()dispose()forgetPath()get()getDownloadUrl()initialize()initStorage()listCheckpoints()newUntitled()normalizeCheckpoint()rename()restoreCheckpoint()save()
- Class:
DriveContentsProcessor - Class:
DriveFS - Class:
DriveFSEmscriptenNodeOps - Class:
DriveFSEmscriptenStreamOps - Class:
ServiceWorkerContentsAPI - Function:
instanceOfStream() - Interface:
IDriveContentsProcessor - Interface:
IDriveStream - Interface:
IEmscriptenFSNode - Interface:
IEmscriptenNodeOps - Interface:
IEmscriptenStream - Interface:
IEmscriptenStreamOps - Interface:
IStats - ~~BrowserStorageDrive~~
- Interface:
~~IOptions~~ - ~~DriveContentsProcessor~~
- Interface:
~~IOptions~~ - ~~DriveFS~~
- Interface:
~~IFile~~ - Interface:
~~ILookup~~ - Interface:
~~IOptions~~ - FILE
- Function:
getType() - Function:
hasFormat() - MIME
- Variable:
JSON - Variable:
OCTET_STREAM - Variable:
PLAIN_TEXT - ~~ServiceWorkerContentsAPI~~
- Interface:
~~IOptions~~ - Type Alias:
ERRNO_CODES - Type Alias:
FS - Type Alias:
PATH - Type Alias:
TDriveData - Type Alias:
TDriveMethod - Type Alias:
TDriveRequest\<T\> - Type Alias:
TDriveResponse\<T\> - Variable:
BLOCK_SIZE - Variable:
DIR_MODE - Variable:
DRIVE_NAME - Variable:
DRIVE_SEPARATOR - Variable:
FILE_MODE - Variable:
SEEK_CUR - Variable:
SEEK_END - @jupyterlite/iframe-extension
- Class:
RenderedIFrame- Extends
- Implements
- Constructors
- Properties
- Accessors
- Methods
activate()addClass()children()clearFlag()close()contains()dispose()fit()hasClass()hide()notifyLayout()onActivateRequest()onAfterAttach()onAfterDetach()onAfterHide()onAfterShow()onBeforeAttach()onBeforeDetach()onBeforeHide()onBeforeShow()onChildAdded()onChildRemoved()onCloseRequest()onFitRequest()onResize()onUpdateRequest()processMessage()removeClass()renderModel()setFlag()setHidden()show()testFlag()toggleClass()update()
- Variable:
default - Variable:
rendererFactory - @jupyterlite/kernel
- Class: ``abstract
BaseKernel- Implements
- Constructors
- Accessors
- Methods
clearOutput()commClose()commInfoRequest()commMsg()commOpen()completeRequest()displayData()dispose()executeRequest()handleComm()handleMessage()inputReply()inputRequest()inspectRequest()isCompleteRequest()kernelInfoRequest()publishExecuteError()publishExecuteResult()stream()updateDisplayData()
- Class:
KernelSpecs - Class:
LiteKernelClient - Class:
LiteKernelSpecClient - Interface:
IKernel - Interface:
IKernelClient - Interface:
IKernelSpecClient - Interface:
IKernelSpecs - Interface:
IRemoteKernel - Interface:
IWorkerKernel - IKernel
- Interface:
IOptions - Type Alias:
SendMessage() - IWorkerKernel
- Interface:
IOptions - ~~KernelSpecs~~
- Interface:
~~IKernelOptions~~ - Type Alias:
~~KernelFactories~~ - Type Alias:
~~KernelFactory()~~ - ~~LiteKernelClient~~
- Interface:
~~IKernelOptions~~ - Interface:
~~IOptions~~ - Variable:
~~WS_BASE_URL~~ - ~~LiteKernelSpecClient~~
- Interface:
~~IOptions~~ - Variable:
FALLBACK_KERNEL - Variable:
IKernelClient - Variable:
IKernelSpecClient - Variable:
IKernelSpecs - @jupyterlite/localforage
- Function:
ensureMemoryStorage() - Interface:
ILocalForage - Variable:
ILocalForage - @jupyterlite/notebook-application-extension
- Variable:
default - @jupyterlite/repl-extension
- Variable:
default - @jupyterlite/server
- Class:
ServiceWorkerManager - Interface:
IServiceWorkerManager - ~~IServiceWorkerManager~~
- Interface:
~~IOptions~~ - Interface:
~~IStdinHandler()~~ - Variable:
IServiceWorkerManager - Variable:
SERVICE_WORKER_BROADCAST_CHANNEL_ID - Variable:
WORKER_NAME - @jupyterlite/services
- Class: ``abstract
BaseExporter - Class: ``abstract
BaseKernel- Implements
- Constructors
- Accessors
- Methods
clearOutput()commClose()commInfoRequest()commMsg()commOpen()completeRequest()displayData()dispose()executeRequest()handleComm()handleMessage()inputReply()inputRequest()inspectRequest()isCompleteRequest()kernelInfoRequest()publishExecuteError()publishExecuteResult()stream()updateDisplayData()
- Class:
BrowserStorageDrive- Implements
- Constructors
- Properties
- Accessors
- Methods
clearStorage()copy()createCheckpoint()createDefaultCheckpoints()createDefaultCounters()createDefaultStorage()delete()deleteCheckpoint()dispose()forgetPath()get()getDownloadUrl()initialize()initStorage()listCheckpoints()newUntitled()normalizeCheckpoint()reduceBytesToString()rename()restoreCheckpoint()save()
- Class: ``abstract
ContentsAPI - Class:
DriveContentsProcessor - Class:
DriveFS - Class:
DriveFSEmscriptenNodeOps - Class:
DriveFSEmscriptenStreamOps - Class:
Exporters - Class:
KernelSpecs - Class:
LiteKernelClient - Class:
LiteKernelSpecClient - Class:
LiteNbConvertManager - Class:
LiteSessionClient - Class:
NotebookExporter - Class:
ScriptExporter - Class:
ServiceWorkerContentsAPI - Class:
Settings - Function:
instanceOfStream() - Function:
isDirMode() - Function:
isFileMode() - Interface:
IDriveContentsProcessor - Interface:
IDriveStream - Interface:
IEmscriptenFSNode - Interface:
IEmscriptenNodeOps - Interface:
IEmscriptenStream - Interface:
IEmscriptenStreamOps - Interface:
IExporter - Interface:
IKernel - Interface:
IKernelClient - Interface:
IKernelSpecClient - Interface:
IKernelSpecs - Interface:
ILiteNbConvertManagerOptions - Interface:
INbConvertExporters - Interface:
IRemoteKernel - Interface:
IStats - Interface:
IWorkerKernel - BrowserStorageDrive
- Interface:
IOptions - ContentsAPI
- Interface:
IOptions - DriveContentsProcessor
- Interface:
IOptions - DriveFS
- Interface:
IFile - Interface:
ILookup - Interface:
IOptions - FILE
- Function:
getType() - Function:
hasFormat() - IKernel
- Interface:
IOptions - Type Alias:
SendMessage() - IWorkerKernel
- Interface:
IOptions - KernelSpecs
- Interface:
IKernelOptions - Type Alias:
KernelFactories - Type Alias:
KernelFactory() - LiteKernelClient
- Interface:
IKernelOptions - Interface:
IOptions - Variable:
WS_BASE_URL - LiteKernelSpecClient
- Interface:
IOptions - LiteSessionClient
- Interface:
IOptions - MIME
- Variable:
JSON - Variable:
OCTET_STREAM - Variable:
PLAIN_TEXT - ServiceWorkerContentsAPI
- Interface:
IOptions - Settings
- Interface:
IOptions - Type Alias:
ERRNO_CODES - Type Alias:
FS - Type Alias:
PATH - Type Alias:
SettingsFile - Type Alias:
TDriveData - Type Alias:
TDriveMethod - Type Alias:
TDriveRequest\<T\> - Type Alias:
TDriveResponse\<T\> - Variable:
BLOCK_SIZE - Variable:
DIR_MODE - Variable:
DRIVE_NAME - Variable:
DRIVE_SEPARATOR - Variable:
FALLBACK_KERNEL - Variable:
FILE_MODE - Variable:
IKernelClient - Variable:
IKernelSpecClient - Variable:
IKernelSpecs - Variable:
INbConvertExporters - Variable:
SEEK_CUR - Variable:
SEEK_END - @jupyterlite/services-extension
- Variable:
default - @jupyterlite/session
- Class:
LiteSessionClient - ~~LiteSessionClient~~
- Interface:
~~IOptions~~ - @jupyterlite/settings
- Class:
Settings - ~~Settings~~
- Interface:
~~IOptions~~ - Type Alias:
SettingsFile - @jupyterlite/types
- Interface:
IFederatedExtension - @jupyterlite/ui-components
- Variable:
liteIcon - Variable:
liteWordmark
- Index
- Packages