ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
fd8df2949b7b6341db8ff5ce96c7ab48925c7539
openlayers/edit/apidoc/ol.parser.html
ahocevar 84cad42f6d Publishing edit branch
2013-09-14 00:29:38 +02:00

1334 lines
26 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers 3 API Documentation - Namespace: ol.parser</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link rel="stylesheet" href="../resources/bootstrap/css/bootstrap.min.css" type="text/css">
<link rel="stylesheet" href="../resources/layout.css" type="text/css">
<link rel="stylesheet" href="../resources/bootstrap/css/bootstrap-responsive.min.css" type="text/css">
</head>
<body>
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="./">OpenLayers 3 API Documentation - Namespace: ol.parser</a>
<ul class="nav pull-right">
<li><iframe class="github-watch-button" src="http://ghbtns.com/github-btn.html?user=openlayers&repo=ol3&type=watch&count=true"
allowtransparency="true" frameborder="0" scrolling="0" height="20" width="90"></iframe></li>
<li><a href="https://twitter.com/share" class="twitter-share-button" data-count="none" data-hashtags="openlayers">&nbsp;</a></li>
<li><div class="g-plusone-wrapper"><div class="g-plusone" data-size="medium" data-annotation="none"></div></div></li>
</ul>
</div>
</div>
</div>
<div id="main">
<section>
<header>
<h2>
<span class="ancestors"><a href="ol.html">ol</a>.</span>
ol.parser
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>parser.jsdoc, line 1</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="ol.parser.GeoJSON.html">ol.parser.GeoJSON</a></dt>
<dd></dd>
<dt><a href="ol.parser.GPX.html">ol.parser.GPX</a></dt>
<dd></dd>
<dt><a href="ol.parser.KML.html">ol.parser.KML</a></dt>
<dd></dd>
<dt><a href="ol.parser.TopoJSON.html">ol.parser.TopoJSON</a></dt>
<dd></dd>
<dt><a href="ol.parser.WKT.html">ol.parser.WKT</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">TypeDefs</h3>
<dl>
<dt class="">
<h4 class="name" id="GMLOptions">GMLOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>curve</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Write gml:Curve instead of
gml:LineString elements. This also affects the elements in multi-part
geometries. Default is `false´. This only applies to GML version 3.</p></td>
</tr>
<tr>
<td class="name"><code>extractAttributes</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Should we extract attributes
from the GML? Default is `true´.</p></td>
</tr>
<tr>
<td class="name"><code>featureNS</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The feature namespace. If not set it
will be automatically configured from the GML.</p></td>
</tr>
<tr>
<td class="name"><code>featureType</code></td>
<td class="type">
<span class="param-type">Array.&lt;string></span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The local
(without prefix) feature typeName(s).</p></td>
</tr>
<tr>
<td class="name"><code>geometryName</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Name of geometry element.
Defaults to `geometry´. If null, it will be set on <read> when the
first geometry is parsed.</p></td>
</tr>
<tr>
<td class="name"><code>multiCurve</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Write gml:MultiCurve instead of
gml:MultiLineString. Since the latter is deprecated in GML 3, the
default is `true´. This only applies to GML version 3.</p></td>
</tr>
<tr>
<td class="name"><code>multiSurface</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Write gml:multiSurface instead
of gml:MultiPolygon. Since the latter is deprecated in GML 3, the
default is `true´. This only applies to GML version 3.</p></td>
</tr>
<tr>
<td class="name"><code>schemaLocation</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Optional schemaLocation to use
when writing out the GML, this will override the default provided.</p></td>
</tr>
<tr>
<td class="name"><code>surface</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Write gml:Surface instead of
gml:Polygon elements. This also affects the elements in multi-part
geometries. Default is `false´. This only applies to GML version 3.</p></td>
</tr>
<tr>
<td class="name"><code>readOptions</code></td>
<td class="type">
<span class="param-type"><a href="ol.parser.html#GMLReadOptions">ol.parser.GMLReadOptions</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>readOptions to
use for this instance.</p></td>
</tr>
<tr>
<td class="name"><code>writeOptions</code></td>
<td class="type">
<span class="param-type"><a href="ol.parser.html#GMLWriteOptions">ol.parser.GMLWriteOptions</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>writeOptions
to use for this instance.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 89</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GMLReadOptions">GMLReadOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>axisOrientation</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The axis orientation.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 85</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GMLWriteOptions">GMLWriteOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>srsName</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#ProjectionLike">ol.ProjectionLike</a></span>
</td>
<td class="description last"><p>The srsName to use when writing.</p></td>
</tr>
<tr>
<td class="name"><code>axisOrientation</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The axis orientation.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 87</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GPXOptions">GPXOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>creator</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The creator attribute to be added to
the written GPX files. Defaults to `OpenLayers´.</p></td>
</tr>
<tr>
<td class="name"><code>defaultDesc</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Default description for the
waypoints/tracks in the case where the feature has no 'description'
attribute. Default is 'No description available'.</p></td>
</tr>
<tr>
<td class="name"><code>extractAttributes</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Should we extract attributes
from the GPX? Default is `true´.</p></td>
</tr>
<tr>
<td class="name"><code>extractWaypoints</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Extract waypoints from GPX.
Default is `true´.</p></td>
</tr>
<tr>
<td class="name"><code>extractTracks</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Extract tracks from GPX.
Default is `true´.</p></td>
</tr>
<tr>
<td class="name"><code>extractRoutes</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Extract routes from GPX.
Default is `true´.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 91</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GPXWriteOptions">GPXWriteOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>features</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Feature.html">ol.Feature</a>></span>
|
<span class="param-type"><a href="ol.Feature.html">ol.Feature</a></span>
</td>
<td class="description last"><p>The features to write
out.</p></td>
</tr>
<tr>
<td class="name"><code>metadata</code></td>
<td class="type">
<span class="param-type">Object</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Metadata key/value pair with keys:
name, desc and author.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 93</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="KMLOptions">KMLOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dimension</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Create geometries with <code>dimension</code>
dimensions. Default is 3.</p></td>
</tr>
<tr>
<td class="name"><code>extractAttributes</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Should we extract attributes
from the KML? Default is `true´.</p></td>
</tr>
<tr>
<td class="name"><code>extractStyles</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Should we extract styles from the
KML? Default is <code>false</code>.</p></td>
</tr>
<tr>
<td class="name"><code>maxDepth</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Maximum depth to follow network links.
Default is 0, which means we don't follow network links at all.</p></td>
</tr>
<tr>
<td class="name"><code>trackAttributes</code></td>
<td class="type">
<span class="param-type">Array.&lt;string></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Track attributes to
parse.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 83</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="ol.Attribution.html">ol.Attribution</a></li><li><a href="ol.Collection.html">ol.Collection</a></li><li><a href="ol.DeviceOrientation.html">ol.DeviceOrientation</a></li><li><a href="ol.Feature.html">ol.Feature</a></li><li><a href="ol.Geolocation.html">ol.Geolocation</a></li><li><a href="ol.Map.html">ol.Map</a></li><li><a href="ol.MapBrowserEvent.html">ol.MapBrowserEvent</a></li><li><a href="ol.Object.html">ol.Object</a></li><li><a href="ol.Overlay.html">ol.Overlay</a></li><li><a href="ol.Projection.html">ol.Projection</a></li><li><a href="ol.View2D.html">ol.View2D</a></li><li><a href="ol.control.Attribution.html">ol.control.Attribution</a></li><li><a href="ol.control.Control.html">ol.control.Control</a></li><li><a href="ol.control.FullScreen.html">ol.control.FullScreen</a></li><li><a href="ol.control.Logo.html">ol.control.Logo</a></li><li><a href="ol.control.MousePosition.html">ol.control.MousePosition</a></li><li><a href="ol.control.ScaleLine.html">ol.control.ScaleLine</a></li><li><a href="ol.control.Zoom.html">ol.control.Zoom</a></li><li><a href="ol.control.ZoomSlider.html">ol.control.ZoomSlider</a></li><li><a href="ol.control.ZoomToExtent.html">ol.control.ZoomToExtent</a></li><li><a href="ol.dom.Input.html">ol.dom.Input</a></li><li><a href="ol.geom.Geometry.html">ol.geom.Geometry</a></li><li><a href="ol.geom.LineString.html">ol.geom.LineString</a></li><li><a href="ol.geom.MultiLineString.html">ol.geom.MultiLineString</a></li><li><a href="ol.geom.MultiPoint.html">ol.geom.MultiPoint</a></li><li><a href="ol.geom.MultiPolygon.html">ol.geom.MultiPolygon</a></li><li><a href="ol.geom.Point.html">ol.geom.Point</a></li><li><a href="ol.geom.Polygon.html">ol.geom.Polygon</a></li><li><a href="ol.geom.SharedVertices.html">ol.geom.SharedVertices</a></li><li><a href="ol.geom2.LineStringCollection.html">ol.geom2.LineStringCollection</a></li><li><a href="ol.geom2.PointCollection.html">ol.geom2.PointCollection</a></li><li><a href="ol.interaction.DragRotateAndZoom.html">ol.interaction.DragRotateAndZoom</a></li><li><a href="ol.interaction.Modify.html">ol.interaction.Modify</a></li><li><a href="ol.interaction.Select.html">ol.interaction.Select</a></li><li><a href="ol.layer.Group.html">ol.layer.Group</a></li><li><a href="ol.layer.Image.html">ol.layer.Image</a></li><li><a href="ol.layer.Layer.html">ol.layer.Layer</a></li><li><a href="ol.layer.Tile.html">ol.layer.Tile</a></li><li><a href="ol.layer.Vector.html">ol.layer.Vector</a></li><li><a href="ol.layer.Vector2.html">ol.layer.Vector2</a></li><li><a href="ol.parser.GPX.html">ol.parser.GPX</a></li><li><a href="ol.parser.GeoJSON.html">ol.parser.GeoJSON</a></li><li><a href="ol.parser.KML.html">ol.parser.KML</a></li><li><a href="ol.parser.TopoJSON.html">ol.parser.TopoJSON</a></li><li><a href="ol.parser.WKT.html">ol.parser.WKT</a></li><li><a href="ol.parser.ogc.GML_v2.html">ol.parser.ogc.GML_v2</a></li><li><a href="ol.parser.ogc.GML_v3.html">ol.parser.ogc.GML_v3</a></li><li><a href="ol.parser.ogc.WMSCapabilities.html">ol.parser.ogc.WMSCapabilities</a></li><li><a href="ol.parser.ogc.WMTSCapabilities.html">ol.parser.ogc.WMTSCapabilities</a></li><li><a href="ol.source.BingMaps.html">ol.source.BingMaps</a></li><li><a href="ol.source.ImageStatic.html">ol.source.ImageStatic</a></li><li><a href="ol.source.ImageWMS.html">ol.source.ImageWMS</a></li><li><a href="ol.source.MapQuestOSM.html">ol.source.MapQuestOSM</a></li><li><a href="ol.source.MapQuestOpenAerial.html">ol.source.MapQuestOpenAerial</a></li><li><a href="ol.source.OSM.html">ol.source.OSM</a></li><li><a href="ol.source.Stamen.html">ol.source.Stamen</a></li><li><a href="ol.source.Tile.html">ol.source.Tile</a></li><li><a href="ol.source.TileDebug.html">ol.source.TileDebug</a></li><li><a href="ol.source.TileJSON.html">ol.source.TileJSON</a></li><li><a href="ol.source.TileWMS.html">ol.source.TileWMS</a></li><li><a href="ol.source.Vector.html">ol.source.Vector</a></li><li><a href="ol.source.Vector2.html">ol.source.Vector2</a></li><li><a href="ol.source.WMTS.html">ol.source.WMTS</a></li><li><a href="ol.source.XYZ.html">ol.source.XYZ</a></li><li><a href="ol.structs.Buffer.html">ol.structs.Buffer</a></li><li><a href="ol.style.Fill.html">ol.style.Fill</a></li><li><a href="ol.style.Icon.html">ol.style.Icon</a></li><li><a href="ol.style.Rule.html">ol.style.Rule</a></li><li><a href="ol.style.Shape.html">ol.style.Shape</a></li><li><a href="ol.style.Stroke.html">ol.style.Stroke</a></li><li><a href="ol.style.Style.html">ol.style.Style</a></li><li><a href="ol.style.Text.html">ol.style.Text</a></li><li><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></li><li><a href="ol.tilegrid.WMTS.html">ol.tilegrid.WMTS</a></li><li><a href="ol.tilegrid.XYZ.html">ol.tilegrid.XYZ</a></li></ul><h3>Namespaces</h3><ul><li><a href="ol.html">ol</a></li><li><a href="ol.animation.html">ol.animation</a></li><li><a href="ol.control.html">ol.control</a></li><li><a href="ol.expr.html">ol.expr</a></li><li><a href="ol.geom.html">ol.geom</a></li><li><a href="ol.layer.html">ol.layer</a></li><li><a href="ol.parser.html">ol.parser</a></li><li><a href="ol.proj.html">ol.proj</a></li><li><a href="ol.source.html">ol.source</a></li><li><a href="ol.style.html">ol.style</a></li><li><a href="ol.tilegrid.html">ol.tilegrid</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-ol3.html">OpenLayers 3 Architecture</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Meters per unit lookup table.">Meters per unit lookup table.</a></li><li><a href="global.html#grid">grid</a></li><li>{boolean}</li><li>{number}</li><li>{string}</li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a>
</footer>
<script> prettyPrint(); </script>
<script src="../resources/social-links.js" type="text/javascript"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink