org.cesiumjs.cs.widgets

Class GeocoderViewModel

java.lang.Object

org.cesiumjs.cs.widgets.GeocoderViewModel

@JsType(isNative=true,
        namespace="Cesium",
        name="GeocoderViewModel")
public class GeocoderViewModel
extends Object

The view model for the Geocoder widget.

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeocoderViewModel.DestinationFoundFunction A function that handles the result of a successful geocode.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	autoComplete True if the geocoder should query as the user types to autocomplete Default: true
Event	complete Gets the event triggered on flight completion.
double	flightDuration Gets or sets the the duration of the camera flight in seconds.
boolean	isSearchInProgress Gets a value indicating whether a search is currently in progress.
boolean	keepExpanded Gets or sets a value indicating if this instance should always show its text input field.
Scene	scene Gets the scene to control.
Command	search Gets the Command that is executed when the button is clicked.
String	searchText Gets or sets the text to search for.
Object	selectedSuggestion Gets the currently selected geocoder search suggestion
Object[]	suggestions Gets the list of geocoder search suggestions

Constructor Summary

Constructors

Constructor and Description
GeocoderViewModel(GeocoderViewModelOptions options)

Method Summary

Modifier and Type	Method and Description
static GeocoderViewModel	create(Scene scene) Fast create instance of GeocoderViewModel by mandatory params
void	destroy() Destroys the widget.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

autoComplete

@JsProperty
public boolean autoComplete

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

complete

@JsProperty
public Event complete

Gets the event triggered on flight completion.

flightDuration

@JsProperty
public double flightDuration

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: undefined

isSearchInProgress

@JsProperty
public boolean isSearchInProgress

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

keepExpanded

@JsProperty
public boolean keepExpanded

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

scene

@JsProperty
public Scene scene

Gets the scene to control.

search

@JsProperty
public Command search

Gets the Command that is executed when the button is clicked.

searchText

@JsProperty
public String searchText

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

@JsProperty
public Object selectedSuggestion

Gets the currently selected geocoder search suggestion

suggestions

@JsProperty
public Object[] suggestions

Gets the list of geocoder search suggestions

Constructor Detail

GeocoderViewModel

@JsConstructor
public GeocoderViewModel(GeocoderViewModelOptions options)

Method Detail

create

@JsOverlay
public static GeocoderViewModel create(Scene scene)

Fast create instance of GeocoderViewModel by mandatory params

Parameters:

scene - The Scene instance to use.

Returns:

GeocoderViewModel instance

destroy

@JsMethod
public void destroy()

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