UNPKG

markgojs

Version:

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

6,495 lines • 394 kB
<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>GoJS&reg; Diagram Class</title>
        
        <script src="../../assets/js/jquery.min.js"></script>
    <script src="../../assets/js/bootstrap.min.js"></script>
    <script src="../../assets/js/highlight.js"></script>
    <script src="../../assets/js/api.js"></script>
    <script src="../../assets/js/fuse.min.js"></script>

    <link href="../../assets/css/bootstrap.min.css" rel="stylesheet" >
    <!-- custom CSS after bootstrap -->
    <link href="../../assets/css/main.css" rel="stylesheet" type="text/css"/>
    <link href="../../assets/css/api.css" rel="stylesheet" type="text/css"/>
    <!--<link rel="stylesheet" href="../../assets/css/api.css" type="text/css" media="all" />-->
    <link rel="stylesheet" href="../../assets/css/highlight.css" type="text/css" media="all" />

    </head>

    <body>
    <!-- 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">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="container-fluid">

<!-- ============================== classes index ============================ -->
     <div id="navindex" class="col-md-2">
        <!-- begin publish.classesIndex -->
        <!-- <div><a href="../index.html">GoJS Class Index</a></div> -->

<div class="sidebar-nav">
  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#DiagramNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#DiagramNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Diagram Classes</span>
      </div>
    </div>
    <div id="DiagramNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        <li><a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a></li>
      
        <li><a href="../symbols/AnimationManager.html" class="linkConstructor">AnimationManager</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a></li>
      
        
      
        <li><a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a></li>
      
        <li><a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a></li>
      
        
      
        <li><a href="../symbols/Group.html" class="linkConstructor">Group</a></li>
      
        
      
        <li><a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a></li>
      
        
      
        
      
        <li><a href="../symbols/Layer.html" class="linkConstructor">Layer</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Link.html" class="linkConstructor">Link</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Node.html" class="linkConstructor">Node</a></li>
      
        <li><a href="../symbols/Overview.html" class="linkConstructor">Overview</a></li>
      
        <li><a href="../symbols/Palette.html" class="linkConstructor">Palette</a></li>
      
        <li><a href="../symbols/Panel.html" class="linkConstructor">Panel</a></li>
      
        
      
        <li><a href="../symbols/Part.html" class="linkConstructor">Part</a></li>
      
        
      
        
      
        <li><a href="../symbols/Picture.html" class="linkConstructor">Picture</a></li>
      
        <li><a href="../symbols/Placeholder.html" class="linkConstructor">Placeholder</a></li>
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/RowColumnDefinition.html" class="linkConstructor">RowColumnDefinition</a></li>
      
        
      
        <li><a href="../symbols/Shape.html" class="linkConstructor">Shape</a></li>
      
        
      
        
      
        <li><a href="../symbols/TextBlock.html" class="linkConstructor">TextBlock</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#GeometryNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#GeometryNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Geometry Classes</span>
      </div>
    </div>
    <div id="GeometryNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Brush.html" class="linkConstructor">Brush</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Geometry.html" class="linkConstructor">Geometry</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Margin.html" class="linkConstructor">Margin</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/PathFigure.html" class="linkConstructor">PathFigure</a></li>
      
        <li><a href="../symbols/PathSegment.html" class="linkConstructor">PathSegment</a></li>
      
        
      
        
      
        <li><a href="../symbols/Point.html" class="linkConstructor">Point</a></li>
      
        <li><a href="../symbols/Rect.html" class="linkConstructor">Rect</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Size.html" class="linkConstructor">Size</a></li>
      
        <li><a href="../symbols/Spot.html" class="linkConstructor">Spot</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#ModelNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#ModelNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Model Classes</span>
      </div>
    </div>
    <div id="ModelNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Binding.html" class="linkConstructor">Binding</a></li>
      
        
      
        <li><a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/GraphLinksModel.html" class="linkConstructor">GraphLinksModel</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Model.html" class="linkConstructor">Model</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Transaction.html" class="linkConstructor">Transaction</a></li>
      
        
      
        
      
        <li><a href="../symbols/TreeModel.html" class="linkConstructor">TreeModel</a></li>
      
        
      
        
      
        <li><a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a></li>
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#LayoutNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#LayoutNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Layout Classes</span>
      </div>
    </div>
    <div id="LayoutNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/CircularLayout.html" class="linkConstructor">CircularLayout</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/ForceDirectedLayout.html" class="linkConstructor">ForceDirectedLayout</a></li>
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/GridLayout.html" class="linkConstructor">GridLayout</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/LayeredDigraphLayout.html" class="linkConstructor">LayeredDigraphLayout</a></li>
      
        
      
        
      
        <li><a href="../symbols/Layout.html" class="linkConstructor">Layout</a></li>
      
        
      
        <li><a href="../symbols/LayoutNetwork.html" class="linkConstructor">LayoutNetwork</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/TreeLayout.html" class="linkConstructor">TreeLayout</a></li>
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#ToolNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#ToolNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Tool Classes</span>
      </div>
    </div>
    <div id="ToolNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        <li><a href="../symbols/ActionTool.html" class="linkConstructor">ActionTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/ClickCreatingTool.html" class="linkConstructor">ClickCreatingTool</a></li>
      
        <li><a href="../symbols/ClickSelectingTool.html" class="linkConstructor">ClickSelectingTool</a></li>
      
        
      
        <li><a href="../symbols/ContextMenuTool.html" class="linkConstructor">ContextMenuTool</a></li>
      
        
      
        
      
        <li><a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a></li>
      
        <li><a href="../symbols/DragSelectingTool.html" class="linkConstructor">DragSelectingTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/HTMLInfo.html" class="linkConstructor">HTMLInfo</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/LinkingBaseTool.html" class="linkConstructor">LinkingBaseTool</a></li>
      
        <li><a href="../symbols/LinkingTool.html" class="linkConstructor">LinkingTool</a></li>
      
        <li><a href="../symbols/LinkReshapingTool.html" class="linkConstructor">LinkReshapingTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/PanningTool.html" class="linkConstructor">PanningTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/RelinkingTool.html" class="linkConstructor">RelinkingTool</a></li>
      
        <li><a href="../symbols/ResizingTool.html" class="linkConstructor">ResizingTool</a></li>
      
        <li><a href="../symbols/RotatingTool.html" class="linkConstructor">RotatingTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/TextEditingTool.html" class="linkConstructor">TextEditingTool</a></li>
      
        <li><a href="../symbols/Tool.html" class="linkConstructor">Tool</a></li>
      
        <li><a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#CollectionNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#CollectionNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Collection Classes</span>
      </div>
    </div>
    <div id="CollectionNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Iterable.html" class="linkConstructor">Iterable</a></li>
      
        <li><a href="../symbols/Iterator.html" class="linkConstructor">Iterator</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/List.html" class="linkConstructor">List</a></li>
      
        <li><a href="../symbols/Map.html" class="linkConstructor">Map</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Set.html" class="linkConstructor">Set</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>
</div> <!-- /class="sidebar-nav -->




        <!-- end publish.classesIndex -->
    </div>

    <div id="contentBody" class="col-md-10">

        <div class="searchsumm">
            <div class="table-wrap">
                <div class="table-cell" id="apisearch" data-base="../">
                    <div class="title">Search API</div>
                    <div class="field">
                        <label for="search-field" class="search-icon"></label>
                        <input id="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>
                </div>
                <div class="table-cell" id="apisumm">
                    <input type="checkbox" id="showsumms" />
                    <label class="apisumms" for="showsumms">Show Summaries</label>
                </div>
            </div>
        </div>

    <!-- ============================== header ================================= -->
    <div id="header" class="fineprint">
      <b>GoJS</b>&reg; Diagramming Components<br/>version 1.8.36 for JavaScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a>
    </div>

<!-- ============================== class title ============================ -->
            <h2 class="classTitle">
                
                Class Diagram
                
            </h2>

<!-- ============================== class summary ========================== -->
            <p class="classsummary">
                
                

                A Diagram is associated with an HTML DIV element. Constructing a Diagram creates
an HTML Canvas element which it places inside of the given DIV element, in addition to several helper DIVs.
<b>GoJS</b> will manage the contents of this DIV -- you should not modify the contents of the DIV,
although you may style the given DIV (background, border, etc) and position and size it as needed.
<p>
Minimal Diagram construction looks like this. HTML:

 <pre class="html">&lt;div id="myDiagramDiv" style="border: solid 1px black; width:400px; height:400px"&gt;&lt;/div&gt;</pre>
 <p>
 JavaScript:
 <pre class="javascript">var $ = go.GraphObject.make;  // for conciseness

 myDiagram = $(go.Diagram, "myDiagramDiv",  // create a Diagram for the DIV HTML element
               {
                 initialContentAlignment: go.Spot.Center,  // center the content
                 "undoManager.isEnabled": true  // enable undo & redo
               });</pre>

<p>
The diagram will draw onto an HTML Canvas element, created inside the Diagram DIV.
<p>
Each Diagram holds a set of <a href="../symbols/Layer.html" class="linkConstructor">Layer</a>s each of which holds some number of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s
such as <a href="../symbols/Node.html" class="linkConstructor">Node</a>s and <a href="../symbols/Link.html" class="linkConstructor">Link</a>s.
Each <a href="../symbols/Part.html" class="linkConstructor">Part</a> consists of <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s such as <a href="../symbols/TextBlock.html" class="linkConstructor">TextBlock</a>s and <a href="../symbols/Shape.html" class="linkConstructor">Shape</a>s
and <a href="../symbols/Panel.html" class="linkConstructor">Panel</a>s holding yet more GraphObjects.
<p>
A Diagram and its Parts provide the visual representation of a <a href="../symbols/Model.html" class="linkConstructor">Model</a> that holds JavaScript
data objects for the nodes and the links.
The model provides the way to recognize the relationships between the data.
<p class="boxrun">
Two Diagrams can display and manipulate the same Model. (<a href="../../samples/updateDemo.html">Example</a>)
<p>
A diagram will automatically create <a href="../symbols/Node.html" class="linkConstructor">Node</a>s and <a href="../symbols/Link.html" class="linkConstructor">Link</a>s corresponding to the model data.
The diagram has a number of named templates it uses to create the actual parts:
<a href="../symbols/Diagram.html#nodeTemplateMap" class="linkProperty">nodeTemplateMap</a>, <a href="../symbols/Diagram.html#groupTemplateMap" class="linkProperty">groupTemplateMap</a>, and <a href="../symbols/Diagram.html#linkTemplateMap" class="linkProperty">linkTemplateMap</a>.
Each template may have some data <a href="../symbols/Binding.html" class="linkConstructor">Binding</a>s that set the part's <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s' properties
based on the value of properties of the data.
<p>
A simple Node template and Model data (both nodes and links) may look like this:

<pre class="javascript">var $ = go.GraphObject.make;  // for conciseness

// define a simple Node template
myDiagram.nodeTemplate =
  $(go.Node, "Auto",  // the Shape will go around the TextBlock
    $(go.Shape, "RoundedRectangle",
      // Shape.fill is bound to Node.data.color
      new go.Binding("fill", "color")),
    $(go.TextBlock,
      { margin: 3 },  // some room around the text
      // TextBlock.text is bound to Node.data.key
      new go.Binding("text", "key"))
  );

// create the model data that will be represented by Nodes and Links
myDiagram.model = new go.GraphLinksModel(
[
  { key: "Alpha", color: "lightblue" },
  { key: "Beta", color: "orange" },
  { key: "Gamma", color: "lightgreen" },
  { key: "Delta", color: "pink" }
],
[
  { from: "Alpha", to: "Beta" },
  { from: "Alpha", to: "Gamma" },
  { from: "Beta", to: "Beta" },
  { from: "Gamma", to: "Delta" },
  { from: "Delta", to: "Alpha" }
]);</pre>
<p class="boxrun">
The above code is used to make the <a href="../../samples/minimal.html">Minimal sample</a>, a simple example of
creating a Diagram and setting its model.
<p class="boxread">
Read about models on the <a href="../../intro/usingModels.html">Using Models</a> page in the introduction.
A diagram is responsible for scrolling (<a href="../symbols/Diagram.html#position" class="linkProperty">position</a>) and zooming (<a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>) all of the parts that it shows.
Each <a href="../symbols/Part.html" class="linkConstructor">Part</a> occupies some area given by its <a href="../symbols/GraphObject.html#actualBounds" class="linkProperty">GraphObject.actualBounds</a>.
<p>
The union of all of the parts' bounds constitutes the <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">documentBounds</a>.
The document bounds determines the area that the diagram can be scrolled to.
There are several properties that you can set, such as <a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a>,
that control the initial size and position of the diagram contents.
<p>
At any later time you can also explicitly set the <a href="../symbols/Diagram.html#position" class="linkProperty">position</a> and/or <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a> to
get the appearance that you want.  But you may find it easier to call methods to get the desired effect.
For example, if you want to make a particular Node be centered in the viewport,
call either <a href="../symbols/Diagram.html#centerRect" class="linkMethod">centerRect</a> or <a href="../symbols/Diagram.html#scrollToRect" class="linkMethod">scrollToRect</a> with the Node's <a href="../symbols/GraphObject.html#actualBounds" class="linkProperty">GraphObject.actualBounds</a>,
depending on whether or not you want the view to be scrolled if the node is already in view.
<p class="boxread">
Read in the Introduction about <a href="../../intro/viewport.html">Viewports</a>
and the <a href="../../intro/initialView.html">Initial Viewport</a>.
You can have the diagram perform automatic layouts of its nodes and links by setting
<a href="../symbols/Diagram.html#layout" class="linkProperty">layout</a> to an instance of the <a href="../symbols/Layout.html" class="linkConstructor">Layout</a> subclass of your choice.
The default <a href="../symbols/Diagram.html#layout" class="linkProperty">layout</a> is an instance of the <a href="../symbols/Layout.html" class="linkConstructor">Layout</a> base class that ignores links and
only positions <a href="../symbols/Node.html" class="linkConstructor">Node</a>s that do not have a location.
This default layout will allow you to programmatically position nodes (including by loading
from a database) and will also allow the user to manually position nodes using the <a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a>.
<p>
If you do supply a particular layout as the <a href="../symbols/Diagram.html#layout" class="linkProperty">layout</a>, you can control which <a href="../symbols/Part.html" class="linkConstructor">Part</a>s it operates
on by setting <a href="../symbols/Part.html#isLayoutPositioned" class="linkProperty">Part.isLayoutPositioned</a>.
Normally, of course, it works on all top-level nodes and links.
The layout is performed both after the model is first loaded as well as after any part is added or removed
or changes visibility or size.
You can disable the initial layout by setting <a href="../symbols/Layout.html#isInitial" class="linkProperty">Layout.isInitial</a> to false.
You can disable later automatic layouts by setting <a href="../symbols/Layout.html#isOngoing" class="linkProperty">Layout.isOngoing</a> to false.
<p class="boxread">
See the <a href="../../intro/layouts.html">Layouts</a> page in the Introduction for a summary of layout behavior.
<p>
A diagram maintains a collection of selected parts, the <a href="../symbols/Diagram.html#selection" class="linkProperty">Diagram.selection</a>.
To select a Part you set its <a href="../symbols/Part.html#isSelected" class="linkProperty">Part.isSelected</a> property to true.
<p>
There are many properties, named "allow...", that control what operations the user
may perform on the parts in the diagram.  These correspond to the same named
properties on <a href="../symbols/Layer.html" class="linkConstructor">Layer</a> that govern the behavior for those parts in a particular layer.
Furthermore for some of these properties there are corresponding properties on
<a href="../symbols/Part.html" class="linkConstructor">Part</a>, named "...able", that govern the behavior for that individual part.
For example, the <a href="../symbols/Diagram.html#allowCopy" class="linkProperty">allowCopy</a> property corresponds to <a href="../symbols/Layer.html#allowCopy" class="linkProperty">Layer.allowCopy</a> and
to the property <a href="../symbols/Part.html#copyable" class="linkProperty">Part.copyable</a>.
The <a href="../symbols/Part.html#canCopy" class="linkMethod">Part.canCopy</a> predicate is false if any of these properties is false.
<p class="boxread">
See the <a href="../../intro/permissions.html">Permissions</a> page for a more thorough discussion.
<p>
The <a href="../symbols/Diagram.html#commandHandler" class="linkProperty">commandHandler</a> implements various standard commands,
such as the <a href="../symbols/CommandHandler.html#deleteSelection" class="linkMethod">CommandHandler.deleteSelection</a> method and the
<a href="../symbols/CommandHandler.html#canDeleteSelection" class="linkMethod">CommandHandler.canDeleteSelection</a> predicate.
<p class="boxread">
See the <a href="../../intro/commands.html">Commands</a> page for a listing of keyboard commands and
the use of commands in general.
<p>
The diagram supports modular behavior for mouse events by implementing "tools".
All mouse and keyboard events are represented by <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>s and redirected
to the <a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a>.
The default tool is an instance of <a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a> which keeps three lists of mode-less tools:
<a href="../symbols/ToolManager.html#mouseDownTools" class="linkProperty">ToolManager.mouseDownTools</a>, <a href="../symbols/ToolManager.html#mouseMoveTools" class="linkProperty">ToolManager.mouseMoveTools</a>, and <a href="../symbols/ToolManager.html#mouseUpTools" class="linkProperty">ToolManager.mouseUpTools</a>.
The ToolManager searches these lists when a mouse event happens to find the first tool that can run.
It then makes that tool the new <a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a>, where it can continue to process input events.
When the tool is done, it stops itself, causing the <a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a> to be the new <a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a>.
<p>
Mouse-down tools include:
<ul>
  <li><a href="../symbols/ToolManager.html#actionTool" class="linkProperty">ToolManager.actionTool</a>, to support objects like "buttons"</li>
  <li><a href="../symbols/ToolManager.html#relinkingTool" class="linkProperty">ToolManager.relinkingTool</a>, to reconnect an existing link</li>
  <li><a href="../symbols/ToolManager.html#linkReshapingTool" class="linkProperty">ToolManager.linkReshapingTool</a>, to modify the route of an existing link</li>
  <li><a href="../symbols/ToolManager.html#resizingTool" class="linkProperty">ToolManager.resizingTool</a>, to change the size of an object</li>
  <li><a href="../symbols/ToolManager.html#rotatingTool" class="linkProperty">ToolManager.rotatingTool</a>, to change the angle of an object</li>
</ul>
Mouse-move tools include:
<ul>
  <li><a href="../symbols/ToolManager.html#linkingTool" class="linkProperty">ToolManager.linkingTool</a>, to draw a new link</li>
  <li><a href="../symbols/ToolManager.html#draggingTool" class="linkProperty">ToolManager.draggingTool</a>, to move or copy the selection</li>
  <li><a href="../symbols/ToolManager.html#dragSelectingTool" class="linkProperty">ToolManager.dragSelectingTool</a>, to select parts within a rectangular area</li>
  <li><a href="../symbols/ToolManager.html#panningTool" class="linkProperty">ToolManager.panningTool</a>, to pan the diagram</li>
</ul>
Mouse-up tools include:
<ul>
  <li><a href="../symbols/ToolManager.html#contextMenuTool" class="linkProperty">ToolManager.contextMenuTool</a>, to manage context menus</li>
  <li><a href="../symbols/ToolManager.html#textEditingTool" class="linkProperty">ToolManager.textEditingTool</a>, to support in-place text editing</li>
  <li><a href="../symbols/ToolManager.html#clickCreatingTool" class="linkProperty">ToolManager.clickCreatingTool</a>, to create new parts where the user clicks</li>
  <li><a href="../symbols/ToolManager.html#clickSelectingTool" class="linkProperty">ToolManager.clickSelectingTool</a>, to select parts</li>
<p>
</ul>
<p>
You can also run a tool in a modal fashion by explicitly setting <a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a>.
That tool will keep running until some code replaces the <a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a>/
This normally happens when the current tool calls <a href="../symbols/Tool.html#stopTool" class="linkMethod">Tool.stopTool</a>, such as on a mouse-up event.
<p class="boxread">
See the <a href="../../intro/tools.html">Tools</a> page for a listing of predefined tools and how they operate.
<p>
A diagram raises various <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>s when interesting things happen that may have affected the whole diagram.
See the documentation for <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a> for a complete listing.
            </p>

<!-- ============================== constructor summary ==================== -->
            
        <h2 id="constructor" class="summaryCaption"> Constructor <span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
            <div class="table-responsive">
            <table class="summaryTable table table-bordered table-condensed" summary="A summary of the constructor documented in the class Diagram.">
                <thead>
                        <tr>
                            <th scope="col" class="name">Name</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                </thead>
                <tbody>
                    <tr>
                        <td class="name" >
                            <div class="name">
                                Diagram(div)
                            </div>
              </td>
              <td class="description">
                            <div class="description">
                            <!--newp--><p><p>Construct an empty Diagram for a particular DIV HTML element.<span class="nodetails" id="xconDiagram"><a class="morelink" onclick="hst('conDiagram')">More...</a></span> <span class="details" id="conDiagram">
</span><div class="details" id="dconDiagram"><p>
You will normally initialize properties of the Diagram that control its appearance and behavior.
These properties include:
<ul>
<li>templates (such as <a href="../symbols/Diagram.html#nodeTemplate" class="linkProperty">nodeTemplate</a> or <a href="../symbols/Diagram.html#linkSelectionAdornmentTemplate" class="linkProperty">linkSelectionAdornmentTemplate</a>),</li>
<li>an automatic layout (if desired, <a href="../symbols/Diagram.html#layout" class="linkProperty">layout</a>),</li>
<li>positioning or scaling (such as <a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a> or <a href="../symbols/Diagram.html#initialAutoScale" class="linkProperty">initialAutoScale</a>),</li>
<li>permissions (such as <a href="../symbols/Diagram.html#isReadOnly" class="linkProperty">isReadOnly</a> or <a href="../symbols/Diagram.html#allowDelete" class="linkProperty">allowDelete</a>), or</li>
<li>Tool or CommandHandler customization (such as <a href="../symbols/CommandHandler.html#archetypeGroupData" class="linkProperty">CommandHandler.archetypeGroupData</a> or
<a href="../symbols/Tool.html#isEnabled" class="linkProperty">Tool.isEnabled</a>): <code>diagram.toolManager.dragSelectingTool.isEnabled = false;</code>.</li>
</ul>
Then you will need to construct a Model (usually a <a href="../symbols/GraphLinksModel.html" class="linkConstructor">GraphLinksModel</a>) for the Diagram,
initialize its data by setting its <a href="../symbols/Model.html#nodeDataArray" class="linkProperty">Model.nodeDataArray</a> and other properties,
and then set the diagram's <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.
<p>
Finally, if you want to disassociate the Diagram from the HTML Div element, set <a href="../symbols/Diagram.html#div" class="linkProperty">Diagram.div</a> to null.
If you remove a part of the HTML DOM containing a Div with a Diagram, you will need to
set <a href="../symbols/Diagram.html#div" class="linkProperty">div</a> to null in order for the page to recover the memory.
<p>
It is commonplace to use the static function <a href="../symbols/GraphObject.html#.make" class="linkStatic">GraphObject.make</a> to build a Diagram:
<pre>
 var $ = go.GraphObject.make;

 var diagram =
   $(go.Diagram, "myDiagramDiv",
     {
       initialContentAlignment: go.Spot.Center,
       allowZoom: false,
       "animationManager.isEnabled": false,  // turn off automatic animations
       "grid.visible": true,  // display a background grid for the whole diagram
       "grid.gridCellSize": new go.Size(20, 20),
       // allow double-click in background to create a new node
       "clickCreatingTool.archetypeNodeData": { text: "Node" },
       // allow Ctrl-G to call the groupSelection command
       "commandHandler.archetypeGroupData":
           { text: "Group", isGroup: true, color: "blue" },
       "commandHandler.copiesTree": true,  // for the copy command
       "commandHandler.deletesTree": true, // for the delete command
       "toolManager.hoverDelay": 100,  // how quickly tooltips are shown
       // mouse wheel zooms instead of scrolls
       "toolManager.mouseWheelBehavior": go.ToolManager.WheelZoom,
       "draggingTool.dragsTree": true,  // dragging for both move and copy
       "draggingTool.isGridSnapEnabled": true,
       layout: $(go.TreeLayout,
                 { angle: 90, sorting: go.TreeLayout.SortingAscending }),
       "undoManager.isEnabled": true,  // enable undo & redo
       // a Changed listener on the Diagram.model
       "ModelChanged": function(e) { if (e.isTransactionFinished) saveModel(); }
     });
