On this page

Class Map

The main Map class for creating and controlling a MapTiler WebGPU interactive map.

Example

import { Map } from '@maptiler/geosplats';

const map = new Map({
  container: 'map',
  apiKey: 'YOUR_MAPTILER_API_KEY_HERE',
  center: [16.37, 48.21],
  zoom: 12
});

Hierarchy (View Summary)

Evented<MapEvent>
- Map

Constructors

constructor

new Map(options: MapOptions): Map
Creates a new Map instance.
Parameters
- options: MapOptions
  The options for the map.
Returns Map
Example
```
const map = new Map({
  apiKey: 'YOUR_MAPTILER_API_KEY_HERE',
  container: 'map',
  center: [14.454266, 50.089376],
  zoom: 12,
  debug: true
});
```
Overrides Evented.constructor
- Defined in Map.ts:192

Properties

`Protected`loaded

loaded: boolean = false

Methods

addControl

addControl(control: Control, position?: ControlPosition): this
Adds a control to the map.
Parameters
- control: Control
  The control instance to add.
- Optionalposition: ControlPosition
  The position of the control.
Returns this
- Defined in Map.ts:266

addSplatModel

addSplatModel(splatModel: SplatModel, cameraParams?: CameraParams | null): void
Adds a SplatModel visualization to the map.
Parameters
- splatModel: SplatModel
  The SplatModel instance to add.
- cameraParams: CameraParams | null = null
  optional pitch and bearing for camera.
Returns void
Example
```
const splatModel = new SplatModel({ model: "model_url" });
map.on('load', () => {
  map.addSplatModel(splatModel);
});
```
- Defined in Map.ts:296

fitBounds

fitBounds(lngLatBoundsLike: LngLatBoundsLike): void
Moves the camera such that the provided bounds are visible.
Parameters
- lngLatBoundsLike: LngLatBoundsLike
  The bounds to fit.
Returns void
Example
```
map.fitBounds([
  [14.408177, 50.080911],
  [14.440250, 50.085178]
]);
```
- Defined in Map.ts:343

getAltitudeAt

getAltitudeAt(position: LngLatLike, callback: (altitude: number) => void): void
Returns the current terrain exaggeration factor.
Parameters
- position: LngLatLike
  LngLat position.
- callback: (altitude: number) => void
  Function called with the position's altitude or NaN if position is invalid or basemap is VOID.
Returns void
- Defined in Map.ts:488

getBasemap

getBasemap(): ReferenceMapStyle
Returns the current basemap.

Returns ReferenceMapStyle
The current basemap.
- Defined in Map.ts:353

getBearing

getBearing(): number
Returns the current bearing (rotation) of the map in degrees.

Returns number
The bearing in degrees.
- Defined in Map.ts:324

getCenter

getCenter(callback: (center: LngLat) => void): void
Returns the current center of the map.
Parameters
- callback: (center: LngLat) => void
  Function called with the center position.
Returns void
- Defined in Map.ts:375

getFov

getFov(): number
Returns the current field of view (FOV) of the map.

Returns number
The FOV in degrees.
- Defined in Map.ts:385

getMaxPitch

getMaxPitch(): number
Returns the maximum allowed pitch (tilt).

Returns number
The maximum pitch.
- Defined in Map.ts:407

getMinPitch

getMinPitch(): number
Returns the minimum allowed pitch (tilt).

Returns number
The minimum pitch.
- Defined in Map.ts:431

getPitch

getPitch(): number
Returns the current pitch (tilt) of the map in degrees.

Returns number
The pitch in degrees.
- Defined in Map.ts:455

getZoom

getZoom(): number
Returns the current zoom level of the map.

Returns number
The zoom level.
- Defined in Map.ts:501

jumpTo(options: CameraOptions): void
Instantly moves the camera to the specified position and zoom.
Parameters
- options: CameraOptions
  The camera options to jump to.
Returns void
Example
```
map.jumpTo({
  center: [13.497569, 47.344369],
  zoom: 12,
  pitch: 80,
  bearing: 60,
});
```
- Defined in Map.ts:532

off

off<
    EventType extends
        | "load"
        | "error"
        | "click"
        | "splatmodel:load"
        | "splatmodel:error"
        | "splatmodel:remove"
        | "splatmodel:update"
        | "splatmodel:mouseover"
        | "splatmodel:mouseout"
        | "splatmodel:click"
        | "splatmodel:dragstart"
        | "splatmodel:dragend"
        | "resolution"
        | "move"
        | "moveend"
        | "movestart",
