Interface ISharedDocument

Implement an API for Context information on the shared information. This is used by, for example, docregistry to share the file-path of the edited content.

Hierarchy

Implemented by

Properties

awareness changed disposed isDisposed state version

Methods

canRedo canUndo clearUndoHistory dispose getSource getState redo setSource setState transact undo

Properties

Readonly awareness

awareness: Awareness

Document awareness

Readonly changed

changed: ISignal<ISharedDocument, DocumentChange>

The changed signal.

Readonly disposed

disposed: ISignal<ISharedDocument, 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.

Readonly state

state: JSONObject

Document state

Readonly version

version: string

Document version

Methods

canRedo

  • Whether the object can undo changes.

    Returns boolean

canUndo

  • Whether the object can redo changes.

    Returns boolean

clearUndoHistory

  • Clear the change stack.

    Returns void

dispose

  • 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

getSource

getState

  • Get the value for a state attribute

    Parameters

    • key: string

      Key to get

    Returns undefined | JSONValue

redo

  • Redo an operation.

    Returns

    Whether a change was made.

    Returns boolean

setSource

setState

  • Set the value of a state attribute

    Parameters

    • key: string

      Key to set

    • value: JSONValue

      New attribute value

    Returns void

transact

  • 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

undo

  • Undo an operation.

    Returns

    Whether a change was made.

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc