Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Map

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new Map(container: string | HTMLElement, opts?: Options): Map

  • 构造一个地图对象

    Parameters

    • container: string | HTMLElement

      地图容器的id或者是DOM元素

    • Optional opts: Options

      选项

    Returns Map

Methods

add

  • 添加覆盖物/图层

    Parameters

    Returns void

addControl

  • addControl(control: {}): void

  • 添加控件

    Parameters

    • control: {}

      控件

    Returns void

clearInfoWindow

  • clearInfoWindow(): void

  • 清除地图上的信息窗体。

    Returns void

clearLimitBounds

  • clearLimitBounds(): void

  • 清除限制区域

    Returns void

clearMap

  • clearMap(): void

  • 删除地图上所有的覆盖物

    Returns void

containerToLngLat

  • 地图容器像素坐标转为地图经纬度坐标

    Parameters

    • pixel: Pixel

      地图像素坐标

    Returns LngLat

destroy

  • destroy(): void

  • 注销地图对象，并清空地图容器

    Returns void

detailOnAMAP

  • detailOnAMAP(obj: { id: string; location?: LocationValue; name?: string }): void

  • 唤起高德地图客户端marker详情页

    Parameters

    • obj: { id: string; location?: LocationValue; name?: string }

      唤起参数

      • id: string
      • Optional location?: LocationValue
      • Optional name?: string

    Returns void

emit

  • emit(eventName: string, data?: any): Map

  • 触发事件

    Parameters

    • eventName: string

      事件名称

    • Optional data: any

      事件数据

    Returns Map

geodeticCoordToLngLat

  • Parameters

    Returns LngLat

getAllOverlays

  • getAllOverlays(type?: "marker" | "circle" | "polyline" | "polygon"): Overlay<any>[]

  • 返回添加的覆盖物对象

    Parameters

    • Optional type: "marker" | "circle" | "polyline" | "polygon"

      覆盖物类型

    Returns Overlay<any>[]

getBounds

  • 获取当前地图视图范围，获取当前可视区域

    Returns Bounds

getCenter

  • 获取地图中心点经纬度坐标值

    Returns LngLat

getCity

  • getCity(callback: (cityData: { city: string; citycode: string; district: string; province: string | never[] }) => void): void

  • 获取地图中心点所在区域

    Parameters

    • callback: (cityData: { city: string; citycode: string; district: string; province: string | never[] }) => void
        • (cityData: { city: string; citycode: string; district: string; province: string | never[] }): void

        • Parameters

          • cityData: { city: string; citycode: string; district: string; province: string | never[] }
            • city: string

              市名称

            • citycode: string

              市代码

            • district: string

              区名称

            • province: string | never[]

              省

          Returns void

    Returns void

getContainer

  • getContainer(): HTMLElement

  • 返回地图对象的容器

    Returns HTMLElement

getDefaultCursor

  • getDefaultCursor(): string

  • 获取地图默认鼠标指针样式

    Returns string

getFeatures

  • 获取地图显示元素种类

    Returns Feature | Feature[] | "all"

getLabelzIndex

  • getLabelzIndex(): number

  • 获取当前地图标注的显示顺序

    Returns number

getLang

  • 获取地图语言类型

    Returns Lang

getLayers

  • 获取地图图层数组

    Returns Layer[]

getLimitBounds

  • 获取Map的限制区域

    Returns Bounds

getMapStyle

  • getMapStyle(): string

  • 获取地图显示样式

    Returns string

getPitch

  • getPitch(): number

  • 获取俯仰角

    Returns number

getResolution

  • 获取指定位置的地图分辨率

    Parameters

    Returns number

getRotation

  • getRotation(): number

  • 获取地图顺时针旋转角度

    Returns number

getScale

  • getScale(dpi?: number): number

  • 获取当前地图比例尺

    Parameters

    • Optional dpi: number

      dpi

    Returns number

getSize

  • 获取地图容器像素大小

    Returns Size

getStatus

  • 获取当前地图状态信息

    Returns Status

getViewMode_

  • Returns ViewMode

getZoom

  • getZoom(): number

  • 获取当前地图缩放级别

    Returns number

lngLatToContainer

  • 地图经纬度坐标转为地图容器像素坐标

    Parameters

    Returns Pixel

lngLatToGeodeticCoord

lnglatToPixel

  • 地图经纬度坐标转换为平面地图像素坐标

    Parameters

    • lnglat: LocationValue

      经纬度坐标

    • Optional level: number

      缩放等级

    Returns Pixel

lnglatTocontainer

  • 地图经纬度坐标转为地图容器像素坐标

    Parameters

    Returns Pixel

off

  • off<C>(eventName: string, handler: "mv" | ((event: any) => void), context?: C): Map

  • 移除事件绑定

    Type parameters

    Parameters

    • eventName: string

      事件名称

    • handler: "mv" | ((event: any) => void)

      事件功能函数

    • Optional context: C

      事件上下文

    Returns Map

on

  • on<C>(eventName: string, handler: (event: any) => void, context?: C, once?: boolean, unshift?: boolean): Map

  • 注册事件

    Type parameters

    Parameters

    • eventName: string

      事件名称

    • handler: (event: any) => void

      事件回调函数

        • (event: any): void

        • Parameters

          • event: any

          Returns void

    • Optional context: C

      事件回调中的上下文

    • Optional once: boolean

      触发一次

    • Optional unshift: boolean

      更改事件顺序

    Returns Map

panBy

  • panBy(x: number, y: number): void

  • 以像素为单位，沿x方向和y方向移动地图

    Parameters

    • x: number

      横向移动像素，向右为正

    • y: number

      纵向移动像素，向下为正

    Returns void

panTo

  • 地图中心点平移至指定点位置

    Parameters

    Returns void

pixelToLngLat

  • 平面地图像素坐标转换为地图经纬度坐标

    Parameters

    • pixel: Pixel

      像素坐标

    • Optional level: number

      缩放等级

    Returns LngLat

plugin

  • plugin(name: string | string[], callback: () => void): Map

  • 加载插件， tips: 插件的类型定义不在本类型定义中给出，需要另行安装例如 3d地图：@types/amap-js-api-map3d 地区搜索：@types/amap-js-api-place-search

    Parameters

    • name: string | string[]

      插件名称

    • callback: () => void

      插件加载完成后的回调函数

        • (): void

        • Returns void

    Returns Map

poiOnAMAP

  • poiOnAMAP(obj: { id: string; location?: LocationValue; name?: string }): void

  • 唤起高德地图客户端marker页

    Parameters

    • obj: { id: string; location?: LocationValue; name?: string }

      唤起参数

      • id: string
      • Optional location?: LocationValue
      • Optional name?: string

    Returns void

remove

  • 删除覆盖物/图层

    Parameters

    Returns void

removeControl

  • removeControl(control: {}): void

  • 移除控件

    Parameters

    • control: {}

      控件

    Returns void

setBounds

  • 指定当前地图显示范围

    Parameters

    Returns Bounds

setCenter

  • 设置地图显示的中心点

    Parameters

    Returns void

setCity

  • setCity(city: string, callback: (coord: [string, string], zoom: number) => void): void

  • 按照行政区名称或adcode来设置地图显示的中心点。

    Parameters

    • city: string

      城市名称或城市编码

    • callback: (coord: [string, string], zoom: number) => void

      回调

        • (coord: [string, string], zoom: number): void

        • Parameters

          • coord: [string, string]
          • zoom: number

          Returns void

    Returns void

setDefaultCursor

  • setDefaultCursor(cursor: string): void

  • 设置鼠标指针默认样式

    Parameters

    • cursor: string

      指针样式

    Returns void

setDefaultLayer

  • 修改底图图层

    Parameters

    Returns void

setFeatures

  • 设置地图上显示的元素种类

    Parameters

    Returns void

setFitView

  • setFitView(overlayList?: Overlay<any> | Overlay<any>[], immediately?: boolean, avoid?: [number, number, number, number], maxZoom?: number): false | Bounds

  • 根据地图上添加的覆盖物分布情况，自动缩放地图到合适的视野级别

    Parameters

    • Optional overlayList: Overlay<any> | Overlay<any>[]

      覆盖物数组

    • Optional immediately: boolean

      是否需要动画过程

    • Optional avoid: [number, number, number, number]

      上下左右的像素避让宽度

    • Optional maxZoom: number

      最大缩放级别

    Returns false | Bounds

setLabelzIndex

  • setLabelzIndex(index: number): void

  • 设置地图标注显示的顺序

    Parameters

    • index: number

      显示顺序

    Returns void

setLang

  • setLang(lang: Lang): void

  • 设置地图语言类型

    Parameters

    • lang: Lang

      语言类型

    Returns void

setLayers

  • setLayers(layers: Layer[]): void

  • 设置地图图层数组

    Parameters

    • layers: Layer[]

      图层数组

    Returns void

setLimitBounds

  • setLimitBounds(bound: Bounds): void

  • 设置Map的限制区域

    Parameters

    Returns void

setMapStyle

  • setMapStyle(style: string): void

  • 设置地图的显示样式

    Parameters

    • style: string

      地图样式

    Returns void

setPitch

  • setPitch(pitch: number): void

  • 设置俯仰角

    Parameters

    • pitch: number

      俯仰角

    Returns void

setRotation

  • setRotation(rotation: number): void

  • 设置地图顺时针旋转角度，旋转原点为地图容器中心点

    Parameters

    • rotation: number

      旋转角度

    Returns void

setStatus

  • setStatus(status: Partial<Status>): void

  • 设置当前地图显示状态

    Parameters

    • status: Partial<Status>

      状态

    Returns void

setZoom

  • setZoom(level: number): void

  • 设置地图显示的缩放级别

    Parameters

    • level: number

      缩放级别

    Returns void

setZoomAndCenter

  • setZoomAndCenter(zoomLevel: number, center: LocationValue): void

  • 地图缩放至指定级别并以指定点为地图显示中心点

    Parameters

    • zoomLevel: number

      缩放等级

    • center: LocationValue

      缩放中心

    Returns void

zoomIn

  • zoomIn(): void

  • 地图放大一级显示

    Returns void

zoomOut

  • zoomOut(): void

  • 地图缩小一级显示

    Returns void

Generated using TypeDoc