Class NotebookKernelService

Constructors

constructor

new NotebookKernelService(): NotebookKernelService
Returns NotebookKernelService

Properties

`Protected` `Readonly`kernelDetectionTasks

kernelDetectionTasks: Map<string, string[]> = ...

`Protected` `Readonly`kernels

kernels: Map<string, KernelInfo> = ...

`Protected` `Readonly`kernelSourceActionProviders

kernelSourceActionProviders: Map<string, KernelSourceActionProvider[]> = ...

`Protected`notebookBindings

notebookBindings: Record<string, string> = {}

`Protected`notebookService

notebookService: NotebookService

`Readonly`onDidAddKernel

onDidAddKernel: Event<NotebookKernel> = ...

`Protected` `Readonly`onDidAddKernelEmitter

onDidAddKernelEmitter: Emitter<NotebookKernel> = ...

`Readonly`onDidChangeKernelDetectionTasks

onDidChangeKernelDetectionTasks: Event<string> = ...

`Protected` `Readonly`onDidChangeKernelDetectionTasksEmitter

onDidChangeKernelDetectionTasksEmitter: Emitter<string> = ...

`Readonly`onDidChangeNotebookAffinity

onDidChangeNotebookAffinity: Event<void> = ...

`Protected` `Readonly`onDidChangeNotebookAffinityEmitter

onDidChangeNotebookAffinityEmitter: Emitter<void> = ...

`Readonly`onDidChangeSelectedKernel

onDidChangeSelectedKernel: Event<SelectedNotebookKernelChangeEvent> = ...

`Protected` `Readonly`onDidChangeSelectedNotebookKernelBindingEmitter

onDidChangeSelectedNotebookKernelBindingEmitter: Emitter<
SelectedNotebookKernelChangeEvent,
> = ...

`Readonly`onDidChangeSourceActions

onDidChangeSourceActions: Event<NotebookSourceActionChangeEvent> = ...

`Protected` `Readonly`onDidChangeSourceActionsEmitter

onDidChangeSourceActionsEmitter: Emitter<NotebookSourceActionChangeEvent> = ...

`Readonly`onDidRemoveKernel

onDidRemoveKernel: Event<NotebookKernel> = ...

`Protected` `Readonly`onDidRemoveKernelEmitter

onDidRemoveKernelEmitter: Emitter<NotebookKernel> = ...

`Protected`storageService

storageService: StorageService

Methods

getKernel

getKernel(id: string): undefined | NotebookKernel
Parameters
- id: string
Returns undefined | NotebookKernel
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:277

getKernelDetectionTasks

getKernelDetectionTasks(notebook: NotebookTextModelLike): string[]
Parameters
- notebook: NotebookTextModelLike
Returns string[]
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:324

getKernelSourceActionsFromProviders

getKernelSourceActionsFromProviders(
notebook: NotebookTextModelLike,
): Promise<NotebookKernelSourceAction[]>
Parameters
- notebook: NotebookTextModelLike
Returns Promise<NotebookKernelSourceAction[]>
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:350

getMatchingKernel

getMatchingKernel(notebook: NotebookTextModelLike): NotebookKernelMatchResult
Helps to find the best matching kernel for a notebook.
Parameters
- notebook: NotebookTextModelLike
  notebook to get the matching kernel for
Returns NotebookKernelMatchResult
and object containing: all kernels sorted to match the notebook best first (affinity ascending, score descending, label)) the selected kernel (if any) specific suggested kernels (if any) hidden kernels (if any)
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:224

getSelectedNotebookKernel

getSelectedNotebookKernel(
notebook: NotebookTextModelLike,
): undefined | NotebookKernel
Parameters
- notebook: NotebookTextModelLike
Returns undefined | NotebookKernel
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:249

getSelectedOrSuggestedKernel

getSelectedOrSuggestedKernel(
notebook: NotebookModel,
): undefined | NotebookKernel
Parameters
- notebook: NotebookModel
Returns undefined | NotebookKernel
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:268

init

init(): void
Returns void
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:185

registerKernel

registerKernel(kernel: NotebookKernel): Disposable
Parameters
- kernel: NotebookKernel
Returns Disposable
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:194

registerKernelSourceActionProvider

registerKernelSourceActionProvider(
viewType: string,
provider: KernelSourceActionProvider,
): Disposable
Parameters
- viewType: string
- provider: KernelSourceActionProvider
Returns Disposable
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:328

registerNotebookKernelDetectionTask

registerNotebookKernelDetectionTask(notebookType: string): Disposable
Parameters
- notebookType: string
Returns Disposable
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:308

selectKernelForNotebook

selectKernelForNotebook(
kernel: undefined | NotebookKernel,
notebook: NotebookTextModelLike,
): void
Parameters
- kernel: undefined | NotebookKernel
- notebook: NotebookTextModelLike
Returns void
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:254

`Protected`tryAutoBindNotebook

tryAutoBindNotebook(
notebook: NotebookModel,
onlyThisKernel?: NotebookKernel,
): void
Parameters
- notebook: NotebookModel
- OptionalonlyThisKernel: NotebookKernel
Returns void
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:291

`Protected` `Static`score

score(kernel: NotebookKernel, notebook: NotebookTextModelLike): number
Parameters
- kernel: NotebookKernel
- notebook: NotebookTextModelLike
Returns number
- Defined in packages/notebook/src/browser/service/notebook-kernel-service.ts:281