</pre></div>
                        
                            <dl class="detailList">
                            <dt class="heading">Parameters:</dt>
                            
                                <dt>
                                    <span class="light fixedFont">{Element|string=}</span>  <b>div</b>
                                    
                                </dt>
                                    <dd>A reference to a DIV HTML element or its ID as a string.
If no DIV is supplied one will be created in memory. The Diagram's <a href="../symbols/Diagram.html#div" class="linkProperty">Diagram.div</a> property
can then be set later on.</dd>
                            
                            </dl>
                        
                        


              </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            </div><!-- class="table-responsive">-->
            

<!-- ============================== properties summary ===================== -->
            
                
                
        <h2 class="summaryCaption">Properties<span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
        <div class="table-responsive">
        <table class="summaryTable table table-bordered table-condensed" summary="A summary of the properties documented in the class Diagram.">
                    <thead>
                        <tr>
                            <th scope="col" class="name">Name, Value Type</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                    
              <tr id="allowClipboard" >
                
                <td class="name">
                  <div class="name">
                    allowClipboard
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may copy to or paste parts from the internal clipboard.<span class="nodetails" id="xpropallowClipboard"><a class="morelink" onclick="hst('propallowClipboard')">More...</a></span> <span class="details" id="propallowClipboard">
This allows use of <a href="../symbols/CommandHandler.html#cutSelection" class="linkMethod">CommandHandler.cutSelection</a>,
<a href="../symbols/CommandHandler.html#copySelection" class="linkMethod">CommandHandler.copySelection</a> and <a href="../symbols/CommandHandler.html#pasteSelection" class="linkMethod">CommandHandler.pasteSelection</a>.
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowCopy" >
                
                <td class="name">
                  <div class="name">
                    allowCopy
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may copy objects.<span class="nodetails" id="xpropallowCopy"><a class="morelink" onclick="hst('propallowCopy')">More...</a></span> <span class="details" id="propallowCopy">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowDelete" >
                
                <td class="name">
                  <div class="name">
                    allowDelete
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may delete objects from the Diagram.<span class="nodetails" id="xpropallowDelete"><a class="morelink" onclick="hst('propallowDelete')">More...</a></span> <span class="details" id="propallowDelete">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowDragOut" >
                
                <td class="name">
                  <div class="name">
                    allowDragOut
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may start a drag-and-drop in this Diagram,
possibly dropping in a different element.<span class="nodetails" id="xpropallowDragOut"><a class="morelink" onclick="hst('propallowDragOut')">More...</a></span> <span class="details" id="propallowDragOut">
The initial value is false.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowDrop" >
                
                <td class="name">
                  <div class="name">
                    allowDrop
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may end a drag-and-drop operation in this Diagram.<span class="nodetails" id="xpropallowDrop"><a class="morelink" onclick="hst('propallowDrop')">More...</a></span> <span class="details" id="propallowDrop">
This is typically set to true when a Diagram is used with a <a href="../symbols/Palette.html" class="linkConstructor">Palette</a>.
</span><div class="details" id="dpropallowDrop"><p>
The initial value is false.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowGroup" >
                
                <td class="name">
                  <div class="name">
                    allowGroup
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may group parts together.<span class="nodetails" id="xpropallowGroup"><a class="morelink" onclick="hst('propallowGroup')">More...</a></span> <span class="details" id="propallowGroup">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowHorizontalScroll" >
                
                <td class="name">
                  <div class="name">
                    allowHorizontalScroll
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user is allowed to use the horizontal scrollbar.<span class="nodetails" id="xpropallowHorizontalScroll"><a class="morelink" onclick="hst('propallowHorizontalScroll')">More...</a></span> <span class="details" id="propallowHorizontalScroll">
The initial value is true.</span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#hasHorizontalScrollbar" class="linkProperty">hasHorizontalScrollbar</a></li>
                            
                                <li><a href="../symbols/Diagram.html#allowVerticalScroll" class="linkProperty">allowVerticalScroll</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowInsert" >
                
                <td class="name">
                  <div class="name">
                    allowInsert
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may add parts to the Diagram.<span class="nodetails" id="xpropallowInsert"><a class="morelink" onclick="hst('propallowInsert')">More...</a></span> <span class="details" id="propallowInsert">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowLink" >
                
                <td class="name">
                  <div class="name">
                    allowLink
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may draw new links.<span class="nodetails" id="xpropallowLink"><a class="morelink" onclick="hst('propallowLink')">More...</a></span> <span class="details" id="propallowLink">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowMove" >
                
                <td class="name">
                  <div class="name">
                    allowMove
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may move objects.<span class="nodetails" id="xpropallowMove"><a class="morelink" onclick="hst('propallowMove')">More...</a></span> <span class="details" id="propallowMove">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowRelink" >
                
                <td class="name">
                  <div class="name">
                    allowRelink
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may reconnect existing links.<span class="nodetails" id="xpropallowRelink"><a class="morelink" onclick="hst('propallowRelink')">More...</a></span> <span class="details" id="propallowRelink">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowReshape" >
                
                <td class="name">
                  <div class="name">
                    allowReshape
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may reshape parts.<span class="nodetails" id="xpropallowReshape"><a class="morelink" onclick="hst('propallowReshape')">More...</a></span> <span class="details" id="propallowReshape">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowResize" >
                
                <td class="name">
                  <div class="name">
                    allowResize
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may resize parts.<span class="nodetails" id="xpropallowResize"><a class="morelink" onclick="hst('propallowResize')">More...</a></span> <span class="details" id="propallowResize">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowRotate" >
                
                <td class="name">
                  <div class="name">
                    allowRotate
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may rotate parts.<span class="nodetails" id="xpropallowRotate"><a class="morelink" onclick="hst('propallowRotate')">More...</a></span> <span class="details" id="propallowRotate">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowSelect" >
                
                <td class="name">
                  <div class="name">
                    allowSelect
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may select objects.<span class="nodetails" id="xpropallowSelect"><a class="morelink" onclick="hst('propallowSelect')">More...</a></span> <span class="details" id="propallowSelect">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowTextEdit" >
                
                <td class="name">
                  <div class="name">
                    allowTextEdit
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may do in-place text editing.<span class="nodetails" id="xpropallowTextEdit"><a class="morelink" onclick="hst('propallowTextEdit')">More...</a></span> <span class="details" id="propallowTextEdit">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowUndo" >
                
                <td class="name">
                  <div class="name">
                    allowUndo
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may undo or redo any changes.<span class="nodetails" id="xpropallowUndo"><a class="morelink" onclick="hst('propallowUndo')">More...</a></span> <span class="details" id="propallowUndo">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowUngroup" >
                
                <td class="name">
                  <div class="name">
                    allowUngroup
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may ungroup existing groups.<span class="nodetails" id="xpropallowUngroup"><a class="morelink" onclick="hst('propallowUngroup')">More...</a></span> <span class="details" id="propallowUngroup">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowVerticalScroll" >
                
                <td class="name">
                  <div class="name">
                    allowVerticalScroll
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user is allowed to use the vertical scrollbar.<span class="nodetails" id="xpropallowVerticalScroll"><a class="morelink" onclick="hst('propallowVerticalScroll')">More...</a></span> <span class="details" id="propallowVerticalScroll">
The initial value is true.</span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#hasVerticalScrollbar" class="linkProperty">hasVerticalScrollbar</a></li>
                            
                                <li><a href="../symbols/Diagram.html#allowHorizontalScroll" class="linkProperty">allowHorizontalScroll</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="allowZoom" >
                
                <td class="name">
                  <div class="name">
                    allowZoom
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may zoom into or out of the Diagram.<span class="nodetails" id="xpropallowZoom"><a class="morelink" onclick="hst('propallowZoom')">More...</a></span> <span class="details" id="propallowZoom">
The initial value is true.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="animationManager" >
                
                <td class="name">
                  <div class="name">
                    animationManager
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/AnimationManager.html" class="linkConstructor">AnimationManager</a>}</span>
                    
                      <span class="since" title="since">1.4</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns the <a href="../symbols/AnimationManager.html" class="linkConstructor">AnimationManager</a> for this Diagram.<span class="nodetails" id="xpropanimationManager"><a class="morelink" onclick="hst('propanimationManager')">More...</a></span> <span class="details" id="propanimationManager">
</span><div class="details" id="dpropanimationManager"><p></div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="autoScale" >
                
                <td class="name">
                  <div class="name">
                    autoScale
                  </div>
                  <div class="attributes">
                    <span class="light">{EnumValue}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the autoScale behavior of the Diagram, controlling whether or not the
Diagram's bounds automatically scale to fit the view.<span class="nodetails" id="xpropautoScale"><a class="morelink" onclick="hst('propautoScale')">More...</a></span> <span class="details" id="propautoScale">
The only accepted values are the constant properties of Diagram,
<a href="../symbols/Diagram.html#None" class="linkConstant">Diagram.None</a>, <a href="../symbols/Diagram.html#Uniform" class="linkConstant">Diagram.Uniform</a>, or <a href="../symbols/Diagram.html#UniformToFill" class="linkConstant">Diagram.UniformToFill</a>.
Setting this will change the Diagram's <a href="../symbols/Diagram.html#scale" class="linkProperty">Diagram.scale</a> and <a href="../symbols/Diagram.html#position" class="linkProperty">Diagram.position</a>, if appropriate.
</span><div class="details" id="dpropautoScale"><p>
The default value is <a href="../symbols/Diagram.html#None" class="linkConstant">Diagram.None</a> - the scale and position are not automatically adjusted
according to the area covered by the document.
When the value is not None, any value for <a href="../symbols/Diagram.html#initialAutoScale" class="linkProperty">initialAutoScale</a> or <a href="../symbols/Diagram.html#initialScale" class="linkProperty">initialScale</a> is ignored.
<p class="box">
When autoScale is set to a non-<a href="../symbols/Diagram.html#None" class="linkConstant">Diagram.None</a> value,
the user will not be able to zoom, and setting <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a> will do nothing.
If you only want to scale automatically on initialization, use <a href="../symbols/Diagram.html#initialAutoScale" class="linkProperty">initialAutoScale</a>.
<p>
Note that depending on the values of <a href="../symbols/Diagram.html#maxScale" class="linkProperty">maxScale</a> and <a href="../symbols/Diagram.html#minScale" class="linkProperty">minScale</a>, the actual value for <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>
might be limited.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="autoScrollRegion" >
                
                <td class="name">
                  <div class="name">
                    autoScrollRegion
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Margin.html" class="linkConstructor">Margin</a>|number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the Margin that describes the Diagram's autoScrollRegion.<span class="nodetails" id="xpropautoScrollRegion"><a class="morelink" onclick="hst('propautoScrollRegion')">More...</a></span> <span class="details" id="propautoScrollRegion"> The default value is a Margin of 16 on all sides.
When the mouse drag point is within this region on the left or right sides,
the view will automatically scroll horizontally in that direction.  When the point is within
the region on the top or bottom, the view will automatically scroll
vertically in that direction.  You can specify a distance of zero to disable autoscrolling
in a direction; a value of 0,0,0,0 turns off autoscrolling altogether.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="click" >
                
                <td class="name">
                  <div class="name">
                    click
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user single-primary-clicks
on the background of the Diagram.<span class="nodetails" id="xpropclick"><a class="morelink" onclick="hst('propclick')">More...</a></span> <span class="details" id="propclick">
This typically involves a mouse-down followed by a prompt mouse-up
at approximately the same position using the left (primary) mouse button.
This property is used by the <a href="../symbols/ClickSelectingTool.html" class="linkConstructor">ClickSelectingTool</a>
when the user clicks on no object.
The function is called in addition to the <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>
that is raised with the name "BackgroundSingleClicked".
</span><div class="details" id="dpropclick"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
By default this property is null.
<p>
If you do provide a function that makes changes to the diagram or to its model,
you should do so within a transaction -- call <a href="../symbols/Diagram.html#startTransaction" class="linkMethod">startTransaction</a> and <a href="../symbols/Diagram.html#commitTransaction" class="linkMethod">commitTransaction</a>.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#doubleClick" class="linkProperty">doubleClick</a></li>
                            
                                <li><a href="../symbols/Diagram.html#contextClick" class="linkProperty">contextClick</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#click" class="linkProperty">GraphObject.click</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="commandHandler" >
                
                <td class="name">
                  <div class="name">
                    commandHandler
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the <a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a> for this Diagram.<span class="nodetails" id="xpropcommandHandler"><a class="morelink" onclick="hst('propcommandHandler')">More...</a></span> <span class="details" id="propcommandHandler">
</span><div class="details" id="dpropcommandHandler"><p>
This is set to a new instance of <a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a> on Diagram instantiation.
<p>
Setting this property does not notify about any changed event; the new value must not be null.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="contentAlignment" >
                
                <td class="name">
                  <div class="name">
                    contentAlignment
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the content alignment <a href="../symbols/Spot.html" class="linkConstructor">Spot</a> of this Diagram, to be used in determining
how parts are positioned when the <a href="../symbols/Diagram.html#viewportBounds" class="linkProperty">viewportBounds</a> width or height is smaller than the <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">documentBounds</a>.<span class="nodetails" id="xpropcontentAlignment"><a class="morelink" onclick="hst('propcontentAlignment')">More...</a></span> <span class="details" id="propcontentAlignment">
</span><div class="details" id="dpropcontentAlignment"><p>
For instance a spot of <a href="../symbols/Spot.html#Center" class="linkConstant">Spot.Center</a> would ensure that the Diagram's
contents are always centered in the viewport.
<p>
If you want the content to be aligned only initially, use <a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a> instead.
<p>
The default value is <a href="../symbols/Spot.html#Default" class="linkConstant">Spot.Default</a>, which causes no automatic scrolling or positioning.
When the value is not Default, any value for <a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a> or <a href="../symbols/Diagram.html#initialPosition" class="linkProperty">initialPosition</a> is ignored.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="contextClick" >
                
                <td class="name">
                  <div class="name">
                    contextClick
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user single-secondary-clicks
on the background of the Diagram.<span class="nodetails" id="xpropcontextClick"><a class="morelink" onclick="hst('propcontextClick')">More...</a></span> <span class="details" id="propcontextClick">
This typically involves a mouse-down followed by a prompt mouse-up
at approximately the same position using the right (secondary) mouse button.
This property is used by the <a href="../symbols/ClickSelectingTool.html" class="linkConstructor">ClickSelectingTool</a>
when the user clicks on no object.
The function is called in addition to the <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>
that is raised with the name "BackgroundContextClicked".
</span><div class="details" id="dpropcontextClick"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
By default this property is null.
<p>
If you do provide a function that makes changes to the diagram or to its model,
you should do so within a transaction -- call <a href="../symbols/Diagram.html#startTransaction" class="linkMethod">startTransaction</a> and <a href="../symbols/Diagram.html#commitTransaction" class="linkMethod">commitTransaction</a>.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#click" class="linkProperty">click</a></li>
                            
                                <li><a href="../symbols/Diagram.html#doubleClick" class="linkProperty">doubleClick</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#contextClick" class="linkProperty">GraphObject.contextClick</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="contextMenu" >
                
                <td class="name">
                  <div class="name">
                    contextMenu
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a>|<a href="../symbols/HTMLInfo.html" class="linkConstructor">HTMLInfo</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This <a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a> or <a href="../symbols/HTMLInfo.html" class="linkConstructor">HTMLInfo</a> is shown when the use context clicks in the background.<span class="nodetails" id="xpropcontextMenu"><a class="morelink" onclick="hst('propcontextMenu')">More...</a></span> <span class="details" id="propcontextMenu">
The default value is null, which means no context menu is shown.
On touch devices, a special default context menu will appear even there is no context menu defined.
See <a href="../symbols/ContextMenuTool.html#defaultTouchContextMenu" class="linkProperty">ContextMenuTool.defaultTouchContextMenu</a> for details.
</span><div class="details" id="dpropcontextMenu"><p>
<pre>
 diagram.contextMenu =
   $(go.Adornment, "Vertical",
     $("ContextMenuButton",
       $(go.TextBlock, "Undo"),
       { click: function(e, obj) { e.diagram.commandHandler.undo(); } },
       new go.Binding("visible", "", function(o) {
           return o.diagram.commandHandler.canUndo();
         }).ofObject()),
     $("ContextMenuButton",
       $(go.TextBlock, "Redo"),
       { click: function(e, obj) { e.diagram.commandHandler.redo(); } },
       new go.Binding("visible", "", function(o) {
           return o.diagram.commandHandler.canRedo();
         }).ofObject())
   );
</pre></div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/GraphObject.html#contextMenu" class="linkProperty">GraphObject.contextMenu</a></li>
                            
                                <li><a href="../symbols/ContextMenuTool.html" class="linkConstructor">ContextMenuTool</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="currentCursor" >
                
                <td class="name">
                  <div class="name">
                    currentCursor
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the current cursor for the Diagram, overriding the <a href="../symbols/Diagram.html#defaultCursor" class="linkProperty">defaultCursor</a>.<span class="nodetails" id="xpropcurrentCursor"><a class="morelink" onclick="hst('propcurrentCursor')">More...</a></span> <span class="details" id="propcurrentCursor">
</span><div class="details" id="dpropcurrentCursor"><p>
Valid CSS cursors are accepted,
such as "auto", "default", "none", "context-menu", "help", "pointer", "progress", "wait", etc.
<p>
It is possible to use custom cursors with the syntax "url(path_to_image), default".
A fallback (like default here) is necessary for a custom cursor to work.
<p>
To read more about cursor syntax, go to:
<a href="https://developer.mozilla.org/en-US/docs/Web/CSS/cursor">CSS cursors (mozilla.org)</a>.
<p>
If the specified cursor is not accepted by the platform, GoJS will append
<code>-webkit-</code> or <code>-moz-</code> prefixes.
<p>
Setting this property does not notify about any changed event.
Setting this value to the empty string ('') returns the Diagram's cursor to the <a href="../symbols/Diagram.html#defaultCursor" class="linkProperty">defaultCursor</a>.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#defaultCursor" class="linkProperty">defaultCursor</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#cursor" class="linkProperty">GraphObject.cursor</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="currentTool" >
                
                <td class="name">
                  <div class="name">
                    currentTool
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Tool.html" class="linkConstructor">Tool</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the current tool for this Diagram that handles all input events.<span class="nodetails" id="xpropcurrentTool"><a class="morelink" onclick="hst('propcurrentTool')">More...</a></span> <span class="details" id="propcurrentTool">
This value is frequently replaced by the <a href="../symbols/Diagram.html#toolManager" class="linkProperty">toolManager</a> as different tools run.
</span><div class="details" id="dpropcurrentTool"><p>
Each Diagram has a number of tools that define its behavior when responding to mouse events.
These include <a href="../symbols/ClickSelectingTool.html" class="linkConstructor">ClickSelectingTool</a>, <a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a>, <a href="../symbols/DragSelectingTool.html" class="linkConstructor">DragSelectingTool</a>, <a href="../symbols/LinkingTool.html" class="linkConstructor">LinkingTool</a>, and <a href="../symbols/ResizingTool.html" class="linkConstructor">ResizingTool</a>, among others.
<p>
Initially this is set to the value of <a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a>.
Setting this to a null value is treated as if it were set to the <a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a>,
because there should always be a currently running tool, except when the diagram is being initialized.
<p>
A <a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a> is the default tool used by a Diagram - it chooses to run one of the other tools
depending on the circumstances.
<p>
Setting this property to a new tool stops the previous current tool
<p>
Setting this property does not notify about any changed event.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a></li>
                            
                                <li><a href="../symbols/Diagram.html#toolManager" class="linkProperty">toolManager</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="defaultCursor" >
                
                <td class="name">
                  <div class="name">
                    defaultCursor
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the cursor to be used for the Diagram
when no <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a> specifies a different cursor.<span class="nodetails" id="xpropdefaultCursor"><a class="morelink" onclick="hst('propdefaultCursor')">More...</a></span> <span class="details" id="propdefaultCursor">
</span><div class="details" id="dpropdefaultCursor"><p>
Valid CSS cursors are accepted,
such as "auto", "default", "none", "context-menu", "help", "pointer", "progress", "wait", etc.
<p>
It is possible to use custom cursors with the syntax "url(path_to_image), default".
A fallback (like default here) is necessary for a custom cursor to work.
<p>
To read more about cursor syntax, go to:
<a href="https://developer.mozilla.org/en-US/docs/Web/CSS/cursor">CSS cursors (mozilla.org)</a>.
The default value is "auto".</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#currentCursor" class="linkProperty">currentCursor</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#cursor" class="linkProperty">GraphObject.cursor</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="defaultTool" >
                
                <td class="name">
                  <div class="name">
                    defaultTool
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Tool.html" class="linkConstructor">Tool</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the default tool for this Diagram that becomes the current tool when the current tool stops.<span class="nodetails" id="xpropdefaultTool"><a class="morelink" onclick="hst('propdefaultTool')">More...</a></span> <span class="details" id="propdefaultTool">
Initially this value is the same tool as <a href="../symbols/Diagram.html#toolManager" class="linkProperty">toolManager</a>, which is an instance of <a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a>.
</span><div class="details" id="dpropdefaultTool"><p>
Setting this property also sets the <a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a> if the old default tool is the currently running tool.
<p>
Setting this property does not notify about any changed event; the new value must not be null.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a></li>
                            
                                <li><a href="../symbols/Diagram.html#toolManager" class="linkProperty">toolManager</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="div" >
                
                <td class="name">
                  <div class="name">
                    div
                  </div>
                  <div class="attributes">
                    <span class="light">{HTMLDivElement}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the Diagram's HTMLDivElement, via an HTML Element ID.<span class="nodetails" id="xpropdiv"><a class="morelink" onclick="hst('propdiv')">More...</a></span> <span class="details" id="propdiv">
