Interface ISharedNotebook

Implements an API for nbformat.INotebookContent

Hierarchy

ISharedDocument
- ISharedNotebook

Implemented by

YNotebook

Properties

`Readonly` cells

cells: ISharedCell[]

The list of shared cells in the notebook.

`Readonly` changed

changed: ISignal<ISharedNotebook, NotebookChange>

The changed signal.

`Optional` `Readonly` disableDocumentWideUndoRedo

disableDocumentWideUndoRedo?: boolean

Wether the undo/redo logic should be considered on the full document across all cells.

`Readonly` disposed

disposed: ISignal<ISharedNotebook, void>

A signal emitted when the object is disposed.

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

metadata

metadata: INotebookMetadata

Notebook metadata.

`Readonly` metadataChanged

metadataChanged: ISignal<ISharedNotebook, IMapChange<any>>

Signal triggered when a metadata changes.

`Readonly` nbformat

nbformat: number

The major version number of the nbformat.

`Readonly` nbformat_minor

nbformat_minor: number

The minor version number of the nbformat.

`Readonly` state

state: JSONObject

Document state

`Readonly` version

version: string

Document version

Methods

addCell

addCell(cell: Cell): ISharedCell
Add a shared cell at the notebook bottom.

Returns
The added cell.
Parameters
- cell: Cell
  
  Cell to add.
Returns ISharedCell
- Defined in src/api.ts:258

canRedo

canRedo(): boolean
Whether the object can undo changes.

Returns boolean
Inherited from ISharedDocument.canRedo
- Defined in src/api.ts:66

canUndo

canUndo(): boolean
Whether the object can redo changes.

Returns boolean
Inherited from ISharedDocument.canUndo
- Defined in src/api.ts:61

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Inherited from ISharedDocument.clearUndoHistory
- Defined in src/api.ts:71

deleteCell

deleteCell(index: number): void
Remove a cell.
Parameters
- index: number
Returns void
- Defined in src/api.ts:311

deleteCellRange

deleteCellRange(from: number, to: number): void
Remove a range of cells.
Parameters
- from: number
- to: number
Returns void
- Defined in src/api.ts:320

deleteMetadata

deleteMetadata(key: string): void
Delete a metadata notebook.
Parameters
- key: string
  
  The key to delete
Returns void
- Defined in src/api.ts:212

dispose

dispose(): void
Dispose of the resources held by the object.

Notes

If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior

It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from ISharedDocument.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

fromJSON

fromJSON(value: INotebookContent): void
Override the notebook with a JSON-serialized document.
Parameters
- value: INotebookContent
  
  The notebook
Returns void
- Defined in src/api.ts:327

getCell

getCell(index: number): ISharedCell
Get a shared cell by index.

Returns
The requested shared cell.
Parameters
- index: number
Returns ISharedCell
- Defined in src/api.ts:267

getMetadata

getMetadata(): INotebookMetadata
Returns all metadata associated with the notebook.

Returns
Notebook's metadata.

Returns INotebookMetadata
- Defined in src/api.ts:219
getMetadata(key: string): undefined | PartialJSONValue
Returns a metadata associated with the notebook.

Returns
Notebook's metadata.
Parameters
- key: string
  
  Key to get from the metadata
Returns undefined | PartialJSONValue
- Defined in src/api.ts:227

getState

getState(key: string): undefined | JSONValue
Get the value for a state attribute
Parameters
- key: string
  
  Key to get
Returns undefined | JSONValue
Inherited from ISharedDocument.getState
- Defined in src/api.ts:103

insertCell

insertCell(index: number, cell: Cell): ISharedCell
Insert a shared cell into a specific position.

Returns
The inserted cell.
Parameters
- index: number
  
  Cell's position.
- cell: Cell
  
  Cell to insert.
Returns ISharedCell
- Defined in src/api.ts:277

insertCells

insertCells(index: number, cells: Cell[]): ISharedCell[]
Insert a list of shared cells into a specific position.

