Files
openlayers/apidoc/master/ol.Rectangle.html
Éric Lemoine 447d9ec05b Update
2012-09-28 10:52:49 +02:00

1094 lines
15 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers Class: ol.Rectangle</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/apidoc.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: ol.Rectangle</h1>
<section>
<header>
<h2>
ol.Rectangle
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Rectangle"><span class="type-signature"></span>new Rectangle</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>minX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Minimum X.</td>
</tr>
<tr>
<td class="name"><code>minY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Minimum Y.</td>
</tr>
<tr>
<td class="name"><code>maxX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Maximum X.</td>
</tr>
<tr>
<td class="name"><code>maxY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Maximum Y.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 16</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="protected">
<h4 class="name" id="maxX"><span class="type-signature"></span>maxX<span class="type-signature"> :number</span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 34</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="maxY"><span class="type-signature"></span>maxY<span class="type-signature"> :number</span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 39</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="minX"><span class="type-signature"></span>minX<span class="type-signature"> :number</span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 24</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="minY"><span class="type-signature"></span>minY<span class="type-signature"> :number</span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 29</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="getCenter"><span class="type-signature"></span>getCenter</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 47</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Center.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getHeight"><span class="type-signature"></span>getHeight</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 56</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Height.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getSize"><span class="type-signature"></span>getSize</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 64</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Size.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Size.html">ol.Size</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getWidth"><span class="type-signature"></span>getWidth</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 72</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Width.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="intersects"><span class="type-signature"></span>intersects</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rectangle</code></td>
<td class="type">
<span class="param-type"><a href="ol.Rectangle.html">ol.Rectangle</a></span>
</td>
<td class="description last">Rectangle.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 81</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Intersects.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="normalize"><span class="type-signature"></span>normalize</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>coordinate</code></td>
<td class="type">
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</td>
<td class="description last">Coordinate.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 93</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Coordinate.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="toString"><span class="type-signature"></span>toString</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>rectangle.js, line 103</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
String.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="ol.Attribution.html">ol.Attribution</a></li><li><a href="ol.Collection.html">ol.Collection</a></li><li><a href="ol.CollectionEvent.html">ol.CollectionEvent</a></li><li><a href="ol.Color.html">ol.Color</a></li><li><a href="ol.Constraints.html">ol.Constraints</a></li><li><a href="ol.control.Attribution.html">ol.control.Attribution</a></li><li><a href="ol.control.Control.html">ol.control.Control</a></li><li><a href="ol.control.MousePosition.html">ol.control.MousePosition</a></li><li><a href="ol.control.Zoom.html">ol.control.Zoom</a></li><li><a href="ol.Coordinate.html">ol.Coordinate</a></li><li><a href="ol.CoverageArea.html">ol.CoverageArea</a></li><li><a href="ol.Extent.html">ol.Extent</a></li><li><a href="ol.interaction.AltDragRotate.html">ol.interaction.AltDragRotate</a></li><li><a href="ol.interaction.DblClickZoom.html">ol.interaction.DblClickZoom</a></li><li><a href="ol.interaction.Drag.html">ol.interaction.Drag</a></li><li><a href="ol.interaction.DragPan.html">ol.interaction.DragPan</a></li><li><a href="ol.interaction.Interaction.html">ol.interaction.Interaction</a></li><li><a href="ol.interaction.Keyboard.html">ol.interaction.Keyboard</a></li><li><a href="ol.interaction.KeyboardPan.html">ol.interaction.KeyboardPan</a></li><li><a href="ol.interaction.KeyboardZoom.html">ol.interaction.KeyboardZoom</a></li><li><a href="ol.interaction.MouseWheelZoom.html">ol.interaction.MouseWheelZoom</a></li><li><a href="ol.interaction.ShiftDragRotateAndZoom.html">ol.interaction.ShiftDragRotateAndZoom</a></li><li><a href="ol.interaction.ShiftDragZoom.html">ol.interaction.ShiftDragZoom</a></li><li><a href="ol.layer.Layer.html">ol.layer.Layer</a></li><li><a href="ol.layer.TileLayer.html">ol.layer.TileLayer</a></li><li><a href="ol.Map.html">ol.Map</a></li><li><a href="ol.MapBrowserEvent.html">ol.MapBrowserEvent</a></li><li><a href="ol.MapBrowserEventHandler.html">ol.MapBrowserEventHandler</a></li><li><a href="ol.MapEvent.html">ol.MapEvent</a></li><li><a href="ol.Object.html">ol.Object</a></li><li><a href="ol.Pixel.html">ol.Pixel</a></li><li><a href="ol.PixelBounds.html">ol.PixelBounds</a></li><li><a href="ol.Proj4jsProjection.html">ol.Proj4jsProjection</a></li><li><a href="ol.Projection.html">ol.Projection</a></li><li><a href="ol.Rectangle.html">ol.Rectangle</a></li><li><a href="ol.renderer.dom.Layer.html">ol.renderer.dom.Layer</a></li><li><a href="ol.renderer.dom.Map.html">ol.renderer.dom.Map</a></li><li><a href="ol.renderer.dom.TileLayer.html">ol.renderer.dom.TileLayer</a></li><li><a href="ol.renderer.Layer.html">ol.renderer.Layer</a></li><li><a href="ol.renderer.Map.html">ol.renderer.Map</a></li><li><a href="ol.renderer.webgl.FragmentShader.html">ol.renderer.webgl.FragmentShader</a></li><li><a href="ol.renderer.webgl.Layer.html">ol.renderer.webgl.Layer</a></li><li><a href="ol.renderer.webgl.Map.html">ol.renderer.webgl.Map</a></li><li><a href="ol.renderer.webgl.map.shader.Fragment.html">ol.renderer.webgl.map.shader.Fragment</a></li><li><a href="ol.renderer.webgl.map.shader.Vertex.html">ol.renderer.webgl.map.shader.Vertex</a></li><li><a href="ol.renderer.webgl.Shader.html">ol.renderer.webgl.Shader</a></li><li><a href="ol.renderer.webgl.TileLayer.html">ol.renderer.webgl.TileLayer</a></li><li><a href="ol.renderer.webgl.tilelayerrenderer.shader.Fragment.html">ol.renderer.webgl.tilelayerrenderer.shader.Fragment</a></li><li><a href="ol.renderer.webgl.tilelayerrenderer.shader.Vertex.html">ol.renderer.webgl.tilelayerrenderer.shader.Vertex</a></li><li><a href="ol.renderer.webgl.VertexShader.html">ol.renderer.webgl.VertexShader</a></li><li><a href="ol.Size.html">ol.Size</a></li><li><a href="ol.source.BingMaps.html">ol.source.BingMaps</a></li><li><a href="ol.source.MapQuestOpenAerial.html">ol.source.MapQuestOpenAerial</a></li><li><a href="ol.source.MapQuestOSM.html">ol.source.MapQuestOSM</a></li><li><a href="ol.source.OpenStreetMap.html">ol.source.OpenStreetMap</a></li><li><a href="ol.source.Source.html">ol.source.Source</a></li><li><a href="ol.source.Stamen.html">ol.source.Stamen</a></li><li><a href="ol.source.TileJSON.html">ol.source.TileJSON</a></li><li><a href="ol.source.TileSource.html">ol.source.TileSource</a></li><li><a href="ol.source.XYZ.html">ol.source.XYZ</a></li><li><a href="ol.Tile.html">ol.Tile</a></li><li><a href="ol.TileCoord.html">ol.TileCoord</a></li><li><a href="ol.TileCoverageArea.html">ol.TileCoverageArea</a></li><li><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></li><li><a href="ol.tilegrid.XYZ.html">ol.tilegrid.XYZ</a></li><li><a href="ol.TileRange.html">ol.TileRange</a></li></ul><h3>Global</h3><ul><li><a href="global.html#{number}">{number}</a></li><li><a href="global.html#grid">grid</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Fri Sep 28 2012 10:51:39 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
</body>
</html>