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

Hierarchy

• YDocument<FileChange>
  • YFile

Implements

• ISharedFile
• ISharedText
• IYText

Index

Constructors

constructor

• new YFile(): YFile

• Returns YFile

Properties

Protected _changed

Readonly version

version: string = '1.0.0'

Readonly ysource

ysource: YText = ...

Accessors

awareness

• get awareness(): Awareness

• Returns Awareness

changed

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

• Returns ISignal<this, T>

disposed

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

• Returns ISignal<this, void>

isDisposed

• get isDisposed(): boolean

• Returns boolean

source

• get source(): string

• Returns string

• set source(v: string): void

• Parameters

  • v: string

Returns void

state

• get state(): JSONObject

• Returns JSONObject

undoManager

• get undoManager(): UndoManager

• Returns UndoManager

ydoc

• get ydoc(): Doc

• Returns Doc

ystate

• get ystate(): YMap<any>

• Returns YMap<any>

Methods

Private _modelObserver

• _modelObserver(event: YTextEvent): void

• Returns void

canRedo

• canRedo(): boolean

• Returns boolean

canUndo

• canUndo(): boolean

• Returns boolean

clearUndoHistory

• clearUndoHistory(): void

• Returns void

dispose

• dispose(): void

• Returns void

getSource

• getSource(): string

• Returns string

getState

• getState(key: string): undefined | JSONValue

• Parameters

  • key: string

Returns undefined | JSONValue

Protected onStateChanged

• onStateChanged(event: YMapEvent<any>): void

• Returns void

redo

• redo(): void

• Returns void

setSource

• setSource(value: string): void

• Parameters

  • value: string

Returns void

setState

• setState(key: string, value: JSONValue): void

• Returns void

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(): YFile

• Returns YFile