wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/GpxDataSource.html

1768 lines
69 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>GpxDataSource - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
GpxDataSource
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="GpxDataSource">
<a href="#GpxDataSource" class="doc-link"></a>
new Cesium.GpxDataSource<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L753">DataSources/GpxDataSource.js 753</a>
</div>
</h4>
</div>
<div class="description">
A <a href="DataSource.html"><code>DataSource</code></a> which processes the GPS Exchange Format (GPX).
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const viewer = new Cesium.Viewer('cesiumContainer');
viewer.dataSources.add(Cesium.GpxDataSource.load('../../SampleData/track.gpx'));</code></pre>
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="http://sandcastle.cesium.com/index.html?src=GPX.html">http://sandcastle.cesium.com/index.html?src=GPX.html</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="http://www.topografix.com/gpx.asp">Topografix GPX Standard</a></li>
<li><a href="http://www.topografix.com/gpx/1/1/">Topografix GPX Documentation</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="changedEvent">
<a href="#changedEvent" class="doc-link"></a>
changedEvent<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L863">DataSources/GpxDataSource.js 863</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that will be raised when the underlying data changes.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clock">
<a href="#clock" class="doc-link"></a>
clock<span class="type-signature"> : <a href="DataSourceClock.html">DataSourceClock</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L833">DataSources/GpxDataSource.js 833</a>
</div>
</h4>
</div>
<div class="description">
Gets the clock settings defined by the loaded GPX. This represents the total
availability interval for all time-dynamic data. If the GPX does not contain
time-dynamic data, this value is undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clustering">
<a href="#clustering" class="doc-link"></a>
clustering<span class="type-signature"> : <a href="EntityCluster.html">EntityCluster</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L908">DataSources/GpxDataSource.js 908</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the clustering options for this data source. This object can be shared between multiple data sources.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="creator">
<a href="#creator" class="doc-link"></a>
creator<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L811">DataSources/GpxDataSource.js 811</a>
</div>
</h4>
</div>
<div class="description">
Gets the creator of the GPX document.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="entities">
<a href="#entities" class="doc-link"></a>
entities<span class="type-signature"> : <a href="EntityCollection.html">EntityCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L843">DataSources/GpxDataSource.js 843</a>
</div>
</h4>
</div>
<div class="description">
Gets the collection of <a href="Entity.html"><code>Entity</code></a> instances.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="errorEvent">
<a href="#errorEvent" class="doc-link"></a>
errorEvent<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L873">DataSources/GpxDataSource.js 873</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that will be raised if an error is encountered during processing.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isLoading">
<a href="#isLoading" class="doc-link"></a>
isLoading<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L853">DataSources/GpxDataSource.js 853</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if the data source is currently loading data.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="loadingEvent">
<a href="#loadingEvent" class="doc-link"></a>
loadingEvent<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L883">DataSources/GpxDataSource.js 883</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that will be raised when the data source either starts or stops loading.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="metadata">
<a href="#metadata" class="doc-link"></a>
metadata<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L821">DataSources/GpxDataSource.js 821</a>
</div>
</h4>
</div>
<div class="description">
Gets an object containing metadata about the GPX file.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="name">
<a href="#name" class="doc-link"></a>
name<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L791">DataSources/GpxDataSource.js 791</a>
</div>
</h4>
</div>
<div class="description">
Gets a human-readable name for this instance.
This will be automatically be set to the GPX document name on load.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L893">DataSources/GpxDataSource.js 893</a>
</div>
</h4>
</div>
<div class="description">
Gets whether or not this data source should be displayed.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="version">
<a href="#version" class="doc-link"></a>
version<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L801">DataSources/GpxDataSource.js 801</a>
</div>
</h4>
</div>
<div class="description">
Gets the version of the GPX Schema in use.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".load">
<a href="#.load" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.GpxDataSource.load<span class="signature">(data, <span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;<a href="GpxDataSource.html">GpxDataSource</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L780">DataSources/GpxDataSource.js 780</a>
</div>
</h4>
</div>
<div class="description">
Creates a Promise to a new instance loaded with the provided GPX data.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Document</span>
|
<span class="param-type">Blob</span>
</td>
<td class="description last">
A url, parsed GPX document, or Blob containing binary GPX data.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
An object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>clampToGround</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">
<span class="optional">optional</span>
True if the symbols should be rendered at the same height as the terrain</td>
</tr>
<tr>
<td class="name"><code>waypointImage</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Image to use for waypoint billboards.</td>
</tr>
<tr>
<td class="name"><code>trackImage</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Image to use for track billboards.</td>
</tr>
<tr>
<td class="name"><code>trackColor</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Color to use for track lines.</td>
</tr>
<tr>
<td class="name"><code>routeColor</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Color to use for route lines.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise that will resolve to a new GpxDataSource instance once the gpx is loaded.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="load">
<a href="#load" class="doc-link"></a>
load<span class="signature">(data, <span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;<a href="GpxDataSource.html">GpxDataSource</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L948">DataSources/GpxDataSource.js 948</a>
</div>
</h4>
</div>
<div class="description">
Asynchronously loads the provided GPX data, replacing any existing data.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Document</span>
|
<span class="param-type">Blob</span>
</td>
<td class="description last">
A url, parsed GPX document, or Blob containing binary GPX data or a parsed GPX document.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
An object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>clampToGround</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">
<span class="optional">optional</span>
True if the symbols should be rendered at the same height as the terrain</td>
</tr>
<tr>
<td class="name"><code>waypointImage</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Image to use for waypoint billboards.</td>
</tr>
<tr>
<td class="name"><code>trackImage</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Image to use for track billboards.</td>
</tr>
<tr>
<td class="name"><code>trackColor</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Color to use for track lines.</td>
</tr>
<tr>
<td class="name"><code>routeColor</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Color to use for route lines.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise that will resolve to this instances once the GPX is loaded.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="update">
<a href="#update" class="doc-link"></a>
update<span class="signature">(time)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GpxDataSource.js#L932">DataSources/GpxDataSource.js 932</a>
</div>
</h4>
</div>
<div class="description">
Updates the data source to the provided time. This function is optional and
is not required to be implemented. It is provided for data sources which
retrieve data based on the current animation time or scene state.
If implemented, update will be called by <a href="DataSourceDisplay.html"><code>DataSourceDisplay</code></a> once a frame.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The simulation time.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
True if this data source is ready to be displayed at the provided time, false otherwise.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>