Class NotebookModel

Implements

Saveable
Disposable

Index

Constructors

constructor

Accessors

dirty onDidChangeReadOnly readOnly selectedText uri viewType

Constructors

constructor

new NotebookModel(): NotebookModel
Returns NotebookModel

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` _selectedText

_selectedText: string = ''

`Protected` cellModelFactory

cellModelFactory: NotebookCellModelFactory

cells

cells: NotebookCellModel[]

`Protected` dirtyCells

dirtyCells: NotebookCellModel[] = []

`Protected` `Readonly` fileService

fileService: FileService

metadata

metadata: NotebookDocumentMetadata = {}

`Protected` modelResolverService

modelResolverService: NotebookModelResolverService

`Protected` nextHandle

nextHandle: number = 0

`Readonly` onContentChanged

onContentChanged: Event<void> = ...

`Protected` `Readonly` onContentChangedEmitter

onContentChangedEmitter: Emitter<void> = ...

`Readonly` onDidAddOrRemoveCell

onDidAddOrRemoveCell: Event<NotebookModelWillAddRemoveEvent> = ...

`Protected` `Readonly` onDidAddOrRemoveCellEmitter

onDidAddOrRemoveCellEmitter: Emitter<NotebookModelWillAddRemoveEvent> = ...

`Readonly` onDidChangeContent

onDidChangeContent: Event<NotebookContentChangedEvent[]> = ...

`Protected` `Readonly` onDidChangeContentEmitter

onDidChangeContentEmitter: QueueableEmitter<NotebookContentChangedEvent> = ...

`Readonly` onDidChangeSelectedCell

onDidChangeSelectedCell: Event<SelectedCellChangeEvent> = ...

`Protected` `Readonly` onDidChangeSelectedCellEmitter

onDidChangeSelectedCellEmitter: Emitter<SelectedCellChangeEvent> = ...

`Readonly` onDidDispose

onDidDispose: Event<void> = ...

`Protected` `Readonly` onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

`Readonly` onDidSaveNotebook

onDidSaveNotebook: Event<void> = ...

`Protected` `Readonly` onDidSaveNotebookEmitter

onDidSaveNotebookEmitter: Emitter<void> = ...

`Readonly` onDirtyChanged

onDirtyChanged: Event<void> = ...

`Protected` `Readonly` onDirtyChangedEmitter

onDirtyChangedEmitter: Emitter<void> = ...

`Protected` props

props: NotebookModelProps

`Optional` selectedCell

selectedCell?: NotebookCellModel

`Protected` `Readonly` undoRedoService

undoRedoService: UndoRedoService

Accessors

dirty

get dirty(): boolean
Returns boolean
Implementation of Saveable.dirty
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:121
set dirty(dirty): void
Parameters
- dirty: boolean
Returns void
Implementation of Saveable.dirty
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:113

onDidChangeReadOnly

get onDidChangeReadOnly(): Event<boolean | MarkdownString>
Returns Event<boolean | MarkdownString>
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:90

readOnly

get readOnly(): boolean | MarkdownString
Returns boolean | MarkdownString
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:125

selectedText

get selectedText(): string
Returns string
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:135
set selectedText(value): void
Parameters
- value: string
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:131

uri

get uri(): URI
Returns URI
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:144

viewType

get viewType(): string
Returns string
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:148

Methods

`Private` addCellOutputListeners

addCellOutputListeners(cells): void
Parameters
- cells: NotebookCellModel[]
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:281

applyEdits

applyEdits(rawEdits, computeUndoRedo): void
Parameters
- rawEdits: CellEditOperation[]
- computeUndoRedo: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:296

applySnapshot

applySnapshot(snapshot): Promise<void>
Parameters
- snapshot: Snapshot
Returns Promise<void>
Implementation of Saveable.applySnapshot
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:207

cellDirtyChanged

cellDirtyChanged(cell, dirtyState): void
Parameters
- cell: NotebookCellModel
- dirtyState: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:233

`Protected` changeCellInternalMetadataPartial

changeCellInternalMetadataPartial(cell, internalMetadata): void
Parameters
- cell: NotebookCellModel
- internalMetadata: NullablePartialNotebookCellInternalMetadata
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:426

`Protected` changeCellLanguage

changeCellLanguage(cell, languageId, computeUndoRedo): void
Parameters
- cell: NotebookCellModel
- languageId: string
- computeUndoRedo: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:485

`Protected` changeCellMetadata

changeCellMetadata(cell, metadata, computeUndoRedo): void
Parameters
- cell: NotebookCellModel
- metadata: NotebookCellMetadata
- computeUndoRedo: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:467

`Protected` changeCellMetadataPartial

changeCellMetadataPartial(cell, metadata, computeUndoRedo): void
Parameters
- cell: NotebookCellModel
- metadata: NullablePartialNotebookCellMetadata
- computeUndoRedo: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:453

createSnapshot

createSnapshot(): Snapshot
Returns Snapshot
Implementation of Saveable.createSnapshot
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:197

dispose

dispose(): void
Returns void
Implementation of Disposable.dispose
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:177

getCellIndexByHandle

getCellIndexByHandle(handle): number
Parameters
- handle: number
Returns number
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:516

getData

getData(): NotebookData
Returns NotebookData
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:255

getVisibleCells

getVisibleCells(): NotebookCellModel[]
Returns NotebookCellModel[]
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:292

initialize

initialize(): void
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:155

`Protected` isCellMetadataChanged

isCellMetadataChanged(a, b): boolean
Parameters
- a: NotebookCellMetadata
- b: NotebookCellMetadata
Returns boolean
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:524

isDirty

isDirty(): boolean
Returns boolean
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:229

`Protected` moveCellToIndex

moveCellToIndex(fromIndex, length, toIndex, computeUndoRedo): boolean
Parameters
- fromIndex: number
- length: number
- toIndex: number
- computeUndoRedo: boolean
Returns boolean
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:495

redo

redo(): void
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:268

replaceAll

replaceAll(matches, text): void
Parameters
- matches: NotebookEditorFindMatch[]
- text: string
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:543

`Protected` replaceCells

replaceCells(start, deleteCount, newCells, computeUndoRedo, requestEdit): void
Parameters
- start: number
- deleteCount: number
- newCells: CellData[]
- computeUndoRedo: boolean
- requestEdit: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:380

revert

revert(options?): Promise<void>
Parameters
- Optional options: RevertOptions
Returns Promise<void>
Implementation of Saveable.revert
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:216

save

save(options?): Promise<void>
Parameters
- Optional options: SaveOptions
Returns Promise<void>
Implementation of Saveable.save
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:187

serialize

serialize(): Promise<BinaryBuffer>
Returns Promise<BinaryBuffer>
Implementation of Saveable.serialize
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:203

setData

setData(data, markDirty?): void
Parameters
- data: NotebookData
- markDirty: boolean = true
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:246

setSelectedCell

setSelectedCell(cell, scrollIntoView?): void
Parameters
- cell: NotebookCellModel
- Optional scrollIntoView: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:274

undo

undo(): void
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:262

`Protected` updateNotebookMetadata

updateNotebookMetadata(metadata, computeUndoRedo): void
Parameters
- metadata: NotebookDocumentMetadata
- computeUndoRedo: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:440

Class NotebookModel

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NotebookModel

Properties

Protected _dirty

Protected _selectedText

Protected cellModelFactory

cells

Protected dirtyCells

Protected Readonly fileService

metadata

Protected modelResolverService

Protected nextHandle

Readonly onContentChanged

Protected Readonly onContentChangedEmitter

Readonly onDidAddOrRemoveCell

Protected Readonly onDidAddOrRemoveCellEmitter

Readonly onDidChangeContent

Protected Readonly onDidChangeContentEmitter

Readonly onDidChangeSelectedCell

Protected Readonly onDidChangeSelectedCellEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onDidSaveNotebook

Protected Readonly onDidSaveNotebookEmitter

Readonly onDirtyChanged

Protected Readonly onDirtyChangedEmitter

Protected props

Optional selectedCell

Protected Readonly undoRedoService

Accessors

dirty

Returns boolean

Parameters

Returns void

onDidChangeReadOnly

Returns Event<boolean | MarkdownString>

readOnly

Returns boolean | MarkdownString

selectedText

Returns string

Parameters

Returns void

uri

Returns URI

viewType

Returns string

Methods

Private addCellOutputListeners

Parameters

Returns void

applyEdits

Parameters

Returns void

applySnapshot

Parameters

Returns Promise<void>

cellDirtyChanged

Parameters

Returns void

Protected changeCellInternalMetadataPartial

Parameters

Returns void

Protected changeCellLanguage

Parameters

Returns void

Protected changeCellMetadata

Parameters

Returns void

Protected changeCellMetadataPartial

Parameters

Returns void

createSnapshot

`Protected` _dirty

`Protected` _selectedText

`Protected` cellModelFactory

`Protected` dirtyCells

`Protected` `Readonly` fileService

`Protected` modelResolverService

`Protected` nextHandle

`Readonly` onContentChanged

`Protected` `Readonly` onContentChangedEmitter

`Readonly` onDidAddOrRemoveCell

`Protected` `Readonly` onDidAddOrRemoveCellEmitter

`Readonly` onDidChangeContent

`Protected` `Readonly` onDidChangeContentEmitter

`Readonly` onDidChangeSelectedCell

`Protected` `Readonly` onDidChangeSelectedCellEmitter

`Readonly` onDidDispose

`Protected` `Readonly` onDidDisposeEmitter

`Readonly` onDidSaveNotebook

`Protected` `Readonly` onDidSaveNotebookEmitter

`Readonly` onDirtyChanged

`Protected` `Readonly` onDirtyChangedEmitter

`Protected` props

`Optional` selectedCell

`Protected` `Readonly` undoRedoService

`Private` addCellOutputListeners

`Protected` changeCellInternalMetadataPartial

`Protected` changeCellLanguage

`Protected` changeCellMetadata

`Protected` changeCellMetadataPartial

`Protected` fireContentChange

`Protected` isCellMetadataChanged

`Protected` moveCellToIndex

`Protected` replaceCells

`Protected` updateNotebookMetadata