统一开发 API

Appearance

类型区域图操作 ​

目录 ​

1. 添加类型区域图 ​

引入版本：3.1 起支持

功能描述 ​

在三维场景中添加类型区域图

调用方法 ​

JavaScript
let jsonData = {
  id: 'typeArea',
  name: '类型区域图',
  coordType: 0,
  coordTypeZ: 0,
  coordZ: 60,
  alpha: 1,
  visible: true,
  lineDataId: 'lineDataId',
  tags: ['tag1', 'tag2', 'tag3'],
  areas: [
    {
      name: 'areaName01',
      points: [
        {
          coord: [113.86946869039616, 22.493958189189748], //以深圳湾经纬度为例
        },
        {
          coord: [113.86977272763804, 22.498154982221983],
        },
        {
          coord: [113.87844111550787, 22.497580739986624],
        },
        {
          coord: [113.87757662220088, 22.49175405194847],
        },
      ],
    },
    {
      name: 'areaName02',
      points: [
        {
          coord: [113.8697516678002, 22.498172735436164],
        },
        {
          coord: [113.86532055267648, 22.498534350194316],
        },
        {
          coord: [113.86426820258261, 22.495288614899888],
        },
        {
          coord: [113.86935283815114, 22.4939974211666],
        },
      ],
    },
    {
      name: 'areaName03',
      points: [
        {
          coord: [113.8768367853843, 22.494683728787688],
        },
        {
          coord: [113.87683894646098, 22.49372946263732],
        },
        {
          coord: [113.87294710038287, 22.49423183970084],
        },
        {
          coord: [113.87295882206737, 22.495073300382806],
        },
      ],
    },
  ],
  legends: [
    {
      name: 'legendName1',
      type: 'Segment03',
      color: '#EDFF00',
      areaHeight: 100,
      fillArea: 'Gradient01',
      fillPosition: 'top',
    },
    {
      name: 'legendName2',
      type: 'Segment03',
      color: '#BDFEFE',
      areaHeight: 10,
      fillArea: 'Gradient01',
      fillPosition: 'top',
    },
  ],
  data: [
    {
      areaName: 'areaName01',
      legendName: 'legendName1',
    },
    {
      areaName: 'areaName02',
      legendName: 'legendName1',
    },
    {
      areaName: 'areaName03',
      legendName: 'legendName2',
    },
  ],
};