This is typically set automatically when a Div is supplied as an argument to Diagram's constructor.
</span><div class="details" id="dpropdiv"><p>
Setting this property to a new value will clobber any HTML and
inner DOM elements inside of both the new and the old divs.
It will then populate the Div with the elements
(inner Divs, Canvases) needed for the Diagram to function.
<p>
If you want to disassociate the Diagram from the HTML Div element, set <a href="../symbols/Diagram.html#div" class="linkProperty">Diagram.div</a> to null.
If you remove a part of the HTML DOM containing a Div with a Diagram, you will need to
set <a href="../symbols/Diagram.html#div" class="linkProperty">div</a> to null in order for the page to recover the memory.
<p>
You should not attempt to manually modify the contents of this Div.
Changing this property value does not raise a Changed event.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="documentBounds" >
                
                <td class="name">
                  <div class="name">
                    documentBounds
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns the bounds of the diagram's contents, in document coordinates.<span class="nodetails" id="xpropdocumentBounds"><a class="morelink" onclick="hst('propdocumentBounds')">More...</a></span> <span class="details" id="propdocumentBounds">
</span><div class="details" id="dpropdocumentBounds"><p>
This is normally computed and set by <a href="../symbols/Diagram.html#computeBounds" class="linkMethod">computeBounds</a> during Diagram updates
that can occur for any number of relevant reasons, such as a <a href="../symbols/Part.html" class="linkConstructor">Part</a> changing size.
<p>
The Diagram's documentBounds can have an unvarying specific value
by setting the <a href="../symbols/Diagram.html#fixedBounds" class="linkProperty">fixedBounds</a> property.
<p>
If the documentBounds are larger than the <a href="../symbols/Diagram.html#viewportBounds" class="linkProperty">viewportBounds</a>,
scrollbars will appear on desktop browsers. You can disable scrolling with the
<a href="../symbols/Diagram.html#allowHorizontalScroll" class="linkProperty">allowHorizontalScroll</a> and <a href="../symbols/Diagram.html#allowVerticalScroll" class="linkProperty">allowVerticalScroll</a> properties, and
you can disable scrollbars themselves with the <a href="../symbols/Diagram.html#hasHorizontalScrollbar" class="linkProperty">hasHorizontalScrollbar</a>
and <a href="../symbols/Diagram.html#hasVerticalScrollbar" class="linkProperty">hasVerticalScrollbar</a> properties.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="doubleClick" >
                
                <td class="name">
                  <div class="name">
                    doubleClick
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user double-primary-clicks
on the background of the Diagram.<span class="nodetails" id="xpropdoubleClick"><a class="morelink" onclick="hst('propdoubleClick')">More...</a></span> <span class="details" id="propdoubleClick">
This typically involves a mouse-down/up/down/up in rapid succession
at approximately the same position using the left (primary) mouse button.
This property is used by the <a href="../symbols/ClickSelectingTool.html" class="linkConstructor">ClickSelectingTool</a>
when the user clicks on no object.
The function is called in addition to the <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>
that is raised with the name "BackgroundDoubleClicked".
</span><div class="details" id="dpropdoubleClick"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
By default this property is null.
<p>
If you do provide a function that makes changes to the diagram or to its model,
you should do so within a transaction -- call <a href="../symbols/Diagram.html#startTransaction" class="linkMethod">startTransaction</a> and <a href="../symbols/Diagram.html#commitTransaction" class="linkMethod">commitTransaction</a>.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#click" class="linkProperty">click</a></li>
                            
                                <li><a href="../symbols/Diagram.html#contextClick" class="linkProperty">contextClick</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#doubleClick" class="linkProperty">GraphObject.doubleClick</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="firstInput" >
                
                <td class="name">
                  <div class="name">
                    firstInput
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the most recent mouse-down <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a> that occurred.<span class="nodetails" id="xpropfirstInput"><a class="morelink" onclick="hst('propfirstInput')">More...</a></span> <span class="details" id="propfirstInput">
</span><div class="details" id="dpropfirstInput"><p>
Setting this property does not notify about any changed event.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#lastInput" class="linkProperty">lastInput</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="fixedBounds" >
                
                <td class="name">
                  <div class="name">
                    fixedBounds
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets a fixed bounding rectangle to be returned by <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">documentBounds</a>
and <a href="../symbols/Diagram.html#computeBounds" class="linkMethod">computeBounds</a>.<span class="nodetails" id="xpropfixedBounds"><a class="morelink" onclick="hst('propfixedBounds')">More...</a></span> <span class="details" id="propfixedBounds">
By default this has Double.NaN values, meaning that <a href="../symbols/Diagram.html#computeBounds" class="linkMethod">computeBounds</a>
will compute the union of all of the parts in the Diagram to determine the <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">documentBounds</a>.
If all x/y/width/height values are real numbers, this value is used as the <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">documentBounds</a>.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="grid" >
                
                <td class="name">
                  <div class="name">
                    grid
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Panel.html" class="linkConstructor">Panel</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets a <a href="../symbols/Panel.html" class="linkConstructor">Panel</a> of type <a href="../symbols/Panel.html#Grid" class="linkConstant">Panel.Grid</a> acting as the background grid
extending across the whole viewport of this diagram.
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="groupSelectionAdornmentTemplate" >
                
                <td class="name">
                  <div class="name">
                    groupSelectionAdornmentTemplate
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the default selection <a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a> template, used to adorn selected Groups.<span class="nodetails" id="xpropgroupSelectionAdornmentTemplate"><a class="morelink" onclick="hst('propgroupSelectionAdornmentTemplate')">More...</a></span> <span class="details" id="propgroupSelectionAdornmentTemplate">
</span><div class="details" id="dpropgroupSelectionAdornmentTemplate"><p>
Each <a href="../symbols/Group.html" class="linkConstructor">Group</a> can have its own <a href="../symbols/Part.html#selectionAdornmentTemplate" class="linkProperty">Part.selectionAdornmentTemplate</a>, which if non-null will take precedence over this Diagram property.
<p>
This Adornment must not be in the visual tree of any Diagram.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="groupTemplate" >
                
                <td class="name">
                  <div class="name">
                    groupTemplate
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Group.html" class="linkConstructor">Group</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the default <a href="../symbols/Group.html" class="linkConstructor">Group</a> template used as the archetype
for group data that is added to the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.<span class="nodetails" id="xpropgroupTemplate"><a class="morelink" onclick="hst('propgroupTemplate')">More...</a></span> <span class="details" id="propgroupTemplate">
</span><div class="details" id="dpropgroupTemplate"><p>
Setting this property just modifies the <a href="../symbols/Diagram.html#groupTemplateMap" class="linkProperty">groupTemplateMap</a>
by replacing the entry named with the empty string.
The value must not be null and must be a <a href="../symbols/Group.html" class="linkConstructor">Group</a>, not a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or simple <a href="../symbols/Part.html" class="linkConstructor">Part</a>.
This Part must not be in the visual tree of any Diagram.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="groupTemplateMap" >
                
                <td class="name">
                  <div class="name">
                    groupTemplateMap
                  </div>
                  <div class="attributes">
                    <span class="light">{Map.<string,Group>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets a <a href="../symbols/Map.html" class="linkConstructor">Map</a> mapping template names to <a href="../symbols/Group.html" class="linkConstructor">Group</a>s.<span class="nodetails" id="xpropgroupTemplateMap"><a class="morelink" onclick="hst('propgroupTemplateMap')">More...</a></span> <span class="details" id="propgroupTemplateMap">
These groups are copied for each group data that is added to the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.
</span><div class="details" id="dpropgroupTemplateMap"><p>
The new value must not be null, nor may it contain a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or <a href="../symbols/Link.html" class="linkConstructor">Link</a> or simple <a href="../symbols/Part.html" class="linkConstructor">Part</a>.
The Links must not be in the visual tree of any Diagram.
Replacing this Map will automatically call <a href="../symbols/Diagram.html#rebuildParts" class="linkMethod">rebuildParts</a>.
<p>
If you modify this <a href="../symbols/Map.html" class="linkConstructor">Map</a>, by replacing a <a href="../symbols/Group.html" class="linkConstructor">Group</a> in it or by adding or
removing a map entry, you need to explicitly call <a href="../symbols/Diagram.html#rebuildParts" class="linkMethod">rebuildParts</a> afterwards.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="hasHorizontalScrollbar" >
                
                <td class="name">
                  <div class="name">
                    hasHorizontalScrollbar
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the Diagram has a horizontal Scrollbar.<span class="nodetails" id="xprophasHorizontalScrollbar"><a class="morelink" onclick="hst('prophasHorizontalScrollbar')">More...</a></span> <span class="details" id="prophasHorizontalScrollbar">
</span><div class="details" id="dprophasHorizontalScrollbar"><p>
To enable or disable scrolling itself, use <a href="../symbols/Diagram.html#allowHorizontalScroll" class="linkProperty">allowHorizontalScroll</a> and <a href="../symbols/Diagram.html#allowVerticalScroll" class="linkProperty">allowVerticalScroll</a>.
<p>
Adding or removing a scrollbar modifies the diagram's viewport.
<p>
The initial value is true.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#allowHorizontalScroll" class="linkProperty">allowHorizontalScroll</a></li>
                            
                                <li><a href="../symbols/Diagram.html#hasVerticalScrollbar" class="linkProperty">hasVerticalScrollbar</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="hasVerticalScrollbar" >
                
                <td class="name">
                  <div class="name">
                    hasVerticalScrollbar
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the Diagram has a vertical Scrollbar.<span class="nodetails" id="xprophasVerticalScrollbar"><a class="morelink" onclick="hst('prophasVerticalScrollbar')">More...</a></span> <span class="details" id="prophasVerticalScrollbar">
</span><div class="details" id="dprophasVerticalScrollbar"><p>
To enable or disable scrolling itself, use <a href="../symbols/Diagram.html#allowHorizontalScroll" class="linkProperty">allowHorizontalScroll</a> and <a href="../symbols/Diagram.html#allowVerticalScroll" class="linkProperty">allowVerticalScroll</a>.
<p>
Adding or removing a scrollbar modifies the diagram's viewport.
<p>
The initial value is true.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#allowVerticalScroll" class="linkProperty">allowVerticalScroll</a></li>
                            
                                <li><a href="../symbols/Diagram.html#hasHorizontalScrollbar" class="linkProperty">hasHorizontalScrollbar</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="highlighteds" >
                
                <td class="name">
                  <div class="name">
                    highlighteds
                  </div>
                  <div class="attributes">
                    <span class="light">{Set.<Part>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns the read-only collection of highlighted parts.<span class="nodetails" id="xprophighlighteds"><a class="morelink" onclick="hst('prophighlighteds')">More...</a></span> <span class="details" id="prophighlighteds">
</span><div class="details" id="dprophighlighteds"><p>
Do not modify this collection.
If you want to highlight or remove the highlight for a particular Part in a Diagram,
set the <a href="../symbols/Part.html#isHighlighted" class="linkProperty">Part.isHighlighted</a> property.
If you want to remove all highlights, call <a href="../symbols/Diagram.html#clearHighlighteds" class="linkMethod">clearHighlighteds</a>.
If you want to removal all highlights and highlight a single object, call <a href="../symbols/Diagram.html#highlight" class="linkMethod">highlight</a>.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="initialAutoScale" >
                
                <td class="name">
                  <div class="name">
                    initialAutoScale
                  </div>
                  <div class="attributes">
                    <span class="light">{EnumValue}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the initialAutoScale of the Diagram.<span class="nodetails" id="xpropinitialAutoScale"><a class="morelink" onclick="hst('propinitialAutoScale')">More...</a></span> <span class="details" id="propinitialAutoScale">
The only accepted values are listed as constant properties of Diagram,
such as <a href="../symbols/Diagram.html#None" class="linkConstant">Diagram.None</a>, <a href="../symbols/Diagram.html#Uniform" class="linkConstant">Diagram.Uniform</a>, or <a href="../symbols/Diagram.html#UniformToFill" class="linkConstant">Diagram.UniformToFill</a>.
Setting this will change the Diagram's <a href="../symbols/Diagram.html#scale" class="linkProperty">Diagram.scale</a> and <a href="../symbols/Diagram.html#position" class="linkProperty">Diagram.position</a>, if appropriate.
</span><div class="details" id="dpropinitialAutoScale"><p>
If you want to always automatically scale the Diagram, use <a href="../symbols/Diagram.html#autoScale" class="linkProperty">autoScale</a> instead.
If you want to set the scale to a value on initialization (for instance every time the model is replaced),
use <a href="../symbols/Diagram.html#initialScale" class="linkProperty">initialScale</a>.
<p>
The default value is <a href="../symbols/Diagram.html#None" class="linkConstant">Diagram.None</a> -- the scale and position are not automatically adjusted
according to the area covered by the document.
<p>
Note that depending on the values of <a href="../symbols/Diagram.html#maxScale" class="linkProperty">maxScale</a> and <a href="../symbols/Diagram.html#minScale" class="linkProperty">minScale</a>, the actual value for <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>
might be limited.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="initialContentAlignment" >
                
                <td class="name">
                  <div class="name">
                    initialContentAlignment
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the initial content alignment <a href="../symbols/Spot.html" class="linkConstructor">Spot</a> of this Diagram, to be used in determining
how parts are positioned initially relative to the viewport, when the <a href="../symbols/Diagram.html#viewportBounds" class="linkProperty">viewportBounds</a> width or height is smaller than the <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">documentBounds</a>.<span class="nodetails" id="xpropinitialContentAlignment"><a class="morelink" onclick="hst('propinitialContentAlignment')">More...</a></span> <span class="details" id="propinitialContentAlignment">
</span><div class="details" id="dpropinitialContentAlignment"><p>
For instance a spot of <a href="../symbols/Spot.html#Center" class="linkConstant">Spot.Center</a> would ensure that the Diagram's contents are initially centered in the viewport.
<p>
To initially align the document when the documentBounds are larger than the viewport, use <a href="../symbols/Diagram.html#initialDocumentSpot" class="linkProperty">initialDocumentSpot</a> and <a href="../symbols/Diagram.html#initialViewportSpot" class="linkProperty">initialViewportSpot</a>.
<p>
If you want the content to be constantly aligned with a spot, use <a href="../symbols/Diagram.html#contentAlignment" class="linkProperty">contentAlignment</a> instead.
<p>
The default value is <a href="../symbols/Spot.html#Default" class="linkConstant">Spot.Default</a>, which causes no automatic scrolling or positioning.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#initialDocumentSpot" class="linkProperty">initialDocumentSpot</a></li>
                            
                                <li><a href="../symbols/Diagram.html#initialViewportSpot" class="linkProperty">initialViewportSpot</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="initialDocumentSpot" >
                
                <td class="name">
                  <div class="name">
                    initialDocumentSpot
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the spot in the document's area that should be coincident with the
<a href="../symbols/Diagram.html#initialViewportSpot" class="linkProperty">initialViewportSpot</a> of the viewport when the document is first initialized.<span class="nodetails" id="xpropinitialDocumentSpot"><a class="morelink" onclick="hst('propinitialDocumentSpot')">More...</a></span> <span class="details" id="propinitialDocumentSpot">
The default value is <a href="../symbols/Spot.html#TopLeft" class="linkConstant">Spot.TopLeft</a>.
If you set this, often you will also want to set <a href="../symbols/Diagram.html#initialViewportSpot" class="linkProperty">initialViewportSpot</a>.
If you set <a href="../symbols/Diagram.html#initialPosition" class="linkProperty">initialPosition</a>, it will take precedence over this property.</span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#initialViewportSpot" class="linkProperty">initialViewportSpot</a></li>
                            
                                <li><a href="../symbols/Diagram.html#initialPosition" class="linkProperty">initialPosition</a></li>
                            
                                <li><a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="initialPosition" >
                
                <td class="name">
                  <div class="name">
                    initialPosition
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span>
                    
                      <span class="since" title="since">1.1</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the initial coordinates of this Diagram in the viewport, eventually setting the <a href="../symbols/Diagram.html#position" class="linkProperty">position</a>.<span class="nodetails" id="xpropinitialPosition"><a class="morelink" onclick="hst('propinitialPosition')">More...</a></span> <span class="details" id="propinitialPosition">
This value is relevant on initialization of a <a href="../symbols/Diagram.html#model" class="linkProperty">model</a> or if <a href="../symbols/Diagram.html#delayInitialization" class="linkMethod">delayInitialization</a> is called.
Value must be of type Point in document coordinates.
The default is Point(NaN, NaN).
</span><div class="details" id="dpropinitialPosition"><p>
Setting this property does not notify about any changed event.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#initialDocumentSpot" class="linkProperty">initialDocumentSpot</a></li>
                            
                                <li><a href="../symbols/Diagram.html#initialViewportSpot" class="linkProperty">initialViewportSpot</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="initialScale" >
                
                <td class="name">
                  <div class="name">
                    initialScale
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                      <span class="since" title="since">1.1</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the initial scale of this Diagram in the viewport, eventually setting the <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>.<span class="nodetails" id="xpropinitialScale"><a class="morelink" onclick="hst('propinitialScale')">More...</a></span> <span class="details" id="propinitialScale">
This value is relevant on initialization of a <a href="../symbols/Diagram.html#model" class="linkProperty">model</a> or if <a href="../symbols/Diagram.html#delayInitialization" class="linkMethod">delayInitialization</a> is called.
The default is NaN.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="initialViewportSpot" >
                
                <td class="name">
                  <div class="name">
                    initialViewportSpot
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the spot in the viewport that should be coincident with the
<a href="../symbols/Diagram.html#initialDocumentSpot" class="linkProperty">initialDocumentSpot</a> of the document when the document is first initialized.<span class="nodetails" id="xpropinitialViewportSpot"><a class="morelink" onclick="hst('propinitialViewportSpot')">More...</a></span> <span class="details" id="propinitialViewportSpot">
The default value is <a href="../symbols/Spot.html#TopLeft" class="linkConstant">Spot.TopLeft</a>.
If you set this, often you will also want to set <a href="../symbols/Diagram.html#initialDocumentSpot" class="linkProperty">initialDocumentSpot</a>.
If you set <a href="../symbols/Diagram.html#initialPosition" class="linkProperty">initialPosition</a>, it will take precedence over this property.</span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#initialDocumentSpot" class="linkProperty">initialDocumentSpot</a></li>
                            
                                <li><a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="isEnabled" >
                
                <td class="name">
                  <div class="name">
                    isEnabled
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the user may interact with the Diagram.<span class="nodetails" id="xpropisEnabled"><a class="morelink" onclick="hst('propisEnabled')">More...</a></span> <span class="details" id="propisEnabled"></span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#isReadOnly" class="linkProperty">isReadOnly</a></li>
                            
                                <li><a href="../symbols/Diagram.html#isModelReadOnly" class="linkProperty">isModelReadOnly</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="isModelReadOnly" >
                
                <td class="name">
                  <div class="name">
                    isModelReadOnly
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the Diagram's <a href="../symbols/Diagram.html#model" class="linkProperty">Diagram.model</a> is <a href="../symbols/Model.html#isReadOnly" class="linkProperty">Model.isReadOnly</a>.<span class="nodetails" id="xpropisModelReadOnly"><a class="morelink" onclick="hst('propisModelReadOnly')">More...</a></span> <span class="details" id="propisModelReadOnly"></span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#isReadOnly" class="linkProperty">isReadOnly</a></li>
                            
                                <li><a href="../symbols/Diagram.html#isEnabled" class="linkProperty">isEnabled</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="isModified" >
                
                <td class="name">
                  <div class="name">
                    isModified
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether this Diagram's state has been modified.<span class="nodetails" id="xpropisModified"><a class="morelink" onclick="hst('propisModified')">More...</a></span> <span class="details" id="propisModified">
Setting this property does not notify about any changed event,
but it does raise the "Modified" <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>,
although perhaps not immediately.
</span><div class="details" id="dpropisModified"><p>
Returns true if the Diagram has been changed,
if the <a href="../symbols/Diagram.html#undoManager" class="linkProperty">undoManager</a> has recorded any changes, or
if an undo has been performed without a corresponding redo.
<p>
Replacing the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a> automatically sets this property to false after the initial layout has completed.
The "Modified" DiagramEvent is also raised when an undo or a redo has finished.
A "Modified" DiagramEvent listener must not modify this Diagram or its Model.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="isMouseCaptured" >
                
                <td class="name">
                  <div class="name">
                    isMouseCaptured
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether mouse events initiated within the Diagram will be captured.<span class="nodetails" id="xpropisMouseCaptured"><a class="morelink" onclick="hst('propisMouseCaptured')">More...</a></span> <span class="details" id="propisMouseCaptured">
The initial value is true.
Setting this property does not notify about any changed event.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="isReadOnly" >
                
                <td class="name">
                  <div class="name">
                    isReadOnly
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the Diagram may be modified by the user,
while still allowing the user to scroll, zoom, and select.<span class="nodetails" id="xpropisReadOnly"><a class="morelink" onclick="hst('propisReadOnly')">More...</a></span> <span class="details" id="propisReadOnly">
The initial value is false.</span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#isModelReadOnly" class="linkProperty">isModelReadOnly</a></li>
                            
                                <li><a href="../symbols/Diagram.html#isEnabled" class="linkProperty">isEnabled</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="isTreePathToChildren" >
                
                <td class="name">
                  <div class="name">
                    isTreePathToChildren
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the Diagram tree structure is defined by
links going from the parent node to their children, or vice-versa.<span class="nodetails" id="xpropisTreePathToChildren"><a class="morelink" onclick="hst('propisTreePathToChildren')">More...</a></span> <span class="details" id="propisTreePathToChildren">
By default this property is true: links go from the parent node to the child node.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="lastInput" >
                
                <td class="name">
                  <div class="name">
                    lastInput
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the last <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a> that occurred.<span class="nodetails" id="xproplastInput"><a class="morelink" onclick="hst('proplastInput')">More...</a></span> <span class="details" id="proplastInput">
</span><div class="details" id="dproplastInput"><p>
This property is useful in tools and real-time operations for determining
where the mouse pointer was most recently located.
<p>
Setting this property does not notify about any changed event.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#firstInput" class="linkProperty">firstInput</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="layers" >
                
                <td class="name">
                  <div class="name">
                    layers
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Layer>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns an iterator for this Diagram's Layers.<span class="nodetails" id="xproplayers"><a class="morelink" onclick="hst('proplayers')">More...</a></span> <span class="details" id="proplayers"></span>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#addLayer" class="linkMethod">addLayer</a></li>
                            
                                <li><a href="../symbols/Diagram.html#removeLayer" class="linkMethod">removeLayer</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="layout" >
                
                <td class="name">
                  <div class="name">
                    layout
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Layout.html" class="linkConstructor">Layout</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the <a href="../symbols/Layout.html" class="linkConstructor">Layout</a> used to position all of the top-level nodes and links in this Diagram.<span class="nodetails" id="xproplayout"><a class="morelink" onclick="hst('proplayout')">More...</a></span> <span class="details" id="proplayout">
By default this property is an instance of a simple <a href="../symbols/Layout.html" class="linkConstructor">Layout</a>
that assigns positions to all parts that need it.
The value cannot be null.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="links" >
                
                <td class="name">
                  <div class="name">
                    links
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Link>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns an iterator of all <a href="../symbols/Link.html" class="linkConstructor">Link</a>s in the Diagram.<span class="nodetails" id="xproplinks"><a class="morelink" onclick="hst('proplinks')">More...</a></span> <span class="details" id="proplinks">
</span><div class="details" id="dproplinks"><p>
This includes both data-bound and unbound links,
and both top-level links and links inside <a href="../symbols/Group.html" class="linkConstructor">Group</a>s.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="linkSelectionAdornmentTemplate" >
                
                <td class="name">
                  <div class="name">
                    linkSelectionAdornmentTemplate
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the default selection <a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a> template, used to adorn selected Links.<span class="nodetails" id="xproplinkSelectionAdornmentTemplate"><a class="morelink" onclick="hst('proplinkSelectionAdornmentTemplate')">More...</a></span> <span class="details" id="proplinkSelectionAdornmentTemplate">
</span><div class="details" id="dproplinkSelectionAdornmentTemplate"><p>
Each <a href="../symbols/Link.html" class="linkConstructor">Link</a> can have its own <a href="../symbols/Part.html#selectionAdornmentTemplate" class="linkProperty">Part.selectionAdornmentTemplate</a>, which if non-null will take precedence over this Diagram property.
<p>
This Adornment must not be in the visual tree of any Diagram.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="linkTemplate" >
                
                <td class="name">
                  <div class="name">
                    linkTemplate
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Link.html" class="linkConstructor">Link</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the default <a href="../symbols/Link.html" class="linkConstructor">Link</a> template used as the archetype
for link data that is added to the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.<span class="nodetails" id="xproplinkTemplate"><a class="morelink" onclick="hst('proplinkTemplate')">More...</a></span> <span class="details" id="proplinkTemplate">
</span><div class="details" id="dproplinkTemplate"><p>
Setting this property just modifies the <a href="../symbols/Diagram.html#linkTemplateMap" class="linkProperty">linkTemplateMap</a>
by replacing the entry named with the empty string.
The value must not be null and must be a <a href="../symbols/Link.html" class="linkConstructor">Link</a>, not a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or simple <a href="../symbols/Part.html" class="linkConstructor">Part</a>.
This Link must not be in the visual tree of any Diagram.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="linkTemplateMap" >
                
                <td class="name">
                  <div class="name">
                    linkTemplateMap
                  </div>
                  <div class="attributes">
                    <span class="light">{Map.<string,Link>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets a <a href="../symbols/Map.html" class="linkConstructor">Map</a> mapping template names to <a href="../symbols/Link.html" class="linkConstructor">Link</a>s.<span class="nodetails" id="xproplinkTemplateMap"><a class="morelink" onclick="hst('proplinkTemplateMap')">More...</a></span> <span class="details" id="proplinkTemplateMap">
These links are copied for each link data that is added to the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.
</span><div class="details" id="dproplinkTemplateMap"><p>
The new value must not be null and must contain only <a href="../symbols/Link.html" class="linkConstructor">Link</a>s, not <a href="../symbols/Node.html" class="linkConstructor">Node</a>s or simple <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.
The Links must not be in the visual tree of any Diagram.
Replacing this Map will automatically call <a href="../symbols/Diagram.html#rebuildParts" class="linkMethod">rebuildParts</a>.
<p>
If you modify this <a href="../symbols/Map.html" class="linkConstructor">Map</a>, by replacing a <a href="../symbols/Link.html" class="linkConstructor">Link</a> in it or by adding or
removing a map entry, you need to explicitly call <a href="../symbols/Diagram.html#rebuildParts" class="linkMethod">rebuildParts</a> afterwards.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="maxScale" >
                
                <td class="name">
                  <div class="name">
                    maxScale
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the largest value that <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a> may take.<span class="nodetails" id="xpropmaxScale"><a class="morelink" onclick="hst('propmaxScale')">More...</a></span> <span class="details" id="propmaxScale">
This property is only used to limit the range of new values of <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>.
</span><div class="details" id="dpropmaxScale"><p>
The default value is 100.0.
Values must be no less than one.
Setting this to a value that is less than the current <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>
will cause the current diagram scale to be set to this new value.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="maxSelectionCount" >
                
                <td class="name">
                  <div class="name">
                    maxSelectionCount
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the maximum number of selected objects.<span class="nodetails" id="xpropmaxSelectionCount"><a class="morelink" onclick="hst('propmaxSelectionCount')">More...</a></span> <span class="details" id="propmaxSelectionCount">
The default value is a large positive integer.
Values must be non-negative.
Decreasing this value may cause objects to be removed from <a href="../symbols/Diagram.html#selection" class="linkProperty">selection</a>
in order to meet the new lower limit.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="minScale" >
                
                <td class="name">
                  <div class="name">
                    minScale
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the smallest value greater than zero that <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a> may take.<span class="nodetails" id="xpropminScale"><a class="morelink" onclick="hst('propminScale')">More...</a></span> <span class="details" id="propminScale">
This property is only used to limit the range of new values of <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>.
</span><div class="details" id="dpropminScale"><p>
The default value is 0.0001.
Values must be larger than zero and not greater than one.
Setting this to a value that is greater than the current <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>
will cause the current diagram scale to be set to this new value.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="model" >
                
                <td class="name">
                  <div class="name">
                    model
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Model.html" class="linkConstructor">Model</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the <a href="../symbols/Model.html" class="linkConstructor">Model</a> holding data corresponding to the
data-bound nodes and links of this Diagram.<span class="nodetails" id="xpropmodel"><a class="morelink" onclick="hst('propmodel')">More...</a></span> <span class="details" id="propmodel">
</span><div class="details" id="dpropmodel"><p>
Replacing this value causes all of the bound Nodes and Links to be deleted and re-created
from the new model data.
<p>
Models may be shared by multiple Diagrams. One common approach is to have two
Diagrams displaying the same Model but using different templates
(see <a href="../symbols/Diagram.html#nodeTemplate" class="linkProperty">nodeTemplate</a>, <a href="../symbols/Diagram.html#nodeTemplateMap" class="linkProperty">nodeTemplateMap</a>, and the associated link and group properties) and sometimes even different Layouts.
<p>
Setting this property does not notify about any changed event; the new value must not be null.
Typically a new Model will have its own <a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a>, thereby replacing the Diagram's
current UndoManager.
<p>
Replacing or re-setting the model will re-initialize the Diagram, taking in to account
<a href="../symbols/Diagram.html#initialPosition" class="linkProperty">initialPosition</a>, <a href="../symbols/Diagram.html#initialScale" class="linkProperty">initialScale</a>, <a href="../symbols/Diagram.html#initialAutoScale" class="linkProperty">initialAutoScale</a>, and <a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a>.
It will also set <a href="../symbols/Diagram.html#isModified" class="linkProperty">isModified</a> to false.
<p>
It is an error to replace the Diagram.model while a transaction is in progress.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="mouseDragOver" >
                
                <td class="name">
                  <div class="name">
                    mouseDragOver
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user is dragging the selection in
the background of the Diagram during a <a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a> drag-and-drop,
not over any <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s.<span class="nodetails" id="xpropmouseDragOver"><a class="morelink" onclick="hst('propmouseDragOver')">More...</a></span> <span class="details" id="propmouseDragOver">
</span><div class="details" id="dpropmouseDragOver"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
It is called within the transaction performed by the <a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a>.
By default this property is null.
<p>
Note that for a drag-and-drop that originates in a different diagram, the target diagram's
selection collection will not be the parts that are being dragged.
Instead the temporary parts being dragged can be found as the source diagram's <a href="../symbols/DraggingTool.html#copiedParts" class="linkProperty">DraggingTool.copiedParts</a>.
<p>
This function is called with <a href="../symbols/Diagram.html#skipsUndoManager" class="linkProperty">Diagram.skipsUndoManager</a> temporarily set to true,
so that any changes to <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s are not recorded in the <a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a>.
You do not need to start and commit any transaction in this function.
After calling this function the diagram will be updated immediately.
<p>
For example, if you want to prevent the user from dropping Parts into the background of the diagram,
and want to provide feedback about that during a drag:
<pre>
  myDiagram.mouseDragOver = function(e) {
    myDiagram.currentCursor = "no-drop";
  };
</pre></div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#mouseDrop" class="linkProperty">mouseDrop</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#mouseDragEnter" class="linkProperty">GraphObject.mouseDragEnter</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#mouseDragLeave" class="linkProperty">GraphObject.mouseDragLeave</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="mouseDrop" >
                
                <td class="name">
                  <div class="name">
                    mouseDrop
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user drops the selection in
the background of the Diagram at the end of a <a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a> drag-and-drop,
not onto any <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s.<span class="nodetails" id="xpropmouseDrop"><a class="morelink" onclick="hst('propmouseDrop')">More...</a></span> <span class="details" id="propmouseDrop">
</span><div class="details" id="dpropmouseDrop"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
It is called within the transaction performed by the <a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a>.
By default this property is null.
<p>
For example, if you want to prevent the user from dropping Parts into the background of the diagram:
<pre>
  myDiagram.mouseDrop = function(e) {
    myDiagram.currentTool.doCancel();
  };
</pre></div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#mouseDragOver" class="linkProperty">mouseDragOver</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#mouseDrop" class="linkProperty">GraphObject.mouseDrop</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="mouseHold" >
                
                <td class="name">
                  <div class="name">
                    mouseHold
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user holds the mouse stationary in
the background of the Diagram while holding down a button,
not over any <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s.<span class="nodetails" id="xpropmouseHold"><a class="morelink" onclick="hst('propmouseHold')">More...</a></span> <span class="details" id="propmouseHold">
This property is used by the <a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a>.
</span><div class="details" id="dpropmouseHold"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
By default this property is null.
<p>
If you do provide a function that makes changes to the diagram or to its model,
you should do so within a transaction -- call <a href="../symbols/Diagram.html#startTransaction" class="linkMethod">startTransaction</a> and <a href="../symbols/Diagram.html#commitTransaction" class="linkMethod">commitTransaction</a>.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/GraphObject.html#mouseHold" class="linkProperty">GraphObject.mouseHold</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="mouseHover" >
                
                <td class="name">
                  <div class="name">
                    mouseHover
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user holds the mouse stationary in
the background of the Diagram without holding down any buttons,
not over any <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s.<span class="nodetails" id="xpropmouseHover"><a class="morelink" onclick="hst('propmouseHover')">More...</a></span> <span class="details" id="propmouseHover">
This property is used by the <a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a>.
</span><div class="details" id="dpropmouseHover"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
By default this property is null.
<p>
If you do provide a function that makes changes to the diagram or to its model,
you should do so within a transaction -- call <a href="../symbols/Diagram.html#startTransaction" class="linkMethod">startTransaction</a> and <a href="../symbols/Diagram.html#commitTransaction" class="linkMethod">commitTransaction</a>.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#mouseOver" class="linkProperty">mouseOver</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#mouseHover" class="linkProperty">GraphObject.mouseHover</a></li>
                            
                                <li><a href="../symbols/ToolManager.html#doMouseHover" class="linkMethod">ToolManager.doMouseHover</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="mouseOver" >
                
                <td class="name">
                  <div class="name">
                    mouseOver
                  </div>
                  <div class="attributes">
                    <span class="light">{function(InputEvent) | null}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function to execute when the user moves the mouse in
the background of the Diagram without holding down any buttons,
not over any <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s.<span class="nodetails" id="xpropmouseOver"><a class="morelink" onclick="hst('propmouseOver')">More...</a></span> <span class="details" id="propmouseOver">
This property is used by the <a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a>.
</span><div class="details" id="dpropmouseOver"><p>
If this property value is a function, it is called with an <a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a>.
By default this property is null.
<p>
This function is called with <a href="../symbols/Diagram.html#skipsUndoManager" class="linkProperty">Diagram.skipsUndoManager</a> temporarily set to true,
so that any changes to <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s are not recorded in the <a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a>.
You do not need to start and commit any transaction in this function.
After calling this function the diagram will be updated immediately.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#mouseHover" class="linkProperty">mouseHover</a></li>
                            
                                <li><a href="../symbols/GraphObject.html#mouseOver" class="linkProperty">GraphObject.mouseOver</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="nodes" >
                
                <td class="name">
                  <div class="name">
                    nodes
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Node>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns an iterator of all <a href="../symbols/Node.html" class="linkConstructor">Node</a>s and <a href="../symbols/Group.html" class="linkConstructor">Group</a>s in the Diagram.<span class="nodetails" id="xpropnodes"><a class="morelink" onclick="hst('propnodes')">More...</a></span> <span class="details" id="propnodes">
</span><div class="details" id="dpropnodes"><p>
This includes both data-bound and unbound nodes,
and both top-level nodes and nodes inside <a href="../symbols/Group.html" class="linkConstructor">Group</a>s.
All of the simple <a href="../symbols/Part.html" class="linkConstructor">Part</a>s are accessible via the <a href="../symbols/Diagram.html#parts" class="linkProperty">parts</a> property.
<p>
See also <a href="../symbols/Diagram.html#findTopLevelGroups" class="linkMethod">findTopLevelGroups</a> and <a href="../symbols/Diagram.html#findTreeRoots" class="linkMethod">findTreeRoots</a>.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="nodeSelectionAdornmentTemplate" >
                
                <td class="name">
                  <div class="name">
                    nodeSelectionAdornmentTemplate
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the default selection <a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a> template, used to adorn selected Parts other than Groups or Links.<span class="nodetails" id="xpropnodeSelectionAdornmentTemplate"><a class="morelink" onclick="hst('propnodeSelectionAdornmentTemplate')">More...</a></span> <span class="details" id="propnodeSelectionAdornmentTemplate">
</span><div class="details" id="dpropnodeSelectionAdornmentTemplate"><p>
Each <a href="../symbols/Node.html" class="linkConstructor">Node</a> or simple <a href="../symbols/Part.html" class="linkConstructor">Part</a> can have its own <a href="../symbols/Part.html#selectionAdornmentTemplate" class="linkProperty">Part.selectionAdornmentTemplate</a>, which if non-null will take precedence over this Diagram property.
<p>
This Adornment must not be in the visual tree of any Diagram.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="nodeTemplate" >
                
                <td class="name">
                  <div class="name">
                    nodeTemplate
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the default <a href="../symbols/Node.html" class="linkConstructor">Node</a> template used as the archetype
for node data that is added to the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.<span class="nodetails" id="xpropnodeTemplate"><a class="morelink" onclick="hst('propnodeTemplate')">More...</a></span> <span class="details" id="propnodeTemplate">
Setting this property just modifies the <a href="../symbols/Diagram.html#nodeTemplateMap" class="linkProperty">nodeTemplateMap</a>
by replacing the entry named with the empty string.
</span><div class="details" id="dpropnodeTemplate"><p>
The value must not be null.
The template may be either a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or a simple <a href="../symbols/Part.html" class="linkConstructor">Part</a>,
but not a <a href="../symbols/Link.html" class="linkConstructor">Link</a> or a <a href="../symbols/Group.html" class="linkConstructor">Group</a>.
<p>
This Part must not be in the visual tree of any Diagram.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="nodeTemplateMap" >
                
                <td class="name">
                  <div class="name">
                    nodeTemplateMap
                  </div>
                  <div class="attributes">
                    <span class="light">{Map.<string,Part>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets a <a href="../symbols/Map.html" class="linkConstructor">Map</a> mapping template names to <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.<span class="nodetails" id="xpropnodeTemplateMap"><a class="morelink" onclick="hst('propnodeTemplateMap')">More...</a></span> <span class="details" id="propnodeTemplateMap">
These nodes are copied for each node data that is added to the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.
</span><div class="details" id="dpropnodeTemplateMap"><p>
The new value must not be null and must contain <a href="../symbols/Node.html" class="linkConstructor">Node</a>s or simple <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.
These Parts must not be in the visual tree of any Diagram.
Replacing this Map will automatically call <a href="../symbols/Diagram.html#rebuildParts" class="linkMethod">rebuildParts</a>.
<p>
If you modify this <a href="../symbols/Map.html" class="linkConstructor">Map</a>, by replacing a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or by adding or
removing a map entry, you need to explicitly call <a href="../symbols/Diagram.html#rebuildParts" class="linkMethod">rebuildParts</a> afterwards.
Any new map values must not be <a href="../symbols/Link.html" class="linkConstructor">Link</a>s or <a href="../symbols/Group.html" class="linkConstructor">Group</a>s.
<p>
If you want to create <a href="../symbols/Group.html" class="linkConstructor">Group</a>s, use <a href="../symbols/Diagram.html#groupTemplateMap" class="linkProperty">groupTemplateMap</a> instead.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="padding" >
                
                <td class="name">
                  <div class="name">
                    padding
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Margin.html" class="linkConstructor">Margin</a>|number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the Margin that describes the Diagram's padding,
which controls how much extra space there is around the area occupied by the document.<span class="nodetails" id="xproppadding"><a class="morelink" onclick="hst('proppadding')">More...</a></span> <span class="details" id="proppadding">
This keeps nodes from butting up against the side of the diagram (unless scrolled).
</span><div class="details" id="dproppadding"><p>
The default value is a margin of 5, all around the edge of the document.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="parts" >
                
                <td class="name">
                  <div class="name">
                    parts
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Part>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns an iterator of all <a href="../symbols/Part.html" class="linkConstructor">Part</a>s in the Diagram
that are not <a href="../symbols/Node.html" class="linkConstructor">Node</a>s or <a href="../symbols/Link.html" class="linkConstructor">Link</a>s or <a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a>s.<span class="nodetails" id="xpropparts"><a class="morelink" onclick="hst('propparts')">More...</a></span> <span class="details" id="propparts">
</span><div class="details" id="dpropparts"><p>
This includes both data-bound and unbound parts,
and both top-level parts and parts inside <a href="../symbols/Group.html" class="linkConstructor">Group</a>s.
Use the <a href="../symbols/Diagram.html#nodes" class="linkProperty">nodes</a> or <a href="../symbols/Diagram.html#links" class="linkProperty">links</a> properties for getting the
collection of all <a href="../symbols/Node.html" class="linkConstructor">Node</a>s or <a href="../symbols/Link.html" class="linkConstructor">Link</a>s in the diagram.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="position" >
                
                <td class="name">
                  <div class="name">
                    position
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the coordinates of this Diagram in the viewport.<span class="nodetails" id="xpropposition"><a class="morelink" onclick="hst('propposition')">More...</a></span> <span class="details" id="propposition">
Value must be of type <a href="../symbols/Point.html" class="linkConstructor">Point</a> in document coordinates.
The default is Point(NaN, NaN), but is typically set to a real value when a Diagram is initialized.
</span><div class="details" id="dpropposition"><p>
Scrolling and panning the Diagram modify the Diagram's position.
<p>
Setting this property does not notify about any changed event.
However you can listen with <a href="../symbols/Diagram.html#addDiagramListener" class="linkMethod">addDiagramListener</a> for a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>
with the name "ViewportBoundsChanged".
The <a href="../symbols/Diagram.html#viewportBounds" class="linkProperty">viewportBounds</a> x and y values are always the same as the Diagram's position values.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="positionComputation" >
                
                <td class="name">
                  <div class="name">
                    positionComputation
                  </div>
                  <div class="attributes">
                    <span class="light">{function(Diagram, Point):Point | null}</span>
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function used to determine the position that this Diagram can be scrolled or moved to.<span class="nodetails" id="xproppositionComputation"><a class="morelink" onclick="hst('proppositionComputation')">More...</a></span> <span class="details" id="proppositionComputation">
</span><div class="details" id="dproppositionComputation"><p>
By default this function is null and the Diagram's position is bound only by the document bounds.
<p>
When this property is set the function is given a reference to the diagram and the proposed new position Point.
The function must return a new point.
<p>
An example that disallows decimal position values:
<pre>
  function computeIntegralPosition(diagram, pt) {
    return new go.Point(Math.floor(pt.x), Math.floor(pt.y));
  }
</pre>
<p>
The function, if supplied, must not have any side-effects.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="scale" >
                
                <td class="name">
                  <div class="name">
                    scale
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the scale transform of this Diagram.<span class="nodetails" id="xpropscale"><a class="morelink" onclick="hst('propscale')">More...</a></span> <span class="details" id="propscale">
Value must be a positive number.
The default value is 1.
Any new value will be coerced to be between <a href="../symbols/Diagram.html#minScale" class="linkProperty">minScale</a> and <a href="../symbols/Diagram.html#maxScale" class="linkProperty">maxScale</a>.
</span><div class="details" id="dpropscale"><p>
Scale can automatically be set by the <a href="../symbols/Diagram.html#autoScale" class="linkProperty">autoScale</a> property.
There are also <a href="../symbols/Diagram.html#initialScale" class="linkProperty">initialScale</a> and <a href="../symbols/Diagram.html#initialAutoScale" class="linkProperty">initialAutoScale</a> for
setting the scale on (re)initialization of a Diagram.
<p>
Setting this property does not notify about any changed event.
However you can listen with <a href="../symbols/Diagram.html#addDiagramListener" class="linkMethod">addDiagramListener</a> for a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>
with the name "ViewportBoundsChanged".</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="scaleComputation" >
                
                <td class="name">
                  <div class="name">
                    scaleComputation
                  </div>
                  <div class="attributes">
                    <span class="light">{function(Diagram, number):number | null}</span>
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the function used to determine valid scale values for this Diagram.
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="scrollHorizontalLineChange" >
                
                <td class="name">
                  <div class="name">
                    scrollHorizontalLineChange
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the distance in screen pixels that the horizontal scrollbar will scroll
when scrolling by a line.<span class="nodetails" id="xpropscrollHorizontalLineChange"><a class="morelink" onclick="hst('propscrollHorizontalLineChange')">More...</a></span> <span class="details" id="propscrollHorizontalLineChange">
</span><div class="details" id="dpropscrollHorizontalLineChange"><p>
The default value is 16.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#scrollVerticalLineChange" class="linkProperty">scrollVerticalLineChange</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="scrollMargin" >
                
                <td class="name">
                  <div class="name">
                    scrollMargin
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Margin.html" class="linkConstructor">Margin</a>|number}</span>
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets a scrollable area that surrounds the document bounds, allowing the user to scroll into empty space.<span class="nodetails" id="xpropscrollMargin"><a class="morelink" onclick="hst('propscrollMargin')">More...</a></span> <span class="details" id="propscrollMargin">
</span><div class="details" id="dpropscrollMargin"><p>
The margin is only effective in each direction when the document bounds plus margin is greater than the viewport bounds.
<p>
The default value is a margin of 0, all around the edge of the document.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="scrollMode" >
                
                <td class="name">
                  <div class="name">
                    scrollMode
                  </div>
                  <div class="attributes">
                    <span class="light">{EnumValue}</span>
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the scrollMode of the Diagram, allowing the user to either
scroll to document bound borders with <a href="../symbols/Diagram.html#DocumentScroll" class="linkConstant">Diagram.DocumentScroll</a>,
or scroll endlessly with <a href="../symbols/Diagram.html#InfiniteScroll" class="linkConstant">Diagram.InfiniteScroll</a>.<span class="nodetails" id="xpropscrollMode"><a class="morelink" onclick="hst('propscrollMode')">More...</a></span> <span class="details" id="propscrollMode">
</span><div class="details" id="dpropscrollMode"><p>
The default value is <a href="../symbols/Diagram.html#DocumentScroll" class="linkConstant">Diagram.DocumentScroll</a>.
Changing this property value does not raise a Changed event.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="scrollsPageOnFocus" >
                
                <td class="name">
                  <div class="name">
                    scrollsPageOnFocus
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                      <span class="since" title="since">1.8</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether the page may be scrolled when the diagram receives focus.<span class="nodetails" id="xpropscrollsPageOnFocus"><a class="morelink" onclick="hst('propscrollsPageOnFocus')">More...</a></span> <span class="details" id="propscrollsPageOnFocus">
This happens in some browsers when the top-left corner of the diagram's HTMLDivElement
is scrolled out of view, the diagram does not have focus, and the user clicks in the diagram.
</span><div class="details" id="dpropscrollsPageOnFocus"><p>
The default value is true.  The default value will change to false in version 2.0.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="scrollVerticalLineChange" >
                
                <td class="name">
                  <div class="name">
                    scrollVerticalLineChange
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the distance in screen pixels that the vertical scrollbar will scroll
when scrolling by a line.<span class="nodetails" id="xpropscrollVerticalLineChange"><a class="morelink" onclick="hst('propscrollVerticalLineChange')">More...</a></span> <span class="details" id="propscrollVerticalLineChange">
</span><div class="details" id="dpropscrollVerticalLineChange"><p>
The default value is 16.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#scrollHorizontalLineChange" class="linkProperty">scrollHorizontalLineChange</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="selection" >
                
                <td class="name">
                  <div class="name">
                    selection
                  </div>
                  <div class="attributes">
                    <span class="light">{Set.<Part>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns the read-only collection of selected objects.<span class="nodetails" id="xpropselection"><a class="morelink" onclick="hst('propselection')">More...</a></span> <span class="details" id="propselection">
</span><div class="details" id="dpropselection"><p>
Do not modify this collection.
If you want to select or deselect a particular object in a Diagram,
set the <a href="../symbols/Part.html#isSelected" class="linkProperty">Part.isSelected</a> property.
If you want to deselect all objects, call <a href="../symbols/Diagram.html#clearSelection" class="linkMethod">clearSelection</a>.
If you want to deselect all objects and select a single object, call <a href="../symbols/Diagram.html#select" class="linkMethod">select</a>.
<p>
You can limit how many objects the user can select by setting <a href="../symbols/Diagram.html#maxSelectionCount" class="linkProperty">maxSelectionCount</a>.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="skipsUndoManager" >
                
                <td class="name">
                  <div class="name">
                    skipsUndoManager
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets whether ChangedEvents are not recorded by the UndoManager.<span class="nodetails" id="xpropskipsUndoManager"><a class="morelink" onclick="hst('propskipsUndoManager')">More...</a></span> <span class="details" id="propskipsUndoManager">
The initial and normal value is false.
WARNING: while this property is true do not perform any changes that cause any previous transactions
to become impossible to undo.
</span><div class="details" id="dpropskipsUndoManager"><p>
While this property is true, changing the Diagram or any GraphObject does not call <a href="../symbols/UndoManager.html#handleChanged" class="linkMethod">UndoManager.handleChanged</a>.
Even when this property is true,
transactions (such as calls to <a href="../symbols/Diagram.html#startTransaction" class="linkMethod">startTransaction</a>) and
undo/redo (such as calls to <a href="../symbols/CommandHandler.html#undo" class="linkMethod">CommandHandler.undo</a>)
are still delegated to the <a href="../symbols/Diagram.html#undoManager" class="linkProperty">undoManager</a>.
<p>
You should set this to true only temporarily, and you should remember its previous value
before setting this to true.
When finishing the period for which you want the UndoManager to be disabled,
you should set this back to the remembered value it had before it was set to true.
<p>
For more permanent disabling of the <a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a>, set <a href="../symbols/UndoManager.html#isEnabled" class="linkProperty">UndoManager.isEnabled</a> to false.
<p>
Setting this property also sets <a href="../symbols/Model.html#skipsUndoManager" class="linkProperty">Model.skipsUndoManager</a> to the same value.
Setting this property does not notify about any changed event.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="toolManager" >
                
                <td class="name">
                  <div class="name">
                    toolManager
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the <a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a> for this Diagram.<span class="nodetails" id="xproptoolManager"><a class="morelink" onclick="hst('proptoolManager')">More...</a></span> <span class="details" id="proptoolManager">
This tool is used for mode-less operation.
It is responsible for choosing a particular tool to run as the <a href="../symbols/Diagram.html#currentTool" class="linkProperty">currentTool</a>.
</span><div class="details" id="dproptoolManager"><p>
This tool is normally also the <a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a>.
If you don't want the ToolManager to run at all,
replace the <a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a> with your own tool.
<p>
Setting this property does not notify about any changed event; the new value must not be null.
If you set this property, you will probably also want to set <a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a>.</div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/Diagram.html#defaultTool" class="linkProperty">defaultTool</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="toolTip" >
                
                <td class="name">
                  <div class="name">
                    toolTip
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a>|<a href="../symbols/HTMLInfo.html" class="linkConstructor">HTMLInfo</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This <a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a> or <a href="../symbols/HTMLInfo.html" class="linkConstructor">HTMLInfo</a> is shown when the mouse stays motionless in the background.<span class="nodetails" id="xproptoolTip"><a class="morelink" onclick="hst('proptoolTip')">More...</a></span> <span class="details" id="proptoolTip">
The default value is null, which means no tooltip is shown.
</span><div class="details" id="dproptoolTip"><p>
Here is a simple example:
<pre>
 diagram.toolTip =
   $(go.Adornment, "Auto",
     $(go.Shape, { fill: "#CCFFCC" }),
     $(go.TextBlock, { margin: 4 },
       "This diagram lets you control the world.")
   );
</pre></div>
                
                    <div class="seealso">See also:
                        <ul class="seealsolist">
                            
                                <li><a href="../symbols/GraphObject.html#toolTip" class="linkProperty">GraphObject.toolTip</a></li>
                            
                                <li><a href="../symbols/ToolManager.html#doToolTip" class="linkMethod">ToolManager.doToolTip</a></li>
                            
                        </ul>
                    </div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="undoManager" >
                
                <td class="name">
                  <div class="name">
                    undoManager
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns the <a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a> for this Diagram, which actually belongs to the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a>.<span class="nodetails" id="xpropundoManager"><a class="morelink" onclick="hst('propundoManager')">More...</a></span> <span class="details" id="propundoManager">
</span><div class="details" id="dpropundoManager"><p>
The default UndoManager has its <a href="../symbols/UndoManager.html#isEnabled" class="linkProperty">UndoManager.isEnabled</a> property set to false.
If you want users to undo and redo, you should set that property to true once you have initialized the Diagram or its Model.
<p>
Note that the UndoManager might be shared with other Diagrams that are showing the same Model.
The UndoManager might also be shared with other Models too.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="validCycle" >
                
                <td class="name">
                  <div class="name">
                    validCycle
                  </div>
                  <div class="attributes">
                    <span class="light">{EnumValue}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets what kinds of graphs this diagram allows the user to draw.<span class="nodetails" id="xpropvalidCycle"><a class="morelink" onclick="hst('propvalidCycle')">More...</a></span> <span class="details" id="propvalidCycle">
By default this property is <a href="../symbols/Diagram.html#CycleAll" class="linkConstant">Diagram.CycleAll</a> -- all kinds of cycles are permitted.
Common values include <a href="../symbols/Diagram.html#CycleDestinationTree" class="linkConstant">Diagram.CycleDestinationTree</a> and <a href="../symbols/Diagram.html#CycleNotDirected" class="linkConstant">Diagram.CycleNotDirected</a>.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="viewportBounds" >
                
                <td class="name">
                  <div class="name">
                    viewportBounds
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>This read-only property returns the bounds of the portion of the Diagram in document coordinates that is viewable from its HTML Canvas.<span class="nodetails" id="xpropviewportBounds"><a class="morelink" onclick="hst('propviewportBounds')">More...</a></span> <span class="details" id="propviewportBounds">
Typically when the viewport bounds are smaller than the <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">documentBounds</a>, the user can scroll or pan the view.
</span><div class="details" id="dpropviewportBounds"><p>
The x and y coordinates are equal to the <a href="../symbols/Diagram.html#position" class="linkProperty">position</a> of the Diagram,
and the width and height are equal to the Diagram's canvas width and height,
divided by the <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a>.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="zoomPoint" >
                
                <td class="name">
                  <div class="name">
                    zoomPoint
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span>
                    
                      <span class="since" title="since">1.2</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the zoom point of this Diagram, in viewport coordinates.<span class="nodetails" id="xpropzoomPoint"><a class="morelink" onclick="hst('propzoomPoint')">More...</a></span> <span class="details" id="propzoomPoint">
This is used by <a href="../symbols/Tool.html#standardMouseWheel" class="linkMethod">Tool.standardMouseWheel</a> and scale-setting commands to control where to zoom in or out.
</span><div class="details" id="dpropzoomPoint"><p>
Typical usage is to remember the value of this property and
to set this property to some point within the viewport (between zero and the canvas width and height).
This is commonly accomplished by using the <a href="../symbols/InputEvent.html#viewPoint" class="linkProperty">InputEvent.viewPoint</a> of <a href="../symbols/Diagram.html#lastInput" class="linkProperty">Diagram.lastInput</a>.
Then one changes the <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a> somehow, perhaps by executing one of the <a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a> commands,
or by rotating the mouse wheel, or just by setting the <a href="../symbols/Diagram.html#scale" class="linkProperty">Diagram.scale</a> property.
Finally one restores the original value of this property.
<p>
The default value is Point(NaN, NaN).
Value must be of type <a href="../symbols/Point.html" class="linkConstructor">Point</a>, in element coordinates, not in document coordinates.
Setting this property does not notify about any changed event.</div>
                
                </div>
                            </td>
                        </tr>
                    
                    </tbody>
                </table>
                </div><!-- class="table-responsive">-->
                

                
            

<!-- ============================== methods summary ======================== -->
            
                
                
        <h2 class="summaryCaption">Method <span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
                <div class="table-responsive">
                <table class="summaryTable table table-bordered table-condensed" summary="A summary of the methods documented in the class Diagram.">
                    <thead>
                        <tr>
                            <th scope="col" class="name">Name, Return Type</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                    
            <tr id="add">
                <td class="name">
                  
                  <div class="name">
                    add(part)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Adds a <a href="../symbols/Part.html" class="linkConstructor">Part</a> to the <a href="../symbols/Layer.html" class="linkConstructor">Layer</a> that matches the Part's <a href="../symbols/Part.html#layerName" class="linkProperty">Part.layerName</a>,
or else the default layer, which is named with the empty string.<span class="nodetails" id="xmethadd"><a class="morelink" onclick="hst('methadd')">More...</a></span> <span class="details" id="methadd">
</span><div class="details" id="dmethadd"><p>
Normally parts added to a diagram are top-level parts.
If you want nodes to be members of a <a href="../symbols/Group.html" class="linkConstructor">Group</a>, in addition to calling this method
call <a href="../symbols/Group.html#addMembers" class="linkMethod">Group.addMembers</a> or set each <a href="../symbols/Part.html#containingGroup" class="linkProperty">Part.containingGroup</a>.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span> <b>part</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="addChangedListener">
                <td class="name">
                  
                  <div class="name">
                    addChangedListener(listener)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Register an event handler that is called when there is a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> because this Diagram
or one of its Parts has changed, but not because the Model or any model data has changed.<span class="nodetails" id="xmethaddChangedListener"><a class="morelink" onclick="hst('methaddChangedListener')">More...</a></span> <span class="details" id="methaddChangedListener">
</span><div class="details" id="dmethaddChangedListener"><p>
It is unusual to listen for Diagram ChangedEvents --
it is far more common to listen for specific <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>s by calling <a href="../symbols/Diagram.html#addDiagramListener" class="linkMethod">addDiagramListener</a>,
or to listen for Model ChangedEvents (i.e. changes to the model) by calling <a href="../symbols/Diagram.html#addModelChangedListener" class="linkMethod">addModelChangedListener</a>.
<p>
Do not add or remove Changed listeners during the execution of a Changed listener.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#removeChangedListener" class="linkMethod">removeChangedListener</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(ChangedEvent)}</span> <b>listener</b>
                                          
                                      </dt>
                                      <dd>a function that takes a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> as its argument.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="addDiagramListener">
                <td class="name">
                  
                  <div class="name">
                    addDiagramListener(name, listener)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Register an event handler that is called when there is a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a> of a given name.<span class="nodetails" id="xmethaddDiagramListener"><a class="morelink" onclick="hst('methaddDiagramListener')">More...</a></span> <span class="details" id="methaddDiagramListener">
</span><div class="details" id="dmethaddDiagramListener"><p>
See the <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a> documentation for a complete listing of diagram event names and their purposes.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>name</b>
                                          
                                      </dt>
                                      <dd>the name is normally capitalized, but this method uses case-insensitive comparison.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(DiagramEvent)}</span> <b>listener</b>
                                          
                                      </dt>
                                      <dd>a function that takes a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a> as its argument.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="addLayer">
                <td class="name">
                  
                  <div class="name">
                    addLayer(layer)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Adds a new <a href="../symbols/Layer.html" class="linkConstructor">Layer</a> to the list of layers.<span class="nodetails" id="xmethaddLayer"><a class="morelink" onclick="hst('methaddLayer')">More...</a></span> <span class="details" id="methaddLayer">
If <a href="../symbols/Layer.html#isTemporary" class="linkProperty">Layer.isTemporary</a> is false, the layer is added after all existing non-temporary layers.
If <a href="../symbols/Layer.html#isTemporary" class="linkProperty">Layer.isTemporary</a> is true, the layer is added as the very last layer.</span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#addLayerBefore" class="linkMethod">addLayerBefore</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#addLayerAfter" class="linkMethod">addLayerAfter</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#removeLayer" class="linkMethod">removeLayer</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findLayer" class="linkMethod">findLayer</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span> <b>layer</b>
                                          
                                      </dt>
                                      <dd>The new Layer to add.  It is an error if the Layer already belongs to a Diagram.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="addLayerAfter">
                <td class="name">
                  
                  <div class="name">
                    addLayerAfter(layer, existingLayer)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Adds a layer to the list of layers after a specified layer.<span class="nodetails" id="xmethaddLayerAfter"><a class="morelink" onclick="hst('methaddLayerAfter')">More...</a></span> <span class="details" id="methaddLayerAfter">
This method can also re-order layers.</span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#addLayer" class="linkMethod">addLayer</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#addLayerBefore" class="linkMethod">addLayerBefore</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#removeLayer" class="linkMethod">removeLayer</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span> <b>layer</b>
                                          
                                      </dt>
                                      <dd>the new Layer to add or existing Layer to move in Z-order.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span> <b>existingLayer</b>
                                          
                                      </dt>
                                      <dd>the other Layer in this Diagram which should come just before the new or moved layer.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="addLayerBefore">
                <td class="name">
                  
                  <div class="name">
                    addLayerBefore(layer, existingLayer)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Adds a layer to the list of layers before a specified layer.<span class="nodetails" id="xmethaddLayerBefore"><a class="morelink" onclick="hst('methaddLayerBefore')">More...</a></span> <span class="details" id="methaddLayerBefore">
This method can also re-order layers.</span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#addLayer" class="linkMethod">addLayer</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#addLayerAfter" class="linkMethod">addLayerAfter</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#removeLayer" class="linkMethod">removeLayer</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span> <b>layer</b>
                                          
                                      </dt>
                                      <dd>the new Layer to add or existing Layer to move in Z-order.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span> <b>existingLayer</b>
                                          
                                      </dt>
                                      <dd>the other Layer in this Diagram which should come just after the new or moved layer.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="addModelChangedListener">
                <td class="name">
                  
                  <div class="name">
                    addModelChangedListener(listener)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.6</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Register an event handler on this Diagram's <a href="../symbols/Diagram.html#model" class="linkProperty">Diagram.model</a> that is called when there is a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> on the <a href="../symbols/Model.html" class="linkConstructor">Model</a>, not in this diagram.<span class="nodetails" id="xmethaddModelChangedListener"><a class="morelink" onclick="hst('methaddModelChangedListener')">More...</a></span> <span class="details" id="methaddModelChangedListener">
Be sure to call <a href="../symbols/Diagram.html#removeModelChangedListener" class="linkMethod">removeModelChangedListener</a> when you are done with the diagram.
</span><div class="details" id="dmethaddModelChangedListener"><p>
This is convenient when the <a href="../symbols/Diagram.html#model" class="linkProperty">Diagram.model</a> may be replaced.
Using this method to register a Model Changed listener is more convenient than calling <a href="../symbols/Model.html#addChangedListener" class="linkMethod">Model.addChangedListener</a> directly
because when this diagram's Model is replaced, one does not need to call <a href="../symbols/Model.html#removeChangedListener" class="linkMethod">Model.removeChangedListener</a> on the old Model
and then <a href="../symbols/Model.html#addChangedListener" class="linkMethod">Model.addChangedListener</a> again on the new Model.
<p>
You can establish Model Changed listeners when you create a Diagram with <a href="../symbols/GraphObject.html#.make" class="linkStatic">GraphObject.make</a>.  For example:
<pre>
$(go.Diagram, . . .,
   {
       "ModelChanged": function(e) { if (e.isTransactionFinished) saveModel(); }
       . . .
   })
</pre>
<p>
Do not add or remove Changed listeners during the execution of a Changed listener.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#removeModelChangedListener" class="linkMethod">removeModelChangedListener</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(ChangedEvent)}</span> <b>listener</b>
                                          
                                      </dt>
                                      <dd>a function that takes a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> as its argument.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="alignDocument">
                <td class="name">
                  
                  <div class="name">
                    alignDocument(documentspot, viewportspot)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Aligns the Diagram's <a href="../symbols/Diagram.html#position" class="linkProperty">position</a> based on a desired document <a href="../symbols/Spot.html" class="linkConstructor">Spot</a> and viewport <a href="../symbols/Spot.html" class="linkConstructor">Spot</a>.<span class="nodetails" id="xmethalignDocument"><a class="morelink" onclick="hst('methalignDocument')">More...</a></span> <span class="details" id="methalignDocument"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> <b>documentspot</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> <b>viewportspot</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="centerRect">
                <td class="name">
                  
                  <div class="name">
                    centerRect(r)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Modifies the <a href="../symbols/Diagram.html#position" class="linkProperty">position</a> to show a given Rect of the Diagram by centering the
viewport on that Rect.<span class="nodetails" id="xmethcenterRect"><a class="morelink" onclick="hst('methcenterRect')">More...</a></span> <span class="details" id="methcenterRect">
</span><div class="details" id="dmethcenterRect"><p>
See also <a href="../symbols/Diagram.html#scrollToRect" class="linkMethod">scrollToRect</a></div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#scrollToRect" class="linkMethod">scrollToRect</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#scroll" class="linkMethod">scroll</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span> <b>r</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="clear">
                <td class="name">
                  
                  <div class="name">
                    clear()
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Removes all Parts from the Diagram, including unbound Parts except for the background <a href="../symbols/Diagram.html#grid" class="linkProperty">grid</a>,
and also clears out the <a href="../symbols/Model.html" class="linkConstructor">Model</a> and <a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a> and clipboard.<span class="nodetails" id="xmethclear"><a class="morelink" onclick="hst('methclear')">More...</a></span> <span class="details" id="methclear">
This operation is not undoable.
</span><div class="details" id="dmethclear"><p>
Alternative actions are to replace the <a href="../symbols/Diagram.html#model" class="linkProperty">model</a> with a new <a href="../symbols/Model.html" class="linkConstructor">Model</a>
(probably a <a href="../symbols/GraphLinksModel.html" class="linkConstructor">GraphLinksModel</a> or a <a href="../symbols/TreeModel.html" class="linkConstructor">TreeModel</a>),
or to set <a href="../symbols/Model.html#nodeDataArray" class="linkProperty">Model.nodeDataArray</a> with an empty JavaScript Array
(and <a href="../symbols/GraphLinksModel.html#linkDataArray" class="linkProperty">GraphLinksModel.linkDataArray</a>).
<p>
This does not remove any listeners from the diagram.</div>
                 
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="clearHighlighteds">
                <td class="name">
                  
                  <div class="name">
                    clearHighlighteds()
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.4</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Remove highlights from all <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.<span class="nodetails" id="xmethclearHighlighteds"><a class="morelink" onclick="hst('methclearHighlighteds')">More...</a></span> <span class="details" id="methclearHighlighteds">
This removes all parts from the <a href="../symbols/Diagram.html#highlighteds" class="linkProperty">highlighteds</a> collection.</span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#highlight" class="linkMethod">highlight</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#highlightCollection" class="linkMethod">highlightCollection</a></li>
                                
                                    <li><a href="../symbols/Part.html#isHighlighted" class="linkProperty">Part.isHighlighted</a></li>
                                
                  </ul></div>
                            
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="clearSelection">
                <td class="name">
                  
                  <div class="name">
                    clearSelection()
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Deselect all selected <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.<span class="nodetails" id="xmethclearSelection"><a class="morelink" onclick="hst('methclearSelection')">More...</a></span> <span class="details" id="methclearSelection">
This removes all parts from the <a href="../symbols/Diagram.html#selection" class="linkProperty">selection</a> collection.
This method raises the "ChangingSelection" and "ChangedSelection" Diagram events.</span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#select" class="linkMethod">select</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#selectCollection" class="linkMethod">selectCollection</a></li>
                                
                  </ul></div>
                            
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="commit">
                <td class="name">
                  
                  <div class="name">
                    commit(func, tname)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.8</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Starts a new transaction, calls the provided function, and commits the transaction.<span class="nodetails" id="xmethcommit"><a class="morelink" onclick="hst('methcommit')">More...</a></span> <span class="details" id="methcommit">
Code is called within a try-finally statement.
If the function does not return normally, this rolls back the transaction rather than committing it.
Example usage:
<pre>
diagram.commit(d => d.model.addNodeData({ counter: myCounter++ }), "Added Node");
</pre></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(Diagram)}</span> <b>func</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{(string|null)=}</span> <b>tname</b>
                                          
                                      </dt>
                                      <dd>a descriptive name for the transaction, or null to temporarily set <a href="../symbols/Diagram.html#skipsUndoManager" class="linkProperty">skipsUndoManager</a> to true;
       if no string transaction name is given, an empty string is used as the transaction name</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="commitTransaction">
                <td class="name">
                  
                  <div class="name">
                    commitTransaction(tname)
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Commit the changes of the current transaction.<span class="nodetails" id="xmethcommitTransaction"><a class="morelink" onclick="hst('methcommitTransaction')">More...</a></span> <span class="details" id="methcommitTransaction">
This just calls <a href="../symbols/UndoManager.html#commitTransaction" class="linkMethod">UndoManager.commitTransaction</a>.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string=}</span> <b>tname</b>
                                          
                                      </dt>
                                      <dd>a descriptive name for the transaction.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{boolean}</span> the value returned by <a href="../symbols/UndoManager.html#commitTransaction" class="linkMethod">UndoManager.commitTransaction</a>.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="computeBounds">
                <td class="name">
                  
                  <div class="name">
                    computeBounds()
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>
                 
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span> a Rect in document coordinates.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="computePartsBounds">
                <td class="name">
                  
                  <div class="name">
                    computePartsBounds(coll, includeLinks)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span>
                    
                      <span class="since" title="since">1.1</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Find the union of the <a href="../symbols/GraphObject.html#actualBounds" class="linkProperty">GraphObject.actualBounds</a> of all of the <a href="../symbols/Part.html" class="linkConstructor">Part</a>s in the given collection,
excluding Links unless the second argument is true.<span class="nodetails" id="xmethcomputePartsBounds"><a class="morelink" onclick="hst('methcomputePartsBounds')">More...</a></span> <span class="details" id="methcomputePartsBounds">
</span><div class="details" id="dmethcomputePartsBounds"><p>
Unlike <a href="../symbols/Diagram.html#computeBounds" class="linkMethod">computeBounds</a>, this ignores the visibility of each Part and does not add any padding to the result.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Iterable.<Part>}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>a collection of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean=}</span> <b>includeLinks</b>
                                          
                                      </dt>
                                      <dd>defaults to false</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span> This returns the bounding area of the given Parts;
