Google Maps for Flutter

https://pub.dev/documentation/google_maps_flutter/latest
Admin
A Flutter plugin that provides a Google Maps widget, allowing developers to integrate Google Maps...
Tokens:44,863
Snippets:716
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### PinConfig

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/PinConfig-class.html

Documentation for the PinConfig class, including its constructor, properties, methods, constants, and usage examples.

```APIDOC
## PinConfig

### Description
Represents a BitmapDescriptor that is created from a pin configuration. Can only be used with AdvancedMarkers. The backgroundColor and borderColor are used to define the color of the standard pin marker. The glyph parameter is used to define the glyph that is displayed on the pin marker (default glyph is a circle).

### Constructor
`PinConfig({Color? backgroundColor, Color? borderColor, AdvancedMarkerGlyph? glyph})`

Constructs a PinConfig that is created from a pin configuration.

### Properties
- **backgroundColor** (Color?) - The background color of the pin.
- **borderColor** (Color?) - The border color of the pin.
- **glyph** (AdvancedMarkerGlyph?) - The glyph that is displayed on the pin marker. If null, the default circular glyph is used.

### Methods
- **toJson()** → Object - Convert the object to a Json format.

### Constants
- **type** → const String - The type of the MapBitmap object, used for the JSON serialization.

### Example: Change colors of the default map pin to white and blue
```dart
PinConfig(
  backgroundColor: Colors.blue,
  borderColor: Colors.white,
  glyph: CircleGlyph(color: Colors.blue)
)
```

### Example: Customize a marker pin by showing a short text on the pin
```dart
PinConfig(
  backgroundColor: Colors.blue,
  glyph: TextGlyph(text: 'Pin', textColor: Colors.white)
)
```

### Example: Customize a marker pin by showing a custom image on the pin
```dart
PinConfig(
  glyph: BitmapGlyph(
    bitmap: await BitmapDescriptor.asset(
      ImageConfiguration(size: Size(12, 12)),
      'assets/cat.png',
    ),
  ),
)
```

### Warning
On iOS, using a PinConfig may result in the marker not showing. For details and updates, see https://issuetracker.google.com/issues/370536110. If this issue has not been fixed in the version of the Google Maps SDK you are using, consider using an asset or bitmap for customization on iOS.
```

--------------------------------

### GroundOverlay.bounds example

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/GroundOverlay-class.html

Creates a ground overlay using exact corner bounds. Requires bitmapScaling: MapBitmapScaling.none. Use for precise placement.

```dart
GroundOverlay.bounds(
  groundOverlayId: const GroundOverlayId('overlay_id'),
  image: await AssetMapBitmap.create(
    createLocalImageConfiguration(context),
    'assets/images/ground_overlay.png',
    bitmapScaling: MapBitmapScaling.none,
  ),
  bounds: LatLngBounds(
    southwest: LatLng(37.42, -122.08),
    northeast: LatLng(37.43, -122.09),
  ),
);
```

--------------------------------

### GroundOverlay.position example

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/GroundOverlay-class.html

Creates a ground overlay using a position with width, height, and zoomLevel. Requires bitmapScaling: MapBitmapScaling.none. Use when bounds are not needed.

```dart
GroundOverlay.position(
  groundOverlayId: const GroundOverlayId('overlay_id'),
  image: await AssetMapBitmap.create(
    createLocalImageConfiguration(context),
    'assets/images/ground_overlay.png',
    bitmapScaling: MapBitmapScaling.none,
  ),
  position: LatLng(37.42, -122.08),
  width: 100,
  height: 100,
  zoomLevel: 14,
);
```

--------------------------------

### Show a map with GoogleMap and animate camera

Source: https://pub.dev/documentation/google_maps_flutter/latest/index.html

Complete example of a StatefulWidget that displays a GoogleMap with a hybrid map type and a floating action button to animate the camera to a predefined lake location. The GoogleMap widget must be used within a widget with a bounded size; using it in an unbounded widget throws a Flutter exception. The map is controlled via the GoogleMapController passed to the onMapCreated callback.

```dart
class MapSample extends StatefulWidget {
  const MapSample({super.key});

  @override
  State<MapSample> createState() => MapSampleState();
}

class MapSampleState extends State<MapSample> {
  final Completer<GoogleMapController> _controller = Completer<GoogleMapController>();

  static const CameraPosition _kGooglePlex = CameraPosition(
    target: LatLng(37.42796133580664, -122.085749655962),
    zoom: 14.4746,
  );

  static const CameraPosition _kLake = CameraPosition(
    bearing: 192.8334901395799,
    target: LatLng(37.43296265331129, -122.08832357078792),
    tilt: 59.440717697143555,
    zoom: 19.151926040649414,
  );

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: GoogleMap(
        mapType: MapType.hybrid,
        initialCameraPosition: _kGooglePlex,
        onMapCreated: (GoogleMapController controller) {
          _controller.complete(controller);
        },
      ),
      floatingActionButton: FloatingActionButton.extended(
        onPressed: _goToTheLake,
        label: const Text('To the lake!'),
        icon: const Icon(Icons.directions_boat),
      ),
    );
  }

  Future<void> _goToTheLake() async {
    final GoogleMapController controller = await _controller.future;
    await controller.animateCamera(CameraUpdate.newCameraPosition(_kLake));
  }
}
```

--------------------------------

### Cap.customCapFromBitmap

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/Cap-class.html