appInstance.uniCall('addTypeAreaLayer', 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支持支持
coordZNumberZ 轴高度（单位：米）支持支持
alphaNumber透明度支持支持
visibleBoolean添加当前图层时默认显示还是隐藏支持支持
lineDataIdString对应本服务器上线数据对象，如果找到 lineDataId，则下方的 areas 不起作用不支持支持
tagsArray用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
areasObject定义基础填充区域，支持为不同区域定义各自样式支持支持
areas[0].nameString图层区域子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
areas[0].points[0].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
legendsArray定义图层包含图例，支持为不同图例定义各自样式支持支持
legends[0].nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别支持支持
legends[0].typeString区域边界样式类别（具体类型参考下图 type 枚举值，端渲染暂不支持 Gradient01）支持支持
legends[0].colorString颜色(HEX 颜色值)支持支持
legends[0].areaHeightNumber边界围栏高度(单位:米)支持支持
legends[0].fillAreaString区域填充样式类别（具体类型参考下图 fillArea 枚举值）支持支持
legends[0].fillPositionString区域填充的位置，top/bottom，默认 top支持支持
dataArray定义图层可视化数据支持支持
data[0].areaNameString数据点区域名称支持支持
data[0].legendNameString数据点图例类别支持支持
areas[].nameString图层区域子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
areas[].points[].coordArrayXY 轴坐标，X：经度；Y：纬度支持支持
legends[].nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别支持支持
legends[].typeString区域边界样式类别（具体类型参考下图 type 枚举值，端渲染暂不支持 Gradient01）支持支持
legends[].colorString颜色(HEX 颜色值)支持支持
legends[].areaHeightNumber边界围栏高度(单位:米)支持支持
legends[].fillAreaString区域填充样式类别（具体类型参考下图 fillArea 枚举值）支持支持
legends[].fillPositionString区域填充的位置，top/bottom，默认 top支持支持
data[].areaNameString数据点区域名称支持支持
data[].legendNameString图例类别，必须与 legends[].name 的值完全匹配支持支持

回调数据 ​

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

回调数据参数描述 ​

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

type 枚举值 ​

  • Arrow01
  • Gradient01
  • Gradient02
  • Gradient03
  • Grid01
  • Grid02
  • Grid03
  • Grid04
  • Grid05
  • Segment01
  • Segment02
  • Segment03

fillArea 枚举值 ​

  • Gradient01
  • Gradient02
  • Grid01
  • Grid02
  • Segment01
  • Segment02
  • Solid01
  • Solid02
  • Solid03
  • Solid04
  • Solid05

返回本章目录

返回本章目录

2. 更新类型区域图数据 ​

引入版本：3.1 起支持

功能描述 ​

更新三维场景中添加类型区域图的数据

调用方法 ​

JavaScript
let jsonData = {
  id: 'typeArea',
  name: '类型区域图',
  isAppend: true,
  tags: ['tag1', 'tag2', 'tag3'],
  data: [
    {
      areaName: 'areaName01',
      legendName: 'legendName2',
    },
    {
      areaName: 'areaName02',
      legendName: 'legendName1',
    },
    {
      areaName: 'areaName03',
      legendName: 'legendName1',
    },
  ],
};

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

参数描述 ​

属性类型说明端渲染流渲染
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别支持支持
nameString图层名称，支持为图层自定义名称支持支持
isAppendBooleantrue: 追加数据，并不会清除现有其他数据，如果名称相同，则只更新该数据；false: 重建数据，数据全部清空支持支持
tagsArray用户自定标签数组，用于保存用户的扩展数据，或者可以控制显隐不支持支持
dataArray定义图层可视化数据支持支持
data[0].areaNameString数据点区域名称支持支持
data[0].legendNameString数据点图例类别支持支持
data[].areaNameString数据点区域名称支持支持
data[].legendNameString图例类别，必须与 legends[].name 的值完全匹配支持支持

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

3. 更新类型区域图样式 ​

引入版本：3.1 起支持

功能描述 ​

更新三维场景中添加类型区域图的样式

调用方法 ​

JavaScript
let jsonData = {
  id: 'typeArea',
  alpha: 1,
  isAppend: true,
  legends: [
    {
      name: 'legendName1',
      type: 'Gradient02',
      color: '#ff0000',
      areaHeight: 800,
      fillArea: 'Segment02',
      fillPosition: 'top',
    },
    {
      name: 'legendName2',
      type: 'Gradient02',
      color: '#FFDE7B',
      areaHeight: 100,
      fillArea: 'Segment02',
      fillPosition: 'top',
    },
  ],
};
appInstance.uniCall('updateTypeAreaLayerStyle', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别
alphaNumber透明度
isAppendBoolean是否追加数据（按数据顺序），true：按新数据 更新原有重复数据 & 追加新数据；false：清除原有数据 & 重建新数据
legendsArray定义填充图例
legends[0].nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别
legends[0].typeString区域边界样式类别（具体类型参考上图 type 枚举值，端渲染暂不支持 Gradient01）
legends[0].colorString颜色(HEX 颜色值)
legends[0].areaHeightNumber边界围栏高度（单位：米）
legends[0].fillAreaString区域填充样式类别（具体类型参考上图 fillArea 枚举值）
legends[0].fillPositionString区域填充的位置，top/bottom，默认 top
legends[].nameString图层内图例名称，新建时调用者自己传入的唯一名称，用于各种操作的图例识别
legends[].typeString区域边界样式类别（具体类型参考上图 type 枚举值，端渲染暂不支持 Gradient01）
legends[].colorString颜色(HEX 颜色值)
legends[].areaHeightNumber边界围栏高度（单位：米）
legends[].fillAreaString区域填充样式类别（具体类型参考上图 fillArea 枚举值）
legends[].fillPositionString区域填充的位置，top/bottom，默认 top

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

4. 更新类型区域图区域 ​

引入版本：3.1 起支持

功能描述 ​

更新三维场景中添加类型区域图的区域

调用方法 ​

JavaScript
let jsonData = {
  id: 'typeArea',
  isAppend: false,
  coordType: 0,
  coordTypeZ: 0,
  coordZ: 60,
  areas: [
    {
      name: 'areaName01',
      points: [
        {
          coord: [113.86936725145179, 22.493961406161986], //以深圳湾经纬度为例
        },
        {
          coord: [113.86686131708493, 22.492759585950132],
        },
        {
          coord: [113.86738877428596, 22.494513005942725],
        },
      ],
    },
    {
      name: 'areaName02',
      points: [
        {
          coord: [113.86828346563361, 22.48995549541383],
        },
        {
          coord: [113.86665223366745, 22.492078756018607],
        },
        {
          coord: [113.8662752188207, 22.49050134575487],
        },
      ],
    },
    {
      name: 'areaName03',
      points: [
        {
          coord: [113.86575162030968, 22.48874573896091],
        },
        {
          coord: [113.86783179032565, 22.487745809901714],
        },
        {
          coord: [113.86543840834135, 22.4858166435584],
        },
      ],
    },
  ],
};
appInstance.uniCall('updateTypeAreaLayerArea', jsonData, (result) => {
  console.log(result);
});

参数描述 ​

属性类型说明
idString图层对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别
isAppendBoolean是否追加数据（按数据顺序），true：按新数据 更新原有重复数据 & 追加新数据；false：清除原有数据 & 重建新数据
coordTypeNumberXY 轴坐标类别，0：X 经度，Y 纬度；1：X 米，Y 米，相对世界 00 点 目前该属性仅支持属性值为 0
coordTypeZNumberZ 轴坐标类别，0：相对 3D 世界 0 海拔；1：相对 3D 世界地表；2：相对 3D 模型表面（单位：米） 目前该属性仅支持属性值为 0
coordZNumberZ 轴高度（单位：米）
areasObject定义基础填充区域，支持为不同区域定义各自样式
areas[0].nameString图层区域子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别
areas[0].points[0].coordArrayXY 轴坐标，X：经度；Y：纬度
areas[].nameString图层区域子对象 id，新建时调用者自己传入的唯一标识，用于各种操作的对象识别
areas[].points[].coordArrayXY 轴坐标，X：经度；Y：纬度

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录

5. 删除类型区域图 ​

引入版本：3.0 起支持

功能描述 ​

删除类型区域图

调用方法 ​

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

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

参数描述 ​

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

回调数据 ​

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

回调数据参数描述 ​

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

返回本章目录