>(
    eventType: EventType,
    handler: (
        event:
            | Extract<MapClickEvent, { type: EventType }>
            | Extract<MapErrorEvent, { type: EventType }>
            | Extract<MapModelResolutionEvent, { type: EventType }>
            | Extract<MapLoadEvent, { type: EventType }>
            | Extract<MapMoveEvent, { type: EventType }>
            | Extract<MapMoveEndEvent, { type: EventType }>
            | Extract<MapMoveStartEvent, { type: EventType }>
            | Extract<MapSplatModelLoadEvent, { type: EventType }>
            | Extract<MapSplatModelErrorEvent, { type: EventType }>
            | Extract<MapSplatModelRemoveEvent, { type: EventType }>
            | Extract<MapSplatModelUpdateEvent, { type: EventType }>
            | Extract<MapSplatModelMouseOverEvent, { type: EventType }>
            | Extract<MapSplatModelMouseOutEvent, { type: EventType }>
            | Extract<MapSplatModelClickEvent, { type: EventType }>
            | Extract<MapSplatModelDragStartEvent, { type: EventType }>
            | Extract<MapSplatModelDragEndEvent, { type: EventType }>,
    ) => void,
): void
Removes a listener for a specific event type.
Type Parameters
- EventType extends
      | "load"
      | "error"
      | "click"
      | "splatmodel:load"
      | "splatmodel:error"
      | "splatmodel:remove"
      | "splatmodel:update"
      | "splatmodel:mouseover"
      | "splatmodel:mouseout"
      | "splatmodel:click"
      | "splatmodel:dragstart"
      | "splatmodel:dragend"
      | "resolution"
      | "move"
      | "moveend"
      | "movestart"
Parameters
- eventType: EventType
  The type of event to remove the listener from.
- handler: (
      event:
          | Extract<MapClickEvent, { type: EventType }>
          | Extract<MapErrorEvent, { type: EventType }>
          | Extract<MapModelResolutionEvent, { type: EventType }>
          | Extract<MapLoadEvent, { type: EventType }>
          | Extract<MapMoveEvent, { type: EventType }>
          | Extract<MapMoveEndEvent, { type: EventType }>
          | Extract<MapMoveStartEvent, { type: EventType }>
          | Extract<MapSplatModelLoadEvent, { type: EventType }>
          | Extract<MapSplatModelErrorEvent, { type: EventType }>
          | Extract<MapSplatModelRemoveEvent, { type: EventType }>
          | Extract<MapSplatModelUpdateEvent, { type: EventType }>
          | Extract<MapSplatModelMouseOverEvent, { type: EventType }>
          | Extract<MapSplatModelMouseOutEvent, { type: EventType }>
          | Extract<MapSplatModelClickEvent, { type: EventType }>
          | Extract<MapSplatModelDragStartEvent, { type: EventType }>
          | Extract<MapSplatModelDragEndEvent, { type: EventType }>,
  ) => void
  The listener function to remove.
Returns void
Inherited from Evented.off
- Defined in Evented.ts:64

on

on<
    EventType extends
        | "load"
        | "error"
        | "click"
        | "splatmodel:load"
        | "splatmodel:error"
        | "splatmodel:remove"
        | "splatmodel:update"
        | "splatmodel:mouseover"
        | "splatmodel:mouseout"
        | "splatmodel:click"
        | "splatmodel:dragstart"
        | "splatmodel:dragend"
        | "resolution"
        | "move"
        | "moveend"
        | "movestart",
>(
    eventType: EventType,
    handler: (
        event:
            | Extract<MapClickEvent, { type: EventType }>
            | Extract<MapErrorEvent, { type: EventType }>
            | Extract<MapModelResolutionEvent, { type: EventType }>
            | Extract<MapLoadEvent, { type: EventType }>
            | Extract<MapMoveEvent, { type: EventType }>
            | Extract<MapMoveEndEvent, { type: EventType }>
            | Extract<MapMoveStartEvent, { type: EventType }>
            | Extract<MapSplatModelLoadEvent, { type: EventType }>
            | Extract<MapSplatModelErrorEvent, { type: EventType }>
            | Extract<MapSplatModelRemoveEvent, { type: EventType }>
            | Extract<MapSplatModelUpdateEvent, { type: EventType }>
            | Extract<MapSplatModelMouseOverEvent, { type: EventType }>
            | Extract<MapSplatModelMouseOutEvent, { type: EventType }>
            | Extract<MapSplatModelClickEvent, { type: EventType }>
            | Extract<MapSplatModelDragStartEvent, { type: EventType }>
            | Extract<MapSplatModelDragEndEvent, { type: EventType }>,
    ) => void,
): void
Adds a listener for a specific event type.
Type Parameters
- EventType extends
      | "load"
      | "error"
      | "click"
      | "splatmodel:load"
      | "splatmodel:error"
      | "splatmodel:remove"
      | "splatmodel:update"
      | "splatmodel:mouseover"
      | "splatmodel:mouseout"
      | "splatmodel:click"
      | "splatmodel:dragstart"
      | "splatmodel:dragend"
      | "resolution"
      | "move"
      | "moveend"
      | "movestart"
