统一开发 API

Appearance

图层基本操作 ​

目录 ​

1. 设置图层对象显隐 ​

引入版本：3.0 起支持

功能描述 ​

设置图层对象显隐

调用方法 ​

JavaScript
let jsonData = {
  id: 'landmark',
  overlayType: 'landmark',
  visible: false,
};

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

参数描述 ​

属性类型说明
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别
overlayTypeString图层对象类别，参考下面图层对象类别枚举表格
visibleBoolean显隐控制，true：显示；false：隐藏

回调数据 ​

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

回调数据参数描述 ​

属性类型说明
resultNumberresult 为执行结果，1 代表成功，0 代表失败。
messageString为成功或失败消息

图层对象类别枚举 ​

值类型备注
landmarkString地标点
pathString路径
areaString区域轮廓
circularAreaString圆形轮廓
3DTileString3DTile 倾斜摄影
gisMapStringTMS 瓦片
landmarkLayerString地标图
3DColumnLayerString三维柱状图
3DGridLayerString栅格图
heatMapLayerString热力图
starLightLayerString星光图
bubbleLayerString气泡图
eventLayerString事件图
trailLayerString轨迹图
trackLayerString点迹图
ODLineLayerString关系图
typeAreaLayerString类型区域图
colorAreaLayerString数值区域图
roadPtHeatLayerString路径点热力图
roadSgHeatLayerString路径段热力图
3DMarkerString特效对象
modelTrailLayerString模型轨迹图
modelLandmarkLayerString模型地标图
3DMarkerLandmarkLayerString特效地标图
iconModelLandmarkLayerString图标模型地标图
iconModelTrailLayerString图标模型轨迹图
aggLandmarkLayerString聚簇地标图
aggBubbleLayerString聚簇气泡图
aggEventBubbleLayerString聚簇事件图
aggHeatMapLayerString聚簇热力图
agg3DColumnLayerString聚簇三维柱状图
agg3DGridLayerString聚簇栅格图
subLandmarkLayerString抽稀地标图

返回本章目录

返回本章目录

2. 设置类别图层显隐 ​

引入版本：3.1 起支持

功能描述 ​

设置类别图层显隐

调用方法 ​

JavaScript
let jsonData = {
  overlayType: 'landmark',
  visible: true,
};

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

参数描述 ​

属性类型说明
overlayTypeString图层对象类别 ，参考上面图层对象类别枚举表格
visibleBoolean显隐控制，true：显示；false：隐藏

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

3. 设置标签图层显隐 流 ​

引入版本：4.0 起支持

功能描述 ​

设置标签图层显隐

调用方法 ​

JavaScript
let jsonData = {
  tags: ['tags1', 'tags2', 'tags3'],
  visible: true,
};

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

参数描述 ​

属性类型说明
tagsArray用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐
visibleBoolean显隐控制，true：显示；false：隐藏

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

4. 设置图层子对象显隐 ​

引入版本：3.4 起支持

功能描述 ​

设置图层子对象显隐

调用方法 ​

JavaScript
let jsonData = {
  idLayer: 'layerId',
  overlayType: 'landmarkLayer',
  id: 'objId',
  ids: [],
  visible: true,
};

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

参数描述 ​

属性类型说明
idLayerString图层对象 id，只支持带有子对象的图层
overlayTypeString图层对象类别，只支持带有子对象的图层，包括：landmarkLayer，bubbleLayer，eventLayer，trailLayer，trackLayer，typeAreaLayer，colorAreaLayer，roadSgHeatLayer，3DColumnLayer，3DGridLayer，modelTrailLayer，modelLandmarkLayer，3DMarkerLandmarkLayer，iconModelTrailLayer，iconModelLandmarkLayer，aggLandmarkLayer，aggBubbleLayer，aggEventBubbleLayer，aggHeatMapLayer，agg3DColumnLayer，agg3DGridLayer
idString需要控制显隐的图层子对象 id
idsArray需要控制显隐的图层子对象 id 数组，如果这个不为空，则会和 id 选中一起作用
visibleBoolean显隐控制，true：显示；false：隐藏

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

5. 删除图层对象 ​

引入版本：3.0 起支持

功能描述 ​

删除图层对象

调用方法 ​

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

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

参数描述 ​

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

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

6. 删除图层子对象 ​

引入版本：3.4 起支持

功能描述 ​

删除图层子对象

调用方法 ​

JavaScript
let jsonData = {
  overlayType: 'landmarkLayer',
  idLayer: 'layerId',
  id: '1',
  ids: [],
};

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

参数描述 ​