Constructs a new CustomCap with a bitmap overlay centered at the start or end vertex of a Polyline, orientated according to the direction of the line's first or last edge and scaled with respect to the line's stroke width.

```APIDOC
## Cap.customCapFromBitmap

### Description
Constructs a new CustomCap with a bitmap overlay centered at the start or end vertex of a Polyline, orientated according to the direction of the line's first or last edge and scaled with respect to the line's stroke width.

### Method
Static Method

### Signature
```dart
static Cap customCapFromBitmap(BitmapDescriptor bitmapDescriptor, {double refWidth = 10})
```

### Parameters
- **bitmapDescriptor** (BitmapDescriptor) - Required - The bitmap descriptor for the custom cap.
- **refWidth** (double) - Optional - The reference width for scaling the bitmap. Defaults to 10.

### Returns
- **Cap** - A new CustomCap instance.

### Example
```dart
final cap = Cap.customCapFromBitmap(bitmapDescriptor, refWidth: 20);
```
```

--------------------------------

### Cap.buttCap

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/Cap-class.html

Cap that is squared off exactly at the start or end vertex of a Polyline with solid stroke pattern, equivalent to having no additional cap beyond the start or end vertex.

```APIDOC
## Cap.buttCap

### Description
Cap that is squared off exactly at the start or end vertex of a Polyline with solid stroke pattern, equivalent to having no additional cap beyond the start or end vertex.

### Type
Constant

### Value
```dart
const Cap buttCap
```

### Example
```dart
final cap = Cap.buttCap;
```
```

--------------------------------

### point property

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/WeightedLatLng-class.html

Gets the geographical data point.

```APIDOC
## point → LatLng

### Description
The geographical data point. This is a final property.

### Returns
- **LatLng** - The geographical data point.

### Example
```dart
final latLng = weighted.point;
```
```

--------------------------------

### InfoWindow constructor

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/InfoWindow-class.html

Constructor for creating an InfoWindow instance with optional title, snippet, anchor, and onTap callback.

```APIDOC
## InfoWindow({String? title, String? snippet, Offset anchor = const Offset(0.5, 0.0), VoidCallback? onTap})

### Description
Creates an immutable representation of a label on for Marker.

### Constructor Parameters
- **title** (String?) - Optional - Text displayed in an info window when the user taps the marker.
- **snippet** (String?) - Optional - Additional text displayed below the title.
- **anchor** (Offset) - Optional - The icon image point that will be the anchor of the info window when displayed. Defaults to `const Offset(0.5, 0.0)`.
- **onTap** (VoidCallback?) - Optional - onTap callback for this InfoWindow.
```

--------------------------------

### hashCode property

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/WeightedLatLng-class.html

Gets the hash code for this object.

```APIDOC
## hashCode → int

### Description
The hash code for this object. Overrides the default implementation.

### Returns
- **int** - The hash code.

### Example
```dart
final hash = weighted.hashCode;
```
```

--------------------------------

### Cap

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter

Cap that can be applied at the start or end vertex of a Polyline.

```APIDOC
## Cap

### Description
Cap that can be applied at the start or end vertex of a Polyline.

### Class
`Cap`

### Usage
This class is used to define caps for polylines.
```

--------------------------------

### InfoWindow.copyWith

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/InfoWindow-class.html

Creates a copy of this InfoWindow with optional overrides for its properties.

```APIDOC
## InfoWindow copyWith({String? titleParam, String? snippetParam, Offset? anchorParam, VoidCallback? onTapParam})

### Description
Creates a new InfoWindow object whose values are the same as this instance, unless overwritten by the specified parameters.

### Parameters
- **titleParam** (String?) - Optional - New title value.
- **snippetParam** (String?) - Optional - New snippet value.
- **anchorParam** (Offset?) - Optional - New anchor value.
- **onTapParam** (VoidCallback?) - Optional - New onTap callback.

### Returns
InfoWindow - A new InfoWindow instance with updated values.
```

--------------------------------

### weight property

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/WeightedLatLng-class.html

Gets the weighting value of the data point.

```APIDOC
## weight → double

### Description
The weighting value of the data point. This is a final property.

### Returns
- **double** - The weight value.

### Example
```dart
final weight = weighted.weight;
```
```

--------------------------------

### GroundOverlay.bounds

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/GroundOverlay-class.html

Constructor for creating a ground overlay using bounds for exact placement.

```APIDOC
## GroundOverlay.bounds

### Description
Creates a ground overlay using exact corners defined by a LatLngBounds. This is recommended for precise placement.

### Method
Constructor

### Parameters
#### Required Parameters
- **groundOverlayId** (GroundOverlayId) - Required - The unique identifier for the ground overlay.
- **image** (AssetMapBitmap) - Required - The image to be drawn, with bitmapScaling set to MapBitmapScaling.none.
- **bounds** (LatLngBounds) - Required - The geographic bounds (southwest and northeast corners) that define the overlay's placement.

### Request Example
```dart
GroundOverlay.bounds(
  groundOverlayId: const GroundOverlayId('overlay_id'),
  image: await AssetMapBitmap.create(
    createLocalImageConfiguration(context),
    'assets/images/ground_overlay.png',
    bitmapScaling: MapBitmapScaling.none,
  ),
  bounds: LatLngBounds(
    southwest: LatLng(37.42, -122.08),
    northeast: LatLng(37.43, -122.09),
  ),
);
```

### Response
No return value (constructor).
```

--------------------------------

### Cap.squareCap

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/Cap-class.html

Cap that is squared off after extending half the stroke width beyond the start or end vertex of a Polyline with solid stroke pattern.

