diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b650d177..5283e37af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,14 +23,14 @@ * `L.esri.ClusteredFeatureLayer` and `L.esri.HeatMapFeatureLayer` now inherit from `L.`L.esri.FeatureManager` so they share many new methods and options. * `L.esri.FeatureLayer`, `L.esri.ClusteredFeatureLayer` and `L.esri.HeatMapFeatureLayer` now support time enabled service via `from`, `to`, `timeFields` and `timeFilterMode` options and `setTimeRange(from, to)` and `getTimeRange()` methods. * `L.esri.FeatureLayer`, `L.esri.ClusteredFeatureLayer` and `L.esri.HeatMapFeatureLayer` now support `where` options and have new methods for `setWhere()` and `getWhere()` to perform filtering. -* `L.esri.FeatureLayer` now supports generalizing polygon and polyline features on the service side for performence using the new `simplifyFactor` option. +* `L.esri.FeatureLayer` now supports generalizing polygon and polyline features on the service side for performance using the new `simplifyFactor` option. * Don't throw errors when `L.esri.BasemapLayer` is added to maps without an attribution control. If you do not add attribution you must handle adding attribution your self to the map. * Remove rbush. Switch to tracking feature ids with the cell key system. * Remove `L.esri.Util.geojsonBounds` as it was only being used to create bounds and envelopes for rbush. * add `bindPopup` method to `L.esri.DynamicMapLayer`. * add `getTimeRange` and `setTimeRange` methods `L.esri.DynamicMapLayer`. * New `L.esri.Services` namespace to handle generic abstraction of interacting with ArcGIS Online and ArcGIS server services. -* new `L.esri.Services.Service` base class that can be used for interacting with any service. All `L.esri.Layers` classes now uses `L.esri.Services.Service` internally for their API requests. This class also abstracts authentication and proxying.s +* new `L.esri.Services.Service` base class that can be used for interacting with any service. All `L.esri.Layers` classes now uses `L.esri.Services.Service` internally for their API requests. This class also abstracts authentication and proxying. * new `L.esri.Services.FeatureLayer` class for interacting with the Feature Layer API. * new `L.esri.Services.MapService` class for interacting with the Map Server API. * new `L.esri.Tasks` namespace for tasks that map to individual API methods. @@ -64,6 +64,6 @@ * Improve DynamicMapLayer panning and zooming performance. #137 * FeatureLayer and ClusteredFeatureLayer can now load features from map services. Thanks to @odoe and @jgravois. -* FeatureLayer, DynamicMapLayer and ClusteredFeatureLayer all accept a token option for accessing services that require authentication and fire a authenticationrequired event when they encounter a need for a token. Thanks to @aaronpk for the Oauth demos. #139 +* FeatureLayer, DynamicMapLayer and ClusteredFeatureLayer all accept a token option for accessing services that require authentication and fire a `authenticationrequired` event when they encounter a need for a token. Thanks to @aaronpk for the Oauth demos. #139 * Add DarkGray and DarkGrayLabels to BasemapLayer. #190 -* An attributionControl on maps is now required when using BasemapLayer. #159 \ No newline at end of file +* An attributionControl on maps is now required when using BasemapLayer. #159 diff --git a/README.md b/README.md index 538218831..d2c5c6e8e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Esri Leaflet -Leaflet plugin for [ArcGIS Services](http://developers.arcgis.com). Currently Esri Leaflet supports loading Esri [basemaps](http://esri.github.io/esri-leaflet/examples/switching-basemaps.html) and [feature services](http://esri.github.io/esri-leaflet/examples/simple-feature-layer.html), as well as [tiled](http://esri.github.io/esri-leaflet/examples/tile-layer-2.html) and [dynamic](http://esri.github.io/esri-leaflet/examples/simple-dynamic-map-layer.html) map services. +Leaflet plugins for [ArcGIS Services](http://developers.arcgis.com). Currently Esri Leaflet supports loading Esri [basemaps](http://esri.github.io/esri-leaflet/examples/switching-basemaps.html) and [feature services](http://esri.github.io/esri-leaflet/examples/simple-feature-layer.html), as well as [tiled](http://esri.github.io/esri-leaflet/examples/tile-layer-2.html) and [dynamic](http://esri.github.io/esri-leaflet/examples/simple-dynamic-map-layer.html) map services. The goal of Esri Leaflet is **not** to replace the [ArcGIS API for JavaScript](https://developers.arcgis.com/en/javascript/), but rather to provide small components to allow developers to build mapping applications with Leaflet. @@ -73,7 +73,7 @@ Make Sure you have the [Grunt CLI](http://gruntjs.com/getting-started) installed 1. [Fork and clone Esri Leaflet](https://help.github.com/articles/fork-a-repo) 2. `cd` into the `esri-leaflet` folder -5. Install the dependancies with `npm install` +5. Install the dependencies with `npm install` 5. run `grunt` from the command line. This will start the web server locally at [http://localhost:8001](http://localhost:8001) and start watching the source files and running linting and testing commands. 6. Make your changes and create a [pull request](https://help.github.com/articles/creating-a-pull-request) @@ -112,7 +112,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 +> http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -123,4 +123,4 @@ limitations under the License. A copy of the license is available in the repository's [license.txt]( https://raw.github.com/Esri/esri-leaflet/master/license.txt) file. [](Esri Tags: ArcGIS Web Mapping Leaflet) -[](Esri Language: JavaScript) \ No newline at end of file +[](Esri Language: JavaScript) diff --git a/package.json b/package.json index 936254578..39cb4dc84 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "Esri-Leaflet", "version": "0.0.1-beta.5", - "description": "Leaflet Plugins for consuming ArcGIS Online and ArcGIS Server services", + "description": "Leaflet plugins for consuming ArcGIS Online and ArcGIS Server services", "main": "dist/esri-leaflet.js", "devDependencies": { "grunt": "^0.4.2", @@ -42,4 +42,4 @@ "license": "Apache", "readmeFilename": "README.md", "dependencies": {} -} \ No newline at end of file +} diff --git a/site/source/pages/api-reference/index.hbs b/site/source/pages/api-reference/index.hbs index 963a98eee..5bef55107 100644 --- a/site/source/pages/api-reference/index.hbs +++ b/site/source/pages/api-reference/index.hbs @@ -7,7 +7,7 @@ layout: documentation.hbs ### L.esri.Layers -Layers provide visualization capabilites for data hosted in Feautre Services and Map Services. +Layers provide visualization capabilities for data hosted in Feature Services and Map Services. * [`L.esri.Layers.BasemapLayer`]({{assets}}api-reference/layers/basemap-layer.html) * [`L.esri.Layers.DynamicMapLayer`]({{assets}}api-reference/layers/dynamic-map-layer.html) diff --git a/site/source/pages/api-reference/layers/clustered-feature-layer.md b/site/source/pages/api-reference/layers/clustered-feature-layer.md index af41ca4e6..68108f471 100644 --- a/site/source/pages/api-reference/layers/clustered-feature-layer.md +++ b/site/source/pages/api-reference/layers/clustered-feature-layer.md @@ -90,7 +90,7 @@ More information about Feature Layers can be found in the [`L.esri.Layers.Featur precision Integer - How many digits of precision to request from the server. Wikipedia has a great referance of digit precision to meters. + How many digits of precision to request from the server. Wikipedia has a great reference of digit precision to meters. token @@ -100,7 +100,7 @@ More information about Feature Layers can be found in the [`L.esri.Layers.Featur proxy String - URL of an ArcGIS API for JavaScript proxies or ArcGIS Resoruce Proxies to use for proxying POST requests. + URL of an ArcGIS API for JavaScript proxies or ArcGIS Resource Proxies to use for proxying POST requests. useCORS @@ -147,7 +147,7 @@ In additon to these events `L.esri.FeatureLayer` also fires the following [Mouse setStyle({{{param 'PathOptions' 'style' 'http://leafletjs.com/reference.html#path-options'}}})

setStyle({{{param 'Function' 'style'}}}) this - Sets the given path options to each layer that has a setStyle method. Can also be a Function that will recive a feature argument and should return Path Options + Sets the given path options to each layer that has a setStyle method. Can also be a Function that will receive a feature argument and should return Path Options 
featureLayer.setStyle(1, {
     color: white;
 })
@@ -240,7 +240,7 @@ In additon to these events `L.esri.FeatureLayer` also fires the following [Mouse Adds a new feature to the feature layer. this also adds the feature to the map if creation is successful. @@ -251,7 +251,7 @@ In additon to these events `L.esri.FeatureLayer` also fires the following [Mouse Update the provided feature on the Feature Layer. This also updates the feature on the map. @@ -262,7 +262,7 @@ In additon to these events `L.esri.FeatureLayer` also fires the following [Mouse Remove the feature with the provided id from the feature layer. This will also remove the feature from the map if it exists. @@ -292,4 +292,4 @@ var busStops = new L.esri.ClusteredFeatureLayer(url, { }); } }).addTo(map); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/layers/dynamic-map-layer.md b/site/source/pages/api-reference/layers/dynamic-map-layer.md index 32f78dbb9..1eaad8c25 100644 --- a/site/source/pages/api-reference/layers/dynamic-map-layer.md +++ b/site/source/pages/api-reference/layers/dynamic-map-layer.md @@ -42,7 +42,7 @@ Option | Type | Default | Description `opacity` | `Integer` | `1` | Opacity of the layer. Should be a value between 0 and 1. `position` | `String` | '"front"` | position of the layer relative to other overlays `token` | `String` | `null` | If you pass a token in your options it will included in all requests to the service. See [working with authenticated services](#working-with-authenticated-services) for more information. -`proxy` | `String` | `false` | URL of an [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resoruce Proxies](https://github.com/Esri/resource-proxy) to use for proxying POST requests. +`proxy` | `String` | `false` | URL of an [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resource Proxies](https://github.com/Esri/resource-proxy) to use for proxying POST requests. `useCORS` | `Boolean` | `true` | If this service should use CORS when making GET requests. ### Methods @@ -120,7 +120,7 @@ Option | Type | Default | Description setTimeRange({{{param 'Date' 'from'}}}, {{{param 'Date' 'to'}}}) this - Redraws the layer witht he passed time range. + Redraws the layer with he passed time range. getTimeOptions() @@ -184,4 +184,4 @@ L.esri.dynamicMapLayer(url, { opacity : 0.25 }).addTo(map); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/layers/feature-layer.md b/site/source/pages/api-reference/layers/feature-layer.md index 6239a562a..e2e0bb16f 100644 --- a/site/source/pages/api-reference/layers/feature-layer.md +++ b/site/source/pages/api-reference/layers/feature-layer.md @@ -106,7 +106,7 @@ You can create a new empty feature service witha single layer on the [ArcGIS fo precision Integer - How many digits of precision to request from the server. Wikipedia has a great referance of digit precision to meters. + How many digits of precision to request from the server. Wikipedia has a great reference of digit precision to meters. token @@ -116,7 +116,7 @@ You can create a new empty feature service witha single layer on the [ArcGIS fo proxy String - URL of an ArcGIS API for JavaScript proxies or ArcGIS Resoruce Proxies to use for proxying POST requests. + URL of an ArcGIS API for JavaScript proxies or ArcGIS Resource Proxies to use for proxying POST requests. useCORS @@ -151,7 +151,7 @@ In additon to these events `L.esri.Layer.FeatureLayer` also fires the following setStyle({{{param 'PathOptions' 'style' 'http://leafletjs.com/reference.html#path-options'}}})

setStyle({{{param 'Function' 'style'}}}) this - Sets the given path options to each layer that has a setStyle method. Can also be a Function that will recive a feature argument and should return Path Options + Sets the given path options to each layer that has a setStyle method. Can also be a Function that will receive a feature argument and should return Path Options 
featureLayer.setStyle(1, {
     color: white;
 })
@@ -256,7 +256,7 @@ In additon to these events `L.esri.Layer.FeatureLayer` also fires the following Adds a new feature to the feature layer. this also adds the feature to the map if creation is successful. @@ -267,7 +267,7 @@ In additon to these events `L.esri.Layer.FeatureLayer` also fires the following Update the provided feature on the Feature Layer. This also updates the feature on the map. @@ -278,7 +278,7 @@ In additon to these events `L.esri.Layer.FeatureLayer` also fires the following Remove the feature with the provided id from the feature layer. This will also remove the feature from the map if it exists. @@ -294,4 +294,4 @@ var map = L.map('map').setView([45.53,-122.64], 14); L.esri.basemapLayer("Streets").addTo(map); var busStops = L.esri.featureLayer('http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/stops/FeatureServer/0/').addTo(map); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/layers/heatmap-feature-layer.md b/site/source/pages/api-reference/layers/heatmap-feature-layer.md index ee00d3f0d..a7bf69d59 100644 --- a/site/source/pages/api-reference/layers/heatmap-feature-layer.md +++ b/site/source/pages/api-reference/layers/heatmap-feature-layer.md @@ -69,7 +69,7 @@ More information about Feature Layers can be found in the [`L.esri.Layers.Featur precision Integer - How many digits of precision to request from the server. Wikipedia has a great referance of digit precision to meters. + How many digits of precision to request from the server. Wikipedia has a great reference of digit precision to meters. token @@ -79,7 +79,7 @@ More information about Feature Layers can be found in the [`L.esri.Layers.Featur proxy String - URL of an ArcGIS API for JavaScript proxies or ArcGIS Resoruce Proxies to use for proxying POST requests. + URL of an ArcGIS API for JavaScript proxies or ArcGIS Resource Proxies to use for proxying POST requests. useCORS @@ -165,7 +165,7 @@ More information about Feature Layers can be found in the [`L.esri.Layers.Featur Adds a new feature to the feature layer. this also adds the feature to the map if creation is successful. @@ -176,7 +176,7 @@ More information about Feature Layers can be found in the [`L.esri.Layers.Featur Update the provided feature on the Feature Layer. This also updates the feature on the map. @@ -187,7 +187,7 @@ More information about Feature Layers can be found in the [`L.esri.Layers.Featur Remove the feature with the provided id from the feature layer. This will also remove the feature from the map if it exists. @@ -205,4 +205,4 @@ L.esri.basemapLayer('Gray').addTo(map); var heatmap = new L.esri.HeatmapFeatureLayer("http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Graffiti_Locations3/FeatureServer/0", { radius: 12 }).addTo(map); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/layers/index.md b/site/source/pages/api-reference/layers/index.md index d72bb24c6..be98fd348 100644 --- a/site/source/pages/api-reference/layers/index.md +++ b/site/source/pages/api-reference/layers/index.md @@ -4,7 +4,7 @@ layout: documentation.hbs # L.esri.Layers -Layers provide visualization capabilites for data hosted in Feautre Services and Map Services.s +Layers provide visualization capabilities for data hosted in Feature Services and Map Services.s * [`L.esri.Layers.BasemapLayer`]({{assets}}api-reference/layers/basemap-layer.html) * [`L.esri.Layers.DynamicMapLayer`]({{assets}}api-reference/layers/dynamic-map-layer.html) diff --git a/site/source/pages/api-reference/layers/tiled-map-layer.md b/site/source/pages/api-reference/layers/tiled-map-layer.md index ac0a4c382..61e47568e 100644 --- a/site/source/pages/api-reference/layers/tiled-map-layer.md +++ b/site/source/pages/api-reference/layers/tiled-map-layer.md @@ -7,7 +7,7 @@ layout: documentation.hbs Inherits from [`L.TileLayer`](http://leafletjs.com/reference.html#tilelayer) -Access tiles from ArcGIS Online and ArcGIS Server as well as visualze and identify features on them. +Access tiles from ArcGIS Online and ArcGIS Server as well as visualize and identify features on them. Is you have Feature Services published on ArcGIS online you can create a static set of tiles using your Feature Service. You can find details on that process on the [ArcGIS Online Help](http://doc.arcgis.com/en/arcgis-online/share-maps/publish-tiles.htm#ESRI_SECTION1_F68FCBD33BD54117B23232D41A762E89) @@ -34,7 +34,7 @@ Is you have Feature Services published on ArcGIS online you can create a static | Option | Type | Default | Description | | --- | --- | --- | --- | -| `proxy` | `String` | `false` | URL of an [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resoruce Proxies](https://github.com/Esri/resource-proxy) to use for proxying POST requests. | +| `proxy` | `String` | `false` | URL of an [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resource Proxies](https://github.com/Esri/resource-proxy) to use for proxying POST requests. | | `useCORS` | `Boolean` | `true` | If this service should use CORS when making GET requests. | `L.esri.TiledMapLayer` also accepts all [`L.TileLayer`](http://leafletjs.com/reference.html#tilelayer-options) options. @@ -94,4 +94,4 @@ var map = L.map('map').setView([37.7614, -122.3911], 12); L.esri.tiledMapLayer("http://services.arcgisonline.com/ArcGIS/rest/services/USA_Topo_Maps/MapServer", { maxZoom: 15 }).addTo(map); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/request.md b/site/source/pages/api-reference/request.md index e88105af0..a20e3ff9c 100644 --- a/site/source/pages/api-reference/request.md +++ b/site/source/pages/api-reference/request.md @@ -7,18 +7,18 @@ layout: documentation.hbs Generic methods for GET and POST requests to ArcGIS Online or ArcGIS Server resources. These methods will handle serializing the input parameters and the parsing of the response into a response and error property similar to Node JS. -GET requests will be made with `XMLHttpRequest` (via CORS) if the browser supports it and will fallback to JSONP. POST requests will always me made with `XMLHttpRequest` (via CORS) but the [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) and the [ArcGIS Resoruce Proxies](https://github.com/Esri/resource-proxy) are support via [`L.esri.Services.Service`]({{assets}}api-reference/services/service.html). +GET requests will be made with `XMLHttpRequest` (via CORS) if the browser supports it and will fallback to JSONP. POST requests will always me made with `XMLHttpRequest` (via CORS) but the [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) and the [ArcGIS Resource Proxies](https://github.com/Esri/resource-proxy) are support via [`L.esri.Services.Service`]({{assets}}api-reference/services/service.html). ### L.esri.get(url, params, callback) Execute a GET request via `XMLHttpRequest' (via CORS) or JSON depending on what is available in the browser. -**Note**: ArcGIS server before 10.1 does not have CORS support enabled by default. You can either enable CORSon your server or tell Esri Leafelt to always use JSONP requests with `L.esri.get = L.esri.Request.get.JSONP;` After you load Esri leaflet but befor your own scripts. +**Note**: ArcGIS server before 10.1 does not have CORS support enabled by default. You can either enable CORSon your server or tell Esri Leaflet to always use JSONP requests with `L.esri.get = L.esri.Request.get.JSONP;` After you load Esri leaflet but before your own scripts. #### Params | Param | Value | Description | -| --- | --- | --- | +| --- | --- | --- | | `url` | `String`| The URL to request. | | `params` | `Object` | The parameters to send as a query string. | | `callback` | `Function` | Function to run when the request completes, will be passed `error` and `response`. | @@ -40,10 +40,10 @@ L.esri.get('http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Her Execute a POST request via `XMLHttpRequest' (via CORS). -This request is made via `XMLHttpRequest` which cannot make cross domain requests in IE 8 and 9. Esri Leaflet supports both the [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) and the [ArcGIS Resoruce Proxies](https://github.com/Esri/resource-proxy) which can be hosted on your server and used with the [`L.esri.Services.Service`]({{assets}}api-reference/services/service.html) classes to work around this issue. +This request is made via `XMLHttpRequest` which cannot make cross domain requests in IE 8 and 9. Esri Leaflet supports both the [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) and the [ArcGIS Resource Proxies](https://github.com/Esri/resource-proxy) which can be hosted on your server and used with the [`L.esri.Services.Service`]({{assets}}api-reference/services/service.html) classes to work around this issue. | Param | Value | Description | -| --- | --- | --- | +| --- | --- | --- | | `url` | `String`| The URL to request. | | `params` | `Object` | The parameters to send as a query string. | | `callback` | `Function` | Function to run when the request completes, will be passed `error` and `response`. | @@ -59,4 +59,4 @@ L.esri.post('http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/He console.log(response.name); } }); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/services/feature-layer.md b/site/source/pages/api-reference/services/feature-layer.md index f2cd09a18..78de8686f 100644 --- a/site/source/pages/api-reference/services/feature-layer.md +++ b/site/source/pages/api-reference/services/feature-layer.md @@ -7,7 +7,7 @@ layout: documentation.hbs Inherits from [`L.esri.Service`]({{assets}}/api-reference/services/service.html) -`L.esri.Services.FeatureLayer` is an abstaction interacting with Feature Layers running on ArcGIS Online and ArcGIS server that allows you to make requests to the API, as well as query, add, update and remove features from the service. +`L.esri.Services.FeatureLayer` is an abstraction interacting with Feature Layers running on ArcGIS Online and ArcGIS server that allows you to make requests to the API, as well as query, add, update and remove features from the service. ### Constructor @@ -21,7 +21,7 @@ Inherits from [`L.esri.Service`]({{assets}}/api-reference/services/service.html) new L.esri.Services.FeatureLayer({{{param 'String' 'url'}}}, {{{param 'Object' 'options'}}})

L.esri.Services.featureLayer({{{param 'String' 'url'}}}, {{{param 'Object' 'options'}}}) - The `url` parameter is the url to the ArcGIS Server or ArcGIS Online feature layer you would like to consume. + The `url` parameter is the URL to the ArcGIS Server or ArcGIS Online feature layer you would like to consume. @@ -64,7 +64,7 @@ Inherits from [`L.esri.Service`]({{assets}}/api-reference/services/service.html) Adds a new feature to the feature layer. this also adds the feature to the map if creation is successful. @@ -75,7 +75,7 @@ Inherits from [`L.esri.Service`]({{assets}}/api-reference/services/service.html) Update the provided feature on the Feature Layer. This also updates the feature on the map. @@ -170,4 +170,4 @@ var service = L.esri.Services.featureLayer('http://services.arcgis.com/rOo16HdIM service.query().where("name='Hello World'").run(function(error, featureCollection, response){ console.log(featureCollection.features[0].properties.name); }); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/services/map-service.md b/site/source/pages/api-reference/services/map-service.md index f40d58163..0a1944b56 100644 --- a/site/source/pages/api-reference/services/map-service.md +++ b/site/source/pages/api-reference/services/map-service.md @@ -7,7 +7,7 @@ layout: documentation.hbs Inherits from [`L.esri.Service`]({{assets}}/api-reference/services/service.html) -`L.esri.Services.MapService` is an abstaction interacting with Map Services running on ArcGIS Online and ArcGIS server that allows you to make requests to the API, as well as query and identify features on the service. +`L.esri.Services.MapService` is an abstraction interacting with Map Services running on ArcGIS Online and ArcGIS server that allows you to make requests to the API, as well as query and identify features on the service. ### Constructor @@ -21,7 +21,7 @@ Inherits from [`L.esri.Service`]({{assets}}/api-reference/services/service.html) new L.esri.Services.MapService({{{param 'String' 'url'}}}, {{{param 'Object' 'options'}}})

L.esri.Services.mapService({{{param 'String' 'url'}}}, {{{param 'Object' 'options'}}}) - The `url` parameter is the url to the ArcGIS Server or ArcGIS Online map service you would like to consume. + The `url` parameter is the URL to the ArcGIS Server or ArcGIS Online map service you would like to consume. @@ -36,7 +36,7 @@ Inherits from [`L.esri.Service`]({{assets}}/api-reference/services/service.html) ### Methods -| Method | Returns | Description | +| Method | Returns | Description | | --- | --- | --- | | `identify()` | `this` | Returns a new [`L.esri.Tasks.Identify()`]({{assets}}/api-reference/tasks/query.html) object bound to this service. | @@ -54,4 +54,4 @@ service.identify() .run(function(error, featureCollection, response){ console.log("UTC Offset: " + featureCollection.features[0].properties.ZONE); }); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/services/service.md b/site/source/pages/api-reference/services/service.md index 1ce862cb5..826b6c6bc 100644 --- a/site/source/pages/api-reference/services/service.md +++ b/site/source/pages/api-reference/services/service.md @@ -18,7 +18,7 @@ A generic class representing a hosted resource on ArcGIS Online or ArcGIS Server new L.esri.Services.Service({{{param 'String' 'url'}}}, {{{param 'Object' 'options'}}})

L.esri.Services.service({{{param 'String' 'url'}}}, {{{param 'Object' 'options'}}}) - The `url` parameter is the url to the ArcGIS Server or ArcGIS Online service you would like to consume. + The `url` parameter is the URL to the ArcGIS Server or ArcGIS Online service you would like to consume. @@ -27,12 +27,12 @@ A generic class representing a hosted resource on ArcGIS Online or ArcGIS Server | Option | Type | Default | Description | | --- | --- | --- | --- | -| `proxy` | `String` | `false` | URL of an [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resoruce Proxies](https://github.com/Esri/resource-proxy) to use for proxying POST requests. | +| `proxy` | `String` | `false` | URL of an [ArcGIS API for JavaScript proxies](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resource Proxies](https://github.com/Esri/resource-proxy) to use for proxying POST requests. | | `useCORS` | `Boolean` | `true` | If this service should use CORS when making GET requests. | ### Events -| Event | Type | Description | +| Event | Type | Description | | --- | --- | --- | | `requeststart` | [<`RequestEvent`>]({{assets}}api-reference/events.html#request-event) | Fired when a request to the service begins. | | `requestend` | [<`RequestEvent`>]({{assets}}api-reference/events.html#request-event) | Fired when a request to the service ends. | @@ -72,4 +72,4 @@ A generic class representing a hosted resource on ArcGIS Online or ArcGIS Server Authenticates this service with a new token and runs any pending requests that required a token. - \ No newline at end of file + diff --git a/site/source/pages/api-reference/tasks/identify.md b/site/source/pages/api-reference/tasks/identify.md index 741183f21..196671570 100644 --- a/site/source/pages/api-reference/tasks/identify.md +++ b/site/source/pages/api-reference/tasks/identify.md @@ -5,7 +5,7 @@ layout: documentation.hbs # {{page.data.title}} -`L.esri.Tasks.Identify` is an abstaction for the Identify API that exists on Map Services. It provides a chainable API for building request parameters and executing the request. +`L.esri.Tasks.Identify` is an abstraction for the Identify API that exists on Map Services. It provides a chainable API for building request parameters and executing the request. ### Constructor @@ -22,7 +22,7 @@ layout: documentation.hbs L.esri.Tasks.identify({{{param 'MapService' 'endpoint' '../../api-reference/services/map-service.html'}}})

new L.esri.Tasks.Identify({{{param 'String' 'endpoint'}}})

L.esri.Tasks.identify({{{param 'String' 'endpoint'}}})
- The `endpoint` parameter is the service that you want to identify either an ArcGIS Server or ArcGIS Online service. You can also pass the URL to a service directly as a string. See [service URLs](#service-urls) for more information on how to find these urls. + The `endpoint` parameter is the service that you want to identify either an ArcGIS Server or ArcGIS Online service. You can also pass the URL to a service directly as a string. See [service URLs](#service-urls) for more information on how to find these URLs. @@ -76,7 +76,7 @@ layout: documentation.hbs simplify({{{param 'Map' 'map' 'http://leafletjs.com/reference.html#map'}}}, {{{param 'Integer' 'factor'}}}) this - Simplify the geometries of the output features for the current map view. the factor parameter controls the amount of simplification between 0 (no simplication)and 1 (simplify to the most basic shape possible). + Simplify the geometries of the output features for the current map view. the factor parameter controls the amount of simplification between 0 (no simplification) and 1 (simplify to the most basic shape possible). token({{{param 'String' 'token'}}}) @@ -86,7 +86,7 @@ layout: documentation.hbs run({{{param 'Function' 'callback'}}}, {{{param 'Object' 'context'}}}) this - Exectues the identify request with the current parameters, identified features will be passed to callback as a GeoJSON FeatureCollection. Accepts an optional function context + Executes the identify request with the current parameters, identified features will be passed to callback as a GeoJSON FeatureCollection. Accepts an optional function context @@ -103,4 +103,4 @@ L.esri.Tasks.identify('http://sampleserver6.arcgisonline.com/arcgis/rest/service .run(function(error, featureCollection, response){ console.log("UTC Offset: " + featureCollection.features[0].properties.ZONE); }); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/tasks/query.md b/site/source/pages/api-reference/tasks/query.md index 29e177237..a9393aeac 100644 --- a/site/source/pages/api-reference/tasks/query.md +++ b/site/source/pages/api-reference/tasks/query.md @@ -5,7 +5,7 @@ layout: documentation.hbs # {{page.data.title}} -`L.esri.Tasks.Query` is an abstaction for the query API that exists on Feature Layers and Map Services. It provides a chainable API for building request parameters and executing queries. +`L.esri.Tasks.Query` is an abstraction for the query API that exists on Feature Layers and Map Services. It provides a chainable API for building request parameters and executing queries. ### Constructor @@ -22,7 +22,7 @@ layout: documentation.hbs L.esri.Tasks.query({{{param 'FeatureLayer' 'endpoint' '../../api-reference/services/feature-layer.html'}}})

new L.esri.Tasks.Query({{{param 'String' 'endpoint'}}})

L.esri.Tasks.query({{{param 'String' 'endpoint'}}}) - The `endpoint` parameter is the service that you want to query either an ArcGIS Server or ArcGIS Online service. You can also pass the URL to a service directly as a string. See [service URLs](#service-urls) for more information on how to find these urls. + The `endpoint` parameter is the service that you want to query either an ArcGIS Server or ArcGIS Online service. You can also pass the URL to a service directly as a string. See [service URLs](#service-urls) for more information on how to find these URLs. @@ -41,7 +41,7 @@ layout: documentation.hbs within({{{param 'LatLngBounds' 'bounds' 'http://leafletjs.com/reference.html#latlngbounds'}}}) this - Queries feautres with the given LatLngBounds object. + Queries features with the given LatLngBounds object. nearby({{{param 'LatLng' 'latlng' 'http://leafletjs.com/reference.html#latlng'}}}, {{{param 'Integer' 'distance'}}}) @@ -56,7 +56,7 @@ layout: documentation.hbs offset({{{param 'Integer' 'offset'}}}) this - Define the offest of the results, when combined with `limit` can be used for paging. Available only for Feature Services hosted on ArcGIS Online. + Define the offset of the results, when combined with `limit` can be used for paging. Available only for Feature Services hosted on ArcGIS Online. limit({{{param 'Integer' 'limit'}}}) @@ -76,7 +76,7 @@ layout: documentation.hbs simplify({{{param 'Map' 'map' 'http://leafletjs.com/reference.html#map'}}}, {{{param 'Integer' 'factor'}}}) this - Simplify the geometries of the output features for the current map view. the factor parameter controls the amount of simplification between 0 (no simplication)and 1 (simplify to the most basic shape possible). + Simplify the geometries of the output features for the current map view. the factor parameter controls the amount of simplification between 0 (no simplification) and 1 (simplify to the most basic shape possible). orderBy({{{param 'String' 'fieldName'}}}, {{{param 'String' 'order'}}}) @@ -97,7 +97,7 @@ layout: documentation.hbs token({{{param 'String' 'token'}}}) this Adds a token to this request if the service requires authentication. Will be added automatically if used with a service. - + run({{{param 'Function' 'callback'}}}, {{{param 'Object' 'context'}}}) this @@ -197,4 +197,4 @@ var query = L.esri.Tasks.query('http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcg query.where("zone_id='B'").bounds(function(error, latLngBounds, response){ map.fitBounds(latLngBounds); }); -``` \ No newline at end of file +``` diff --git a/site/source/pages/api-reference/utils.md b/site/source/pages/api-reference/utils.md index 8144b0ecf..cbabd08e0 100644 --- a/site/source/pages/api-reference/utils.md +++ b/site/source/pages/api-reference/utils.md @@ -5,7 +5,7 @@ layout: documentation.hbs # L.esri.Utils -Utility methods used internally by Esri Leaflet. These methods are useful for converting data between ArcGIS and Leaflt formats. +Utility methods used internally by Esri Leaflet. These methods are useful for converting data between ArcGIS and Leaflet formats. diff --git a/site/source/pages/download/index.md b/site/source/pages/download/index.md index ab2978ed7..896ad1a9a 100644 --- a/site/source/pages/download/index.md +++ b/site/source/pages/download/index.md @@ -6,7 +6,7 @@ class: no-sidebar # Download -All builds of Esri Leaflet are availble for download on [GitHub](https://github.com/Esri/esri-leaflet/releases/). +All builds of Esri Leaflet are available for download on [GitHub](https://github.com/Esri/esri-leaflet/releases/). Current ReleasePast Releases diff --git a/site/source/pages/examples/basemap-with-labels.hbs b/site/source/pages/examples/basemap-with-labels.hbs index 1e0b47419..5abddcd6d 100644 --- a/site/source/pages/examples/basemap-with-labels.hbs +++ b/site/source/pages/examples/basemap-with-labels.hbs @@ -1,6 +1,6 @@ --- title: Basemap with labels -description: Showing an ArcGIS Online basemap with a seperate label layer. +description: Showing an ArcGIS Online basemap with a separate label layer. layout: example.hbs --- @@ -11,4 +11,4 @@ layout: example.hbs L.esri.basemapLayer('Imagery').addTo(map); L.esri.basemapLayer('ImageryLabels').addTo(map); - \ No newline at end of file + diff --git a/site/source/pages/examples/center-map-on-address.hbs b/site/source/pages/examples/center-map-on-address.hbs index 2ee0dcb68..304cb2d50 100644 --- a/site/source/pages/examples/center-map-on-address.hbs +++ b/site/source/pages/examples/center-map-on-address.hbs @@ -1,5 +1,5 @@ --- -title: Center the inital map state +title: Center the initial map state description: Geocode an address and then center the map on it automatically. This demo relies of the Esri Leaflet Geocoder plugin. layout: example.hbs --- @@ -21,4 +21,4 @@ layout: example.hbs geocoder.geocode('New York City', {}, function (error, results) { map.fitBounds(results[0].bounds); }); - \ No newline at end of file + diff --git a/site/source/pages/examples/getting-service-metadata.hbs b/site/source/pages/examples/getting-service-metadata.hbs index d0ae850dc..ca2ac9c04 100644 --- a/site/source/pages/examples/getting-service-metadata.hbs +++ b/site/source/pages/examples/getting-service-metadata.hbs @@ -1,6 +1,6 @@ --- title: Getting service metadata -description: Retriving service metadata such as name, bounding box and capabilities. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. +description: Retrieving service metadata such as name, bounding box and capabilities. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. layout: example.hbs --- @@ -26,4 +26,4 @@ layout: example.hbs stops.metadata(function (error, metadata) { document.getElementById('info').innerText = metadata.name; }); - \ No newline at end of file + diff --git a/site/source/pages/examples/querying-feature-layers-1.hbs b/site/source/pages/examples/querying-feature-layers-1.hbs index e9e87dd4e..815b40e08 100644 --- a/site/source/pages/examples/querying-feature-layers-1.hbs +++ b/site/source/pages/examples/querying-feature-layers-1.hbs @@ -1,6 +1,6 @@ --- title: Querying features -description: Configuting a query to filter features on a L.esri.Layers.FeatureLayer. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. +description: Configuring a query to filter features on a L.esri.Layers.FeatureLayer. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. layout: example.hbs --- @@ -81,4 +81,4 @@ layout: example.hbs direction.addEventListener('change', function(){ stops.setWhere('direction="'+direction.value+'"'); }); - \ No newline at end of file + diff --git a/site/source/pages/examples/querying-feature-layers-2.hbs b/site/source/pages/examples/querying-feature-layers-2.hbs index e9f74d0c7..92c7b610e 100644 --- a/site/source/pages/examples/querying-feature-layers-2.hbs +++ b/site/source/pages/examples/querying-feature-layers-2.hbs @@ -1,6 +1,6 @@ --- title: Querying features -description: Performing advanced queries on a Feature Layer. Click on the map to query all features within 500 meteres. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. +description: Performing advanced queries on a Feature Layer. Click on the map to query all features within 500 meters. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. layout: example.hbs --- @@ -41,4 +41,4 @@ layout: example.hbs } }); }); - \ No newline at end of file + diff --git a/site/source/pages/examples/retina-basemap.hbs b/site/source/pages/examples/retina-basemap.hbs index e6d583ab2..7f6ca8042 100644 --- a/site/source/pages/examples/retina-basemap.hbs +++ b/site/source/pages/examples/retina-basemap.hbs @@ -1,6 +1,6 @@ --- title: Retina Basemap -description: Displaying basemaps at higher resolutions on retina devices with the detectRetina option. IN this example the base layer is added at retina resolutiona and the labels are added at regular resolution. +description: Displaying basemaps at higher resolutions on retina devices with the detectRetina option. In this example the base layer is added at retina resolutions and the labels are added at regular resolutions. layout: example.hbs --- @@ -16,4 +16,4 @@ layout: example.hbs // include the labels at normal resolution L.esri.basemapLayer('DarkGrayLabels').addTo(map); - \ No newline at end of file + diff --git a/site/source/pages/examples/simplifying-complex-features.hbs b/site/source/pages/examples/simplifying-complex-features.hbs index f593efb4f..239cff009 100644 --- a/site/source/pages/examples/simplifying-complex-features.hbs +++ b/site/source/pages/examples/simplifying-complex-features.hbs @@ -1,6 +1,6 @@ --- title: Simplifying complex features -description: Complex features can be simplified on the server for faster response times. Zoom in and watch as higher resolution vectors are loaded from the service. Hover over featuers for effects. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. +description: Complex features can be simplified on the server for faster response times. Zoom in and watch as higher resolution vectors are loaded from the service. Hover over features for effects. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. layout: example.hbs --- @@ -52,4 +52,4 @@ layout: example.hbs opacity: 1 }); }); - \ No newline at end of file + diff --git a/site/source/pages/examples/styling-clusters.hbs b/site/source/pages/examples/styling-clusters.hbs index 934f6d8ab..5481a76b6 100644 --- a/site/source/pages/examples/styling-clusters.hbs +++ b/site/source/pages/examples/styling-clusters.hbs @@ -1,6 +1,6 @@ --- title: Styling clusters -description: Customizing the display of custers and markers with L.DivIcon and L.MarkerClusterGroup options. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. +description: Customizing the display of clusters and markers with L.DivIcon and L.MarkerClusterGroup options. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. layout: example.hbs --- @@ -178,4 +178,4 @@ layout: example.hbs stops.bindPopup(function(feature){ return L.Util.template('{stop_name}
{stop_desc}', feature.properties); }); - \ No newline at end of file + diff --git a/site/source/pages/examples/styling-heatmaps.hbs b/site/source/pages/examples/styling-heatmaps.hbs index f9ec51cb4..5213b1156 100644 --- a/site/source/pages/examples/styling-heatmaps.hbs +++ b/site/source/pages/examples/styling-heatmaps.hbs @@ -1,6 +1,6 @@ --- title: Styling heatmaps -description: Custom styling of heatmap gradiants with the L.heat options. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. +description: Custom styling of heatmap gradients with the L.heat options. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. layout: example.hbs --- @@ -27,4 +27,4 @@ layout: example.hbs 1: '#bd0026' } }).addTo(map); - \ No newline at end of file + diff --git a/site/source/pages/examples/zooming-to-all-features.hbs b/site/source/pages/examples/zooming-to-all-features.hbs index f96ec449c..2ce2a3510 100644 --- a/site/source/pages/examples/zooming-to-all-features.hbs +++ b/site/source/pages/examples/zooming-to-all-features.hbs @@ -1,6 +1,6 @@ --- title: Zoom to all features -description: Fitting the map to the boundries of all features in the layer by querying the service. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. +description: Fitting the map to the boundaries of all features in the layer by querying the service. More information about Feature Layers can be found in the L.esri.Layers.FeatureLayer documentation. layout: example.hbs --- @@ -14,4 +14,4 @@ layout: example.hbs trees.query().bounds(function (error, latlngbounds) { map.fitBounds(latlngbounds); }); - \ No newline at end of file + diff --git a/site/source/partials/copyright.hbs b/site/source/partials/copyright.hbs index c390a3101..a2b2575da 100644 --- a/site/source/partials/copyright.hbs +++ b/site/source/partials/copyright.hbs @@ -1,3 +1,3 @@
-

Esri Leaflet is a project from the Esri PDX R&D Center and the Esri Community

-
\ No newline at end of file +

Esri Leaflet is a project from the Esri PDX R&D Center and the Esri Community

+ diff --git a/site/source/partials/sidebar-examples.hbs b/site/source/partials/sidebar-examples.hbs index a5d0578da..7473f4c3b 100644 --- a/site/source/partials/sidebar-examples.hbs +++ b/site/source/partials/sidebar-examples.hbs @@ -50,7 +50,7 @@
Geocoding
@@ -59,4 +59,4 @@ Getting service metadata - \ No newline at end of file +