plugin_api library

Classes

Anchor
AnchorPos<T>
AssetTileProvider
AttributionWidget
Attribution widget layer, usually placed in nonRotatedChildren
BaseOverlayImage
Base class for all overlay images.
Bounds<T extends num>
Rectangular bound delimited by orthogonal lines passing through two points.
CenterZoom
Geographical point with applied zoom level
CircleLayer
CircleLayerOptions
CircleLayerWidget
CircleMarker
CirclePainter
Coords<T extends num>
Crs
An abstract representation of a Coordinate Reference System.
CrsSimple
CustomPoint<T extends num>
Data represenation of point located on map instance where x is horizontal and y is vertical pixel value
CustomTileProvider
A very basic TileProvider implementation, that can be extended to create your own provider
Earth
Epsg3857
The most common CRS used for rendering maps.
Epsg4326
A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.
FileTileProvider
TileProvider that uses FileImage internally on platforms other than web
FitBoundsOptions
FlutterMap
Renders a map composed of a list of layers powered by LayerOptions.
GroupLayer
GroupLayerOptions
LayerOptions that describe a layer composed by multiple built-in layers.
GroupLayerWidget
InteractiveFlag
Use InteractiveFlag to disable / enable certain events Use InteractiveFlag.all to enable all events, use InteractiveFlag.none to disable all events
LatLngBounds
Data structure representing rectangular bounding box constrained by its northwest and southeast corners
LayerOptions
Common type between all LayerOptions.
MapController
Controller to programmatically interact with FlutterMap.
MapControllerImpl
MapEvent
Base event class which is emitted by MapController instance, the event is usually related to performed gesture on the map itself or it can be an event related to map configuration
MapEventDoubleTapZoom
Event which is fired when map is double tapped
MapEventDoubleTapZoomEnd
Event which is fired when animation for double tap gesture ends
MapEventDoubleTapZoomStart
Event which is fired when animation for double tap gesture is started
MapEventFlingAnimation
Event which is fired when animation started by fling gesture is in progress
MapEventFlingAnimationEnd
Event which is fired when animation started by fling gesture finished
MapEventFlingAnimationNotStarted
Emits when InteractiveFlags contains fling and there wasn't enough velocity to start fling animation
MapEventFlingAnimationStart
Event which is fired when fling gesture is detected
MapEventLongPress
Event which is fired when map is long-pressed
MapEventMove
Event which is fired when map is being dragged
MapEventMoveEnd
Event which is fired when dragging is finished
MapEventMoveStart
Event which is fired when dragging is started
MapEventRotate
Event which is fired when map is being rotated
MapEventRotateEnd
MapEventRotateStart
Event which is fired when rotate gesture was started
MapEventScrollWheelZoom
Event which is fired when scroll wheel is used to zoom
MapEventTap
Event which is fired when map is tapped
MapEventWithMove
Base event class which is emitted by MapController instance and includes information about camera movement
MapOptions
Allows you to provide your map's starting properties for zoom, rotation and center. Alternatively you can provide bounds instead of center. If both, center and bounds are provided, bounds will take preference over center. Zoom, pan boundary and interactivity constraints can be specified here too.
MapPlugin
MapPosition
Position's type for PositionCallback.
MapState
Marker
Marker object that is rendered by MarkerLayerWidget
MarkerLayer
MarkerLayerOptions
Configuration for marker layer
MarkerLayerWidget
MoveAndRotateResult
MultiFingerGesture
Use MultiFingerGesture to disable / enable certain gestures Use MultiFingerGesture.all to enable all gestures, use MultiFingerGesture.none to disable all gestures
NetworkNoRetryTileProvider
TileProvider that uses FMNetworkNoRetryImageProvider internally
NetworkTileProvider
TileProvider that uses FMNetworkImageProvider internally
NonCachingNetworkTileProvider
Deprecated due to internal refactoring. The name is misleading, as the internal ImageProvider always caches, and this is recommended by most tile servers anyway. For the same functionality, migrate to NetworkNoRetryTileProvider before the next minor update.
OverlayImage
Unrotated overlay image that spans between a given bounding box.
OverlayImageLayer
OverlayImageLayerOptions
OverlayImageLayerWidget
Polygon
PolygonLayer
PolygonLayerOptions
PolygonLayerWidget
PolygonPainter
Polyline
PolylineLayer
PolylineLayerOptions
PolylineLayerWidget
PolylinePainter
Proj4Crs
Custom CRS
Projection
RotatedOverlayImage
Spans an image across three corner points.
SphericalMercator
Tile
TileLayer
TileLayerOptions
Describes the needed properties to create a tile-based layer. A tile is an image bound to a specific geographical position.
TileLayerWidget
TileProvider
The base tile provider implementation, extended by other classes such as NetworkTileProvider
Transformation
WMSTileLayerOptions

Enums

AnchorAlign
EvictErrorTileStrategy
MapEventSource
Event sources which are used to identify different types of MapEvent events
PolygonLabelPlacement

Functions

coordinateDebugTileBuilder(BuildContext context, Widget tileWidget, Tile tile) Widget
Shows coordinates over Tiles
darkModeTileBuilder(BuildContext context, Widget tileWidget, Tile tile) Widget
Applies inversion color matrix on Tiles which may simulate Dark mode. darkModeTilesContainerBuilder is better at performance because it applies color matrix on the container instead of on every Tile
darkModeTilesContainerBuilder(BuildContext context, Widget tilesContainer, List<Tile> tiles) Widget
Applies inversion color matrix on Tiles container which may simulate Dark mode.
loadingTimeDebugTileBuilder(BuildContext context, Widget tileWidget, Tile tile) Widget
Shows the Tile loading time in ms

Typedefs

ErrorTileCallBack = void Function(Tile tile, dynamic error)
LongPressCallback = void Function(TapPosition tapPosition, LatLng point)
MapCreatedCallback = void Function(MapController mapController)
PointerCancelCallback = void Function(PointerCancelEvent event, LatLng point)
PointerDownCallback = void Function(PointerDownEvent event, LatLng point)
PointerHoverCallback = void Function(PointerHoverEvent event, LatLng point)
PointerUpCallback = void Function(PointerUpEvent event, LatLng point)
PositionCallback = void Function(MapPosition position, bool hasGesture)
TapCallback = void Function(TapPosition tapPosition, LatLng point)
TemplateFunction = String Function(String str, Map<String, String> data)
TileBuilder = Widget Function(BuildContext context, Widget tileWidget, Tile tile)
TileReady = void Function(Coords<double> coords, dynamic error, Tile tile)
TilesContainerBuilder = Widget Function(BuildContext context, Widget tilesContainer, List<Tile> tiles)