3541 lines
112 KiB
HTML
3541 lines
112 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<base data-ice="baseUrl" href="../">
|
|
<title data-ice="title">Function | yjs</title>
|
|
<link type="text/css" rel="stylesheet" href="css/style.css">
|
|
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
|
|
<script src="script/prettify/prettify.js"></script>
|
|
<script src="script/manual.js"></script>
|
|
<meta name="description" content="A framework for real-time p2p shared editing on any data"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="yjs"><meta property="twitter:description" content="A framework for real-time p2p shared editing on any data"></head>
|
|
<body class="layout-container" data-ice="rootContainer">
|
|
|
|
<header>
|
|
<a href="./">Home</a>
|
|
|
|
<a href="identifiers.html">Reference</a>
|
|
<a href="source.html">Source</a>
|
|
|
|
<div class="search-box">
|
|
<span>
|
|
<img src="./image/search.png">
|
|
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
|
|
</span>
|
|
<ul class="search-result"></ul>
|
|
</div>
|
|
<a style="position:relative; top:3px;" href="https://github.com/y-js/yjs.git"><img width="20px" src="./image/github.png"></a></header>
|
|
|
|
<nav class="navigation" data-ice="nav"><div>
|
|
<ul>
|
|
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Connector.js~AbstractConnector.html">AbstractConnector</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Persistence.js~AbstractPersistence.html">AbstractPersistence</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Transaction.js~Transaction.html">Transaction</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Y.js~Y.html">Y</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-encodable">encodable</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#bindings">Bindings</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Bindings/Binding.js~Binding.html">Binding</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#bindings-dombinding">Bindings/DomBinding</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-domToType">domToType</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-defaultFilter">defaultFilter</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-filterDomAttributes">filterDomAttributes</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createAssociation">createAssociation</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-domsToTypes">domsToTypes</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-removeAssociation">removeAssociation</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-switchAssociation">switchAssociation</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-FilterFunction">FilterFunction</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#bindings-quillbinding">Bindings/QuillBinding</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Bindings/QuillBinding/QuillBinding.js~QuillBinding.html">QuillBinding</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#bindings-textareabinding">Bindings/TextareaBinding</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Bindings/TextareaBinding/TextareaBinding.js~TextareaBinding.html">TextareaBinding</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#messagehandler">MessageHandler</a><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-fromBinary">fromBinary</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-toBinary">toBinary</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-readDeleteSet">readDeleteSet</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-stringifyDeleteSet">stringifyDeleteSet</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-writeDeleteSet">writeDeleteSet</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-integrateRemoteStructs">integrateRemoteStructs</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-stringifyStructs">stringifyStructs</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-logID">logID</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-messageToRoomname">messageToRoomname</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-messageToString">messageToString</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-readStateSet">readStateSet</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-writeStateSet">writeStateSet</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-readSyncStep1">readSyncStep1</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-sendSyncStep1">sendSyncStep1</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-stringifySyncStep1">stringifySyncStep1</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-readSyncStep2">readSyncStep2</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-stringifySyncStep2">stringifySyncStep2</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#store">Store</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Store/DeleteStore.js~DeleteStore.html">DeleteStore</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Store/OperationStore.js~OperationStore.html">OperationStore</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Store/StateStore.js~StateStore.html">StateStore</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#struct">Struct</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Struct/GC.js~GC.html">GC</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Struct/Item.js~Item.html">Item</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Struct/ItemEmbed.js~ItemEmbed.html">ItemEmbed</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Struct/ItemFormat.js~ItemFormat.html">ItemFormat</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Struct/ItemJSON.js~ItemJSON.html">ItemJSON</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Struct/ItemString.js~ItemString.html">ItemString</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Struct/Type.js~Type.html">Type</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getListItemIDByPosition">getListItemIDByPosition</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#types-yarray">Types/YArray</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YArray/YArray.js~YArray.html">YArray</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YArray/YArray.js~YArrayEvent.html">YArrayEvent</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#types-ymap">Types/YMap</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YMap/YMap.js~YMap.html">YMap</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YMap/YMap.js~YMapEvent.html">YMapEvent</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#types-ytext">Types/YText</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YText/YText.js~YText.html">YText</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-Delta">Delta</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-TextAttributes">TextAttributes</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#types-yxml">Types/YXml</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YXml/YXmlElement.js~YXmlElement.html">YXmlElement</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YXml/YXmlFragment.js~YXmlFragment.html">YXmlFragment</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YXml/YXmlHook.js~YXmlHook.html">YXmlHook</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YXml/YXmlText.js~YXmlText.html">YXmlText</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Types/YXml/YXmlTreeWalker.js~YXmlTreeWalker.html">YXmlTreeWalker</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-CSS_Selector">CSS_Selector</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-CSS_Selector">CSS_Selector</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#util">Util</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/EventHandler.js~EventHandler.html">EventHandler</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/NamedEventHandler.js~NamedEventHandler.html">NamedEventHandler</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/Tree.js~Tree.html">Tree</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/UndoManager.js~UndoManager.html">UndoManager</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/YEvent.js~YEvent.html">YEvent</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-defragmentItemContent">defragmentItemContent</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-generateRandomUint32">generateRandomUint32</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-isParentOf">isParentOf</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createMutualExclude">createMutualExclude</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-fromRelativePosition">fromRelativePosition</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getRelativePosition">getRelativePosition</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-simpleDiff">simpleDiff</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-registerStruct">registerStruct</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-AbsolutePosition">AbsolutePosition</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-RelativePosition">RelativePosition</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SimpleDiff">SimpleDiff</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#util-binary">Util/Binary</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/Binary/Decoder.js~BinaryDecoder.html">BinaryDecoder</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/Binary/Encoder.js~BinaryEncoder.html">BinaryEncoder</a></span></span></li>
|
|
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#util-id">Util/ID</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/ID/ID.js~ID.html">ID</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Util/ID/RootID.js~RootID.html">RootID</a></span></span></li>
|
|
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-RootFakeUserID">RootFakeUserID</a></span></span></li>
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="content" data-ice="content"><h1 data-ice="title">Function</h1>
|
|
<div data-ice="summaries"><table class="summary" data-ice="summary">
|
|
<thead><tr><td data-ice="title" colspan="3">Static Public Summary</td></tr></thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-createAssociation">createAssociation</a></span></span><span class="code" data-ice="signature">(domBinding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>, dom: <span>Element</span>, type: <span><a href="class/src/Types/YXml/YXmlElement.js~YXmlElement.html">YXmlElement</a></span> | <span><a href="class/src/Types/YXml/YXmlHook.js~YXmlHook.html">YXmlHook</a></span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Creates an association (the information that a DOM element belongs to a
|
|
type).</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-createMutualExclude">createMutualExclude</a></span></span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">Function</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Creates a mutual exclude function with the following property:</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-defaultFilter">defaultFilter</a></span></span><span class="code" data-ice="signature">(nodeName: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, attrs: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map">Map</a></span>): <span>Map </span> | <span> null</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Default filter method (does nothing).</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-defragmentItemContent">defragmentItemContent</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Try to merge all items in os with their successors.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-domToType">domToType</a></span></span><span class="code" data-ice="signature">(element: <span>Element</span> | <span>TextNode</span>, _document: <span>Document</span>, hooks: <span>Hooks</span>, filter: <span>Filter</span>, binding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>): <span>YXmlElement </span> | <span> YXmlText</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Creates a Yjs type (YXml) based on the contents of a DOM Element.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-domsToTypes">domsToTypes</a></span></span><span class="code" data-ice="signature">(doms: <span>*</span>, _document: <span>*</span>, hooks: <span>*</span>, filter: <span>*</span>, binding: <span>*</span>): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-filterDomAttributes">filterDomAttributes</a></span></span><span class="code" data-ice="signature">(dom: <span>*</span>, filter: <span>*</span>): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-fromBinary">fromBinary</a></span></span><span class="code" data-ice="signature">(y: <span><a href="class/src/Y.js~Y.html">Y</a></span>, decoder: <span><a href="class/src/Util/Binary/Decoder.js~BinaryDecoder.html">BinaryDecoder</a></span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Read the Decoder and fill the Yjs instance with data in the decoder.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-fromRelativePosition">fromRelativePosition</a></span></span><span class="code" data-ice="signature">(y: <span><a href="class/src/Y.js~Y.html">Y</a></span>, rpos: <span><a href="typedef/index.html#static-typedef-RelativePosition">RelativePosition</a></span>): <span><a href="typedef/index.html#static-typedef-AbsolutePosition">AbsolutePosition</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Transforms a relative position back to a relative position.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-generateRandomUint32">generateRandomUint32</a></span></span><span class="code" data-ice="signature">(): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-getListItemIDByPosition">getListItemIDByPosition</a></span></span><span class="code" data-ice="signature">(type: <span>*</span>, i: <span>*</span>): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-getRelativePosition">getRelativePosition</a></span></span><span class="code" data-ice="signature">(type: <span>YType</span>, offset: <span>Integer</span>): <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span><span>[]</span></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Create a relativePosition based on a absolute position.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-integrateRemoteStructs">integrateRemoteStructs</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-isParentOf">isParentOf</a></span></span><span class="code" data-ice="signature">(parent: <span><a href="class/src/Struct/Type.js~Type.html">Type</a></span>, child: <span><a href="class/src/Struct/Type.js~Type.html">Type</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">Boolean</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Check if <code>parent</code> is a parent of <code>child</code>.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-logID">logID</a></span></span><span class="code" data-ice="signature">(id: <span>*</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-messageToRoomname">messageToRoomname</a></span></span><span class="code" data-ice="signature">(buffer: <span>*</span>): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-messageToString">messageToString</a></span></span><span class="code" data-ice="signature">(arrayPattern: <span><span>*</span><span>[]</span></span>): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-readDeleteSet">readDeleteSet</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-readStateSet">readStateSet</a></span></span><span class="code" data-ice="signature">(decoder: <span>*</span>): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-readSyncStep1">readSyncStep1</a></span></span><span class="code" data-ice="signature">(decoder: <span>*</span>, encoder: <span>*</span>, y: <span>*</span>, senderConn: <span>*</span>, sender: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-readSyncStep2">readSyncStep2</a></span></span><span class="code" data-ice="signature">(decoder: <span>*</span>, encoder: <span>*</span>, y: <span>*</span>, senderConn: <span>*</span>, sender: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-registerStruct">registerStruct</a></span></span><span class="code" data-ice="signature">(reference: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></span>, structConstructor: <span>class</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Register a new Yjs types.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-removeAssociation">removeAssociation</a></span></span><span class="code" data-ice="signature">(domBinding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>, dom: <span>Element</span>, type: <span><a href="class/src/Types/YXml/YXmlElement.js~YXmlElement.html">YXmlElement</a></span> | <span><a href="class/src/Types/YXml/YXmlHook.js~YXmlHook.html">YXmlHook</a></span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Removes an association (the information that a DOM element belongs to a
|
|
type).</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-sendSyncStep1">sendSyncStep1</a></span></span><span class="code" data-ice="signature">(connector: <span>*</span>, syncUser: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-simpleDiff">simpleDiff</a></span></span><span class="code" data-ice="signature">(a: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, b: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="typedef/index.html#static-typedef-SimpleDiff">SimpleDiff</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Create a diff between two strings.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-stringifyDeleteSet">stringifyDeleteSet</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>): <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-stringifyStructs">stringifyStructs</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-stringifySyncStep1">stringifySyncStep1</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-stringifySyncStep2">stringifySyncStep2</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-switchAssociation">switchAssociation</a></span></span><span class="code" data-ice="signature">(domBinding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>, oldDom: <span>Element</span>, newDom: <span>Element</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>If oldDom is associated with a type, associate newDom with the type and
|
|
forget about oldDom.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-toBinary">toBinary</a></span></span><span class="code" data-ice="signature">(y: <span><a href="class/src/Y.js~Y.html">Y</a></span>): <span><a href="class/src/Util/Binary/Encoder.js~BinaryEncoder.html">BinaryEncoder</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Encode the Yjs model to binary format.</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-writeDeleteSet">writeDeleteSet</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, encoder: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
|
|
|
|
|
|
<span class="code" data-ice="name"><span><a href="function/index.html#static-function-writeStateSet">writeStateSet</a></span></span><span class="code" data-ice="signature">(y: <span>*</span>, encoder: <span>*</span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div data-ice="details"><h2 data-ice="title">Static Public </h2>
|
|
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-createAssociation">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">createAssociation</span><span class="code" data-ice="signature">(domBinding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>, dom: <span>Element</span>, type: <span><a href="class/src/Types/YXml/YXmlElement.js~YXmlElement.html">YXmlElement</a></span> | <span><a href="class/src/Types/YXml/YXmlHook.js~YXmlHook.html">YXmlHook</a></span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber39">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {createAssociation} from '<span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber39">yjs/src/Bindings/DomBinding/util.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Creates an association (the information that a DOM element belongs to a
|
|
type).</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">domBinding</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The binding object</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">dom</td>
|
|
<td data-ice="type" class="code"><span>Element</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The dom that is to be associated with type</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">type</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Types/YXml/YXmlElement.js~YXmlElement.html">YXmlElement</a></span> | <span><a href="class/src/Types/YXml/YXmlHook.js~YXmlHook.html">YXmlHook</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The type that is to be associated with dom</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-createMutualExclude">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">createMutualExclude</span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">Function</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/mutualExclude.js.html#lineNumber20">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {createMutualExclude} from '<span><a href="file/src/Util/mutualExclude.js.html#lineNumber20">yjs/src/Util/mutualExclude.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Creates a mutual exclude function with the following property:</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">Function</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>A mutual exclude function</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="example">
|
|
<h4>Example:</h4>
|
|
|
|
<div class="example-doc" data-ice="exampleDoc">
|
|
|
|
<pre class="prettyprint source-code"><code data-ice="exampleCode">const mutualExclude = createMutualExclude()
|
|
mutualExclude(function () {
|
|
// This function is immediately executed
|
|
mutualExclude(function () {
|
|
// This function is never executed, as it is called with the same
|
|
// mutualExclude
|
|
})
|
|
})</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-defaultFilter">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">defaultFilter</span><span class="code" data-ice="signature">(nodeName: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, attrs: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map">Map</a></span>): <span>Map </span> | <span> null</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Bindings/DomBinding/filter.js.html#lineNumber11">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {defaultFilter} from '<span><a href="file/src/Bindings/DomBinding/filter.js.html#lineNumber11">yjs/src/Bindings/DomBinding/filter.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Default filter method (does nothing).</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">nodeName</td>
|
|
<td data-ice="type" class="code"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The nodeName of the element</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">attrs</td>
|
|
<td data-ice="type" class="code"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map">Map</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>Map of key-value pairs that are attributes of the node.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>Map </span> | <span> null</span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The allowed attributes or null, if the element should be
|
|
filtered.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-defragmentItemContent">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">defragmentItemContent</span><span class="code" data-ice="signature">(y: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/defragmentItemContent.js.html#lineNumber19">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {defragmentItemContent} from '<span><a href="file/src/Util/defragmentItemContent.js.html#lineNumber19">yjs/src/Util/defragmentItemContent.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Try to merge all items in os with their successors.</p>
|
|
<p>Some transformations (like delete) fragment items.
|
|
Item(c: 'ab') + Delete(1,1) + Delete(0, 1) -> Item(c: 'a',deleted);Item(c: 'b',deleted)</p>
|
|
<p>This functions merges the fragmented nodes together:
|
|
Item(c: 'a',deleted);Item(c: 'b',deleted) -> Item(c: 'ab', deleted)</p>
|
|
<p>TODO: The Tree implementation does not support deletions in-spot.
|
|
This is why all deletions must be performed after the traversal.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-domToType">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">domToType</span><span class="code" data-ice="signature">(element: <span>Element</span> | <span>TextNode</span>, _document: <span>Document</span>, hooks: <span>Hooks</span>, filter: <span>Filter</span>, binding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>): <span>YXmlElement </span> | <span> YXmlText</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Bindings/DomBinding/domToType.js.html#lineNumber16">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import domToType from '<span><a href="file/src/Bindings/DomBinding/domToType.js.html#lineNumber16">yjs/src/Bindings/DomBinding/domToType.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Creates a Yjs type (YXml) based on the contents of a DOM Element.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">element</td>
|
|
<td data-ice="type" class="code"><span>Element</span> | <span>TextNode</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The DOM Element</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">_document</td>
|
|
<td data-ice="type" class="code"><span>Document</span></td>
|
|
<td data-ice="appendix"><ul><li>nullable: true</li></ul></td>
|
|
<td data-ice="description"><p>Optional. Provide the global document object</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">hooks</td>
|
|
<td data-ice="type" class="code"><span>Hooks</span></td>
|
|
<td data-ice="appendix"><ul><li>optional</li>
|
|
<li>default: {}</li></ul></td>
|
|
<td data-ice="description"><p>Optional. Set of Yjs Hooks</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">filter</td>
|
|
<td data-ice="type" class="code"><span>Filter</span></td>
|
|
<td data-ice="appendix"><ul><li>optional</li>
|
|
<li>default: defaultFilter</li></ul></td>
|
|
<td data-ice="description"><p>Optional. Dom element filter</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">binding</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span></td>
|
|
<td data-ice="appendix"><ul><li>nullable: true</li></ul></td>
|
|
<td data-ice="description"><p>Warning: This property is for internal use only!</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>YXmlElement </span> | <span> YXmlText</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-domsToTypes">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">domsToTypes</span><span class="code" data-ice="signature">(doms: <span>*</span>, _document: <span>*</span>, hooks: <span>*</span>, filter: <span>*</span>, binding: <span>*</span>): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber85">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {domsToTypes} from '<span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber85">yjs/src/Bindings/DomBinding/util.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">doms</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">_document</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">hooks</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">filter</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">binding</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-filterDomAttributes">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">filterDomAttributes</span><span class="code" data-ice="signature">(dom: <span>*</span>, filter: <span>*</span>): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Bindings/DomBinding/filter.js.html#lineNumber19">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {filterDomAttributes} from '<span><a href="file/src/Bindings/DomBinding/filter.js.html#lineNumber19">yjs/src/Bindings/DomBinding/filter.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">dom</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">filter</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-fromBinary">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">fromBinary</span><span class="code" data-ice="signature">(y: <span><a href="class/src/Y.js~Y.html">Y</a></span>, decoder: <span><a href="class/src/Util/Binary/Decoder.js~BinaryDecoder.html">BinaryDecoder</a></span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/binaryEncode.js.html#lineNumber13">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {fromBinary} from '<span><a href="file/src/MessageHandler/binaryEncode.js.html#lineNumber13">yjs/src/MessageHandler/binaryEncode.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Read the Decoder and fill the Yjs instance with data in the decoder.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Y.js~Y.html">Y</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The Yjs instance</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Util/Binary/Decoder.js~BinaryDecoder.html">BinaryDecoder</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The BinaryDecoder to read from.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-fromRelativePosition">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">fromRelativePosition</span><span class="code" data-ice="signature">(y: <span><a href="class/src/Y.js~Y.html">Y</a></span>, rpos: <span><a href="typedef/index.html#static-typedef-RelativePosition">RelativePosition</a></span>): <span><a href="typedef/index.html#static-typedef-AbsolutePosition">AbsolutePosition</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/relativePosition.js.html#lineNumber71">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {fromRelativePosition} from '<span><a href="file/src/Util/relativePosition.js.html#lineNumber71">yjs/src/Util/relativePosition.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Transforms a relative position back to a relative position.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Y.js~Y.html">Y</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The Yjs instance in which to query for the absolute position.</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">rpos</td>
|
|
<td data-ice="type" class="code"><span><a href="typedef/index.html#static-typedef-RelativePosition">RelativePosition</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The relative position.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span><a href="typedef/index.html#static-typedef-AbsolutePosition">AbsolutePosition</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The absolute position in the Yjs model
|
|
(type + offset).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-generateRandomUint32">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">generateRandomUint32</span><span class="code" data-ice="signature">(): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/generateRandomUint32.js.html#lineNumber3">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {generateRandomUint32} from '<span><a href="file/src/Util/generateRandomUint32.js.html#lineNumber3">yjs/src/Util/generateRandomUint32.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-getListItemIDByPosition">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">getListItemIDByPosition</span><span class="code" data-ice="signature">(type: <span>*</span>, i: <span>*</span>): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Struct/Type.js.html#lineNumber18">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {getListItemIDByPosition} from '<span><a href="file/src/Struct/Type.js.html#lineNumber18">yjs/src/Struct/Type.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">type</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">i</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-getRelativePosition">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">getRelativePosition</span><span class="code" data-ice="signature">(type: <span>YType</span>, offset: <span>Integer</span>): <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span><span>[]</span></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/relativePosition.js.html#lineNumber42">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {getRelativePosition} from '<span><a href="file/src/Util/relativePosition.js.html#lineNumber42">yjs/src/Util/relativePosition.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Create a relativePosition based on a absolute position.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">type</td>
|
|
<td data-ice="type" class="code"><span>YType</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The base type (e.g. YText or YArray).</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">offset</td>
|
|
<td data-ice="type" class="code"><span>Integer</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The absolute position.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span><span>[]</span></span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-integrateRemoteStructs">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">integrateRemoteStructs</span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/integrateRemoteStructs.js.html#lineNumber77">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {integrateRemoteStructs} from '<span><a href="file/src/MessageHandler/integrateRemoteStructs.js.html#lineNumber77">yjs/src/MessageHandler/integrateRemoteStructs.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-isParentOf">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">isParentOf</span><span class="code" data-ice="signature">(parent: <span><a href="class/src/Struct/Type.js~Type.html">Type</a></span>, child: <span><a href="class/src/Struct/Type.js~Type.html">Type</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">Boolean</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/isParentOf.js.html#lineNumber11">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import isParentOf from '<span><a href="file/src/Util/isParentOf.js.html#lineNumber11">yjs/src/Util/isParentOf.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Check if <code>parent</code> is a parent of <code>child</code>.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">parent</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Struct/Type.js~Type.html">Type</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">child</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Struct/Type.js~Type.html">Type</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">Boolean</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>Whether <code>parent</code> is a parent of <code>child</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-logID">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">logID</span><span class="code" data-ice="signature">(id: <span>*</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/messageToString.js.html#lineNumber33">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {logID} from '<span><a href="file/src/MessageHandler/messageToString.js.html#lineNumber33">yjs/src/MessageHandler/messageToString.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">id</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-messageToRoomname">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">messageToRoomname</span><span class="code" data-ice="signature">(buffer: <span>*</span>): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/messageToString.js.html#lineNumber27">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {messageToRoomname} from '<span><a href="file/src/MessageHandler/messageToString.js.html#lineNumber27">yjs/src/MessageHandler/messageToString.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">buffer</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-messageToString">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">messageToString</span><span class="code" data-ice="signature">(arrayPattern: <span><span>*</span><span>[]</span></span>): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/messageToString.js.html#lineNumber9">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {messageToString} from '<span><a href="file/src/MessageHandler/messageToString.js.html#lineNumber9">yjs/src/MessageHandler/messageToString.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">arrayPattern</td>
|
|
<td data-ice="type" class="code"><span><span>*</span><span>[]</span></span></td>
|
|
<td data-ice="appendix"><ul><li>default: [null, null]</li></ul></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-readDeleteSet">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">readDeleteSet</span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/deleteSet.js.html#lineNumber58">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {readDeleteSet} from '<span><a href="file/src/MessageHandler/deleteSet.js.html#lineNumber58">yjs/src/MessageHandler/deleteSet.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-readStateSet">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">readStateSet</span><span class="code" data-ice="signature">(decoder: <span>*</span>): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/stateSet.js.html#lineNumber2">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {readStateSet} from '<span><a href="file/src/MessageHandler/stateSet.js.html#lineNumber2">yjs/src/MessageHandler/stateSet.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-readSyncStep1">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">readSyncStep1</span><span class="code" data-ice="signature">(decoder: <span>*</span>, encoder: <span>*</span>, y: <span>*</span>, senderConn: <span>*</span>, sender: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/syncStep1.js.html#lineNumber62">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {readSyncStep1} from '<span><a href="file/src/MessageHandler/syncStep1.js.html#lineNumber62">yjs/src/MessageHandler/syncStep1.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">encoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">senderConn</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">sender</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-readSyncStep2">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">readSyncStep2</span><span class="code" data-ice="signature">(decoder: <span>*</span>, encoder: <span>*</span>, y: <span>*</span>, senderConn: <span>*</span>, sender: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/syncStep2.js.html#lineNumber24">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {readSyncStep2} from '<span><a href="file/src/MessageHandler/syncStep2.js.html#lineNumber24">yjs/src/MessageHandler/syncStep2.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">encoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">senderConn</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">sender</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-registerStruct">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">registerStruct</span><span class="code" data-ice="signature">(reference: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></span>, structConstructor: <span>class</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/structReferences.js.html#lineNumber25">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {registerStruct} from '<span><a href="file/src/Util/structReferences.js.html#lineNumber25">yjs/src/Util/structReferences.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Register a new Yjs types. The same type must be defined with the same
|
|
reference on all clients!</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">reference</td>
|
|
<td data-ice="type" class="code"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">structConstructor</td>
|
|
<td data-ice="type" class="code"><span>class</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-removeAssociation">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">removeAssociation</span><span class="code" data-ice="signature">(domBinding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>, dom: <span>Element</span>, type: <span><a href="class/src/Types/YXml/YXmlElement.js~YXmlElement.html">YXmlElement</a></span> | <span><a href="class/src/Types/YXml/YXmlHook.js~YXmlHook.html">YXmlHook</a></span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber25">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {removeAssociation} from '<span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber25">yjs/src/Bindings/DomBinding/util.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Removes an association (the information that a DOM element belongs to a
|
|
type).</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">domBinding</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The binding object</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">dom</td>
|
|
<td data-ice="type" class="code"><span>Element</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The dom that is to be associated with type</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">type</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Types/YXml/YXmlElement.js~YXmlElement.html">YXmlElement</a></span> | <span><a href="class/src/Types/YXml/YXmlHook.js~YXmlHook.html">YXmlHook</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The type that is to be associated with dom</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-sendSyncStep1">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">sendSyncStep1</span><span class="code" data-ice="signature">(connector: <span>*</span>, syncUser: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/syncStep1.js.html#lineNumber23">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {sendSyncStep1} from '<span><a href="file/src/MessageHandler/syncStep1.js.html#lineNumber23">yjs/src/MessageHandler/syncStep1.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">connector</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">syncUser</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-simpleDiff">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">simpleDiff</span><span class="code" data-ice="signature">(a: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, b: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="typedef/index.html#static-typedef-SimpleDiff">SimpleDiff</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Util/simpleDiff.js.html#lineNumber30">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import simpleDiff from '<span><a href="file/src/Util/simpleDiff.js.html#lineNumber30">yjs/src/Util/simpleDiff.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Create a diff between two strings. This diff implementation is highly
|
|
efficient, but not very sophisticated.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">a</td>
|
|
<td data-ice="type" class="code"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The old version of the string</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">b</td>
|
|
<td data-ice="type" class="code"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The updated version of the string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span><a href="typedef/index.html#static-typedef-SimpleDiff">SimpleDiff</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The diff description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-stringifyDeleteSet">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">stringifyDeleteSet</span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>): <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/deleteSet.js.html#lineNumber4">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {stringifyDeleteSet} from '<span><a href="file/src/MessageHandler/deleteSet.js.html#lineNumber4">yjs/src/MessageHandler/deleteSet.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">strBuilder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span>*</span></td>
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-stringifyStructs">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">stringifyStructs</span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/integrateRemoteStructs.js.html#lineNumber62">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {stringifyStructs} from '<span><a href="file/src/MessageHandler/integrateRemoteStructs.js.html#lineNumber62">yjs/src/MessageHandler/integrateRemoteStructs.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">strBuilder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-stringifySyncStep1">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">stringifySyncStep1</span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/syncStep1.js.html#lineNumber7">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {stringifySyncStep1} from '<span><a href="file/src/MessageHandler/syncStep1.js.html#lineNumber7">yjs/src/MessageHandler/syncStep1.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">strBuilder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-stringifySyncStep2">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">stringifySyncStep2</span><span class="code" data-ice="signature">(y: <span>*</span>, decoder: <span>*</span>, strBuilder: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/syncStep2.js.html#lineNumber4">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {stringifySyncStep2} from '<span><a href="file/src/MessageHandler/syncStep2.js.html#lineNumber4">yjs/src/MessageHandler/syncStep2.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">decoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">strBuilder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-switchAssociation">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">switchAssociation</span><span class="code" data-ice="signature">(domBinding: <span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span>, oldDom: <span>Element</span>, newDom: <span>Element</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber54">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {switchAssociation} from '<span><a href="file/src/Bindings/DomBinding/util.js.html#lineNumber54">yjs/src/Bindings/DomBinding/util.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>If oldDom is associated with a type, associate newDom with the type and
|
|
forget about oldDom. If oldDom is not associated with any type, nothing happens.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">domBinding</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Bindings/DomBinding/DomBinding.js~DomBinding.html">DomBinding</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The binding object</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">oldDom</td>
|
|
<td data-ice="type" class="code"><span>Element</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The existing dom</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">newDom</td>
|
|
<td data-ice="type" class="code"><span>Element</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The new dom object</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-toBinary">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">toBinary</span><span class="code" data-ice="signature">(y: <span><a href="class/src/Y.js~Y.html">Y</a></span>): <span><a href="class/src/Util/Binary/Encoder.js~BinaryEncoder.html">BinaryEncoder</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/binaryEncode.js.html#lineNumber27">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {toBinary} from '<span><a href="file/src/MessageHandler/binaryEncode.js.html#lineNumber27">yjs/src/MessageHandler/binaryEncode.js</a></span>'</code></pre></div>
|
|
|
|
|
|
<div data-ice="description"><p>Encode the Yjs model to binary format.</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span><a href="class/src/Y.js~Y.html">Y</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The Yjs instance</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td class="return-type code" data-ice="returnType"><span><a href="class/src/Util/Binary/Encoder.js~BinaryEncoder.html">BinaryEncoder</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The encoder instance that can be transformed
|
|
to ArrayBuffer or Buffer.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-writeDeleteSet">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">writeDeleteSet</span><span class="code" data-ice="signature">(y: <span>*</span>, encoder: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/deleteSet.js.html#lineNumber20">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {writeDeleteSet} from '<span><a href="file/src/MessageHandler/deleteSet.js.html#lineNumber20">yjs/src/MessageHandler/deleteSet.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">encoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-writeStateSet">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="code" data-ice="name">writeStateSet</span><span class="code" data-ice="signature">(y: <span>*</span>, encoder: <span>*</span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/MessageHandler/stateSet.js.html#lineNumber13">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {writeStateSet} from '<span><a href="file/src/MessageHandler/stateSet.js.html#lineNumber13">yjs/src/MessageHandler/stateSet.js</a></span>'</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">y</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" class="code" data-depth="0">encoder</td>
|
|
<td data-ice="type" class="code"><span>*</span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footer">
|
|
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.0.4)</span><img src="./image/esdoc-logo-mini-black.png"></a>
|
|
</footer>
|
|
|
|
<script src="script/search_index.js"></script>
|
|
<script src="script/search.js"></script>
|
|
<script src="script/pretty-print.js"></script>
|
|
<script src="script/inherited-summary.js"></script>
|
|
<script src="script/test-summary.js"></script>
|
|
<script src="script/inner-link.js"></script>
|
|
<script src="script/patch-for-local.js"></script>
|
|
</body>
|
|
</html>
|