统一开发 API

Appearance

路径操作 ​

目录 ​

1. 添加路径 ​

引入版本：3.0 起支持

功能描述 ​

在三维场景中添加路径

调用方法 ​

JavaScript
let jsonData = {
  id: 'path',
  name: '路径',
  coordType: 0,
  coordTypeZ: 0,
  type: 'Segment06',
  texture: 'cableFlow.png',
  textureSpeed: 0,
  color: '#ff0000',
  colorPass: '#0000FF',
  width: 40,
  tags: ['tag1', 'tag2', 'tag3'], // 用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐
  label: 'label text',
  label2: 'label2 text',
  labelColor: '#ffffff',
  labelScale: 1,
  labelOffset: [0, 0, 2],
  labelBackgroundColor: '#333333',
  alpha: 1,
  autoScale: false,
  visible: true,
  cornerRadius: 0,
  cornerHideRadius: 1,
  lineDataId: 'lineDataId', // 对应本服务器上线数据对象，如果找到lineDataId，则下方的points不起作用。注意：此属性端渲染未生效
  snapSurface: 0,
  points: [
    {
      coord: [113.93067192262, 22.5055370709766], //以深圳湾经纬度为例
      coordZ: 64,
    },
    {
      coord: [113.931096391945, 22.505529293013502],
      coordZ: 64,
    },
    {
      coord: [113.931631709536, 22.505558300919404],
      coordZ: 64,
    },
    {
      coord: [113.931891370615, 22.505629814270502],
      coordZ: 64,
    },
    {
      coord: [113.932472588119, 22.506007710047],
      coordZ: 64,
    },
    {
      coord: [113.932700261644, 22.5064112673693],
      coordZ: 64,
    },
    {
      coord: [113.932918938857, 22.506912837105403],
      coordZ: 64,
    },
    {
      coord: [113.933647825522, 22.508953376710004],
      coordZ: 64,
    },
  ],
};

