YMultiDocUndoManager (undo/redo across Yjs docs) and\nYKeyValue (optimized key-value store).\n insert,\ndelete, and move operations for folder-like\nhierarchies. \n \nA shareable Array-like type that supports efficient insert/delete of elements\nat any position. Internally it uses a linked list of Arrays that is split when\nnecessary.\n
\nconst yarray = new Y.Array()\n
\nY.Array.from(Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type>):\nY.Array\n \n parent:Y.AbstractType|null\n \n insert(index:number, content:Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type>)\n array.insert(0, [1]) splices the list and inserts 1 at\nposition 0.\n push(Array<Object|boolean|Array|string|number|null|Uint8Array|Y.Type>)\n \n unshift(Array<Object|boolean|Array|string|number|null|Uint8Array|Y.Type>)\n \n delete(index:number, length:number)\n \n get(index:number)\n \n slice(start:number, end:number):Array<Object|boolean|Array|string|number|null|Uint8Array|Y.Type>\n length:number\n \n \n \nforEach(function(value:object|boolean|Array|string|number|null|Uint8Array|Y.Type,\n index:number, array: Y.Array))\n \n \n \n map(function(T, number, YArray):M):Array<M>\n \n clone(): Y.Array\n toArray():Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type>\n toJSON():Array<Object|boolean|Array|string|number|null>\n toJSON method.\n [Symbol.Iterator]\n for (let value of yarray) { .. }\n observe(function(YArrayEvent, Transaction):void)\n unobserve(function(YArrayEvent, Transaction):void)\n observe event listener from this type.\n observeDeep(function(Array<YEvent>, Transaction):void)\n unobserveDeep(function(Array<YEvent>, Transaction):void)\n observeDeep event listener from this type.\n \n A shareable Map type.\n
\nconst ymap = new Y.Map()parent:Y.AbstractType|null\n \n size: number\n get(key:string):object|boolean|string|number|null|Uint8Array|Y.Type\n \n set(key:string, value:object|boolean|string|number|null|Uint8Array|Y.Type)\n \n delete(key:string)\n \n has(key:string):boolean\n \n clear()\n clone():Y.Map\n toJSON():Object<string, Object|boolean|Array|string|number|null|Uint8Array>\n [key,value] pairs of this YMap to a new Object.It\ntransforms all child types to JSON using their toJSON method.\n forEach(function(value:object|boolean|Array|string|number|null|Uint8Array|Y.Type,\n key:string, map: Y.Map))\n [Symbol.Iterator]\n [key, value] pairs.\n for (let [key, value] of ymap) { .. }\n entries()\n [key, value] pairs.\n values()\n keys()\n observe(function(YMapEvent, Transaction):void)\n unobserve(function(YMapEvent, Transaction):void)\n observe event listener from this type.\n observeDeep(function(Array<YEvent>, Transaction):void)\n unobserveDeep(function(Array<YEvent>, Transaction):void)\n observeDeep event listener from this type.\n \nA shareable type that is optimized for shared editing on text. It allows to\nassign properties to ranges in the text. This makes it possible to implement\nrich-text bindings to this type.\n
\n\nThis type can also be transformed to the\ndelta format. Similarly the\nYTextEvents compute changes as deltas.\n
\nconst ytext = new Y.Text()\n
parent:Y.AbstractType|null\n \n insert(index:number, content:string, [formattingAttributes:Object<string,string>])\n ytext.insert(0, 'bold text', { bold: true })\n delete(index:number, length:number)\n \n format(index:number, length:number, formattingAttributes:Object<string,string>)\n applyDelta(delta: Delta, opts:Object<string,any>)\n ytext.applyDelta(delta, { sanitize: false })\n length:number\n \n toString():string\n toJSON():string\n toStringtoDelta():Delta\n observe(function(YTextEvent, Transaction):void)\n unobserve(function(YTextEvent, Transaction):void)\n observe event listener from this type.\n observeDeep(function(Array<YEvent>, Transaction):void)\n unobserveDeep(function(Array<YEvent>, Transaction):void)\n observeDeep event listener from this type.\n \n A container that holds an Array of Y.XmlElements.\n
\nconst yxml = new Y.XmlFragment()parent:Y.AbstractType|null\n \n firstChild:Y.XmlElement|Y.XmlText|null\n \n insert(index:number, content:Array<Y.XmlElement|Y.XmlText>)\n \n delete(index:number, length:number)\n \n get(index:number)\n \n slice(start:number, end:number):Array<Y.XmlElement|Y.XmlText>\n length:number\n \n clone():Y.XmlFragment\n toArray():Array<Y.XmlElement|Y.XmlText>\n toDOM():DocumentFragment\n toString():string\n toJSON():string\n toString.createTreeWalker(filter: function(AbstractType<any>):boolean):Iterable\n observe(function(YXmlEvent, Transaction):void)\n unobserve(function(YXmlEvent, Transaction):void)\n observe event listener from this type.\n observeDeep(function(Array<YEvent>, Transaction):void)\n unobserveDeep(function(Array<YEvent>, Transaction):void)\n observeDeep event listener from this type.\n \nA shareable type that represents an XML Element. It has a nodeName,\nattributes, and a list of children. But it makes no effort to validate its\ncontent and be actually XML compliant.\n
const yxml = new Y.XmlElement()parent:Y.AbstractType|null\n \n firstChild:Y.XmlElement|Y.XmlText|null\n \n nextSibling:Y.XmlElement|Y.XmlText|null\n \n prevSibling:Y.XmlElement|Y.XmlText|null\n \n insert(index:number, content:Array<Y.XmlElement|Y.XmlText>)\n \n delete(index:number, length:number)\n \n get(index:number)\n \n length:number\n \n setAttribute(attributeName:string, attributeValue:string)\n \n removeAttribute(attributeName:string)\n \n getAttribute(attributeName:string):string\n \n getAttributes():Object<string,string>\n \n get(i:number):Y.XmlElement|Y.XmlText\n slice(start:number, end:number):Array<Y.XmlElement|Y.XmlText>\n clone():Y.XmlElement\n toArray():Array<Y.XmlElement|Y.XmlText>\n toDOM():Element\n toString():string\n toJSON():string\n toString.observe(function(YXmlEvent, Transaction):void)\n unobserve(function(YXmlEvent, Transaction):void)\n observe event listener from this type.\n observeDeep(function(Array<YEvent>, Transaction):void)\n unobserveDeep(function(Array<YEvent>, Transaction):void)\n observeDeep event listener from this type.\n clientID\n gc\n transact(function(Transaction):void [, origin:any])\n update event are called after each transaction. You should\nbundle changes into a single transaction to reduce the amount of event\ncalls. I.e. doc.transact(() => { yarray.insert(..); ymap.set(..) })\ntriggers a single change event. origin\nparameter that is stored on transaction.origin and\non('update', (update, origin) => ..).\n toJSON():any\n ydoc.getType(..)).\n get(string, Y.[TypeClass]):[Type]\n getArray(string):Y.Array\n y.get(string, Y.Array).getMap(string):Y.Map\n y.get(string, Y.Map).getText(string):Y.Text\n y.get(string, Y.Text).getXmlElement(string, string):Y.XmlElement\n y.get(string, Y.XmlElement).getXmlFragment(string):Y.XmlFragment\n y.get(string, Y.XmlFragment).on(string, function)\n off(string, function)\n on('update', function(updateMessage:Uint8Array, origin:any, Y.Doc):void)\n on('beforeTransaction', function(Y.Transaction, Y.Doc):void)\n on('afterTransaction', function(Y.Transaction, Y.Doc):void)\n on('beforeAllTransactions', function(Y.Doc):void)\n on('afterAllTransactions', function(Y.Doc, Array<Y.Transaction>):void)\n Y.applyUpdate(Y.Doc, update:Uint8Array, [transactionOrigin:any])\n transactionOrigin that will be stored on\ntransaction.origin\nand ydoc.on('update', (update, origin) => ..).\n Y.encodeStateAsUpdate(Y.Doc, [encodedTargetStateVector:Uint8Array]):Uint8Array\n Y.encodeStateVector(Y.Doc):Uint8Array\n Y.mergeUpdates(Array<Uint8Array>)\n Y.encodeStateVectorFromUpdate(Uint8Array): Uint8Array\n Y.diffUpdate(update: Uint8Array, stateVector: Uint8Array): Uint8Array\n Y.encodeStateAsUpdate(ydoc, stateVector) but works\non updates instead.\n convertUpdateFormatV1ToV2\n convertUpdateFormatV2ToV1\n \nY.createRelativePositionFromTypeIndex(type:Uint8Array|Y.Type, index: number\n[, assoc=0])\n \n assoc >= 0). By default, the position associates\nwith the character that comes after the specified index position. If\nassoc < 0, then the relative position associates with the character\nbefore the specified index position.\n \nY.createAbsolutePositionFromRelativePosition(RelativePosition, Y.Doc):\n{ type: Y.AbstractType, index: number, assoc: number } | null\n \n \nY.encodeRelativePosition(RelativePosition):Uint8Array\n \n Y.decodeRelativePosition(Uint8Array):RelativePosition\n constructor(scope:Y.AbstractType|Array<Y.AbstractType>\n [, {captureTimeout:number,trackedOrigins:Set<any>,deleteFilter:function(item):boolean}])\n undo()\n \n redo()\n \n stopCapturing()\n \n \n \non('stack-item-added', { stackItem: { meta: Map<any,any> }, type: 'undo'\n| 'redo' })\n \n \n StackItem is added to the\nundo- or the redo-stack.\n \non('stack-item-updated', { stackItem: { meta: Map<any,any> }, type: 'undo'\n| 'redo' })\n \n \n StackItem is updated.\nThis happens when two changes happen within a \"captureInterval\".\n \non('stack-item-popped', { stackItem: { meta: Map<any,any> }, type: 'undo'\n| 'redo' })\n \n \n StackItem is popped from\nthe undo- or the redo-stack.\n \non('stack-cleared', { undoStackCleared: boolean, redoStackCleared: boolean })\n \n \n