if there are no Parts in the collection, this returns a Rect with zero width and height and an X and Y that are NaN.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="copyParts">
                <td class="name">
                  
                  <div class="name">
                    copyParts(coll, diagram, check)
                  </div>
                  <div class="attributes">
                    <span class="light">{Map.<Part,Part>}</span>
                    
                      <span class="since" title="since">1.3</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Make a copy of a collection of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s and return them in a <a href="../symbols/Map.html" class="linkConstructor">Map</a> mapping each original Part to its copy.<span class="nodetails" id="xmethcopyParts"><a class="morelink" onclick="hst('methcopyParts')">More...</a></span> <span class="details" id="methcopyParts">
It may optionally add them to a given <a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a>.
Copying a <a href="../symbols/Group.html" class="linkConstructor">Group</a> will also copy its member Nodes and Links.
Copying a <a href="../symbols/Link.html" class="linkConstructor">Link</a> will also copy any label Nodes that it owns.
</span><div class="details" id="dmethcopyParts"><p>
This does not perform a transaction nor does it raise a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>.
Call <a href="../symbols/CommandHandler.html#copySelection" class="linkMethod">CommandHandler.copySelection</a>, which calls this method,
if you want to copy all selected Parts into the clipboard.
The <a href="../symbols/CommandHandler.html#copySelection" class="linkMethod">CommandHandler.copySelection</a> command may also copy additional Parts as well, depending on <a href="../symbols/CommandHandler.html#copiesTree" class="linkProperty">CommandHandler.copiesTree</a>.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Iterable.<Part>}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>A <a href="../symbols/List.html" class="linkConstructor">List</a> or a <a href="../symbols/Set.html" class="linkConstructor">Set</a> or <a href="../symbols/Iterator.html" class="linkConstructor">Iterator</a> of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a>}</span> <b>diagram</b>
                                          
                                      </dt>
                                      <dd>The destination diagram; if null, the copied parts are not added to this diagram.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean}</span> <b>check</b>
                                          
                                      </dt>
                                      <dd>Whether to check <a href="../symbols/Part.html#canCopy" class="linkMethod">Part.canCopy</a> on each part.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Map.<Part,Part>}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="delayInitialization">
                <td class="name">
                  
                  <div class="name">
                    delayInitialization(func)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.1</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Updates the diagram immediately, then resets initialization flags so that
