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

• @jupyter/ydoc
• YBaseCell

Class YBaseCell

Type Parameters

• Metadata extends nbformat.IBaseCellMetadata

Hierarchy

• YBaseCell
  • YCodeCell

Implements

• ISharedBaseCell<Metadata>
• IYText

Index

Constructors

constructor

• new YBaseCell<Metadata>(ymodel: YMap<any>, ysource: YText, options?: SharedCell.IOptions, ymetadata?: YMap<any>): YBaseCell<Metadata>

• Type Parameters

  • Metadata extends IBaseCellMetadata

Parameters

• ymodel: YMap<any>

• ysource: YText

• options: SharedCell.IOptions = {}

• Optional ymetadata: YMap<any>

Returns YBaseCell<Metadata>

Properties

Private _awareness

Private _changed

Private _disposed

Private _isDisposed

_isDisposed: boolean = false

Protected _metadataChanged

Protected _notebook

Private _prevSourceLength

_prevSourceLength: number

Private _undoManager

Private _ymetadata

_ymetadata: YMap<any>

Private _ysource

_ysource: YText

Readonly ymodel

ymodel: YMap<any>

Accessors

awareness

• get awareness(): null | Awareness

• Returns null | Awareness

cell_type

• get cell_type(): any

• Returns any

changed

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

• Returns ISignal<this, CellChange>

disposed

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

• Returns ISignal<this, void>

id

• get id(): string

• Returns string

isDisposed

• get isDisposed(): boolean

• Returns boolean

isStandalone

• get isStandalone(): boolean

• Returns boolean

metadata

• get metadata(): Partial<Metadata>

• Returns Partial<Metadata>

• set metadata(v: Partial<Metadata>): void

• Parameters

  • v: Partial<Metadata>

Returns void

metadataChanged

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

• Returns ISignal<this, IMapChange<any>>

notebook

• get notebook(): null | YNotebook

• Returns null | YNotebook

source

• get source(): string

• Returns string

• set source(v: string): void

• Parameters

  • v: string

Returns void

undoManager

• get undoManager(): null | UndoManager

• Returns null | UndoManager

ysource

• get ysource(): YText

• Returns YText

Methods

Private _modelObserver

• _modelObserver(events: YEvent<any>[], transaction: Transaction): void

• Parameters

  • events: YEvent<any>[]

  • transaction: Transaction

Returns void

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

Protected getChanges

• getChanges(events: YEvent<any>[]): Partial<CellChange>

• Parameters

  • events: YEvent<any>[]

Returns Partial<CellChange>

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  

  • undoable: boolean = true

  • origin: any = null

Returns void

undo

• undo(): void

• Returns void

updateSource

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

• Parameters

  • start: number

  • end: number

  • value: string = ''

Returns void

Static create

• create(id?: string): YBaseCell<any>

• Parameters

  • Optional id: string

Returns YBaseCell<any>