Interface ISharedAttachmentsCell

Cell with attachment interface.

Hierarchy

ISharedBaseCell<nbformat.IBaseCellMetadata>
- ISharedAttachmentsCell
  - ISharedMarkdownCell
  - ISharedRawCell

Properties

`Optional` attachments

attachments?: IAttachments

Cell attachments

`Readonly` cell_type

cell_type: string

The type of the cell.

`Readonly` changed

changed: ISignal<ISharedAttachmentsCell, CellChange>

The changed signal.

`Readonly` disposed

disposed: ISignal<ISharedAttachmentsCell, void>

A signal emitted when the object is disposed.

`Readonly` id

id: string

Cell id.

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly` isStandalone

isStandalone: boolean

Whether the cell is standalone or not.

If the cell is standalone. It cannot be inserted into a YNotebook because the Yjs model is already attached to an anonymous Y.Doc instance.

metadata

metadata: Partial<IBaseCellMetadata>

Cell metadata.

Notes

You should prefer to access and modify the specific key of interest.

`Readonly` metadataChanged

metadataChanged: ISignal<ISharedAttachmentsCell, IMapChange<any>>

Signal triggered when the cell metadata changes.

`Readonly` notebook

notebook: null | ISharedNotebook

The notebook that this cell belongs to.

source

source: string

Text

Methods

canRedo

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

Returns boolean
Inherited from ISharedBaseCell.canRedo
- Defined in src/api.ts:72

canUndo

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

Returns boolean
Inherited from ISharedBaseCell.canUndo
- Defined in src/api.ts:67

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Inherited from ISharedBaseCell.clearUndoHistory
- Defined in src/api.ts:77

deleteMetadata

deleteMetadata(key: string): void
Delete a metadata cell.
Parameters
- key: string
  
  The key to delete
Returns void
Inherited from ISharedBaseCell.deleteMetadata
- Defined in src/api.ts:489

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 ISharedBaseCell.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

getAttachments

getAttachments(): undefined | IAttachments
Gets the cell attachments.

Returns
The cell attachments.

Returns undefined | IAttachments
- Defined in src/api.ts:605

getId

getId(): string
Get Cell id.

Returns
Cell id.

Returns string
Inherited from ISharedBaseCell.getId
- Defined in src/api.ts:482

getMetadata

getMetadata(): Partial<IBaseCellMetadata>
Returns all metadata associated with the cell.

Returns
Cell's metadata.

Returns Partial<IBaseCellMetadata>
Inherited from ISharedBaseCell.getMetadata
- Defined in src/api.ts:496
getMetadata(key: string): undefined | PartialJSONValue
Returns a metadata associated with the cell.

Returns
Cell's metadata.
Parameters
- key: string
  
  Metadata key to get
Returns undefined | PartialJSONValue
Inherited from ISharedBaseCell.getMetadata
- Defined in src/api.ts:504

getSource

getSource(): string
Get text.

Returns
Text.

Returns string
Inherited from ISharedBaseCell.getSource
- Defined in src/api.ts:169

redo

redo(): boolean
Redo an operation.

Returns
Whether a change was made.

Returns boolean
Inherited from ISharedBaseCell.redo
- Defined in src/api.ts:62

setAttachments

setAttachments(attachments: undefined | IAttachments): void
Sets the cell attachments
Parameters
- attachments: undefined | IAttachments
Returns void
- Defined in src/api.ts:612

setMetadata

setMetadata(metadata: Partial<IBaseCellMetadata>): void
Sets some cell metadata.
Parameters
- metadata: Partial<IBaseCellMetadata>
  
  Cell's metadata.
Returns void
Inherited from ISharedBaseCell.setMetadata
- Defined in src/api.ts:511
setMetadata(metadata: string, value: PartialJSONValue): void
Sets a cell metadata.
Parameters
- metadata: string
  
  Cell's metadata key.
- value: PartialJSONValue
  
  Metadata value
Returns void
Inherited from ISharedBaseCell.setMetadata
- Defined in src/api.ts:519

setSource

setSource(value: string): void
Set text.
Parameters
- value: string
  
  New text.
Returns void
Inherited from ISharedBaseCell.setSource
- Defined in src/api.ts:176

toJSON

toJSON(): IBaseCell
Serialize the model to JSON.

Returns IBaseCell
Inherited from ISharedBaseCell.toJSON
- Defined in src/api.ts:524

transact

transact(f: (() => void), undoable?: boolean, origin?: any): 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)
- Optional origin: any
Returns void
Inherited from ISharedBaseCell.transact
- Defined in src/api.ts:86

undo

undo(): boolean
Undo an operation.

Returns
Whether a change was made.

Returns boolean
Inherited from ISharedBaseCell.undo
- Defined in src/api.ts:55

updateSource

updateSource(start: number, end: number, value?: string): void
Replace content from start to end with value.
Parameters
- start: number
- end: number
- Optional value: string
Returns void
Inherited from ISharedBaseCell.updateSource
- Defined in src/api.ts:185

Interface ISharedAttachmentsCell

Hierarchy

Index

Properties

Methods

Properties

Optional attachments

Readonly cell_type

Readonly changed

Readonly disposed

Readonly id

Readonly isDisposed

Notes

Readonly isStandalone

metadata

Notes

Readonly metadataChanged

Readonly notebook

source

Methods

canRedo

Returns boolean

canUndo

Returns boolean

clearUndoHistory

Returns void

deleteMetadata

Parameters

key: string

Returns void

dispose

Notes

Undefined Behavior

Returns void

getAttachments

Returns

Returns undefined | IAttachments

getId

Returns

Returns string

getMetadata

Returns

Returns Partial<IBaseCellMetadata>

Returns

Parameters

key: string

Returns undefined | PartialJSONValue

getSource

Returns

Returns string

redo

Returns

Returns boolean

setAttachments

Parameters

attachments: undefined | IAttachments

Returns void

setMetadata

Parameters

metadata: Partial<IBaseCellMetadata>

Returns void

Parameters

metadata: string

value: PartialJSONValue

Returns void

setSource

Parameters

value: string

Returns void

toJSON

Returns IBaseCell

transact

Parameters

f: (() => void)

Returns void

Optional undoable: boolean

Optional origin: any

Returns void

undo

Returns

`Optional` attachments

`Readonly` cell_type

`Readonly` changed

`Readonly` disposed

`Readonly` id

`Readonly` isDisposed

`Readonly` isStandalone

`Readonly` metadataChanged

`Readonly` notebook

`Optional` undoable: boolean

`Optional` origin: any

`Optional` value: string