Class NotebookAdapter

Constructors

constructor

new NotebookAdapter(props): NotebookAdapter
Parameters
- props: INotebookProps
Returns NotebookAdapter
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:67

Properties

`Private` `Optional` _CellSidebar

_CellSidebar?: ((props) => Element)

Type declaration

- (props): Element
- Parameters
  - props: ICellSidebarProps
  Returns Element

`Private` _boxPanel

_boxPanel: BoxPanel

`Private` _commandRegistry

_commandRegistry: CommandRegistry

`Private` _contentFactory

_contentFactory: JupyterReactContentFactory

`Private` `Optional` _context

_context?: Context<INotebookModel>

`Private` `Optional` _documentRegistry

_documentRegistry?: DocumentRegistry

`Private` `Optional` _iPyWidgetsManager

_iPyWidgetsManager?: WidgetManager

`Private` _id

_id: string

`Private` `Optional` _kernel

_kernel?: Kernel

`Private` `Optional` _kernelClients

_kernelClients?: IKernelConnection[]

`Private` _kernelConnection

_kernelConnection: undefined | null | IKernelConnection

`Private` `Optional` _kernelTransfer

_kernelTransfer?: KernelTransfer

`Private` `Optional` _lite

_lite?: Lite

`Private` _mimeTypeService

_mimeTypeService: CodeMirrorMimeTypeService

`Private` `Optional` _nbformat

_nbformat?: INotebookContent

`Private` _nbgrader

_nbgrader: boolean

`Private` `Optional` _notebookModelFactory

_notebookModelFactory?: JupyterReactNotebookModelFactory

`Private` `Optional` _notebookPanel

_notebookPanel?: NotebookPanel

`Private` `Optional` _onSessionConnection

_onSessionConnection?: OnSessionConnection

`Private` `Optional` _path

_path?: string

`Private` _readonly

_readonly: boolean

`Private` _renderers

_renderers: IRendererFactory[]

`Private` `Optional` _rendermime

_rendermime?: RenderMimeRegistry

`Private` _serverless

_serverless: boolean

`Private` _serviceManager

_serviceManager: IManager

`Private` `Optional` _tracker

_tracker?: NotebookTracker

`Private` `Optional` _url

_url?: string

Accessors

commands

get commands(): CommandRegistry
Returns CommandRegistry
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:558

context

get context(): undefined | Context<INotebookModel>
Returns undefined | Context<INotebookModel>
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:546

id

get id(): string
Returns string
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:506

kernel

get kernel(): undefined | Kernel
Returns undefined | Kernel
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:534

kernelConnection

get kernelConnection(): undefined | null | IKernelConnection
Returns undefined | null | IKernelConnection
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:538

lite

get lite(): undefined | Lite
Returns undefined | Lite
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:518

nbformat

get nbformat(): undefined | INotebookContent
Returns undefined | INotebookContent
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:530

notebookPanel

get notebookPanel(): undefined | NotebookPanel
Returns undefined | NotebookPanel
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:542
set notebookPanel(notebookPanel): void
Parameters
- notebookPanel: undefined | NotebookPanel
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:550

Methods

assignKernel

assignKernel(kernel): void
Parameters
- kernel: Kernel
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:624

changeCellType

changeCellType(cellType): void
Parameters
- cellType: string
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:635

dispose

dispose(): void
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:707

initializeContext

initializeContext(): void
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:166

insertAbove

insertAbove(source?): void
Parameters
- Optional source: string
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:667

insertBelow

insertBelow(source?): void
Parameters
- Optional source: string
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:687

loadFromUrl

loadFromUrl(url): Promise<any>
Parameters
- url: string
Returns Promise<any>
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:106

notebookKeydownListener

notebookKeydownListener(event): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:114

setDefaultCellType

setDefaultCellType(cellType): void
Parameters
- cellType: string
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:631

setKernel

setKernel(kernel?): void
Parameters
- Optional kernel: Kernel
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:586

setNbformat

setNbformat(nbformat?): void
Parameters
- Optional nbformat: INotebookContent
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:569

setPath

setPath(path): void
Parameters
- path: string
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:617

setReadonly

setReadonly(readonly): void
Parameters
- readonly: boolean
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:594

setServerless

setServerless(serverless): void
Parameters
- serverless: boolean
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:610

setServiceManager

setServiceManager(serviceManager, lite?): void
Parameters
- serviceManager: IManager
- Optional lite: Lite
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:579

`Private` setupAdapter

setupAdapter(): void
Returns void
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:379

setupCompleter

setupCompleter(notebookPanel): CompletionHandler
Parameters
- notebookPanel: NotebookPanel
Returns CompletionHandler
- Defined in tech/jupyter/ui/packages/react/src/components/notebook/NotebookAdapter.ts:118

Class NotebookAdapter

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebookAdapter

Properties

Private Optional _CellSidebar

Type declaration

Parameters

Returns Element

Private _boxPanel

Private _commandRegistry

Private _contentFactory

Private Optional _context

Private Optional _documentRegistry

Private Optional _iPyWidgetsManager

Private _id

Private Optional _kernel

Private Optional _kernelClients

Private _kernelConnection

Private Optional _kernelTransfer

Private Optional _lite

Private _mimeTypeService

Private Optional _nbformat

Private _nbgrader

Private Optional _notebookModelFactory

Private Optional _notebookPanel

Private Optional _onSessionConnection

Private Optional _path

Private _readonly

Private _renderers

Private Optional _rendermime

Private _serverless

Private _serviceManager

Private Optional _tracker

Private Optional _url

Accessors

commands

Returns CommandRegistry

context

Returns undefined | Context<INotebookModel>

id

Returns string

kernel

Returns undefined | Kernel

kernelConnection

Returns undefined | null | IKernelConnection

lite

Returns undefined | Lite

nbformat

Returns undefined | INotebookContent

notebookPanel

Returns undefined | NotebookPanel

Parameters

Returns void

panel

Returns BoxPanel

path

Returns undefined | string

readonly

Returns boolean

serverless

Returns boolean

serviceManager

Returns IManager

url

Returns undefined | string

Methods

assignKernel

Parameters

Returns void

changeCellType

Parameters

Returns void

dispose

`Private` `Optional` _CellSidebar

`Private` _boxPanel

`Private` _commandRegistry

`Private` _contentFactory

`Private` `Optional` _context

`Private` `Optional` _documentRegistry

`Private` `Optional` _iPyWidgetsManager

`Private` _id

`Private` `Optional` _kernel

`Private` `Optional` _kernelClients

`Private` _kernelConnection

`Private` `Optional` _kernelTransfer

`Private` `Optional` _lite

`Private` _mimeTypeService

`Private` `Optional` _nbformat

`Private` _nbgrader

`Private` `Optional` _notebookModelFactory

`Private` `Optional` _notebookPanel

`Private` `Optional` _onSessionConnection

`Private` `Optional` _path

`Private` _readonly

`Private` _renderers

`Private` `Optional` _rendermime

`Private` _serverless

`Private` _serviceManager

`Private` `Optional` _tracker

`Private` `Optional` _url

`Private` setupAdapter