new Cesium.GeocoderViewModel(options)

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.
flightDuration number optional The duration of the camera flight to an entered location, in seconds.
destinationFound Geocoder.DestinationFoundFunction GeocoderViewModel.flyToDestination optional 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.


A function to fly to the destination found by a successful geocode.
True if the geocoder should query as the user types to autocomplete
Default Value: true
Gets the event triggered on flight completion.
Gets and sets the command called when a geocode destination is found
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
Gets a value indicating whether a search is currently in progress. This property is observable.
Gets or sets a value indicating if this instance should always show its text input field.
Default Value: false
Gets the scene to control.
Gets the Command that is executed when the button is clicked.
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.
Gets the currently selected geocoder search suggestion
Gets the list of geocoder search suggestions


Destroys the widget. Should be called if permanently removing the widget from layout.
Destroys the widget. Should be called if permanently removing the widget from layout.
true if the object has been destroyed, false otherwise.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.