Class: GeocoderViewModel

GeocoderViewModel

new GeocoderViewModel(options)

The view model for the Geocoder widget.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
scene Scene The Scene instance to use.
url String <optional>
 'https://dev.virtualearth.net' 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.
Source:

Members

complete :Event

Gets the event triggered on flight completion.
Type:
Source:

flightDuration :Number|undefined

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.
Type:
  • Number | undefined
Default Value:
  • undefined
Source:

isSearchInProgress :Boolean

Gets a value indicating whether a search is currently in progress. This property is observable.
Type:
  • Boolean
Source:

keepExpanded :Boolean

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

key :String

Gets the Bing maps key.
Type:
  • String
Source:

scene :Scene

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

searchText :String

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.
Type:
  • String
Source:

url :String

Gets the Bing maps url.
Type:
  • String
Source: