Documentación / Otros / Referencia de la API

Referencia de la API

Un índice de las API públicas de las 3 plataformas, ordenadas por concepto. La mayoría de los tipos tienen el mismo nombre en los 3 idiomas, pero los métodos de creación (constructores, fábricas, ganchos) y algunos nombres de tipos difieren según las convenciones del idioma. Están organizadas para que solo deba mirar las diferencias para poder portar.

01 · Paquetes

Además del núcleo, agregue a las dependencias solo los módulos de las funciones que use. Para los módulos de proveedores (for-*), consulte “Cambiar de proveedor”.

Funciones
Android
iOS
React
Núcleo
com.mapconductor:core
MapConductorCore
@mapconductor/js-sdk-core
Componentes declarativos
com.mapconductor:compose
Incluido en el núcleo
@mapconductor/js-sdk-react
Iconos
com.mapconductor:icons
MapConductorIcons
@mapconductor/react-icons
Agrupamiento
com.mapconductor:marker-clustering
MapConductorMarkerCluster
@mapconductor/react-marker-clustering
Mapa de calor
com.mapconductor:heatmap
MapConductorHeatmap
@mapconductor/react-heatmap
GeoJSON
com.mapconductor:geojson
MapConductorGeoJSON
@mapconductor/react-geojson-layer
KML
com.mapconductor:kml

Android publica una BOM (com.mapconductor:mapconductor-bom) que permite especificar las versiones juntas. iOS usa Swift Package Manager, React usa npm.

02 · Tipos del núcleo

Conceptos
Android
iOS
React
Coordenadas
GeoPoint
GeoPoint
GeoPoint · createGeoPoint()
Rango rectangular
GeoRectBounds
GeoRectBounds
createGeoRectBounds()
Posición de la cámara
MapCameraPosition
MapCameraPosition
createMapCameraPosition()
Estado del mapa
MapViewStateInterface<T>
MapViewStateProtocol
MapViewStateInterface<T>
Diseño del mapa
MapDesignTypeInterface<T>
MapDesignTypeProtocol
MapDesignTypeInterface<T>
Reglas de atribución
AttributionRule
AttributionRule
AttributionRule
Etapas de inicialización
InitState
InitState
InitState
Escape a nativo
MapViewHolderInterface
AnyMapViewHolder
MapViewHolder
Configuración de mosaicos de marcadores
MarkerTilingOptions
MarkerTilingOptions
MarkerTilingOptions

03 · Estados de los elementos

Todo lo que se coloca en el mapa tiene la forma de “crear un objeto de estado y pasarlo a la vista del mapa”. Kotlin y Swift usan constructores, TypeScript usa fábricas como createMarkerState().

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

Cualquier objeto de estado tiene id, zIndex, clickable, extra y onClick. Al reescribir una propiedad, se refleja solo esa diferencia sin volver a crear el objeto del mapa.

04 · Componentes

Contenedor para declarar un objeto de estado como hijo de la vista del mapa. Los mismos nombres se alinean en las 3 plataformas. Android los escribe como funciones de extensión de MapViewScope, iOS como el generador de resultados de MapViewContentBuilder, React como componentes secundarios.

Marker · Markers

1 o varios marcadores

Polyline · Polylines

Línea (iOS también ofrece plural)

Polygon · Polygons

Superficie (admite huecos)

Circle · Circles

Círculo con radio en metros

GroundImage · GroundImages

Imagen en el área

RasterLayer

Capa de mosaicos

InfoBubble · InfoBubbleCustom

Burbuja asociada a un marcador. InfoBubbleCustom es una versión de bajo nivel que dibuja el marco y la cola por sí misma.

MapAttributionOverlay

Mostrar atribución

05 · Funciones

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

La misma estructura de métodos para el modelo esférico y el modelo elipsoidal. Planar es un modelo lineal de latitud/longitud. →

Auxiliares para líneas y áreas
calculateMetersPerPixel · expandBounds · splitByMeridian · closestPointOnSegment · pointOnGeodesicLineOrNull · pointOnLinearLineOrNull

Las mismas funciones que el SDK usa internamente para la detección de toques y el trazado de rutas ortodrómicas. →

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

Proyección y constantes de la Tierra. Disponible públicamente para Android y React. →

Operar la vista del mapa
moveCameraTo · fitBounds · getMapViewHolder · mapDesignType

Común a todos los objetos de estado de cualquier proveedor. →

Páginas relacionadas