统一开发 API

Appearance

地标图操作 ​

目录 ​

1. 添加地标图 ​

引入版本：3.0 起支持

功能描述 ​

在三维场景中添加地标图

调用方法 ​

JavaScript
let jsonData = {
  id: 'landmarkLayer',
  name: '地标图层',
  coordType: 0,
  coordTypeZ: 0,
  autoScale: false,
  visible: true,
  tags: ["tag1", "tag2", "tag3"],
  legends: [
    {
      name: '摄像头',
      color: '#73FFFF',
      iconName: 'camera',
      iconScale: 1,
      labelScale: 1，
    },
    {
      name: 'WIFI热点',
      color: '#2626FF',
      iconName: 'wifi',
      iconScale: 1,
      labelScale: 1，
    },
  ],
  data: [
    {
      id: '1',
      type: '摄像头',
      label: '摄像头1',
      coord: [113.934429644472, 22.5105568002601], //以深圳湾经纬度为例
      coordZ: 100,
    },
    {
      id: '2',
      type: '摄像头',
      label: '摄像头2',
      coord: [113.933593837038, 22.5099344521292],
      coordZ: 100,
    },
    {
      id: '3',
      type: '摄像头',
      label: '摄像头3',
      coord: [113.936979866625, 22.511939613347902],
      coordZ: 100,
    },
    {
      id: '4',
      type: '摄像头',
      label: '摄像头4',
      coord: [113.935147516865, 22.5123693181349],
      coordZ: 100,
    },
    {
      id: '5',
      type: '摄像头',
      label: '摄像头5',
      coord: [113.93276891595, 22.5104320222378],
      coordZ: 100,
    },
    {
      id: '6',
      type: 'WIFI热点',
      label: 'WIFI热点1',
      coord: [113.933326095652, 22.5115899172958],
      coordZ: 60,
    },
    {
      id: '7',
      type: 'WIFI热点',
      label: 'WIFI热点2',
      coord: [113.932480299133, 22.5104125714032],
      coordZ: 60,
    },
    {
      id: '8',
      type: 'WIFI热点',
      label: 'WIFI热点3',
      coord: [113.932705105515, 22.508776193495404],
      coordZ: 60,
    },
    {
      id: '9',
      type: 'WIFI热点',
      label: 'WIFI热点4',
      coord: [113.931762182516, 22.511235896344402],
      coordZ: 60,
    },
    {
      id: '10',
      type: 'WIFI热点',
      label: 'WIFI热点5',
      coord: [113.931365756868, 22.510176666936403],
      coordZ: 60,
    },
  ],
};

