Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MapProperties

Indexable

[key: string]: any

key for others property.

Index

Properties

Optional cacheEnabled

cacheEnabled: undefined | true | false

If true map will be cached and displayed as an image instead of being interactable, for performance usage. If true map will be cached and displayed as an image instead of being interactable, for performance usage.

Optional customMapStyle

customMapStyle: ReactNode

Adds custom styling to the map component. Adds custom styling to the map component.

Optional followsUserLocation

followsUserLocation: undefined | true | false

If true the map will focus on the user's location. This only works if showsUserLocation is true and the user has shared their location. Note: iOS only. If true the map will focus on the user's location. This only works if showsUserLocation is true and the user has shared their location. Note: iOS only.

Optional initialRegion

initialRegion: undefined | object

The initial region to be displayed by the map. Use this prop instead of region only if you don't want to control the viewport of the map besides the initial region. The initial region to be displayed by the map. Use this prop instead of region only if you don't want to control the viewport of the map besides the initial region.

Optional legalLabelInsets

legalLabelInsets: undefined | object

If set, changes the position of the "Legal" label link from the OS default. Note: iOS only. If set, changes the position of the "Legal" label link from the OS default. Note: iOS only.

Optional liteMode

liteMode: undefined | true | false

Enable lite mode. Note: Android only. Enable lite mode. Note: Android only.

Optional loadingBackgroundColor

loadingBackgroundColor: ColorProperties

Sets loading background color, default to #FFFFFF. Sets loading background color, default to #FFFFFF.

Optional loadingEnabled

loadingEnabled: undefined | true | false

If true a loading indicator will show while the map is loading. If true a loading indicator will show while the map is loading.

Optional loadingIndicatorColor

loadingIndicatorColor: ColorProperties

Sets loading indicator color, default to #606060. Sets loading indicator color, default to #606060.

Optional mapType

mapType: undefined | string

The map type to be displayed. The map type to be displayed.

Optional maxZoomLevel

maxZoomLevel: undefined | number

Maximum zoom value for the map, must be between 0 and 20 Maximum zoom value for the map, must be between 0 and 20

Optional minZoomLevel

minZoomLevel: undefined | number

Minimum zoom value for the map, must be between 0 and 20 Minimum zoom value for the map, must be between 0 and 20

Optional moveOnMarkerPress

moveOnMarkerPress: undefined | true | false

Android only If false the map won't move when a marker is pressed. Android only If false the map won't move when a marker is pressed.

Optional onCalloutPress

onCalloutPress: undefined | function

Optional onLongPress

onLongPress: undefined | function

Optional onMapReady

onMapReady: undefined | function

Optional onMarkerDeselect

onMarkerDeselect: undefined | function

Optional onMarkerDrag

onMarkerDrag: undefined | function

Optional onMarkerDragEnd

onMarkerDragEnd: undefined | function

Optional onMarkerDragStart

onMarkerDragStart: undefined | function

Optional onMarkerPress

onMarkerPress: undefined | function

Optional onMarkerSelect

onMarkerSelect: undefined | function

Optional onPanDrag

onPanDrag: undefined | function

Optional onPress

onPress: undefined | function

Optional onRegionChange

onRegionChange: undefined | function

Optional onRegionChangeComplete

onRegionChangeComplete: undefined | function

Optional pitchEnabled

pitchEnabled: undefined | true | false

If false the user won't be able to adjust the camera’s pitch angle. If false the user won't be able to adjust the camera’s pitch angle.

Optional provider

provider: undefined | string

The map framework to use. Either "google" for GoogleMaps, otherwise null or undefined to use the native map framework (MapKit in iOS and GoogleMaps in android). The map framework to use. Either "google" for GoogleMaps, otherwise null or undefined to use the native map framework (MapKit in iOS and GoogleMaps in android).

Optional region

region: undefined | object

The region to be displayed by the map. The region is defined by the center coordinates and the span of coordinates to display. The region to be displayed by the map. The region is defined by the center coordinates and the span of coordinates to display.

Optional rotateEnabled

rotateEnabled: undefined | true | false

If false the user won't be able to pinch/rotate the map. If false the user won't be able to pinch/rotate the map.

Optional scrollEnabled

scrollEnabled: undefined | true | false

If false the user won't be able to change the map region being displayed. If false the user won't be able to change the map region being displayed.

Optional showsBuildings

showsBuildings: undefined | true | false

A Boolean indicating whether the map displays extruded building information. A Boolean indicating whether the map displays extruded building information.

Optional showsCompass

showsCompass: undefined | true | false

If false compass won't be displayed on the map. If false compass won't be displayed on the map.

Optional showsIndoorLevelPicker

showsIndoorLevelPicker: undefined | true | false

A Boolean indicating whether indoor level picker should be enabled. Note: Google Maps only (either Android or iOS with PROVIDER_GOOGLE). A Boolean indicating whether indoor level picker should be enabled. Note: Google Maps only (either Android or iOS with PROVIDER_GOOGLE).

Optional showsIndoors

showsIndoors: undefined | true | false

A Boolean indicating whether indoor maps should be enabled. A Boolean indicating whether indoor maps should be enabled.

Optional showsMyLocationButton

showsMyLocationButton: undefined | true | false

If false hide the button to move map to the current user's location. If false hide the button to move map to the current user's location.

Optional showsPointsOfInterest

showsPointsOfInterest: undefined | true | false

If false points of interest won't be displayed on the map. If false points of interest won't be displayed on the map.

Optional showsScale

showsScale: undefined | true | false

A Boolean indicating whether the map shows scale information. A Boolean indicating whether the map shows scale information.

Optional showsTraffic

showsTraffic: undefined | true | false

A Boolean value indicating whether the map displays traffic information. A Boolean value indicating whether the map displays traffic information.

Optional showsUserLocation

showsUserLocation: undefined | true | false

If true the app will ask for the user's location. NOTE: You need to add NSLocationWhenInUseUsageDescription key in Info. plist to enable geolocation, otherwise it is going to fail silently!. If true the app will ask for the user's location. NOTE: You need to add NSLocationWhenInUseUsageDescription key in Info. plist to enable geolocation, otherwise it is going to fail silently!.

Optional source

source: undefined | object

Loads static html or a uri (with optional headers) in the WebView. Loads static html or a uri (with optional headers) in the WebView.

Optional toolbarEnabled

toolbarEnabled: undefined | true | false

Android only If false will hide 'Navigate' and 'Open in Maps' buttons on marker press Android only If false will hide 'Navigate' and 'Open in Maps' buttons on marker press

Optional userLocationAnnotationTitle

userLocationAnnotationTitle: undefined | string

The title of the annotation for current user location. This only works if showsUserLocation is true. There is a default value My Location set by MapView. Note: iOS only. The title of the annotation for current user location. This only works if showsUserLocation is true. There is a default value My Location set by MapView. Note: iOS only.

Optional zoomControlEnabled

zoomControlEnabled: undefined | true | false

If false the zoom control at the bottom right of the map won't be visible Note: Android only. If false the zoom control at the bottom right of the map won't be visible Note: Android only.

Optional zoomEnabled

zoomEnabled: undefined | true | false

If false the user won't be able to pinch/zoom the map. If false the user won't be able to pinch/zoom the map.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc