gem.control. SearchControl

new SearchControl(searchOptionsopt)

Control for displaying free text search on map

Parameters:
NameTypeAttributesDescription
searchOptionsobject<optional>
Properties
NameTypeDescription
highlightOptionsobject

customize search result highlight on map options

Properties
NameTypeDescription
showContourbool

default true, show search result contour if available

contourColorobject

search result highlight contour color, default {r: 255, g: 0, b: 0, a: 255}

overlapbool

default true, overlap highlight over existing map data

noFadingbool

default false, disable highlight fading in / out

groupbool

default false, group landmarks

searchResultPinbool

default true - use search result pin icon, if false - highlight result landmark icon

searchPreferencesobject

customize search preferences

Properties
NameTypeDescription
exactMatchbool

default true

maximumMatchesnumber

no. of search results to display, default 5, maximum 5

addressSearchbool

default false

mapPoisSearchbool

default false

mapEnvelopeobject

default entire map, map area in which to restrict the search results

Properties
NameTypeDescription
topLeftgem.core.Coordinates

default {latitude: 90, longitude: -180, altitude: 0, bearing: 0}

bottomRightgem.core.Coordinates

default {latitude: -90, longitude: 180, altitude: 0, bearing: 0}

setCursorReferencePointbool

default false( reference point is center of map envelope ), if set to true the search reference coordinate is set at the last cursor position

placeholderTextstring

set custom placeholder text for search box

searchResultsobject

options for configuring the free text search results

Properties
NameTypeAttributesDefaultDescription
showLandmarkIconsbool

default false

initialPlaceSearchstring

default no value, specify a start-up location

flyToResultAltitudenumber<optional>
1000

fly to result altitude in meters

cssClassesobject

specify custom style rules classes

Properties
NameTypeDescription
containerstring
inputContainerstring
inputTextstring
searchIconstring
searchLoaderstring
searchClearstring
searchFocusstring
searchResultsstring
searchResultItemstring
searchResultCanvasstring
searchResultContentstring
searchResultTitlestring
searchResultTypestring