```APIDOC
## Cap.squareCap

### Description
Cap that is squared off after extending half the stroke width beyond the start or end vertex of a Polyline with solid stroke pattern.

### Type
Constant

### Value
```dart
const Cap squareCap
```

### Example
```dart
final cap = Cap.squareCap;
```
```

--------------------------------

### GroundOverlay.fromBounds

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/GroundOverlay-class.html

Creates a GroundOverlay fitted to the specified bounds with the provided image.

```APIDOC
## GroundOverlay.fromBounds

### Description
Creates a GroundOverlay fitted to the specified `bounds` with the provided `image`.

### Constructor
`GroundOverlay.fromBounds({required GroundOverlayId groundOverlayId, required MapBitmap image, required LatLngBounds bounds, Offset anchor = const Offset(0.5, 0.5), double bearing = 0.0, double transparency = 0.0, int zIndex = 0, bool visible = true, bool clickable = true, VoidCallback? onTap})`

### Parameters
- **groundOverlayId** (GroundOverlayId) - Required - Uniquely identifies the ground overlay.
- **image** (MapBitmap) - Required - A description of the bitmap used to draw the ground overlay.
- **bounds** (LatLngBounds) - Required - Bounds which will contain the image.
- **anchor** (Offset) - Optional - The anchor in normalized coordinates specifying the anchor point of the overlay. Defaults to Offset(0.5, 0.5).
- **bearing** (double) - Optional - The amount that the image should be rotated in a clockwise direction. Defaults to 0.0.
- **transparency** (double) - Optional - The transparency of the ground overlay. Defaults to 0.0.
- **zIndex** (int) - Optional - The ground overlay's zIndex. Defaults to 0.
- **visible** (bool) - Optional - Whether the ground overlay is visible. Defaults to true.
- **clickable** (bool) - Optional - Controls if click events are handled for this ground overlay. Defaults to true.
- **onTap** (VoidCallback?) - Optional - Callbacks to receive tap events for ground overlay placed on this map.

### Returns
A GroundOverlay instance.
```

--------------------------------

### newLatLngBounds(LatLngBounds bounds, double padding)

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/CameraUpdate-class.html

Creates a camera update that centers a bounding box in the map view with optional padding.

```APIDOC
## newLatLngBounds(LatLngBounds bounds, double padding) → CameraUpdate

### Description
Returns a camera update that transforms the camera so that the specified geographical bounding box is centered in the map view at the greatest possible zoom level. A non-zero `padding` insets the bounding box from the map view's edges. The camera's new tilt and bearing will both be 0.0.

### Method
newLatLngBounds

### Parameters
- **bounds** (LatLngBounds) - Required - The geographical bounding box to center.
- **padding** (double) - Required - The padding in pixels to inset the bounding box from the map view's edges.

### Returns
CameraUpdate - A camera update that transforms the camera to fit the bounding box.
```

--------------------------------

### Cap.roundCap

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/Cap-class.html

Cap that is a semicircle with radius equal to half the stroke width, centered at the start or end vertex of a Polyline with solid stroke pattern.

```APIDOC
## Cap.roundCap

### Description
Cap that is a semicircle with radius equal to half the stroke width, centered at the start or end vertex of a Polyline with solid stroke pattern.

### Type
Constant

### Value
```dart
const Cap roundCap
```

### Example
```dart
final cap = Cap.roundCap;
```
```

--------------------------------

### Polygon({required PolygonId polygonId, bool consumeTapEvents = false, Color fillColor = Colors.black, bool geodesic = false, List<LatLng> points = const <LatLng>[], List<List<LatLng>> holes = const <List<LatLng>>[], Color strokeColor = Colors.black, int strokeWidth = 10, bool visible = true, int zIndex = 0, VoidCallback? onTap})

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/Polygon-class.html

Creates an immutable representation of a polygon through geographical locations on the map. This constructor initializes all properties of the polygon.

```APIDOC
## Polygon Constructor

### Description
Creates an immutable representation of a polygon through geographical locations on the map.

### Parameters
- **polygonId** (PolygonId) - Required - Uniquely identifies a Polygon.
- **consumeTapEvents** (bool) - Optional - True if the Polygon consumes tap events. Default: false.
- **fillColor** (Color) - Optional - Fill color in ARGB format. Default: Colors.black.
- **geodesic** (bool) - Optional - Indicates whether segments should be drawn as geodesics. Default: false.
- **points** (List<LatLng>) - Optional - The vertices of the polygon. Default: const <LatLng>[].
- **holes** (List<List<LatLng>>) - Optional - Coordinates defining holes inside the polygon. Default: const <List<LatLng>>[].
- **strokeColor** (Color) - Optional - Line color in ARGB format. Default: Colors.black.
- **strokeWidth** (int) - Optional - Width of the polygon line. Default: 10.
- **visible** (bool) - Optional - True if the polygon is visible. Default: true.
- **zIndex** (int) - Optional - The z-index of the polygon. Default: 0.
- **onTap** (VoidCallback?) - Optional - Callback for tap events.

### Example
```dart
Polygon(
  polygonId: PolygonId('my_polygon'),
  points: [LatLng(37.7749, -122.4194), LatLng(37.7849, -122.4294)],
  fillColor: Colors.red,
  strokeWidth: 5,
)
```
```

--------------------------------

### PatternItem Constructors and Methods

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/PatternItem-class.html

Static factory methods and constants for creating PatternItem instances, and a method to serialize a PatternItem to JSON.