actions taken in the argument function will be considered part of Diagram initialization,
and will participate in initial layouts, <a href="../symbols/Diagram.html#initialAutoScale" class="linkProperty">initialAutoScale</a>, <a href="../symbols/Diagram.html#initialContentAlignment" class="linkProperty">initialContentAlignment</a>, etc.<span class="nodetails" id="xmethdelayInitialization"><a class="morelink" onclick="hst('methdelayInitialization')">More...</a></span> <span class="details" id="methdelayInitialization">
</span><div class="details" id="dmethdelayInitialization"><p>
This is useful in situations where you do not wish for the first content added to the diagram to be considered
the "initial" content, such as with a Node that represents a "Loading" bar.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function()|null=}</span> <b>func</b>
                                          
                                      </dt>
                                      <dd>an optional function of actions to perform as part of another diagram initialization.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findLayer">
                <td class="name">
                  
                  <div class="name">
                    findLayer(name)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Finds a layer with a given name.<span class="nodetails" id="xmethfindLayer"><a class="morelink" onclick="hst('methfindLayer')">More...</a></span> <span class="details" id="methfindLayer"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#addLayerBefore" class="linkMethod">addLayerBefore</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#addLayerAfter" class="linkMethod">addLayerAfter</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#removeLayer" class="linkMethod">removeLayer</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>name</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span> a Layer with the given name, or null if no such layer was found.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findLinkForData">
                <td class="name">
                  
                  <div class="name">
                    findLinkForData(linkdata)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Link.html" class="linkConstructor">Link</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Look for a <a href="../symbols/Link.html" class="linkConstructor">Link</a> corresponding to a <a href="../symbols/GraphLinksModel.html" class="linkConstructor">GraphLinksModel</a>'s link data object.<span class="nodetails" id="xmethfindLinkForData"><a class="morelink" onclick="hst('methfindLinkForData')">More...</a></span> <span class="details" id="methfindLinkForData"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Object}</span> <b>linkdata</b>
                                          
                                      </dt>
                                      <dd>a JavaScript object matched by reference identity;
  use <a href="../symbols/Diagram.html#findLinksByExample" class="linkMethod">findLinksByExample</a> if you want to find those Links whose data matches an example data object</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Link.html" class="linkConstructor">Link</a>}</span> an existing <a href="../symbols/Link.html" class="linkConstructor">Link</a> in this Diagram that was
