Skip to content

[去看示例]

addShip(data)

注意!

若某艘船不绘制真实船体,toBow,toStern,toStarboard,toPort 请同时传0。否则会出现真实船体无法绘制的问题

添加船舶数据

参数说明类型可选值默认值
data渲染船舶所需的数据Array-null

data参数结构如下:

参数说明类型默认值是否必须备注
id船舶唯一idString或Number--
name船舶标签默认名称String--
lon船舶所在经度Number-请遵照Number最长位数
lat船舶唯所在纬度Number-请遵照Number最长位数
updateTime船舶更新时间String-毫秒级时间戳
color真实船舶颜色String--
imageName自定义图片名称String-与addShipImg数据中的name一致
toBow船舶定位器到船头距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
toStern船舶定位器到船尾距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
toStarboard船舶定位器到右弦距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
toPort船舶定位器到左弦距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
width船舶宽度Number-用于绘制真实船体所需参数,若无则不绘制
length船舶长度Number-用于绘制真实船体所需参数,若无则不绘制
hdg船艏向(°)Number-与sog一起构成地图上船舶朝向
rot船舶转向Number-用于判断默认船舶图片前方横线朝向
sog航速Number-与hdg一起构成地图上船舶朝向

removeShip(ids)

移除船舶数据

参数说明类型可选值默认值
ids需要移除的船舶唯一id数组Array-null

setSelect(shipInfo)

设置船舶选中,多次调用可选中多艘

参数说明类型默认值是否必须备注
id船舶唯一idString或Number--
name船舶标签默认名称String--
lon船舶所在经度Number-请遵照Number最长位数
lat船舶唯所在纬度Number-请遵照Number最长位数
updateTime船舶更新时间String-毫秒级时间戳
color真实船舶颜色String--
imageName自定义图片名称String-与addShipImg数据中的name一致
toBow船舶定位器到船头距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
toStern船舶定位器到船尾距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
toStarboard船舶定位器到右弦距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
toPort船舶定位器到左弦距离Number-用于绘制真实船体所需参数,若无或为0,则不绘制
hdg船艏向(°)Number-与sog一起构成地图上船舶朝向
rot船舶转向Number-用于判断默认船舶图片前方横线朝向
sog航速Number-与hdg一起构成地图上船舶朝向

getSelectInfo(id)

根据ID获取选中船舶信息

参数说明类型可选值默认值
id船舶唯一idString或Number-null

getAllSelectInfo()

获取所有选中船舶信息

unSelect(id)

取消船舶选中

参数说明类型可选值默认值
id船舶唯一idString或Number-null

unSelectAll()

取消所有选中船舶

setRealShipZoom(zoom)

设置真实船舶从几级开始展示

参数说明类型可选值默认值
zoom地图层级,取值范围为0-24Number-null

setMustShowNameId(ids)

整体替换强制展示船舶名称

参数说明类型可选值默认值备注
ids船舶唯一ID组成的数组Array-null若固定区域内设置了多个,且已无空间展示所有,则会按照设置的先后顺序展示

addMustShowNameId(id)

添加强制展示船舶名称

参数说明类型可选值默认值备注
id船舶唯一IDString或Number-null若固定区域内设置了多个,且已无空间展示所有,则会按照设置的先后顺序展示

removeMustShowNameId(id)

根据ID移除强制展示的船舶名称

参数说明类型可选值默认值
id船舶唯一IDString或Number-null

removeAllMustShowNameId()

移除所有强制展示的船舶名称

setByIdShipNameStyle(options)

根据ID设置船舶名称标签样式

参数说明类型可选值默认值备注
options.id船舶唯一IDString或Number-null-
options.strokeColor船体与标签连接线颜色String-rgba(0,0,0,1)-
options.fillColor船体背景色String-rgba(0,0,0,0.5)-
options.textColor文字颜色String-#fff-
options.text标签内容String-船舶数据中的name字段值-

setShipNameStyle(options)

设置所有船舶名称标签样式

参数说明类型可选值默认值备注
options.strokeColor船体与标签连接线颜色String-rgba(0,0,0,1)-
options.fillColor船体背景色String-rgba(0,0,0,0.5)-
options.textColor文字颜色String-#fff-

addShipImg(imgList)

添加自定义船舶图片 若存在相同名称图片则替换,若不存在则添加

注意

自定义图片,请一次性添加常规状态图片与选中状态图片 选中图片名称为原图片名称加_select

如[{name:'abc',icon:'xxx.png'},{name:'abc_select',icon:'xxx_select.png'}]

参数说明类型可选值默认值备注
imgList.name图片名称 要求唯一String---
imgList.icon图片相对路径(支持网络地址)String---