maplibre_gl library
This library contains the MapLibre GL plugin for Flutter.
To display a map, add a MapLibreMap widget to the widget tree.
In this plugin, the map is configured through the parameters passed to the MapLibreMap constructor and through the MapLibreMapController. The MapLibreMapController is provided at runtime by the MapLibreMap.onMapCreated callback. The controller also allows adding annotations (icons, lines etc.) to the map at runtime and provides some callbacks to get notified when the user clicks those.
The visual appearance of the map is configured through a MapLibre style passed to the
styleString parameter of the MapLibreMap constructor.
The MapLibre style is a JSON document following the specification at https://maplibre.org/maplibre-style-spec/.
The following is supposed to serve as a short introduction to the MapLibre style specification:
The style document contains (among other things) sources and layers.
Sources determine which data is displayed on the map, layers determine how the data is displayed.
Typical types of sources are raster and vector tiles, as well as GeoJson data. For raster and vector tiles, the entire world is divided into a set of tiles in different zoom levels. Depending on the map's zoom level and viewport, the MapLibre client libraries decide, which tiles are needed to fill the viewport and request them from the source.
The difference between raster and vector tiles is that raster tiles are images that are pre-rendered on a server, whereas vector tiles contain raw geometric information that is rendered on the client. Vector tiles are in the Mapbox Vector Tile (MVT) format, the de-facto standard for vector tiles that is implemented by multiple libraries.
Vector tiles have a number of advantages over raster tiles, including (often) smaller size, the possibility to style them dynamically at runtime (e.g. change the color or visibility of certain features), and the possibility to rotate them and keep text labels horizontal. Raster and vector tiles can be generated from a variety of sources, including OpenStreetMap data and are also available from a number of providers.
Raster sources are displayed by adding a "raster" layer to the MapLibre GL style. Vector and GeoJson sources are displayed by adding a "line", "fill", "symbol" or "circle" layer to the MapLibre GL style and specifying which source to use (by setting the "source" property of the layer to the id of the source) as well as how to style the data by setting other properties of the layer such as "line-color" or "fill-outline-color". For example, a vector source layer (or a GeoJson source layer) with the outlines of countries could be displayed both by a fill layer to fill the countries with a color and by a line layer to draw the outlines of the countries.
Classes
- Annotation
-
AnnotationManager<
T extends Annotation> -
ArgumentCallbacks<
T> -
Mutable collection of
ArgumentCallbackinstances, itself anArgumentCallback. - CameraPosition
- The position of the map "camera", the view point from which the world is shown in the map view. Aggregates the camera's target geographical location, its zoom level, tilt angle, and bearing.
- CameraTargetBounds
-
Bounds for the map camera target.
Used with
_MapLibreMapOptionsto wrap a LatLngBounds value. This allows distinguishing between specifying an unbounded target (nullLatLngBounds) from not specifying anything (nullCameraTargetBounds). - CameraUpdate
- Defines a camera move, supporting absolute moves as well as moves relative the current position.
- Circle
- CircleLayerProperties
- CircleManager
- CircleOptions
- Configuration options for Circle instances.
- DownloadRegionStatus
- Error
- Expressions
- Fill
- FillExtrusionLayerProperties
- FillLayerProperties
- FillManager
- FillOptions
- Configuration options for Fill instances.
- GeojsonSourceProperties
- HeatmapLayerProperties
- HillshadeLayerProperties
- ImageSourceProperties
- InProgress
- LatLng
- A pair of latitude and longitude coordinates, stored as degrees.
- LatLngBounds
- A latitude/longitude aligned rectangle.
- LatLngQuad
- A geographical area representing a non-aligned quadrilateral This class does not wrap values to the world bounds
- LayerProperties
- Line
- LineLayerProperties
- LineManager
- LineOptions
- Configuration options for Line instances.
- MapLibreMap
- Shows a MapLibre map. Also refer to the documentation of maplibre_gl and MapLibreMapController.
- MapLibreMapController
- Controller for a single MapLibreMap instance running on the host platform.
- MapLibreMethodChannel
- MapLibrePlatform
- MapLibreStyles
- MapLibre styles used mostly for demonstration.
- MinMaxZoomPreference
-
Preferred bounds for map camera zoom level.
Used with
_MapLibreMapOptionsto wrap min and max zoom. This allows distinguishing between specifying unbounded zooming (null minZoom and maxZoom) from not specifying anything (null MinMaxZoomPreference). - OfflineRegion
- Description of a downloaded region including its identifier.
- OfflineRegionDefinition
- Description of region to be downloaded. Identifier will be generated when the download is initiated.
- RasterDemSourceProperties
- RasterLayerProperties
- RasterSourceProperties
- SourceProperties
- Success
- Symbol
- SymbolLayerProperties
- SymbolManager
- SymbolOptions
- Configuration options for Symbol instances.
- UserHeading
- Type represents a geomagnetic value, measured in microteslas, relative to a device axis in three dimensional space.
- UserLocation
- User's observed location
- VectorSourceProperties
- VideoSourceProperties
Enums
- AnnotationType
- AttributionButtonPosition
- Attribution Button Position
- CompassViewPosition
- Compass View Position
- DragEventType
- MyLocationRenderMode
- Specifies if and how the user's heading/bearing is rendered in the user location indicator.
- MyLocationTrackingMode
- The camera mode, which determines how the map camera will track the rendered location.
Extensions
Functions
-
buildFeatureCollection(
List< Map< features) → Map<String, dynamic> >String, dynamic> -
deleteOfflineRegion(
int id) → Future -
downloadOfflineRegion(
OfflineRegionDefinition definition, {Map< String, dynamic> metadata = const {}, dynamic onEvent(DownloadRegionStatus event)?}) → Future<OfflineRegion> -
getListOfRegions(
) → Future< List< OfflineRegion> > -
getRandomString(
[int length = 10]) → String -
installOfflineMapTiles(
String tilesDb) → Future< void> - Copy tiles db file passed in to the tiles cache directory (sideloaded) to make tiles available offline.
-
mergeOfflineRegions(
String path) → Future< List< OfflineRegion> > -
setHttpHeaders(
Map< String, String> headers) → Future<void> -
setOffline(
bool offline) → Future -
setOfflineTileCountLimit(
int limit) → Future -
updateOfflineRegionMetadata(
int id, Map< String, dynamic> metadata) → Future<OfflineRegion>
Typedefs
- MapCreatedCallback = void Function(MapLibreMapController controller)
- MaplibreMap = MapLibreMap
- MaplibreMapController = MapLibreMapController
- MaplibreStyles = MapLibreStyles
- OnCameraIdleCallback = void Function()
- OnCameraTrackingChangedCallback = void Function(MyLocationTrackingMode mode)
- OnCameraTrackingDismissedCallback = void Function()
-
OnFeatureDragnCallback
= void Function(dynamic id, {required LatLng current, required LatLng delta, required DragEventType eventType, required LatLng origin, required Point<
double> point}) -
OnFeatureInteractionCallback
= void Function(dynamic id, Point<
double> point, LatLng coordinates) -
OnMapClickCallback
= void Function(Point<
double> point, LatLng coordinates) - OnMapIdleCallback = void Function()
-
OnMapLongClickCallback
= void Function(Point<
double> point, LatLng coordinates) - OnPlatformViewCreatedCallback = void Function(int)
- The default instance of MapLibrePlatform to use.
- OnStyleLoadedCallback = void Function()
- OnUserLocationUpdated = void Function(UserLocation location)