Skip to content
MapLibre GL JS
CanonicalTileID
Initializing search
GitHub
Introduction
Plugins
Style Specifications
API
Examples
Guides
MapLibre GL JS
GitHub
Introduction
Plugins
Style Specifications
API
API
Intro
media
media
Contributing to MapLibre GL JS
Classes
Classes
AJAXError
Actor
AlphaImage
AttributionControl
BoxZoomHandler
CanonicalTileID
CanonicalTileID
Table of contents
Implements
CanvasSource
CircleStyleLayer
ClickZoomHandler
CooperativeGesturesHandler
DEMData
Dispatcher
DoubleClickZoomHandler
DragPanHandler
DragRotateHandler
EdgeInsets
Event
Evented
FeatureIndex
FullscreenControl
GeoJSONFeature
GeoJSONSource
GeolocateControl
Hash
HeatmapStyleLayer
ImageAtlas
ImageManager
ImageSource
KeyboardHandler
Layout<Props>
LngLat
LngLatBounds
LogoControl
Map
MapMouseEvent
MapTouchEvent
MapWheelEvent
Marker
MercatorCoordinate
NavigationControl
OverscaledTileID
Popup
RGBAImage
RasterDEMTileSource
RasterTileSource
ScaleControl
ScrollZoomHandler
Style
abstract StyleLayer
TapDragZoomHandler
TapZoomHandler
TerrainControl
ThrottledInvoker
Tile
TouchPanHandler
abstract TwoFingersTouchHandler
TwoFingersTouchPitchHandler
TwoFingersTouchRotateHandler
TwoFingersTouchZoomHandler
TwoFingersTouchZoomRotateHandler
VectorTileSource
VideoSource
WorkerPool
Enumerations
Enumerations
MessageType
ResourceType
TextFit
Functions
Functions
addProtocol()
addSourceType()
clearPrewarmedResources()
getMaxParallelImageRequests()
getRTLTextPluginStatus()
getVersion()
getWorkerCount()
getWorkerUrl()
importScriptInWorkers()
prewarm()
removeProtocol()
setMaxParallelImageRequests()
setRTLTextPlugin()
setWorkerCount()
setWorkerUrl()
Interfaces
Interfaces
ActorTarget
AttributeBinder
Bucket
CustomLayerInterface
Handler
IActor
IControl
MousePanHandler
MousePitchHandler
MouseRotateHandler
Source
StyleImageInterface
Type aliases
Type aliases
ActorMessage<T>
AddLayerObject
AddProtocolAction()
Alignment
AnimationOptions
AroundCenterOptions
AttributionControlOptions
CameraForBoundsOptions
CameraOptions
CameraUpdateTransformFunction()
CanvasSourceSpecification
CenterZoomBearing
ClusterIDAndSource
Complete<T>
Config
ControlPosition
Coordinates
CrossFaded<T>
CustomRenderMethod()
CustomRenderMethodInput
DEMEncoding
DashEntry
DistributiveKeys<T>
DistributiveOmit<T, K>
DragPanOptions
DragRotateHandlerOptions
ExpiryData
FeatureIdentifier
FitBoundsOptions
FlyToOptions
FullscreenControlOptions
GeoJSONFeatureDiff
GeoJSONFeatureId
GeoJSONSourceDiff
GeoJSONSourceOptions
GeoJSONWorkerOptions
GeoJSONWorkerSourceLoadDataResult
GeolocateControlOptions
GestureOptions
GetClusterLeavesParams
GetGlyphsParameters
GetGlyphsResponse
GetImagesParameters
GetImagesResponse
GetResourceResponse<T>
GlyphMetrics
GlyphPosition
GlyphPositions
GridKey
HandlerResult
JumpToOptions
Listener()
LngLatBoundsLike
LngLatLike
LoadGeoJSONParameters
LogoControlOptions
MapContextEvent
MapDataEvent
MapEventType
MapGeoJSONFeature
MapLayerEventType
MapLayerMouseEvent
MapLayerTouchEvent
MapLibreEvent<TOrig>
MapLibreZoomEvent
MapOptions
MapSourceDataEvent
MapSourceDataType
MapStyleDataEvent
MapStyleImageMissingEvent
MapTerrainEvent
MarkerOptions
MessageData
NavigationControlOptions
Offset
OverlapMode
PaddingOptions
PluginState
PointLike
PointProjection
PopupOptions
PositionAnchor
PossiblyEvaluatedValue<T>
Projection
QueryRenderedFeaturesOptions
QuerySourceFeatureOptions
RTLPluginStatus
Rect
RemoveSourceParams
RequestParameters
RequestResponseMessageMap
RequestTransformFunction()
RequireAtLeastOne<T>
ScaleControlOptions
Serialized
SerializedObject<S>
SerializedStructArray
SetClusterOptions
SourceClass()
SpriteOnDemandStyleImage
StyleGlyph
StyleImage
StyleImageData
StyleImageMetadata
StyleOptions
StyleSetterOptions
StyleSwapOptions
SymbolQuad
TileParameters
TileState
TransformStyleFunction()
Unit
UpdateImageOptions
UpdateLayersParamaeters
WorkerDEMTileParameters
WorkerTileParameters
WorkerTileResult
Examples
Examples
Overview
Display buildings in 3D
Extrude polygons for 3D indoor mapping
3D Terrain
Add a 3D model with babylon.js
Adding 3D models with three.js on terrain
Add a 3D model with three.js
Add a default marker
Create deck.gl layer using REST API
Add an animated icon to the map
Add a generated icon to the map
Generate and add a missing icon to the map
Add a stretchable image to the map
Add an icon to the map
Animate a line
Animate map camera around a point
Animate a series of images
Animate a marker
Animate a point
Animate a point along a route
Change the default position for attribution
Customize camera animations
Add a canvas source
Center the map on a clicked symbol
Change building color based on zoom level
Change the case of labels
Check if WebGL is supported
Display HTML clusters with custom properties
Create and style clusters
Change a layer's color with buttons
Add Contour Lines
Cooperative gestures
Add custom icons with Markers
Add a custom style layer
Style lines with a data-driven property
Disable map rotation
Disable scroll zoom
Display and style rich text labels
Create a draggable Marker
Create a draggable point
Draw a Circle
Use a fallback image
Add a pattern to a polygon
Filter symbols by text input
Filter symbols by toggling a list
Filter within a Layer
Fit a map to a bounding box
Slowly fly to a location
Fly to a location
View a fullscreen map
Navigate the map with game-like controls
Geocode with Nominatim
Add a new layer below labels
Add a GeoJSON line
Draw GeoJSON points
Add a GeoJSON polygon
Hash routing
Create a heatmap layer
Create a hover effect
Display a non-interactive map
Jump to a series of locations
Change a map's language
Display line that crosses 180th meridian
Create a gradient line using an expression
Add live realtime data
Update a feature in realtime
View local GeoJSON (experimental)
View local GeoJSON
Use locally generated ideographs
Locate the user
Add a raster tile source
Show drawn polygon area
Add support for right-to-left scripts
Draw geometries with terra-draw
Measure distances
Get coordinates of the mouse pointer
Add multiple geometries from one GeoJSON source
Display map navigation controls
Offset the vanishing point using padding
PMTiles source and protocol
Show polygon information on click
Display a popup on click
Display a popup on hover
Display a popup
Get features under the mouse pointer
Render world copies
Restrict map panning to an area
Display a satellite map
Fly to a location based on scroll position
Set pitch and bearing
Attach a popup to a marker instance
Display a map
Sky, Fog, Terrain
Sync movement of multiple maps
Create a time slider
Toggle deck.gl layer
Toggle interactions
Variable label placement
Variable label placement with offset
Add a vector tile source
Add a video
Visualize population density
Add a WMS source
Fit to the bounds of a LineString
Guides
Guides
Guides
Optimising MapLibre Performance: Tips for Large GeoJSON Datasets
MapBox migration guide
Table of contents
Implements
CanonicalTileID
A canonical way to define a tile ID
Implements
ICanonicalTileID
Back to top