Appearance
[去看示例]
addShip(data)
注意!
若某艘船不绘制真实船体,toBow,toStern,toStarboard,toPort 请同时传0。否则会出现真实船体无法绘制的问题
添加船舶数据
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| data | 渲染船舶所需的数据 | Array | - | null |
data参数结构如下:
| 参数 | 说明 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| id | 船舶唯一id | String或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 | 船舶唯一id | String或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 | 船舶唯一id | String或Number | - | null |
getAllSelectInfo()
获取所有选中船舶信息
unSelect(id)
取消船舶选中
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 船舶唯一id | String或Number | - | null |
unSelectAll()
取消所有选中船舶
setRealShipZoom(zoom)
设置真实船舶从几级开始展示
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| zoom | 地图层级,取值范围为0-24 | Number | - | null |
setMustShowNameId(ids)
整体替换强制展示船舶名称
| 参数 | 说明 | 类型 | 可选值 | 默认值 | 备注 |
|---|---|---|---|---|---|
| ids | 船舶唯一ID组成的数组 | Array | - | null | 若固定区域内设置了多个,且已无空间展示所有,则会按照设置的先后顺序展示 |
addMustShowNameId(id)
添加强制展示船舶名称
| 参数 | 说明 | 类型 | 可选值 | 默认值 | 备注 |
|---|---|---|---|---|---|
| id | 船舶唯一ID | String或Number | - | null | 若固定区域内设置了多个,且已无空间展示所有,则会按照设置的先后顺序展示 |
removeMustShowNameId(id)
根据ID移除强制展示的船舶名称
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 船舶唯一ID | String或Number | - | null |
removeAllMustShowNameId()
移除所有强制展示的船舶名称
setByIdShipNameStyle(options)
根据ID设置船舶名称标签样式
| 参数 | 说明 | 类型 | 可选值 | 默认值 | 备注 |
|---|---|---|---|---|---|
| options.id | 船舶唯一ID | String或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 | - | - | - |