created because its <code>Part.data</code> was the link data in the Diagram's <a href="../symbols/Model.html" class="linkConstructor">Model</a>.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findLinksByExample">
                <td class="name">
                  
                  <div class="name">
                    findLinksByExample(examples)
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Link>}</span>
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Search for Links by matching the Link data with example data holding values, RegExps, or predicates.<span class="nodetails" id="xmethfindLinksByExample"><a class="morelink" onclick="hst('methfindLinksByExample')">More...</a></span> <span class="details" id="methfindLinksByExample">
</span><div class="details" id="dmethfindLinksByExample"><p>
See the documentation of <a href="../symbols/Diagram.html#findNodesByExample" class="linkMethod">findNodesByExample</a> for how the example
data can match data of bound Parts.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#findNodesByExample" class="linkMethod">findNodesByExample</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{...Object}</span> <b>examples</b>
                                          
                                      </dt>
                                      <dd>one or more JavaScript Objects whose properties are either predicates to be
    applied or RegExps to be tested or values to be compared to the corresponding data property value</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Iterator.<Link>}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findNodeForData">
                <td class="name">
                  
                  <div class="name">
                    findNodeForData(nodedata)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Node.html" class="linkConstructor">Node</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Look for a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or <a href="../symbols/Group.html" class="linkConstructor">Group</a>  corresponding to a model's node data object.<span class="nodetails" id="xmethfindNodeForData"><a class="morelink" onclick="hst('methfindNodeForData')">More...</a></span> <span class="details" id="methfindNodeForData"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Object}</span> <b>nodedata</b>
                                          
                                      </dt>
                                      <dd>a JavaScript object matched by reference identity;
  use <a href="../symbols/Diagram.html#findNodesByExample" class="linkMethod">findNodesByExample</a> if you want to find those Nodes whose data matches an example data object</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Node.html" class="linkConstructor">Node</a>}</span> an existing <a href="../symbols/Node.html" class="linkConstructor">Node</a> or <a href="../symbols/Group.html" class="linkConstructor">Group</a> in this Diagram that was
created because its <code>Part.data</code> was the node data in the Diagram's <a href="../symbols/Model.html" class="linkConstructor">Model</a>;
this will be null if there is no such part or if it's just a <a href="../symbols/Part.html" class="linkConstructor">Part</a> or <a href="../symbols/Link.html" class="linkConstructor">Link</a>.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findNodeForKey">
                <td class="name">
                  
                  <div class="name">
                    findNodeForKey(key)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Node.html" class="linkConstructor">Node</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Look for a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or <a href="../symbols/Group.html" class="linkConstructor">Group</a> corresponding to a model's node data object's unique key.<span class="nodetails" id="xmethfindNodeForKey"><a class="morelink" onclick="hst('methfindNodeForKey')">More...</a></span> <span class="details" id="methfindNodeForKey"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{(string|number|undefined)}</span> <b>key</b>
                                          
                                      </dt>
                                      <dd>a string or number.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Node.html" class="linkConstructor">Node</a>}</span> null if a node data with that key cannot be found in the model,
or if a corresponding <a href="../symbols/Node.html" class="linkConstructor">Node</a> or <a href="../symbols/Group.html" class="linkConstructor">Group</a> cannot be found in the Diagram,
or if what is found is just a <a href="../symbols/Part.html" class="linkConstructor">Part</a>.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findNodesByExample">
                <td class="name">
                  
                  <div class="name">
                    findNodesByExample(examples)
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Node>}</span>
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Search for Nodes or Groups by matching the Node data with example data holding values, RegExps, or predicates.<span class="nodetails" id="xmethfindNodesByExample"><a class="morelink" onclick="hst('methfindNodesByExample')">More...</a></span> <span class="details" id="methfindNodesByExample">
</span><div class="details" id="dmethfindNodesByExample"><p>
For example, calling this method with an argument object:
<code>{ sex: "M", name: /^Alex/i, age: function(n) { return n >= 18; } }</code>
will return an iterator of Nodes whose <code>Node.data</code> is a JavaScript object whose:
<ul>
<li>sex is "M" (a case-sensitive string comparison), and</li>
<li>name starts with the string "Alex" (using a case-insensitive match), and</li>
<li>age is greater than or equal to 18
</ul>
<p>
Here is how an example value can match the corresponding data value:
<ul>
<li>
A string, number, or boolean is compared with the === operator.
</li>
<li>
A function is treated as a predicate and applied to the data value.
</li>
<li>
A regular expression (RexExp) is matched against the toString() of the data value.
Common expressions include:
  <ul>
  <li><code>/abc/</code> matches any string that includes exactly the substring "abc"</li>
  <li><code>/abc/i</code> matches any string that includes the substring "abc", but uses a case-insensitive comparison</li>
  <li><code>/^no/i</code> matches any string that starts with "no", ignoring case</li>
  <li><code>/ism$</code> matches any string that ends with "ism" exactly</li>
  <li><code>/(green|red) apple/</code> matches any string that includes either "green apple" or "red apple"</li>
  </ul>
For more details read <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions">Regular Expressions (mozilla.org)</a>.
</li>
<li>
An Array requires the data value to also be an Array of equal or greater length.
Each example array item that is not undefined is matched with the corresponding data array item.
</li>
<li>
An Object is recursively matched with the data value, which must also be an Object.
</li>
</ul>
All properties given by the argument example data must be present on the node data,
unless the example property value is undefined.
All other data properties are ignored when matching.
<p>
When multiple argument objects are given, if any of the objects match the node's data,
the node is included in the results.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#findLinksByExample" class="linkMethod">findLinksByExample</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{...Object}</span> <b>examples</b>
                                          
                                      </dt>
                                      <dd>one or more JavaScript Objects whose properties are either predicates to be
    applied or RegExps to be tested or values to be compared to the corresponding data property value</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Iterator.<Node>}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findObjectAt">
                <td class="name">
                  
                  <div class="name">
                    findObjectAt(p, navig, pred)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Find the front-most <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>
at the given point in document coordinates.<span class="nodetails" id="xmethfindObjectAt"><a class="morelink" onclick="hst('methfindObjectAt')">More...</a></span> <span class="details" id="methfindObjectAt">
</span><div class="details" id="dmethfindObjectAt"><p>
If <a href="../symbols/Layer.html#visible" class="linkProperty">Layer.visible</a> is false, this method will not find any objects in that layer.
However, <a href="../symbols/Layer.html#opacity" class="linkProperty">Layer.opacity</a> does not affect this method.
<p>
Example usage:
<pre>
// Returns the top-most object that is a selectable Part, or null if there isn't one
myDiagram.findObjectAt(
            myDiagram.lastInput.documentPoint,
            // Navigation function
            function(x) { return x.part; },
            // Because of the navigation function, x will always be a Part.
            function(x) { return x.canSelect(); }
);
</pre></div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#findObjectsAt" class="linkMethod">findObjectsAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsIn" class="linkMethod">findObjectsIn</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsNear" class="linkMethod">findObjectsNear</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findPartAt" class="linkMethod">findPartAt</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> <b>p</b>
                                          
                                      </dt>
                                      <dd>A Point in document coordinates.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):GraphObject | null=}</span> <b>navig</b>
                                          
                                      </dt>
                                      <dd>A function taking a GraphObject and
returning a GraphObject, defaulting to the identity.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):boolean | null=}</span> <b>pred</b>
                                          
                                      </dt>
                                      <dd>A function taking the GraphObject
returned by navig and returning true if that object should be returned,
defaulting to a predicate that always returns true.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>}</span> The first GraphObject returned by the <i>navig</i> function
and satisfying the <i>pred</i> function that is at the point <i>p</i>, in Z-order from front to back,
or else null if nothing is found.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findObjectsAt">
                <td class="name">
                  
                  <div class="name">
                    findObjectsAt(p, navig, pred, coll)
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterable.<GraphObject>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Return a collection of the <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s
at the given point in document coordinates.<span class="nodetails" id="xmethfindObjectsAt"><a class="morelink" onclick="hst('methfindObjectsAt')">More...</a></span> <span class="details" id="methfindObjectsAt">
</span><div class="details" id="dmethfindObjectsAt"><p>
If <a href="../symbols/Layer.html#visible" class="linkProperty">Layer.visible</a> is false, this method will not find any objects in that layer.
However, <a href="../symbols/Layer.html#opacity" class="linkProperty">Layer.opacity</a> does not affect this method.
<p>
Example usage:
<pre>
// Returns the Nodes that are at a given point, overlapping each other
myDiagram.findObjectsAt(somePoint,
            // Navigation function -- only return Nodes
            function(x) { var p = x.part; return (p instanceof go.Node) ? p : null; }
);
</pre></div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#findObjectAt" class="linkMethod">findObjectAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsIn" class="linkMethod">findObjectsIn</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsNear" class="linkMethod">findObjectsNear</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findPartAt" class="linkMethod">findPartAt</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> <b>p</b>
                                          
                                      </dt>
                                      <dd>A Point in document coordinates.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):GraphObject | null=}</span> <b>navig</b>
                                          
                                      </dt>
                                      <dd>A function taking a GraphObject and
returning a GraphObject, defaulting to the identity.
If this function returns null, the given GraphObject will not be included in the results.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):boolean | null=}</span> <b>pred</b>
                                          
                                      </dt>
                                      <dd>A function taking the GraphObject
returned by navig and returning true if that object should be returned,
defaulting to a predicate that always returns true.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{List.<GraphObject>|Set.<GraphObject>=}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>An optional collection (List or Set) to add the results to.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Iterable.<GraphObject>}</span> a collection of GraphObjects returned by the <i>navig</i> function
and satisfying the <i>pred</i> that are located at the point <i>p</i>, or else an empty collection.
If a List or Set was passed in, it is returned.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findObjectsIn">
                <td class="name">
                  
                  <div class="name">
                    findObjectsIn(r, navig, pred, partialInclusion, coll)
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterable.<GraphObject>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Returns a collection of all <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s that are inside or that intersect
a given <a href="../symbols/Rect.html" class="linkConstructor">Rect</a> in document coordinates.<span class="nodetails" id="xmethfindObjectsIn"><a class="morelink" onclick="hst('methfindObjectsIn')">More...</a></span> <span class="details" id="methfindObjectsIn">
</span><div class="details" id="dmethfindObjectsIn"><p>
If <a href="../symbols/Layer.html#visible" class="linkProperty">Layer.visible</a> is false, this method will not find any objects in that layer.
However, <a href="../symbols/Layer.html#opacity" class="linkProperty">Layer.opacity</a> does not affect this method.
<p>
Example usage:
<pre>
// Returns the Links that intersect a given rectangle and have a certain data property
myDiagram.findObjectsIn(someRect,
            // Navigation function -- only return Links
            function(x) { var p = x.part; return (p instanceof go.Link) ? p : null; },
            // Predicate that always receives a Link, due to above navigation function
            function(link) { return link.data.someProp > 17; },
            // the links may only partly overlap the given rectangle
            true
);
</pre></div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#findObjectAt" class="linkMethod">findObjectAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsAt" class="linkMethod">findObjectsAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsNear" class="linkMethod">findObjectsNear</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findPartAt" class="linkMethod">findPartAt</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span> <b>r</b>
                                          
                                      </dt>
                                      <dd>A Rect in document coordinates.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):GraphObject | null=}</span> <b>navig</b>
                                          
                                      </dt>
                                      <dd>A function taking a GraphObject and
returning a GraphObject, defaulting to the identity.
If this function returns null, the given GraphObject will not be included in the results.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):boolean | null=}</span> <b>pred</b>
                                          
                                      </dt>
                                      <dd>A function taking the GraphObject
returned by navig and returning true if that object should be returned,
defaulting to a predicate that always returns true.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean=}</span> <b>partialInclusion</b>
                                          
                                      </dt>
                                      <dd>Whether an object can match if it merely intersects the rectangular area (true) or
if it must be entirely inside the rectangular area (false).  The default value is false.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{List.<GraphObject>|Set.<GraphObject>=}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>An optional collection (List or Set) to add the results to.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Iterable.<GraphObject>}</span> a collection of GraphObjects returned by the <i>navig</i> function
and satisfying the <i>pred</i> function that are within the rectangle <i>r</i>, or else an empty collection.
If a List or Set was passed in, it is returned.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findObjectsNear">
                <td class="name">
                  
                  <div class="name">
                    findObjectsNear(p, dist, navig, pred, partialInclusion, coll)
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterable.<GraphObject>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Returns a collection of all <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>s that are within a certain distance
of a given point in document coordinates.<span class="nodetails" id="xmethfindObjectsNear"><a class="morelink" onclick="hst('methfindObjectsNear')">More...</a></span> <span class="details" id="methfindObjectsNear">
</span><div class="details" id="dmethfindObjectsNear"><p>
If <a href="../symbols/Layer.html#visible" class="linkProperty">Layer.visible</a> is false, this method will not find any objects in that layer.
However, <a href="../symbols/Layer.html#opacity" class="linkProperty">Layer.opacity</a> does not affect this method.
<p>
Example usage:
<pre>
// Returns the Nodes that intersect a given circular area and have a certain data property
myDiagram.findObjectsNear(somePoint,
            // The circular area is centered at somePoint and has radius 100
            100,
            // Navigation function -- only return Nodes
            function(x) { var p = x.part; return (p instanceof go.Node) ? p : null; },
            // Predicate that always receives a Node, due to above navigation function
            function(node) { return node.data.someProp > 17; },
            // the nodes may only partly overlap the given circular area
            true
);
</pre></div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#findObjectAt" class="linkMethod">findObjectAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsAt" class="linkMethod">findObjectsAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsIn" class="linkMethod">findObjectsIn</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findPartAt" class="linkMethod">findPartAt</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> <b>p</b>
                                          
                                      </dt>
                                      <dd>A Point in document coordinates.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number}</span> <b>dist</b>
                                          
                                      </dt>
                                      <dd>The distance from the point.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):GraphObject | null=}</span> <b>navig</b>
                                          
                                      </dt>
                                      <dd>A function taking a GraphObject and
returning a GraphObject, defaulting to the identity.
If this function returns null, the given GraphObject will not be included in the results.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(GraphObject):boolean | null=}</span> <b>pred</b>
                                          
                                      </dt>
                                      <dd>A function taking the GraphObject
returned by navig and returning true if that object should be returned,
defaulting to a predicate that always returns true.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{*=}</span> <b>partialInclusion</b>
                                          
                                      </dt>
                                      <dd>Whether an object can match if it merely intersects the circular area (true) or
if it must be entirely inside the circular area (false).  The default value is true.
The default is true.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{List.<GraphObject>|Set.<GraphObject>=}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>An optional collection (List or Set) to add the results to.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Iterable.<GraphObject>}</span> a collection of GraphObjects returned by the <i>navig</i> function
and satisfying the <i>pred</i> that are located near the point <i>p</i>, or else an empty collection.
If a List or Set was passed in, it is returned.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findPartAt">
                <td class="name">
                  
                  <div class="name">
                    findPartAt(p, selectable)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This convenience function finds the front-most <a href="../symbols/Part.html" class="linkConstructor">Part</a>
that is at a given point that might be selectable and that is not in a temporary layer.<span class="nodetails" id="xmethfindPartAt"><a class="morelink" onclick="hst('methfindPartAt')">More...</a></span> <span class="details" id="methfindPartAt">
</span><div class="details" id="dmethfindPartAt"><p>
This just calls <a href="../symbols/Diagram.html#findObjectAt" class="linkMethod">findObjectAt</a> with appropriate arguments,
but ignoring Layers that are <a href="../symbols/Layer.html#isTemporary" class="linkProperty">Layer.isTemporary</a>.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#findObjectAt" class="linkMethod">findObjectAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsAt" class="linkMethod">findObjectsAt</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsIn" class="linkMethod">findObjectsIn</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findObjectsNear" class="linkMethod">findObjectsNear</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> <b>p</b>
                                          
                                      </dt>
                                      <dd>a Point in document coordinates.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean}</span> <b>selectable</b>
                                          
                                      </dt>
                                      <dd>Whether to only consider parts that are <a href="../symbols/Part.html#selectable" class="linkProperty">Part.selectable</a>.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findPartForData">
                <td class="name">
                  
                  <div class="name">
                    findPartForData(data)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Look for a <a href="../symbols/Part.html" class="linkConstructor">Part</a>, <a href="../symbols/Node.html" class="linkConstructor">Node</a>, <a href="../symbols/Group.html" class="linkConstructor">Group</a>, or <a href="../symbols/Link.html" class="linkConstructor">Link</a> corresponding to a <a href="../symbols/Model.html" class="linkConstructor">Model</a>'s data object.<span class="nodetails" id="xmethfindPartForData"><a class="morelink" onclick="hst('methfindPartForData')">More...</a></span> <span class="details" id="methfindPartForData">
We recommend that you call <a href="../symbols/Diagram.html#findNodeForData" class="linkMethod">findNodeForData</a> or <a href="../symbols/Diagram.html#findLinkForData" class="linkMethod">findLinkForData</a> if you are looking for a <a href="../symbols/Node.html" class="linkConstructor">Node</a> or a <a href="../symbols/Link.html" class="linkConstructor">Link</a>.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Object}</span> <b>data</b>
                                          
                                      </dt>
                                      <dd>a JavaScript object matched by reference identity</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span> an existing <a href="../symbols/Part.html" class="linkConstructor">Part</a> in this Diagram that was
created because its <code>Part.data</code> was the data in the Diagram's <a href="../symbols/Model.html" class="linkConstructor">Model</a>.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findPartForKey">
                <td class="name">
                  
                  <div class="name">
                    findPartForKey(key)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Look for a <a href="../symbols/Part.html" class="linkConstructor">Part</a> or <a href="../symbols/Node.html" class="linkConstructor">Node</a> or <a href="../symbols/Group.html" class="linkConstructor">Group</a> corresponding to a model's data object's unique key.<span class="nodetails" id="xmethfindPartForKey"><a class="morelink" onclick="hst('methfindPartForKey')">More...</a></span> <span class="details" id="methfindPartForKey">
This will find a <a href="../symbols/Link.html" class="linkConstructor">Link</a> if the model is a <a href="../symbols/GraphLinksModel.html" class="linkConstructor">GraphLinksModel</a> that is maintaining a key on the link data objects.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{(string|number|undefined)}</span> <b>key</b>
                                          
                                      </dt>
                                      <dd>a string or number.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span> null if a data with that key cannot be found in the model,
or if a corresponding <a href="../symbols/Part.html" class="linkConstructor">Part</a> cannot be found in the Diagram.
This will not return a <a href="../symbols/Link.html" class="linkConstructor">Link</a> unless the model is a <a href="../symbols/GraphLinksModel.html" class="linkConstructor">GraphLinksModel</a> and
<a href="../symbols/GraphLinksModel.html#linkKeyProperty" class="linkProperty">GraphLinksModel.linkKeyProperty</a> has been set.
If the same key is used for both a node data object and a link data object, this will return a Node.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findTopLevelGroups">
                <td class="name">
                  
                  <div class="name">
                    findTopLevelGroups()
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Group>}</span>
                    
                      <span class="since" title="since">1.2</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Returns an iterator of all <a href="../symbols/Group.html" class="linkConstructor">Group</a>s that are at top-level,