Parameters
- eventType: EventType
  The type of event to listen for.
- handler: (
      event:
          | Extract<MapClickEvent, { type: EventType }>
          | Extract<MapErrorEvent, { type: EventType }>
          | Extract<MapModelResolutionEvent, { type: EventType }>
          | Extract<MapLoadEvent, { type: EventType }>
          | Extract<MapMoveEvent, { type: EventType }>
          | Extract<MapMoveEndEvent, { type: EventType }>
          | Extract<MapMoveStartEvent, { type: EventType }>
          | Extract<MapSplatModelLoadEvent, { type: EventType }>
          | Extract<MapSplatModelErrorEvent, { type: EventType }>
          | Extract<MapSplatModelRemoveEvent, { type: EventType }>
          | Extract<MapSplatModelUpdateEvent, { type: EventType }>
          | Extract<MapSplatModelMouseOverEvent, { type: EventType }>
          | Extract<MapSplatModelMouseOutEvent, { type: EventType }>
          | Extract<MapSplatModelClickEvent, { type: EventType }>
          | Extract<MapSplatModelDragStartEvent, { type: EventType }>
          | Extract<MapSplatModelDragEndEvent, { type: EventType }>,
  ) => void
  The function to call when the event is fired.
Returns void
Example
```
map.on('load', () => {
  console.log('Map loaded!');
});
```
Inherited from Evented.on
- Defined in Evented.ts:32

once

once<
    EventType extends
        | "load"
        | "error"
        | "click"
        | "splatmodel:load"
        | "splatmodel:error"
        | "splatmodel:remove"
        | "splatmodel:update"
        | "splatmodel:mouseover"
        | "splatmodel:mouseout"
        | "splatmodel:click"
        | "splatmodel:dragstart"
        | "splatmodel:dragend"
        | "resolution"
        | "move"
        | "moveend"
        | "movestart",
>(
    eventType: EventType,
    handler: (
        event:
            | Extract<MapClickEvent, { type: EventType }>
            | Extract<MapErrorEvent, { type: EventType }>
            | Extract<MapModelResolutionEvent, { type: EventType }>
            | Extract<MapLoadEvent, { type: EventType }>
            | Extract<MapMoveEvent, { type: EventType }>
            | Extract<MapMoveEndEvent, { type: EventType }>
            | Extract<MapMoveStartEvent, { type: EventType }>
            | Extract<MapSplatModelLoadEvent, { type: EventType }>
            | Extract<MapSplatModelErrorEvent, { type: EventType }>
            | Extract<MapSplatModelRemoveEvent, { type: EventType }>
            | Extract<MapSplatModelUpdateEvent, { type: EventType }>
            | Extract<MapSplatModelMouseOverEvent, { type: EventType }>
            | Extract<MapSplatModelMouseOutEvent, { type: EventType }>
            | Extract<MapSplatModelClickEvent, { type: EventType }>
            | Extract<MapSplatModelDragStartEvent, { type: EventType }>
            | Extract<MapSplatModelDragEndEvent, { type: EventType }>,
    ) => void,
): void
Adds a listener for a specific event type that will be called only once.
Type Parameters
- EventType extends
      | "load"
      | "error"
      | "click"
      | "splatmodel:load"
      | "splatmodel:error"
      | "splatmodel:remove"
      | "splatmodel:update"
      | "splatmodel:mouseover"
      | "splatmodel:mouseout"
      | "splatmodel:click"
      | "splatmodel:dragstart"
      | "splatmodel:dragend"
      | "resolution"
      | "move"
      | "moveend"
      | "movestart"
Parameters
- eventType: EventType
  The type of event to listen for.