appInstance.uniCall('addLandmarkLayer', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明端渲染流渲染
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
nameString图层名称，支持为图层自定义名称支持支持
coordTypeNumberxy 轴坐标模式 坐标类型(0:x 经度 y 纬度；1:x 米 y 米，相对世界 00 点) 目前该属性仅支持属性值为 0支持支持
coordTypeZNumberZ 轴坐标类别，0：相对 3D 世界 0 海拔；1：相对 3D 世界地表；2：相对 3D 模型表面（单位：米） 目前该属性仅支持属性值为 0支持支持
autoScaleBoolean默认 false, 如果开启 true 后，图标会按照摄像机远近自动缩放大小支持支持
visibleBoolean添加当前图层时默认显示还是隐藏支持支持
tagsArray用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
legendsArray定义图层包含图例，支持为不同图例定义各自样式支持支持
legends[0].nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别支持支持
legends[0].colorString颜色（HEX 颜色值）支持支持
legends[0].iconNameString内置图标名称，具体图标名称参考下表和下图支持支持
legends[0].iconScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持
legends[0].labelScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持
dataArray数据点位基本信息集合支持支持
data[0].idString图层子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
data[0].labelString图标标签文本支持支持
data[0].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
data[0].coordZNumberZ 轴高度（单位：米）支持支持
data[0].typeString地标点的图例类别名称支持支持
legends[].nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别，必须与 data[].type 的值完全匹配支持支持
legends[].colorString颜色（HEX 颜色值）支持支持
legends[].iconNameString内置图标名称，具体图标名称参考下表和下图支持支持
legends[].iconScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持
legends[].labelScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持
data[].idString图层子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
data[].typeString图例类别名称，必须与 legends[].name 的值完全匹配支持支持
data[].labelString图标标签文本支持支持
data[].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
data[].coordZNumberZ 轴高度（单位：米）支持支持

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因

具体内置图标名称（iconName）详情 ​

图标类型图标名称
市政设施camera
streetlamp
manholecover
sensor
utilitypole
transmission
broadcast
wifi
firehydrant
equipmentbox
trafficlight
charge
gasstation
wc
dustbin
地点建筑trainstation
airport
anchor
government
netpoint
metro
finance
school
hospital
factory
constructionsite
residence
mergencyshelter
park
diningroom
warehouse
store
tollgate
officebuilding
busstation
人员people
policeman
doctor
specialpeople
criminal
交通car
policecar
fireengine
ambulance
taxi
truck
bus
newscar
militarycar
municipal
electriccar
watercar
train
ship
cargoship
飞行器airplane
helicopter
uav
satellite
rocket
事件event_01
event_02
event_03
通用icon_01
icon_02
icon_03
icon_04
地名site_01
site_02
site_03

具体内置图标名称（iconName）效果 ​

图标效果

返回本章目录

返回本章目录

2. 更新地标图数据 ​

引入版本：3.0 起支持

功能描述 ​

更新三维场景中添加地标图的数据

调用方法 ​

JavaScript
let jsonData = {
  id: 'landmarkLayer',
  name: '地标图层',
  coordType: 0,
  coordTypeZ: 0,
  isAppend: false,
  tags: ['tag1', 'tag2', 'tag3'],
  data: [
    {
      id: '11',
      type: '摄像头',
      label: '摄像头',
      coord: [113.932358252279, 22.513687693448002], //以深圳湾经纬度为例
      coordZ: 64,
    },
    {
      id: '12',
      type: '摄像头',
      label: '摄像头',
      coord: [113.934061940271, 22.513951407881102],
      coordZ: 64,
    },
    {
      id: '13',
      type: '摄像头',
      label: '摄像头',
      coord: [113.930654568696, 22.511470933294802],
      coordZ: 64,
    },
  ],
};

appInstance.uniCall('updateLandmarkLayerCoord', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明端渲染流渲染
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
nameString图层名称，支持为图层自定义名称支持支持
coordTypeNumberxy 轴坐标模式 坐标类型(0:x 经度 y 纬度；1:x 米 y 米，相对世界 00 点) 目前该属性仅支持属性值为 0支持支持
coordTypeZNumberZ 轴坐标类别，0：相对 3D 世界 0 海拔；1：相对 3D 世界地表；2：相对 3D 模型表面（单位：米） 目前该属性仅支持属性值为 0支持支持
isAppendBoolean是否追加数据（按顺序），true：按新数据 更新原有重复数据 & 追加新数据；false：清除原有数据 & 重建新数据支持支持
tagsArray用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
dataArray定义图层可视化数据支持支持
data[0].idString图层子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
data[0].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
data[0].coordZNumberZ 轴高度（单位：米）支持支持
data[0].typeString地标点的图例类别名称支持支持
data[0].labelString图标标签文本支持支持
data[].idString图层子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
data[].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
data[].coordZNumberZ 轴高度（单位：米）支持支持
data[].typeString图例类别名称，必须与 legends[].name 的值完全匹配支持支持
data[].labelString图标标签文本支持支持

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因

返回本章目录

3. 更新地标图样式 ​

引入版本：3.0 起支持

功能描述 ​

更新三维场景中添加地标图的样式

调用方法 ​

JavaScript
let jsonData = {
  id: 'landmarkLayer',
  isAppend: true,
  legends: [
    {
      name: '摄像头',
      color: '#00ef00',
      iconName: 'firehydrant',
      iconScale: 1,
      labelScale: 1,
    },
    {
      name: 'WIFI热点',
      color: '#00ad00',
      iconName: 'streetlamp',
      iconScale: 1,
      labelScale: 1,
    },
  ],
};

appInstance.uniCall('updateLandmarkLayerStyle', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别
isAppendBoolean是否追加数据（按顺序），true：按新数据 更新原有重复数据 & 追加新数据；false：清除原有数据 & 重建新数据
legendsArray图例图层定义
legends[0].nameString图标对象名称，和数据集合中 type 属性对应，本身也可以代表内置的图标名称
legends[0].colorString图标颜色设置
legends[0].iconNameString内置图标名称
legends[0].iconScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率
legends[0].labelScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率
legends[].nameString图标对象名称，和数据集合中 type 属性对应，本身也可以代表内置的图标名称
legends[].colorString图标颜色设置
legends[].iconNameString内置图标名称
legends[].iconScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率
legends[].labelScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因

返回本章目录

4. 删除地标图 ​

引入版本：3.0 起支持

功能描述 ​

删除地标图

调用方法 ​

JavaScript
let jsonData = {
  id: 'landmarkLayer',
  overlayType: 'landmarkLayer',
};

appInstance.uniCall('removeOverlay', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别
overlayTypeString图层对象类别

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因

返回本章目录

5. 添加 shp 地标图 端 ​

引入版本：3.6.4 起支持

功能描述 ​

在三维场景中添加 Shp 地标图

调用方法 ​

JavaScript
let jsonData = {  
  id: 'idObj',
  name: 'layerName',
  coordZ: 150,
  coordZFiled: 'heightField',
  autoScale: false,
  visible: true,
  idField: 'idField',
  labelField: 'poititleField',
  legendsField: 'legendField',
  shpEncoding: 'utf8',
  shpPath: 'http://tuguan.net/test.shp',
  tags: ["tag1", "tag2", "tag3"],
  legends: [
    {
        name: 'legendName1',
        color: '#ff0000'，
        iconName: 'camera',
        iconScale: 1,
        labelScale: 1
    },
    {
        name: 'legendName2',
        color: '#ff0000'，
        iconName: 'camera',
        iconScale: 1,
        labelScale: 1
    }
  ]
};

appInstance.uniCall('addLandmarkLayerShp', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明端渲染流渲染
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
nameString图层名称，支持为图层自定义名称支持支持
coordZNumber高度（单位：米）支持支持
coordZFiledString高度在 SHP 文件中属性表的字段名称，如果有这个字段则 coordZ 不起作用（单位：米）支持支持
autoScaleBoolean默认 false, 如果开启 true 后，图标会按照摄像机远近自动缩放大小支持支持
visibleBoolean添加当前图层时默认显示还是隐藏支持支持
idFieldString对象唯一标识在 SHP 文件中属性表的字段名称支持支持
labelFieldString标签文字在 SHP 文件中属性表的字段名称，如果不写或为空就只显示图标支持支持
legendsFieldString对象图例字段在 SHP 文件中属性表的字段名称支持支持
shpEncodingStringshp 文件的编码格式，可以是"utf8"或者"gb2312"支持支持
shpPathString在线地址：shp 文件 URL ; 本地地址一："file:///D:/xxx/shpData.shp"；D: 云渲染所在盘符 ; 本地地址二："path:/UserData/shpData.shp"，资源由云渲染后台管理支持支持
tagsArray用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
legends[0].nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别支持支持
legends[0].colorString颜色（HEX 颜色值）支持支持
legends[0].iconNameString内置图标名称支持支持
legends[0].iconScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持
legends[0].labelScaleNumber默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因

返回本章目录