osr-plastic/control-freak-ide
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
master
control-freak-ide/misc/pocs/GoJS/api/symbols/Rect.html
plastic-hub-dev-node-saturn 538369cff7 latest
2021-05-12 18:35:18 +02:00

3034 lines
115 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>GoJS&reg; Rect 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>
<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="../../doc/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">
<!-- ============================== header ================================= -->
<div id="header" class="fineprint mt30">
<b>GoJS</b>&reg; Diagramming Components<br/>version 1.8.5 for JavaScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a>
</div>
<!-- ============================== class title ============================ -->
<h2 class="classTitle mt30">
Class Rect
</h2>
<!-- ============================== class summary ========================== -->
<span class="hideshowall">
<span class="nodetails"><button id="buttonShow">Show Details</button></span>
<span class="details"><button id="buttonHide">Show Summaries</button></span>
</span>
<p class="classsummary">
A Rect describes a rectangular two-dimensional area as a top-left point (x and y values)
and a size (width and height values).
<p>
Use the static functions <a href="../symbols/Rect.html#.parse" class="linkStatic">Rect.parse</a> and <a href="../symbols/Rect.html#.stringify" class="linkStatic">Rect.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/Rect.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/Rect.html#copy" class="linkMethod">copy</a> method.
The static <a href="../symbols/Rect.html#.parse" class="linkStatic">Rect.parse</a> method also allocates a new object.
The <a href="../symbols/Rect.html#center" class="linkProperty">center</a>, <a href="../symbols/Rect.html#position" class="linkProperty">position</a>, and <a href="../symbols/Rect.html#size" class="linkProperty">size</a> properties all allocate and return 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 Rect.">
<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">
Rect(x, y, w, h)
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>There are four constructors: (), (Point, Point), (Point, Size),
and four numbers for (x, y, width, height).<span class="nodetails" id="xconRect"><a class="morelink" onclick="hst('conRect')">More...</a></span> <span class="details" id="conRect">
The default constructor (no argument) results in a Rect(0,0,0,0).</span>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>|number=}</span> <b>x</b>
</dt>
<dd>Top-left Point, or x value.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Point.html" class="linkConstructor">Point</a>|<a href="../symbols/Size.html" class="linkConstructor">Size</a>|number=}</span> <b>y</b>
</dt>
<dd>Bottom-right Point or Size or y value.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>w</b>
</dt>
<dd>Width to be used if x,y are specified;
must be non-negative.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>h</b>
</dt>
<dd>Height to be used if x,y are specified;
must be non-negative.</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 Rect.">
<thead>
<tr>
<th scope="col" class="name">Name, Value Type</th>
<th scope="col" class="description">Description</th>
</tr>
</thead>
<tbody>
<tr id="bottom" >
<td class="name">
<div class="name">
bottom
</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-axis value of the bottom of the Rect.<span class="nodetails" id="xpropbottom"><a class="morelink" onclick="hst('propbottom')">More...</a></span> <span class="details" id="propbottom">
This is equal to the sum of the y value and the height.</span>
</div>
</td>
</tr>
<tr id="center" >
<td class="name">
<div class="name">
center
</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 Point at the center of this Rect.<span class="nodetails" id="xpropcenter"><a class="morelink" onclick="hst('propcenter')">More...</a></span> <span class="details" id="propcenter">
Setting this property just shifts the X and Y values.</span>
</div>
</td>
</tr>
<tr id="centerX" >
<td class="name">
<div class="name">
centerX
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the horizontal center X coordinate of the Rect.
</div>
</td>
</tr>
<tr id="centerY" >
<td class="name">
<div class="name">
centerY
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the vertical center Y coordinate of the Rect.
</div>
</td>
</tr>
<tr id="height" >
<td class="name">
<div class="name">
height
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the height of the Rect.<span class="nodetails" id="xpropheight"><a class="morelink" onclick="hst('propheight')">More...</a></span> <span class="details" id="propheight">
The value must not be negative.</span>
</div>
</td>
</tr>
<tr id="left" >
<td class="name">
<div class="name">
left
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the leftmost value of the Rect.<span class="nodetails" id="xpropleft"><a class="morelink" onclick="hst('propleft')">More...</a></span> <span class="details" id="propleft">
This is the same as the X value.</span>
</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 x- and y-axis position of the Rect as a Point.
</div>
</td>
</tr>
<tr id="right" >
<td class="name">
<div class="name">
right
</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-axis value of the right of the Rect.<span class="nodetails" id="xpropright"><a class="morelink" onclick="hst('propright')">More...</a></span> <span class="details" id="propright">
This is equal to the sum of the x value and the width.</span>
</div>
</td>
</tr>
<tr id="size" >
<td class="name">
<div class="name">
size
</div>
<div class="attributes">
<span class="light">{<a href="../symbols/Size.html" class="linkConstructor">Size</a>}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the width and height of the Rect as a Size.
</div>
</td>
</tr>
<tr id="top" >
<td class="name">
<div class="name">
top
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the topmost value of the Rect.<span class="nodetails" id="xproptop"><a class="morelink" onclick="hst('proptop')">More...</a></span> <span class="details" id="proptop">
This is the same as the Y value.</span>
</div>
</td>
</tr>
<tr id="width" >
<td class="name">
<div class="name">
width
</div>
<div class="attributes">
<span class="light">{number}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp <p> -->
<p>Gets or sets the width of the Rect.<span class="nodetails" id="xpropwidth"><a class="morelink" onclick="hst('propwidth')">More...</a></span> <span class="details" id="propwidth">
The value must not be negative.</span>
</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 top-left x coordinate of the Rect.
</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 top-left y coordinate of the Rect.
</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 Rect.">
<thead>
<tr>
<th scope="col" class="name">Name, Return Type</th>
<th scope="col" class="description">Description</th>
</tr>
</thead>
<tbody>
<tr id="addMargin">
<td class="name">
<div class="name">
addMargin(m)
</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>Modify this Rect by adding the given Margin to each side of the Rect.<span class="nodetails" id="xmethaddMargin"><a class="morelink" onclick="hst('methaddMargin')">More...</a></span> <span class="details" id="methaddMargin"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#subtractMargin" class="linkMethod">subtractMargin</a></li>
<li><a href="../symbols/Rect.html#grow" class="linkMethod">grow</a></li>
<li><a href="../symbols/Rect.html#inflate" class="linkMethod">inflate</a></li>
</ul></div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Margin.html" class="linkConstructor">Margin</a>}</span> <b>m</b>
</dt>
<dd>The Margin to add to the Rect.</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 bigger Rect.</dt>
</dl>
</div>
</td>
</tr>
<tr id="contains">
<td class="name">
<div class="name">
contains(x, y, w, h)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Indicates whether this Rect contains the given Point/Rect.<span class="nodetails" id="xmethcontains"><a class="morelink" onclick="hst('methcontains')">More...</a></span> <span class="details" id="methcontains"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#containsRect" class="linkMethod">containsRect</a></li>
<li><a href="../symbols/Rect.html#containsPoint" class="linkMethod">containsPoint</a></li>
</ul></div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the Point or Rect to include in the new bounds.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the Point or Rect to include in the new bounds.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>w</b>
</dt>
<dd>The Width of the Rect to include in the new bounds, defaults to zero.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>h</b>
</dt>
<dd>The Height of the Rect to include in the new bounds, defaults to zero.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> True if the Point/Rect is contained within this Rect,
false otherwise.</dt>
</dl>
</div>
</td>
</tr>
<tr id=".contains">
<td class="name">
&lt;static&gt;
<div class="name">
Rect.contains(rx, ry, rw, rh, x, y, w, h)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>This static function indicates whether a Rect contains the given Point/Rect.<span class="nodetails" id="xmethcontains"><a class="morelink" onclick="hst('methcontains')">More...</a></span> <span class="details" id="methcontains"></span>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>rx</b>
</dt>
<dd>The X coordinate of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>ry</b>
</dt>
<dd>The Y coordinate of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>rw</b>
</dt>
<dd>The Width of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>rh</b>
</dt>
<dd>The Height of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the Point or Rect that might be in the bounds (RX, RY, RW, RH).</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the Point or Rect that might be in the bounds (RX, RY, RW, RH).</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>w</b>
</dt>
<dd>The Width of the Rect to include in the new bounds, defaults to zero.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>h</b>
</dt>
<dd>The Height of the Rect to include in the new bounds, defaults to zero.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> True if the Point/Rect is contained within this Rect,
false otherwise.</dt>
</dl>
</div>
</td>
</tr>
<tr id="containsPoint">
<td class="name">
<div class="name">
containsPoint(p)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Indicates whether this Rect contains the given Point.<span class="nodetails" id="xmethcontainsPoint"><a class="morelink" onclick="hst('methcontainsPoint')">More...</a></span> <span class="details" id="methcontainsPoint"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#containsRect" class="linkMethod">containsRect</a></li>
<li><a href="../symbols/Rect.html#contains" class="linkMethod">contains</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>The Point to check.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> True if the Point is contained within this Rect,
false otherwise.</dt>
</dl>
</div>
</td>
</tr>
<tr id="containsRect">
<td class="name">
<div class="name">
containsRect(r)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Indicates whether this Rect contains the given Rect.<span class="nodetails" id="xmethcontainsRect"><a class="morelink" onclick="hst('methcontainsRect')">More...</a></span> <span class="details" id="methcontainsRect"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#containsPoint" class="linkMethod">containsPoint</a></li>
<li><a href="../symbols/Rect.html#contains" class="linkMethod">contains</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>The Rect to check.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> True if the Rect is contained within this Rect,
false otherwise.</dt>
</dl>
</div>
</td>
</tr>
<tr id="copy">
<td class="name">
<div class="name">
copy()
</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>Create a copy of this Rect, with the same values.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{<a href="../symbols/Rect.html" class="linkConstructor">Rect</a>}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="equals">
<td class="name">
<div class="name">
equals(r)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Indicates whether the given Rect is equal to the current Rect.<span class="nodetails" id="xmethequals"><a class="morelink" onclick="hst('methequals')">More...</a></span> <span class="details" id="methequals"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#equalTo" class="linkMethod">equalTo</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>The rectangle to compare to the current rectangle.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> True if the Rects are equivalent in x, y, width,
and height.</dt>
</dl>
</div>
</td>
</tr>
<tr id="equalTo">
<td class="name">
<div class="name">
equalTo(x, y, w, h)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Indicates whether the given Rect is equal to the current Rect.<span class="nodetails" id="xmethequalTo"><a class="morelink" onclick="hst('methequalTo')">More...</a></span> <span class="details" id="methequalTo"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#equals" class="linkMethod">equals</a></li>
</ul></div>
<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>w</b>
</dt>
<dd>the width.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>h</b>
</dt>
<dd>the height.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> True if the Rects are equivalent in x, y, width, and height.</dt>
</dl>
</div>
</td>
</tr>
<tr id="grow">
<td class="name">
<div class="name">
grow(t, r, b, l)
</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>Modifies this Rect by adding some distance to each side of the Rect.<span class="nodetails" id="xmethgrow"><a class="morelink" onclick="hst('methgrow')">More...</a></span> <span class="details" id="methgrow"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#inflate" class="linkMethod">inflate</a></li>
<li><a href="../symbols/Rect.html#addMargin" class="linkMethod">addMargin</a></li>
<li><a href="../symbols/Rect.html#subtractMargin" class="linkMethod">subtractMargin</a></li>
</ul></div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>t</b>
</dt>
<dd>the amount to move the top side upwards; may be negative.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>r</b>
</dt>
<dd>the amount to move the right side rightwards; may be negative.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>b</b>
</dt>
<dd>the amount to move the bottom side downwards; may be negative.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>l</b>
</dt>
<dd>the amount to move the left side leftwards; may be negative.</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 modified Rect.</dt>
</dl>
</div>
</td>
</tr>
<tr id="inflate">
<td class="name">
<div class="name">
inflate(w, h)
</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>Modify this Rect so that its width and height are changed on all four sides,
equally on the left and right sides, and equally on the top and bottom sides.<span class="nodetails" id="xmethinflate"><a class="morelink" onclick="hst('methinflate')">More...</a></span> <span class="details" id="methinflate">
When the arguments are negative, this operation deflates this Rect, but not beyond zero.</span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#grow" class="linkMethod">grow</a></li>
<li><a href="../symbols/Rect.html#addMargin" class="linkMethod">addMargin</a></li>
<li><a href="../symbols/Rect.html#subtractMargin" class="linkMethod">subtractMargin</a></li>
</ul></div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>w</b>
</dt>
<dd>The additional width on each side, left and right; may be negative.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>h</b>
</dt>
<dd>The additional height on each side, top and bottom; may be negative.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="intersect">
<td class="name">
<div class="name">
intersect(x, y, w, h)
</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>Modify this Rect so that it is the intersection of this Rect and the rectangle
defined by x, y, w, h.<span class="nodetails" id="xmethintersect"><a class="morelink" onclick="hst('methintersect')">More...</a></span> <span class="details" id="methintersect"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#intersectRect" class="linkMethod">intersectRect</a></li>
<li><a href="../symbols/Rect.html#intersects" class="linkMethod">intersects</a></li>
</ul></div>
<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>w</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>h</b>
</dt>
<dd></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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="intersectRect">
<td class="name">
<div class="name">
intersectRect(r)
</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>Modify this Rect so that it is the intersection of this Rect and the given Rect.<span class="nodetails" id="xmethintersectRect"><a class="morelink" onclick="hst('methintersectRect')">More...</a></span> <span class="details" id="methintersectRect"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#intersect" class="linkMethod">intersect</a></li>
<li><a href="../symbols/Rect.html#intersects" class="linkMethod">intersects</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>Rect to intersect with.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id=".intersects">
<td class="name">
&lt;static&gt;
<div class="name">
Rect.intersects(rx, ry, rw, rh, x, y, w, h)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>This static function indicates whether a Rect partly or wholly overlaps the given Rect.<span class="nodetails" id="xmethintersects"><a class="morelink" onclick="hst('methintersects')">More...</a></span> <span class="details" id="methintersects"></span>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>rx</b>
</dt>
<dd>The X coordinate of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>ry</b>
</dt>
<dd>The Y coordinate of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>rw</b>
</dt>
<dd>The Width of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>rh</b>
</dt>
<dd>The Height of a Rect.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the Point or Rect that might overlap the bounds (RX, RY, RW, RH).</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the Point or Rect that might overlap the bounds (RX, RY, RW, RH).</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>w</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>h</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> true if there is any overlap.</dt>
</dl>
</div>
</td>
</tr>
<tr id="intersects">
<td class="name">
<div class="name">
intersects(x, y, w, h)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Determine if this Rect partly or wholly overlaps the rectangle
defined by x, y, w, h.<span class="nodetails" id="xmethintersects"><a class="morelink" onclick="hst('methintersects')">More...</a></span> <span class="details" id="methintersects"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#intersectsRect" class="linkMethod">intersectsRect</a></li>
<li><a href="../symbols/Rect.html#intersect" class="linkMethod">intersect</a></li>
</ul></div>
<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>w</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>h</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> true if there is any overlap.</dt>
</dl>
</div>
</td>
</tr>
<tr id="intersectsRect">
<td class="name">
<div class="name">
intersectsRect(r)
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>Determine if a given Rect is partly or wholly inside of this Rect.<span class="nodetails" id="xmethintersectsRect"><a class="morelink" onclick="hst('methintersectsRect')">More...</a></span> <span class="details" id="methintersectsRect"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#intersects" class="linkMethod">intersects</a></li>
<li><a href="../symbols/Rect.html#intersectRect" class="linkMethod">intersectRect</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>Rect to test intersection with.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> true if there is an intersection.</dt>
</dl>
</div>
</td>
</tr>
<tr id="isEmpty">
<td class="name">
<div class="name">
isEmpty()
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>True if this Rect has a Width and Height of zero.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="isReal">
<td class="name">
<div class="name">
isReal()
</div>
<div class="attributes">
<span class="light">{boolean}</span>
</div>
</td>
<td class="description">
<div class="description">
<!--newp--><p><p>True if this Rect has X, Y, Width, and Height values that are real numbers and not infinity.
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dt><span class="light fixedFont">{boolean}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="offset">
<td class="name">
<div class="name">
offset(dx, dy)
</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>Modify this Rect by shifting its values with the given DX and DY offsets.<span class="nodetails" id="xmethoffset"><a class="morelink" onclick="hst('methoffset')">More...</a></span> <span class="details" id="methoffset"></span>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>dx</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>dy</b>
</dt>
<dd></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.</dt>
</dl>
</div>
</td>
</tr>
<tr id=".parse">
<td class="name">
&lt;static&gt;
<div class="name">
Rect.parse(str)
</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 static function can be used to read in a <a href="../symbols/Rect.html" class="linkConstructor">Rect</a> from a string that was produced by <a href="../symbols/Rect.html#.stringify" class="linkStatic">Rect.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.Rect.parse("1 2 3 4")</code> produces the Rect <code>new go.Rect(1, 2, 3, 4)</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/Rect.html" class="linkConstructor">Rect</a>}</span> </dt>
</dl>
</div>
</td>
</tr>
<tr id="set">
<td class="name">
<div class="name">
set(r)
</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>Modify this Rect so that its X, Y, Width, and Height values are the same as the given Rect.<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/Rect.html" class="linkConstructor">Rect</a>}</span> <b>r</b>
</dt>
<dd>the given Rect.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="setPoint">
<td class="name">
<div class="name">
setPoint(p)
</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>Modify this Rect so that its X and Y values are the same as the given Point.<span class="nodetails" id="xmethsetPoint"><a class="morelink" onclick="hst('methsetPoint')">More...</a></span> <span class="details" id="methsetPoint"></span>
<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>the given Point.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="setSize">
<td class="name">
<div class="name">
setSize(s)
</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>Modify this Rect so that its Width and Height values are the same as the given Size.<span class="nodetails" id="xmethsetSize"><a class="morelink" onclick="hst('methsetSize')">More...</a></span> <span class="details" id="methsetSize"></span>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Size.html" class="linkConstructor">Size</a>}</span> <b>s</b>
</dt>
<dd>the given Size.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="setSpot">
<td class="name">
<div class="name">
setSpot(x, y, spot)
</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>Modify this Rect so that a given Spot is at a given (x,y) point using this Rect's size.<span class="nodetails" id="xmethsetSpot"><a class="morelink" onclick="hst('methsetSpot')">More...</a></span> <span class="details" id="methsetSpot">
Return this rectangle for which the spot is at that point, without modifying the size.
</span><div class="details" id="dmethsetSpot"><p>
The result is meaningless if <a href="../symbols/Spot.html#isNoSpot" class="linkMethod">Spot.isNoSpot</a> is true.</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>x</b>
</dt>
<dd>the point where the spot should be.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>y</b>
</dt>
<dd>the point where the spot should be.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span> <b>spot</b>
</dt>
<dd>a Spot; <a href="../symbols/Spot.html#isSpot" class="linkMethod">Spot.isSpot</a> must be true.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="setTo">
<td class="name">
<div class="name">
setTo(x, y, w, h)
</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>Modify this Rect with new X, Y, Width, and Height 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>w</b>
</dt>
<dd>the width.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>h</b>
</dt>
<dd>the height.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id=".stringify">
<td class="name">
&lt;static&gt;
<div class="name">
Rect.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/Rect.html" class="linkConstructor">Rect</a> as a string that can be read by <a href="../symbols/Rect.html#.parse" class="linkStatic">Rect.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.Rect.stringify(new go.Rect(1, 2, 3, 4))</code> produces the string "1 2 3 4".</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>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>
<tr id="subtractMargin">
<td class="name">
<div class="name">
subtractMargin(m)
</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>Modify this Rect by subtracting the given Margin from each side of the Rect.<span class="nodetails" id="xmethsubtractMargin"><a class="morelink" onclick="hst('methsubtractMargin')">More...</a></span> <span class="details" id="methsubtractMargin"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#addMargin" class="linkMethod">addMargin</a></li>
<li><a href="../symbols/Rect.html#grow" class="linkMethod">grow</a></li>
<li><a href="../symbols/Rect.html#inflate" class="linkMethod">inflate</a></li>
</ul></div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Margin.html" class="linkConstructor">Margin</a>}</span> <b>m</b>
</dt>
<dd>The Margin to subtract from the Rect.</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 smaller Rect.</dt>
</dl>
</div>
</td>
</tr>
<tr id="union">
<td class="name">
<div class="name">
union(x, y, w, h)
</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>Modify this Rect to be exactly big enough to contain both the original Rect and the given rectangular area.<span class="nodetails" id="xmethunion"><a class="morelink" onclick="hst('methunion')">More...</a></span> <span class="details" id="methunion"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#unionRect" class="linkMethod">unionRect</a></li>
<li><a href="../symbols/Rect.html#unionPoint" class="linkMethod">unionPoint</a></li>
</ul></div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the Point or Rect to include in the new bounds.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the Point or Rect to include in the new bounds.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>w</b>
</dt>
<dd>The Width of the Rect to include in the new bounds, defaults to zero.</dd>
<dt>
<span class="light fixedFont">{number=}</span> <b>h</b>
</dt>
<dd>The Height of the Rect to include in the new bounds, defaults to zero.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="unionPoint">
<td class="name">
<div class="name">
unionPoint(p)
</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>Modify this Rect to be exactly big enough to contain both the original Rect and the given Point.<span class="nodetails" id="xmethunionPoint"><a class="morelink" onclick="hst('methunionPoint')">More...</a></span> <span class="details" id="methunionPoint"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#unionRect" class="linkMethod">unionRect</a></li>
<li><a href="../symbols/Rect.html#union" class="linkMethod">union</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>The Point to include in the new bounds.</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.</dt>
</dl>
</div>
</td>
</tr>
<tr id="unionRect">
<td class="name">
<div class="name">
unionRect(r)
</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>Modify this Rect to be exactly big enough to contain this Rect and the given Rect.<span class="nodetails" id="xmethunionRect"><a class="morelink" onclick="hst('methunionRect')">More...</a></span> <span class="details" id="methunionRect"></span>
</p><div class="seealso">See also:
<ul class="seealsolist">
<li><a href="../symbols/Rect.html#unionPoint" class="linkMethod">unionPoint</a></li>
<li><a href="../symbols/Rect.html#union" class="linkMethod">union</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>The Rect to include in the new bounds.</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.</dt>
</dl>
</div>
</td>
</tr>
</tbody>
</table>
</div><!-- class="table-responsive">-->
<!-- ============================== events summary ======================== -->
<!-- ============================== fields summary ===================== -->
<!-- ============================== constructor details ==================== -->
</div> <!-- end contentBody -->
</div> <!-- end container-fluid -->
<!-- ============================== footer ================================= -->
<div id="footer" class="fineprint" style="clear:both">
Copyright &copy; 1998-2017 by <a href="https://www.nwoods.com/">Northwoods Software Corporation.</a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink