GroundOverlay class
Draws a ground overlay on the map.
- Implemented types
- Annotations
Constructors
- GroundOverlay({required GroundOverlayId groundOverlayId, bool consumeTapEvents = false, LatLng? location, int zIndex = 0, VoidCallback? onTap, bool visible = true, BitmapDescriptor? bitmap, LatLngBounds? bounds, double? width, double? height, double bearing = 0.0, Offset anchor = Offset.zero, double opacity = 1.0})
-
Creates an immutable representation of a GroundOverlay to draw on
GoogleMap
. The following ground overlay positioning is allowed by the Google Maps Apiconst - GroundOverlay.fromBounds(LatLngBounds? bounds, {required GroundOverlayId groundOverlayId, Offset anchor = Offset.zero, double bearing = 0.0, BitmapDescriptor? bitmap, bool consumeTapEvents = false, VoidCallback? onTap, double opacity = 1.0, bool visible = true, int zIndex = 0})
-
Creates an immutable representation of a GroundOverlay to draw on
GoogleMap
using LatLngBoundsconst
Properties
- anchor → Offset
-
The anchor is, by default, 50% from the top of the image and 50% from the left of the image.
final
- bearing → double
-
The amount that the image should be rotated in a clockwise direction.
The center of the rotation will be the image's anchor.
This is optional and the default bearing is 0, i.e., the image
is aligned so that up is north.
final
- bitmap → BitmapDescriptor?
-
A description of the bitmap used to draw the ground overlay image.
final
- bounds → LatLngBounds?
-
A latitude/longitude alignment of the ground overlay.
final
- consumeTapEvents → bool
-
True if the GroundOverlay consumes tap events.
final
- groundOverlayId → GroundOverlayId
-
Uniquely identifies a GroundOverlay.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- height → double?
-
Height of the ground overlay in meters
final
- location → LatLng?
-
Geographical location of the center of the ground overlay.
final
- mapsId → GroundOverlayId
-
A identifier for this object.
no setteroverride
- onTap → VoidCallback?
-
Callbacks to receive tap events for ground overlay placed on this map.
final
- opacity → double
-
Transparency of the ground overlay
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- visible → bool
-
True if the ground overlay is visible.
final
- width → double?
-
Width of the ground overlay in meters
final
- zIndex → int
-
The z-index of the ground overlay, used to determine relative drawing order of
map overlays.
final
Methods
-
clone(
) → GroundOverlay -
Creates a new GroundOverlay object whose values are the same as this instance.
override
-
copyWith(
{BitmapDescriptor? bitmapParam, Offset? anchorParam, int? zIndexParam, bool? visibleParam, bool? consumeTapEventsParam, double? widthParam, double? heightParam, double? bearingParam, LatLng? locationParam, LatLngBounds? boundsParam, VoidCallback? onTapParam, double? opacityParam}) → GroundOverlay - Creates a new GroundOverlay object whose values are the same as this instance, unless overwritten by the specified parameters.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Object -
Converts this object to something serializable in JSON.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override