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

Hierarchy

• YBaseCell<nbformat.IBaseCellMetadata>
  • YCodeCell

Implements

• ISharedCodeCell

Index

Constructors

constructor

• new YCodeCell(ymodel: YMap<any>, ysource: YText, youtputs: YArray<any>, options?: SharedCell.IOptions, ymetadata?: YMap<any>): YCodeCell

• Parameters

  • ymodel: YMap<any>

  • ysource: YText

  • youtputs: YArray<any>

  • options: SharedCell.IOptions = {}

  • Optional ymetadata: YMap<any>

Returns YCodeCell

Properties

Protected _metadataChanged

Protected _notebook

Private _youtputs

_youtputs: YArray<YMap<any>>

Readonly ymodel

ymodel: YMap<any>

Accessors

awareness

• get awareness(): null | Awareness

• Returns null | Awareness

cell_type

• get cell_type(): "code"

• Returns "code"

changed

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

• Returns ISignal<this, CellChange>

disposed

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

• Returns ISignal<this, void>

executionState

• get executionState(): IExecutionState

• Returns IExecutionState

• set executionState(state: IExecutionState): void

• Returns void

execution_count

• get execution_count(): null | number

• Returns null | number

• set execution_count(count: null | number): void

• Parameters

  • count: null | number

Returns 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

outputs

• get outputs(): IOutput[]

• Returns IOutput[]

• set outputs(v: IOutput[]): void

• Returns void

source

• get source(): string

• Returns string

• set source(v: string): void

• Parameters

  • v: string

Returns void

undoManager

• get undoManager(): null | UndoManager

• Returns null | UndoManager

youtputs

• get youtputs(): YArray<any>

• Returns YArray<any>

ysource

• get ysource(): YText

• Returns YText

Methods

appendStreamOutput

• appendStreamOutput(index: number, text: string, origin?: any): void

• Parameters

  • index: number

  • text: string

  • origin: any = null

Returns void

canRedo

• canRedo(): boolean

• Returns boolean

canUndo

• canUndo(): boolean

• Returns boolean

clearUndoHistory

• clearUndoHistory(): void

• Returns void

createOutputs

• createOutputs(outputs: IOutput[]): YMap<any>[]

• Returns YMap<any>[]

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<IBaseCellMetadata>

• Returns Partial<IBaseCellMetadata>

• getMetadata(key: string): undefined | PartialJSONValue

• Parameters

  • key: string

Returns undefined | PartialJSONValue

getOutputs

• getOutputs(): IOutput[]

• Returns IOutput[]

getSource

• getSource(): string

• Returns string

redo

• redo(): void

• Returns void

removeStreamOutput

• removeStreamOutput(index: number, start: number, origin?: any): void

• Parameters

  • index: number

  • start: number

  • origin: any = null

Returns void

setMetadata

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

• Returns void

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

• Returns void

setOutputs

• setOutputs(outputs: IOutput[]): void

• Returns void

setSource

• setSource(value: string): void

• Parameters

  • value: string

Returns void

toJSON

• toJSON(): ICodeCell

• Returns ICodeCell

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

updateOutputs

• updateOutputs(start: number, end: number, outputs?: IOutput[], origin?: any): void

• Parameters

  • start: number

  • end: number

  • outputs: IOutput[] = []

  • origin: any = null

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): YCodeCell

• Parameters

  • Optional id: string

Returns YCodeCell