Class AMap

定义AMap 地图对象的操作方法与接口。

Since

1.0.0

Index

Constructors

constructor

new AMap(iAMap): AMap
Parameters
- iAMap: IAMap
Returns AMap
- Defined in module/src/api/AMap.ts:39

Properties

`Private` mapDelegate

mapDelegate: IAMap

`Private` `Optional` projection

projection?: Projection

`Private` `Optional` uiSettings

uiSettings?: UiSettings

Methods

addAMapAppResourceListener

addAMapAppResourceListener(listener): void
Parameters
- listener: AMapAppResourceRequestListener
Returns void
- Defined in module/src/api/AMap.ts:646

addCircle

addCircle(options): undefined | Circle
在地图上添加一个圆（circle）对象。
Parameters
- options: CircleOptions
  一个circleOptions对象，它定义circle的属性信息。
Returns undefined | Circle
返回被添加的circle 对象。

Since
1.0.0
- Defined in module/src/api/AMap.ts:96

addGL3DModel

addGL3DModel(options): undefined | GL3DModel
在地图上添一个3d模型。
Parameters
- options: GL3DModelOptions
  GL3DModelOptions 对象，它定义了模型的属性信息。
Returns undefined | GL3DModel
返回被添加的GL3DModel对象。

Since
2.0.0
- Defined in module/src/api/AMap.ts:141

addInfoWindowListener

addInfoWindowListener(adapter): void
添加infowindow的监听
Parameters
- adapter: InfoWindowListener
Returns void
Since
V2.0.0
- Defined in module/src/api/AMap.ts:689

addMarker

addMarker(options): undefined | Marker
在地图上添一个图片标记（marker）对象。
Parameters
- options: MarkerOptions
  一个markerOptions 对象，它定义了marker 的属性信息。
Returns undefined | Marker
返回被添加的marker对象。

Since
1.0.0
- Defined in module/src/api/AMap.ts:107

addMarkers

addMarkers(options, moveToCenter?): ArrayList<Marker>
在地图上添一组图片标记（marker）对象，并设置是否改变地图状态以至于所有的marker对象都在当前地图可视区域范围内显示。
Parameters
- options: ArrayList<MarkerOptions>
  多个markerOptions对象，它们分别定义了对应marker的属性信息。
- moveToCenter: boolean = false
  是否改变地图状态，默认为false。
Returns ArrayList<Marker>
返回一组被添加的marker对象。

Since
1.0.0
- Defined in module/src/api/AMap.ts:119

addOnPOIClickListener

addOnPOIClickListener(listener): void
添加地图上Poi点击监听
Parameters
- listener: OnMapPOIClickListener
  监听
Returns void
Since
2.0.0
- Defined in module/src/api/AMap.ts:708

addPolygon

addPolygon(options): undefined | Polygon
在地图上添加一个多边形（polygon）对象。
Parameters
- options: PolygonOptions
  一个polygonOptions 对象，它定义了polygon的属性信息。
Returns undefined | Polygon
返回被添加的polygon对象。

Since
1.0.0
- Defined in module/src/api/AMap.ts:85

addPolyline

addPolyline(options): undefined | Polyline
在地图上添加一个折线对象（polyline）对象。
Parameters
- options: PolylineOptions
  一个polylineOptions对象，它定义polyline的属性信息。
Returns undefined | Polyline
返回被添加的 polyline 对象。

Since
1.0.0
- Defined in module/src/api/AMap.ts:74

animateCamera

animateCamera(update, cancelableCallback?, durationMs?): void
按照指定的动画时长及传入的CameraUpdate参数更新地图状态，，同时设置一个cancelableCallback来监听动画执行的结果。
可以通过CameraUpdateFactory#zoomIn()等方法来生成对应的CameraUpdate对象。
Parameters
- update: CameraUpdate
  地图状态将要发生的变化。
- Optional cancelableCallback: CancelableCallback
  如果动画正常完成，则会回调onFinish()方法，被中断时回调onCancel()。
- Optional durationMs: number
  动画的持续时间，单位毫秒。默认动画耗时250毫秒
Returns void
Since
V2.0.0
- Defined in module/src/api/AMap.ts:63

