# Class: FlowCoreMapPopup
Core functionality for Flo.w map popups.
# Hierarchy
EventEmitter
↳ FlowCoreMapPopup
# Constructors
# constructor
+ new FlowCoreMapPopup(map
: FlowCoreMap, options
: FlowCoreMapPopupOptions): FlowCoreMapPopup
Constructs a new FlowCoreMapPopup
instance.
This is called by the FlowCoreMap::openPopup
method.
# Parameters:
Name | Type | Description |
---|---|---|
map | FlowCoreMap | Parent Flo.w map. |
options | FlowCoreMapPopupOptions | Popup options. |
Returns: FlowCoreMapPopup
# Properties
# map
• Readonly
map: FlowCoreMap
Parent Flo.w map.
# options
• Readonly
options: FlowCoreMapPopupOptions
Popup options.
# Methods
# close
▸ close(): void
Close the popup.
Returns: void
# moveTo
▸ moveTo(lngLat
: maplibregl.LngLatLike): void
Move the popup to a new location.
# Parameters:
Name | Type | Description |
---|---|---|
lngLat | maplibregl.LngLatLike | New location. |
Returns: void
# open
▸ open(lngLat
: maplibregl.LngLatLike): void
Open the popup at the specified location.
# Parameters:
Name | Type | Description |
---|---|---|
lngLat | maplibregl.LngLatLike | Popup location. |
Returns: void
# trackLocation
▸ trackLocation(location
: string, fireImmediately?
: boolean): void
Start tracking a Flo.w reactive expression to move the popup.
Call with null location
to stop tracking.
# Parameters:
Name | Type | Default value | Description |
---|---|---|---|
location | string | - | Flo.w reactive expression returning lng/lat as a 2-element array. |
fireImmediately | boolean | false | Update popup position immediately. |
Returns: void