YNotebook | @jupyter/ydoc (original) (raw)

Hierarchy

• YDocument<NotebookChange>
  • YNotebook

Implements

• ISharedNotebook

Index

Constructors

constructor

• new YNotebook(options?: Omit<ISharedNotebook.IOptions, "data">): YNotebook

• Returns YNotebook

Properties

Protected _changed

Private _disableDocumentWideUndoRedo

_disableDocumentWideUndoRedo: boolean

Protected _metadataChanged

Private _ycellMapping

_ycellMapping: WeakMap<YMap<any>, YCellType> = ...

Protected Readonly _ycells

_ycells: YArray<YMap<any>> = ...

Readonly cells

Readonly version

version: string = '2.0.0'

Readonly ymeta

ymeta: YMap<any> = ...

Accessors

awareness

• get awareness(): Awareness

• Returns Awareness

changed

• get changed(): ISignal<this, T>

• Returns ISignal<this, T>

disableDocumentWideUndoRedo

• get disableDocumentWideUndoRedo(): boolean

• Returns boolean

disposed

• get disposed(): ISignal<this, void>

• Returns ISignal<this, void>

isDisposed

• get isDisposed(): boolean

• Returns boolean

metadata

• get metadata(): INotebookMetadata

• Returns INotebookMetadata

• set metadata(v: INotebookMetadata): void

• Returns void

metadataChanged

• get metadataChanged(): ISignal<this, IMapChange<any>>

• Returns ISignal<this, IMapChange<any>>

nbformat

• get nbformat(): number

• Returns number

• set nbformat(value: number): void

• Parameters

  • value: number

Returns void

nbformat_minor

• get nbformat_minor(): number

• Returns number

• set nbformat_minor(value: number): void

• Parameters

  • value: number

Returns void

source

• get source(): JSONValue

• Returns JSONValue

• set source(value: JSONValue): void

• Returns void

state

• get state(): JSONObject

• Returns JSONObject

undoManager

• get undoManager(): UndoManager

• Returns UndoManager

ydoc

• get ydoc(): Doc

• Returns Doc

ystate

• get ystate(): YMap<any>

• Returns YMap<any>

Methods

Private _onMetaChanged

• _onMetaChanged(events: YEvent<any>[]): void

• Parameters

  • events: YEvent<any>[]

Returns void

Private _onYCellsChanged

• _onYCellsChanged(event: YArrayEvent<YMap<any>>): void

• Returns void

addCell

• addCell(cell: Cell): YBaseCell<IBaseCellMetadata>

• Parameters

  • cell: Cell

Returns YBaseCell<IBaseCellMetadata>

canRedo

• canRedo(): boolean

• Returns boolean

canUndo

• canUndo(): boolean

• Returns boolean

clearUndoHistory

• clearUndoHistory(): void

• Returns void

deleteCell

• deleteCell(index: number): void

• Parameters

  • index: number

Returns void

deleteCellRange

• deleteCellRange(from: number, to: number): void

• Parameters

  • from: number

  • to: number

Returns void

deleteMetadata

• deleteMetadata(key: string): void

• Parameters

  • key: string

Returns void

dispose

• dispose(): void

• Returns void

fromJSON

• fromJSON(value: INotebookContent): void

• Returns void

getCell

• getCell(index: number): YCellType

• Parameters

  • index: number

Returns YCellType

getMetadata

• getMetadata(): INotebookMetadata

• Returns INotebookMetadata

• getMetadata(key: string): undefined | PartialJSONValue

• Parameters

  • key: string

Returns undefined | PartialJSONValue

getSource

• getSource(): JSONValue

• Returns JSONValue

getState

• getState(key: string): undefined | JSONValue

• Parameters

  • key: string

Returns undefined | JSONValue

insertCell

• insertCell(index: number, cell: Cell): YBaseCell<IBaseCellMetadata>

• Parameters

  • index: number

  • cell: Cell

Returns YBaseCell<IBaseCellMetadata>

insertCells

• insertCells(index: number, cells: Cell[]): YBaseCell<IBaseCellMetadata>[]

• Parameters

  • index: number

  • cells: Cell[]

Returns YBaseCell<IBaseCellMetadata>[]

moveCell

• moveCell(fromIndex: number, toIndex: number): void

• Parameters

  • fromIndex: number

  • toIndex: number

Returns void

moveCells

• moveCells(fromIndex: number, toIndex: number, n?: number): void

• Parameters

  • fromIndex: number

  • toIndex: number

  • n: number = 1

Returns void

Protected onStateChanged

• onStateChanged(event: YMapEvent<any>): void

• Returns void

redo

• redo(): void

• Returns void

setMetadata

• setMetadata(metadata: INotebookMetadata): void

• Returns void

• setMetadata(metadata: string, value: PartialJSONValue): void

• Returns void

setSource

• setSource(value: JSONValue): void

• Returns void

setState

• setState(key: string, value: JSONValue): void

• Returns void

toJSON

• toJSON(): INotebookContent

• Returns INotebookContent

transact

• transact(f: (() => void), undoable?: boolean, origin?: any): void

• Parameters

  • f: (() => void)

    * * (): void  
             * #### Returns void  

  • undoable: boolean = true

  • origin: any = null

Returns void

undo

• undo(): void

• Returns void

updateMetadata

• updateMetadata(value: Partial<INotebookMetadata>): void

• Returns void

Static create

• create(options?: ISharedNotebook.IOptions): YNotebook

• Returns YNotebook