Skip to content

Documentation / @gebeta/react

@gebeta/react ​

References ​

addProtocol ​

Renames and re-exports LngLat

AttributionControl ​

Renames and re-exports LngLat

FullscreenControl ​

Renames and re-exports LngLat

GeoJSONSource ​

Renames and re-exports LngLat

GeolocateControl ​

Renames and re-exports LngLat

MapMouseEvent ​

Renames and re-exports LngLat

MercatorCoordinate ​

Renames and re-exports LngLat

removeProtocol ​

Renames and re-exports LngLat

ScaleControl ​

Renames and re-exports LngLat

TerrainControl ​

Renames and re-exports LngLat

Classes ​

BrowserLocationProvider ​

Implements ​

  • ILocationProvider

Methods ​

start() ​
ts
start(onLocation): void
Parameters ​
ParameterType
onLocation(location) => void
Returns ​

void

Implementation of ​

ILocationProvider.start

Defined in ​

client/js/dist/adapters/LocationProvider.d.ts:12

stop() ​
ts
stop(): void
Returns ​

void

Implementation of ​

ILocationProvider.stop

Defined in ​

client/js/dist/adapters/LocationProvider.d.ts:13

getInstance() ​
ts
static getInstance(options?): BrowserLocationProvider
Parameters ​
ParameterType
options?LocationProviderOptions
Returns ​

BrowserLocationProvider

Defined in ​

client/js/dist/adapters/LocationProvider.d.ts:11


ClusteringManager ​

Manages marker clustering on a MapLibre map.

Groups nearby markers into clusters at lower zoom levels and renders individual markers when zoomed in. Cluster markers automatically expand on click unless a custom clusterOnClick handler is provided.

Enable via the constructor: new GebetaMaps({ clustering: { enabled: true } }), then access via sdk.clustering.

Constructors ​

new ClusteringManager() ​
ts
new ClusteringManager(
   mapAdapter, 
   markerFactory, 
   popupFactory, 
   options?): ClusteringManager
Parameters ​
ParameterType
mapAdapterIMapAdapter
markerFactoryIMarkerFactory
popupFactoryIPopupFactory
options?ClusteringOptions
Returns ​

ClusteringManager

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:24

Methods ​

addMarker() ​
ts
addMarker(marker): void

Add a marker to clustering.

Parameters ​
ParameterTypeDescription
markerMarkerDataMarker data to add
Returns ​

void

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:29

clearMarkers() ​
ts
clearMarkers(): void

Clear all markers.

Returns ​

void

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:39

getMarker() ​
ts
getMarker(markerId): undefined | MarkerData

Get marker by ID.

Parameters ​
ParameterTypeDescription
markerIdstringID of marker to find
Returns ​

undefined | MarkerData

Marker data or undefined if not found

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:50

getMarkers() ​
ts
getMarkers(): MarkerData[]

Get all markers.

Returns ​

MarkerData[]

Array of all markers

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:44

getOptions() ​
ts
getOptions(): any

Get clustering options.

Returns ​

any

Current clustering options

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:60

removeMarker() ​
ts
removeMarker(markerId): boolean

Remove a marker by ID.

Parameters ​
ParameterTypeDescription
markerIdstringID of marker to remove
Returns ​

boolean

True if marker was removed, false if not found

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:35

updateOptions() ​
ts
updateOptions(options): void

Update clustering options.

Parameters ​
ParameterTypeDescription
optionsPartial<ClusteringOptions>Partial options to update
Returns ​

void

Defined in ​

client/js/dist/Clustering/ClusteringManager.d.ts:55


DirectionsManager ​

Manages route display on the map.

Wraps the core DirectionsManager and adds MapLibre GL rendering: draws the route line and places origin/destination/waypoint markers.

Use via sdk.getDirections() and sdk.displayRoute(), or access directly for advanced use cases.

Constructors ​

new DirectionsManager() ​
ts
new DirectionsManager(
   mapAdapter, 
   markerFactory, 
   auth, 
   clientId?): DirectionsManager
Parameters ​
ParameterType
mapAdapterIMapAdapter
markerFactoryIMarkerFactory
authAuthInput
clientId?string
Returns ​

DirectionsManager

Defined in ​

client/js/dist/Directions/DirectionsManager.d.ts:25

Methods ​

