Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookWidgetFactory

A widget factory for notebook panels.

Hierarchy

Index

Constructors

constructor

Properties

Private _editorConfig

_editorConfig: any

Private _notebookConfig

_notebookConfig: any

Private _sessionDialogs

_sessionDialogs: any

Readonly contentFactory

contentFactory: IContentFactory

The content factory used by the widget factory.

Readonly mimeTypeService

mimeTypeService: IEditorMimeTypeService

The service used to look up mime types.

Readonly rendermime

Accessors

canStartKernel

  • get canStartKernel(): boolean
  • Whether the widgets can start a kernel when opened.

    Returns boolean

defaultFor

  • get defaultFor(): string[]
  • The file types for which the factory should be the default.

    Returns string[]

defaultRendered

  • get defaultRendered(): string[]
  • The file types for which the factory should be the default for rendering a document model, if different from editing.

    Returns string[]

editorConfig

  • A configuration object for cell editor settings.

    Returns IEditorConfig

  • A configuration object for cell editor settings.

    Parameters

    Returns void

fileTypes

  • get fileTypes(): string[]
  • The file types the widget can view.

    Returns string[]

isDisposed

  • get isDisposed(): boolean
  • Get whether the model factory has been disposed.

    Returns boolean

modelName

  • get modelName(): string
  • The registered name of the model type used to create the widgets.

    Returns string

name

  • get name(): string
  • The name of the widget to display in dialogs.

    Returns string

notebookConfig

  • A configuration object for notebook settings.

    Returns INotebookConfig

  • A configuration object for notebook settings.

    Parameters

    Returns void

preferKernel

  • get preferKernel(): boolean
  • Whether the widgets prefer having a kernel started.

    Returns boolean

readOnly

  • get readOnly(): boolean
  • Whether the widget factory is read only.

    Returns boolean

shutdownOnClose

  • get shutdownOnClose(): boolean
  • set shutdownOnClose(value: boolean): void
  • Whether the kernel should be shutdown when the widget is closed.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

translator

  • The application language translator.

    Returns ITranslator

widgetCreated

  • A signal emitted when a widget is created.

    Returns ISignal<IWidgetFactory<T, U>, T>

Methods

createNew

Protected createNewWidget

Protected defaultToolbarFactory

dispose

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

    Returns void

Generated using TypeDoc