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

• @jupyter/ydoc
• ISharedBaseCell

Interface ISharedBaseCell

Type Parameters

• Metadata extends nbformat.IBaseCellMetadata = nbformat.IBaseCellMetadata

Hierarchy

• ISharedText
  • ISharedBaseCell
    * ISharedCodeCell
    * ISharedAttachmentsCell
    * ISharedUnrecognizedCell

Implemented by

• YBaseCell

Index

Properties

Readonly cell_type

cell_type: string

Readonly changed

Readonly disposed

Readonly id

id: string

Readonly isDisposed

isDisposed: boolean

Readonly isStandalone

isStandalone: boolean

metadata

metadata: Partial<Metadata>

Readonly metadataChanged

Readonly notebook

source

source: string

Methods

canRedo

• canRedo(): boolean

• Returns boolean

canUndo

• canUndo(): boolean

• Returns boolean

clearUndoHistory

• clearUndoHistory(): void

• Returns void

deleteMetadata

• deleteMetadata(key: string): void

• Parameters

  • key: string

Returns void

dispose

• dispose(): void

• Returns void

getId

• getId(): string

• Returns string

getMetadata

• getMetadata(): Partial<Metadata>

• Returns Partial<Metadata>

• getMetadata(key: string): undefined | PartialJSONValue

• Parameters

  • key: string

Returns undefined | PartialJSONValue

getSource

• getSource(): string

• Returns string

redo

• redo(): void

• Returns void

setMetadata

• setMetadata(metadata: Partial<Metadata>): void

• Parameters

  • metadata: Partial<Metadata>

Returns void

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

• Returns void

setSource

• setSource(value: string): void

• Parameters

  • value: string

Returns void

toJSON

• toJSON(): IBaseCell

• Returns IBaseCell

transact

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

• Parameters

  • f: (() => void)

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

  • Optional undoable: boolean

  • Optional origin: any

Returns void

undo

• undo(): void

• Returns void

updateSource

• updateSource(start: number, end: number, value?: string): void

• Parameters

  • start: number

  • end: number

  • Optional value: string

Returns void