Skip to content
This repository has been archived by the owner on Sep 30, 2021. It is now read-only.

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bhaskar Karambelkar committed Jan 31, 2017
1 parent e7dcc73 commit fa580a8
Show file tree
Hide file tree
Showing 14 changed files with 276 additions and 31 deletions.
4 changes: 2 additions & 2 deletions docs/addEsriBasemapLayer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>addEsriBasemapLayer. leaflet.esri 0.1.2</title>
<title>addEsriBasemapLayer. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

Expand Down Expand Up @@ -32,7 +32,7 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.2</a>
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
Expand Down
112 changes: 112 additions & 0 deletions docs/addEsriDynamicMapLayer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>addEsriDynamicMapLayer. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

<link href="css/bootstrap.css" rel="stylesheet">
<link href="css/bootstrap-responsive.css" rel="stylesheet">
<link href="css/highlight.css" rel="stylesheet">
<link href="css/staticdocs.css" rel="stylesheet">

<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->

<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [ ['$','$'], ["\\(","\\)"] ],
processEscapes: true
}
});
</script>
<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
</head>

<body>
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
<li><a href="reference.html">Reference</a></li>
</ul>
</div>
</div>
</div>
</div>


<div class="container">
<header>

</header>

<h1>Render and visualize Map Services from ArcGIS Online and ArcGIS Server.</h1>

<div class="row">
<div class="span8">
<h2>Usage</h2>
<pre><span class="functioncall"><a href='addEsriDynamicMapLayer.html'>addEsriDynamicMapLayer</a></span><span class="keyword">(</span><span class="symbol">map</span><span class="keyword">,</span> <span class="symbol">url</span><span class="keyword">,</span> <span class="argument">options</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="functioncall"><a href='dynamicMapLayerOptions.html'>dynamicMapLayerOptions</a></span><span class="keyword">(</span><span class="keyword">)</span><span class="keyword">,</span>
<span class="argument">layerId</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">group</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">)</span></pre>

<h2>Arguments</h2>
<dl>
<dt>map</dt>
<dd>The leaflet map</dd>
<dt>url</dt>
<dd>URL of the <a href = 'http://resources.arcgis.com/en/help/arcgis-rest-api/#/Map_Service/02r3000000w2000000'>Map Service</a> with a tile cache.</dd>
<dt>options</dt>
<dd>options for the tiledmap layer.</dd>
<dt>layerId</dt>
<dd>A unique ID for the layer.</dd>
<dt>group</dt>
<dd>The name of the group this layer should be added to.</dd>
<dt>popupFunction</dt>
<dd>Uses the provided function to create a popup that will
identify features whenever the map is clicked.
Your function will be passed a GeoJSON FeatureCollection of the features
at the clicked location and should return the appropriate HTML.
If you do not want to open the popup when there are no results, return false.</dd>
<dt>popupOptions</dt>
<dd>See <code><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-options'>popupOptions</a></code>.</dd>
</dl>

<div class="Description">
<h2>Description</h2>

<p>Map Services are a way to expose the contents of a map as a web service and
expose capabilities for exporting tile images, querying and
identifying features and more.
Also supports custom popups and identification of features.</p>

</div>
</div>
<div class="span4 sidebar">
<!-- <ul>
<li>addEsriDynamicMapLayer</li>
</ul>
<ul>
</ul> -->




</div>
</div>

<footer>
<p class="pull-right"><a href="#">Back to top</a></p>
<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="https://getbootstrap.com/2.0.4/">bootstrap</a>.</p>
</footer>
</div>
</body>
</html>
17 changes: 10 additions & 7 deletions docs/addEsriFeatureLayer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>addEsriFeatureLayer. leaflet.esri 0.1.2</title>
<title>addEsriFeatureLayer. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

