문서 / 그 밖에 / API 레퍼런스

API 레퍼런스

3개 플랫폼의 공개 API를 개념별로 정리한 색인입니다. 대부분의 타입은 3개 언어에서 같은 이름이지만, 생성 방법(생성자・팩토리・훅)과 일부 타입 이름은 각 언어의 작법에 맞춰 다릅니다. 다른 부분만 보면 이식할 수 있도록 배열했습니다.

01 · 패키지

코어에 더해, 쓰는 기능의 모듈만 의존에 추가합니다. 프로바이더 모듈(for-*)은 「프로바이더 전환」을 참조하세요.

기능
Android
iOS
React
코어
com.mapconductor:core
MapConductorCore
@mapconductor/js-sdk-core
선언적 컴포넌트
com.mapconductor:compose
코어에 포함
@mapconductor/js-sdk-react
아이콘
com.mapconductor:icons
MapConductorIcons
@mapconductor/react-icons
클러스터링
com.mapconductor:marker-clustering
MapConductorMarkerCluster
@mapconductor/react-marker-clustering
히트맵
com.mapconductor:heatmap
MapConductorHeatmap
@mapconductor/react-heatmap
GeoJSON
com.mapconductor:geojson
MapConductorGeoJSON
@mapconductor/react-geojson-layer
KML
com.mapconductor:kml

Android는 버전을 한꺼번에 지정할 수 있는 BOM(com.mapconductor:mapconductor-bom)을 공개하고 있습니다. iOS는 Swift Package Manager, React는 npm입니다.

02 · 코어의 타입

개념
Android
iOS
React
좌표
GeoPoint
GeoPoint
GeoPoint · createGeoPoint()
사각형 범위
GeoRectBounds
GeoRectBounds
createGeoRectBounds()
카메라 위치
MapCameraPosition
MapCameraPosition
createMapCameraPosition()
지도의 상태
MapViewStateInterface<T>
MapViewStateProtocol
MapViewStateInterface<T>
지도 디자인
MapDesignTypeInterface<T>
MapDesignTypeProtocol
MapDesignTypeInterface<T>
출처 표기 규칙
AttributionRule
AttributionRule
AttributionRule
초기화 단계
InitState
InitState
InitState
네이티브로 가는 통로
MapViewHolderInterface
AnyMapViewHolder
MapViewHolder
마커 타일 설정
MarkerTilingOptions
MarkerTilingOptions
MarkerTilingOptions

03 · 요소의 상태

지도에 놓는 것은 모두 「상태 객체를 하나 만들어 지도 뷰에 넘긴다」는 형태입니다. Kotlin・Swift는 생성자를, TypeScript는 createMarkerState() 같은 팩토리를 씁니다.

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

어느 상태 객체든 id・zIndex・clickable・extra・onClick을 가집니다. 프로퍼티를 바꿔 쓰면 지도 오브젝트를 다시 만들지 않고 그 차분만 반영됩니다.

04 · 컴포넌트

상태 객체를 지도 뷰의 자식으로 선언하기 위한 그릇입니다. 3개 플랫폼에서 같은 이름이 나란히 놓입니다. Android는 MapViewScope의 확장 함수, iOS는 MapViewContentBuilder의 결과 빌더, React는 자식 컴포넌트로 씁니다.

Marker · Markers

1건/여러 건의 마커

Polyline · Polylines

선(iOS는 복수형도 제공)

Polygon · Polygons

면(구멍 뚫기 지원)

Circle · Circles

미터 반지름의 원

GroundImage · GroundImages

범위에 붙이는 이미지

RasterLayer

타일 레이어

InfoBubble · InfoBubbleCustom

마커에 연결되는 말풍선. InfoBubbleCustom은 테두리와 꼬리를 직접 그리는 저수준 버전입니다.

MapAttributionOverlay

출처 표기 표시

05 · 함수

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

구체 모델과 타원체 모델이 같은 메서드 구성입니다. Planar는 위경도의 직선 모델입니다. →

선과 범위의 헬퍼
calculateMetersPerPixel · expandBounds · splitByMeridian · closestPointOnSegment · pointOnGeodesicLineOrNull · pointOnLinearLineOrNull

SDK 내부의 탭 판정과 대권 코스 그리기가 쓰는 것과 같은 함수입니다. →

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

투영과 지구의 상수. Android・React가 공개하고 있습니다. →

지도 뷰의 조작
moveCameraTo · fitBounds · getMapViewHolder · mapDesignType

어느 프로바이더의 상태 객체에도 공통으로 붙어 있습니다. →

관련 페이지