属性类型说明
overlayTypeString图层对象类别，只支持带有子对象的图层，包括：landmarkLayer，bubbleLayer，eventLayer，trailLayer，trackLayer，typeAreaLayer，colorAreaLayer，roadSgHeatLayer，3DColumnLayer，3DGridLayer，modelTrailLayer，modelLandmarkLayer，3DMarkerLandmarkLayer，iconModelTrailLayer，iconModelLandmarkLayer，aggLandmarkLayer，aggBubbleLayer，aggEventBubbleLayer，aggHeatMapLayer，agg3DColumnLayer，agg3DGridLayer
idLayerString图层对象 id，只支持带有子对象的图层
idString需要删除的图层子对象 id
idsArray需要删除的图层子对象 id 数组，如果这个不为空，则会和 id 一起被删除

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

7. 删除类别图层 ​

引入版本：3.0 起支持

功能描述 ​

删除类别图层

调用方法 ​

JavaScript
let jsonData = {
  overlayType: 'landmark',
};

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

参数描述 ​

属性类型说明端渲染流渲染
overlayTypeString覆盖物类型,支持 all ，参考上面图层对象类别枚举表格支持支持
idString模型对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
coordTypeNumberXY 轴坐标类别，0：X 经度，Y 纬度；1：X 米，Y 米，相对世界 00 点支持支持
coordTypeZNumberZ 轴坐标类别，0：相对 3D 世界 0 海拔；1：相对 3D 世界地表；2：相对 3D 模型表面（单位：米）支持支持
snapSurfaceNumber启用自动贴地支持支持
alphaNumber透明度，0：完全透明；1：完全不透明支持支持
markerMaxDistanceNumber特效最大可见距离（单位：米），不可见后显示 icon支持支持
iconMaxDistanceNumbericon 最大可见距离（单位：米），不可见后隐藏支持支持
markerLandmarkDataIdString对应本服务器上 3DMarkerLandmark 数据 Id，如果找到 id，则下方的 data 不起作用支持支持
visibleBoolean添加当前图层时默认显示还是隐藏支持支持
tagsArray用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别支持支持
markerTypeString特效样式类别 Radar01 Revolve01 Revolve02 Revolve03 Revolve04 Spread01 Spread02 Spread03 Spread04 Spread05 Spread06 Spread07 Spread08 Spread09 Square01支持支持
scaleNumber整体放缩倍数（单位：倍）支持支持
iconNameString内置图标名称，或根据项目，在场景中预置好的图标对象的名称，包含文字样式定义，具体图标名称参考下表和下图册支持支持
titleColorString特效标签文本颜色，可选值，默认白色支持支持
titleBackgroundColorString特效标签文本背景颜色，可选值，默认灰色支持支持
titleTextString特效标签文本支持支持
coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
coordZNumberZ 轴高度（单位：米）支持支持
rotationArray[Yaw、Pitch、Roll] Yaw 偏航（单位：角度，正南为 0 度，以天为正方向的左手法则, 值域：-360 到 360），Pitch 俯仰角（单位：角度，水平面模型前进方向为 0 度，前进方向左侧的左手法则, 值域：-360 到 360），Roll 翻滚角（单位：角度，水平面模型前进方向右侧为 0 度，模型前进方向的左手法则, 值域：-360 到 360）支持支持
typeString特效图例类别支持支持

回调数据 ​

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_03
event_03
通用icon_01
icon_02
icon_03
icon_04
地名site_01
site_02
site_03

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

图标效果

返回本章目录

返回本章目录

8. 移除图层尾迹 流 ​

引入版本：4.0 起支持

功能描述 ​

移除图层尾迹

调用方法 ​

JavaScript
let jsonData = {
  overlayType: 'modelTrailLayer',
  idLayer: 'layerId',
  id: 'objId',
};

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

参数描述 ​

属性类型说明
overlayTypeString图层类型，支持 trailLayer、modelTrailLayer 和 iconModelTrailLayer
idLayerString图层 Id，可为空，为空表示清空该类型所有尾迹
idString对象 Id，可为空，为空时表示清空该图层所有对象尾迹

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

9. 获取图层顺序 ​

引入版本：3.2.1 起支持

功能描述 ​

获取图层顺序

调用方法 ​

JavaScript
appInstance.uniCall('getOverlaysOrder', {}, (result) => {
  console.log(result);
});

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。",
  "data": [
    {
      "idLayer": "layerId1",
      "index": 1
    },
    {
      "idLayer": "layerId2",
      "index": 2
    }
  ]
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因
dataArray获取图层数据
data[0].idLayerString图层 Id
data[0].indexNumber图层 index，越大表示在在前面，会遮挡其他图层，最下面的图层 index 是 1，index 是连续的，没有间断

返回本章目录

10. 前移图层 ​

引入版本：3.2.1 起支持

功能描述 ​

前移图层

调用方法 ​