Returns
The inserted cells.
Parameters
- index: number
  
  Position to insert the cells.
- cells: Cell[]
  
  Array of shared cells to insert.
Returns ISharedCell[]
- Defined in src/api.ts:287

moveCell

moveCell(fromIndex: number, toIndex: number): void
Move a cell.
Parameters
- fromIndex: number
- toIndex: number
Returns void
- Defined in src/api.ts:295

moveCells

moveCells(fromIndex: number, toIndex: number, n?: number): void
Move cells.
Parameters
- fromIndex: number
- toIndex: number
- Optional n: number
Returns void
- Defined in src/api.ts:304

redo

redo(): void
Redo an operation.

Returns void
Inherited from ISharedDocument.redo
- Defined in src/api.ts:56

setMetadata

setMetadata(metadata: INotebookMetadata): void
Sets all metadata associated with the notebook.
Parameters
- metadata: INotebookMetadata
  
  All Notebook's metadata.
Returns void
- Defined in src/api.ts:234
setMetadata(metadata: string, value: PartialJSONValue): void
Sets a metadata associated with the notebook.
Parameters
- metadata: string
  
  The key to set.
- value: PartialJSONValue
  
  New metadata value
Returns void
- Defined in src/api.ts:242

setState

setState(key: string, value: JSONValue): void
Set the value of a state attribute
Parameters
- key: string
  
  Key to set
- value: JSONValue
  
  New attribute value
Returns void
Inherited from ISharedDocument.setState
- Defined in src/api.ts:111

toJSON

toJSON(): INotebookContent
Serialize the model to JSON.

Returns INotebookContent
- Defined in src/api.ts:332

transact

transact(f: (() => void), undoable?: boolean): void
Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.
Parameters
- f: (() => void)
  
  Transaction to execute
  - - (): void
    - Returns void
- Optional undoable: boolean
  
  Whether to track the change in the action history or not (default true)
Returns void
Inherited from ISharedDocument.transact
- Defined in src/api.ts:80

undo

undo(): void
Undo an operation.

Returns void
Inherited from ISharedDocument.undo
- Defined in src/api.ts:51

updateMetadata

updateMetadata(value: Partial<INotebookMetadata>): void
Updates the metadata associated with the notebook.
Parameters
- value: Partial<INotebookMetadata>
Returns void
- Defined in src/api.ts:249

Interface ISharedNotebook

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly cells

Readonly changed

Optional Readonly disableDocumentWideUndoRedo

Readonly disposed

Readonly isDisposed

Notes

metadata

Readonly metadataChanged

Readonly nbformat

Readonly nbformat_minor

Readonly state

Readonly version

Methods

addCell

Returns

Parameters

cell: Cell

Returns ISharedCell

canRedo

Returns boolean

canUndo

Returns boolean

clearUndoHistory

Returns void

deleteCell

Parameters

index: number

Returns void

deleteCellRange

Parameters

from: number

to: number

Returns void

deleteMetadata

Parameters

key: string

Returns void

dispose

Notes

Undefined Behavior

Returns void

fromJSON

Parameters

value: INotebookContent

Returns void

getCell

Returns

Parameters

index: number

Returns ISharedCell

getMetadata

Returns

Returns INotebookMetadata

Returns

Parameters

key: string

Returns undefined | PartialJSONValue

getState

Parameters

key: string

Returns undefined | JSONValue

insertCell

Returns

Parameters

index: number

cell: Cell

Returns ISharedCell

insertCells

Returns

Parameters

index: number

cells: Cell[]

Returns ISharedCell[]

`Readonly` cells

`Readonly` changed

`Optional` `Readonly` disableDocumentWideUndoRedo

`Readonly` disposed

`Readonly` isDisposed

`Readonly` metadataChanged

`Readonly` nbformat

`Readonly` nbformat_minor

`Readonly` state

`Readonly` version

`Optional` n: number

`Optional` undoable: boolean