GoogleMapsFlutterPlatform class abstract

The interface that platform-specific implementations of google_maps_flutter must extend.

Avoid implements of this interface. Using implements makes adding any new methods here a breaking change for end users of your platform!

Do extends GoogleMapsFlutterPlatform instead, so new methods added here are inherited in your code with the default implementation (that throws at runtime), rather than breaking your users at compile time.

Inheritance
  • Object
  • PlatformInterface
  • GoogleMapsFlutterPlatform
Implementers

Constructors

GoogleMapsFlutterPlatform()
Constructs a GoogleMapsFlutterPlatform.

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

animateCamera(CameraUpdate cameraUpdate, {required int mapId}) Future<void>
Starts an animated change of the map camera position.
buildView(int creationId, PlatformViewCreatedCallback onPlatformViewCreated, {required CameraPosition initialCameraPosition, Set<Marker> markers = const <Marker>{}, Set<Polygon> polygons = const <Polygon>{}, Set<Polyline> polylines = const <Polyline>{}, Set<Circle> circles = const <Circle>{}, Set<TileOverlay> tileOverlays = const <TileOverlay>{}, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers = const <Factory<OneSequenceGestureRecognizer>>{}, Map<String, dynamic> mapOptions = const <String, dynamic>{}}) Widget
Returns a widget displaying the map view - deprecated, use buildViewWithConfiguration instead.
buildViewWithConfiguration(int creationId, PlatformViewCreatedCallback onPlatformViewCreated, {required MapWidgetConfiguration widgetConfiguration, MapConfiguration mapConfiguration = const MapConfiguration(), MapObjects mapObjects = const MapObjects()}) Widget
Returns a widget displaying the map view.
buildViewWithTextDirection(int creationId, PlatformViewCreatedCallback onPlatformViewCreated, {required CameraPosition initialCameraPosition, required TextDirection textDirection, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers, Set<Marker> markers = const <Marker>{}, Set<Polygon> polygons = const <Polygon>{}, Set<Polyline> polylines = const <Polyline>{}, Set<Circle> circles = const <Circle>{}, Set<TileOverlay> tileOverlays = const <TileOverlay>{}, Map<String, dynamic> mapOptions = const <String, dynamic>{}}) Widget
Returns a widget displaying the map view - deprecated, use buildViewWithConfiguration instead.
clearTileCache(TileOverlayId tileOverlayId, {required int mapId}) Future<void>
Clears the tile cache so that all tiles will be requested again from the TileProvider.
dispose({required int mapId}) → void
Dispose of whatever resources the mapId is holding on to.
enableDebugInspection() → void
Populates GoogleMapsFlutterInspectorPlatform.instance to allow inspecting the platform map state.
getLatLng(ScreenCoordinate screenCoordinate, {required int mapId}) Future<LatLng>
Returns LatLng corresponding to the ScreenCoordinate in the current map view.
getScreenCoordinate(LatLng latLng, {required int mapId}) Future<ScreenCoordinate>
Return ScreenCoordinate of the LatLng in the current map view.
getStyleError({required int mapId}) Future<String?>
If the last attempt to set the style via MapConfiguration.style failed, returns the error information, otherwise returns null.
getVisibleRegion({required int mapId}) Future<LatLngBounds>
Return the region that is visible in a map.
getZoomLevel({required int mapId}) Future<double>
Returns the current zoom level of the map.
hideMarkerInfoWindow(MarkerId markerId, {required int mapId}) Future<void>
Programmatically hide the Info Window for a Marker.
init(int mapId) Future<void>
/// Initializes the platform interface with id.
isMarkerInfoWindowShown(MarkerId markerId, {required int mapId}) Future<bool>
Returns true when the InfoWindow is showing, false otherwise.
moveCamera(CameraUpdate cameraUpdate, {required int mapId}) Future<void>
Changes the map camera position.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onCameraIdle({required int mapId}) Stream<CameraIdleEvent>
The Camera is now idle.
onCameraMove({required int mapId}) Stream<CameraMoveEvent>
The Camera finished moving to a new CameraPosition.
onCameraMoveStarted({required int mapId}) Stream<CameraMoveStartedEvent>
The Camera started moving.
onCircleTap({required int mapId}) Stream<CircleTapEvent>
A Circle has been tapped.
onClusterTap({required int mapId}) Stream<ClusterTapEvent>
A marker icon managed by ClusterManager has been tapped.
onInfoWindowTap({required int mapId}) Stream<InfoWindowTapEvent>
An InfoWindow has been tapped.
onLongPress({required int mapId}) Stream<MapLongPressEvent>
A Map has been long-pressed at a certain LatLng.
onMarkerDrag({required int mapId}) Stream<MarkerDragEvent>
A Marker has been dragged to a different LatLng position.
onMarkerDragEnd({required int mapId}) Stream<MarkerDragEndEvent>
A Marker has been dragged to a different LatLng position.
onMarkerDragStart({required int mapId}) Stream<MarkerDragStartEvent>
A Marker has been dragged to a different LatLng position.
onMarkerTap({required int mapId}) Stream<MarkerTapEvent>
A Marker has been tapped.
onPolygonTap({required int mapId}) Stream<PolygonTapEvent>
A Polygon has been tapped.
onPolylineTap({required int mapId}) Stream<PolylineTapEvent>
A Polyline has been tapped.
onTap({required int mapId}) Stream<MapTapEvent>
A Map has been tapped at a certain LatLng.
setMapStyle(String? mapStyle, {required int mapId}) Future<void>
Sets the styling of the base map.
showMarkerInfoWindow(MarkerId markerId, {required int mapId}) Future<void>
Programmatically show the Info Window for a Marker.
takeSnapshot({required int mapId}) Future<Uint8List?>
Returns the image bytes of the map.
toString() String
A string representation of this object.
inherited
updateCircles(CircleUpdates circleUpdates, {required int mapId}) Future<void>
Updates circle configuration.
updateClusterManagers(ClusterManagerUpdates clusterManagerUpdates, {required int mapId}) Future<void>
Updates cluster manager configuration.
updateMapConfiguration(MapConfiguration configuration, {required int mapId}) Future<void>
Updates configuration options of the map user interface.
updateMapOptions(Map<String, dynamic> optionsUpdate, {required int mapId}) Future<void>
Updates configuration options of the map user interface - deprecated, use updateMapConfiguration instead.
updateMarkers(MarkerUpdates markerUpdates, {required int mapId}) Future<void>
Updates marker configuration.
updatePolygons(PolygonUpdates polygonUpdates, {required int mapId}) Future<void>
Updates polygon configuration.
updatePolylines(PolylineUpdates polylineUpdates, {required int mapId}) Future<void>
Updates polyline configuration.
updateTileOverlays({required Set<TileOverlay> newTileOverlays, required int mapId}) Future<void>
Updates tile overlay configuration.

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

instance GoogleMapsFlutterPlatform
The default instance of GoogleMapsFlutterPlatform to use.
getter/setter pair