2.0_beta sync to rsa
[framework/web/web-ui-fw.git] / libs / js / jquery-geo-1.0a4 / docs / geo / area.html
1 <!doctype html>  
2
3 <html lang="en" class="no-js">
4 <head>
5   <meta charset="utf-8">
6
7   <title>area | $.geo</title>
8   <meta name="description" content="jQuery Geo area 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.0/jquery.mobile-1.0.min.css" />
15 </head>
16
17 <body>
18
19   <div id="area" data-role="page">
20     <div data-role="header" data-theme="b">
21       <h1>area</h1>
22     </div>
23     
24     <div data-role="content">
25       <table>
26         <tr>
27           <th>return type</th>
28           <td>Number</td>
29         </tr>
30         <tr>
31           <th>syntax</th>
32           <td>$.geo.area( Object shape ( <a href="http://geojson.org/geojson-spec.html" rel="external">GeoJSON object</a> ) )</td>
33         </tr>
34         <tr>
35           <th>usage</th>
36           <td><pre><code>var area = $.geo.area( {
37       type: &quot;Polygon&quot;,
38       coordinates: [[
39         [-75, 39.7],
40         [-74.8, 39.3],
41         [-75.2, 39.3],
42         [-75, 39.7]
43       ]]
44 } )</pre></code></td>
45         </tr>
46       </table>
47       <p>The area method calculates the area of a basic GeoJSON geometry object and returns it in non-geodetic units. The basic shapes are Point, LineString and Polygon. If you are using geomap with its default map service, the area is in square meters because the default projection is web mercator meters.</p>
48       <p>While you can pass any basic geometry, this function returns the area of Polygon objects and 0 for objects of other shape types.</p>
49       <p>If the argument is not a basic GeoJSON geometry object, this function returns undefined.</p>
50       <p>This function is similar to Geometry.getArea in JTS.</p>
51     </div>
52   </div> <!-- end of #container -->
53
54   <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
55   <script src="http://code.jquerygeo.com/jquery.geo-1.0a4.min.js"></script>
56   <script src="../js/script.js"></script>
57   <script src="http://code.jquery.com/mobile/1.0/jquery.mobile-1.0.min.js"></script>
58 </body>
59 </html>
60