GroundOverlay

Defines an image on a map.

Properties

Name	Type	Description
groundOverlayId	GroundOverlayId	Unique ground overlay ID.
bearing	double	Bearing of a ground overlay, in degrees clockwise from north.
clickable	bool	Indicates whether a ground overlay is tappable.
width	double	Width of a ground overlay, in meters.
height	double	Height of a ground overlay, in meters.
imageDescriptor	BitmapDescriptor	Image for a ground overlay.
position	LatLng?	Position of a ground overlay.
bounds	LatLngBounds?	Bounds of a ground overlay.
anchor	Offset	Anchor of a ground overlay.
transparency	double	Transparency of a ground overlay.
visible	bool	Indicates whether a ground overlay is visible. If the ground overlay is invisible, it will not be drawn but all other states will be preserved.
zIndex	double	Z-index of a ground overlay. The z-index indicates the overlapping order of a ground overlay. A ground overlay with a larger z-index overlaps that with a smaller z-index. Ground overlays with the same z-index overlap each other in a random order.
onClick	VoidCallback?	Function executed when a ground overlay is tapped.

Constructor Summary

Constructor	Description
GroundOverlay({required GroundOverlayId groundOverlayId, required double width, required double height, required BitmapDescriptor imageDescriptor, double bearing, bool clickable, LatLng? position, LatLngBounds? bounds, Offset anchor, double transparency, bool visible, double zIndex})	Creates a GroundOverlay object.

Constructors

[h2]GroundOverlay

Creates a GroundOverlay object.

Parameter	Type	Description
groundOverlayId	GroundOverlayId	Unique ground overlay ID.
bearing	double	Bearing of a ground overlay, in degrees clockwise from north.
clickable	bool	Indicates whether a ground overlay is tappable.
width	double	Width of a ground overlay, in meters.
height	double	Height of a ground overlay, in meters.
imageDescriptor	BitmapDescriptor	Image for a ground overlay.
position	LatLng?	Position of a ground overlay.
bounds	LatLngBounds?	Bounds of a ground overlay.
anchor	Offset	Anchor of a ground overlay.
transparency	double	Transparency of a ground overlay.
visible	bool	Indicates whether a ground overlay is visible. If the ground overlay is invisible, it will not be drawn but all other states will be preserved.
zIndex	double	Z-index of a ground overlay. The z-index indicates the overlapping order of a ground overlay. A ground overlay with a larger z-index overlaps that with a smaller z-index. Ground overlays with the same z-index overlap each other in a random order.
onClick	VoidCallback?	Function executed when a ground overlay is tapped.

Method Summary

Method	Return Type	Description
GroundOverlay.updateCopy({double? bearing, bool? clickable, double? width, double? height, BitmapDescriptor? imageDescriptor, LatLng? position, LatLngBounds? bounds, Offset? anchor, double? transparency, bool? visible, double? zIndex, VoidCallback? onClick})	GroundOverlay	Copies an existing GroundOverlay object and updates the specified attributes.
GroundOverlay.clone()	GroundOverlay	Clones a GroundOverlay object.

Methods

[h2]GroundOverlay.updateCopy

Copies an existing GroundOverlay object and updates the specified attributes.

Parameter	Type	Description
bearing	double?	Bearing of a ground overlay, in degrees clockwise from north.
clickable	bool?	Indicates whether a ground overlay is tappable.
width	double?	Width of a ground overlay, in meters.
height	double?	Height of a ground overlay, in meters.
imageDescriptor	BitmapDescriptor	Image for a ground overlay.
position	LatLng?	Position of a ground overlay.
bounds	LatLngBounds?	Bounds of a ground overlay.
anchor	Offset?	Anchor of a ground overlay.
transparency	double?	Transparency of a ground overlay.
visible	bool?	Indicates whether a ground overlay is visible. If the ground overlay is invisible, it will not be drawn but all other states will be preserved.
zIndex	double?	Z-index of a ground overlay. The z-index indicates the overlapping order of a ground overlay. A ground overlay with a larger z-index overlaps that with a smaller z-index. Ground overlays with the same z-index overlap each other in a random order.
onClick	VoidCallback?	Function executed when a ground overlay is tapped.

Return Type	Description
GroundOverlay	GroundOverlay object.

Call example:

// Define a GroundOverlay object.
GroundOverlay groundOverlay; 
 
// Call the updateCopy method.
groundOverlay = groundOverlay!.updateCopy(clickable: true);

[h2]GroundOverlay.clone

Clones a GroundOverlay object.

Return Type	Description
GroundOverlay	GroundOverlay object.