```APIDOC
## PatternItem.dash

### Description
Creates a dash item used in the stroke pattern for a Polyline.

### Method
PatternItem.dash(double length)

### Parameters
- **length** (double) - Required - The length of the dash.

### Returns
- **PatternItem** - A PatternItem representing a dash.
```

```APIDOC
## PatternItem.gap

### Description
Creates a gap item used in the stroke pattern for a Polyline.

### Method
PatternItem.gap(double length)

### Parameters
- **length** (double) - Required - The length of the gap.

### Returns
- **PatternItem** - A PatternItem representing a gap.
```

```APIDOC
## PatternItem.dot

### Description
A constant dot item used in the stroke pattern for a Polyline.

### Method
PatternItem.dot

### Returns
- **PatternItem** - A PatternItem representing a dot.
```

```APIDOC
## PatternItem.toJson

### Description
Converts this object to something serializable in JSON.

### Method
toJson()

### Returns
- **Object** - A JSON-serializable representation of the PatternItem.
```

--------------------------------

### MinMaxZoomPreference class

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/MinMaxZoomPreference-class.html

Documentation for the MinMaxZoomPreference class, including its constructor, properties, methods, operators, and constants.

```APIDOC
## MinMaxZoomPreference

### Description
Creates an immutable representation of the preferred minimum and maximum zoom values for the map camera.

### Constructor
`MinMaxZoomPreference(double? minZoom, double? maxZoom)`

### Parameters
- **minZoom** (double?) - The preferred minimum zoom level or null, if unbounded from below.
- **maxZoom** (double?) - The preferred maximum zoom level or null, if unbounded from above.

### Properties
- **minZoom** (double?) - The preferred minimum zoom level or null, if unbounded from below.
- **maxZoom** (double?) - The preferred maximum zoom level or null, if unbounded from above.
- **hashCode** (int) - The hash code for this object.
- **runtimeType** (Type) - A representation of the runtime type of the object.

### Methods
- **toJson()** → Object - Converts this object to something serializable in JSON.
- **toString()** → String - A string representation of this object.
- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed.

### Operators
- **operator ==(Object other)** → bool - The equality operator.

### Constants
- **unbounded** → const MinMaxZoomPreference - Unbounded zooming.
```

--------------------------------

### fromAssetImage(ImageConfiguration configuration, String assetName, {AssetBundle? bundle, String? package, bool mipmaps = true}) → Future<BitmapDescriptor>

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/BitmapDescriptor-class.html

Creates a BitmapDescriptor from an asset image. This is a static method that returns a Future<BitmapDescriptor>.

```APIDOC
## [STATIC_METHOD] fromAssetImage

### Description
Creates a BitmapDescriptor from an asset image.

### Method
STATIC_METHOD

### Signature
`static Future<BitmapDescriptor> fromAssetImage(ImageConfiguration configuration, String assetName, {AssetBundle? bundle, String? package, bool mipmaps = true})`

### Parameters
- **configuration** (ImageConfiguration) - Required - The image configuration.
- **assetName** (String) - Required - The name of the asset.
- **bundle** (AssetBundle?) - Optional - The asset bundle.
- **package** (String?) - Optional - The package name.
- **mipmaps** (bool) - Optional - Whether to use mipmaps. Defaults to true.

### Returns
Future<BitmapDescriptor> - A future that resolves to a BitmapDescriptor.
```

--------------------------------

### GroundOverlay.fromPosition

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/GroundOverlay-class.html

Creates a GroundOverlay to given position with the given image.

```APIDOC
## GroundOverlay.fromPosition

### Description
Creates a GroundOverlay to given `position` with the given `image`.

### Constructor
`GroundOverlay.fromPosition({required GroundOverlayId groundOverlayId, required MapBitmap image, required LatLng position, double? width, double? height, Offset anchor = const Offset(0.5, 0.5), double bearing = 0.0, double transparency = 0.0, int zIndex = 0, bool visible = true, bool clickable = true, VoidCallback? onTap, double? zoomLevel})`

### Parameters
- **groundOverlayId** (GroundOverlayId) - Required - Uniquely identifies the ground overlay.
- **image** (MapBitmap) - Required - A description of the bitmap used to draw the ground overlay.
- **position** (LatLng) - Required - Geographical location to which the anchor will be fixed.
- **width** (double?) - Optional - Width of the ground overlay in meters.
- **height** (double?) - Optional - Height of the ground overlay in meters.
- **anchor** (Offset) - Optional - The anchor in normalized coordinates specifying the anchor point of the overlay. Defaults to Offset(0.5, 0.5).
- **bearing** (double) - Optional - The amount that the image should be rotated in a clockwise direction. Defaults to 0.0.
- **transparency** (double) - Optional - The transparency of the ground overlay. Defaults to 0.0.
- **zIndex** (int) - Optional - The ground overlay's zIndex. Defaults to 0.
- **visible** (bool) - Optional - Whether the ground overlay is visible. Defaults to true.
- **clickable** (bool) - Optional - Controls if click events are handled for this ground overlay. Defaults to true.
- **onTap** (VoidCallback?) - Optional - Callbacks to receive tap events for ground overlay placed on this map.
- **zoomLevel** (double?) - Optional - The map zoom level used when setting a ground overlay with a position.

### Returns
A GroundOverlay instance.
```

--------------------------------

### LatLngBounds class

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/LatLngBounds-class.html

Documentation for the LatLngBounds class, including its constructor, properties, methods, operators, and static methods.