calculateZoomToSpanLevel

calculateZoomToSpanLevel(paddingLeft, paddingRight, paddingTop, paddingBottom, leftDown, rightUp): undefined | [number, LatLng]
通过指定的两个经纬度坐标（左下、右上）及屏幕边距计算出合适的缩放级别及中心点。
Parameters
- paddingLeft: number
  屏幕左内边距
- paddingRight: number
  屏幕右内边距
- paddingTop: number
  屏幕顶部内边距
- paddingBottom: number
  屏幕底部内边距
- leftDown: LatLng
  左下角 (经纬度)
- rightUp: LatLng
  右上角 (经纬度)
Returns undefined | [number, LatLng]
Pair对象, first:缩放级别,second:中心的(经纬度)

Since
2.0.0
- Defined in module/src/api/AMap.ts:759

clear

clear(isKeepMyLocationOverlay?): void
从地图上删除所有的覆盖物（marker，circle，polyline 等对象），但myLocationOverlay（内置定位覆盖物）除外。
Parameters
- Optional isKeepMyLocationOverlay: boolean
  是否保留myLocationOverlay。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:151

getCameraPosition

getCameraPosition(): undefined | CameraPosition
获取地图的当前状态。

Returns undefined | CameraPosition
一个cameraPosition对象，表示地图的当前状态。

Since
1.0.0
- Defined in module/src/api/AMap.ts:364

getMapContentApprovalNumber

getMapContentApprovalNumber(): string
获取地图审图号（普通地图）
任何使用高德地图API调用地图服务的应用必须在其应用中对外透出审图号
如高德地图在"关于"中体现

Returns string
普通矢量地图审图号

Since
1.0.0
- Defined in module/src/api/AMap.ts:577

getMapScreenMarkers

getMapScreenMarkers(): ArrayList<Marker>
获取当前地图可视区域范围所有marker对象。

Returns ArrayList<Marker>
当前地图可视区域范围的所有marker对象。

Since
V2.0.0
- Defined in module/src/api/AMap.ts:129

getMapTextZIndex

getMapTextZIndex(): number
得到地图底图文字标注的层级指数。

Returns number
地图底图文字标注的层级指数。

Since
v2.0.0
- Defined in module/src/api/AMap.ts:172

getMapType

getMapType(): MapType
获取地图当前的模式。可以参考#MAP_TYPE_NORMAL、#MAP_TYPE_SATELLITE 等。

Returns MapType
地图当前的模式。

Since
1.0.0
- Defined in module/src/api/AMap.ts:312

getMaxZoomLevel

getMaxZoomLevel(): number
返回地图可显示最大缩放级别。

Returns number
最大缩放级别。

Since
1.0.0
- Defined in module/src/api/AMap.ts:435

getMinZoomLevel

getMinZoomLevel(): number
返回地图可显示最小缩放级别。

Returns number
最小缩放级别。

Since
1.0.0
- Defined in module/src/api/AMap.ts:446

getMyLocation

getMyLocation(): undefined | Location
返回当前定位源（locationSource）提供的定位信息。如果未设置定位源（locationSource）则返回null。

Returns undefined | Location
当前定位源（locationSource）提供的定位信息。

Since
1.0.0
- Defined in module/src/api/AMap.ts:354

getMyLocationStyle

getMyLocationStyle(): undefined | MyLocationStyle
获取定位图层（myLocationOverlay）的样式。

Returns undefined | MyLocationStyle
myLocationStyle 定位图层（myLocationOverlay）样式。

Since
1.0.0
- Defined in module/src/api/AMap.ts:322

getNativeMapController

getNativeMapController(): bigint
获取底层地图控制对象，仅供导航使用需要在onMapLoaded之后调用

Returns bigint
Exclude
javadoc中不显示

Since
V2.0.0
- Defined in module/src/api/AMap.ts:333

getNativeMapEngineID

getNativeMapEngineID(): number
获取底层地图引擎ID，仅供导航使用需要在onMapLoaded之后调用

Returns number
Exclude
javadoc中不显示

Since
V2.0.0
- Defined in module/src/api/AMap.ts:344

