libs/js/jquery-geo-1.0b2/docs/geo/include.html

   1 <!doctype html>
   2
   3 <html lang="en" class="no-js">
   4 <head>
   5   <meta charset="utf-8">
   6
   7   <title>include | $.geo</title>
   8   <meta name="description" content="jQuery Geo include method">
   9   <meta name="author" content="Ryan Westphal">
  10
  11   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  12
  13   <link rel="stylesheet" href="../css/style.css?v=2">
  14   <link rel="stylesheet" href="http://code.jquery.com/mobile/1.1.0/jquery.mobile-1.1.0.min.css" />
  15 </head>
  16
  17 <body>
  18
  19   <div id="include" data-role="page">
  20     <div data-role="header" data-theme="b">
  21       <h1>include</h1>
  22     </div>
  23
  24     <div data-role="content">
  25       <table>
  26         <tr>
  27           <th>return type</th>
  28           <td>Array ( <a href="http://geojson.org/geojson-spec.html#bounding-boxes" rel="external">GeoJSON bounding box</a> ) </td>
  29         </tr>
  30         <tr>
  31           <th>syntax</th>
  32           <td>$.geo.include( null | Array bbox ( <a href="http://geojson.org/geojson-spec.html#bounding-boxes" rel="external">GeoJSON bounding box</a> ),  Array position ( <a href="http://geojson.org/geojson-spec.html#positions" rel="external">GeoJSON position</a> ) | Array bbox ( <a href="http://geojson.org/geojson-spec.html#bounding-boxes" rel="external">GeoJSON bounding box</a> )  )</td>
  33         </tr>
  34         <tr>
  35           <th>usage</th>
  36           <td><pre><code>var bboxOfCoord = $.geo.include( null, [ -70, 42 ] );
  37 var sameAsSecondArgument = $.geo.include( null, [ -71, 41, -69, 43 ] );
  38 var includeCoord = $.geo.include( bbox, [ -70, 42 ] );
  39 var includeBbox = $.geo.include( bbox, [ -71, 41, -69, 43 ] );</code></pre></td>
  40         </tr>
  41       </table>
  42
  43       <p>The include method expands a bbox to include either a coordinate or another bbox. The expanded bbox is returned.</p>
  44
  45       <p>If the first argument is null or undefined, the result is a new bbox and will contain the second argument.</p>
  46
  47       <p>For efficency, if the first argument is a valid bbox, it is modified in-place and a reference is returned.</p>
  48
  49       <p>If the second argument is not a coordinate or bbox, this function returns the first argument.</p>
  50
  51       <p>This function is similar to Envelope.expandToInclude in JTS.</p>
  52     </div>
  53   </div> <!-- end of #container -->
  54
  55   <script src="http://code.jquery.com/jquery-1.7.2.min.js"></script>
  56   <script src="http://code.jquerygeo.com/jquery.geo-1.0b1.min.js"></script>
  57   <script src="../js/script.js"></script>
  58   <script src="http://code.jquery.com/mobile/1.1.0/jquery.mobile-1.1.0.min.js"></script>
  59 </body>
  60 </html>
  61