KAPI

界面

本页目录

分析 ​

new Analyze() ​

实例化

  • 返回:

    • 实例化Analyze对象

  • 详情:

    实例化Analyze对象，可以调用分析模块中的方法

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
console.log(analyze)

addHeatmap2D() ​

新增二维热力图功能

  • 参数:

    • {Array} heatmapArray 热力信息
    • {Object} option 热力信息
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

option参数如下表

参数类型描述
strengthnumber热力渲染强度调节参数【建议1-5】
sizenumber热力渲染范围调节参数【建议1-5】
highnumber热力渲染图高度调节参数【单位：米】

  • 返回:

    • 新增二维热力图功能后的回调

  • 详情:

    新增二维热力图功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
let heatmapArray = [{ lng: 114.48080809, lat: 38.04440706, cnt: 20 },
  { lng: 114.47902883, lat: 38.04356116, cnt: 100 },
  { lng: 114.47589874, lat: 38.0438018, cnt: 60 },
  { lng: 114.47306132, lat: 38.04456011, cnt: 86 },
  { lng: 114.47184694, lat: 38.04367579, cnt: 38 }]
let option = {
  strength: 5,
  size: 1,
  high: 5
}
const status = await analyze.addHeatmap2D(heatmapArray,option)
console.log(status)

removeHeatmap2D() ​

移除二维热力图功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 移除二维热力图功能后的回调

  • 详情:

    移除二维热力图功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.removeHeatmap2D()
console.log(status)

addMigrateMap() ​

新增迁徙图功能

  • 参数:

    • {Object} start 开始坐标参数
    • {Object} end 结束坐标参数
    • {Boolean} isGraphic 是否是地理坐标（否为投影坐标）
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

start和end参数如下表

参数类型描述
startobject开始坐标参数
    xnumberx
    ynumbery
    znumberz
endobject结束坐标参数
    xnumberx
    ynumbery
    znumberz

  • 返回:

    • 新增迁徙图功能后的回调

  • 详情:

    新增迁徙图功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
let start = {
  x: 511128,
  y: 4056989,
  z: 85,
}
let end = {
  x: 510876,
  y: 4056882,
  z: 85,
}
const status = await analyze.addMigrateMap(start, end, false)
console.log(status)

removeMigrateMap() ​

移除迁徙图功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 移除迁徙图功能后的回调

  • 详情:

    移除迁徙图功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.removeMigrateMap()
console.log(status)

addHighLight() ​

新增物理高亮功能

  • 参数:

    • {String} id 高亮类型
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 新增物理高亮功能后的回调

  • 详情:

    新增物理高亮功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
const status = await analyze.addHighLight('123')
console.log(status)

removeHighLight() ​

移除物理高亮功能

  • 参数:

    • {String} id 高亮类型
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 移除物理高亮功能后的回调

  • 详情:

    移除物理高亮功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
const status = await analyze.removeHighLight('123')
console.log(status)

addWaterElectricityAlarm() ​

新增水电告警，实现点击监听功能

  • 参数:

    • {Object} option 热力信息
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

option参数如下表

参数类型描述
idstring水电告警ID参数【对应具体建筑的ID】
numstring水电告警数值参数【归一化后的数据，范围0-1,数值越小，表示剩余水电量越少，渲染颜色越深】
typestring水电告警类型参数【'water' or 'electricity' 两种】

  • 返回:

    • 新增水电告警点击监听功能后的回调

  • 详情:

    新增水电告警，实现点击监听功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
let option = {
  id: 'ed234',
  num: 123,
  type: 'electricity'
}
const status = await analyze.addWaterElectricityAlarm(option)
console.log(status)

removeWaterElectricityAlarm() ​

移除水电告警功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 移除水电告警功能后的回调

  • 详情:

    移除水电告警功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.removeWaterElectricityAlarm()
console.log(status)

openBuildingDismantling() ​

开启楼宇拆解功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 开启楼宇拆解功能后的回调

  • 详情:

    开启楼宇拆解功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.openBuildingDismantling()
console.log(status)

