Docs / More / API reference

API reference

An index of the public API on all three platforms, one concept per row. Most types share a name across the three languages; how you build them — constructor, factory, hook — and a handful of type names follow each language conventions. The table is arranged so you only have to read the differences.

01 · Packages

Add core plus only the modules you use. For the provider modules (for-*), see Switching providers.

Feature
Android
iOS
React
Core
com.mapconductor:core
MapConductorCore
@mapconductor/js-sdk-core
Declarative components
com.mapconductor:compose
in Core
@mapconductor/js-sdk-react
Icons
com.mapconductor:icons
MapConductorIcons
@mapconductor/react-icons
Clustering
com.mapconductor:marker-clustering
MapConductorMarkerCluster
@mapconductor/react-marker-clustering
Heatmap
com.mapconductor:heatmap
MapConductorHeatmap
@mapconductor/react-heatmap
GeoJSON
com.mapconductor:geojson
MapConductorGeoJSON
@mapconductor/react-geojson-layer
KML
com.mapconductor:kml

Android publishes a BOM (com.mapconductor:mapconductor-bom) so versions can be pinned in one place. iOS is Swift Package Manager; React is npm.

02 · Core types

Concept
Android
iOS
React
Coordinate
GeoPoint
GeoPoint
GeoPoint · createGeoPoint()
Bounds
GeoRectBounds
GeoRectBounds
createGeoRectBounds()
Camera position
MapCameraPosition
MapCameraPosition
createMapCameraPosition()
Map view state
MapViewStateInterface<T>
MapViewStateProtocol
MapViewStateInterface<T>
Map design
MapDesignTypeInterface<T>
MapDesignTypeProtocol
MapDesignTypeInterface<T>
Attribution rule
AttributionRule
AttributionRule
AttributionRule
Init state
InitState
InitState
InitState
Native escape hatch
MapViewHolderInterface
AnyMapViewHolder
MapViewHolder
Marker tiling
MarkerTilingOptions
MarkerTilingOptions
MarkerTilingOptions

03 · Element states

Everything you put on the map follows one shape: build one state object and hand it to the map view. Kotlin and Swift use the constructor; TypeScript uses a factory such as createMarkerState().

Android
iOS
React
Page
MarkerState
MarkerState
createMarkerState()
PolylineState
PolylineState
createPolylineState()
PolygonState
PolygonState
createPolygonState()
CircleState
CircleState
createCircleState()
GroundImageState
GroundImageState
createGroundImageState()
RasterLayerState
RasterLayerState
createRasterLayerState()

Every state object carries id, zIndex, clickable, extra and onClick. Assigning to a property applies just that difference — the map object is never rebuilt.

04 · Components

These are the wrappers that declare a state object as a child of the map view. The names line up across all three: Android uses MapViewScope extension functions, iOS a MapViewContentBuilder result builder, React plain child components.

Marker · Markers
One marker, or a list
Polyline · Polylines
Lines (iOS also has the plural)
Polygon · Polygons
Areas, with holes
Circle · Circles
Metre-radius circles
GroundImage · GroundImages
An image pinned to bounds
RasterLayer
A tile layer
InfoBubble · InfoBubbleCustom
A bubble anchored to a marker; InfoBubbleCustom is the low-level form where you draw the frame and tail yourself.
MapAttributionOverlay
Renders the attribution text

05 · Functions

Spherical · WGS84Geodesic · Planar
computeDistanceBetween · computeHeading · computeOffset · computeOffsetOrigin · computeLength · computeArea · computeSignedArea · interpolate

The spherical and ellipsoidal models expose the same method set; Planar is the straight lat/lng model.

Line and bounds helpers
calculateMetersPerPixel · expandBounds · splitByMeridian · closestPointOnSegment · pointOnGeodesicLineOrNull · pointOnLinearLineOrNull

The same functions the SDK own hit testing and great-circle rendering use.

Earth · WebMercator · WGS84
project · unproject · RADIUS_METERS · FLATTENING · CIRCUMFERENCE_METERS

Projections and the Earth constants; exposed on Android and React.

Map view operations
moveCameraTo · fitBounds · getMapViewHolder · mapDesignType

Present on every provider state object.

Related pages