xunjijssdk v0.0.28

寻迹 SDK JS 开发手册 (Xunji SDK 0.0.28版本)

概要介绍

寻迹 SDK 为Web应用提供一个完善的 定位/地图 系统开发框架，屏蔽掉 定位/地图 底层的复杂细节，对外提供较为简洁的 API 接口，方便第三方应用快速集成 定位/地图 功能。寻迹 SDK 提供的能力如下：

• 地图组件及对地图组件相关操作的接口
• 地图数据管理服务
• 设备管理服务
• 标签管理服务

业务介绍

• 地图组件及对地图组件相关操作的接口 为第三方用户提供地图组件， 可快速在网页中集成地图相关功能， 同时， 寻迹 SDK 提供了切换楼层， 地图缩放、 移动Camera到某个指定的位置、在地图上绘制围栏、绘制热力图、绘制运动轨迹、在地图上添加Marker等多种操作， 开发者可根据自身需求, 快速定制集成地图组件。
• 地图数据管理服务 即获取地图的全部数据信息， 寻迹 SDK 可以向开发者提供地图中的所有楼栋信息、楼层信息、电子围栏信息等。开发者可根据这些数据信息自行进行展示操作。
• 设备管理服务 设备管理服务向第三方用户提供了对设备相关的操作和管理。包括：添加设备、更新设备、上传设备图片、设定电子围栏、导航到设备、删除设备、获取设备列表、获取设备的历史轨迹、监听设备进入退出围栏等多种接口。
• 标签管理服务 标签管理服务向第三方用户提供了对标签相关的操作和管理。包括：获取标签的详细信息。

集成方式

使用npm:

npm i xunjijssdk

安装成功后， 使用import导入后即可调用相关接口方法。

import xunji from 'xunjijssdk'

若直接在浏览器中使用， 则使用<script>标签引入(直接将index.js拷贝到项目中使用):

<script src="index.js"></script>

之后可以使用window.xunjiSDK来调用相关接口方法。

总体接口介绍

根据不同的业务模块， 寻迹 SDK 主要提供了如下接口供开发者调用。

SDK 初始化

调用如下方法进行初始化

    var xjClient = window.xunjiSDK.XJClient.getInstance();
    xjClient.init("注册时申请的APPID", "IP和PORT组成的BaseUrl", initSuccessCallback, initFailCallback);

传入第三方开发者申请到的APPID 和 IP和PORT组成的BaseUrl。 该方法为异步调用， 在回调方法initSuccessCallback和initFailCallback， 可以拿到初始化成功或者失败的结果。

地图组件及相关操作

先使用 window.xunjiSDK.XJMapbox.getInstance();拿到XJMapbox的对象，首先使用getData方法或许地图数据，然后使用loadMap传入地图数据和dom container的id去渲染绘制地图，在promise回调方法内可获取楼层数据，并且做后续的操作。 然后调用该对象提供的相关接口方法对设备进行操作。

参考: 寻迹API文档

设备管理服务

先使用 window.xunjiSDK.XJDeviceManager.getInstance();拿到XJDeviceManager的对象， 然后调用该对象提供的相关接口方法对设备进行操作。

参考: 寻迹API文档

标签管理服务

先使用 window.xunjiSDK.XJTagManager.getInstance();拿到XJTagManager的对象， 然后调用该对象提供的相关接口方法对标签进行操作。

参考: 寻迹API文档

地图数据解析服务

先使用 window.xunjiSDK.XJMapManager.getInstance();拿到XJMapManager的对象。 关键方法: XJMapManager.updateMapInfo() 更新地图数据并解析成楼栋,楼层,电子围栏等具体对象. 然后通过 XJMapManager 对象对地图数据进行具体的操作.

参考: 寻迹API文档