ymir
library
Classes
AssetTileProvider
Fetch tiles from the app's shipped assets, where the tile URL is a path
within the asset store
BaseOverlayImage
Display an Image on the map at a specific coordinate location, within an
OverlayImageLayer
BBoxUtils
BearingBetweenTwoGeoPoints
A Bearing Between Two GeoPoints class for calculating bearings between two geographical points
represented by their latitude and longitude coordinates.
BoundingBox
A BoundingBox class for calculating bounding boxes and checking if a point is within a bounding box.
BuiltInMapCachingProvider
Simple built-in map caching using an I/O storage mechanism, for native
(non-web) platforms only
CachedMapTileMetadata
Metadata about a tile cached with a MapCachingProvider
CameraConstraint
Describes a boundary for a MapCamera , that cannot be exceeded by movement
CameraFit
Describes a position for a MapCamera
CartoDBBasemapLight
CentroidCalculator
Places the Polygon.label at the centroid calculated using the
signed area formula
Circle
Circle-base GEO algorithms.
CircleLayer <R extends Object >
A layer that displays a list of CircleMarker on the map
CircleMarker <R extends Object >
Immutable marker options for CircleMarker . Circle markers are a more
simple and performant way to draw markers as the regular Marker
CirclePainter <R extends Object >
The CustomPainter used to draw CircleMarker s for the CircleLayer .
ContainCamera
Constrains the edges of the camera to within bounds
ContainCameraCenter
Constrains the center coordinate of the camera to within bounds
ContainCameraLatitude
Constrains the edges of the camera to within latitudes a and b
Crs
An abstract representation of a
Coordinate Reference System .
Custom CRS for non geographical maps
CursorKeyboardRotationOptions
Options to configure cursor/keyboard rotation
DestinationPoint
A Destination Point class for calculating destination points on the Earth's surface
using the Rhumb Line Destination formula.
DisabledMapCachingProvider
Caching provider which disables built-in caching
Distance
Calculates the distance between points.
DistanceAndBearing
A DistanceAndBearing class for calculating destination points based on a starting point,
a distance, a direction (bearing), and optionally a radius.
DistanceCalculator
DistanceHaversine
Shortcut for
final Distance distance = const Distance(calculator: const Haversine());
DistanceVincenty
Shortcut for
final Distance distance = const Distance(calculator: const Vincenty());
Epsg3857
EPSG:3857, The most common CRS used for rendering maps.
Epsg4326
EPSG:4326, A common CRS among GIS enthusiasts.
Uses simple Equirectangular projection.
EquirectangularApproximation
A Equi- Rectangular Approximation class for calculating the distance
between two geographical points
using the Equirectangular approximation formula.
FadeInTileDisplay
Displays a tile with a fade-in animation
FadeRAWA
Prebuilt animation provider for a RichAttributionWidget
FileTileProvider
Fetch tiles from the local filesystem (not asset store), where the tile URL
is a path within the filesystem.
FitBounds
The CameraFit should fit inside a given LatLngBounds .
FitCoordinates
Use this CameraFit if the MapCamera should fit a list of LatLng
coordinates.
FitInsideBounds
A CameraFit that should get be within given LatLngBounds .
FlutterMap
An interactive geographical map
GeodesicLines
A Geodesic Lines class for calculating geodesic lines, intersections, and projections.
Geodesy
Geodesy class that acts as a wrapper for various geodetic calculations. This class provides a
wide range of geo-spatial functionalities, from calculating distances and bearings to working
with polygons, points, and lines. This can be a valuable utility for geo-spatial applications
GeoJsonDTO
GeoJsonUtils
GeomGeoJson
GeomLine
GeomMultiLine
GeomMultiPolygon
GeomPoint
GeomPolygon
GeoPoints
GoogleMT1SateliteTLR
GreatCirclePoint
A Great Circle Point class for calculating points along the great circle arc
connecting two LatLng points.
Haversine
IGNBuildingsTLR
IGNCadastralParcelsTLR
IGNSateliteTLR
InstantaneousTileDisplay
Displays a tile instantaneously
InteractionOptions
All interactive options for FlutterMap
InteractiveFlag
Use InteractiveFlag to disable / enable certain events Use
InteractiveFlag.all to enable all events, use InteractiveFlag.none to
disable all events
InterractiveLayerHoverBuilder
Will draw the hover map element widget
InterractiveMapLayer
InterractiveMapLayerHover
InterractiveMapLayerTapDown
KeyboardOptions
Options to configure how keyboard keys may be used to control the map
LatLng
Coordinates in Degrees
LatLngBounds
Data structure representing rectangular bounding box constrained by its
northwest and southeast corners
LatLngTween
A Tween object for LatLng . Used for AnimationController to handle
animated changes of the MapCamera .
LayerHitResult <R extends Object >
Result emitted by hit notifiers (see LayerHitNotifier ) when a hit is
detected on an element (such as a Polyline ) within the respective layer
LazyLoadLayerRefresh
LazyloadMapLayer
@Author: David Golay (lancoli on github)
LengthUnit
LogoSourceAttribution
An image attribution permanently displayed adjacent to the open/close icon of
a RichAttributionWidget
MapActionStyling
MapActionTooltip
MapCachingProvider
Provides tile caching facilities to TileProvider s
MapCamera
Describes the view of a map. This includes the size/zoom/position/crs as
well as the minimum/maximum zoom. This class is mostly immutable but has
some fields that get calculated lazily, changes to the map view may occur
via the MapController or user interactions which will result in a
new MapCamera value.
MapCameraActor
MapControlBlock
MapControlBuilder
MapController
Controller to programmatically interact with FlutterMap , such as
controlling it and accessing some of its properties.
MapControllerImpl
Implements MapController whilst exposing methods for internal use which
should not be visible to the user (e.g. for setting the current camera).
This controller is for internal use. All updates to the state should be done
by calling methods of this class to ensure consistency.
MapControlsStyling
MapControlsWidget
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 moved.
MapEventMoveEnd
Event which is fired when dragging is finished
MapEventMoveStart
Event which is fired when dragging is started
MapEventNonRotatedSizeChange
Event that fires when the map widget changes size, e.g. when the app window
gets changed in size.
MapEventRotate
Event which is fired when map is being rotated
MapEventRotateEnd
Event which is fired when rotate gesture has ended
MapEventRotateStart
Event which is fired when rotate gesture was started
MapEventScrollWheelZoom
Event which is fired when scroll wheel is used to zoom
MapEventSecondaryTap
Event which is fired when map is secondary tapped
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
which are not partial (e.g start rotate, rotate, end rotate).
MapLocation
Permet d'ouvrir des menus d'overlays dans l'enfant qu'il controller mais est déclaré via les
MapOptions
All options for the FlutterMap widget.
MapTileSwitchController
This class will help developper to bind action from their parent widget which use OwlnextMap
This allow to bind callback when tile need to be changed
It is the center place where developer can affect the background tile map he needs to display
MapTileSwitcher
MapUtils
Marker
A container for a child widget located at a geographic coordinate point
MarkerLayer
A Marker layer for FlutterMap .
MidPointBetweenTwoPoints
A MidPoint Between Two Points class for calculating the midpoint between two points on the
Earth's surface
specified by their latitude and longitude.
MobileLayerTransformer
Transforms a child widget tree into a layer that can move and rotate based
on the MapCamera
MultiFingerGesture
Use MultiFingerGesture to disable / enable certain gestures Use
MultiFingerGesture.all to enable all gestures, use
MultiFingerGesture.none to disable all gestures
MutableRectangle <T extends num >
A class for representing two-dimensional axis-aligned rectangles with
mutable properties.
NetworkTileProvider
TileProvider to fetch tiles from the network.
OpenTopoMapTLR
OsmTLR
OverlayImage
Unrotated overlay image that spans between a given bounding box.
OverlayImageLayer
OverlayImageLayer is used to display one or multiple images on the map.
OwlnextMap
Path <T extends LatLng >
Path of LatLng values
Point <T extends num >
A utility class for representing two-dimensional positions.
PointRange
A Point Range class for working with geographical points and ranges.
Polygon <R extends Object >
Polygon class, to be used for the PolygonLayer .
PolygonArea
A Polygon Area class for calculating the area of a polygon using the Shoelace formula.
PolygonCentroid
A Polygon Centroid class for finding the centroid of polygons.
PolygonHole
A Polygon Hole class for calculating the area of a polygon with holes.
PolygonIntersection
A PolygonIntersection class for finding the intersection points of two polygons.
PolygonLabelPlacementCalculator
Calculates the position of a Polygon.label within its Polygon in
geographic (lat/lng) space
PolygonLayer <R extends Object >
A polygon layer for FlutterMap .
PolygonsUtils
PolylabelCalculator
Places the Polygon.label at the point furthest away from the outline,
calculated using a Dart implementation of
Mapbox's 'polylabel' algorithm
PolyLine
A PolyLine class for calculating the length of a polyline formed by connecting
multiple points.
Polyline <R extends Object >
Polyline (aka. LineString) class, to be used for the PolylineLayer .
PolylineLayer <R extends Object >
A Polyline (aka. LineString) layer for FlutterMap .
PositionedTapController
PositionedTapDetector2
Proj4Crs
Custom CRS
Projection
The abstract base Projection class, used for coordinate reference
systems like Epsg3857 .
Inherit from this class if you want to create or implement your own CRS.
Random
A generator of random bool, int, or double values.
Rectangle <T extends num >
A class for representing two-dimensional rectangles whose properties are
immutable.
RectangleBounds
Rectangle Bounds class for calculating the bounding rectangle of a set of LatLng points.
RenderTranslucentPointer
A render object that is invisible to its parent during hit testing.
RichAttributionWidget
A prebuilt dynamic attribution layer that supports both logos and text
through SourceAttribution s
RichAttributionWidgetAnimation
Animation provider interface for a RichAttributionWidget
RotatedOverlayImage
Spans an image across three corner points.
Scalebar
The Scalebar widget is a map layer for FlutterMap .
ScalebarPainter
This painter is used in the Scalebar widget and ensures that all
ScalebarPainter s have a function to tell the widget what Size
it should have.
ScaleRAWA
Prebuilt animation provider for a RichAttributionWidget
SimpleAttributionWidget
A simple, classic style, attribution layer
SimpleCentroidCalculator
Places the Polygon.label at the approximate centroid calculated by
averaging all the points of the polygon
SimpleMultiWorldCentroidCalculator
Similar to SimpleCentroidCalculator , but supports correct placement of the
Polygon.label when the polygon lies across the anti-meridian
SourceAttribution
Base class for attributions that render themselves as widgets in a
RichAttributionWidget
SphericalLawOfCosines
A Spherical Law Of Cosines class for calculating the distance between two geographical points
using the Spherical Law of Cosines formula.
SphericalMercator
Spherical mercator projection
StamenMapTLR
StrokePattern
Determines whether a stroke should be solid, dotted, or dashed, and the
exact characteristics of each
TapPosition
TextSourceAttribution
A simple text attribution displayed in the popup box of a
RichAttributionWidget
TileCoordinates
Tile coordinates identify the position of the tile position for
slippy map tiles. The z coordinate represents the zoom level where the
zoom level of 0 fits the complete world while bigger z values are using
accordingly to the zoom level of the MapCamera .
TileCoordinatesResolver
Resolves coordinates in the context of world replications.
TileDisplay
Defines how the tile should get displayed on the map.
TileImage
The tile image class
TileLayer
Describes the needed properties to create a tile-based layer. A tile is an
image bound to a specific geographical position.
TileLayerProvider
TileLayersProvider
TileProvider
The base tile provider, extended by other classes with more specialised
purposes and/or requirements
TileUpdateEvent
Describes whether loading and/or pruning should occur and allows overriding
the load center/zoom.
TileUpdateTransformers
Contains a set of built-in TileUpdateTransformer s
TrackDistance
Track Distance class for calculating the signed distance between a
geographical point and the great circle defined by a start and end point.
TranslucentPointer
A widget that is invisible for its parent during hit testing, but still
allows its subtree to receive pointer events
UnconstrainedCamera
Does not apply any constraint to a MapCamera
Vincenty
VincentyDistance
Vincenty Distance class for calculating geodesic distances between two points on
the surface of an ellipsoid using the Vincenty formula.
WMSTileLayerOptions
Options for the []
WorldTopoMapTLR
YmirDebug
This class serves to setup the debug message you want to see in console
Functions
acos (num x → double
Converts x to a double and returns its arc cosine in radians.
asin (num x → double
Converts x to a double and returns its arc sine in radians.
atan (num x → double
Converts x to a double and returns its arc tangent in radians.
atan2 (num a , num b → double
A variant of atan .
coordinateDebugTileBuilder (BuildContext context , Widget tileWidget , TileImage tile → Widget
Shows coordinates over Tiles
cos (num radians → double
Converts radians to a double and returns the cosine of the value.
darkModeTileBuilder (BuildContext context , Widget tileWidget , TileImage 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 → Widget
Applies inversion color matrix on Tiles container which may simulate Dark mode.
decimal2sexagesimal (double dec → String
Converts a decimal coordinate value to sexagesimal format
degToRadian (double deg → double
Converts degree to radian
exp (num x → double
Converts x to a double and returns the natural exponent, e ,
to the power x.
loadingTimeDebugTileBuilder (BuildContext context , Widget tileWidget , TileImage tile → Widget
Shows the Tile loading time in ms
log (num x → double
Converts x to a double and returns the natural logarithm of the value.
max <T extends num > (T a , T b → T
Returns the larger of two numbers.
min <T extends num > (T a , T b → T
Returns the lesser of two numbers.
normalizeBearing (double bearing → double
Convert a bearing to be within the 0 to +360 degrees range.
Compass bearing is in the rangen 0° ... 360°
pow (num x , num exponent → num
Returns x to the power of exponent.
radianToDeg (double rad → double
Radian to degree
round (double value , {int decimals = 6 → double
Rounds value to given number of decimals
sexagesimal2decimal (String str → double
Converts a string coordinate value in sexagesimal format to decimal
sin (num radians → double
Converts radians to a double and returns the sine of the value.
sqrt (num x → double
Converts x to a double and returns the positive square root of the
value.
tan (num radians → double
Converts radians to a double and returns the tangent of the value.
zeroPad (num number → String
Pads a number with a single zero, if it is less than 10
Typedefs
CachedMapTile {Uint8List bytes , CachedMapTileMetadata metadata }
A tile's bytes and metadata returned from MapCachingProvider.getTile
ErrorTileCallBack
= void Function(TileImage tile , Object error , StackTrace ?stackTrace
Callback definition for the TileLayer.errorTileCallback option.
IsKeyCursorRotationTrigger
= bool Function(LogicalKeyboardKey key
See CursorKeyboardRotationOptions.isKeyTrigger
LatLngFactory
= LatLng Function(double latitude , double longitude
Necessary for creating new instances T extends LatLng (Path
LayerHitNotifier R extends Object >
= ValueNotifier <LayerHitResult <R > ?
A ValueNotifier that notifies:
LongPressCallback
= void Function(TapPosition tapPosition , LatLng point
Callback to notify when the map emits long-press gesture
MapEventCallback
= void Function(MapEvent
Callback to notify when the map emits a MapEvent .
PointerCancelCallback
= void Function(PointerCancelEvent event , LatLng point
Callback to notify when the map registers a pointer cancel event.
PointerDownCallback
= void Function(PointerDownEvent event , LatLng point
Callback to notify when the map registers a pointer down event.
PointerHoverCallback
= void Function(PointerHoverEvent event , LatLng point
Callback to notify when the map registers a pointer hover event.
PointerUpCallback
= void Function(PointerUpEvent event , LatLng point
Callback to notify when the map registers a pointer up event.
PositionCallback
= void Function(MapCamera camera , bool hasGesture
Callback that gets called when the viewport of the map changes.
TapCallback
= void Function(TapPosition tapPosition , LatLng point
Callback to notify when the map registers a confirmed short tap gesture.
TapPositionCallback
= void Function(TapPosition position
TileBuilder
= Widget Function(BuildContext context , Widget tileWidget , TileImage tile
Builder function that returns a TileBuilder instance.
TileUpdateTransformer StreamTransformer <TileUpdateEvent TileUpdateEvent
Restricts and limits TileUpdateEvent s (which are emitted 'by' MapEvent s),
which cause the tiles of the TileLayer to update (see below).
Exceptions / Errors
CachedMapTileReadFailure
Indicates that the tile with the given URL was present in the cache, but
could not be correctly read
