GeocoderViewModel

new Cesium.GeocoderViewModel(options)
Widgets/Geocoder/GeocoderViewModel.js 58

The view model for the Geocoder widget.
Name Type Description
options Object Object with the following properties:
Name Type Default Description
scene Scene The Scene instance to use.
geocoderServices Array.<GeocoderService> optional 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.
url String 'https://dev.virtualearth.net' optional The base URL of the Bing Maps API.
key String optional The Bing Maps key for your application, which can be created at https://www.bingmapsportal.com. If this parameter is not provided, BingMapsApi.defaultKey is used. If BingMapsApi.defaultKey is undefined as well, a message is written to the console reminding you that you must create and supply a Bing Maps key as soon as possible. Please do not deploy an application that uses this widget without creating a separate key for your application.
flightDuration Number optional The duration of the camera flight to an entered location, in seconds.

Members

autoComplete : Booelan
Widgets/Geocoder/GeocoderViewModel.js 196

True if the geocoder should query as the user types to autocomplete
Default Value: true

complete : Event
Widgets/Geocoder/GeocoderViewModel.js 304

Gets the event triggered on flight completion.

flightDuration : Number|undefined
Widgets/Geocoder/GeocoderViewModel.js 252

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.
Default Value: undefined

isSearchInProgress : Boolean
Widgets/Geocoder/GeocoderViewModel.js 212

Gets a value indicating whether a search is currently in progress. This property is observable.

keepExpanded : Boolean
Widgets/Geocoder/GeocoderViewModel.js 189

Gets or sets a value indicating if this instance should always show its text input field.
Default Value: false

key : String
Widgets/Geocoder/GeocoderViewModel.js 291

Gets the Bing maps key.
Deprecated: true

scene : Scene
Widgets/Geocoder/GeocoderViewModel.js 316

Gets the scene to control.
Gets the Command that is executed when the button is clicked.

searchText : String
Widgets/Geocoder/GeocoderViewModel.js 225

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.

selectedSuggestion : Object
Widgets/Geocoder/GeocoderViewModel.js 340

Gets the currently selected geocoder search suggestion

suggestions : Array.<Object>
Widgets/Geocoder/GeocoderViewModel.js 352

Gets the list of geocoder search suggestions

url : String
Widgets/Geocoder/GeocoderViewModel.js 277

Gets the Bing maps url.
Deprecated: true

Methods

destroy()
Widgets/Geocoder/GeocoderViewModel.js 363

Destroys the widget. Should be called if permanently removing the widget from layout.