Class NotebookModel

Implements

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> = ...

This event is fired when the content of the saveable changes. While onDirtyChanged is fired to notify the UI that the widget is dirty, onContentChanged is used for the auto save throttling.

`Protected` `Readonly`onContentChangedEmitter

onContentChangedEmitter: Emitter<void> = ...

`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> = ...

This event is fired when the content of the dirty variable changes.

`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: boolean): 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: string): 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

applyEdits

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

applySnapshot

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

cellDirtyChanged

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

`Protected`changeCellInternalMetadataPartial

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

`Protected`changeCellLanguage

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

`Protected`changeCellMetadata

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

`Protected`changeCellMetadataPartial

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

createSnapshot

createSnapshot(): Saveable.Snapshot
Creates a snapshot of the dirty state. See also Saveable.Snapshot.

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

dispose

dispose(): void
Dispose this object.

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

findMatches

findMatches(options: NotebookEditorFindMatchOptions): NotebookEditorFindMatch[]
Parameters
- options: NotebookEditorFindMatchOptions
Returns NotebookEditorFindMatch[]
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:540

`Protected`fireContentChange

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

getCellByHandle

getCellByHandle(handle: number): undefined | NotebookCellModel
Parameters
- handle: number
Returns undefined | NotebookCellModel
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:525

getCellIndexByHandle

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

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: NotebookCellMetadata, b: NotebookCellMetadata): boolean
Parameters
- a: NotebookCellMetadata
- b: NotebookCellMetadata
Returns boolean
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:529

isDirty

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

`Protected`moveCellToIndex

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

redo

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

replaceAll

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

`Protected`replaceCells

replaceCells(
    start: number,
    deleteCount: number,
    newCells: CellData[],
    computeUndoRedo: boolean,
    requestEdit: boolean,
): 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?: RevertOptions): Promise<void>
Reverts dirty changes.
Parameters
- Optionaloptions: RevertOptions
Returns Promise<void>
Implementation of Saveable.revert
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:216

save

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

serialize

serialize(): Promise<BinaryBuffer>
Serializes the full state of the saveable item to a binary buffer.

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

setData

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

setSelectedCell

setSelectedCell(cell: NotebookCellModel, scrollIntoView?: boolean): void
Parameters
- cell: NotebookCellModel
- OptionalscrollIntoView: 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: NotebookDocumentMetadata,
computeUndoRedo: boolean,
): void
Parameters
- metadata: NotebookDocumentMetadata
- computeUndoRedo: boolean
Returns void
- Defined in packages/notebook/src/browser/view-model/notebook-model.ts:445

Class NotebookModel

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NotebookModel

Properties

Protected_dirty

Protected_selectedText

ProtectedcellModelFactory

cells

ProtecteddirtyCells

Protected ReadonlyfileService

metadata

ProtectedmodelResolverService

ProtectednextHandle

ReadonlyonContentChanged

Protected ReadonlyonContentChangedEmitter

ReadonlyonDidAddOrRemoveCell

Protected ReadonlyonDidAddOrRemoveCellEmitter

ReadonlyonDidChangeContent

Protected ReadonlyonDidChangeContentEmitter

ReadonlyonDidChangeSelectedCell

Protected ReadonlyonDidChangeSelectedCellEmitter

ReadonlyonDidDispose

Protected ReadonlyonDidDisposeEmitter

ReadonlyonDidSaveNotebook

Protected ReadonlyonDidSaveNotebookEmitter

ReadonlyonDirtyChanged

Protected ReadonlyonDirtyChangedEmitter

Protectedprops

OptionalselectedCell

Protected ReadonlyundoRedoService

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

applyEdits

Parameters

Returns void

applySnapshot

Parameters

Returns Promise<void>

cellDirtyChanged

Parameters

Returns void

ProtectedchangeCellInternalMetadataPartial

Parameters

Returns void

ProtectedchangeCellLanguage

Parameters

Returns void

ProtectedchangeCellMetadata

Parameters

Returns void

ProtectedchangeCellMetadataPartial

Parameters

Returns void

createSnapshot

Returns Saveable.Snapshot

dispose

Returns void

`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

`Protected`changeCellInternalMetadataPartial

`Protected`changeCellLanguage

`Protected`changeCellMetadata

`Protected`changeCellMetadataPartial

`Protected`fireContentChange

`Protected`isCellMetadataChanged

`Protected`moveCellToIndex

`Protected`replaceCells

`Protected`updateNotebookMetadata