Interface ISharedFile

Text/Markdown/Code files are represented as ISharedFile

Hierarchy

ISharedDocumentNoSource
ISharedText
- ISharedFile

Implemented by

YFile

Index

Properties

awareness changed disposed isDisposed source state version

Methods

canRedo canUndo clearUndoHistory dispose getSource getState redo setSource setState transact undo updateSource

Properties

`Readonly` awareness

awareness: Awareness

Document awareness

`Readonly` changed

changed: ISignal<ISharedFile, FileChange>

The changed signal.

`Readonly` disposed

disposed: ISignal<ISharedFile, void>

A signal emitted when the object is disposed.

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

source

source: string

Text

`Readonly` state

state: JSONObject

Document state

`Readonly` version

version: string

Document version

Methods

canRedo

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

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

canUndo

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

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

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

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

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

getSource

getSource(): string
Get text.

Returns
Text.

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

getState

getState(key: string): undefined | JSONValue
Get the value for a state attribute
Parameters
- key: string
  
  Key to get
Returns undefined | JSONValue
Inherited from ISharedDocumentNoSource.getState
- Defined in src/api.ts:114

redo

redo(): boolean
Redo an operation.

Returns
Whether a change was made.

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

setSource

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

setState

setState(key: string, value: JSONValue): void
Set the value of a state attribute
Parameters
- key: string
  
  Key to set
- value: JSONValue
  
  New attribute value
Returns void
Inherited from ISharedDocumentNoSource.setState
- Defined in src/api.ts:122

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 ISharedText.transact
- Defined in src/api.ts:86

undo

undo(): boolean
Undo an operation.

Returns
Whether a change was made.

Returns boolean
Inherited from ISharedText.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 ISharedText.updateSource
- Defined in src/api.ts:185

Generated using TypeDoc