统一开发 API

Appearance

预置地图操作 ​

目录 ​

1. 切换世界地图 流 ​

引入版本：3.3 起支持

功能描述 ​

切换世界地图

调用方法 ​

JavaScript
let jsonData = {
  visible: true, 
  preloadOnly: false, 
};
appInstance.uniCall('switchWorldMap', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
visibleBoolean显隐控制，true：显示；false：隐藏
preloadOnlyBoolean是否只是预加载，true：端：预加载模型，但是不切换显示，下载完成后会有 onSwitchChinaMapEnd 事件触发；false：加载后直接显示

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

2. 高亮世界国家 流 ​

引入版本：3.3 起支持

功能描述 ​

高亮世界国家

调用方法 ​

JavaScript
let jsonData = {   
  country: "name",
  type: "all"
  color: "#00ff00"
}

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

参数描述 ​

属性类型说明
provinceString国家名称：country，详见 内置枚举
typeStringall 全部国家，single 单一国家，镜头不变
colorString高亮颜色
countryString国家名称

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

3. 设置世界国家名称显隐 流 ​

引入版本：3.3 起支持

功能描述 ​

设置世界国家名称显隐

调用方法 ​

JavaScript
let jsonData = {
  country: 'all', 
  visible: true, 
};

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

参数描述 ​

属性类型说明
countryString国家名称 country，支持填写 "all"，全部显隐
visibleBooleantrue 显示，false 关闭

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

4. 切换中国地图 流 ​

引入版本：3.2 起支持

功能描述 ​

切换中国地图

调用方法 ​

JavaScript
let jsonData = {
  visible: true,
  preloadOnly: false,
};
appInstance.uniCall('switchChinaMap', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
visibleBoolean显隐控制，true：显示；false：隐藏
preloadOnlyBoolean是否只是预加载，true：端：预加载模型，但是不切换显示，下载完成后会有 onSwitchChinaMapEnd 事件触发；false：加载后直接显示

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

5. 高亮中国省份 流 ​

引入版本：3.2 起支持

功能描述 ​

高亮中国省份

调用方法 ​

JavaScript
let jsonData = {
  province: 'BJ', 
  type: 'single', 
  color: '#00ff00', 
};
appInstance.uniCall('highlightProvince', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
provinceString省份名称 province
typeStringall 全部省份，single 单一省份，镜头不变
colorString高亮颜色

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

6. 设置中国省份名称显隐 流 ​

引入版本：3.2 起支持

功能描述 ​

设置中国省份名称显隐

调用方法 ​

JavaScript
let jsonData = {
  province: 'name',
  visible: true,
};
appInstance.uniCall('setProvinceNameVisible', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
provinceString省份名称 province，详见 内置枚举，支持填写 "all"，全部显隐
visibleBoolean显隐控制，true：显示；false：隐藏

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

7. 高亮城市 流 ​

引入版本：5.0 起支持

功能描述 ​

高亮城市级行政区，可整体高亮或只高亮单个城市。

调用方法 ​

JavaScript
let jsonData = {
  city: '北京市',
  parentProvince: '北京市',
  type: 'single',
  color: '#00ff00',
};
appInstance.uniCall('highlightCity', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
cityString城市名称或行政区 code
parentProvinceString所属省份，用于同名城市消歧
typeStringall 全部城市，single 单一城市，镜头不变
colorString高亮颜色，#RRGGBB 或 #RRGGBBAA

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

8. 设置城市名称显隐 流 ​

引入版本：5.0 起支持

功能描述 ​

控制城市名称标注的显示与隐藏。

调用方法 ​

JavaScript
let jsonData = {
  city: 'all',
  visible: true,
  language: 'zh-CN',
};
appInstance.uniCall('setCityNameVisible', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
cityString城市名称或行政区 code；传 all 表示全部城市
parentProvinceString所属省份，用于同名城市消歧
visibleBooleantrue：显示；false：隐藏
languageString名称语言，可选 zh-CN、en、source

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

9. 添加行政边界图层 流 ​

引入版本：5.0 起支持

功能描述 ​

创建行政边界图层，支持内置国家、省份、城市数据集与自定义边界资产。

调用方法 ​

JavaScript
let jsonData = {
  id: 'chinaBoundary',
  boundaryType: 'province',
  visible: true,
  width: 20000,
  color: '#00ffff',
  clampMode: 'terrain',
};
appInstance.uniCall('addBoundaryLayer', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString边界图层 ID。保留 ID 与 boundaryType 绑定：worldBoundary→country、chinaBoundary→province、chinaCityBoundary→city
nameString图层显示名称
boundaryTypeString边界数据集类型：country 国家、province 省份、city 城市、custom 自定义
assetNameString自定义边界资产名，仅允许 ASCII 字母、数字和下划线；boundaryType 为 custom 时必填，内置类型禁止提供
visibleBoolean图层显隐，true：显示；false：隐藏
tagsArray<String>图层标签
countriesArray<String>按国家筛选；空数组表示清除该维度筛选
provincesArray<String>按省份筛选；空数组表示清除该维度筛选
citiesArray<String>按城市筛选；与 parentProvinces 不能同时非空
parentProvincesArray<String>按所属省份筛选；与 cities 不能同时非空
spatialCullBoolean是否开启空间剔除
internalOnlyBoolean是否仅内部可见
minCameraHeightNumber生效的最小相机高度
maxCameraHeightNumber生效的最大相机高度
widthNumber边界线宽度，单位米（UE 传输层转换为厘米）
colorString边界线颜色，#RRGGBB 或 #RRGGBBAA
alphaNumber透明度，取值 0–1
heightOffsetNumber高度偏移
clampModeString贴合方式：ellipsoid 椭球面、terrain 地形
autoWidthBoolean是否按屏幕宽度自适应线宽
minScreenWidthPixelsNumber自动线宽的最小屏幕像素
maxAutoWidthNumber自动线宽上限
distanceHeightStartNumber随距离抬升的起始距离
distanceHeightScaleNumber随距离抬升的缩放系数
maxDistanceHeightOffsetNumber随距离抬升的最大偏移
typeString线型：solid 实线、Segment06 流光段
flowColorString流光颜色
textureSpeedNumber流光速度
flowIntensityNumber流光强度
flowTilingNumber流光平铺次数
emissiveIntensityNumber自发光强度
flowAutoDistanceBoolean是否按距离自动控制流光
flowDistanceStartNumber流光起效距离
flowDistanceEndNumber流光结束距离
flowFarSpeedScaleNumber远处流光速度系数
flowFarTilingScaleNumber远处流光平铺系数
LODNumberLOD 等级
lodModeStringLOD 模式：auto 自动、manual 手动
lodHeightThresholdsArray<Number>LOD 高度阈值数组
lodHysteresisNumberLOD 切换迟滞
autoLodPointBudgetNumber自动 LOD 的点数预算

回调数据 ​

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

回调数据参数描述 ​

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

筛选字段须与 boundaryType 匹配：country 只接受 countries，province 只接受 provinces，city 只接受 cities 或 parentProvinces，custom 不接受任何行政区筛选。

返回本章目录

10. 更新边界线样式 流 ​

引入版本：5.0 起支持

功能描述 ​

更新已创建边界图层的线条与流光样式；未提供的字段保持原值。

调用方法 ​

JavaScript
let jsonData = {
  id: 'chinaBoundary',
  color: '#ffcc00',
  width: 30000,
  type: 'Segment06',
};
appInstance.uniCall('updateBoundaryLayerStyle', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString边界图层 ID
widthNumber边界线宽度，单位米（UE 传输层转换为厘米）
colorString边界线颜色，#RRGGBB 或 #RRGGBBAA
alphaNumber透明度，取值 0–1
heightOffsetNumber高度偏移
clampModeString贴合方式：ellipsoid 椭球面、terrain 地形
autoWidthBoolean是否按屏幕宽度自适应线宽
minScreenWidthPixelsNumber自动线宽的最小屏幕像素
maxAutoWidthNumber自动线宽上限
distanceHeightStartNumber随距离抬升的起始距离
distanceHeightScaleNumber随距离抬升的缩放系数
maxDistanceHeightOffsetNumber随距离抬升的最大偏移
typeString线型：solid 实线、Segment06 流光段
flowColorString流光颜色
textureSpeedNumber流光速度
flowIntensityNumber流光强度
flowTilingNumber流光平铺次数
emissiveIntensityNumber自发光强度
flowAutoDistanceBoolean是否按距离自动控制流光
flowDistanceStartNumber流光起效距离
flowDistanceEndNumber流光结束距离
flowFarSpeedScaleNumber远处流光速度系数
flowFarTilingScaleNumber远处流光平铺系数

回调数据 ​

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

回调数据参数描述 ​

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

部分更新语义：只传需要修改的字段即可。

返回本章目录

11. 更新边界名称样式 流 ​

引入版本：5.0 起支持

功能描述 ​

批量更新边界名称的文本与样式。

调用方法 ​

JavaScript
let jsonData = {
  id: 'chinaBoundary',
  data: [
    { province: '北京市', label: '北京' },
  ],
  fontSize: 14,
  color: '#ffffff',
};
appInstance.uniCall('updateBoundaryNameStyle', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString边界图层 ID
dataArray<Object>名称数据数组，不能为空。每项须提供 country、province、city 之一，可带 label 自定义文本或 resetLabel 恢复内置名称；label 与 resetLabel 互斥，label 最多 128 个字符
fontSizeNumber字号
colorString文字颜色，#RRGGBB 或 #RRGGBBAA
outlineSizeNumber描边宽度
outlineColorString描边颜色
shadowColorString阴影颜色
shadowOffsetXNumber阴影水平偏移
shadowOffsetYNumber阴影垂直偏移

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

12. 更新边界 LOD 流 ​

引入版本：5.0 起支持

功能描述 ​

配置边界图层的手动或自动 LOD 策略。

调用方法 ​

JavaScript
let jsonData = {
  id: 'chinaBoundary',
  lodMode: 'manual',
  LOD: 1,
};
appInstance.uniCall('updateBoundaryLayerLOD', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString边界图层 ID
LODNumberLOD 等级
lodModeStringLOD 模式：auto 自动、manual 手动
lodHeightThresholdsArray<Number>LOD 高度阈值数组
lodHysteresisNumberLOD 切换迟滞
autoLodPointBudgetNumber自动 LOD 的点数预算

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

13. 更新行政区筛选 流 ​

引入版本：5.0 起支持

功能描述 ​

原子更新边界图层的行政区筛选条件。

调用方法 ​

JavaScript
let jsonData = {
  id: 'chinaBoundary',
  provinces: ['北京市', '上海市'],
};
appInstance.uniCall('updateBoundaryLayerFilter', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString边界图层 ID
countriesArray<String>按国家筛选；空数组表示清除该维度筛选
provincesArray<String>按省份筛选；空数组表示清除该维度筛选
citiesArray<String>按城市筛选；与 parentProvinces 不能同时非空
parentProvincesArray<String>按所属省份筛选；与 cities 不能同时非空

回调数据 ​

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

回调数据参数描述 ​

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

countries、provinces、cities、parentProvinces 至少提供一个；cities 与 parentProvinces 不能同时非空。

返回本章目录

14. 设置焦点行政区工作集 流 ​

引入版本：5.0 起支持

功能描述 ​

设置焦点行政区及其同级、子级的工作集与 LOD 档位。

调用方法 ​

JavaScript
let jsonData = {
  id: 'chinaBoundary',
  featureCode: '110000',
  preset: 'balanced',
};
appInstance.uniCall('setBoundaryDisplayScope', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString边界图层 ID
featureCodeString焦点行政区的要素 code
LODNumberLOD 等级
presetString档位预设：balanced 均衡、quality 质量优先、performance 性能优先
siblingLodOffsetNumber同级区域的 LOD 偏移
childLodOffsetNumber子级区域的 LOD 偏移
pointBudgetNumber点数预算

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录