2.0_beta sync to rsa
[framework/web/web-ui-fw.git] / libs / js / jquery-geo-1.0a4 / docs / geo / length.html
1 <!doctype html>  
2
3 <html lang="en" class="no-js">
4 <head>
5   <meta charset="utf-8">
6
7   <title>length | $.geo</title>
8   <meta name="description" content="jQuery Geo length 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="length" data-role="page">
20     <div data-role="header" data-theme="b">
21       <h1>length</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.length( 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 length = $.geo.length( {
37       type: &quot;LineString&quot;,
38       coordinates: [[
39         [-75, 39.7],
40         [-74.8, 39.3],
41         [-75.2, 39.3]
42       ]]
43 } )</pre></code></td>
44         </tr>
45       </table>
46       <p>The length method calculates the length 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 length is in meters because the default projection is web mercator meters.</p>
47       <p>This function returns 0 for Point objects, the length of LineString objects and the perimeter of Polygon objects.</p>
48       <p>If the argument is not a basic GeoJSON geometry object, this function returns undefined.</p>
49       <p>This function is similar to Geometry.getLength in JTS.</p>
50     </div>
51   </div> <!-- end of #container -->
52
53   <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
54   <script src="http://code.jquerygeo.com/jquery.geo-1.0a4.min.js"></script>
55   <script src="../js/script.js"></script>
56   <script src="http://code.jquery.com/mobile/1.0/jquery.mobile-1.0.min.js"></script>
57 </body>
58 </html>
59