getProjection

getProjection(): undefined | Projection
获取地图投影坐标转换器, 当地图初始化完成之前返回 null。

Returns undefined | Projection
地图投影坐标转换器。

Since
1.0.0
- Defined in module/src/api/AMap.ts:565

getSatelliteImageApprovalNumber

getSatelliteImageApprovalNumber(): string
获取地图审图号（卫星地图）
任何使用高德地图API调用地图服务的应用必须在其应用中对外透出审图号
如高德地图在"关于"中体现

Returns string
卫星地图审图号

Since
1.0.0
- Defined in module/src/api/AMap.ts:590

getScalePerPixel

getScalePerPixel(): number
获取当前缩放级别下，地图上1像素点对应的长度，单位米。

Returns number
当前缩放级别下，地图上1像素点对应的长度，单位米。

Since
V2.0.0
- Defined in module/src/api/AMap.ts:671

getUiSettings

getUiSettings(): undefined | UiSettings
获取地图ui控制器，可以控制内置ui（缩放按钮、指北针等）是否显示及部分手势（滑动、双指缩放等）是否可用。

Returns undefined | UiSettings
地图ui控制器。

Since
1.0.0
- Defined in module/src/api/AMap.ts:555

getZoomToSpanLevel

getZoomToSpanLevel(leftDown, rightUp): number
Parameters
- leftDown: LatLng
- rightUp: LatLng
Returns number
- Defined in module/src/api/AMap.ts:743

isMyLocationEnabled

isMyLocationEnabled(): boolean
返回是否打开定位图层（myLocationOverlay）。

Returns boolean
是否打开定位图层。

Since
2.0.0
- Defined in module/src/api/AMap.ts:384

isTouchPoiEnable

isTouchPoiEnable(): boolean
获取地图POI是否允许点击。

Returns boolean
true：表示允许点击，为默认值； false：不允许点击

Since
2.0.0
- Defined in module/src/api/AMap.ts:739

isTrafficEnabled

isTrafficEnabled(): boolean
获取是否打开交通路况图层。

Returns boolean
是否打开交通路况图层。

Since
V2.0.0
- Defined in module/src/api/AMap.ts:486

moveCamera

moveCamera(update): void
按照传入的CameraUpdate参数改变地图状态。（直接改变状态，没有动画效果）
可以通过CameraUpdateFactory#zoomIn()等方法来生成对应的CameraUpdate对象。
Parameters
- update: CameraUpdate
  地图状态将要发生的变化。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:50

removeAMapAppResourceListener

removeAMapAppResourceListener(listener): void
Parameters
- listener: AMapAppResourceRequestListener
Returns void
- Defined in module/src/api/AMap.ts:650

removeInfoWindowListener

removeInfoWindowListener(adapter): void
移除infowindow的监听
Parameters
- adapter: InfoWindowListener
Returns void
Since
V2.0.0
- Defined in module/src/api/AMap.ts:698

removeOnPOIClickListener

removeOnPOIClickListener(listener): void
删除地图上Poi点击监听
Parameters
- listener: OnMapPOIClickListener
  监听
Returns void
Since
2.0.0
- Defined in module/src/api/AMap.ts:718

removeOverlay

removeOverlay(id): void
移除覆盖物
Parameters
- id: string
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:638

resetMinMaxZoomPreference

resetMinMaxZoomPreference(): void
重置最小及最大缩放级别将恢复最小级别为3，最大级别为20 。注：只有在有室内地图显示的情况下最大级别为20，否则最大级别为19。

Returns void
Since
2.0.0
- Defined in module/src/api/AMap.ts:456

runOnDrawFrame

runOnDrawFrame(): void
触发地图立即刷新。

Returns void
Since
V2.0
- Defined in module/src/api/AMap.ts:680

setCustomRenderer

setCustomRenderer(render): void
设置地图在初始化及每一帧绘制时的回调接口，该接口在OpenGL线程中调用。
Parameters
- render: CustomRenderer
  地图在初始化及每一帧绘制时的回调接口。
Returns void
Since
V2.0.0
- Defined in module/src/api/AMap.ts:532

