IT-Naturschutz/netgis-client
1
0
Fork 0
mirror of https://github.com/sebastianpauli/netgis-client.git synced 2025-06-10 12:24:13 +02:00
Code Issues Projects Releases Wiki Activity
53ccc83e65
netgis-client/docs/global.html
sebastianpauli 53ccc83e65 Update: initial html documenation
2025-04-29 13:49:50 +02:00

1603 lines
23 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="Commands"><span class="type-signature">(readonly) </span>Commands<span class="type-signature"></span></h4>
<div class="description">
Default IDs for Built-in Commands
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>LAYERTREE</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SEARCHPLACE</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SEARCHPARCEL</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TOOLBOX</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>LEGEND</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VIEW_PREV</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VIEW_NEXT</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VIEW</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ZOOM_BOX</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>ZOOM_SCALE</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MEASURE_LINE</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MEASURE_AREA</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MEASURE_CLEAR</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DRAW_POINTS</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DRAW_LINES</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DRAW_POLYGONS</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>MODIFY_FEATURES</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DELETE_FEATURES</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>BUFFER_FEATURES</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>CUT_FEATURES</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>SNAP_TOGGLE</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>IMPORT_LAYER</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>EXPORT</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>GEOLOCATION</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="LayerID"><span class="type-signature">(readonly) </span>LayerID<span class="type-signature"></span></h4>
<div class="description">
Default IDs for Built-in Layers
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>EDITABLE</code></td>
<td class="type">
</td>
<td class="description last">"editable-layer"</td>
</tr>
<tr>
<td class="name"><code>NON_EDITABLE</code></td>
<td class="type">
</td>
<td class="description last">"non-editable-layer"</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="LayerTypes"><span class="type-signature">(readonly) </span>LayerTypes<span class="type-signature"></span></h4>
<div class="description">
Supported Layer Types
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>TMS</code></td>
<td class="type">
</td>
<td class="description last">Tile Map Service<br/>
Parameters:
<ul>
<li><code>"url": {String} URL containing {x}/{y}/{z} placeholders</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>XYZ</code></td>
<td class="type">
</td>
<td class="description last">Raster Tiles, see <a href="global.html#LayerTypes#.TMS">TMS</a></td>
</tr>
<tr>
<td class="name"><code>OSM</code></td>
<td class="type">
</td>
<td class="description last">OpenStreetMap Tiles, see <a href="global.html#LayerTypes#.TMS">TMS</a></td>
</tr>
<tr>
<td class="name"><code>WMTS</code></td>
<td class="type">
</td>
<td class="description last">Web Map Tile Service<br/>
Parameters:
<ul>
<li><code>"url": {String} Service host URL</code></li>
<li><code>"name": {String} Service layer name</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>WMS</code></td>
<td class="type">
</td>
<td class="description last">Web Map Service<br/>
Parameters:
<ul>
<li><code>"url": {String} Service host URL</code></li>
<li><code>"name": {String} Service layer name</code></li>
<li><code>"format": {String} Image MIME type</code></li>
<li><code>"tiled": {Boolean} Request tiled or full image</code></li>
<li><code>"username": {String} For basic auth if necessary</code></li>
<li><code>"password": {String} For basic auth if necessary</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>WMST</code></td>
<td class="type">
</td>
<td class="description last">Web Map Service Temporal<br/>
Parameters:
<ul>
<li><code>"url": {String} Service host URL</code></li>
<li><code>"name": {String} Service layer name</code></li>
<li><code>"format": {String} Image MIME type</code></li>
<li><code>"tiled": {Boolean} Request tiled or full image</code></li>
<li><code>"username": {String} For basic auth if necessary</code></li>
<li><code>"password": {String} For basic auth if necessary</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>GEOJSON</code></td>
<td class="type">
</td>
<td class="description last">GeoJSON<br/>
Parameters:
<ul>
<li><code>"data": {JSON} GeoJSON feature or collection</code></li>
<li><code>"url": {String} Request from URL if no data given</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>VTILES</code></td>
<td class="type">
</td>
<td class="description last">Vector Tiles<br/>
Parameters:
<ul>
<li><code>"url": {String} Service host URL</code></li>
<li><code>"extent": {Array} Data extent if not set by server</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>WFS</code></td>
<td class="type">
</td>
<td class="description last">Web Feature Service<br/>
Parameters:
<ul>
<li><code>"url": {String} Service host URL</code></li>
<li><code>"name": {String} Service layer type name</code></li>
<li><code>"format": {String} Response MIME type</code></li>
<li><code>"username": {String} For basic auth if necessary</code></li>
<li><code>"password": {String} For basic auth if necessary</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>GML</code></td>
<td class="type">
</td>
<td class="description last">Geography Markup Language<br/>
Parameters:
<ul>
<li><code>"data": {String} GML document</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>KML</code></td>
<td class="type">
</td>
<td class="description last">Keyhole Markup Language<br/>
Parameters:
<ul>
<li><code>"url": {String} KML document URL</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>GEOPACKAGE</code></td>
<td class="type">
</td>
<td class="description last">GeoPackage<br/>
Parameters:
<ul>
<li><code>"data": {Array} GeoPackage file content</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>SPATIALITE</code></td>
<td class="type">
</td>
<td class="description last">Spatialite<br/>
Parameters:
<ul>
<li><code>"data": {Array} Spatialite file content</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>SHAPEFILE</code></td>
<td class="type">
</td>
<td class="description last">Shapefile<br/>
Parameters:
<ul>
<li><code>"data": {Array} Shapefile file content</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>WKT</code></td>
<td class="type">
</td>
<td class="description last">Well Known Text<br/>
Parameters:
<ul>
<li><code>"data": {String} WKT content</code></li>
</ul></td>
</tr>
<tr>
<td class="name"><code>HIDDEN</code></td>
<td class="type">
</td>
<td class="description last">Hidden Layer (not visible in <a href="netgis.LayerTree.html">Layer Tree</a>, but may be used for feature queries etc.)</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="Modules"><span class="type-signature">(readonly) </span>Modules<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>menu</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Menu.html">Menu Bar</a></td>
</tr>
<tr>
<td class="name"><code>layertree</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.LayerTree.html">Layer Tree Panel</a></td>
</tr>
<tr>
<td class="name"><code>map</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Map.html">Map View</a></td>
</tr>
<tr>
<td class="name"><code>controls</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Controls.html">Map Controls</a></td>
</tr>
<tr>
<td class="name"><code>attribution</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Attribution.html">Map Layer Attribution</a></td>
</tr>
<tr>
<td class="name"><code>legend</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Legend.html">Legend Panel</a></td>
</tr>
<tr>
<td class="name"><code>geolocation</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Geolocation.html">Geolocation Controls</a></td>
</tr>
<tr>
<td class="name"><code>info</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Info.html">Feature Info Popup</a></td>
</tr>
<tr>
<td class="name"><code>searchplace</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.SearchPlace.html">Search Place Panel</a></td>
</tr>
<tr>
<td class="name"><code>searchparcel</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.SearchParcel.html">Search Parcel Panel</a></td>
</tr>
<tr>
<td class="name"><code>toolbox</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Toolbox.html">Toolbox Panel</a></td>
</tr>
<tr>
<td class="name"><code>import</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Import.html">Import Layer Modal</a></td>
</tr>
<tr>
<td class="name"><code>export</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.Export.html">Export Map Modal</a></td>
</tr>
<tr>
<td class="name"><code>timeslider</code></td>
<td class="type">
</td>
<td class="description last"><a href="netgis.TimeSlider.html">Time Slider Panel</a></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="util"><span class="type-signature"></span>util<span class="type-signature"></span></h4>
<div class="description">
General Purpose Pure Static Utility Functions
</div>
<dl class="details">
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="netgis.html">netgis</a></li></ul><h3>Classes</h3><ul><li><a href="netgis.Attribution.html">Attribution</a></li><li><a href="netgis.Client.html">Client</a></li><li><a href="netgis.Controls.html">Controls</a></li><li><a href="netgis.Export.html">Export</a></li><li><a href="netgis.Geolocation.html">Geolocation</a></li><li><a href="netgis.Import.html">Import</a></li><li><a href="netgis.Info.html">Info</a></li><li><a href="netgis.LayerTree.html">LayerTree</a></li><li><a href="netgis.Legend.html">Legend</a></li><li><a href="netgis.Map.html">Map</a></li><li><a href="netgis.Menu.html">Menu</a></li><li><a href="netgis.OWS.html">OWS</a></li><li><a href="netgis.SearchParcel.html">SearchParcel</a></li><li><a href="netgis.SearchPlace.html">SearchPlace</a></li><li><a href="netgis.TimeSlider.html">TimeSlider</a></li><li><a href="netgis.Toolbox.html">Toolbox</a></li><li><a href="netgis.WMC.html">WMC</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Commands">Commands</a></li><li><a href="global.html#LayerID">LayerID</a></li><li><a href="global.html#LayerTypes">LayerTypes</a></li><li><a href="global.html#Modules">Modules</a></li><li><a href="global.html#util">util</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Tue Apr 29 2025 13:39:56 GMT+0200 (Mitteleuropäische Sommerzeit)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink