目录

HWMap

概述

API中的核心类,用来加载一张地图。

构造函数

函数

描述

HWMapJsSDK.HWMap(div, mapOptions)

  • div:填充地图容器。
  • mapOptions:设置地图属性,详情见MapOptions。

方法

方法

描述

参数类型

返回值

fitBounds(bounds)

设置地图显示区域范围。

LatLngBounds

-

fromScreenLocation(pixel)

屏幕坐标转经纬度。

说明:

地图加载完成后使用。

{x, y}

  • x:Number,横坐标偏移的像素数。
  • y:Number,纵坐标偏移的像素数。

LatLng

getBounds()

获取地图显示区域。

-

LatLngBounds

getCenter()

获取地图中心点坐标。

-

LatLng

getDiv()

获取装载地图的容器。

-

div容器。

getHeading()

获取地图朝向。

-

Number

表示地图朝向与正北夹角值。

getMapType()

获取地图类型。

-

String

getOpacity()

获取地图的不透明度。

-

Number

getPoi(pixel)

获取当前位置的POI数据。

[Number, Number]

表示地图上一个像素点坐标,分别表示横坐标和纵坐标。

返回当前点击位置的POI信息,包含位置和属性。

getSize()

获取地图大小。

-

返回[width, height]两个Number类型的数组。

getZoom()

获取地图当前缩放级别。

-

Number

panBy(x, y)

将地图中心点偏移(x, y)。

  • x:Number,横坐标偏移的像素数。
  • y:Number,纵坐标偏移的像素数。

-

panTo(latLng)

地图中心移动到指定坐标点。

LatLng

-

panToBounds(latLngBounds)

移动地图使得包含指定坐标区域。

[lng1, lat1, lng2, lat2]

-

resize()

重新计算地图容器大小。

-

-

setCenter(latlng)

设置地图中心点坐标。

LatLng

-

setCopyrightControl(enabled)

设置是否显示版权。

Boolean

  • true:显示
  • false:关闭

-

setFitView(points, options?)

根据输入的经纬度数组计算最优视角。

-

setHeading(heading)

设置地图朝向。

Number

值为地图朝向与实际正北的夹角,取值范围:[0, 360]。

-

setLocationControl(enabled)

设置是否显示当前位置按钮。

Boolean

  • true:显示
  • false:关闭

-

setLogoPosition(logoPosition)

设置Petal Maps Logo位置。

String

  • BOTTOM_LEFT:左下
  • BOTTOM_RIGHT:右下
  • TOP_LEFT:左上
  • TOP_RIGHT:右上

默认为BOTTOM_LEFT。

-

setMapType(mapType)

设置地图类型。

String

  • ROADMAP:基础地图
  • TERRAIN:地形图
  • SATELLITE:卫星图
  • HYBRID:混合模式

-

setNavigationControl(enabled)

设置是否显示平移按钮。

Boolean

  • true:显示
  • false:关闭

-

setOpacity(opacity)

设置地图不透明度。

Number

取值范围:[0, 1]。

-

setPinchRotate(disabled)

设置地图双指旋转是否可用。

Boolean,

  • true:可用
  • false:不可用

默认值为true。

-

setPresetStyleId(presetStyleId)

设置预置地图样式。

String

可选值为:standard、night、simple。

-

setPreviewId(previewId)

设置预览ID,通过预览ID设置自定义地图样式。

String

预览ID。

-

setRotateControl(enabled)

设置是否显示指北针。

Boolean

  • true:显示
  • false:关闭

-

setScaleControl(enabled)

设置是否显示比例尺。

Boolean

  • true:显示
  • false:关闭

-

setStyle(styles)

通过JSON文件设置自定义地图样式。

JSON数组。

-

setStyleId(styleId)

设置样式ID,通过样式ID设置自定义地图样式。

String

样式ID。

-

setTitle(title)

设置地图所在容器的提示信息。