```APIDOC
## LatLngBounds

### Description
A latitude/longitude aligned rectangle. The rectangle conceptually includes all points (lat, lng) where lat is between southwest.latitude and northeast.latitude, and lng is between southwest.longitude and northeast.longitude (or wraps around the antimeridian if northeast.longitude < southwest.longitude).

### Constructors

#### LatLngBounds({required LatLng southwest, required LatLng northeast})
Creates a geographical bounding box with the specified corners.

### Properties

- **hashCode** → int - The hash code for this object. (no setter, override)
- **northeast** → LatLng - The northeast corner of the rectangle. (final)
- **runtimeType** → Type - A representation of the runtime type of the object. (no setter, inherited)
- **southwest** → LatLng - The southwest corner of the rectangle. (final)

### Methods

#### contains(LatLng point) → bool
Returns whether this rectangle contains the given LatLng.

#### toJson() → Object
Converts this object to something serializable in JSON.

#### toString() → String
A string representation of this object. (override)

### Operators

#### operator ==(Object other) → bool
The equality operator. (override)

### Static Methods

#### fromList(Object? json) → LatLngBounds?
Converts a list to LatLngBounds.
```

--------------------------------

### zoomIn()

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/CameraUpdate-class.html

Creates a camera update that zooms the camera in.

```APIDOC
## zoomIn() → CameraUpdate

### Description
Returns a camera update that zooms the camera in, bringing the camera closer to the surface of the Earth.

### Method
zoomIn

### Returns
CameraUpdate - A camera update that zooms the camera in.
```

--------------------------------

### asset(ImageConfiguration configuration, String assetName, {AssetBundle? bundle, String? package, double? width, double? height, double? imagePixelRatio, MapBitmapScaling bitmapScaling = MapBitmapScaling.auto}) → Future<AssetMapBitmap>

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/BitmapDescriptor-class.html

Creates a BitmapDescriptor from an asset using AssetMapBitmap. This is a static method that returns a Future<AssetMapBitmap>.

```APIDOC
## [STATIC_METHOD] asset

### Description
Creates a BitmapDescriptor from an asset using AssetMapBitmap.

### Method
STATIC_METHOD

### Signature
`static Future<AssetMapBitmap> asset(ImageConfiguration configuration, String assetName, {AssetBundle? bundle, String? package, double? width, double? height, double? imagePixelRatio, MapBitmapScaling bitmapScaling = MapBitmapScaling.auto})`

### Parameters
- **configuration** (ImageConfiguration) - Required - The image configuration.
- **assetName** (String) - Required - The name of the asset.
- **bundle** (AssetBundle?) - Optional - The asset bundle.
- **package** (String?) - Optional - The package name.
- **width** (double?) - Optional - The width of the image.
- **height** (double?) - Optional - The height of the image.
- **imagePixelRatio** (double?) - Optional - The image pixel ratio.
- **bitmapScaling** (MapBitmapScaling) - Optional - The bitmap scaling mode. Defaults to MapBitmapScaling.auto.

### Returns
Future<AssetMapBitmap> - A future that resolves to an AssetMapBitmap.
```

--------------------------------

### GoogleMap constructor

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/GoogleMap-class.html

Creates a widget displaying data from Google Maps services. This constructor accepts numerous optional parameters to configure the map's initial camera position, styling, controls, gestures, overlays, and callbacks.

