Svelte MapLibre GL

Docs Examples API Reference

API Reference

Map

  • MapLibre
  • Image
  • Light
  • Projection
  • Sky
  • Sprite
  • Terrain

Sources

  • CanvasSource
  • FeatureState
  • GeoJSONSource
  • ImageSource
  • RasterDEMTileSource
  • RasterTileSource
  • RawSource
  • VectorTileSource
  • VideoSource
  • MapLibreContourSource (ext)

Layers

  • BackgroundLayer
  • CircleLayer
  • CustomLayer
  • FillExtrusionLayer
  • HeatmapLayer
  • HillshadeLayer
  • LineLayer
  • RasterLayer
  • RawLayer
  • SymbolLayer

Global

  • Protocol
  • PMTilesProtocol (ext)

Marker

  • Marker
  • Popup

Controls

  • AttributionControl
  • CustomControl
  • FullScreenControl
  • GeolocateControl
  • GlobeControl
  • Hash
  • LogoControl
  • NavigationControl
  • ScaleControl
  • TerrainControl
  • DeckGLOverlay (ext)
  • TerraDraw (ext)

Utilities

  • ImageLoader
  • QueryRenderedFeatures
  • QuerySourceFeatures
  1. API Reference
  2. Image

Image

API Reference (beta) for <Image />

Property Type Description
id
required
string
-
image
required
HTMLImageElement | ImageBitmap | ImageData | {
  width: number,
  height: number,
  data: Uint8ClampedArray<ArrayBuffer | SharedArrayBuffer> | Uint8Array<ArrayBuffer | SharedArrayBuffer>
} | {
  width: number,
  height: number,
  data: Uint8ClampedArray<ArrayBuffer | SharedArrayBuffer> | Uint8Array<ArrayBuffer | SharedArrayBuffer>,
  render?: () => boolean,
  onAdd?: (map: Map, id: string) => void,
  onRemove?: () => void
}
-
options
optional
Partial<StyleImageMetadata>
-
On This Page

© 2025 Svelte Maplibre GL contributors

Svelte MapLibre GL

Docs

Overview

  • Quickstart

Examples

Basic

  • Plain Map
  • Complex
  • Marker and Popup
  • Change Base Style
  • Hover Styles
  • Clusters
  • Limit Map Interactions
  • Animate a Series of Images
  • Video on a Map
  • Fullscreen
  • Locate the User
  • Change Cursor
  • 3D Buildings

Styles

  • 3D Terrain and Sky
  • Globe with an Atmosphere

Utilities

  • Load Images from URLs
  • Query Features

Techniques

  • Side by Side
  • 3D Floor Plan

Advanced

  • Custom Control
  • Custom Protocols
  • Canvas Source
  • Custom Layer
  • Dynamic Image
  • 3D model with three.js

Extensions

  • PMTiles Protocol
  • deck.gl Overlay
  • Contour Lines
  • Terra Draw

API Reference

Map

  • MapLibre
  • Image
  • Light
  • Projection
  • Sky
  • Sprite
  • Terrain

Sources

  • CanvasSource
  • FeatureState
  • GeoJSONSource
  • ImageSource
  • RasterDEMTileSource
  • RasterTileSource
  • RawSource
  • VectorTileSource
  • VideoSource
  • MapLibreContourSource (ext)

Layers

  • BackgroundLayer
  • CircleLayer
  • CustomLayer
  • FillExtrusionLayer
  • HeatmapLayer
  • HillshadeLayer
  • LineLayer
  • RasterLayer
  • RawLayer
  • SymbolLayer

Global

  • Protocol
  • PMTilesProtocol (ext)

Marker

  • Marker
  • Popup

Controls

  • AttributionControl
  • CustomControl
  • FullScreenControl
  • GeolocateControl
  • GlobeControl
  • Hash
  • LogoControl
  • NavigationControl
  • ScaleControl
  • TerrainControl
  • DeckGLOverlay (ext)
  • TerraDraw (ext)

Utilities

  • ImageLoader
  • QueryRenderedFeatures
  • QuerySourceFeatures