String

-

setZoom(zoom)

设置地图缩放级别。

数值类型

取值范围:[minZoom, maxZoom]。

-

setZoomControl(enabled)

设置是否显示缩放按钮。

Boolean

  • true:显示
  • false:关闭

-

setZoomSlider(enabled)

设置是否显示缩放条。

Boolean

  • true:显示
  • false:关闭

-

toScreenLocation(latlng)

经纬度转屏幕坐标。

说明:

地图加载完成后使用。

LatLng

{x, y}

  • x:Number,横坐标偏移的像素数。
  • y:Number,纵坐标偏移的像素数。

zoomIn()

地图放大一个级别。

-

-

zoomOut()

地图缩小一个级别。

-

-

on(event, callback)

设置事件触发时调用的自定义函数。

  • event:String,事件类型,见事件。
  • callback:Function,事件触发的回调函数。

-

onCenterChanged(callback)

地图中心点改变。

Function

自定义回调函数。

-

onHeadingChanged(callback)

地图方向改变。

Function

自定义回调函数。

-

onZoomChanged(callback)

缩放级别改变。

Function

自定义回调函数。

-

un(event, callback)

解绑事件侦听。

  • event:String,事件类型,见事件。
  • callback:Function,事件触发的回调函数。

-

destroy()

销毁地图实例。

-

-

事件

事件

描述

用法

说明

click

鼠标左键点击,与dblclick会冲突。

map.on('click', callback)

callback回调函数中,参数event对象包含了两个重要的参数:

  • coordinate:墨卡托3857投影经纬度。可以使用HWMapJsSDK.HWMapUtils.epsgToLatLng(event.coordinate)方法,将墨卡托3857投影经纬度转换成日常使用经纬度。
  • pixel:屏幕坐标,当前交互点与屏幕左上角的像素距离。

contextmenu

鼠标右键点击。

map.on('contextmenu', callback)

dblclick

鼠标左键双击。

map.on('dblclick', callback)

singleclick

鼠标左键点击,此事件会延迟250毫秒,以确保它不是双击事件,与dblclick不冲突。

map.on('singleclick', callback)

pointermove

鼠标移动。

map.on('pointermove', callback)

pointerdown

鼠标键按下。

map.on('pointerdown', callback)

pointerup

鼠标键松开。

map.on('pointerup', callback)

pointerdrag

地图拖动。

map.on('pointerdrag', callback)

movestart

地图开始移动。

map.on('movestart', callback)

-

moveend

地图结束移动。

map.on('moveend', callback)

-

onCenterChanged

地图中心点改变。

map.onCenterChanged(callback)

-

onHeadingChanged

方向改变。

map.onHeadingChanged(callback)

-

onZoomChanged

缩放级别改变。

map.onZoomChanged(callback)

-

AuthOptions

参数

是否必选

参数类型

描述

accessToken

是

String

AT。

CopyrightControlOptions

参数

是否必选

参数类型

描述

value

是

String

目前支持文本或HTML的dom元素,dom元素支持以下标签:

  • <font>标签
  • <a>标签
  • <img>标签

MapOptions

参数

是否必选

参数类型

描述

authOptions

否

AuthOptions

设置AT。

center

是

LatLng

地图中心点。

copyrightControl

否

Boolean

设置地图是否显示版权,默认false。

copyrightControlOptions

否

CopyrightControlOptions

设置地图的版权内容。

language

否

String

设置地图语言,取值范围参见LanguageCode。

说明:

推荐使用BCP 47语言码。

locationControl

否

Boolean

设置地图是否显示当前位置按钮,默认false。

logoPosition

否

String

设置Petal Maps Logo位置。取值包括:

  • BOTTOM_LEFT:左下
  • BOTTOM_RIGHT:右下
  • TOP_LEFT:左上
  • TOP_RIGHT:右上

默认为BOTTOM_LEFT。

mapType