clearRoute() ​
ts
clearRoute(): void
Returns ​

void

Defined in ​

client/js/dist/Directions/DirectionsManager.d.ts:30

displayRoute() ​
ts
displayRoute(routeData, options?): void
Parameters ​
ParameterType
routeDataRouteData
options?DisplayRouteOptions & object
Returns ​

void

Defined in ​

client/js/dist/Directions/DirectionsManager.d.ts:27

getCurrentRoute() ​
ts
getCurrentRoute(): null | RouteData
Returns ​

null | RouteData

Defined in ​

client/js/dist/Directions/DirectionsManager.d.ts:31

getDirections() ​
ts
getDirections(
   origin, 
   destination, 
options?): Promise<RouteData>
Parameters ​
ParameterType
originLngLat
destinationLngLat
options?DirectionsOptions
Returns ​

Promise<RouteData>

Defined in ​

client/js/dist/Directions/DirectionsManager.d.ts:26

getRouteSummary() ​
ts
getRouteSummary(): null | object
Returns ​

null | object

Defined in ​

client/js/dist/Directions/DirectionsManager.d.ts:32

updateRouteStyle() ​
ts
updateRouteStyle(style): void
Parameters ​
ParameterType
styleRouteStyleOptions
Returns ​

void

Defined in ​

client/js/dist/Directions/DirectionsManager.d.ts:39


FenceManager ​

Manages geofences (polygons) on the map.

Supports interactive fence drawing, rendering pre-defined fences, and attaching overlays (HTML labels) at fence centroids.

Access via sdk.fencing after calling sdk.init().

Constructors ​

new FenceManager() ​
ts
new FenceManager(
   mapAdapter, 
   markerFactory, 
   popupFactory, 
   options?): FenceManager
Parameters ​
ParameterType
mapAdapterIMapAdapter
markerFactoryIMarkerFactory
popupFactoryIPopupFactory
options?FenceManagerOptions
Returns ​

FenceManager

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:39

Methods ​

addPoint() ​
ts
addPoint(point, options?): void

Add a point to the current fence.

Parameters ​
ParameterTypeDescription
pointLngLatLikePoint to add
options?FencePointOptions & objectOptional point options
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:54

canCloseFence() ​
ts
canCloseFence(): boolean

Check if current fence can be closed (has at least 3 points).

Returns ​

boolean

True if fence can be closed

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:143

clearAllFences() ​
ts
clearAllFences(): void

Clear all stored fences.

Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:98

clearCurrentFence() ​
ts
clearCurrentFence(): void

Clear the current fence being drawn.

Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:65

closeFence() ​
ts
closeFence(): null | FenceDefinition

Close the current fence.

Returns ​

null | FenceDefinition

Fence definition if closed successfully, null otherwise

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:61

getCurrentFencePoints() ​
ts
getCurrentFencePoints(): LngLatLike[]

Get the current fence points.

Returns ​

LngLatLike[]

Array of points or empty array if not drawing

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:138

getCurrentStyle() ​
ts
getCurrentStyle(): FenceStyleOptions

Get current fence style (if drawing).

Returns ​

FenceStyleOptions

Current fence style or default style

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:118

getDefaultStyle() ​
ts
getDefaultStyle(): FenceStyleOptions

Get current default style.

Returns ​

FenceStyleOptions

Copy of default style

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:113

getFence() ​
ts
getFence(fenceId): undefined | FenceDefinition

Get a fence by ID.

Parameters ​
ParameterTypeDescription
fenceIdstring | numberFence ID
Returns ​

undefined | FenceDefinition

Fence definition or undefined if not found

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:76

getFenceByName() ​
ts
getFenceByName(name): undefined | FenceDefinition

Get a fence by name.

Parameters ​
ParameterTypeDescription
namestringFence name
Returns ​

undefined | FenceDefinition

Fence definition or undefined if not found

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:82

getFenceCentroid() ​
ts
getFenceCentroid(fence): LngLat

Get fence centroid.

Parameters ​
ParameterTypeDescription
fencestring | number | FenceDefinitionFence definition or fence ID
Returns ​

LngLat

Centroid coordinates

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:149

getFences() ​
ts
getFences(): FenceDefinition[]

Get all stored fences.

Returns ​

FenceDefinition[]

Array of fence definitions

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:70

