gojs

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>TreeModel | 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>  <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> </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>® Diagramming Components<br/>version 2.1.18<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a> </div> <div> <h1>Class TreeModel</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> <a href="Model.html" class="tsd-signature-type">Model</a> <ul class="tsd-hierarchy"> <li> <span class="target">TreeModel</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <p>TreeModels support tree-structured graphs of nodes and links. Each node can have at most one "tree parent"; cycles are not permitted. The reference to the parent node's key is a property of the child node data.</p> <p>TreeModels, unlike <a href="GraphLinksModel.html">GraphLinksModel</a>s, do not support arbitrary link relationships between nodes, nor is there a separate link data object for each parent-child relationship. Furthermore there is no support for grouping or label nodes.</p> <p>The <a href="TreeModel.html#nodeParentKeyProperty">nodeParentKeyProperty</a> property names the property on the node data whose value is the key of the "tree parent" node. The default value for this property is "parent".</p> <p>For example, one can define a graph consisting of one parent node with two child nodes:</p> <pre><code class="hljs js"> model.nodeDataArray = [ { <span class="hljs-attr">key</span>: <span class="hljs-string">"Alpha"</span> }, { <span class="hljs-attr">key</span>: <span class="hljs-string">"Beta"</span>, <span class="hljs-attr">parent</span>: <span class="hljs-string">"Alpha"</span> }, { <span class="hljs-attr">key</span>: <span class="hljs-string">"Gamma"</span>, <span class="hljs-attr">parent</span>: <span class="hljs-string">"Alpha"</span> } ];</code></pre> <p>If you need to show a more complicated graph structure than a tree, use a <a href="GraphLinksModel.html">GraphLinksModel</a>. If you want to have multiple links between the same pair of nodes, or if you want to associate more information with each link and cannot put the information on the child node, you will need to have a separate link data object for each link, and that would require the use of <a href="GraphLinksModel.html">GraphLinksModel</a>.</p> <dl class="tsd-comment-tags"> <dt>since</dt> <dd><p>1.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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TreeModel.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeModel.html#nodeParentKeyProperty" class="tsd-kind-icon">node<wbr>Parent<wbr>Key<wbr>Property</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeModel.html#parentLinkCategoryProperty" class="tsd-kind-icon">parent<wbr>Link<wbr>Category<wbr>Property</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeModel.html#copyNodeData" class="tsd-kind-icon">copy<wbr>Node<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeModel.html#getParentKeyForNodeData" class="tsd-kind-icon">get<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeModel.html#getParentLinkCategoryForNodeData" class="tsd-kind-icon">get<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeModel.html#setDataProperty" class="tsd-kind-icon">set<wbr>Data<wbr>Property</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeModel.html#setParentKeyForNodeData" class="tsd-kind-icon">set<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeModel.html#setParentLinkCategoryForNodeData" class="tsd-kind-icon">set<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3> constructor </h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Tree<wbr>Model<span class="tsd-signature-symbol">(</span>nodedataarray<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TreeModel.html" class="tsd-signature-type">TreeModel</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>This constructs an empty TreeModel unless one provides arguments as the initial data array values for the <a href="Model.html#nodeDataArray">Model.nodeDataArray</a> property.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> nodedataarray: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p>an optional Array containing JavaScript objects to be represented by Nodes.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="TreeModel.html" class="tsd-signature-type">TreeModel</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="nodeParentKeyProperty" class="tsd-anchor"></a> <h3> node<wbr>Parent<wbr>Key<wbr>Property <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">a</span><span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">b</span><span class="tsd-signature-symbol">?: </span><a href="../index.html#Key" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#Key" class="tsd-signature-type">Key</a> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Gets or sets the name of the property on node data that specifies the string or number key of the node data that acts as the "parent" for this "child" node data. The value may also be a function taking two arguments, where the first argument will be a node data object. If the second argument is not supplied, the function should return the string or number key for the parent node data object of which the given data object is a child; if the second argument is supplied, the function should modify the node data object so that it has that new key (which may be undefined to refer to no node) as the parent key for that node.. The default value is the name 'parent', meaning that it expects the data to have a property named 'parent' if the node wants to refer to the parent node by its key. The value must not be null nor an empty string.</p> <p>If you want to set this property you must do so before using the model, and especially before you assign <a href="Diagram.html#model">Diagram.model</a>. Note that functions cannot be serialized into JSON-formatted text, so if you are using <a href="Model.html#toJson">toJson</a> and <a href="Model.html#static-fromJson">Model.fromJson</a>, and if you want this property to be a function, you will need to assign this property to your desired function immediately after creating the model, including when it is created by <a href="Model.html#static-fromJson">Model.fromJson</a>.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="TreeModel.html#getParentKeyForNodeData">getParentKeyForNodeData</a>, <a href="TreeModel.html#setParentKeyForNodeData">setParentKeyForNodeData</a></p> </dd> </dl> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="parentLinkCategoryProperty" class="tsd-anchor"></a> <h3> parent<wbr>Link<wbr>Category<wbr>Property <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">a</span><span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">b</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Gets or sets the name of the data property that returns a string describing that node data's parent link's category. The value may also be a function taking two arguments, where the first argument will be a node data object. If the second argument is not supplied, the function should return the category name for any parent link; if the second argument is supplied, the function should modify the node data object so that its parent link has that new category name. The default value is the name 'parentLinkCategory'. This is used by the diagram to distinguish between different kinds of links. The name must not be null. If the value is an empty string, <a href="TreeModel.html#getParentLinkCategoryForNodeData">getParentLinkCategoryForNodeData</a> will return an empty string for all node data objects.</p> <p>If you want to set this property you must do so before using the model, and especially before you assign <a href="Diagram.html#model">Diagram.model</a>. Note that functions cannot be serialized into JSON-formatted text, so if you are using <a href="Model.html#toJson">toJson</a> and <a href="Model.html#static-fromJson">Model.fromJson</a>, and if you want this property to be a function, you will need to assign this property to your desired function immediately after creating the model, including when it is created by <a href="Model.html#static-fromJson">Model.fromJson</a>.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="TreeModel.html#getParentLinkCategoryForNodeData">getParentLinkCategoryForNodeData</a>, <a href="TreeModel.html#setParentLinkCategoryForNodeData">setParentLinkCategoryForNodeData</a></p> </dd> </dl> </div> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="copyNodeData" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagVirtual">Virtual</span> <span class="tsd-flag ts-flagOverride">Override</span> copy<wbr>Node<wbr>Data </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">copy<wbr>Node<wbr>Data<span class="tsd-signature-symbol">(</span>nodedata<span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>This override also makes sure any copied node data does not have a reference to a parent node.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="Model.html#copyNodeData">Model.copyNodeData</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nodedata: <a href="ObjectData.html" class="tsd-signature-type">ObjectData</a></h5> <div class="tsd-comment tsd-typography"> <p>a JavaScript object represented by a node, group, or non-link.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="ObjectData.html" class="tsd-signature-type">ObjectData</a> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">null</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getParentKeyForNodeData" class="tsd-anchor"></a> <h3> get<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data<span class="tsd-signature-symbol">(</span>nodedata<span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#Key" class="tsd-signature-type">Key</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>If there is a parent node for the given node data, return the parent's key.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="TreeModel.html#nodeParentKeyProperty">nodeParentKeyProperty</a>, <a href="TreeModel.html#setParentKeyForNodeData">setParentKeyForNodeData</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nodedata: <a href="ObjectData.html" class="tsd-signature-type">ObjectData</a></h5> <div class="tsd-comment tsd-typography"> <p>a JavaScript object represented by a node.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../index.html#Key" class="tsd-signature-type">Key</a></h4> <p>This returns undefined if there is no parent node data object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getParentLinkCategoryForNodeData" class="tsd-anchor"></a> <h3> get<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data<span class="tsd-signature-symbol">(</span>childdata<span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Find the category for the parent link of a given child node data, a string naming the link template that the <a href="Diagram.html">Diagram</a> should use to represent the link.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="TreeModel.html#parentLinkCategoryProperty">parentLinkCategoryProperty</a>, <a href="TreeModel.html#setParentLinkCategoryForNodeData">setParentLinkCategoryForNodeData</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>childdata: <a href="ObjectData.html" class="tsd-signature-type">ObjectData</a></h5> <div class="tsd-comment tsd-typography"> <p>a JavaScript object represented by a node data.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setDataProperty" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagVirtual">Virtual</span> <span class="tsd-flag ts-flagOverride">Override</span> set<wbr>Data<wbr>Property </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Data<wbr>Property<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a>, propname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>This override changes the value of some property of a node data or an item data, given a string naming the property and the new value, in a manner that can be undone/redone and that automatically updates any bindings.</p> <p>This gets the old value of the property; if the value is the same as the new value, no side-effects occur.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="Model.html#setDataProperty">Model.setDataProperty</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <a href="ObjectData.html" class="tsd-signature-type">ObjectData</a></h5> <div class="tsd-comment tsd-typography"> <p>a JavaScript object typically the value of a <a href="Panel.html#data">Panel.data</a> and represented by a Node, Link, Group, simple Part, or item in a <a href="Panel.html#itemArray">Panel.itemArray</a>; or this model's <a href="Model.html#modelData">modelData</a>.</p> </div> </li> <li> <h5>propname: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>a string that is not null or the empty string.</p> </div> </li> <li> <h5>val: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>the new value for the property.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setParentKeyForNodeData" class="tsd-anchor"></a> <h3> set<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data<span class="tsd-signature-symbol">(</span>nodedata<span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a>, key<span class="tsd-signature-symbol">: </span><a href="../index.html#Key" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Change the parent node for the given node data, given a key for the new parent, or undefined if there should be no parent.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="TreeModel.html#nodeParentKeyProperty">nodeParentKeyProperty</a>, <a href="TreeModel.html#getParentKeyForNodeData">getParentKeyForNodeData</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>nodedata: <a href="ObjectData.html" class="tsd-signature-type">ObjectData</a></h5> <div class="tsd-comment tsd-typography"> <p>a JavaScript object represented by a node.</p> </div> </li> <li> <h5>key: <a href="../index.html#Key" class="tsd-signature-type">Key</a></h5> <div class="tsd-comment tsd-typography"> <p>This may be undefined if there should be no parent node data.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setParentLinkCategoryForNodeData" class="tsd-anchor"></a> <h3> set<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data<span class="tsd-signature-symbol">(</span>childdata<span class="tsd-signature-symbol">: </span><a href="ObjectData.html" class="tsd-signature-type">ObjectData</a>, cat<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Change the category for the parent link of a given child node data, a string naming the link template that the <a href="Diagram.html">Diagram</a> should use to represent the link.</p> <p>Changing the link template will cause any existing <a href="Link.html">Link</a> to be removed from the <a href="Diagram.html">Diagram</a> and replaced with a new <a href="Link.html">Link</a> created by copying the new link template and applying any data-bindings. Note that the new template must be an instance of the same class as the original link. Thus one cannot change the category of a link from an instance of <a href="Link.html">Link</a> to an instance of a subclass of Link, nor vice-versa.</p> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="TreeModel.html#parentLinkCategoryProperty">parentLinkCategoryProperty</a>, <a href="TreeModel.html#getParentLinkCategoryForNodeData">getParentLinkCategoryForNodeData</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>childdata: <a href="ObjectData.html" class="tsd-signature-type">ObjectData</a></h5> <div class="tsd-comment tsd-typography"> <p>a JavaScript object represented by a node data.</p> </div> </li> <li> <h5>cat: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Must not be null.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </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-class"> <a href="TreeModel.html" class="tsd-kind-icon">Tree<wbr>Model</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="TreeModel.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="TreeModel.html#nodeParentKeyProperty" class="tsd-kind-icon">node<wbr>Parent<wbr>Key<wbr>Property</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="TreeModel.html#parentLinkCategoryProperty" class="tsd-kind-icon">parent<wbr>Link<wbr>Category<wbr>Property</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="TreeModel.html#copyNodeData" class="tsd-kind-icon">copy<wbr>Node<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="TreeModel.html#getParentKeyForNodeData" class="tsd-kind-icon">get<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="TreeModel.html#getParentLinkCategoryForNodeData" class="tsd-kind-icon">get<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="TreeModel.html#setDataProperty" class="tsd-kind-icon">set<wbr>Data<wbr>Property</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="TreeModel.html#setParentKeyForNodeData" class="tsd-kind-icon">set<wbr>Parent<wbr>Key<wbr>For<wbr>Node<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="TreeModel.html#setParentLinkCategoryForNodeData" class="tsd-kind-icon">set<wbr>Parent<wbr>Link<wbr>Category<wbr>For<wbr>Node<wbr>Data</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <div class="container-fluid bottom-copyright plr15"> Copyright © 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>