Expand Down Expand Up @@ -32,7 +32,7 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.2</a>
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
Expand Down Expand Up @@ -63,7 +63,8 @@ <h2>Usage</h2>
<span class="argument">popupOptions</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="package">leaflet</span><span class="keyword">::</span><span class="functioncall"><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-options'>popupOptions</a></span><span class="keyword">(</span><span class="keyword">)</span><span class="keyword">,</span> <span class="argument">stroke</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">TRUE</span><span class="keyword">,</span> <span class="argument">color</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"#03F"</span><span class="keyword">,</span>
<span class="argument">weight</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">5</span><span class="keyword">,</span> <span class="argument">opacity</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">0.5</span><span class="keyword">,</span> <span class="argument">fill</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">TRUE</span><span class="keyword">,</span> <span class="argument">fillColor</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="symbol">color</span><span class="keyword">,</span>
<span class="argument">fillOpacity</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">0.2</span><span class="keyword">,</span> <span class="argument">dashArray</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">smoothFactor</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">1</span><span class="keyword">,</span> <span class="argument">noClip</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">FALSE</span><span class="keyword">,</span>
<span class="argument">pathOptions</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="package">leaflet</span><span class="keyword">::</span><span class="functioncall"><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-options'>pathOptions</a></span><span class="keyword">(</span><span class="keyword">)</span><span class="keyword">,</span> <span class="argument">highlightOptions</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">)</span></pre>
<span class="argument">pathOptions</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="package">leaflet</span><span class="keyword">::</span><span class="functioncall"><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-options'>pathOptions</a></span><span class="keyword">(</span><span class="keyword">)</span><span class="keyword">,</span> <span class="argument">highlightOptions</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span>
<span class="argument">fitBounds</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">FALSE</span><span class="keyword">)</span></pre>

<h2>Arguments</h2>
<dl>
Expand Down Expand Up @@ -103,7 +104,8 @@ <h2>Arguments</h2>
<dd>The property to use for the label.
You can also pass in a JS function that takes in a feature and returns a text/HTML content.</dd>
<dt>labelOptions</dt>
<dd>A Vector of <code><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-options'>labelOptions</a></code> to provide label</dd>
<dd>A Vector of <code><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-options'>labelOptions</a></code> to provide label
options for each label. Default <code>NULL</code></dd>
<dt>popupProperty</dt>
<dd>The property to use for popup content
You can also pass in a JS function that takes in a feature and returns a text/HTML content.</dd>
Expand Down Expand Up @@ -138,9 +140,10 @@ <h2>Arguments</h2>
<dd>Options for shapes</dd>
<dt>highlightOptions</dt>
<dd>Options for highlighting the shape on mouse over.
options for each label. Default <code>NULL</code>
you can use <code><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-layers'>highlightOptions</a>()</code> to specify highlight
options</dd>
you can use <code><a href='http://www.rdocumentation.org/packages/leaflet/topics/map-layers'>highlightOptions</a>()</code> to specify highlight</dd>
<dt>fitBounds</dt>
<dd>Whether to set the maps bounds to fit the data in the featureLayer
options</dd>
</dl>

<div class="Description">
Expand Down
4 changes: 2 additions & 2 deletions docs/addEsriHeatmapFeatureLayer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>addEsriHeatmapFeatureLayer. leaflet.esri 0.1.2</title>
<title>addEsriHeatmapFeatureLayer. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

Expand Down Expand Up @@ -32,7 +32,7 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.2</a>
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/addEsriTiledMapLayer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>addEsriTiledMapLayer. leaflet.esri 0.1.2</title>
<title>addEsriTiledMapLayer. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

Expand Down Expand Up @@ -32,7 +32,7 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.2</a>
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
Expand Down
123 changes: 123 additions & 0 deletions docs/dynamicMapLayerOptions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>dynamicMapLayerOptions. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

<link href="css/bootstrap.css" rel="stylesheet">
<link href="css/bootstrap-responsive.css" rel="stylesheet">
<link href="css/highlight.css" rel="stylesheet">
<link href="css/staticdocs.css" rel="stylesheet">

<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->

<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [ ['$','$'], ["\\(","\\)"] ],
processEscapes: true
}
});
</script>
<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
</head>

<body>
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
<li><a href="reference.html">Reference</a></li>
</ul>
</div>
</div>
</div>
</div>


<div class="container">
<header>

</header>

<h1>Options for dynamic map layer.</h1>