否

String

设置地图类型。取值包括:

  • ROADMAP:基础地图
  • TERRAIN:地形图
  • SATELLITE:卫星图
  • HYBRID:混合模式

maxZoom

否

Number

地图最大缩放级别。取值范围:[2, 20],默认20。

minZoom

否

Number

地图最小缩放级别。取值范围:[2, 20],默认2。

navigationControl

否

Boolean

设置地图是否显示平移按钮,默认false。

presetStyleId

否

String

设置预置地图样式。可选值为:standard、night、simple。

rotateControl

否

Boolean

设置地图是否显示指北针,默认false。

scaleControl

否

Boolean

设置地图是否显示比例尺,默认false。

sourceType

否

String

设置地图加载时使用的瓦片类型,支持vector(矢量)或raster(栅格),默认为vector。

zoom

是

Number

地图初始化时缩放级别。

zoomSlider

否

Boolean

设置地图是否显示缩放条,默认false。

zoomControl

否

Boolean

设置地图是否显示缩放按钮,默认true。

rasterPreload

否

Boolean

设置矢量图是否支持栅格预加载,默认true。

ScaleControlOptions

参数

是否必选

参数类型

描述

units

否

String

比例尺单位。取值包括:imperial(英制英寸)、nautical(海里)、metric(公制),默认为metric。

LanguageCode

ISO-639-2

BCP 47

中文名称

AFR

af

南非语

SQI

sq

阿尔巴尼亚语

AMH

am

阿姆哈拉语

AMH

am-Latn

阿姆哈拉语

ARA

ar

阿拉伯语

HYE

hy

亚美尼亚语

HYE

hy-Latn

亚美尼亚语

ASM

as-Latn

阿萨姆语

ASM

as

阿萨姆语

AYM

ay

艾马拉语

AZE

az

阿塞拜疆语

BAQ

eu

巴斯克语

BEL

be-Latn

白俄罗斯语

BEL

be

白俄罗斯语

BEN

bn-Latn

孟加拉语

BEN

bn

孟加拉语

BIS

bi

比斯拉马语

BOS

bs

波斯尼亚语

BRE

br

布列塔尼语

BUL

bg-Latn

保加利亚语

BUL

bg

保加利亚语

BUR

my

缅甸语

CAT

ca

加泰罗尼亚语

CHI

zh

中文简体

ZHO

zh-Hant

中文繁体

CES

cs

捷克语

DAN

da

丹麦语

DIV

dv

迪维西语

NLD

nl

荷兰语

DZO

dz

宗喀语

ENG

en

英语

EST

et

爱沙尼亚语

FAO

fo

法罗语

FIJ

fj

斐济语

FIL

tl

菲律宾语

FIN

fi

芬兰语

FRA

fr

法语

FRY

fy

弗里斯兰语

KAT

ka

格鲁吉亚语

KAT

ka-Latn

格鲁吉亚语

DEU

de

德语

GLA

gd

苏格兰盖尔语

GLE

ga

爱尔兰语

GLG

gl

加利西亚语

ELL

el

希腊语

ELL

el-Latn

希腊语

GRN

gn

瓜拉尼语

GUJ

gu-Latn

古吉拉特语

GUJ

gu

古吉拉特语

HAT

ht

海地法国克里奥尔语

HAU

ha

豪萨语

HEB

he-Latn

希伯来语

HEB

he

希伯来语

HIN

hi-Latn

印地语

HIN

hi

印地语

HMO

ho

希里莫图语

HUN

hu

匈牙利语

IBO

ig

伊博语

ISL

is

冰岛语

IKU

iu

因纽特语

IND

id

印尼语

ITA

it

意大利语

JPN

ja-Latn

日语

JPN

ja

日语

KAL

kl

格陵兰语

KAN

kn-Latn

卡纳达语

KAN

kn

卡纳达语

KAS

ks

克什米尔语