getProximityThreshold() ​
ts
getProximityThreshold(): number

Get proximity threshold.

Returns ​

number

Threshold in meters

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:128

isDrawingFence() ​
ts
isDrawingFence(): boolean

Check if currently drawing a fence.

Returns ​

boolean

True if drawing is active

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:133

off() ​
ts
off(event, callback): void

Remove event listener for fence events.

Parameters ​
ParameterTypeDescription
event"fenceCompleted"Event name
callback(event) => voidCallback function to remove
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:170

on() ​
ts
on(event, callback): void

Add event listener for fence events.

Parameters ​
ParameterTypeDescription
event"fenceCompleted"Event name
callback(event) => voidCallback function
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:164

removeFence() ​
ts
removeFence(fenceId): boolean

Remove a fence by ID.

Parameters ​
ParameterTypeDescription
fenceIdstring | numberFence ID
Returns ​

boolean

True if fence was removed

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:88

removeFenceByName() ​
ts
removeFenceByName(name): boolean

Remove a fence by name.

Parameters ​
ParameterTypeDescription
namestringFence name
Returns ​

boolean

True if fence was removed

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:94

renderFences() ​
ts
renderFences(fences, options?): void

Render multiple fences from an array of definitions.

Parameters ​
ParameterTypeDescription
fencesFenceDefinition[]Array of fence definitions
options?objectRender options
options.clearExisting?boolean-
options.persistent?boolean-
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:155

setDefaultStyle() ​
ts
setDefaultStyle(style): void

Set default fence style for future fences.

Parameters ​
ParameterTypeDescription
styleFenceStyleOptionsStyle options
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:108

setProximityThreshold() ​
ts
setProximityThreshold(meters): void

Set proximity threshold for auto-closing fences.

Parameters ​
ParameterTypeDescription
metersnumberThreshold distance in meters
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:123

startDrawing() ​
ts
startDrawing(style?): void

Start drawing a new fence.

Parameters ​
ParameterTypeDescription
style?FenceStyleOptionsOptional style options for this fence
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:44

stopDrawing() ​
ts
stopDrawing(): void

Stop drawing the current fence.

Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:48

updateCurrentFenceStyle() ​
ts
updateCurrentFenceStyle(style): void

Update the style for the current fence being drawn.

Parameters ​
ParameterTypeDescription
stylePartial<FenceStyleOptions>Style options to update
Returns ​

void

Defined in ​

client/js/dist/Fencing/FenceManager.d.ts:103


GeocodingManager ​

GeocodingManager handles forward and reverse geocoding operations. Platform-agnostic: uses fetch API which is available in all JS environments.

Constructors ​

new GeocodingManager() ​
ts
new GeocodingManager(auth, clientId?): GeocodingManager
Parameters ​
ParameterType
authAuthInput
clientId?string
Returns ​

GeocodingManager

Defined in ​

core/dist/Geocoding/GeocodingManager.d.ts:11

Methods ​

geocode() ​
ts
geocode(name): Promise<GeocodeResult[]>

Forward geocoding: search by name/address.

Parameters ​
ParameterTypeDescription
namestringPlace name or address to search for
Returns ​

Promise<GeocodeResult[]>

Promise resolving to array of geocoding results

Defined in ​

core/dist/Geocoding/GeocodingManager.d.ts:17

reverseGeocode() ​
ts
reverseGeocode(latlng): Promise<GeocodeResult[]>

Reverse geocoding: search by coordinates.

Parameters ​
ParameterType
latlngLngLat
Returns ​

Promise<GeocodeResult[]>

Promise resolving to array of geocoding results

Defined in ​

core/dist/Geocoding/GeocodingManager.d.ts:23


LngLatBounds ​

Constructors ​

new LngLatBounds() ​
ts
new LngLatBounds(): LngLatBounds
Returns ​

LngLatBounds

Defined in ​

client/react/src/maplibre-gl.d.ts:57

Methods ​

extend() ​
ts
extend(point): this
Parameters ​
ParameterType
point[number, number]
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:58

getEast() ​
ts
getEast(): number
Returns ​

number

Defined in ​

client/react/src/maplibre-gl.d.ts:61

getNorth() ​
ts
getNorth(): number
Returns ​

number

Defined in ​

client/react/src/maplibre-gl.d.ts:62

