Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GeocoderControlOptions

Hierarchy

  • ControlOptions
    • GeocoderControlOptions

Index

Properties

collapsed

collapsed: boolean

Collapse control unless hovered/clicked

defaultMarkGeocode

defaultMarkGeocode: boolean

Whether to mark a geocoding result on the map by default

errorMessage

errorMessage: string

Message when no result found / geocoding error occurs

expand

expand: "touch" | "click" | "hover"

How to expand a collapsed control: touch or click or hover

Optional geocoder

geocoder: IGeocoder

Object to perform the actual geocoding queries

iconLabel

iconLabel: string

Accessibility label for the search icon used by screen readers

placeholder

placeholder: string

Placeholder text for text input

Optional position

position: ControlPosition

query

query: string

Initial query string for text input

queryMinLength

queryMinLength: number

Minimum number of characters in search text before performing a query

showResultIcons

showResultIcons: boolean

Show icons for geocoding results (if available); supported by Nominatim

showUniqueResult

showUniqueResult: boolean

Immediately show the unique result without prompting for alternatives

suggestMinLength

suggestMinLength: number

Minimum number characters before suggest functionality is used (if available from geocoder)

suggestTimeout

suggestTimeout: number

Number of milliseconds after typing stopped before suggest functionality is used (if available from geocoder)

Generated using TypeDoc