KAZ

kk-Latn

哈萨克语

KAZ

kk

哈萨克语

KHM

km-Latn

高棉语

KHM

km

高棉语

KIN

rw

卢旺达语

KIR

ky-Latn

柯尔克孜语

KIR

ky

柯尔克孜语

KOR

ko-Latn

韩语

KOR

ko

韩语

KUR

ku-Latn

库尔德语

KUR

ku

库尔德语

LAO

lo

老挝语

LAT

la

拉丁语

LAV

lv

拉脱维亚语

LIT

lt

立陶宛语

LTZ

lb

卢森堡语

MKD

mk-Latn

北马其顿语

MKD

mk

北马其顿语

MAH

mh

马绍尔语

MAL

ml

马拉雅拉姆语

MAL

ml-Latn

马拉雅拉姆语

MRI

mi

毛利语

MAR

mr-Latn

马拉地语

MAR

mr

马拉地语

MSA

ms

马来语

MLG

mg

马拉加斯语

MLT

mt

马耳他语

MON

mn-Latn

蒙古语

MON

mn

蒙古语

NAU

na

瑙鲁语

NDE

nd

北恩德贝莱语

NEP

ne-Latn

尼泊尔语

NEP

ne

尼泊尔语

NOR

no

挪威语

NYA

ny

齐切瓦语

OCI

oc

奥克语

ORI

or-Latn

奥里亚语

ORI

or

奥里亚语

ORM

om

奥罗莫语

PAN

pa

旁遮普语

PAN

pa-Latn

旁遮普语

PAN

pa-Arab

旁遮普语

PAN

pa-Guru

旁遮普语

FAS

fa-Latn

波斯语

FAS

fa

波斯语

POL

pl

波兰语

POR

pt

葡萄牙语

PUS

ps

普什图语

QUE

qu

克丘亚语

ROH

rm

罗曼什语

RON

ro

罗马尼亚语

RUN

rn

卢旺达-朗迪语

RUS

ru-Latn

俄语

RUS

ru

俄语

SAG

sg

桑戈语

SAN

sa

梵语

HRV

hr

克罗地亚语

SRP

sr-Latn

塞尔维亚语

SRP

sr

塞尔维亚语

SIN

si-Latn

僧伽罗语

SIN

si

僧伽罗语

SLK

sk

斯洛伐克语

SLV

sl

斯洛文尼亚语

SMO

sm

萨摩亚语

SNA

sn

修纳语

SND

sd-Latn

信德语

SND

sd

信德语

SOM

so

索马里语

SOT

st

塞索托语

SPA

es

西班牙文

SRD

sc

撒丁语

SSW

ss

斯威士语

SWA

sw

斯瓦希里语

SWE

sv

瑞典语

TAH

ty

塔希提语

TAM

ta-Latn

泰米尔语

TAM

ta

泰米尔语

TAT

tt-Latn

鞑靼语

TAT

tt

鞑靼语

TEL

te-Latn

泰卢固语

TEL

te

泰卢固语

TGK

tg-Latn

塔吉克语

TGK

tg

塔吉克语

THA

th-Latn

泰语

THA

th

泰语

TIR

ti-Latn

提格雷尼亚语

TIR

ti

提格雷尼亚语

TON

to

汤加语

TSN

tn

茨瓦纳语

TUK

tk

土库曼语

TUR

tr

土耳其语

UIG

ug-Latn

维吾尔语

UIG

ug

维吾尔语

UKR

uk-Latn

乌克兰语

UKR

uk

乌克兰语

URD

ur-Latn

乌尔都语

URD

ur

乌尔都语

UZB

uz-Latn

乌兹别克语

UZB

uz

乌兹别克语

VIE

vi

越南语

CYM

cy

威尔士语

WOL

wo

沃洛夫语

XHO

xh

科萨语

YOR

yo

约鲁巴语

ZUL

zu

祖鲁语