KMP Maps/com.swmansion.kmpmaps

Package-level declarations

Types

Link copied to clipboard
data class AppleMapsPointOfInterestCategories(val excluding: List<AppleMapsPointOfInterestCategory>? = emptyList(), val including: List<AppleMapsPointOfInterestCategory>? = emptyList())

Configuration for Apple Maps points of interest categories.

Link copied to clipboard
enum AppleMapsPointOfInterestCategory : Enum<AppleMapsPointOfInterestCategory>

Categories of points of interest (POI) for Apple Maps.

Link copied to clipboard
data class CameraPosition(val coordinates: Coordinates, val zoom: Float, val androidBearing: Float? = null, val androidTilt: Float? = null)

Represents the camera position and orientation of the map.

Link copied to clipboard
data class Circle(val center: Coordinates, val radius: Float, val color: Color? = null, val lineColor: Color? = null, val lineWidth: Float? = null)

Represents a circle overlay on the map.

Link copied to clipboard
data class Coordinates(val latitude: Double, val longitude: Double)

Represents geographical coordinates (latitude and longitude).

Link copied to clipboard
data class GoogleMapsAnchor(val x: Float, val y: Float)

Anchor point configuration for Google Maps markers.

Link copied to clipboard
data class GoogleMapsMapStyleOptions(val json: String?)

Custom map styling options for Google Maps.

Link copied to clipboard
data class MapProperties(val isMyLocationEnabled: Boolean = false, val isTrafficEnabled: Boolean = true, val isBuildingEnabled: Boolean = true, val mapType: MapType? = MapType.NORMAL, val mapTheme: MapTheme = MapTheme.SYSTEM, val appleShowPOI: Boolean = true, val applePointsOfInterest: AppleMapsPointOfInterestCategories? = null, val applePolylineTapThreshold: Float? = null, val androidIsIndoorEnabled: Boolean = true, val androidMaxZoomPreference: Float? = null, val androidMinZoomPreference: Float? = null, val androidMapStyleOptions: GoogleMapsMapStyleOptions? = null)

Configuration properties for map behavior and appearance.

Link copied to clipboard
enum MapTheme : Enum<MapTheme>

Theme options for map appearance.

Link copied to clipboard
enum MapType : Enum<MapType>

Types of map display modes.

Link copied to clipboard
data class MapUISettings(val compassEnabled: Boolean = false, val myLocationButtonEnabled: Boolean = false, val scaleBarEnabled: Boolean = true, val togglePitchEnabled: Boolean = true, val scrollEnabled: Boolean = true, val zoomEnabled: Boolean = true, val appleRotateGesturesEnabled: Boolean = true, val androidIndoorLevelPickerEnabled: Boolean = true, val androidMapToolbarEnabled: Boolean = true, val androidRotationGesturesEnabled: Boolean = true, val androidScrollGesturesEnabledDuringRotateOrZoom: Boolean = true, val androidTiltGesturesEnabled: Boolean = true, val androidZoomControlsEnabled: Boolean = true)

UI settings that control interactive elements and gestures on the map.

Link copied to clipboard
data class Marker(val coordinates: Coordinates, val title: String? = "No title was provided", val appleTintColor: Color? = null, val androidAnchor: GoogleMapsAnchor? = null, val androidDraggable: Boolean = false, val androidSnippet: String? = null, val androidZIndex: Float? = null)

Represents a marker on the map.

Link copied to clipboard
data class Polygon(val coordinates: List<Coordinates>, val lineWidth: Float, val color: Color? = null, val lineColor: Color? = null)

Represents a polygon overlay on the map.

Link copied to clipboard
data class Polyline(val coordinates: List<Coordinates>, val width: Float, val lineColor: Color? = null)

Represents a polyline overlay on the map.

Functions

Link copied to clipboard
@Composable
actual fun Map(modifier: Modifier, cameraPosition: CameraPosition?, properties: MapProperties, uiSettings: MapUISettings, markers: List<Marker>, circles: List<Circle>, polygons: List<Polygon>, polylines: List<Polyline>, onCameraMove: (CameraPosition) -> Unit?, onMarkerClick: (Marker) -> Unit?, onCircleClick: (Circle) -> Unit?, onPolygonClick: (Polygon) -> Unit?, onPolylineClick: (Polyline) -> Unit?, onMapClick: (Coordinates) -> Unit?, onMapLongClick: (Coordinates) -> Unit?, onPOIClick: (Coordinates) -> Unit?, onMapLoaded: () -> Unit?)

Android implementation of the Map composable using Google Maps.

@Composable
expect fun Map(modifier: Modifier = Modifier, cameraPosition: CameraPosition? = null, properties: MapProperties, uiSettings: MapUISettings, markers: List<Marker> = emptyList(), circles: List<Circle> = emptyList(), polygons: List<Polygon> = emptyList(), polylines: List<Polyline> = emptyList(), onCameraMove: (CameraPosition) -> Unit? = null, onMarkerClick: (Marker) -> Unit? = null, onCircleClick: (Circle) -> Unit? = null, onPolygonClick: (Polygon) -> Unit? = null, onPolylineClick: (Polyline) -> Unit? = null, onMapClick: (Coordinates) -> Unit? = null, onMapLongClick: (Coordinates) -> Unit? = null, onPOIClick: (Coordinates) -> Unit? = null, onMapLoaded: () -> Unit? = null)

A cross-platform map component that provides access to native map APIs on Android and iOS.

@Composable
actual fun Map(modifier: Modifier, cameraPosition: CameraPosition?, properties: MapProperties, uiSettings: MapUISettings, markers: List<Marker>, circles: List<Circle>, polygons: List<Polygon>, polylines: List<Polyline>, onCameraMove: (CameraPosition) -> Unit?, onMarkerClick: (Marker) -> Unit?, onCircleClick: (Circle) -> Unit?, onPolygonClick: (Polygon) -> Unit?, onPolylineClick: (Polyline) -> Unit?, onMapClick: (Coordinates) -> Unit?, onMapLongClick: (Coordinates) -> Unit?, onPOIClick: (Coordinates) -> Unit?, onMapLoaded: () -> Unit?)

iOS implementation of the Map composable using Apple Maps (MapKit).