getSouth() ​
ts
getSouth(): number
Returns ​

number

Defined in ​

client/react/src/maplibre-gl.d.ts:60

getWest() ​
ts
getWest(): number
Returns ​

number

Defined in ​

client/react/src/maplibre-gl.d.ts:59


Marker ​

Constructors ​

new Marker() ​
ts
new Marker(options?): Marker
Parameters ​
ParameterType
options?object
options.anchor?string
options.element?HTMLElement
options.offset?number | [number, number]
Returns ​

Marker

Defined in ​

client/react/src/maplibre-gl.d.ts:32

Methods ​

addTo() ​
ts
addTo(map): this
Parameters ​
ParameterType
mapMap
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:38

remove() ​
ts
remove(): void
Returns ​

void

Defined in ​

client/react/src/maplibre-gl.d.ts:39

setLngLat() ​
ts
setLngLat(lngLat): this
Parameters ​
ParameterType
lngLat[number, number] | object
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:37

setPopup() ​
ts
setPopup(popup): this
Parameters ​
ParameterType
popupnull | Popup
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:40


Constructors ​

new NavigationControl() ​
ts
new NavigationControl(): NavigationControl
Returns ​

NavigationControl

Defined in ​

client/react/src/maplibre-gl.d.ts:28


Browser navigation manager — wraps the core NavigationManager and adds map rendering: a live location marker and a camera that follows the driver.

Access via sdk.navigation after calling sdk.init().

Example ​

ts
const route = await sdk.getDirections(origin, destination);
sdk.displayRoute(route);

sdk.navigation.on('progress', e => console.log('remaining:', e.remainingDistance));
sdk.navigation.on('arrive', () => console.log('Arrived!'));

sdk.navigation.start(route, { userId: 'user-123' }, BrowserLocationProvider.getInstance());

Constructors ​

new NavigationManager() ​
ts
new NavigationManager(
   auth, 
   mapAdapter, 
   markerFactory, 
   options?, 
   clientId?): NavigationManager

Creates a new NavigationManager instance.

Parameters ​
ParameterTypeDescription
authAuthInputAPI key or service key authentication input
mapAdapterIMapAdapterMap adapter for camera control
markerFactoryIMarkerFactoryMarker factory for location marker
options?NavigationManagerOptionsConfiguration options for navigation behavior
clientId?string-
Returns ​

NavigationManager

Throws ​

If apiKey, mapAdapter, or markerFactory is missing

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:41

Methods ​

getCurrentRoute() ​
ts
getCurrentRoute(): null | RouteData

Gets the current route being navigated.

Returns ​

null | RouteData

Current route data or null if not navigating

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:100

getCurrentStepIndex() ​
ts
getCurrentStepIndex(): number

Gets the current step index in the route instructions.

Returns ​

number

Current step index

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:105

isNavigating() ​
ts
isNavigating(): boolean

Checks if navigation is currently active.

Returns ​

boolean

True if navigating, false otherwise

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:110

off() ​
ts
off<K>(event, callback): void

Remove a navigation event listener.

Type Parameters ​
Type Parameter
K extends keyof NavigationEventMap
Parameters ​
ParameterType
eventK
callbackNavigationEventMap[K]
Returns ​

void

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:116

on() ​
ts
on<K>(event, callback): void

Register a navigation event listener. Payload type is inferred from the event name.

Type Parameters ​
Type Parameter
K extends keyof NavigationEventMap
Parameters ​
ParameterType
eventK
callbackNavigationEventMap[K]
Returns ​

void

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:114

start() ​
ts
start(
   route, 
   startOptions, 
   locationProvider): void

Starts navigation along the provided route.

Parameters ​
ParameterTypeDescription
routeRouteDataRoute data containing geometry and instructions
startOptionsNavigationStartOptionsOptions for starting navigation (userId, role, precision)
locationProviderILocationProviderProvider that supplies location data
Returns ​

void

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:48

stop() ​
ts
stop(): void

Stops navigation and removes location marker.

Returns ​

void

Defined in ​

client/js/dist/Navigation/NavigationManager.d.ts:59


Constructors ​

new Popup() ​
ts
new Popup(options?): Popup
Parameters ​
ParameterType
options?object
options.anchor?string
options.closeButton?boolean
options.offset?number | [number, number]
Returns ​

Popup

