Class GeocodingControl
Hierarchy
- EventedControl
- GeocodingControl
Constructors
constructor
Parameters
- options: LeafletControlOptions
Returns GeocodingControl
Methods
addEventListener
addEventParent
Parameters
- obj: Evented
Returns this
addOneTimeEventListener
blur
Returns void
clearList
Clear search result list.
Returns void
clearMap
Clear geocoding search results from the map.
Returns void
fire
Parameters
- type: string
Optionaldata: unknownOptionalpropagate: boolean
Returns this
fireEvent
Parameters
- type: string
Optionaldata: unknownOptionalpropagate: boolean
Returns this
focus
hasEventListeners
- hasEventListeners<
T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle",
>(
type: T,
): booleanType Parameters
- T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle"
Parameters
- type: T
Returns boolean
- T extends
listens
off
- off(
eventMap?: {
featureslisted?: (
event: { features: Feature<Geometry>[] | undefined } & LeafletEvent<
"featureslisted",
>,
) => void;
featuresmarked?: (
event: { features: Feature<Geometry>[] | undefined } & LeafletEvent<
"featuresmarked",
>,
) => void;
optionsvisibilitychange?: (
event: { optionsVisible: boolean } & LeafletEvent<
"optionsvisibilitychange",
>,
) => void;
pick?: (
event: { feature: Feature<Geometry> | undefined } & LeafletEvent<
"pick",
>,
) => void;
querychange?: (
event: { query: string } & LeafletEvent<"querychange">,
) => void;
response?: (
event: { featureCollection: FeatureCollection; url: string } & LeafletEvent<
"response",
>,
) => void;
reversetoggle?: (
event: { reverse: boolean } & LeafletEvent<"reversetoggle">,
) => void;
select?: (
event: { feature: Feature<Geometry> | undefined } & LeafletEvent<
"select",
>,
) => void;
},
): thisParameters
OptionaleventMap: {
featureslisted?: (
event: { features: Feature<Geometry>[] | undefined } & LeafletEvent<
"featureslisted",
>,
) => void;
featuresmarked?: (
event: { features: Feature<Geometry>[] | undefined } & LeafletEvent<
"featuresmarked",
>,
) => void;
optionsvisibilitychange?: (
event: { optionsVisible: boolean } & LeafletEvent<
"optionsvisibilitychange",
>,
) => void;
pick?: (
event: { feature: Feature<Geometry> | undefined } & LeafletEvent<
"pick",
>,
) => void;
querychange?: (
event: { query: string } & LeafletEvent<"querychange">,
) => void;
response?: (
event: { featureCollection: FeatureCollection; url: string } & LeafletEvent<
"response",
>,
) => void;
reversetoggle?: (
event: { reverse: boolean } & LeafletEvent<"reversetoggle">,
) => void;
select?: (
event: { feature: Feature<Geometry> | undefined } & LeafletEvent<
"select",
>,
) => void;
}
Returns this
on
onAdd
Parameters
- map: Map
Returns HTMLDivElement
once
onRemove
Returns void
removeEventListener
removeEventParent
Parameters
- obj: Evented
Returns this
setOptions
Update the control options.
Parameters
- options: LeafletControlOptions
options to update
Returns void
- options: LeafletControlOptions
setQuery
Set the content of search input box.
Parameters
- value: string
text to set
- submit: boolean = true
perform the search
Returns void
- value: string
setReverseMode
Set reverse geocoding mode.
Parameters
- reverseActive: boolean
reverse geocoding active
Returns void
- reverseActive: boolean
Blur the search input box.