- handler: (
      event:
          | Extract<MapClickEvent, { type: EventType }>
          | Extract<MapErrorEvent, { type: EventType }>
          | Extract<MapModelResolutionEvent, { type: EventType }>
          | Extract<MapLoadEvent, { type: EventType }>
          | Extract<MapMoveEvent, { type: EventType }>
          | Extract<MapMoveEndEvent, { type: EventType }>
          | Extract<MapMoveStartEvent, { type: EventType }>
          | Extract<MapSplatModelLoadEvent, { type: EventType }>
          | Extract<MapSplatModelErrorEvent, { type: EventType }>
          | Extract<MapSplatModelRemoveEvent, { type: EventType }>
          | Extract<MapSplatModelUpdateEvent, { type: EventType }>
          | Extract<MapSplatModelMouseOverEvent, { type: EventType }>
          | Extract<MapSplatModelMouseOutEvent, { type: EventType }>
          | Extract<MapSplatModelClickEvent, { type: EventType }>
          | Extract<MapSplatModelDragStartEvent, { type: EventType }>
          | Extract<MapSplatModelDragEndEvent, { type: EventType }>,
  ) => void
  The function to call when the event is fired.
Returns void
Example
```
map.once('splatmodel:load', () => {
  console.log('First SplatModel loaded!');
});
```
Inherited from Evented.once
- Defined in Evented.ts:51

remove

remove(): void
Removes the map and cleans up all related resources.

Returns void
- Defined in Map.ts:549

removeSplatModel

removeSplatModel(splatModel: SplatModel): void
Removes a SplatModel visualization from the map.
Parameters
- splatModel: SplatModel
  The SplatModel instance to remove.
Returns void
- Defined in Map.ts:573

setBasemap

setBasemap(basemap: ReferenceMapStyle): void
Changes the basemap.
Parameters
- basemap: ReferenceMapStyle
  The new basemap identifier (e.g., 'satellite-v4').
Returns void
- Defined in Map.ts:707

setBearing

setBearing(bearing: number): void
Sets the bearing (rotation) of the map.
Parameters
- bearing: number
  The new bearing in degrees.
Returns void
- Defined in Map.ts:585

setCenter

setCenter(center: LngLatLike): void
Sets the center position of the map.
Parameters
- center: LngLatLike
  The new center position.
Returns void
- Defined in Map.ts:595

setMaxPitch

setMaxPitch(pitch: number): void
Sets the maximum pitch (tilt) of the map.
Parameters
- pitch: number
  The new maximum pitch, from 0 to 180.
Returns void
- Defined in Map.ts:625

setMinPitch

setMinPitch(pitch: number): void
Sets the minimum pitch (tilt) of the map.
Parameters
- pitch: number
  The new minimum pitch, from 0 to 180.
Returns void
- Defined in Map.ts:646

setModelResolution

setModelResolution(resolution: ModelResolutionType): void
Changes rendered model quality.
Parameters
- resolution: ModelResolutionType
  sets render quality for models. QUALITY option might have impact on performance.
Returns void
- Defined in Map.ts:697

setPitch

setPitch(pitch: number): void
Sets the pitch (tilt) of the map.
Parameters
- pitch: number
  The new pitch in degrees.
Returns void
- Defined in Map.ts:667

setPitchLocked

setPitchLocked(locked: boolean): void
Locks or unlocks the current pitch of the map.
Parameters
- locked: boolean
  Whether to lock the pitch.
Returns void
- Defined in Map.ts:677

setZoom

setZoom(zoom: number): void
Sets the zoom level of the map.
Parameters
- zoom: number
  The new zoom level.
Returns void
- Defined in Map.ts:727

Class Map

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Map

Example

Properties

Protectedloaded

Methods

addControl

Parameters

Returns this

addSplatModel

Parameters

Returns void

Example

fitBounds

Parameters

Returns void

Example

getAltitudeAt

Parameters

Returns void

getBasemap

Returns ReferenceMapStyle

getBearing

Returns number

getCenter

Parameters

Returns void

getFov

Returns number

getMaxPitch

Returns number

getMinPitch

Returns number

getPitch

Returns number

getZoom

Returns number

jumpTo

Parameters

Returns void

Example

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Example

once

Type Parameters

Parameters

Returns void

Example

remove

Returns void

removeSplatModel

Parameters

Returns void

setBasemap

Parameters

Returns void

setBearing

Parameters

Returns void

setCenter

Parameters

Returns void

setMaxPitch

Parameters

`Protected`loaded