```APIDOC
## GoogleMap constructor

### Description
Creates a widget displaying data from Google Maps services.

### Constructor
GoogleMap({Key? key, required CameraPosition initialCameraPosition, String? style, MapCreatedCallback? onMapCreated, Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers = const <Factory<OneSequenceGestureRecognizer>>{}, WebGestureHandling? webGestureHandling, WebCameraControlPosition? webCameraControlPosition, bool webCameraControlEnabled = true, bool compassEnabled = true, bool mapToolbarEnabled = true, bool mapTypeControlEnabled = false, bool fullscreenControlEnabled = false, bool streetViewControlEnabled = false, CameraTargetBounds cameraTargetBounds = CameraTargetBounds.unbounded, MapType mapType = MapType.normal, MinMaxZoomPreference minMaxZoomPreference = MinMaxZoomPreference.unbounded, bool rotateGesturesEnabled = true, bool scrollGesturesEnabled = true, bool zoomControlsEnabled = true, bool zoomGesturesEnabled = true, bool liteModeEnabled = false, bool tiltGesturesEnabled = true, bool fortyFiveDegreeImageryEnabled = false, bool myLocationEnabled = false, bool myLocationButtonEnabled = true, TextDirection? layoutDirection, EdgeInsets padding = EdgeInsets.zero, bool indoorViewEnabled = false, bool trafficEnabled = false, bool buildingsEnabled = true, Set<Marker> markers = const <Marker>{}, Set<Polygon> polygons = const <Polygon>{}, Set<Polyline> polylines = const <Polyline>{}, Set<Circle> circles = const <Circle>{}, Set<ClusterManager> clusterManagers = const <ClusterManager>{}, Set<Heatmap> heatmaps = const <Heatmap>{}, VoidCallback? onCameraMoveStarted, Set<TileOverlay> tileOverlays = const <TileOverlay>{}, Set<GroundOverlay> groundOverlays = const <GroundOverlay>{}, CameraPositionCallback? onCameraMove, VoidCallback? onCameraIdle, ArgumentCallback<LatLng>? onTap, ArgumentCallback<LatLng>? onLongPress, GoogleMapMarkerType markerType = GoogleMapMarkerType.marker, MapColorScheme? colorScheme, String? mapId, @Deprecated('cloudMapId is deprecated. Use mapId instead.') String? cloudMapId})

### Parameters
- **key** (Key?) - Optional - Key for the widget.
- **initialCameraPosition** (CameraPosition) - Required - The initial camera position of the map.
- **style** (String?) - Optional - A JSON string representing map styling.
- **onMapCreated** (MapCreatedCallback?) - Optional - Callback when the map is created.
- **gestureRecognizers** (Set<Factory<OneSequenceGestureRecognizer>>) - Optional - Gesture recognizers for the map.
- **webGestureHandling** (WebGestureHandling?) - Optional - Gesture handling for web.
- **webCameraControlPosition** (WebCameraControlPosition?) - Optional - Position of the camera control on web.
- **webCameraControlEnabled** (bool) - Optional - Whether the camera control is enabled on web.
- **compassEnabled** (bool) - Optional - Whether the compass is enabled.
- **mapToolbarEnabled** (bool) - Optional - Whether the map toolbar is enabled.
- **mapTypeControlEnabled** (bool) - Optional - Whether the map type control is enabled.
- **fullscreenControlEnabled** (bool) - Optional - Whether the fullscreen control is enabled.
- **streetViewControlEnabled** (bool) - Optional - Whether the street view control is enabled.
- **cameraTargetBounds** (CameraTargetBounds) - Optional - Bounds for the camera target.
- **mapType** (MapType) - Optional - The type of map to display.
- **minMaxZoomPreference** (MinMaxZoomPreference) - Optional - Minimum and maximum zoom levels.
- **rotateGesturesEnabled** (bool) - Optional - Whether rotate gestures are enabled.
- **scrollGesturesEnabled** (bool) - Optional - Whether scroll gestures are enabled.
- **zoomControlsEnabled** (bool) - Optional - Whether zoom controls are enabled.
- **zoomGesturesEnabled** (bool) - Optional - Whether zoom gestures are enabled.
- **liteModeEnabled** (bool) - Optional - Whether lite mode is enabled.
- **tiltGesturesEnabled** (bool) - Optional - Whether tilt gestures are enabled.
- **fortyFiveDegreeImageryEnabled** (bool) - Optional - Whether 45-degree imagery is enabled.
- **myLocationEnabled** (bool) - Optional - Whether the my location layer is enabled.
- **myLocationButtonEnabled** (bool) - Optional - Whether the my location button is enabled.
- **layoutDirection** (TextDirection?) - Optional - Layout direction for the widget.
- **padding** (EdgeInsets) - Optional - Padding around the map.
- **indoorViewEnabled** (bool) - Optional - Whether the indoor view is enabled.
- **trafficEnabled** (bool) - Optional - Whether traffic information is displayed.
- **buildingsEnabled** (bool) - Optional - Whether buildings are displayed.
- **markers** (Set<Marker>) - Optional - Markers to display on the map.
- **polygons** (Set<Polygon>) - Optional - Polygons to display on the map.
- **polylines** (Set<Polyline>) - Optional - Polylines to display on the map.
- **circles** (Set<Circle>) - Optional - Circles to display on the map.
- **clusterManagers** (Set<ClusterManager>) - Optional - Cluster managers for markers.
- **heatmaps** (Set<Heatmap>) - Optional - Heatmaps to display on the map.
- **onCameraMoveStarted** (VoidCallback?) - Optional - Callback when the camera starts moving.
- **tileOverlays** (Set<TileOverlay>) - Optional - Tile overlays to display on the map.
- **groundOverlays** (Set<GroundOverlay>) - Optional - Ground overlays to display on the map.
- **onCameraMove** (CameraPositionCallback?) - Optional - Callback when the camera moves.
- **onCameraIdle** (VoidCallback?) - Optional - Callback when the camera stops moving.
- **onTap** (ArgumentCallback<LatLng>?) - Optional - Callback when the map is tapped.
- **onLongPress** (ArgumentCallback<LatLng>?) - Optional - Callback when the map is long-pressed.
- **markerType** (GoogleMapMarkerType) - Optional - The type of markers to use.
- **colorScheme** (MapColorScheme?) - Optional - The color scheme for the map.
- **mapId** (String?) - Optional - The map ID for styling.
- **cloudMapId** (String?) - Optional - Deprecated: Use mapId instead.
```

--------------------------------

### GroundOverlay.position

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/GroundOverlay-class.html

Constructor for creating a ground overlay using a position, width, height, and zoom level.

```APIDOC
## GroundOverlay.position

### Description
Creates a ground overlay using a position, width, height, and zoomLevel. If height is omitted, the image aspect ratio is preserved.

### Method
Constructor

### Parameters
#### Required Parameters
- **groundOverlayId** (GroundOverlayId) - Required - The unique identifier for the ground overlay.
- **image** (AssetMapBitmap) - Required - The image to be drawn, with bitmapScaling set to MapBitmapScaling.none.
- **position** (LatLng) - Required - The geographic position where the overlay is anchored.
- **width** (double) - Required - The width of the overlay in meters.
- **height** (double) - Optional - The height of the overlay in meters. If omitted, the aspect ratio is preserved.
- **zoomLevel** (double) - Optional - The zoom level to scale the image according to.

### Request Example
```dart
GroundOverlay.position(
  groundOverlayId: const GroundOverlayId('overlay_id'),
  image: await AssetMapBitmap.create(
    createLocalImageConfiguration(context),
    'assets/images/ground_overlay.png',
    bitmapScaling: MapBitmapScaling.none,
  ),
  position: LatLng(37.42, -122.08),
  width: 100,
  height: 100,
  zoomLevel: 14,
);
```

### Response
No return value (constructor).
```