setInfoWindowAdapter

setInfoWindowAdapter(adapter): void
设置marker的信息窗口定制接口。
Parameters
- adapter: CustomBuilder
  marker的信息窗口定制接口。
Returns void
Since
2.0.0
- Defined in module/src/api/AMap.ts:290

setLocationSource

setLocationSource(locationSource): void
设置定位源（locationSource）。
Parameters
- locationSource: LocationSource
  定位源（locationSource）。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:374

setMapStatusLimits

setMapStatusLimits(latLngBounds): void
设置地图显示范围，无论如何操作地图，显示区域都不能超过该矩形区域。
Parameters
- latLngBounds: LatLngBounds
  通过指定的两个经纬度坐标（左下、右上）构建的一个矩形区域，详情参见LatLngBounds
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:466

setMapTextZIndex

setMapTextZIndex(x): void
设置地图底图文字标注的层级指数，默认为0，用来比较覆盖物（polyline、polygon、circle等）的zIndex。如果覆盖物的zIndex大于底图文字标注的zIndex，则覆盖物会在文字标注上层绘制，否则，覆盖物在文字标注下面绘制。
Parameters
- x: number
  为地图底图文字标注的层级指数，默认为0。
Returns void
Since
v2.0.0
- Defined in module/src/api/AMap.ts:162

setMapType

setMapType(type): void
设置地图模式。
Parameters
- type: MapType
  地图模式： MAP_TYPE_NORMAL：普通地图，值为1；
  MAP_TYPE_SATELLITE：卫星地图，值为2；
  MAP_TYPE_NIGHT 黑夜地图，夜间模式，值为3；
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:302

setMaxZoomLevel

setMaxZoomLevel(zoomLevel): void
设置地图最大缩放级别缩放级别范围为[3, 20],超出范围将按最大级别计算。注：只有在有室内地图显示的情况下最大级别为20，否则最大级别为19。
Parameters
- zoomLevel: number
  最大缩放等级
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:415

setMinZoomLevel

setMinZoomLevel(zoomLevel): void
设置最小缩放级别缩放级别范围为[3, 20],超出范围将按最小级别计算
Parameters
- zoomLevel: number
  最小缩放等级
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:425

setMyLocationEnabled

setMyLocationEnabled(enabled): void
设置是否打开定位图层（myLocationOverlay）。
Parameters
- enabled: boolean
  是否打开定位图层。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:394

setMyLocationStyle

setMyLocationStyle(style): void
设置定位图层（myLocationOverlay）的样式。
Parameters
- style: MyLocationStyle
  myLocationStyle 定位图层（myLocationOverlay）样式。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:404

setNaviLabelEnable

setNaviLabelEnable(enabled, flushInterval, flushMode): void
设置导航模式是否显示label，默认不显示。
Parameters
- enabled: boolean
  true：表示显示，为默认值； false：不显示
- flushInterval: number
  刷新标注的间隔帧数阈值。
- flushMode: number
  1时，实现强制刷新效果
Returns void
Exclude
javadoc中不显示

Since
V2.0.0
- Defined in module/src/api/AMap.ts:522

setOnCameraChangeListener

setOnCameraChangeListener(listener): void
设置地图状态的监听接口。
Parameters
- listener: OnCameraChangeListener
  地图状态的监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:233

setOnInfoWindowClickListener

setOnInfoWindowClickListener(listener): void
设置marker的信息窗口点击事件监听接口。
Parameters
- listener: OnInfoWindowClickListener
  marker的信息窗口点击事件监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:202

setOnMapClickListener

setOnMapClickListener(listener): void
设置地图点击事件监听接口。
Parameters
- listener: OnMapClickListener
  地图单击事件监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:243

setOnMapLongClickListener

setOnMapLongClickListener(listener): void
设置地图长按事件监听接口。
Parameters
- listener: OnMapLongClickListener
  地图长按事件监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:254

setOnMapTouchListener

setOnMapTouchListener(listener): void
设置地图触摸事件监听接口。
Parameters
- listener: OnMapTouchListener
  地图触摸事件监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:264

setOnMarkerClickListener

