Module: webgis4u/ol/control/Search

Classes

Search

Members

(inner, constant) HTML_NAME_SEARCH_FIELD

The default name used for the search field
Source:

Methods

(inner) defaultOnError()

Source:

(inner) defaultOnHover()

Source:

(inner) defaultOnSelect()

Source:

(inner) defaultOnShow()

Source:

(inner) toFeature(featureData, projection, geoJsonFormat) → {ol.Feature}

Convert the acquired feature data
Parameters:
Name Type Description
featureData any The feature to read
projection ol.ProjectionLike Projection of the feature geometries created by the format reader.
geoJsonFormat ol.format.GeoJSON
Source:
Returns:
Type
ol.Feature

(inner) valueOrDefault()

Return value or default value
Source:

Type Definitions

OnErrorCallback(request, status, error, layer, map)

Is called when an error occurs. Can be overriden by your own business logic.
Parameters:
Name Type Description
request type The request.
status type The status.
error type The error.
layer ol.Layer The layer.
map ol.Map The map.
Source:

OnHoverCallback(suggestion, layer, map, geoJsonFormat)

Is called when the user hovers over a search result in the ajax serach field.
Parameters:
Name Type Description
suggestion string The suggestion.
layer ol.layer.Vector The layer on which the search results will be drawn.
map ol.Map The map.
geoJsonFormat ol.format.GeoJSON The GeoJsonFormat parser.
Source:

OnSelectCallback(suggestion, layer, map, geoJsonFormat)

Is called when a search result is selected.
Parameters:
Name Type Description
suggestion string The sugestion.
layer ol.layer.Vector The layer on which the search results will be drawn.
map ol.Map The map.
geoJsonFormat ol.format.GeoJSON The GeoJsonFormat parser.
Source:

OnShowCallback(suggestions, layer, map, geoJsonFormat)

Is called when the search results are returned. Can be overridden by your specific code.
Parameters:
Name Type Description
suggestions Object.<string, ol.vector.Feature> The suggestions as key value pair (html, feature).
layer ol.layer.Vector The layer on which the search results will be drawn.
map ol.Map The map.
geoJsonFormat ol.format.GeoJSON The GeoJsonFormat parser.
Source: