mirror of
https://github.com/noncomputable/AgentMaps.git
synced 2026-01-18 16:27:05 +00:00
90 lines
4.2 KiB
HTML
90 lines
4.2 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: jsdocs.js</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">Source: jsdocs.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/* Extra documentation that isn't particular to any module */
|
|
|
|
/**
|
|
* Represents a latitude/longitude pair. Preferably an instance of L.LatLng:
|
|
* {@link https://leafletjs.com/reference-1.3.2.html#latlng}.
|
|
*
|
|
* @typedef {object} LatLng
|
|
* @property {number} lat - A decimal latitude.
|
|
* @property {number} lng - A decimal longitude.
|
|
* @property {Place} [new_place] - A place (unit or street) associated with this LatLng.
|
|
*/
|
|
|
|
/**
|
|
* A GeoJSON feature object.
|
|
*
|
|
* @typedef {object} Feature
|
|
* @property {string} type - Should be "Feature".
|
|
* @property {object} properties - Non-geometric properties of the feature.
|
|
* @property {object} geometry - Geometric properties of the feature (a GeoJSON spec of the feature's geometry).
|
|
* @property {string} geometry.type - The feature's GeoJSON geometry type.
|
|
* @property {Array} geometry.coordinates - The coordinates specifying the feature's geometry.
|
|
* @see {@link http://geojson.org/}
|
|
*/
|
|
|
|
/**
|
|
* A GeoJSON {@link Feature} specifically for individual points.
|
|
*
|
|
* @typedef {Feature} Point
|
|
* @property {Array} geometry.coordinates - A single array with 2 elements: [longitude, latitude].
|
|
*/
|
|
|
|
/**
|
|
* A object describing a location.
|
|
*
|
|
* @typedef {object} Place
|
|
* @property {string} type - Either "street", "unit", or "unanchored".
|
|
* @property {number} id - The ID of either a street or unit in the appropriate layer group, if the place is "street" or "unit".
|
|
*/
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Agent.html">Agent</a></li><li><a href="Agentmap.html">Agentmap</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-extra.html">extra</a></li><li><a href="tutorial-quickstart.html">quickstart</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addStreetLayerIntersections">addStreetLayerIntersections</a></li><li><a href="global.html#agent">agent</a></li><li><a href="global.html#agentmap">agentmap</a></li><li><a href="global.html#checkEndExcess">checkEndExcess</a></li><li><a href="global.html#checkStartExcess">checkStartExcess</a></li><li><a href="global.html#decodeCoordString">decodeCoordString</a></li><li><a href="global.html#encodeLatLng">encodeLatLng</a></li><li><a href="global.html#generateUnitFeatures">generateUnitFeatures</a></li><li><a href="global.html#getIntersections">getIntersections</a></li><li><a href="global.html#getPathFinder">getPathFinder</a></li><li><a href="global.html#getStreetFeatures">getStreetFeatures</a></li><li><a href="global.html#getUnitAnchors">getUnitAnchors</a></li><li><a href="global.html#getUnitFeatures">getUnitFeatures</a></li><li><a href="global.html#getUnitNeighborLayerIDs">getUnitNeighborLayerIDs</a></li><li><a href="global.html#isPointCoordinates">isPointCoordinates</a></li><li><a href="global.html#noOverlaps">noOverlaps</a></li><li><a href="global.html#pointToCoordinateArray">pointToCoordinateArray</a></li><li><a href="global.html#reversedCoordinates">reversedCoordinates</a></li><li><a href="global.html#setupStreetFeatures">setupStreetFeatures</a></li><li><a href="global.html#setupUnitFeatures">setupUnitFeatures</a></li><li><a href="global.html#streetsToGraph">streetsToGraph</a></li><li><a href="global.html#streetToGraph">streetToGraph</a></li><li><a href="global.html#unitsOutOfStreets">unitsOutOfStreets</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 04 2018 11:46:39 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|