esri-leaflet

<!DOCTYPE html>      <html class="not-ie">  <head> <meta charset="utf-8"> <title>L.esri.Tasks.IdentifyImage | Esri Leaflet</title> <meta name="description" content="Esri Leaflet"> <meta name="viewport" content="width=device-width">   <link href='//fonts.googleapis.com/css?family=Vollkorn:400italic,700italic,400,700' rel='stylesheet' type='text/css'> <link rel="stylesheet" href="//brick.a.ssl.fastly.net/Source+Code+Pro:300"> <link href='//fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic' rel='stylesheet' type='text/css'>  <link rel="stylesheet" href="../../css/style.css">  <link rel="stylesheet" href="//cdn.jsdelivr.net/leaflet/0.7.7/leaflet.css" />  <script src="//cdn.jsdelivr.net/leaflet/0.7.7/leaflet.js"></script>  <script src="../../js/esri-leaflet-src.js"></script> <script src="//cdn.jsdelivr.net/jsdelivr-rum/latest/jsdelivr-rum.min.js"></script>  <script src="//localhost:35729/livereload.js"></script>  <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-44963317-3', 'auto'); ga('send', 'pageview'); </script>  </head> <body> <div class="page-content "> <div class="container"> <a class="site-nav" href="../../" class="left logo">Esri Leaflet</a> <nav class="right"> <a class="site-nav" href="../../examples/">Examples</a> <a class="site-nav" href="../../api-reference/">API Reference</a> <a class="site-nav" href="../../download/">Download</a> <a class="site-nav" href="https://github.com/Esri/esri-leaflet">View on GitHub</a> </nav> </div> <div id="background-map" class="background-map"></div> <div class="container white"> <aside class="sidebar"> <h5>L.esri.Layers</h5> <nav> <a href="../../api-reference/layers/basemap-layer.html">BasemapLayer</a> <a href="../../api-reference/layers/feature-layer.html">FeatureLayer</a> <a href="../../api-reference/layers/tiled-map-layer.html">TiledMapLayer</a> <a href="../../api-reference/layers/dynamic-map-layer.html">DynamicMapLayer</a> <a href="../../api-reference/layers/image-map-layer.html">ImageMapLayer</a> <a href="../../api-reference/layers/clustered-feature-layer.html">ClusteredFeatureLayer</a> <a href="../../api-reference/layers/heatmap-feature-layer.html">HeatmapFeatureLayer</a> </nav> <h5>L.esri.Tasks</h5> <nav> <a href="../../api-reference/tasks/query.html">Query</a> <a href="../../api-reference/tasks/find.html">Find</a> <a href="../../api-reference/tasks/identify-features.html">Identify Features</a> <a href="../../api-reference/tasks/identify-image.html">Identify Image</a> <a href="../../api-reference/tasks/task.html">Task</a> </nav> <h5>Misc.</h5> <nav> <a href="../../api-reference/request.html">Request</a> <a href="../../api-reference/util.html">Util</a> <a href="../../api-reference/events.html">Events</a> </nav> <h5>Base Classes</h5> <nav> <a href="../../api-reference/services/image-service.html">ImageService</a> <a href="../../api-reference/services/feature-layer.html">FeatureLayerService</a> <a href="../../api-reference/services/map-service.html">MapService</a> <a href="../../api-reference/services/service.html">Service</a> </nav> </aside> <div class="main-content"> <h1 id="l-esri-tasks-identifyimage">L.esri.Tasks.IdentifyImage</h1> <p><code>L.esri.Tasks.IdentifyImage</code> is an abstraction for the Identify API found in Image Services. It provides a chainable API for building request parameters and executing the request.</p> <h3 id="constructor">Constructor</h3> <table> <thead> <tr> <th>Constructor</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>L.esri.Tasks.identifyImage(<nobr class="param"><span><<a href="../../api-reference/services/map-service.html">ImageService</a>></span> <code>endpoint</code></nobr>)</code><br><br> <code>L.esri.Tasks.identifyImage(<nobr class="param"><span><Object></span> <code>options</code></nobr>)</code><br></td> <td>Accepts either an <code>options</code> object or an instance of <a href="../..//api-reference/services/image-service.html"></a>.</td> </tr> </tbody> </table> <h3 id="options">Options</h3> <table> <thead> <tr> <th>Option</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>url</code></td> <td><code>String</code></td> <td><code>''</code></td> <td>URL of the ArcGIS service you would like to consume.</td> </tr> <tr> <td><code>proxy</code></td> <td><code>String</code></td> <td><code>false</code></td> <td>URL of an <a href="https://developers.arcgis.com/javascript/jshelp/ags_proxy.html">ArcGIS API for JavaScript proxy</a> or <a href="https://github.com/Esri/resource-proxy">ArcGIS Resource Proxy</a> to use for proxying POST requests.</td> </tr> <tr> <td><code>useCors</code></td> <td><code>Boolean</code></td> <td><code>true</code></td> <td>If this task should use CORS when making GET requests.</td> </tr> </tbody> </table> <h3 id="methods">Methods</h3> <table> <thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>at(<nobr class="param"><span><<a href="http://leafletjs.com/reference.html#latlng">LatLng</a>></span> <code>latlng</code></nobr>)</code></td> <td><code>this</code></td> <td>Identifie the pixel value at a given <a href="http://leafletjs.com/reference.html#latlng">LatLng</a></td> </tr> <tr> <td><code>between(<nobr class="param"><span><Date></span> <code>from</code></nobr>, <nobr class="param"><span><Date></span> <code>to</code></nobr>)</code></td> <td><code>this</code></td> <td>Identifies pixel values within a given time range.</td> </tr> <tr> <td><code>getRenderingRule()</code></td> <td><code>Object</code></td> <td>Returns the current rendering rule of the task.</td> </tr> <tr> <td><code>setRenderingRule(<nobr class="param"><span><Object></span> <code>renderingRule</code></nobr>)</code></td> <td><code>this</code></td> <td>Sets the rendering rule to apply when getting a pixel value.</td> </tr> <tr> <td><code>getMosaicRule()</code></td> <td><code>Object</code></td> <td>Returns the current mosaic rule of the task.</td> </tr> <tr> <td><code>setMosaicRule(<nobr class="param"><span><Object></span> <code>mosaicRule</code></nobr>)</code></td> <td><code>this</code></td> <td>Sets the mosaic rule to apply when getting a pixel value.</td> </tr> <tr> <td><code>setPixelSize(<nobr class="param"><span><Array></span> <code>pixelSize</code></nobr> or <nobr class="param"><span><String></span> <code>pixelSize</code></nobr>)</code></td> <td><code>this</code></td> <td>Sets the pixel size to use when getting a pixel value. Either an array (<code>[x,y]</code>) or string (<code>'x,y'</code>). If not set, it will use the pixel size defined by the service.</td> </tr> <tr> <td><code>getPixelSize()</code></td> <td><code>Object</code></td> <td>Returns the current pixel size of the task.</td> </tr> <tr> <td><code>returnCatalogItems(<nobr class="param"><span><Boolean></span> <code>returnCatalogItems</code></nobr>)</code></td> <td><code>this</code></td> <td>Indicates whether or not to return raster catalog items. Set it to <code>false</code> when catalog items are not needed to improve the identify operation's performance significantly. When set to <code>false</code>, neither the geometry nor attributes of catalog items will be returned. Default is <code>false</code>.</td> </tr> <tr> <td><code>returnGeometry(<nobr class="param"><span><Boolean></span> <code>returnGeometry</code></nobr>)</code></td> <td><code>this</code></td> <td>Return catalog footprints (geometry) with catalog item results. Default is <code>false</code>.</td> </tr> <tr> <td><code>token(<nobr class="param"><span><String></span> <code>token</code></nobr>)</code></td> <td><code>this</code></td> <td>Adds a token to this request if the service requires authentication. Will be added automatically if used with a service.</td> </tr> <tr> <td><code>run(<nobr class="param"><span><Function></span> <code>callback</code></nobr>, <nobr class="param"><span><Object></span> <code>context</code></nobr>)</code></td> <td><code>this</code></td> <td>Executes the identify request with the current parameters, identified pixel value will be passed to <code>callback</code> as a <a href="http://wiki.geojson.org/GeoJSON_draft_version_5#Point">GeoJSON Point</a>. Accepts an optional function context</td> </tr> </tbody> </table> <h3 id="example">Example</h3> <pre><code class="language-js"><span class="keyword">var</span> map = L.map(<span class="string">'map'</span>).setView([<span class="number">36.230577</span>, -<span class="number">118.253147</span>], <span class="number">10</span>); L.esri.Tasks.identifyImage({ url: <span class="string">'http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Earthquakes/CaliforniaDEM/ImageServer'</span> }) .at([<span class="number">36.230577</span>, -<span class="number">118.253147</span>]) .pixelSize([<span class="number">30</span>,<span class="number">30</span>]) .run(<span class="function"><span class="keyword">function</span><span class="params">(error, identifyImageResponse, rawResponse)</span>{</span> console.log(identifyImageResponse.pixel.properties.value); });</code></pre> <p><a href="http://github.com/esri/esri-leaflet/edit/master/site/source/pages/api-reference/tasks/identify-image.md">Edit this page on GitHub</a></p> </div> <div style='clear:both;'></div> </div> <div class="container centered-text"> <p class="copyright">Esri Leaflet is a project from the <a href="http://pdx.esri.com">Esri PDX R&D Center</a> and the <a href="https://github.com/Esri/esri-leaflet/graphs/contributors">Esri Community</a></p> </div> </div> <script src="../../js/script.js"></script> </body> </html>