setOnMarkerClickListener(listener): void
设置marker点击事件监听接口。
Parameters
- listener: OnMarkerClickListener
  marker点击事件监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:212

setOnMarkerDragListener

setOnMarkerDragListener(listener): void
marker拖动事件监听接口
Parameters
- listener: OnMarkerDragListener
  marker拖动事件监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:192

setOnMyLocationChangeListener

setOnMyLocationChangeListener(listener): void
设置用户定位信息监听接口。
Parameters
- listener: OnMyLocationChangeListener
  用户定位信息监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:182

setOnPolylineClickListener

setOnPolylineClickListener(listener): void
设置polyline点击事件监听接口。
Parameters
- listener: OnPolylineClickListener
  polyline点击事件监听接口。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:222

setPointToCenter

setPointToCenter(x, y): void
设置屏幕上的某个像素点为地图中心点。

使用该方法设置后，地图将以所设置的屏幕坐标点为中心进行旋转、倾斜。同时， #moveCamera(CameraUpdate) 方法也将会以此坐标点为中心进行设置。
Parameters
- x: number
  屏幕像素点x轴坐标。
- y: number
  屏幕像素点y轴坐标。
Returns void
Since
v2.0.0
- Defined in module/src/api/AMap.ts:544

setRenderFps

setRenderFps(fps): void
设置地图每秒渲染的帧数
Parameters
- fps: number
  帧率
Returns void
Exclude
javadoc中不显示

Since
2.0.0
- Defined in module/src/api/AMap.ts:661

setTouchPoiEnable

setTouchPoiEnable(touchPoiEnable): void
设置地图POI是否允许点击。默认情况下单击地铁站，地铁路线会高亮，如果关闭了poi单击，则地铁站不会被单击，地铁路线也不会高亮
Parameters
- touchPoiEnable: boolean
  true：表示允许点击，为默认值； false：不允许点击
Returns void
Since
2.0.0
- Defined in module/src/api/AMap.ts:729

setTrafficEnabled

setTrafficEnabled(enabled): void
设置是否打开交通路况图层。
Parameters
- enabled: boolean
  是否打开交通路况图层。
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:476

showBuildings

showBuildings(enabled): void
设置是否显示3D建筑物，默认显示。
注：
1. 开启显示3D建筑物后，地图需要被放大至Zoomlevel 17级以上且地图仰角>0（在地图上双指下滑可以调为仰视视角）时，才能可以看到3D建筑物的效果。
2. 夜间模式的地图无3D建筑物效果。
Parameters
- enabled: boolean
  true：显示3D建筑物；false：不显示；
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:509

showMapText

showMapText(enabled): void
设置是否显示底图文字标注，默认显示。
Parameters
- enabled: boolean
  true：表示显示，为默认值； false：不显示
Returns void
Since
1.0.0
- Defined in module/src/api/AMap.ts:496

Class AMap

Since

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AMap

Properties

Private mapDelegate

Private Optional projection

Private Optional uiSettings

Methods

addAMapAppResourceListener

Parameters

Returns void

addCircle

Parameters

Returns undefined | Circle

Since

addGL3DModel

Parameters

Returns undefined | GL3DModel

Since

addInfoWindowListener

Parameters

Returns void

Since

addMarker

Parameters

Returns undefined | Marker

Since

addMarkers

Parameters

Returns ArrayList<Marker>

Since

addOnPOIClickListener

Parameters

Returns void

Since

addPolygon

Parameters

Returns undefined | Polygon

Since

addPolyline

Parameters

Returns undefined | Polyline

Since

animateCamera

Parameters

Returns void

Since

calculateZoomToSpanLevel

Parameters

Returns undefined | [number, LatLng]

Since

clear

Parameters

Returns void

Since

getCameraPosition

Returns undefined | CameraPosition

Since

getMapContentApprovalNumber

Returns string

Since

getMapScreenMarkers

Returns ArrayList<Marker>

Since

getMapTextZIndex

Returns number

Since

getMapType

Returns MapType

Since

getMaxZoomLevel

Returns number

Since

`Private` mapDelegate

`Private` `Optional` projection

`Private` `Optional` uiSettings