Back to React Native Maps

`` Component API

docs/overlay.md

1.27.22.4 KB
Original Source

<Overlay /> Component API

Props

PropTypeDefaultNote
imageImageSourceA custom image to be used as the overlay. Only required local image resources and uri (as for images located in the net) are allowed to be used.
boundsArray<LatLng>[northWest, southEast]The coordinates for the image (bottom-left corner, top-right corner). ie.[[lat, long], [lat, long]]
bearingNumber 0Google Maps API only The bearing in degrees clockwise from north. Values outside the range [0, 360) will be normalized.
tappableBoolfalseAndroid only Boolean to allow an overlay to be tappable and use the onPress function.
opacityNumber1.0Google maps only The opacity of the overlay.

Events

Event NameReturnsNotes
onPressAndroid only Callback that is called when the user presses on the overlay

Types

type LatLng = [
  latitude: Number,
  longitude: Number,
]