Class AMap

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

Since

1.0.0

Constructors

constructor

Properties

mapDelegate projection? uiSettings?

Methods

addCircle addMarker addMarkers addPolygon addPolyline animateCamera clear getCameraPosition getMapContentApprovalNumber getMapType getMaxZoomLevel getMinZoomLevel getMyLocation getMyLocationStyle getProjection getSatelliteImageApprovalNumber getUiSettings moveCamera removeOverlay setLocationSource setMapStatusLimits setMapType setMaxZoomLevel setMinZoomLevel setMyLocationEnabled setMyLocationStyle setOnCameraChangeListener setOnInfoWindowClickListener setOnMapClickListener setOnMapLongClickListener setOnMapTouchListener setOnMarkerClickListener setOnMarkerDragListener setOnMyLocationChangeListener setOnPolylineClickListener setTrafficEnabled showBuildings showMapText

Constructors

constructor

  • new AMap(iAMap): AMap

  • Parameters

    • iAMap: IAMap

    Returns AMap

Properties

Private mapDelegate

mapDelegate: IAMap

Private Optional projection

projection?: Projection

Private Optional uiSettings

uiSettings?: UiSettings

Methods

addCircle

  • addCircle(options): undefined | Circle

  • 在地图上添加一个圆（circle）对象。

    Parameters

    • options: CircleOptions

      一个circleOptions对象，它定义circle的属性信息。

    Returns undefined | Circle

    返回被添加的circle 对象。

    Since

    1.0.0

addMarker

  • addMarker(options): undefined | Marker

  • 在地图上添一个图片标记（marker）对象。

    Parameters

    • options: MarkerOptions

      一个markerOptions 对象，它定义了marker 的属性信息。

    Returns undefined | Marker

    返回被添加的marker对象。

    Since

    1.0.0

addMarkers

  • addMarkers(options, moveToCenter): ArrayList<Marker>

  • 在地图上添一组图片标记（marker）对象，并设置是否改变地图状态以至于所有的marker对象都在当前地图可视区域范围内显示。

    Parameters

    • options: ArrayList<MarkerOptions>

      多个markerOptions对象，它们分别定义了对应marker的属性信息。

    • moveToCenter: boolean

      是否改变地图状态，默认为false。

    Returns ArrayList<Marker>

    返回一组被添加的marker对象。

    Since

    1.0.0

addPolygon

  • addPolygon(options): undefined | Polygon

  • 在地图上添加一个多边形（polygon）对象。

    Parameters

    • options: PolygonOptions

      一个polygonOptions 对象，它定义了polygon的属性信息。

    Returns undefined | Polygon

    返回被添加的polygon对象。

    Since

    1.0.0

addPolyline

  • addPolyline(options): undefined | Polyline

  • 在地图上添加一个折线对象（polyline）对象。

    Parameters

    • options: PolylineOptions

      一个polylineOptions对象，它定义polyline的属性信息。

    Returns undefined | Polyline

    返回被添加的 polyline 对象。

    Since

    1.0.0

animateCamera

  • animateCamera(update): void

  • 以动画方式按照传入的CameraUpdate参数更新地图状态，默认动画耗时250毫秒。
    可以通过CameraUpdateFactory#zoomIn()等方法来生成对应的CameraUpdate对象。

    Parameters

    Returns void

    Since

    1.0.0

clear

  • clear(isKeepMyLocationOverlay?): void

  • 从地图上删除所有的覆盖物（marker，circle，polyline 等对象），但myLocationOverlay（内置定位覆盖物）除外。

    Parameters

    • Optional isKeepMyLocationOverlay: boolean

      是否保留myLocationOverlay。

    Returns void

    Since

    1.0.0

getCameraPosition

  • getCameraPosition(): undefined | CameraPosition

  • 获取地图的当前状态。

    Returns undefined | CameraPosition

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

    Since

    1.0.0

getMapContentApprovalNumber

  • getMapContentApprovalNumber(): string

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

    Returns string

    普通矢量地图审图号

    Since

    1.0.0

getMapType

  • getMapType(): MapType

  • 获取地图当前的模式。可以参考#MAP_TYPE_NORMAL、#MAP_TYPE_SATELLITE 等。

    Returns MapType

    地图当前的模式。

    Since

    1.0.0

getMaxZoomLevel

  • getMaxZoomLevel(): number

  • 返回地图可显示最大缩放级别。

    Returns number

    最大缩放级别。

    Since

    1.0.0

getMinZoomLevel

  • getMinZoomLevel(): number

  • 返回地图可显示最小缩放级别。

    Returns number

    最小缩放级别。

    Since

    1.0.0

getMyLocation

  • getMyLocation(): undefined | Location

  • 返回当前定位源（locationSource）提供的定位信息。如果未设置定位源（locationSource） 则返回null。

    Returns undefined | Location

    当前定位源（locationSource）提供的定位信息。

    Since

    1.0.0

getMyLocationStyle

  • getMyLocationStyle(): undefined | MyLocationStyle

  • 获取定位图层（myLocationOverlay）的样式。

    Returns undefined | MyLocationStyle

    myLocationStyle 定位图层（myLocationOverlay）样式。

    Since

    1.0.0