Defined in ​

client/react/src/maplibre-gl.d.ts:44

Methods ​

addTo() ​
ts
addTo(map): this
Parameters ​
ParameterType
mapMap
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:52

remove() ​
ts
remove(): void
Returns ​

void

Defined in ​

client/react/src/maplibre-gl.d.ts:53

setDOMContent() ​
ts
setDOMContent(element): this
Parameters ​
ParameterType
elementHTMLElement
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:50

setHTML() ​
ts
setHTML(html): this
Parameters ​
ParameterType
htmlstring
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:49

setLngLat() ​
ts
setLngLat(lngLat): this
Parameters ​
ParameterType
lngLat[number, number]
Returns ​

this

Defined in ​

client/react/src/maplibre-gl.d.ts:51

Interfaces ​

GebetaMarkerOptions ​

Options for sdk.addMarker().

Properties ​

PropertyTypeDescriptionDefined in
anchor?AnchorPart of the marker placed at lngLat (default: 'center', or 'bottom' for imageUrl).client/js/dist/Markers/helpers.d.ts:19
className?stringCSS class added to the marker element.client/js/dist/Markers/helpers.d.ts:27
color?stringColor of the default pin (ignored with element / imageUrl).client/js/dist/Markers/helpers.d.ts:17
draggable?booleanAllow the user to drag the marker.client/js/dist/Markers/helpers.d.ts:23
element?HTMLElementCustom HTML element. Takes precedence over imageUrl and color.client/js/dist/Markers/helpers.d.ts:11
imageUrl?stringImage URL for the marker icon.client/js/dist/Markers/helpers.d.ts:13
lngLatLngLatLikeMarker position [lng, lat] or { lng, lat }.client/js/dist/Markers/helpers.d.ts:9
offset?[number, number]Pixel offset [x, y].client/js/dist/Markers/helpers.d.ts:21
onClick?(marker: Marker, event: MouseEvent) => voidClick handler.client/js/dist/Markers/helpers.d.ts:31
onDragEnd?(lngLat: object, marker: Marker) => voidCalled after the user finishes dragging (requires draggable).client/js/dist/Markers/helpers.d.ts:33
popup?string | HTMLElementPopup opened when the marker is clicked: plain text, or an HTMLElement.client/js/dist/Markers/helpers.d.ts:29
rotation?numberRotation in degrees.client/js/dist/Markers/helpers.d.ts:25
size?[number, number]Icon size [width, height] in pixels when using imageUrl (default: [30, 30]).client/js/dist/Markers/helpers.d.ts:15

GebetaPopupOptions ​

Options for sdk.addPopup().

Properties ​

PropertyTypeDescriptionDefined in
anchor?AnchorPopup anchor relative to lngLat.client/js/dist/Markers/helpers.d.ts:53
className?stringCSS class added to the popup container.client/js/dist/Markers/helpers.d.ts:59
closeButton?booleanShow the close button (default: true).client/js/dist/Markers/helpers.d.ts:49
closeOnClick?booleanClose when the map is clicked (default: true).client/js/dist/Markers/helpers.d.ts:51
element?HTMLElementDOM element content.client/js/dist/Markers/helpers.d.ts:47
html?stringHTML content. Only use with trusted markup.client/js/dist/Markers/helpers.d.ts:45
lngLatLngLatLikePopup position [lng, lat] or { lng, lat }.client/js/dist/Markers/helpers.d.ts:41
maxWidth?stringCSS max-width (default: '240px').client/js/dist/Markers/helpers.d.ts:57
offset?number | [number, number]Pixel offset.client/js/dist/Markers/helpers.d.ts:55
text?stringPlain text content (safe for user data).client/js/dist/Markers/helpers.d.ts:43

UseClusteringResult ​

Properties ​

PropertyTypeDefined in
addMarker(marker: MarkerData) => voidclient/react/src/hooks/useClustering.ts:9
clearMarkers() => voidclient/react/src/hooks/useClustering.ts:11
getMarker(markerId: string) => undefined | MarkerDataclient/react/src/hooks/useClustering.ts:13
getMarkers() => MarkerData[]client/react/src/hooks/useClustering.ts:12
getOptions() => anyclient/react/src/hooks/useClustering.ts:15
removeMarker(markerId: string) => booleanclient/react/src/hooks/useClustering.ts:10
updateOptions(options: Partial<ClusteringOptions>) => voidclient/react/src/hooks/useClustering.ts:14