--------------------------------

### TextGlyph Constructor

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/TextGlyph-class.html

Documentation for the TextGlyph class constructor and its properties.

```APIDOC
## TextGlyph Constructor

### Description
Constructs a glyph with the specified `text` and `textColor`.

### Constructor
`TextGlyph({required String text, Color? textColor})`

### Parameters
- **text** (String) - Required - Text to be displayed in the glyph.
- **textColor** (Color?) - Optional - Color of the text.

### Properties
- **text** (String) - final - Text to be displayed in the glyph.
- **textColor** (Color?) - final - Color of the text.

### Methods
- **toJson()** → Object - Convert the object to a Json format. (override)

### Inheritance
- Object
- BitmapDescriptor
- AdvancedMarkerGlyph
- TextGlyph
```

--------------------------------

### zoomOut()

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/CameraUpdate-class.html

Creates a camera update that zooms the camera out.

```APIDOC
## zoomOut() → CameraUpdate

### Description
Returns a camera update that zooms the camera out, bringing the camera further away from the surface of the Earth.

### Method
zoomOut

### Returns
CameraUpdate - A camera update that zooms the camera out.
```

--------------------------------

### WeightedLatLng constructor

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/WeightedLatLng-class.html

Creates a WeightedLatLng with the specified point and optional weight.

```APIDOC
## WeightedLatLng(LatLng point, {double weight = 1.0})

### Description
Creates a WeightedLatLng with the specified geographical point and weight. The weight defaults to 1.0 if not provided.

### Parameters
- **point** (LatLng) - Required - The geographical data point.
- **weight** (double) - Optional - The weighting value of the data point. Defaults to 1.0.

### Example
```dart
final weighted = WeightedLatLng(LatLng(37.7749, -122.4194), weight: 0.5);
```
```

--------------------------------

### BytesMapBitmap constructor

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/BytesMapBitmap-class.html

Constructs a BytesMapBitmap from a Uint8List of PNG-encoded bytes, with optional scaling, width, height, and imagePixelRatio parameters.

```APIDOC
## BytesMapBitmap(Uint8List byteData, {MapBitmapScaling bitmapScaling = MapBitmapScaling.auto, double? width, double? height, double? imagePixelRatio})

### Description
Constructs a BytesMapBitmap that is created from an array of bytes that must be encoded as `PNG` in Uint8List.

### Parameters
- **byteData** (Uint8List) - Required - The bytes of the bitmap, encoded as PNG.
- **bitmapScaling** (MapBitmapScaling) - Optional - The scaling method of the bitmap. Defaults to MapBitmapScaling.auto.
- **width** (double?) - Optional - The target width of the bitmap in logical pixels.
- **height** (double?) - Optional - The target height of the bitmap in logical pixels.
- **imagePixelRatio** (double?) - Optional - The pixel ratio of the bitmap. Defaults to 1.0 if not provided.

### Example
```dart
Uint8List byteData = imageBuffer.asUint8List();
double imagePixelRatio = 2.0; // Pixel density of the image.
BytesMapBitmap bytesMapBitmap = BytesMapBitmap(
  byteData,
  imagePixelRatio: imagePixelRatio,
);
```
```

--------------------------------

### HeatmapGradient class

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/HeatmapGradient-class.html

Documentation for the HeatmapGradient class, including its constructor, properties, methods, and operators.

```APIDOC
## HeatmapGradient

### Description
Represents a mapping of intensity to color. Interpolates between given set of intensity and color values to produce a full mapping for the range `0, 1`.

### Constructors

#### HeatmapGradient(List<HeatmapGradientColor> colors, {int colorMapSize = 256})
Creates a new HeatmapGradient object.

### Properties
- **colorMapSize** (int) - Number of entries in the generated color map.
- **colors** (List<HeatmapGradientColor>) - The gradient colors.
- **hashCode** (int) - The hash code for this object.
- **runtimeType** (Type) - A representation of the runtime type of the object.

### Methods

#### clone() → HeatmapGradient
Creates a new HeatmapGradient object whose values are the same as this instance.

#### copyWith({List<HeatmapGradientColor>? colorsParam, int? colorMapSizeParam}) → HeatmapGradient
Creates a new HeatmapGradient object whose values are the same as this instance, unless overwritten by the specified parameters.

#### toJson() → Object
Converts this object to something serializable in JSON.

#### toString() → String
A string representation of this object.

### Operators

#### operator ==(Object other) → bool
The equality operator.
```

--------------------------------

### Polyline({required PolylineId polylineId, bool consumeTapEvents = false, Color color = Colors.black, Cap endCap = Cap.buttCap, bool geodesic = false, JointType jointType = JointType.mitered, List<LatLng> points = const <LatLng>[], List<PatternItem> patterns = const <PatternItem>[], Cap startCap = Cap.buttCap, bool visible = true, int width = 10, int zIndex = 0, VoidCallback? onTap})

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/Polyline-class.html

Creates an immutable object representing a line drawn through geographical locations on the map. This constructor initializes a Polyline with the given identifier and optional styling and interaction parameters.

