Skip to main content

API Reference

The SDK exposes the same class model on every platform — the C++ core is wrapped by SWIG into native Java, Objective-C/Swift and C# bindings, so classes and methods map 1:1 with a per-platform naming convention.

Two surfaces

This page documents the object API — the classes an app constructs and wires by hand. New work targets the surface API instead: ids, JSON specs and dotted paths, the same in every language, with its own generated reference. Both are supported, and adopt moves an app from one to the other a piece at a time.

Generated reference

PlatformReferenceNaming
Android (Java/Kotlin)Javadoc →package com.massifmaps.*, e.g. com.massifmaps.ui.MapView
iOS (Objective-C/Swift)Jazzy →MSF prefix, e.g. MSFMapView
Generated on release

The per-language reference is generated by CI on every release and published alongside this site. If the links above 404, the docs build has not published API output yet — see building the docs.

Naming conventions

ConceptAndroidiOS
Classcom.massifmaps.ui.MapViewMSFMapView
Enum valueCartoBaseMapStyle.MASSIF_BASEMAP_STYLE_VOYAGER.MASSIF_BASEMAP_STYLE_VOYAGER
GettergetZoom() / property zoomgetZoom()
Vector containerMapPosVectorMSFMapPosVector

Key packages

PackageWhat's in it
com.massifmaps.coreMapPos, MapBounds, MapVec, vectors, Variant.
com.massifmaps.uiMapView and click/gesture listeners.
com.massifmaps.layers*TileLayer, VectorLayer, HillshadeRasterTileLayer, CompositeVectorTileLayer, CustomRasterTileLayer.
com.massifmaps.datasourcesHTTPTileDataSource, MBTilesTileDataSource, PMTilesTileDataSource, ContourTileDataSource, caches.
com.massifmaps.componentsOptions, TerrainOptions, Layers.
com.massifmaps.styles / com.massifmaps.vectortilesCartoCSS styling and vector-tile decoders.
com.massifmaps.geometry / com.massifmaps.vectorelementsGeometry and on-map elements (markers, lines, polygons, popups).
com.massifmaps.routing / com.massifmaps.geocodingValhalla/SGRE routing and (reverse) geocoding.

Fork-specific classes

These do not exist in the original CARTO 4.x API — see the Features section for guides: