qiusj
/
learning_cesium
0
0
Fork 0
Code Issues Issues Pull Requests Releases Wiki Wiki Activity
learning_cesium/Build168/Documentation/GeocoderViewModel.html

1214 lines
57 KiB
HTML
Raw Permalink Normal View History

init project
2024-03-19 18:06:25 +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>GeocoderViewModel - 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>
GeocoderViewModel
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="GeocoderViewModel">
<a href="#GeocoderViewModel" class="doc-link"></a>
new Cesium.GeocoderViewModel<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L34">Widgets/Geocoder/GeocoderViewModel.js 34</a>
</div>
</h4>
</div>
<div class="description">
The view model for the <a href="Geocoder.html"><code>Geocoder</code></a> widget.
</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The Scene instance to use.</td>
</tr>
<tr>
<td class="name"><code>geocoderServices</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="GeocoderService.html">GeocoderService</a>></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Geocoder services to use for geocoding queries.
If more than one are supplied, suggestions will be gathered for the geocoders that support it,
and if no suggestion is selected the result from the first geocoder service wil be used.</td>
</tr>
<tr>
<td class="name"><code>flightDuration</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The duration of the camera flight to an entered location, in seconds.</td>
</tr>
<tr>
<td class="name"><code>destinationFound</code></td>
<td class="type">
<span class="param-type"><a href="Geocoder.html#~DestinationFoundFunction">Geocoder~DestinationFoundFunction</a></span>
</td>
<td class="default">
<code class="language-javascript">GeocoderViewModel.flyToDestination</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A callback function that is called after a successful geocode. If not supplied, the default behavior is to fly the camera to the result destination.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".flyToDestination">
<a href="#.flyToDestination" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeocoderViewModel.flyToDestination<span class="type-signature"> : <a href="Geocoder.html#~DestinationFoundFunction">Geocoder~DestinationFoundFunction</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L512">Widgets/Geocoder/GeocoderViewModel.js 512</a>
</div>
</h4>
</div>
<div class="description">
A function to fly to the destination found by a successful geocode.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="autoComplete">
<a href="#autoComplete" class="doc-link"></a>
autoComplete<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L152">Widgets/Geocoder/GeocoderViewModel.js 152</a>
</div>
</h4>
</div>
<div class="description">
True if the geocoder should query as the user types to autocomplete
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="complete">
<a href="#complete" class="doc-link"></a>
complete<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.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L238">Widgets/Geocoder/GeocoderViewModel.js 238</a>
</div>
</h4>
</div>
<div class="description">
Gets the event triggered on flight completion.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="destinationFound">
<a href="#destinationFound" class="doc-link"></a>
destinationFound<span class="type-signature"> : <a href="Geocoder.html#~DestinationFoundFunction">Geocoder~DestinationFoundFunction</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L158">Widgets/Geocoder/GeocoderViewModel.js 158</a>
</div>
</h4>
</div>
<div class="description">
Gets and sets the command called when a geocode destination is found
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="flightDuration">
<a href="#flightDuration" class="doc-link"></a>
flightDuration<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L214">Widgets/Geocoder/GeocoderViewModel.js 214</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the the duration of the camera flight in seconds.
A value of zero causes the camera to instantly switch to the geocoding location.
The duration will be computed based on the distance when undefined.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="isSearchInProgress">
<a href="#isSearchInProgress" class="doc-link"></a>
isSearchInProgress<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L174">Widgets/Geocoder/GeocoderViewModel.js 174</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating whether a search is currently in progress. This property is observable.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="keepExpanded">
<a href="#keepExpanded" class="doc-link"></a>
keepExpanded<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L145">Widgets/Geocoder/GeocoderViewModel.js 145</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets a value indicating if this instance should always show its text input field.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="scene">
<a href="#scene" class="doc-link"></a>
scene<span class="type-signature"> : <a href="Scene.html">Scene</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L250">Widgets/Geocoder/GeocoderViewModel.js 250</a>
</div>
</h4>
</div>
<div class="description">
Gets the scene to control.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="search">
<a href="#search" class="doc-link"></a>
search<span class="type-signature"> : <a href="Command.html">Command</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L262">Widgets/Geocoder/GeocoderViewModel.js 262</a>
</div>
</h4>
</div>
<div class="description">
Gets the Command that is executed when the button is clicked.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="searchText">
<a href="#searchText" class="doc-link"></a>
searchText<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L187">Widgets/Geocoder/GeocoderViewModel.js 187</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the text to search for. The text can be an address, or longitude, latitude,
and optional height, where longitude and latitude are in degrees and height is in meters.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="selectedSuggestion">
<a href="#selectedSuggestion" class="doc-link"></a>
selectedSuggestion<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L274">Widgets/Geocoder/GeocoderViewModel.js 274</a>
</div>
</h4>
</div>
<div class="description">
Gets the currently selected geocoder search suggestion
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="suggestions">
<a href="#suggestions" class="doc-link"></a>
suggestions<span class="type-signature"> : Array.&lt;Object></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L286">Widgets/Geocoder/GeocoderViewModel.js 286</a>
</div>
</h4>
</div>
<div class="description">
Gets the list of geocoder search suggestions
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Widgets/Geocoder/GeocoderViewModel.js#L297">Widgets/Geocoder/GeocoderViewModel.js 297</a>
</div>
</h4>
</div>
<div class="description">
Destroys the widget. Should be called if permanently
removing the widget from layout.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</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="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</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="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-
</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>