closeBuildingDismantling() ​

关闭楼宇拆解功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 关闭楼宇拆解功能后的回调

  • 详情:

    关闭楼宇拆解功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.closeBuildingDismantling()
console.log(status)

openSectioning() ​

开启地面剖切功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 开启地面剖切功能后的回调

  • 详情:

    开启地面剖切功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.openSectioning()
console.log(status)

closeSectioning() ​

关闭地面剖切功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 关闭地面剖切功能后的回调

  • 详情:

    关闭地面剖切功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.closeSectioning()
console.log(status)

addVisualField2D() ​

新增二维平面可视域功能

  • 参数:

    • {Object} option 可视域参数
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

option参数如下表

参数类型描述
distancenumber绘制2D平面可视域的距离【单位：M】
isGraphicboolean空间参数【默认接收地理坐标，指定isGraphic为false时，认为接收投影坐标，示例为投影坐标】
anglenumber绘制2D平面可视域可视域的角度大小【单位：°】
locationobject绘制2D平面可视域坐标
    xnumberx
    ynumbery
    znumberz
rotationobject绘制2D平面可视域姿态
    znumberz

  • 返回:

    • 新增二维平面可视域功能后的回调

  • 详情:

    新增二维平面可视域功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
let option = {
  isGraphic: false,
  distance: 2000,
  angle: 120,
  location: {
    x: 511128,
    y: 4056989,
    z: 85,
  },
  rotation: {
    z: 0,
  }
}
const status = await analyze.addVisualField2D(option)
console.log(status)

removeVisualField2D() ​

移除二维平面可视域功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 移除二维平面可视域功能后的回调

  • 详情:

    移除二维平面可视域功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.removeVisualField2D()
console.log(status)

addStrategicMap() ​

新增战略图功能

  • 参数:

    • {Object} start 开始坐标参数
    • {Object} end 结束坐标参数
    • {Boolean} isGraphic 是否是地理坐标（否为投影坐标）
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

start和end参数如下表

参数类型描述
startobject开始坐标参数
    xnumberx
    ynumbery
    znumberz
endobject结束坐标参数
    xnumberx
    ynumbery
    znumberz

  • 返回:

    • 新增战略图功能后的回调

  • 详情:

    新增战略图功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
let start = {
  x: 511128,
  y: 4056989,
  z: 85,
}
let end = {
  x: 510876,
  y: 4056882,
  z: 85,
}
const status = await analyze.addStrategicMap(start, end, false)
console.log(status)

removeStrategicMap() ​

移除战略图功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 移除战略图功能后的回调

  • 详情:

    移除战略图功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.removeStrategicMap()
console.log(status)

addRadiationCircle() ​

新增辐射圈功能

  • 参数:

    • {Object} option 辐射圈参数
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

option参数如下表

参数类型描述
radiusnumber绘制辐射圈的半径
isGraphicboolean空间参数
locationobject绘制辐射圈圆心坐标
    xnumberx
    ynumbery
    znumberz

  • 返回:

    • 新增辐射圈功能后的回调

  • 详情:

    新增辐射圈功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' } )

const analyze = new kapi.Analyze()
let option = {
  isGraphic: false,
  radius: 200,
  location: {
    x: 511128,
    y: 4056989,
    z: 85,
  }
}
const status = await analyze.addRadiationCircle(option)
console.log(status)

removeRadiationCircle() ​

移除辐射圈功能

  • 参数:

    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 移除辐射圈功能后的回调

  • 详情:

    移除辐射圈功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.removeRadiationCircle()
console.log(status)

toggleViewFloor() ​

切换查看楼层功能

  • 参数:

    • {number} floor 楼层
    • {Boolean} sync [可选]是否要多客户端同步场景，需要开启同步服务器

  • 返回:

    • 切换查看楼层功能后的回调

  • 详情:

    切换查看楼层功能

  • 示例:

js
import KAPI from '@ibrucekong/kapi'

const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })

const analyze = new kapi.Analyze()
const status = await analyze.toggleViewFloor(27)
console.log(status)