in other words that are not themselves inside other Groups.<span class="nodetails" id="xmethfindTopLevelGroups"><a class="morelink" onclick="hst('methfindTopLevelGroups')">More...</a></span> <span class="details" id="methfindTopLevelGroups">
</span><div class="details" id="dmethfindTopLevelGroups"><p>
This is useful for when you want to traverse the diagram's graph by recursing into Groups.</div>
                 
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Iterator.<Group>}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="findTreeRoots">
                <td class="name">
                  
                  <div class="name">
                    findTreeRoots()
                  </div>
                  <div class="attributes">
                    <span class="light">{Iterator.<Node>}</span>
                    
                      <span class="since" title="since">1.2</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Returns an iterator of all top-level <a href="../symbols/Node.html" class="linkConstructor">Node</a>s that have no tree parents.<span class="nodetails" id="xmethfindTreeRoots"><a class="morelink" onclick="hst('methfindTreeRoots')">More...</a></span> <span class="details" id="methfindTreeRoots">
</span><div class="details" id="dmethfindTreeRoots"><p>
This is useful for when you want to traverse the diagram's graph by starting at the root of each tree,
assuming that the diagram consists of one tree or a forest of trees.</div>
                 
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{Iterator.<Node>}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="focus">
                <td class="name">
                  
                  <div class="name">
                    focus()
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Explicitly bring HTML focus to the Diagram's canvas.<span class="nodetails" id="xmethfocus"><a class="morelink" onclick="hst('methfocus')">More...</a></span> <span class="details" id="methfocus">
Used in tools that may create other HTML elements such as TextEditingTool.
</span><div class="details" id="dmethfocus"><p>
If <a href="../symbols/Diagram.html#scrollsPageOnFocus" class="linkProperty">scrollsPageOnFocus</a> is false, this tries to keep the page at the same scroll position
that it had before calling <a href="../symbols/Diagram.html#focus" class="linkMethod">focus</a>.
This method is not overridable.</div>
                 
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".fromDiv">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Diagram.fromDiv(div)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function gets the <a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a> that is attached to an HTML DIV element.<span class="nodetails" id="xmethfromDiv"><a class="morelink" onclick="hst('methfromDiv')">More...</a></span> <span class="details" id="methfromDiv"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Element|string}</span> <b>div</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a>}</span> null if there is no <a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a> associated with the given DIV,
or if the argument is not a DIV element nor a string naming such a DIV element in the HTML document.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="highlight">
                <td class="name">
                  
                  <div class="name">
                    highlight(part)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.4</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Make the given part the only highlighted part.<span class="nodetails" id="xmethhighlight"><a class="morelink" onclick="hst('methhighlight')">More...</a></span> <span class="details" id="methhighlight"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Part.html#isHighlighted" class="linkProperty">Part.isHighlighted</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#highlightCollection" class="linkMethod">highlightCollection</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#clearHighlighteds" class="linkMethod">clearHighlighteds</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span> <b>part</b>
                                          
                                      </dt>
                                      <dd>a Part that is already in a layer of this Diagram.
If the value is null, this does nothing.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="highlightCollection">
                <td class="name">
                  
                  <div class="name">
                    highlightCollection(coll)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.4</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Highlight all of the <a href="../symbols/Part.html" class="linkConstructor">Part</a>s supplied in the given collection, and clear all other highlighted Parts.<span class="nodetails" id="xmethhighlightCollection"><a class="morelink" onclick="hst('methhighlightCollection')">More...</a></span> <span class="details" id="methhighlightCollection"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Part.html#isHighlighted" class="linkProperty">Part.isHighlighted</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#highlight" class="linkMethod">highlight</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#clearHighlighteds" class="linkMethod">clearHighlighteds</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Iterable.<Part>|Array.<Part>}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>a <a href="../symbols/List.html" class="linkConstructor">List</a> or <a href="../symbols/Set.html" class="linkConstructor">Set</a> or <a href="../symbols/Iterator.html" class="linkConstructor">Iterator</a> or Array, of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s to be highlighted.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".inherit">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Diagram.inherit(derivedclass, baseclass)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function declares that a class (constructor function) derives from another class --
<b><i>but please note that most classes do not support inheritance</i></b>.<span class="nodetails" id="xmethinherit"><a class="morelink" onclick="hst('methinherit')">More...</a></span> <span class="details" id="methinherit">
Do not call this function when your class is defined using an ES2015 or TypeScript "class" declaration.
</span><div class="details" id="dmethinherit"><p>
Because you must not modify the prototypes for the <b>GoJS</b> classes,
in order to override methods you need to define a new class that inherits from a predefined class.
You can then modify the prototype of your derived class.
<p>
Typical usage is:
<pre>
 function BaseClass() {
   this._total = 0;
 }

 BaseClass.prototype.increment = function(x) {
   this._total += x;
 }

 function DerivedClass() {
   this._anotherProperty = "";
 }
 go.Diagram.inherit(DerivedClass, BaseClass);

 DerivedClass.prototype.someMethod = ...;
</pre>
<p>
<b><i>Note that most classes do not support inheritance.</i></b>
Currently you can only inherit from <a href="../symbols/Layout.html" class="linkConstructor">Layout</a>, <a href="../symbols/Tool.html" class="linkConstructor">Tool</a>, <a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a>, and <a href="../symbols/Link.html" class="linkConstructor">Link</a> or their subclasses.
When you override a method, you must strongly consider calling the base method.
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call a base method.
<p>
The call to <code>Diagram.inherit</code> should be made immediately after defining the subclass constructor function
and before defining any new methods or overriding any base class methods.
You must not call this static function more than once on a derived class, or at all on a class defined using an ES2015 or TypeScript class declaration.
<p>
The need for subclassing is greatly diminished by the presence of a number of properties that have functional values.
Setting such a property to a function will cause that function to be called as if it were
an event handler for that particular object.
Example properties include: <a href="../symbols/GraphObject.html#click" class="linkProperty">GraphObject.click</a>, <a href="../symbols/GraphObject.html#mouseEnter" class="linkProperty">GraphObject.mouseEnter</a>, <a href="../symbols/Part.html#layerChanged" class="linkProperty">Part.layerChanged</a>,
<a href="../symbols/Node.html#treeExpandedChanged" class="linkProperty">Node.treeExpandedChanged</a>, <a href="../symbols/LinkingBaseTool.html#linkValidation" class="linkProperty">LinkingBaseTool.linkValidation</a>, <a href="../symbols/CommandHandler.html#memberValidation" class="linkProperty">CommandHandler.memberValidation</a>,
<a href="../symbols/TextEditingTool.html#textValidation" class="linkProperty">TextEditingTool.textValidation</a>.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Function}</span> <b>derivedclass</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Function}</span> <b>baseclass</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="layoutDiagram">
                <td class="name">
                  
                  <div class="name">
                    layoutDiagram(invalidateAll)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Perform all invalid layouts.<span class="nodetails" id="xmethlayoutDiagram"><a class="morelink" onclick="hst('methlayoutDiagram')">More...</a></span> <span class="details" id="methlayoutDiagram">
If the optional argument is true,
this will perform all of the layouts (<a href="../symbols/Diagram.html#layout" class="linkProperty">Diagram.layout</a> and all <a href="../symbols/Group.html#layout" class="linkProperty">Group.layout</a>s),
not just the invalid ones.
</span><div class="details" id="dmethlayoutDiagram"><p>
Under normal circumstances you should not need to call this method,
because layouts will be performed automatically after they become invalid.
However you may have disabled automatic layouts by setting <a href="../symbols/Layout.html#isInitial" class="linkProperty">Layout.isInitial</a>
and/or <a href="../symbols/Layout.html#isOngoing" class="linkProperty">Layout.isOngoing</a> to false, or by restricting a Part's <a href="../symbols/Part.html#layoutConditions" class="linkProperty">Part.layoutConditions</a>.
If that is the case you might call this method
(perhaps due to a user command) to perform the layout at a time of your choosing.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean=}</span> <b>invalidateAll</b>
                                          
                                      </dt>
                                      <dd>If true, this will explicitly set <a href="../symbols/Layout.html#isValidLayout" class="linkProperty">Layout.isValidLayout</a> to false on each <a href="../symbols/Layout.html" class="linkConstructor">Layout</a> in the diagram.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="makeImage">
                <td class="name">
                  
                  <div class="name">
                    makeImage(properties)
                  </div>
                  <div class="attributes">
                    <span class="light">{HTMLImageElement}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p><p>
Create an HTMLImageElement that contains a bitmap of the current Diagram.<span class="nodetails" id="xmethmakeImage"><a class="morelink" onclick="hst('methmakeImage')">More...</a></span> <span class="details" id="methmakeImage">
This method is just a convenience function that creates an image,
sets its source to the returned string of <a href="../symbols/Diagram.html#makeImageData" class="linkMethod">makeImageData</a>,
and returns a reference to that Image.
</span><div class="details" id="dmethmakeImage"><p>
By default this method returns a snapshot of the visible diagram, but optional arguments give more options.
<p>
At the current time methods such as <a href="../symbols/Diagram.html#makeImage" class="linkMethod">Diagram.makeImage</a>,
<a href="../symbols/Diagram.html#makeImageData" class="linkMethod">Diagram.makeImageData</a> and <a href="../symbols/Diagram.html#makeSvg" class="linkMethod">Diagram.makeSvg</a> do not work on <a href="../symbols/Overview.html" class="linkConstructor">Overview</a>s.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#makeImageData" class="linkMethod">makeImageData</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#makeSvg" class="linkMethod">makeSvg</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{{ size: Size,
            scale: number,
            maxSize: Size,
            position: Point,
            parts: Iterable,
            padding: (Margin|number),
            showTemporary: boolean,
            showGrid: boolean,
            document: Document,

            type: string,
            details: *
          }|Object=}</span> <b>properties</b>
                                          
                                      </dt>
                                      <dd>a JavaScript object detailing optional arguments for image creation, to be passed to makeImageData.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{HTMLImageElement}</span> An HTML Image element.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="makeImageData">
                <td class="name">
                  
                  <div class="name">
                    makeImageData(properties)
                  </div>
                  <div class="attributes">
                    <span class="light">{ImageData|string}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Create a bitmap of the current Diagram encoded as a base64 string, or returned as an ImageData object.<span class="nodetails" id="xmethmakeImageData"><a class="morelink" onclick="hst('methmakeImageData')">More...</a></span> <span class="details" id="methmakeImageData">
This method uses the toDataURL method of the HTMLCanvasElement to create the data URL,
or the getImageData method of the Canvas Context.
Unlike toDataURL, this method will not throw an error if cross-domain images
were drawn on the canvas, instead it will return a data URL of a bitmap with those images omitted.
<p class="boxread">
See the page on <a href="../../intro/makingImages.html">Making Images</a> for usage examples.</p>
</span><div class="details" id="dmethmakeImageData"><p>
At the current time methods such as <a href="../symbols/Diagram.html#makeImage" class="linkMethod">Diagram.makeImage</a>,
<a href="../symbols/Diagram.html#makeImageData" class="linkMethod">Diagram.makeImageData</a> and <a href="../symbols/Diagram.html#makeSvg" class="linkMethod">Diagram.makeSvg</a> do not work on <a href="../symbols/Overview.html" class="linkConstructor">Overview</a>s.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#makeImage" class="linkMethod">makeImage</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{{ size: Size,
            scale: number,
            maxSize: Size,
            position: Point,
            parts: Iterable,
            padding: (Margin|number),
            showTemporary: boolean,
            showGrid: boolean,
            document: Document,

            returnType: string,
            callback: function(Blob),
            type: string,
            details: *
          }|Object=}</span> <b>properties</b>
                                          
                                      </dt>
                                      <dd>a JavaScript object detailing optional arguments for image creation.
<p>Image creation arguments:
<ul>
<li><strong>size:</strong>
The size of the created image, as a <a href="../symbols/Size.html" class="linkConstructor">Size</a>, limited by the <strong>maxSize</strong> property.
If no <strong>scale</strong> or <strong>position</strong> is specified then the diagram will be scaled to fit the given size.
If you set a size, you should also set a <strong>position</strong>. If you are scaling the diagram, you may also want to scale the size.
<li><strong>scale:</strong>
The scale of the diagram. If <strong>scale</strong> is specified and <strong>size</strong> is not, the resulting image will be sized to uniformly
fit the space needed for the given scale.
Can be constrained by the <strong>maxSize</strong> property. A scale value of <code>NaN</code> will
automatically scale ot fit within the maxSize, but may be smaller, with a maximum computed scale of 1.
<li><strong>maxSize:</strong>
The maximum size of the created image, as a <a href="../symbols/Size.html" class="linkConstructor">Size</a>. The default value is <code>(Infinity, Infinity)</code> for SVG and <code>(2000, 2000)</code> for images.
This is typically used when <strong>scale</strong> is specified.
<li><strong>position:</strong>
The position of the diagram, as a <a href="../symbols/Point.html" class="linkConstructor">Point</a>.
By default this is the position of <a href="../symbols/Diagram.html#documentBounds" class="linkProperty">Diagram.documentBounds</a> with the <a href="../symbols/Diagram.html#padding" class="linkProperty">Diagram.padding</a> removed.
If a specific parts collection is used, by default this is the top-left diagram position of their collective bounds.
If you set a <code>position</code>, you should also set a <code>size</code>.
<li><strong>parts:</strong>
An iterator of GraphObjects, typically Parts, such as one from <a href="../symbols/Diagram.html#selection" class="linkProperty">Diagram.selection</a> or <a href="../symbols/Layer.html#parts" class="linkProperty">Layer.parts</a>.
If GraphObjects are specified their containing Part will be drawn. By default all Parts are drawn except temporary parts (see <strong>showTemporary</strong>).
<li><strong>padding:</strong>
A <a href="../symbols/Margin.html" class="linkConstructor">Margin</a> (or number) to pad the image with. If a size is specified,
the padding will not increase the image size, it will only offset the Diagram contents within the image.
The default value is a padding of <code>1</code>.
<li><strong>background:</strong>
A valid CSS color to replace the default (transparent) canvas background. Any padding area is also colored.
<li><strong>showTemporary:</strong>
A boolean value, defaulting to false,
that determines whether or not temporary objects such as adornments are included in the image.
<li><strong>showGrid:</strong>
A boolean value, defaulting to the value of <strong>showTemporary</strong>,
that determines whether or not the Grid Layer (containing <a href="../symbols/Diagram.html#grid" class="linkProperty">Diagram.grid</a>) is included in the image
regardless of the value of <strong>showTemporary</strong>.
This is useful if you want to include the grid but not adornments, or vice versa.
<li><strong>document:</strong>
An HTML Document, defaulting to <code>window.document</code>
This may be useful to set if you intend your Image or SVG to be opened in a new window.
</ul>
<p>Additional Image-specific arguments:
<ul>
<li><strong>type:</strong>
The optional MIME type of the image. Valid values are typically <code>"image/png"</code> and <code>"image/jpeg"</code>.
Some browsers allow <code>"image/webp"</code>. The default value is <code>"image/png"</code>, and unrecognized values will defer to the default.
<li><strong>returnType:</strong>
The optional return type of the image data. Valid values are <code>"ImageData"</code>, <code>"string"</code>, and <code>"blob"</code>.
The <code>"string"</code> option returns a base64 string representation of the image.
The <code>"ImageData"</code> option returns an <code>ImageData</code> object representation of the image.
The <code>"blob"</code> option requires that the <strong>callback</strong> property is also defined.
The default value is <code>"string"</code>, and unrecognized values will return a string.
<li><strong>callback:</strong>
Only used if the <strong>returnType</strong> is <code>"blob"</code>.
The function to call when a blob is finished creation. It has one argument, the blob object.
See the <a href="../../samples/minimalBlob.html">Minimal Image Blob Download sample</a> for an example usage,
which also demonstrates downloading an image file without involving a web server.
<li><strong>details:</strong>
The optional details to pass to the HTMLCanvasElement's toDataURL function.
If the type is <code>"image/jpeg"</code> then this can be a number from <code>0</code> to <code>1</code>, inclusive, describing the desired jpeg quality.
</ul>
<p>Additional SVG-specific arguments:
<ul>
<li><strong>elementFinished:</strong>
A function with two arguments, GraphObject and SVGElement.
As the SVG elements are created representing each graph object, this function is called on them,
allowing you to modify the SVG as it is being built, to assign stylesheets, IDs, etc. Example:
<pre class="javascript">
elementFinished: function(graphObject, SVGElement) {
  // set something on every SVG element that represents a GoJS TextBlock
  if (graphObject instanceof go.TextBlock) SVGElement.setAttribute(...);
}
</pre>
</ul></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{ImageData|string}</span> An ImageData, or a base64-encoded string describing an image.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="makeSvg">
                <td class="name">
                  
                  <div class="name">
                    makeSvg(properties)
                  </div>
                  <div class="attributes">
                    <span class="light">{SVGElement}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p><p>
Create an SVGElement that contains a SVG rendering of the current Diagram.<span class="nodetails" id="xmethmakeSvg"><a class="morelink" onclick="hst('methmakeSvg')">More...</a></span> <span class="details" id="methmakeSvg">
</span><div class="details" id="dmethmakeSvg"><p>
By default this method returns a snapshot of the visible diagram, but optional arguments give more options.
<p class="boxread">
See the page on <a href="../../intro/makingSVG.html">Making SVG</a> for usage examples.
See the <a href="../../samples/minimalSVG.html">Minimal SVG Download sample</a>,
which also demonstrates downloading an SVG file without involving a web server.
<p>
See <a href="../symbols/Diagram.html#makeImageData" class="linkMethod">makeImageData</a> for a complete explanation of possible parameters.
<p>
At the current time methods such as <a href="../symbols/Diagram.html#makeImage" class="linkMethod">Diagram.makeImage</a>,
<a href="../symbols/Diagram.html#makeImageData" class="linkMethod">Diagram.makeImageData</a> and <a href="../symbols/Diagram.html#makeSvg" class="linkMethod">Diagram.makeSvg</a> do not work on <a href="../symbols/Overview.html" class="linkConstructor">Overview</a>s.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#makeImage" class="linkMethod">makeImage</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{{ size: Size,
            scale: number,
            maxSize: Size,
            position: Point,
            parts: Iterable,
            padding: (Margin|number),
            showTemporary: boolean,
            showGrid: boolean,
            document: Document,
            elementFinished: function(GraphObject, SVGElement),

            details: *
}|Object=}</span> <b>properties</b>
                                          
                                      </dt>
                                      <dd>a JavaScript object detailing optional arguments for SVG creation.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{SVGElement}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="moveParts">
                <td class="name">
                  
                  <div class="name">
                    moveParts(coll, offset, check)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.3</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Move a collection of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s in this Diagram by a given offset.<span class="nodetails" id="xmethmoveParts"><a class="morelink" onclick="hst('methmoveParts')">More...</a></span> <span class="details" id="methmoveParts">
Moving a <a href="../symbols/Group.html" class="linkConstructor">Group</a> will also move its member Nodes and Links.
Moving with a zero X and a zero Y offset is potentially useful in order to snap Parts to the grid if <a href="../symbols/DraggingTool.html#isGridSnapEnabled" class="linkProperty">DraggingTool.isGridSnapEnabled</a> is true.
</span><div class="details" id="dmethmoveParts"><p>
This does not perform a transaction nor does it raise a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>.
<p>
This calls <a href="../symbols/DraggingTool.html#moveParts" class="linkMethod">DraggingTool.moveParts</a> to carefully perform the movement of the parts.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Iterable.<Part>}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>A <a href="../symbols/List.html" class="linkConstructor">List</a> or a <a href="../symbols/Set.html" class="linkConstructor">Set</a> or <a href="../symbols/Iterator.html" class="linkConstructor">Iterator</a> of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s, or null to move all of the Parts in this Diagram.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> <b>offset</b>
                                          
                                      </dt>
                                      <dd>the X and Y change to be made to each Part, in document coordinates.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean}</span> <b>check</b>
                                          
                                      </dt>
                                      <dd>Whether to check <a href="../symbols/Part.html#canMove" class="linkMethod">Part.canMove</a> on each part.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="rebuildParts">
                <td class="name">
                  
                  <div class="name">
                    rebuildParts()
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Remove all of the <a href="../symbols/Part.html" class="linkConstructor">Part</a>s created from model data
and then create them again.<span class="nodetails" id="xmethrebuildParts"><a class="morelink" onclick="hst('methrebuildParts')">More...</a></span> <span class="details" id="methrebuildParts">
This must be called after modifying or replacing any of the template maps
such as <a href="../symbols/Diagram.html#nodeTemplateMap" class="linkProperty">nodeTemplateMap</a>.
This re-selects all of the new Parts that were created from data of the original selected Parts.
</span><div class="details" id="dmethrebuildParts"><p>
If you modify a template Map, there is no notification that the map has changed.
You will need to call rebuildParts explicitly.
If you are replacing the <a href="../symbols/Diagram.html#nodeTemplate" class="linkProperty">nodeTemplate</a> or the <a href="../symbols/Diagram.html#nodeTemplateMap" class="linkProperty">nodeTemplateMap</a> or
the corresponding properties for Groups or Links,
the Diagram property setters will automatically call rebuildParts.
<p>
It is extremely wasteful to call this method after making some model data changes that you want to
be reflected in the diagram.  Instead, it is better call <a href="../symbols/Model.html#setDataProperty" class="linkMethod">Model.setDataProperty</a>,
<a href="../symbols/Model.html#addNodeData" class="linkMethod">Model.addNodeData</a>, <a href="../symbols/Model.html#removeNodeData" class="linkMethod">Model.removeNodeData</a>, or other model methods.
Not only do those methods update efficiently, they also preserve unbound state and support undo/redo.</div>
                 
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="remove">
                <td class="name">
                  
                  <div class="name">
                    remove(part)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Removes a <a href="../symbols/Part.html" class="linkConstructor">Part</a> from its <a href="../symbols/Layer.html" class="linkConstructor">Layer</a>, provided the Layer is in this Diagram.<span class="nodetails" id="xmethremove"><a class="morelink" onclick="hst('methremove')">More...</a></span> <span class="details" id="methremove">
Removing a <a href="../symbols/Node.html" class="linkConstructor">Node</a> will also remove any Links that are connected with it.
Removing a <a href="../symbols/Group.html" class="linkConstructor">Group</a> will also remove all of its members.
Removing a <a href="../symbols/Link.html" class="linkConstructor">Link</a> will also remove all of its label Nodes, if it has any.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span> <b>part</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="removeChangedListener">
                <td class="name">
                  
                  <div class="name">
                    removeChangedListener(listener)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Unregister a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> handler.<span class="nodetails" id="xmethremoveChangedListener"><a class="morelink" onclick="hst('methremoveChangedListener')">More...</a></span> <span class="details" id="methremoveChangedListener"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#addChangedListener" class="linkMethod">addChangedListener</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(ChangedEvent)}</span> <b>listener</b>
                                          
                                      </dt>
                                      <dd>a function that takes a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> as its argument.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="removeDiagramListener">
                <td class="name">
                  
                  <div class="name">
                    removeDiagramListener(name, listener)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Unregister a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a> handler.<span class="nodetails" id="xmethremoveDiagramListener"><a class="morelink" onclick="hst('methremoveDiagramListener')">More...</a></span> <span class="details" id="methremoveDiagramListener">