<div class="row">
<div class="span8">
<h2>Usage</h2>
<pre><span class="functioncall"><a href='dynamicMapLayerOptions.html'>dynamicMapLayerOptions</a></span><span class="keyword">(</span><span class="argument">format</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"png24"</span><span class="keyword">,</span> <span class="argument">transparent</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">TRUE</span><span class="keyword">,</span> <span class="argument">f</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"json"</span><span class="keyword">,</span>
<span class="argument">attribution</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">""</span><span class="keyword">,</span> <span class="argument">layers</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">layerDefs</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">opacity</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">1</span><span class="keyword">,</span>
<span class="argument">position</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"front"</span><span class="keyword">,</span> <span class="argument">maxZoom</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">minZoom</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span>
<span class="argument">dynamicLayers</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">token</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">proxy</span>&nbsp;<span class="argument">=</span>&nbsp;NULL<span class="keyword">,</span> <span class="argument">useCors</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">TRUE</span><span class="keyword">,</span> <span class="symbol">...</span><span class="keyword">)</span></pre>

<h2>Arguments</h2>
<dl>
<dt>format</dt>
<dd>Output format of the image.</dd>
<dt>transparent</dt>
<dd>Allow the server to produce transparent images.</dd>
<dt>f</dt>
<dd>Server response content type.</dd>
<dt>attribution</dt>
<dd>Attribution from service metadata copyright text is automatically displayed in Leaflet&#39;s default control. This property can be used for customization.</dd>
<dt>layers</dt>
<dd>An array of Layer IDs like [3,4,5] to show from the service.</dd>
<dt>layerDefs</dt>
<dd>A string representing a query to run against the service before the image is rendered. This can be a string like &quot;3:STATE_NAME=&#39;Kansas&#39;&quot; or an object mapping different queries to specific layers 3:&quot;STATE_NAME=&#39;Kansas&#39;&quot;, 2:&quot;POP2007&gt;25000&quot;.</dd>
<dt>opacity</dt>
<dd>Opacity of the layer. Should be a value between 0 (completely transparent) and 1 (completely opaque).</dd>
<dt>position</dt>
<dd>Position of the layer relative to other overlays.</dd>
<dt>maxZoom</dt>
<dd>Closest zoom level the layer will be displayed on the map.</dd>
<dt>minZoom</dt>
<dd>Furthest zoom level the layer will be displayed on the map.</dd>
<dt>dynamicLayers</dt>
<dd>JSON object literal used to manipulate the layer symbology defined in the service itself. Requires a 10.1 (or above) map service which supports dynamicLayers requests.</dd>
<dt>token</dt>
<dd>If you pass a token in your options it will be included in all requests to the service.</dd>
<dt>proxy</dt>
<dd>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 requests.</dd>
<dt>useCors</dt>
<dd>If this service should use CORS when making GET requests.</dd>
<dt>...</dt>
<dd>extra options</dd>
</dl>

<div class="Description">
<h2>Description</h2>

<p>Options for dynamic map layer.</p>

</div>
</div>
<div class="span4 sidebar">
<!-- <ul>
<li>dynamicMapLayerOptions</li>
</ul>
<ul>
</ul> -->




</div>
</div>

<footer>
<p class="pull-right"><a href="#">Back to top</a></p>
<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="https://getbootstrap.com/2.0.4/">bootstrap</a>.</p>
</footer>
</div>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/esri-dependencies.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>addEsriDependency. leaflet.esri 0.1.2</title>
<title>addEsriDependency. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

Expand Down Expand Up @@ -32,7 +32,7 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.2</a>
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/esriBasemapLabels.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>esriBasemapLabels. leaflet.esri 0.1.2</title>
<title>esriBasemapLabels. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

Expand Down Expand Up @@ -32,7 +32,7 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.2</a>
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/esriBasemapLayers.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>esriBasemapLayers. leaflet.esri 0.1.2</title>
<title>esriBasemapLayers. leaflet.esri 0.1.3</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

Expand Down Expand Up @@ -32,7 +32,7 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">leaflet.esri 0.1.2</a>
<a class="brand" href="index.html">leaflet.esri 0.1.3</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html">Home</a></li>
Expand Down
Loading

0 comments on commit fa580a8

Please sign in to comment.