UNPKG

gojs

Version:

Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams

274 lines (273 loc) 13.9 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IncrementalData | GoJS API</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../../assets/css/bootstrap.min.css"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <!-- non-fixed navbar --> <nav id="non-fixed-nav" class="navbar navbar-inverse navbar-top"> <div class="container-fluid"> <div class="navbar-header"> <div class="navheader-container"> <div class="navheader-collapse" data-toggle="collapse" data-target="#navbar"> <a id="toplogo" class="navbar-brand" href="../../index.html">GoJS</a> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> </div> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="../../index.html">Home</a></li> <li><a href="../../learn/index.html">Learn</a></li> <li><a href="../../samples/index.html">Samples</a></li> <li><a href="../../intro/index.html">Intro</a></li> <li><a href="../../api/index.html" target="api">API</a></li> <li><a href="https://www.nwoods.com/components/evalform.htm">Register</a></li> <li><a href="../../download.html">Download</a></li> <li><a href="https://forum.nwoods.com/c/gojs">Forum</a></li> <li><a href="https://www.nwoods.com/contact.html" onclick="ga('send','event','Outbound Link','click','contact');">Contact</a></li> <li class="buy"><a href="https://www.nwoods.com/sales/index.html" onclick="ga('send','event','Outbound Link','click','buy');">Buy</a></li> <li class="activate"><a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a></li> </ul> </div><!--/.nav-collapse --> </div> </nav> <div class="tsd-page-header"> <div class="tsd-page-toolbar"> <div class="container-fluid plr15"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">GoJS API</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container-fluid plr15"> <div class="top-copyright"> <!--<b>GoJS</b>&reg; Diagramming Components<br/>version &lt;br/&gt;version 2.1.18 for TypeScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a>--> <b>GoJS</b>&reg; Diagramming Components<br/>version 2.1.18<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a> </div> <div> <h1>Interface IncrementalData</h1> </div> </div> </div> </div> </header> <div class="container-fluid container-main plr15"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">IncrementalData</span> </li> </ul> </section> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <p>Interface for the output object of <a href="Model.html#toIncrementalData">Model.toIncrementalData</a>.</p> <p>All properties of this object are optional, as they are only included if changes occurred. For instance, if a transaction didn&#39;t include any changes to modelData, the modelData property of this interface won&#39;t be included on the output object.</p> <p>Any shared or cyclic references within the model data will be maintained on the data included on this output object.</p> <dl class="tsd-comment-tags"> <dt>since</dt> <dd><p>2.1</p> </dd> </dl> </div> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IncrementalData.html#insertedLinkKeys" class="tsd-kind-icon">inserted<wbr>Link<wbr>Keys</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IncrementalData.html#insertedNodeKeys" class="tsd-kind-icon">inserted<wbr>Node<wbr>Keys</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IncrementalData.html#modelData" class="tsd-kind-icon">model<wbr>Data</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IncrementalData.html#modifiedLinkData" class="tsd-kind-icon">modified<wbr>Link<wbr>Data</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IncrementalData.html#modifiedNodeData" class="tsd-kind-icon">modified<wbr>Node<wbr>Data</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IncrementalData.html#removedLinkKeys" class="tsd-kind-icon">removed<wbr>Link<wbr>Keys</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IncrementalData.html#removedNodeKeys" class="tsd-kind-icon">removed<wbr>Node<wbr>Keys</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="insertedLinkKeys" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagOptional">Optional</span> inserted<wbr>Link<wbr>Keys <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#Key" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">&gt;</span> </h3> <div class="tsd-comment tsd-typography"> <p>Array of link keys added. Any key included will also be included in the modifiedLinkData array.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="insertedNodeKeys" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagOptional">Optional</span> inserted<wbr>Node<wbr>Keys <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#Key" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">&gt;</span> </h3> <div class="tsd-comment tsd-typography"> <p>Array of node keys added. Any key included will also be included in the modifiedNodeData array.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="modelData" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagOptional">Optional</span> model<wbr>Data <span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a> </h3> <div class="tsd-comment tsd-typography"> <p>Object containing the modified <a href="Model.html#modelData">Model.modelData</a>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="modifiedLinkData" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagOptional">Optional</span> modified<wbr>Link<wbr>Data <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">&gt;</span> </h3> <div class="tsd-comment tsd-typography"> <p>Array of link data objects modified.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="modifiedNodeData" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagOptional">Optional</span> modified<wbr>Node<wbr>Data <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">&gt;</span> </h3> <div class="tsd-comment tsd-typography"> <p>Array of node data objects modified.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="removedLinkKeys" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagOptional">Optional</span> removed<wbr>Link<wbr>Keys <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#Key" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">&gt;</span> </h3> <div class="tsd-comment tsd-typography"> <p>Array of link keys deleted.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="removedNodeKeys" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagOptional">Optional</span> removed<wbr>Node<wbr>Keys <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#Key" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">&gt;</span> </h3> <div class="tsd-comment tsd-typography"> <p>Array of node keys deleted.</p> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../index.html"><em>GoJS <wbr>Class <wbr>Index</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="IncrementalData.html" class="tsd-kind-icon">Incremental<wbr>Data</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="IncrementalData.html#insertedLinkKeys" class="tsd-kind-icon">inserted<wbr>Link<wbr>Keys</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="IncrementalData.html#insertedNodeKeys" class="tsd-kind-icon">inserted<wbr>Node<wbr>Keys</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="IncrementalData.html#modelData" class="tsd-kind-icon">model<wbr>Data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="IncrementalData.html#modifiedLinkData" class="tsd-kind-icon">modified<wbr>Link<wbr>Data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="IncrementalData.html#modifiedNodeData" class="tsd-kind-icon">modified<wbr>Node<wbr>Data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="IncrementalData.html#removedLinkKeys" class="tsd-kind-icon">removed<wbr>Link<wbr>Keys</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="IncrementalData.html#removedNodeKeys" class="tsd-kind-icon">removed<wbr>Node<wbr>Keys</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <div class="container-fluid bottom-copyright plr15"> Copyright &copy; 1998-2020 by Northwoods Software Corporation. </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script src="../../assets/js/api.js"></script> <script src="../../assets/js/bootstrap.min.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-1506307-5', 'auto'); ga('send', 'pageview'); </script> </body> </html>