JavaScript
let jsonData = {
  idLayer: 'layerId', // 需要移动的图层Id
  offset: 1, // 移动图层偏移几个，是相对图层的数量，如果是0，表示前移到最上面，值域只能是大于0
};
appInstance.uniCall('moveOverlayForward', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idLayerString需要移动的图层 Id
offsetString移动图层偏移几个，是相对图层的数量，如果是 0，表示前移到最上面，值域只能是大于 0

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

11. 后移图层 ​

引入版本：3.2.1 起支持

功能描述 ​

后移图层

调用方法 ​

JavaScript
let jsonData = {
  idLayer: 'layerId', // 需要移动的图层Id
  offset: 1, // 移动图层偏移几个，是相对图层的数量，如果是0，表示前移到最上面，值域只能是大于0
};
appInstance.uniCall('moveOverlayBackward', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idLayerString需要移动的图层 Id
offsetString移动图层偏移几个，是相对图层的数量，如果是 0，表示前移到最上面，值域只能是大于 0

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

12. 添加图层对象 Tip ​

引入版本：3.0 起支持

功能描述 ​

添加图层对象 Tip

调用方法 ​

JavaScript
let jsonData = {
  id: 'landmark',
  url: 'http://www.tuguan.net/testdlg.html',
  divId: 'tipDivId',
  size: [500, 300],
  offset: [100, -30],
  isShowClose: true,
  overlayType: 'landmark',
  canDrag: false,
  showLine: false,
  lineColor: '#ff0000',
  lineWidth: 1,
  lineStyle: 'solid',
};

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

参数描述 ​

属性类型说明端渲染流渲染
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
urlStringTip 窗口页面地址支持支持
divIdStringHTML 侧弹出标牌的 dom div id，如果这个不为""，url 属性不起作用支持支持
isShowCloseBoolean是否显示右上角关闭按钮，默认显示关闭按钮支持支持
sizeArrayTip 窗口宽高 xy，x：窗口宽；y：窗口高（单位：像素）支持支持
offsetArrayTip 左上角相对 对象中心点 偏移量 xy，x：为正，向右偏移；y：为正，向上偏移（单位：像素）支持支持
overlayTypeString图层对象类别，参考上面图层对象类别枚举表格支持支持
canDragBoolean是否可以拖拽标牌，默认 false，true: 可以拖拽，false: 不可以拖拽支持不支持
showLineBoolean是否显示标牌到中心点的连线，默认 false，true: 显示，false: 不显示支持不支持
lineColorString标牌连线颜色支持不支持
lineWidthNumber标牌连线宽度支持不支持
lineStyleString标牌连线样式，"solid": 实线，"dashed": 虚线，"dotted"：点线支持不支持

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

13. 移除图层对象 Tip ​

引入版本：3.2 起支持

功能描述 ​

移除图层对象 Tip

调用方法 ​

JavaScript
let jsonData = {
  id: "landmark"
  overlayType: "landmark"
};

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

参数描述 ​

属性类型说明
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别，如果 id 为空，则删除所有 TIP
overlayTypeString图层对象类别 ，参考上面图层对象类别枚举表格

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

14. 获取类别图层 ​

引入版本：3.1 起支持

功能描述 ​

获取类别图层

调用方法 ​

JavaScript
let jsonData = {
  overlayType: 'landmark',
};

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

参数描述 ​

属性类型说明
overlayTypeString图层对象类别 ，参考上面图层对象类别枚举表格

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。",
  "type": "landmark",
  "data": [
    {
      "id": "objId1",
      "name": "objName1"
    },
    {
      "id": "objId2",
      "name": "objName2"
    }
  ]
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因
typeString图层类型
dataArray获取图层数据
data[0].idString图层 id
data[0].nameStringlayer 类别覆盖物，会返回 name，其他为空

返回本章目录

15. 获取图层子图层对象 ​

引入版本：3.1 起支持

功能描述 ​

获取图层子图层对象

调用方法 ​

JavaScript
let jsonData = {
  idLayer: 'layerId',
  layerType: 'landmarkLayer',
};

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

参数描述 ​

属性类型说明
idLayerString含子图层对象的图层 id，会获取该图层的所有子对象
layerTypeString含子图层对象的图层类别 参考下表含子图层对象图层类别枚举

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。",
  "type": "landmark",
  "data": [
    {
      "id": "objId1"
    },
    {
      "id": "objId2"
    }
  ]
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因
typeString覆盖物类别
dataArray获取图层数据
data[0].idString子图层 id

# 含子图层对象图层类别枚举 ​

值类型备注
landmarkLayerString地标图
bubbleLayerString气泡图
eventLayerString事件图
trailLayerString轨迹图
trackLayerString点迹图
typeAreaLayerString类型区域图
colorAreaLayerString数值区域图
roadSgHeatLayerString路径段热力图
3DColumnLayerString三维柱状图
3DGridLayerString栅格图
aggLandmarkLayerString聚簇地标图
aggBubbleLayerString聚簇气泡图
aggEventBubbleLayerString聚簇事件图
aggHeatMapLayerString聚簇热力图
agg3DColumnLayerString聚簇三维柱状图
agg3DGridLayerString聚簇栅格图

返回本章目录