getProjection

  • getProjection(): undefined | Projection

  • 获取地图投影坐标转换器, 当地图初始化完成之前返回 null。

    Returns undefined | Projection

    地图投影坐标转换器。

    Since

    1.0.0

getSatelliteImageApprovalNumber

  • getSatelliteImageApprovalNumber(): string

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

    Returns string

    卫星地图审图号

    Since

    1.0.0

getUiSettings

  • getUiSettings(): undefined | UiSettings

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

    Returns undefined | UiSettings

    地图ui控制器。

    Since

    1.0.0

moveCamera

  • moveCamera(update): void

  • 按照传入的CameraUpdate参数改变地图状态。（直接改变状态，没有动画效果）
    可以通过CameraUpdateFactory#zoomIn()等方法来生成对应的CameraUpdate对象。

    Parameters

    Returns void

    Since

    1.0.0

removeOverlay

  • removeOverlay(id): void

  • 移除覆盖物

    Parameters

    • id: string

    Returns void

    Since

    1.0.0

setLocationSource

  • setLocationSource(locationSource): void

  • 设置定位源（locationSource）。

    Parameters

    Returns void

    Since

    1.0.0

setMapStatusLimits

  • setMapStatusLimits(latLngBounds): void

  • 设置地图显示范围，无论如何操作地图，显示区域都不能超过该矩形区域。

    Parameters

    • latLngBounds: LatLngBounds

      通过指定的两个经纬度坐标（左下、右上）构建的一个矩形区域，详情参见LatLngBounds

    Returns void

    Since

    1.0.0

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

setMaxZoomLevel

  • setMaxZoomLevel(zoomLevel): void

  • 设置地图最大缩放级别 缩放级别范围为[3, 20],超出范围将按最大级别计算 。 注：只有在有室内地图显示的情况下最大级别为20，否则最大级别为19。

    Parameters

    • zoomLevel: number

      最大缩放等级

    Returns void

    Since

    1.0.0

setMinZoomLevel

  • setMinZoomLevel(zoomLevel): void

  • 设置最小缩放级别 缩放级别范围为[3, 20],超出范围将按最小级别计算

    Parameters

    • zoomLevel: number

      最小缩放等级

    Returns void

    Since

    1.0.0

setMyLocationEnabled

  • setMyLocationEnabled(enabled): void

  • 设置是否打开定位图层（myLocationOverlay）。

    Parameters

    • enabled: boolean

      是否打开定位图层。

    Returns void

    Since

    1.0.0

setMyLocationStyle

  • setMyLocationStyle(style): void

  • 设置定位图层（myLocationOverlay）的样式。

    Parameters

    • style: MyLocationStyle

      myLocationStyle 定位图层（myLocationOverlay）样式。

    Returns void

    Since

    1.0.0

setOnCameraChangeListener

  • setOnCameraChangeListener(listener): void

  • 设置地图状态的监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setOnInfoWindowClickListener

  • setOnInfoWindowClickListener(listener): void

  • 设置marker的信息窗口点击事件监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setOnMapClickListener

  • setOnMapClickListener(listener): void

  • 设置地图点击事件监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setOnMapLongClickListener

  • setOnMapLongClickListener(listener): void

  • 设置地图长按事件监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setOnMapTouchListener

  • setOnMapTouchListener(listener): void

  • 设置地图触摸事件监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setOnMarkerClickListener

  • setOnMarkerClickListener(listener): void

  • 设置marker点击事件监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setOnMarkerDragListener

  • setOnMarkerDragListener(listener): void

  • marker拖动事件监听接口

    Parameters

    Returns void

    Since

    1.0.0

setOnMyLocationChangeListener

  • setOnMyLocationChangeListener(listener): void

  • 设置用户定位信息监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setOnPolylineClickListener

  • setOnPolylineClickListener(listener): void

  • 设置polyline点击事件监听接口。

    Parameters

    Returns void

    Since

    1.0.0

setTrafficEnabled

  • setTrafficEnabled(enabled): void

  • 设置是否打开交通路况图层。

    Parameters

    • enabled: boolean

      是否打开交通路况图层。

    Returns void

    Since

    1.0.0

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

showMapText

  • showMapText(enabled): void

  • 设置是否显示底图文字标注，默认显示。

    Parameters

    • enabled: boolean

      true： 表示显示，为默认值； false： 不显示

    Returns void

    Since

    1.0.0

Settings

Member Visibility

Theme

On This Page

constructormapDelegateprojectionuiSettingsaddCircleaddMarkeraddMarkersaddPolygonaddPolylineanimateCameracleargetCameraPositiongetMapContentApprovalNumbergetMapTypegetMaxZoomLevelgetMinZoomLevelgetMyLocationgetMyLocationStylegetProjectiongetSatelliteImageApprovalNumbergetUiSettingsmoveCameraremoveOverlaysetLocationSourcesetMapStatusLimitssetMapTypesetMaxZoomLevelsetMinZoomLevelsetMyLocationEnabledsetMyLocationStylesetOnCameraChangeListenersetOnInfoWindowClickListenersetOnMapClickListenersetOnMapLongClickListenersetOnMapTouchListenersetOnMarkerClickListenersetOnMarkerDragListenersetOnMyLocationChangeListenersetOnPolylineClickListenersetTrafficEnabledshowBuildingsshowMapText

Generated using TypeDoc