markgojs
Version:
Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams
2,532 lines • 86.4 kB
HTML
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>GoJS® Spot 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>® Diagramming Components<br/>version 1.8.36 for JavaScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>
</div>
<!-- ============================== class title ============================ -->
<h2 class="classTitle">
Class Spot
</h2>
<!-- ============================== class summary ========================== -->
<p class="classsummary">
A Spot represents a relative point from (0,0) to (1,1) within the bounds of
a rectangular area plus an absolute offset.
<p>
Use the static functions <a href="../symbols/Spot.html#.parse" class="linkStatic">Spot.parse</a> and <a href="../symbols/Spot.html#.stringify" class="linkStatic">Spot.stringify</a> to convert to and from
a standard string representation that is independent of the current locale.
<p>
When an instance of this class is the value of a property of a <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a> class or <a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a>
or <a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a> or a <a href="../symbols/Tool.html" class="linkConstructor">Tool</a> class, you should treat the object
as if it were frozen or read-only -- you cannot modify its properties.
This allows the property to return a value without allocating a new instance.
If you need to do your own calculations with the value, call <a href="../symbols/Spot.html#copy" class="linkMethod">copy</a> to make
a new instance with the same values that you can modify.
<p>
Many methods modify the object's properties and then return a reference to "this" object.
The only instance method to allocate a new object is the <a href="../symbols/Spot.html#copy" class="linkMethod">copy</a> method.
The static <a href="../symbols/Spot.html#.parse" class="linkStatic">Spot.parse</a> method also allocates a new object.
<p>
The "Debug" implementation of this class is significantly slower than the "Release" implementation,
mostly due to additional error checking.
<p>
You cannot inherit from this class.
</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 Spot.">
<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">
Spot(x, y, offx, offy)
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The default constructor produces the Spot(0, 0, 0, 0), at the top-left corner.<span class="nodetails" id="xconSpot"><a class="morelink" onclick="hst('conSpot')">More...</a></span> <span class="details" id="conSpot"></span>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number=}</span> <b>x</b>
</dt>
<dd>The x value of the Spot. Default is zero.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>y</b>
</dt>
<dd>The y value of the Spot. Default is zero.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>offx</b>
</dt>
<dd>(Optional) The absolute x offset. Default is zero.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>offy</b>
</dt>
<dd>(Optional) The absolute y offset. Default is zero.</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 Spot.">
<thead>
<tr>
<th scope="col" class="name">Name, Value Type</th>
<th scope="col" class="description">Description</th>
</tr>
</thead>
<tbody>
<tr id="offsetX" >
<td class="name">
<div class="name">
offsetX
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the offsetX value of the Spot.<span class="nodetails" id="xpropoffsetX"><a class="morelink" onclick="hst('propoffsetX')">More...</a></span> <span class="details" id="propoffsetX">
The value may be negative.
If this represents a side value instead of a specific spot, this value is meaningless.
</span><div class="details" id="dpropoffsetX"><p>
A Spot(0,0,5,5) of a large rectangle is near the top-left corner, inside the rectangle.
A Spot(1,1,5,5) would be near the bottom-right corner, outside the rectangle.
A Spot(1,1,-5,-5) would also be near the bottom-right corner, but inside the rectangle.</div>
</div>
</td>
</tr>
<tr id="offsetY" >
<td class="name">
<div class="name">
offsetY
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the offsetY value of the Spot.<span class="nodetails" id="xpropoffsetY"><a class="morelink" onclick="hst('propoffsetY')">More...</a></span> <span class="details" id="propoffsetY">
The value may be negative.
If this represents a side value instead of a specific spot, this value is meaningless.
</span><div class="details" id="dpropoffsetY"><p>
A Spot(0,0,5,5) of a large rectangle is near the top-left corner, inside the rectangle.
A Spot(1,1,5,5) would be near the bottom-right corner, outside the rectangle.
A Spot(1,1,-5,-5) would also be near the bottom-right corner, but inside the rectangle.</div>
</div>
</td>
</tr>
<tr id="x" >
<td class="name">
<div class="name">
x
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the x value of the Spot, a fractional value between zero and one.<span class="nodetails" id="xpropx"><a class="morelink" onclick="hst('propx')">More...</a></span> <span class="details" id="propx">
</span><div class="details" id="dpropx"><p>
The Spot(0,0) of a rectangle is at the top-left corner.
This value is commonly available as <a href="../symbols/Spot.html#TopLeft" class="linkConstant">Spot.TopLeft</a>.
The Spot(0.5,1) would be at the middle of the bottom side.
That value is commonly available as <a href="../symbols/Spot.html#MiddleBottom" class="linkConstant">Spot.MiddleBottom</a>.</div>
</div>
</td>
</tr>
<tr id="y" >
<td class="name">
<div class="name">
y
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the y value of the Spot, a fractional value between zero and one.<span class="nodetails" id="xpropy"><a class="morelink" onclick="hst('propy')">More...</a></span> <span class="details" id="propy">
</span><div class="details" id="dpropy"><p>
The Spot(0,1) of a rectangle is at the bottom-left corner.
This value is commonly available as <a href="../symbols/Spot.html#BottomLeft" class="linkConstant">Spot.BottomLeft</a>.
The Spot(1,0.5) would be at the middle of the right side.
That value is commonly available as <a href="../symbols/Spot.html#MiddleRight" class="linkConstant">Spot.MiddleRight</a>.</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 Spot.">
<thead>
<tr>
<th scope="col" class="name">Name, Return Type</th>
<th scope="col" class="description">Description</th>
</tr>
</thead>
<tbody>
<tr id="copy">
<td class="name">
<div class="name">
copy()
</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>Create a copy of this Spot, with the same values.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="equals">
<td class="name">
<div class="name">
equals(spot)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Two spots are equal if all four property values are the same.<span class="nodetails" id="xmethequals"><a class="morelink" onclick="hst('methequals')">More...</a></span> <span class="details" id="methequals"></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>spot</b>
</dt>
<dd>The Spot to compare to the current Spot.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> True if the two spots are equal, false otherwise.</dt>
</dl>
</div>
</td>
</tr>
<tr id="includesSide">
<td class="name">
<div class="name">
includesSide(side)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>This predicate is true if this Spot is a side that
includes the side(s) given by the argument Spot.<span class="nodetails" id="xmethincludesSide"><a class="morelink" onclick="hst('methincludesSide')">More...</a></span> <span class="details" id="methincludesSide"></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>side</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> false if either this Spot or the argument Spot is not a "Side";
true if the side(s) that this Spot represents are a superset or the same set of
sides represented by the argument Spot.</dt>
</dl>
</div>
</td>
</tr>
<tr id="isDefault">
<td class="name">
<div class="name">
isDefault()
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>True if this is a special spot indicating that the real spot value will come from another source.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="isNone">
<td class="name">
<div class="name">
isNone()
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>True if this is a special spot referring to no particular spot or side.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="isNoSpot">
<td class="name">
<div class="name">
isNoSpot()
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>True if this is an unspecific special spot, such as <a href="../symbols/Spot.html#None" class="linkConstant">Spot.None</a>
or one of the sides.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="isSide">
<td class="name">
<div class="name">
isSide()
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>True if this is a special spot referring to one (or more) of the sides.<span class="nodetails" id="xmethisSide"><a class="morelink" onclick="hst('methisSide')">More...</a></span> <span class="details" id="methisSide">
This is false if the spot is <a href="../symbols/Spot.html#None" class="linkConstant">Spot.None</a>.</span>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="isSpot">
<td class="name">
<div class="name">
isSpot()
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>True if this is a specific spot, not a side nor <a href="../symbols/Spot.html#None" class="linkConstant">Spot.None</a>.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="opposite">
<td class="name">
<div class="name">
opposite()
</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>Return a new spot that is opposite this spot.<span class="nodetails" id="xmethopposite"><a class="morelink" onclick="hst('methopposite')">More...</a></span> <span class="details" id="methopposite">
The X and Y values will be an equal distance
away from the center on the other side of the center.
The OffsetX and OffsetY values are also negated.
</span><div class="details" id="dmethopposite"><p>
The result is meaningless if <a href="../symbols/Spot.html#isNoSpot" class="linkMethod">isNoSpot</a> is true.</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id=".parse">
<td class="name">
<static>
<div class="name">
Spot.parse(str)
</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>This static function can be used to read in a <a href="../symbols/Spot.html" class="linkConstructor">Spot</a> from a string that was produced by <a href="../symbols/Spot.html#.stringify" class="linkStatic">Spot.stringify</a>.<span class="nodetails" id="xmethparse"><a class="morelink" onclick="hst('methparse')">More...</a></span> <span class="details" id="methparse">
</span><div class="details" id="dmethparse"><p>
<code>go.Spot.parse("0 1 2 3")</code> produces the Spot <code>new go.Spot(0, 1, 2, 3)</code>.</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>str</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="set">
<td class="name">
<div class="name">
set(s)
</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>Modify this Spot so that its X, Y, OffsetX, and OffsetY values are the same as the given Spot.<span class="nodetails" id="xmethset"><a class="morelink" onclick="hst('methset')">More...</a></span> <span class="details" id="methset"></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>s</b>
</dt>
<dd>the given Spot.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> this.</dt>
</dl>
</div>
</td>
</tr>
<tr id="setTo">
<td class="name">
<div class="name">
setTo(x, y, offx, offy)
</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>Modify this Spot with new X, Y, OffsetX, and OffsetY values.<span class="nodetails" id="xmethsetTo"><a class="morelink" onclick="hst('methsetTo')">More...</a></span> <span class="details" id="methsetTo"></span>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>x</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>y</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>offx</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>offy</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> this.</dt>
</dl>
</div>
</td>
</tr>
<tr id=".stringify">
<td class="name">
<static>
<div class="name">
Spot.stringify(val)
</div>
<div class="attributes">
<span class="light">{string}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>This static function can be used to write out a <a href="../symbols/Spot.html" class="linkConstructor">Spot</a> as a string that can be read by <a href="../symbols/Spot.html#.parse" class="linkStatic">Spot.parse</a>.<span class="nodetails" id="xmethstringify"><a class="morelink" onclick="hst('methstringify')">More...</a></span> <span class="details" id="methstringify">
</span><div class="details" id="dmethstringify"><p>
<code>go.Spot.stringify(new go.Spot(0, 1, 2, 3))</code> produces the string "0 1 2 3".</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> <b>val</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{string}</span> </dt>
</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 Spot.">
<thead>
<tr>
<th scope="col" class="name">Name</th>
<th scope="col" class="description">Description</th>
</tr>
</thead>
<tbody>
<tr id="AllSides">
<td class="name">
<div class="name">
AllSides
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points on all sides of the bounding rectangle.
</div>
</td>
</tr>
<tr id="Bottom">
<td class="name">
<div class="name">
Bottom
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#BottomCenter" class="linkConstant">Spot.BottomCenter</a>.
</div>
</td>
</tr>
<tr id="BottomCenter">
<td class="name">
<div class="name">
BottomCenter
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the middle of the bottom side of bounding rectangle.
</div>
</td>
</tr>
<tr id="BottomLeft">
<td class="name">
<div class="name">
BottomLeft
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the bottom-left corner of the bounding rectangle.
</div>
</td>
</tr>
<tr id="BottomLeftSides">
<td class="name">
<div class="name">
BottomLeftSides
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the left or bottom sides of the bounding rectangle.
</div>
</td>
</tr>
<tr id="BottomRight">
<td class="name">
<div class="name">
BottomRight
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the bottom-right corner of the bounding rectangle.
</div>
</td>
</tr>
<tr id="BottomRightSides">
<td class="name">
<div class="name">
BottomRightSides
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the right or bottom sides of the bounding rectangle.
</div>
</td>
</tr>
<tr id="BottomSide">
<td class="name">
<div class="name">
BottomSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the bottom side of the bounding rectangle.
</div>
</td>
</tr>
<tr id="Center">
<td class="name">
<div class="name">
Center
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the very center of the bounding rectangle.
</div>
</td>
</tr>
<tr id="Default">
<td class="name">
<div class="name">
Default
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Use this value to indicate that the real spot value is inherited from elsewhere.
</div>
</td>
</tr>
<tr id="Left">
<td class="name">
<div class="name">
Left
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#LeftCenter" class="linkConstant">Spot.LeftCenter</a>.
</div>
</td>
</tr>
<tr id="LeftCenter">
<td class="name">
<div class="name">
LeftCenter
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the middle of the left side of bounding rectangle.
</div>
</td>
</tr>
<tr id="LeftRightSides">
<td class="name">
<div class="name">
LeftRightSides
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the left or right sides of the bounding rectangle.
</div>
</td>
</tr>
<tr id="LeftSide">
<td class="name">
<div class="name">
LeftSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the left side of the bounding rectangle.
</div>
</td>
</tr>
<tr id="MiddleBottom">
<td class="name">
<div class="name">
MiddleBottom
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#BottomCenter" class="linkConstant">Spot.BottomCenter</a>.
</div>
</td>
</tr>
<tr id="MiddleLeft">
<td class="name">
<div class="name">
MiddleLeft
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#LeftCenter" class="linkConstant">Spot.LeftCenter</a>.
</div>
</td>
</tr>
<tr id="MiddleRight">
<td class="name">
<div class="name">
MiddleRight
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#RightCenter" class="linkConstant">Spot.RightCenter</a>.
</div>
</td>
</tr>
<tr id="MiddleTop">
<td class="name">
<div class="name">
MiddleTop
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#TopCenter" class="linkConstant">Spot.TopCenter</a>.
</div>
</td>
</tr>
<tr id="None">
<td class="name">
<div class="name">
None
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Use this Spot value to indicate no particular spot --
code looking for a particular point on an element will need to do their
own calculations to determine the desired point depending on the
circumstances.
</div>
</td>
</tr>
<tr id="NotBottomSide">
<td class="name">
<div class="name">
NotBottomSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points on all sides of bounding rectangle except bottom side.
</div>
</td>
</tr>
<tr id="NotLeftSide">
<td class="name">
<div class="name">
NotLeftSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points on all sides of the bounding rectangle except left side.
</div>
</td>
</tr>
<tr id="NotRightSide">
<td class="name">
<div class="name">
NotRightSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points on all sides of the bounding rectangle except right side.
</div>
</td>
</tr>
<tr id="NotTopSide">
<td class="name">
<div class="name">
NotTopSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points on all sides of the bounding rectangle except top side.
</div>
</td>
</tr>
<tr id="Right">
<td class="name">
<div class="name">
Right
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#RightCenter" class="linkConstant">Spot.RightCenter</a>.
</div>
</td>
</tr>
<tr id="RightCenter">
<td class="name">
<div class="name">
RightCenter
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the middle of the right side of bounding rectangle.
</div>
</td>
</tr>
<tr id="RightSide">
<td class="name">
<div class="name">
RightSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the right side of the bounding rectangle.
</div>
</td>
</tr>
<tr id="Top">
<td class="name">
<div class="name">
Top
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>A synonym for <a href="../symbols/Spot.html#TopCenter" class="linkConstant">Spot.TopCenter</a>.
</div>
</td>
</tr>
<tr id="TopBottomSides">
<td class="name">
<div class="name">
TopBottomSides
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the top or bottom sides of the bounding rectangle.
</div>
</td>
</tr>
<tr id="TopCenter">
<td class="name">
<div class="name">
TopCenter
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the center of the top side of the bounding rectangle.
</div>
</td>
</tr>
<tr id="TopLeft">
<td class="name">
<div class="name">
TopLeft
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the top-left corner of the bounding rectangle.
</div>
</td>
</tr>
<tr id="TopLeftSides">
<td class="name">
<div class="name">
TopLeftSides
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the top or left sides of the bounding rectangle.
</div>
</td>
</tr>
<tr id="TopRight">
<td class="name">
<div class="name">
TopRight
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The specific point at the top-right corner of the bounding rectangle.
</div>
</td>
</tr>
<tr id="TopRightSides">
<td class="name">
<div class="name">
TopRightSides
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the top or right sides of the bounding rectangle.
</div>
</td>
</tr>
<tr id="TopSide">
<td class="name">
<div class="name">
TopSide
<span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>The set of points at the top side of the bounding rectangle.
</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 © 1998-2019 by <a href="https://www.nwoods.com/">Northwoods Software Corporation.</a>
</div>
</body>
</html>