Type Aliases ​

GebetaMapInstance ​

ts
type GebetaMapInstance: MapLibreMap;

The map instance returned by sdk.init() / sdk.getMap().

Defined in ​

client/js/dist/gebeta.d.ts:23


GebetaMapsProps ​

ts
type GebetaMapsProps: AuthOptions & ForwardedMapOptions & object;

Type declaration ​

NameTypeDescriptionDefined in
center?[number, number]Initial center [lng, lat]. Only read on mount.client/react/src/GebetaMaps.tsx:40
children?ReactNodeRendered over the map once it has loaded.client/react/src/GebetaMaps.tsx:62
className?stringCSS class for the map wrapper element.client/react/src/GebetaMaps.tsx:60
clustering?OptionsClustering configuration (read on mount).client/react/src/GebetaMaps.tsx:48
mapStyle?string | objectMap style URL or style object; takes precedence over styleUrl.client/react/src/GebetaMaps.tsx:46
navigationControl?booleanShow zoom/compass controls (default: false).client/react/src/GebetaMaps.tsx:50
navigationControlPosition?stringCorner for navigation controls (default: 'top-right').client/react/src/GebetaMaps.tsx:52
onError?(error) => voidCalled on map errors.client/react/src/GebetaMaps.tsx:56
onLoad?(instance) => voidCalled once the map style has loaded, with the GebetaMaps instance.client/react/src/GebetaMaps.tsx:54
style?CSSPropertiesCSS styles for the map wrapper element (defaults to filling the parent).client/react/src/GebetaMaps.tsx:58
styleUrl?stringMap style JSON URL (defaults to the Gebeta standard style).client/react/src/GebetaMaps.tsx:44
zoom?numberInitial zoom. Only read on mount.client/react/src/GebetaMaps.tsx:42

Defined in ​

client/react/src/GebetaMaps.tsx:37


GebetaMapsRef ​

ts
type GebetaMapsRef: GebetaMaps;

Defined in ​

client/react/src/GebetaMaps.tsx:64


MarkerData ​

ts
type MarkerData: MarkerData;

Defined in ​

client/react/src/hooks/useClustering.ts:6

Variables ​

gebeta ​

ts
const gebeta: object;

Namespace object with every Gebeta building block (also window.gebeta on CDN).

Type declaration ​

NameTypeDefined in
addProtocoltypeof LngLatclient/js/dist/gebeta.d.ts:38
AttributionControltypeof LngLatclient/js/dist/gebeta.d.ts:36
FullscreenControltypeof LngLatclient/js/dist/gebeta.d.ts:34
GeolocateControltypeof LngLatclient/js/dist/gebeta.d.ts:33
LngLattypeof LngLatclient/js/dist/gebeta.d.ts:29
LngLatBoundstypeof LngLatBoundsclient/js/dist/gebeta.d.ts:30
Markertypeof Markerclient/js/dist/gebeta.d.ts:27
MercatorCoordinatetypeof LngLatclient/js/dist/gebeta.d.ts:31
NavigationControltypeof NavigationControlclient/js/dist/gebeta.d.ts:32
Popuptypeof Popupclient/js/dist/gebeta.d.ts:28
removeProtocoltypeof LngLatclient/js/dist/gebeta.d.ts:39
ScaleControltypeof LngLatclient/js/dist/gebeta.d.ts:35
TerrainControltypeof LngLatclient/js/dist/gebeta.d.ts:37

Defined in ​

client/js/dist/gebeta.d.ts:26


LngLat ​

ts
LngLat: any;

Functions ​

GebetaMaps() ​

ts
function GebetaMaps(props): ReactNode

Parameters ​

ParameterType
propsGebetaMapsProps & object

Returns ​

ReactNode

Defined in ​

client/react/src/GebetaMaps.tsx:215


useClustering() ​

ts
function useClustering(): UseClusteringResult

React hook for managing clustered markers on a Gebeta map.

Must be used inside a GebetaMaps component with clustering enabled.

Returns ​

UseClusteringResult

Throws ​

If clustering is not enabled on the parent GebetaMaps component.

Defined in ​

client/react/src/hooks/useClustering.ts:25