```APIDOC
## Polyline Constructor

### Description
Creates an immutable object representing a line drawn through geographical locations on the map.

### Constructor
`Polyline({required PolylineId polylineId, bool consumeTapEvents = false, Color color = Colors.black, Cap endCap = Cap.buttCap, bool geodesic = false, JointType jointType = JointType.mitered, List<LatLng> points = const <LatLng>[], List<PatternItem> patterns = const <PatternItem>[], Cap startCap = Cap.buttCap, bool visible = true, int width = 10, int zIndex = 0, VoidCallback? onTap})`

### Parameters
- **polylineId** (PolylineId) - Required - Uniquely identifies a Polyline.
- **consumeTapEvents** (bool) - Optional - True if the Polyline consumes tap events. Default: false.
- **color** (Color) - Optional - Line segment color in ARGB format. Default: Colors.black.
- **endCap** (Cap) - Optional - The cap at the end vertex of the polyline. Default: Cap.buttCap.
- **geodesic** (bool) - Optional - Indicates whether the segments should be drawn as geodesics. Default: false.
- **jointType** (JointType) - Optional - Joint type of the polyline line segments. Default: JointType.mitered.
- **points** (List<LatLng>) - Optional - The vertices of the polyline to be drawn. Default: const <LatLng>[].
- **patterns** (List<PatternItem>) - Optional - The stroke pattern for the polyline. Default: const <PatternItem>[].
- **startCap** (Cap) - Optional - The cap at the start vertex of the polyline. Default: Cap.buttCap.
- **visible** (bool) - Optional - True if the polyline is visible. Default: true.
- **width** (int) - Optional - Width of the polyline. Default: 10.
- **zIndex** (int) - Optional - The z-index of the polyline. Default: 0.
- **onTap** (VoidCallback?) - Optional - Callbacks to receive tap events for polyline placed on this map.

### Example
```dart
Polyline(
  polylineId: PolylineId('route'),
  points: [LatLng(37.7749, -122.4194), LatLng(37.7849, -122.4094)],
  color: Colors.blue,
  width: 5,
)
```
```

--------------------------------

### Create BytesMapBitmap from Uint8List with imagePixelRatio

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/BytesMapBitmap-class.html

Creates a BytesMapBitmap from a Uint8List of PNG-encoded bytes, specifying the imagePixelRatio to match the device's pixel density for sharp rendering.

```dart
Uint8List byteData = imageBuffer.asUint8List()
double imagePixelRatio = 2.0; // Pixel density of the image.
BytesMapBitmap bytesMapBitmap = BytesMapBitmap(
  byteData,
  imagePixelRatio: imagePixelRatio,
);
```

--------------------------------

### newLatLng(LatLng latLng)

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/CameraUpdate-class.html

Creates a camera update that moves the camera target to a specified LatLng.

```APIDOC
## newLatLng(LatLng latLng) → CameraUpdate

### Description
Returns a camera update that moves the camera target to the specified geographical location.

### Method
newLatLng

### Parameters
- **latLng** (LatLng) - Required - The target geographical location.

### Returns
CameraUpdate - A camera update that moves the camera target to the specified geographical location.
```

--------------------------------

### HeatmapGradientColor class

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/HeatmapGradientColor-class.html

Documentation for the HeatmapGradientColor class, including its constructor, properties, methods, and operators.

```APIDOC
## HeatmapGradientColor

### Description
A Color with a startPoint for use in a HeatmapGradient.

### Constructors

#### HeatmapGradientColor(Color color, double startPoint)
Creates a new HeatmapGradientColor object.

### Properties
- **color** (Color) - The color for this portion of the gradient.
- **startPoint** (double) - The start point of this color.

### Methods

#### clone() → HeatmapGradientColor
Creates a new HeatmapGradientColor object whose values are the same as this instance.

#### copyWith({Color? colorParam, double? startPointParam}) → HeatmapGradientColor
Creates a new HeatmapGradientColor object whose values are the same as this instance, unless overwritten by the specified parameters.

### Operators

#### operator ==(Object other) → bool
The equality operator.
```

--------------------------------

### CameraPosition constructor

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/CameraPosition-class.html

Constructor for creating a CameraPosition instance.

```APIDOC
## CameraPosition({double bearing = 0.0, required LatLng target, double tilt = 0.0, double zoom = 0.0})

### Description
Creates an immutable representation of the GoogleMap camera.

### Constructor Parameters
- **bearing** (double) - Optional - The camera's bearing in degrees, measured clockwise from north. Defaults to 0.0.
- **target** (LatLng) - Required - The geographical location that the camera is pointing at.
- **tilt** (double) - Optional - The angle, in degrees, of the camera angle from the nadir. Defaults to 0.0.
- **zoom** (double) - Optional - The zoom level of the camera. Defaults to 0.0.

### Example
```dart
CameraPosition(
  target: LatLng(37.7749, -122.4194),
  zoom: 12,
  tilt: 45,
  bearing: 90,
)
```
```

--------------------------------

### Create BytesMapBitmap with device pixel ratio

Source: https://pub.dev/documentation/google_maps_flutter/latest/google_maps_flutter/BytesMapBitmap-class.html

Creates a BytesMapBitmap using the device's pixel ratio via MediaQuery.maybeDevicePixelRatioOf to render the bitmap sharply at a pixel-to-pixel ratio.

```dart
Uint8List byteData = imageBuffer.asUint8List()
BytesMapBitmap bytesMapBitmap = BytesMapBitmap(
  byteData,
  imagePixelRatio: MediaQuery.maybeDevicePixelRatioOf(context),
);
```
Tokens:
Raw