</span><div class="details" id="dmethremoveDiagramListener"><p>
See the documentation for <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a> for a complete listing of diagram event names and their purposes.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>name</b>
                                          
                                      </dt>
                                      <dd>the name is normally capitalized, but this method uses case-insensitive comparison.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(DiagramEvent)}</span> <b>listener</b>
                                          
                                      </dt>
                                      <dd>a function that takes a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a> as its argument.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="removeLayer">
                <td class="name">
                  
                  <div class="name">
                    removeLayer(layer)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Removes the given layer from the list of layers.<span class="nodetails" id="xmethremoveLayer"><a class="morelink" onclick="hst('methremoveLayer')">More...</a></span> <span class="details" id="methremoveLayer">
</span><div class="details" id="dmethremoveLayer"><p>
Removing a layer does not remove the Parts in the layer. Instead, those Parts are placed into the default layer.
To remove all Parts in a layer you can call <a href="../symbols/Diagram.html#removeParts" class="linkMethod">Diagram.removeParts</a> with <a href="../symbols/Layer.html#parts" class="linkProperty">Layer.parts</a> as the argument.
<p>
You cannot remove the default layer, the one named with the empty string.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#addLayer" class="linkMethod">addLayer</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#addLayerBefore" class="linkMethod">addLayerBefore</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#addLayerAfter" class="linkMethod">addLayerAfter</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#findLayer" class="linkMethod">findLayer</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Layer.html" class="linkConstructor">Layer</a>}</span> <b>layer</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="removeModelChangedListener">
                <td class="name">
                  
                  <div class="name">
                    removeModelChangedListener(listener)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.6</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Unregister a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> handler from this Diagram's <a href="../symbols/Diagram.html#model" class="linkProperty">Diagram.model</a>.<span class="nodetails" id="xmethremoveModelChangedListener"><a class="morelink" onclick="hst('methremoveModelChangedListener')">More...</a></span> <span class="details" id="methremoveModelChangedListener"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#addModelChangedListener" class="linkMethod">addModelChangedListener</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{function(ChangedEvent)}</span> <b>listener</b>
                                          
                                      </dt>
                                      <dd>a function that takes a <a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a> as its argument.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="removeParts">
                <td class="name">
                  
                  <div class="name">
                    removeParts(coll, check)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.3</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This method removes from this Diagram all of the <a href="../symbols/Part.html" class="linkConstructor">Part</a>s in a collection.<span class="nodetails" id="xmethremoveParts"><a class="morelink" onclick="hst('methremoveParts')">More...</a></span> <span class="details" id="methremoveParts">
Removing a <a href="../symbols/Node.html" class="linkConstructor">Node</a> will also remove any Links that are connected with it.
Removing a <a href="../symbols/Group.html" class="linkConstructor">Group</a> will also remove all of its members.
Removing a <a href="../symbols/Link.html" class="linkConstructor">Link</a> will also remove all of its label Nodes, if it has any.
</span><div class="details" id="dmethremoveParts"><p>
This does not perform a transaction nor does it raise a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>.
Call <a href="../symbols/CommandHandler.html#deleteSelection" class="linkMethod">CommandHandler.deleteSelection</a>, which calls this method,
if you want to delete all selected Parts.
The <a href="../symbols/CommandHandler.html#deleteSelection" class="linkMethod">CommandHandler.deleteSelection</a> command may delete other Parts as well, depending on <a href="../symbols/CommandHandler.html#deletesTree" class="linkProperty">CommandHandler.deletesTree</a>.
<p>
At this time there is no "addParts" method -- just call <a href="../symbols/Diagram.html#add" class="linkMethod">Diagram.add</a> on each Part.</div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Iterable.<Part>|Array.<Part>}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>A <a href="../symbols/List.html" class="linkConstructor">List</a> or <a href="../symbols/Set.html" class="linkConstructor">Set</a> or <a href="../symbols/Iterator.html" class="linkConstructor">Iterator</a> or Array of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean}</span> <b>check</b>
                                          
                                      </dt>
                                      <dd>Whether to check <a href="../symbols/Part.html#canDelete" class="linkMethod">Part.canDelete</a> on each part.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="requestUpdate">
                <td class="name">
                  
                  <div class="name">
                    requestUpdate(alwaysQueueUpdate)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.6</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Usage of this method is uncommon and may affect performance,
for efficiency do not call this method unless you have a well-defined need.<span class="nodetails" id="xmethrequestUpdate"><a class="morelink" onclick="hst('methrequestUpdate')">More...</a></span> <span class="details" id="methrequestUpdate">
Normally, GoJS updates the diagram automatically, and completeing a transaction ensures an immediate update.
</span><div class="details" id="dmethrequestUpdate"><p>
The most common reason to call this method when the HTML Div has changed size but the window has not changed size,
and the Diagram needs to be notified of this DOM change. See an example of resizing diagrams
<a href="../../intro/resizing.html">here</a>.
<p>
Requests that in the near-future the diagram makes sure all GraphObjects are arranged,
recomputes the document bounds, updates the scrollbars, and redraws the viewport.
<p></div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{boolean=}</span> <b>alwaysQueueUpdate</b>
                                          
                                      </dt>
                                      <dd>If true the Diagram will queue another update,
even if an update is already occurring. The default value is false.
Side effects in an "InitialLayoutCompleted" DiagramEvent listener might necessitate setting this parameter.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="rollbackTransaction">
                <td class="name">
                  
                  <div class="name">
                    rollbackTransaction()
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Rollback the current transaction, undoing any recorded changes.<span class="nodetails" id="xmethrollbackTransaction"><a class="morelink" onclick="hst('methrollbackTransaction')">More...</a></span> <span class="details" id="methrollbackTransaction">
This just calls <a href="../symbols/UndoManager.html#rollbackTransaction" class="linkMethod">UndoManager.rollbackTransaction</a>.</span>
                 
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{boolean}</span> the value returned by <a href="../symbols/UndoManager.html#rollbackTransaction" class="linkMethod">UndoManager.rollbackTransaction</a>.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="scroll">
                <td class="name">
                  
                  <div class="name">
                    scroll(unit, dir, dist)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Scrolling function used by primarily by <a href="../symbols/Diagram.html#commandHandler" class="linkProperty">commandHandler</a>'s <a href="../symbols/CommandHandler.html#doKeyDown" class="linkMethod">CommandHandler.doKeyDown</a>.<span class="nodetails" id="xmethscroll"><a class="morelink" onclick="hst('methscroll')">More...</a></span> <span class="details" id="methscroll"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#scrollToRect" class="linkMethod">scrollToRect</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#centerRect" class="linkMethod">centerRect</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>unit</b>
                                          
                                      </dt>
                                      <dd>A string representing the unit of the scroll operation. Can be 'pixel', 'line', 'page', or 'document'.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>dir</b>
                                          
                                      </dt>
                                      <dd>The direction of the scroll operation. Can be 'up', 'down', 'left', or 'right'.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number=}</span> <b>dist</b>
                                          
                                      </dt>
                                      <dd>An optional distance multiplier, for multiple pixels, lines, or pages. The default value is 1.
                      This argument is ignored when the unit is 'document'.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="scrollToRect">
                <td class="name">
                  
                  <div class="name">
                    scrollToRect(r)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Modifies the <a href="../symbols/Diagram.html#position" class="linkProperty">position</a> to show a given Rect of the Diagram by centering the
viewport on that Rect.<span class="nodetails" id="xmethscrollToRect"><a class="morelink" onclick="hst('methscrollToRect')">More...</a></span> <span class="details" id="methscrollToRect"> Does nothing if the Rect is already in view.
</span><div class="details" id="dmethscrollToRect"><p>
See also <a href="../symbols/Diagram.html#centerRect" class="linkMethod">centerRect</a></div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#centerRect" class="linkMethod">centerRect</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#scroll" class="linkMethod">scroll</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span> <b>r</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="select">
                <td class="name">
                  
                  <div class="name">
                    select(part)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Make the given object the only selected object.<span class="nodetails" id="xmethselect"><a class="morelink" onclick="hst('methselect')">More...</a></span> <span class="details" id="methselect">
This method raises the "ChangingSelection" and "ChangedSelection" Diagram events.</span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#selectCollection" class="linkMethod">selectCollection</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#clearSelection" class="linkMethod">clearSelection</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Part.html" class="linkConstructor">Part</a>}</span> <b>part</b>
                                          
                                      </dt>
                                      <dd>a Part that is already in a layer of this Diagram.
If the value is null, this does nothing.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="selectCollection">
                <td class="name">
                  
                  <div class="name">
                    selectCollection(coll)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Select all of the <a href="../symbols/Part.html" class="linkConstructor">Part</a>s supplied in the given collection, and deselect all other Parts.<span class="nodetails" id="xmethselectCollection"><a class="morelink" onclick="hst('methselectCollection')">More...</a></span> <span class="details" id="methselectCollection">
This method raises the "ChangingSelection" and "ChangedSelection" Diagram events.</span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#select" class="linkMethod">select</a></li>
                                
                                    <li><a href="../symbols/Diagram.html#clearSelection" class="linkMethod">clearSelection</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Iterable.<Part>|Array.<Part>}</span> <b>coll</b>
                                          
                                      </dt>
                                      <dd>a <a href="../symbols/List.html" class="linkConstructor">List</a> or <a href="../symbols/Set.html" class="linkConstructor">Set</a> or <a href="../symbols/Iterator.html" class="linkConstructor">Iterator</a> or Array, of <a href="../symbols/Part.html" class="linkConstructor">Part</a>s to be selected.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="setProperties">
                <td class="name">
                  
                  <div class="name">
                    setProperties(props)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This method sets a collection of properties according to the property/value pairs that have been set on the given Object,
in the same manner as <a href="../symbols/GraphObject.html#.make" class="linkStatic">GraphObject.make</a> does when constructing a Diagram with an argument that is a simple JavaScript Object.<span class="nodetails" id="xmethsetProperties"><a class="morelink" onclick="hst('methsetProperties')">More...</a></span> <span class="details" id="methsetProperties">
</span><div class="details" id="dmethsetProperties"><p>
You can set properties on an object that is the value of a property of the Diagram,
or on the <a>Diagram.toolManager</a>, by using a <i>subpropname.property</i> syntax for the property name.
At the current time only a single dot is permitted in the property "name".
<p>
The property name may also be the name of a <a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a>, in which case this calls <a href="../symbols/Diagram.html#addDiagramListener" class="linkMethod">addDiagramListener</a> with that DiagramEvent name.
<pre>
aDiagram.setProperties({
    allowDelete: false,
    // display a background grid for the whole diagram
    "grid.visible": true,
    "grid.gridCellSize": new go.Size(20, 20),
    "animationManager.isEnabled": false,  // turn off automatic animations
    // specify a group membership validation predicate
    "commandHandler.memberValidation": function(group, part) { return ...; },
    "commandHandler.copiesTree": true,  // for the copy command
    // mouse wheel zooms instead of scrolls
    "toolManager.mouseWheelBehavior": go.ToolManager.WheelZoom,
    "draggingTool.dragsTree": true,  // dragging for both move and copy
    "draggingTool.isGridSnapEnabled": true,
    layout: $(go.TreeLayout),
    // add a DiagramEvent listener
    "ExternalObjectsDropped": function(e) { e.subject.each(function(part) { ... }); }
});
</pre></div>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{Object}</span> <b>props</b>
                                          
                                      </dt>
                                      <dd>a plain JavaScript object with various property values to be set on this Diagram or on a part of this Diagram.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="startTransaction">
                <td class="name">
                  
                  <div class="name">
                    startTransaction(tname)
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Begin a transaction, where the changes are held by a <a href="../symbols/Transaction.html" class="linkConstructor">Transaction</a> object
in the <a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a>.<span class="nodetails" id="xmethstartTransaction"><a class="morelink" onclick="hst('methstartTransaction')">More...</a></span> <span class="details" id="methstartTransaction">
This just calls <a href="../symbols/UndoManager.html#startTransaction" class="linkMethod">UndoManager.startTransaction</a>.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string=}</span> <b>tname</b>
                                          
                                      </dt>
                                      <dd>a descriptive name for the transaction.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{boolean}</span> the value returned by <a href="../symbols/UndoManager.html#startTransaction" class="linkMethod">UndoManager.startTransaction</a>.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="transformDocToView">
                <td class="name">
                  
                  <div class="name">
                    transformDocToView(p)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Given a Point in document coorindates, return a new Point in viewport coordinates.<span class="nodetails" id="xmethtransformDocToView"><a class="morelink" onclick="hst('methtransformDocToView')">More...</a></span> <span class="details" id="methtransformDocToView"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#transformViewToDoc" class="linkMethod">transformViewToDoc</a></li>
                                
                                    <li><a href="../symbols/GraphObject.html#getDocumentPoint" class="linkMethod">GraphObject.getDocumentPoint</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> <b>p</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> The given Point converted into View coordinates.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="transformViewToDoc">
                <td class="name">
                  
                  <div class="name">
                    transformViewToDoc(p)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Given a point in viewport coordinates, return a new Point in document coordinates.<span class="nodetails" id="xmethtransformViewToDoc"><a class="morelink" onclick="hst('methtransformViewToDoc')">More...</a></span> <span class="details" id="methtransformViewToDoc"></span>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#transformDocToView" class="linkMethod">transformDocToView</a></li>
                                
                                    <li><a href="../symbols/GraphObject.html#getDocumentPoint" class="linkMethod">GraphObject.getDocumentPoint</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> <b>p</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>}</span> The given point converted into Document coordinates.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="updateAllRelationshipsFromData">
                <td class="name">
                  
                  <div class="name">
                    updateAllRelationshipsFromData()
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.5</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Add or remove any nodes or links according to additional or missing data objects in the model
and update all of the references to nodes, in case they had been modified in the model without
properly notifying the model by calling <a href="../symbols/Model.html#addNodeData" class="linkMethod">Model.addNodeData</a> or
<a href="../symbols/GraphLinksModel.html#removeLinkData" class="linkMethod">GraphLinksModel.removeLinkData</a> or
<a href="../symbols/GraphLinksModel.html#setGroupKeyForNodeData" class="linkMethod">GraphLinksModel.setGroupKeyForNodeData</a> or
<a href="../symbols/GraphLinksModel.html#setToKeyForLinkData" class="linkMethod">GraphLinksModel.setToKeyForLinkData</a> or other similar methods.<span class="nodetails" id="xmethupdateAllRelationshipsFromData"><a class="morelink" onclick="hst('methupdateAllRelationshipsFromData')">More...</a></span> <span class="details" id="methupdateAllRelationshipsFromData">
This method does not conduct a transaction, so you need to start and commit one yourself.
</span><div class="details" id="dmethupdateAllRelationshipsFromData"><p>
It is better to call <a href="../symbols/Model.html#addNodeData" class="linkMethod">Model.addNodeData</a>, <a href="../symbols/Model.html#removeNodeData" class="linkMethod">Model.removeNodeData</a>,
<a href="../symbols/GraphLinksModel.html#addLinkData" class="linkMethod">GraphLinksModel.addLinkData</a>, <a href="../symbols/GraphLinksModel.html#removeLinkData" class="linkMethod">GraphLinksModel.removeLinkData</a>,
<a href="../symbols/Model.html#setDataProperty" class="linkMethod">Model.setDataProperty</a>, and other model methods to add/remove/modify data,
because those methods will both record changes for undo/redo and will update all bindings
that make depend on that property.
Simply modifying the data and calling an "update..." method will not be able to record
the previous value(s) of properties in the model data to support undo.
<p>
This only adds, removes, or updates the relationships between nodes and links,
to have them reflect what is now declared in the model data.
If you know which model data objects have been modified,
it will be more efficient to update only the <a href="../symbols/Part.html" class="linkConstructor">Part</a>s that need it
by calling <a href="../symbols/Part.html#updateRelationshipsFromData" class="linkMethod">Part.updateRelationshipsFromData</a>.
<p>
To update <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a> properties that are data bound, call <a href="../symbols/Diagram.html#updateAllTargetBindings" class="linkMethod">updateAllTargetBindings</a>.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#updateAllTargetBindings" class="linkMethod">updateAllTargetBindings</a></li>
                                
                  </ul></div>
                            
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="updateAllTargetBindings">
                <td class="name">
                  
                  <div class="name">
                    updateAllTargetBindings(srcprop)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Update all of the data-bound properties of <a href="../symbols/Node.html" class="linkConstructor">Node</a>s and <a href="../symbols/Link.html" class="linkConstructor">Link</a>s in this diagram,
without having to call <a href="../symbols/Model.html#setDataProperty" class="linkMethod">Model.setDataProperty</a>.<span class="nodetails" id="xmethupdateAllTargetBindings"><a class="morelink" onclick="hst('methupdateAllTargetBindings')">More...</a></span> <span class="details" id="methupdateAllTargetBindings">
This copies/converts model data properties to set properties on <a href="../symbols/Part.html" class="linkConstructor">Part</a>s.
This method does not conduct a transaction, so you need to start and commit one yourself.
</span><div class="details" id="dmethupdateAllTargetBindings"><p>
It is better to call <a href="../symbols/Model.html#setDataProperty" class="linkMethod">Model.setDataProperty</a> to modify data properties,
because that will both record changes for undo/redo and will update all bindings
that make depend on that property.
Simply modifying the data and calling an "update..." method will not be able to record
the previous value(s) of properties in the model data to support undo.
<p>
If you know which model data objects have been modified,
it will be more efficient to update only the <a href="../symbols/Part.html" class="linkConstructor">Part</a>s that need it
by calling <a href="../symbols/Panel.html#updateTargetBindings" class="linkMethod">Panel.updateTargetBindings</a>.
<p>
To update relationships between nodes, call <a href="../symbols/Diagram.html#updateAllRelationshipsFromData" class="linkMethod">updateAllRelationshipsFromData</a>.</div>
                 
                                </p><div class="seealso">See also:
                  <ul class="seealsolist">
                                  
                                    <li><a href="../symbols/Diagram.html#updateAllRelationshipsFromData" class="linkMethod">updateAllRelationshipsFromData</a></li>
                                
                  </ul></div>
                            
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string=}</span> <b>srcprop</b>
                                          
                                      </dt>
                                      <dd>An optional source data property name:
  when provided, only evaluates those <a href="../symbols/Binding.html" class="linkConstructor">Binding</a>s that use that particular property;
  when not provided or when it is the empty string, all bindings are evaluated.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="zoomToFit">
                <td class="name">
                  
                  <div class="name">
                    zoomToFit()
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Scales the Diagram to uniformly fit into the viewport.<span class="nodetails" id="xmethzoomToFit"><a class="morelink" onclick="hst('methzoomToFit')">More...</a></span> <span class="details" id="methzoomToFit"> To have this done automatically,
set the Diagram's <a href="../symbols/Diagram.html#autoScale" class="linkProperty">autoScale</a> to <a href="../symbols/Diagram.html#Uniform" class="linkConstant">Uniform</a>.</span>
                 
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="zoomToRect">
                <td class="name">
                  
                  <div class="name">
                    zoomToRect(r, scaling)
                  </div>
                  <div class="attributes">
                    
                    
                      <span class="since" title="since">1.1</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Modifies the <a href="../symbols/Diagram.html#scale" class="linkProperty">scale</a> and <a href="../symbols/Diagram.html#position" class="linkProperty">position</a> of the Diagram
so that the viewport displays a given document-coordinates rectangle.<span class="nodetails" id="xmethzoomToRect"><a class="morelink" onclick="hst('methzoomToRect')">More...</a></span> <span class="details" id="methzoomToRect"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span> <b>r</b>
                                          
                                      </dt>
                                      <dd>rectangular bounds in document coordinates.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{EnumValue=}</span> <b>scaling</b>
                                          
                                      </dt>
                                      <dd>an optional value of either <a href="../symbols/Diagram.html#Uniform" class="linkConstant">Uniform</a> (the default) or <a href="../symbols/Diagram.html#UniformToFill" class="linkConstant">UniformToFill</a>.</dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
                    </tbody>
                </table>
                </div><!-- class="table-responsive">-->
                

                
            
<!-- ============================== events summary ======================== -->
            

<!-- ============================== fields summary ===================== -->
            
                
                
                <h2 class="summaryCaption">Constants<span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
                <div class="table-responsive">
                <table class="summaryTable table table-bordered table-condensed" summary="A summary of the properties documented in the class Diagram.">
                    <thead>
                        <tr>
                            <th scope="col" class="name">Name</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                    
                        <tr id="CycleAll">
                            <td class="name">
                                <div class="name">
                                CycleAll
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This value for <a href="../symbols/Diagram.html#validCycle" class="linkProperty">Diagram.validCycle</a> states that
there are no restrictions on making cycles of links.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="CycleDestinationTree">
                            <td class="name">
                                <div class="name">
                                CycleDestinationTree
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This value for <a href="../symbols/Diagram.html#validCycle" class="linkProperty">Diagram.validCycle</a> states that
any number of destination links may go out of a node, but at most one
source link may come into a node, and there are no directed cycles.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="CycleNotDirected">
                            <td class="name">
                                <div class="name">
                                CycleNotDirected
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This value for <a href="../symbols/Diagram.html#validCycle" class="linkProperty">Diagram.validCycle</a> states that
a valid link from a node will not produce a directed cycle in the graph.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="CycleNotUndirected">
                            <td class="name">
                                <div class="name">
                                CycleNotUndirected
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This value for <a href="../symbols/Diagram.html#validCycle" class="linkProperty">Diagram.validCycle</a> states that
a valid link from a node will not produce an undirected cycle in the graph.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="CycleSourceTree">
                            <td class="name">
                                <div class="name">
                                CycleSourceTree
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This value for <a href="../symbols/Diagram.html#validCycle" class="linkProperty">Diagram.validCycle</a> states that
any number of source links may come into a node, but at most one
destination link may go out of a node, and there are no directed cycles.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="DocumentScroll">
                            <td class="name">
                                <div class="name">
                                DocumentScroll
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This value for <a href="../symbols/Diagram.html#scrollMode" class="linkProperty">Diagram.scrollMode</a> states that
the viewport constrains scrolling to the Diagram document bounds.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="InfiniteScroll">
                            <td class="name">
                                <div class="name">
                                InfiniteScroll
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This value for <a href="../symbols/Diagram.html#scrollMode" class="linkProperty">Diagram.scrollMode</a> states that
the viewport does not constrain scrolling to the Diagram document bounds.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="None">
                            <td class="name">
                                <div class="name">
                                None
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>The default autoScale type, used as the value of <a href="../symbols/Diagram.html#autoScale" class="linkProperty">Diagram.autoScale</a>:
The Diagram does not attempt to scale so that its documentBounds would fit the view.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="Uniform">
                            <td class="name">
                                <div class="name">
                                Uniform
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Diagrams with this autoScale type, used as the value of <a href="../symbols/Diagram.html#autoScale" class="linkProperty">Diagram.autoScale</a>,
are scaled uniformly until the whole documentBounds fits in the view.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="UniformToFill">
                            <td class="name">
                                <div class="name">
                                UniformToFill
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Diagrams with this autoScale type, used as the value of <a href="../symbols/Diagram.html#autoScale" class="linkProperty">Diagram.autoScale</a>,
are scaled until the documentBounds fits in the view in one direction while
a scrollbar is still needed in the other direction.
                            

                </div>
                            </td>
                        </tr>
                    
                    </tbody>
                </table>
                </div><!-- class="table-responsive">-->
                

            

<!-- ============================== constructor details ==================== -->

      </div> <!-- end contentBody -->
    </div> <!-- end container-fluid -->

<!-- ============================== footer ================================= -->
        <div id="footer" class="fineprint" style="clear:both">
            Copyright &copy; 1998-2019 by <a href="https://www.nwoods.com/">Northwoods Software Corporation.</a>
        </div>
    </body>
</html>