appInstance.uniCall('addPath', 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支持支持
typeString路线样式类别，详见下表：路线样式类别，如果为：Model 开始的类型，会生成模型，并且使用贴图支持支持
textureString材质贴图名称，只有当 type 为 Model 开始的类型，才有用。端渲染：在场景中预置好的图片名称或外部图片 url，流渲染：服务器应用目录里的资源图片支持支持
textureSpeedNumber材质贴图的 UV 动画速度，默认：0，0 为不运动，其他数值沿着路径模型方向前进，负数为反向支持支持
colorString路线颜色，"" 颜色透明（HEX 颜色值）；只有当 type 不为 Model 开始的类型，才有用。支持支持
colorPassString模型对象 移动经过后的 路径颜色（HEX 颜色值）；只有当 type 不为 Model 开始的类型，才有用。支持支持
widthNumber宽度(单位:米)支持支持
tagsAnything用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
labelString标签文本支持支持
label2String第二行标签文本支持支持
labelColorString标签文本颜色，可选值，默认白色支持支持
labelScaleNumber标签文本的缩放，默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持
labelOffsetArray标签文本的位置偏移，默认值是[0, 0, 0]，表示相对于模型中心点的相对世界坐标的 x、y、z 偏移位置（单位：米）支持支持
labelBackgroundColorString标签文本背景颜色，可选值，默认灰色支持支持
alphaNumber透明度，0：完全透明；1：完全不透明，默认值 1支持支持
autoScaleBoolean线是否近大远小，false，镜头无论远近，看起来线一样大，true，镜头近线粗，镜头远线细。（流渲染，当 autoScale 为 false 时，不支持点击和悬浮选中）支持支持
visibleBoolean添加当前图层时默认显示还是隐藏支持支持
cornerRadiusNumber拐点平滑度，取值为 0 到 4，4 最平滑，默认值为 0。支持不支持
cornerHideRadiusNumber拐点是否显示，0 时显示所有弯曲拐点，非 0 时不显示拐点，默认值为 0。支持不支持
lineDataIdString对应本服务器上线数据对象，如果找到 lineDataId，则下方的 points 不起作用。注意：此属性端渲染未生效支持支持
snapSurfaceNumber启用自动贴地，0：不贴地，1：自动贴地。默认值是 0不支持支持
pointsArray定义路径途径点支持支持
points[0].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
points[0].coordZNumberZ 轴高度（单位：米）支持支持
points[].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
points[].coordZNumberZ 轴高度（单位：米）支持支持

回调数据 ​

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

回调数据参数描述 ​

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

type 枚举值 ​

  • Arrow01
  • Arrow02
  • Arrow03
  • Arrow04
  • Arrow05
  • Arrow06
  • Arrow07
  • Segment01
  • Segment02
  • Segment03
  • Segment04
  • Segment05
  • Segment06
  • Segment07
  • Segment08
  • ModelCube
  • ModelCylinder

返回本章目录

返回本章目录

2. 更新路径数据 ​

引入版本：3.0 起支持

功能描述 ​

更新三维场景中添加路径的数据

调用方法 ​

JavaScript
let jsonData = {
  id: 'path',
  name: '路径',
  coordType: 0,
  coordTypeZ: 0,
  isAppend: false,
  tags: ['tag1', 'tag2', 'tag3'], // 用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐
  points: [
    {
      coord: [113.935195492731, 22.511670245576504], //以深圳湾经纬度为例
      coordZ: 64,
    },
    {
      coord: [113.935040742524, 22.511205569365902],
      coordZ: 64,
    },
    {
      coord: [113.934916949514, 22.510709831450303],
      coordZ: 64,
    },
    {
      coord: [113.934837080962, 22.5104179991934],
      coordZ: 64,
    },
    {
      coord: [113.934746228014, 22.5101201885304],
      coordZ: 64,
    },
    {
      coord: [113.934628413815, 22.509803431319003],
      coordZ: 64,
    },
    {
      coord: [113.934300895417, 22.5094280879441],
      coordZ: 64,
    },
    {
      coord: [113.933958382163, 22.5092297644093],
      coordZ: 64,
    },
  ],
};

appInstance.uniCall('updatePathCoord', 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：清除原有数据，更新数据支持支持
tagsAnything用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
pointsArray定义路径途径点支持支持
points[0].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
points[0].coordZNumberZ 轴高度（单位：米）支持支持

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

3. 更新路径样式 ​

引入版本：3.0 起支持

功能描述 ​

更新三维场景中添加路径的样式

调用方法 ​

JavaScript
let jsonData = {
  id: 'path',
  type: 'Segment05',
  texture: 'cableFlow',
  textureSpeed: 0,
  color: '#0000dd',
  colorPass: '#FFFF00',
  width: 50,
  label: 'label text',
  label2: 'label2 text',
  labelColor: '#ffffff',
  labelScale: 1,
  labelOffset: [0, 0, 2],
  labelBackgroundColor: '#333333',
  alpha: 0.5,
  snapSurface: 0,
};

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

参数描述 ​

属性类型说明端渲染流渲染
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
typeString路线样式类别，详见下表：路线样式类别，如果为：Model 开始的类型，会生成模型，并且使用贴图支持支持
textureString材质贴图名称，只有当 type 为 Model 开始的类型，才有用。端渲染：在场景中预置好的图片名称或外部图片 url，流渲染：服务器应用目录里的资源图片支持支持
textureSpeedNumber材质贴图的 UV 动画速度，默认：0，0 为不运动，其他数值沿着路径模型方向前进，负数为反向支持支持
colorString路线颜色，"" 颜色透明（HEX 颜色值）；只有当 type 不为 Model 开始的类型，才有用。支持支持
colorPassString模型对象 移动经过后的 路径颜色（HEX 颜色值）；只有当 type 不为 Model 开始的类型，才有用支持支持
widthNumber宽度(单位:米)支持支持
labelString标签文本支持支持
label2String第二行标签文本支持支持
labelColorString标签文本颜色，可选值，默认白色支持支持
labelScaleNumber标签文本的缩放，默认值是 1 表示原大，0 - 1：表示缩小倍率，大于 1：表示放大倍率支持支持
labelOffsetArray标签文本的位置偏移，默认值是[0, 0, 0]，表示相对于模型中心点的相对世界坐标的 x、y、z 偏移位置（单位：米）支持支持
labelBackgroundColorString标签文本背景颜色，可选值，默认灰色支持支持
alphaNumber透明度，0：完全透明；1：完全不透明支持支持
snapSurfaceNumber启用自动贴地，0：不贴地，1：自动贴地。默认值是 0不支持支持

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

4. 删除路径 ​

引入版本：3.0 起支持

功能描述 ​

删除路径

调用方法 ​

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

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

参数描述 ​

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

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

5. 添加 Shp 路径 ​

引入版本：3.1 起支持

功能描述 ​

添加 Shp 路径

调用方法 ​

JavaScript
let jsonData = {
  id: 'idPath',
  name: 'layerName',
  coordType: 0,
  coordTypeZ: 0,
  coordZ: 150,
  type: 'solid',
  color: '#ff0000',
  colorPass: '#ffff00',
  width: 10,
  tags: ['tag1', 'tag2', 'tag3'],
  shpPath: '',
  dataRegion: 'first',
};
appInstance.uniCall('addPathShp', 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支持支持
coordZNumber高度(单位:米)支持支持
typeString路线样式类别 Arrow01 Arrow02 Arrow03 Arrow04 Arrow05 Arrow06 Arrow07 Segment01 Segment02 Segment03 Segment04 Segment05 Segment06 Segment07 Segment08 ModelCube ModelCylinder支持支持
colorString颜色(HEX 颜色值, "color":"" 透明路径)支持支持
colorPassString覆盖物移动经过路径颜色(HEX 颜色值)支持支持
widthNumber宽度(单位:米)支持支持
tagsAnything用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
shpPathNumbershp 文件地址，端渲染，可以传入和 TGAPI.min.js 相对的 URL 路径，或者 URL 的绝对路径；流渲染，可以是本地 CustomShps 下的相对路径，根目录直接填 “test.shp”，如果是子文件夹填写"\test\test.shp"，如果是在线地址，需填写完整的 URL，例如："http://xxx.xx/xx/test.shp"支持支持
dataRegionString值为 all 或者 first ，用于区分只加载第一条还是加载全部数据，默认值是 first支持不支持

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录