rn_supermap
Version:
rn_supermap 一款基于React-Native框架的移动应用开发工具。基于该开发工具，用户可以使用JavaScript开发语言，开发出在Android和IOS操作系统下运行的原生移动GIS应用，入门门槛低，一次开发，处处运行。
2,326 lines • 25.8 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: TraditionalNavi</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">Class: TraditionalNavi</h1>
<section>
<header>
<h2>TraditionalNavi</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="TraditionalNavi"><span class="type-signature"></span>new TraditionalNavi<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
导航类，导航类提供路径分析和引导功能。(该类对象只能通过mapControl类下方法获取)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".addWayPoint"><span class="type-signature">(static) </span>addWayPoint<span class="signature">(x, y)</span><span class="type-signature"> → {Promise.<Promise.boolean>}</span></h4>
<div class="description">
添加途经点
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">途经点x坐标</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">途经点y坐标</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line103">line 103</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Promise.boolean></span>
</dd>
</dl>
<h4 class="name" id=".cleanPath"><span class="type-signature">(static) </span>cleanPath<span class="signature">()</span><span class="type-signature"> → {Promise.<void>}</span></h4>
<div class="description">
清除路径分析的结果
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line234">line 234</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h4 class="name" id=".connectNaviData"><span class="type-signature">(static) </span>connectNaviData<span class="signature">(dataPath)</span><span class="type-signature"> → {Promise.<Promise.boolean>}</span></h4>
<div class="description">
链接导航路网数据
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataPath</code></td>
<td class="type">
</td>
<td class="description last">数据存储路径</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Promise.boolean></span>
</dd>
</dl>
<h4 class="name" id=".enablePanOnGuide"><span class="type-signature">(static) </span>enablePanOnGuide<span class="signature">(bPan)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
<div class="description">
引导过程中是否允许平移地图。
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>bPan</code></td>
<td class="type">
</td>
<td class="description last">一个布尔值，用来指示在导航过程中是否允许平移地图，true,表示允许，false,表示不允许。</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line221">line 221</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h4 class="name" id=".getNaviPath"><span class="type-signature">(static) </span>getNaviPath<span class="signature">()</span><span class="type-signature"> → {Promise.<Promise.array>}</span></h4>
<div class="description">
获取导航路径的详情
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line247">line 247</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- 返回一个导航路径上所有路径的NaviStep对象数组，每个pathInfo对象的结构为{point:{x:--,y:--},length:--,name:--,time:--,turnType:--}
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Promise.array></span>
</dd>
</dl>
<h4 class="name" id=".getRoute"><span class="type-signature">(static) </span>getRoute<span class="signature">()</span><span class="type-signature"> → {Promise.<object>}</span></h4>
<div class="description">
获得路径分析线路。
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line203">line 203</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<object></span>
</dd>
</dl>
<h4 class="name" id=".getTimeToDestination"><span class="type-signature">(static) </span>getTimeToDestination<span class="signature">(speed)</span><span class="type-signature"> → {Promise.<number>}</span></h4>
<div class="description">
获取导航剩余时间
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>speed</code></td>
<td class="type">
</td>
<td class="description last">当前行驶速度</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line188">line 188</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<number></span>
</dd>
</dl>
<h4 class="name" id=".isGuiding"><span class="type-signature">(static) </span>isGuiding<span class="signature">()</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
<div class="description">
当前是否在引导过程中。
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line173">line 173</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<boolean></span>
</dd>
</dl>
<h4 class="name" id=".locateMap"><span class="type-signature">(static) </span>locateMap<span class="signature">()</span><span class="type-signature"> → {Promise.<void>}</span></h4>
<div class="description">
导航中，将小车位置作为地图中心。 当允许导航中平移地图时，移动地图后，可以通过该接口使小车一直在地图中心显示。
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line160">line 160</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h4 class="name" id=".routeAnalyst"><span class="type-signature">(static) </span>routeAnalyst<span class="signature">(mode)</span><span class="type-signature"> → {Promise.<number>}</span></h4>
<div class="description">
执行路径分析。
路径分析模式的值为[0，1，2，3]，其分别表示推荐模式、时间最快模式、距离最短模式、和最少收费模式。
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
</td>
<td class="description last">路径分析模式。</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
路径分析成功返回1，路径分析失败返回0，起点周围无道路返回-1，终点周围无道路返回-2。
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<number></span>
</dd>
</dl>
<h4 class="name" id=".setDestinationPoint"><span class="type-signature">(static) </span>setDestinationPoint<span class="signature">(x, y, map)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
<div class="description">
设置路径规划的终点。
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
</td>
<td class="description last">终点经度坐标（度）。</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
</td>
<td class="description last">终点纬度坐标(度)。</td>
</tr>
<tr>
<td class="name"><code>map</code></td>
<td class="type">
</td>
<td class="description last">导航所属地图对象</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line72">line 72</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h4 class="name" id=".setGPSData"><span class="type-signature">(static) </span>setGPSData<span class="signature">(gpsData)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
<div class="description">
设置GPS数据
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>gpsData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">gps数据</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line147">line 147</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h4 class="name" id=".setSpeechParam"><span class="type-signature">(static) </span>setSpeechParam<span class="signature">(speech)</span><span class="type-signature"> → {Promise.<Promise.speak>}</span></h4>
<div class="description">
设置导航指引信息控制,用于控制导航中是否播报引导信息
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>speech</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line132">line 132</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Promise.speak></span>
</dd>
</dl>
<h4 class="name" id=".setStartPoint"><span class="type-signature">(static) </span>setStartPoint<span class="signature">(x, y, map)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
<div class="description">
设置路径规划的起点。
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
</td>
<td class="description last">起点经度坐标（度）。</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
</td>
<td class="description last">起点纬度坐标(度)。</td>
</tr>
<tr>
<td class="name"><code>map</code></td>
<td class="type">
</td>
<td class="description last">导航所属地图对象</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h4 class="name" id=".startGuide"><span class="type-signature">(static) </span>startGuide<span class="signature">(status)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
<div class="description">
开始导航。
引导状态的值为[0，1，2]，其分别表示执行真实导航、执行模拟导航、执行定位点巡航。
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>status</code></td>
<td class="type">
</td>
<td class="description last">引导状态。</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h4 class="name" id=".stopGuide"><span class="type-signature">(static) </span>stopGuide<span class="signature">()</span><span class="type-signature"> → {Promise.<Promise.boolean>}</span></h4>
<div class="description">
停止引导。
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TraditionalNavi.js.html">TraditionalNavi.js</a>, <a href="TraditionalNavi.js.html#line117">line 117</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Promise.boolean></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BufferAnalyst.html">BufferAnalyst</a></li><li><a href="BufferAnalystParameter.html">BufferAnalystParameter</a></li><li><a href="DataDownloadService.html">DataDownloadService</a></li><li><a href="Dataset.html">Dataset</a></li><li><a href="DatasetVector.html">DatasetVector</a></li><li><a href="DatasetVectorInfo.html">DatasetVectorInfo</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="DatasourceConnectionInfo.html">DatasourceConnectionInfo</a></li><li><a href="DataUploadService.html">DataUploadService</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FeatureSet.html">FeatureSet</a></li><li><a href="GeoLine.html">GeoLine</a></li><li><a href="Geometry.html">Geometry</a></li><li><a href="GeoPoint.html">GeoPoint</a></li><li><a href="GeoRegion.html">GeoRegion</a></li><li><a href="GeoStyle.html">GeoStyle</a></li><li><a href="Layer.html">Layer</a></li><li><a href="LayerSetting.html">LayerSetting</a></li><li><a href="LayerSettingVector.html">LayerSettingVector</a></li><li><a href="LocationManager.html">LocationManager</a></li><li><a href="Map.html">Map</a></li><li><a href="MapControl.html">MapControl</a></li><li><a href="MapView.html">MapView</a></li><li><a href="Navigation2.html">Navigation2</a></li><li><a href="OverlayAnalyst.html">OverlayAnalyst</a></li><li><a href="OverlayAnalystParameter.html">OverlayAnalystParameter</a></li><li><a href="Point.html">Point</a></li><li><a href="Point2D.html">Point2D</a></li><li><a href="QueryParameter.html">QueryParameter</a></li><li><a href="QueryService.html">QueryService</a></li><li><a href="Rectangle2D.html">Rectangle2D</a></li><li><a href="Scene.html">Scene</a></li><li><a href="Selection.html">Selection</a></li><li><a href="ServiceBase.html">ServiceBase</a></li><li><a href="ServiceQueryParameter.html">ServiceQueryParameter</a></li><li><a href="Size2D.html">Size2D</a></li><li><a href="Theme.html">Theme</a></li><li><a href="Track.html">Track</a></li><li><a href="TrackingLayer.html">TrackingLayer</a></li><li><a href="TraditionalNavi.html">TraditionalNavi</a></li><li><a href="Workspace.html">Workspace</a></li><li><a href="WorkspaceConnectionInfo.html">WorkspaceConnectionInfo</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Aug 01 2017 16:16:50 GMT+0800 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>