SardegnaMappe API - API Documentation - framework.form.GeocoderOpenLSComboBox

Class framework.form.GeocoderOpenLSComboBox

Extends Ext.form.ComboBox.
Creates a combo box that handles results from a geocoding service OpenLS.
Defined in: GeocoderOpenLSComboBox.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	framework.form.GeocoderOpenLSComboBox() Creates a combo box that handles results from a geocoding service.

Field Summary
Field Attributes	Field Name and Description
	displayField The field to display in the combo boy.
	emptyText Text to display for an empty field
	layer If provided, a marker will be drawn on this layer with the location returned by the geocoder.
	listWidth See http://www.dev.sencha.com/deploy/dev/docs/source/Combo.html#cfg-Ext.form.ComboBox-listWidth, default value is 350.
	loadingText See http://www.dev.sencha.com/deploy/dev/docs/source/Combo.html#cfg-Ext.form.ComboBox-loadingText, default value is "Search in Geozet.
	locationField The field to get the location from.
	minChars Minimum number of entered characters to trigger a search.
	queryDelay Delay before the search occurs.
	queryParam The query parameter for the user entered search text.
	srs The srs used by the geocoder service.
	url URL template for querying the geocoding service.
	valueField Field from selected record to use when the combo's :meth:`getValue` method is called.
	vectorStyle style point result
	width See http://www.dev.sencha.com/deploy/dev/docs/source/BoxComponent.html#cfg-Ext.BoxComponent-width, default value is 240.
	zoom The minimum zoom level to use when zooming to a location.
	zoomMunicipality The minimum zoom level to use when zooming to a municipality.

Class Detail

framework.form.GeocoderOpenLSComboBox()

Creates a combo box that handles results from a geocoding service. By default it uses Directory OpenLS service by Regione Autonoma della Sardegna (http://www.sardegnageoportale.it/index.php?xsl=1598&s=203310&v=2&c=9869&t=1), but it can be configured with a custom store to use other services standard OpenLS. If the user enters a valid address in the search box, the combo's store will be populated with records that match the address.

Field Detail

{String} displayField

The field to display in the combo boy. Default is "name" for instant use with the default store for this component.

{String} emptyText

Text to display for an empty field

{OpenLayers.Layer.Vector} layer

If provided, a marker will be drawn on this layer with the location returned by the geocoder. The location will be cleared when the map panned.

{Number} listWidth

See http://www.dev.sencha.com/deploy/dev/docs/source/Combo.html#cfg-Ext.form.ComboBox-listWidth, default value is 350.

{String} loadingText

See http://www.dev.sencha.com/deploy/dev/docs/source/Combo.html#cfg-Ext.form.ComboBox-loadingText, default value is "Search in Geozet...".

{String} locationField

The field to get the location from. This field is supposed to contain an array of [x, y] for a location. Default is "lonlat" for instant use with the default store for this component.

{Number} minChars

Minimum number of entered characters to trigger a search. Default is 4.

{number} queryDelay

Delay before the search occurs. Default is 200ms.

{String} queryParam

The query parameter for the user entered search text. Default is "q" for instant use with OSM Nominatim.

{String} srs

The srs used by the geocoder service. Default is "EPSG:3003".

{String} url

URL template for querying the geocoding service. If a :obj:`store` is configured, this will be ignored. Note that the :obj:`queryParam` will be used to append the user's combo box input to the url. Default is "http://nominatim.openstreetmap.org/search?format=json", for instant use with the OSM Nominatim geolocator. However, if you intend to use that, note the `Nominatim Usage Policy `_.

{String} valueField

Field from selected record to use when the combo's :meth:`getValue` method is called. Default is "bounds". This field is supposed to contain an array of [left, bottom, right, top] coordinates for a bounding box or [x, y] for a location.

{OpenLayers.Layer.Vector} vectorStyle

style point result

{Number} width

See http://www.dev.sencha.com/deploy/dev/docs/source/BoxComponent.html#cfg-Ext.BoxComponent-width, default value is 240.

{number} zoom

The minimum zoom level to use when zooming to a location. Not used when zooming to a bounding box. Default is 12.

{number} zoomMunicipality

The minimum zoom level to use when zooming to a municipality. Not used when zooming to a bounding box. Default is 8.