Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookWidgetFactory

A widget factory for notebook panels. The namespace for NotebookWidgetFactory statics.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private _editorConfig

_editorConfig: IEditorConfig

Private _notebookConfig

_notebookConfig: INotebookConfig

canStartKernel

canStartKernel: boolean

Whether the widgets can start a kernel when opened.

contentFactory

contentFactory: IContentFactory

The content factory used by the widget factory.

defaultFor

defaultFor: string[]

The file types for which the factory should be the default.

defaultRendered

defaultRendered: string[]

The file types for which the factory should be the default for rendering a document model, if different from editing.

fileTypes

fileTypes: string[]

The file types the widget can view.

isDisposed

isDisposed: boolean

Get whether the model factory has been disposed.

mimeTypeService

mimeTypeService: IEditorMimeTypeService

The service used to look up mime types.

modelName

modelName: string

The registered name of the model type used to create the widgets.

name

name: string

The name of the widget to display in dialogs.

preferKernel

preferKernel: boolean

Whether the widgets prefer having a kernel started.

readOnly

readOnly: boolean

Whether the widget factory is read only.

rendermime

rendermime: IRenderMimeRegistry

shutdownOnClose

shutdownOnClose: boolean

Whether the kernel should be shutdown when the widget is closed.

widgetCreated

widgetCreated: ISignal<IWidgetFactory<NotebookPanel, INotebookModel>, NotebookPanel>

A signal emitted when a widget is created.

Accessors

editorConfig

notebookConfig

Methods

createNew

  • Create a new widget given a document model and a context.

    Notes

    It should emit the [widgetCreated] signal with the new widget.

    Parameters

    Returns NotebookPanel

Protected createNewWidget

Protected defaultToolbarFactory

  • Default factory for toolbar items to be added after the widget is created.

    Parameters

    Returns IToolbarItem[]

dispose

  • dispose(): void
  • Dispose of the resources held by the document manager.

    Returns void

Generated using TypeDoc