Skip to main content

Type Alias: RNMapUiSettings

type RNMapUiSettings = {
allGesturesEnabled?: boolean;
compassEnabled?: boolean;
consumeOnMarkerPress?: boolean;
consumeOnMyLocationButtonPress?: boolean;
indoorLevelPickerEnabled?: boolean;
mapToolbarEnabled?: boolean;
myLocationButtonEnabled?: boolean;
rotateEnabled?: boolean;
scrollDuringRotateOrZoomEnabled?: boolean;
scrollEnabled?: boolean;
tiltEnabled?: boolean;
zoomControlsEnabled?: boolean;
zoomGesturesEnabled?: boolean;
};

UI and gesture settings.

Properties​

PropertyTypeDefault valueDescription
allGesturesEnabled?booleantrueEnables or disables all gestures.
compassEnabled?booleanfalseShows the compass.
consumeOnMarkerPress?booleanfalseConsumes the press event. Remarks When enabled: native map UI does not execute its default behavior; only the JS callback fires. When disabled: JS callback fires and native behavior runs (camera move, info window, selection).
consumeOnMyLocationButtonPress?booleanfalseConsumes the My-Location-button press event. Remarks When enabled: native map UI does not execute its default behavior; only the JS callback fires. When disabled: JS callback fires and native behavior runs (camera animates to user location).
indoorLevelPickerEnabled?booleanfalseEnables the indoor level picker.
mapToolbarEnabled?booleanfalseEnables the map toolbar. Android: supported. iOS: not supported.
myLocationButtonEnabled?booleanfalseEnables the "My Location" button.
rotateEnabled?booleantrueEnables rotation gestures.
scrollDuringRotateOrZoomEnabled?booleantrueEnables scroll during rotate/zoom gestures.
scrollEnabled?booleantrueEnables scroll gestures.
tiltEnabled?booleantrueEnables tilt gestures.
zoomControlsEnabled?booleanfalseShows built-in zoom controls. Android: supported. iOS: not supported.
zoomGesturesEnabled?booleantrueEnables pinch zoom gestures.