界面
全局:应用实例
build
在KAPI中,我们提供了丰富切简单易用的API文档,遵从常规API的封装,对于新手上手十分友好,特别是使用过ArcGIS、Cesium、百度、高德等地图框架的,在试用本API时可以无缝切换。
在引入该组件后,首先要创建KAPI的实例。
类型:
[token: string]: any
默认:
undefined
详情:
当试用KAPI时,首先要使用
kapi.build
方法实例化kapi
对象,然后作为上下文,可以创建Scene|Controller|Camera|Data|Draw|Event|Iot|Layer|Marker|Measure|Tool|ui
等功能类库示例:
js
import KAPI from '@ibrucekong/kapi'
const kapi = await KAPI.build('Your Auth Token')
console.log(kapi)
调用 build
方法,传入 授权码
,返回应用实例,实例提供后续功能开发的上下文实例,进行KAPI的整个开发工作。
1、访问授权页面,申请试用授权
2、类库方法大多是
Promise
返回值方式进行使用,如果对Promise
不熟悉,可以点击此处学习
kapi.version
KAPI在实例化后,可以通过 kapi.version
查看正在使用的版本信息
js
const kapi = await KAPI.build('Your Auth Token')
console.log(kapi.version)
当使用KAPI时遇到问题,可以根据版本号和报错信息反馈给我们。
kapi.ui
ui
类库提供一系列UI小部件,包括全屏按钮、网络状态框等
js
const kapi = await KAPI.build('Your Auth Token')
// 显示全屏按钮
let res1 = await kapi.ui.showFullscreen()
console.log(res1)
// 隐藏全屏按钮
let res2 = await kapi.ui.hideFullscreen()
console.log(res2)
kapi.Scene()
Scene
模块,通过 new kapi.Scene(id, options)
可实现实例化,两个参数分别为[1]工程中DOM容器的id,[2]渲染云场景时的配置参数,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const scene = new kapi.Scene('kapi-container', {server: 'Your Service URL'})
kapi.Controller()
Controller
模块,通过 new kapi.Controller()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const controller = new kapi.Controller()
- 参考: new Controller()
kapi.Camera()
Controller
模块,通过 new kapi.Controller()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const camera = new kapi.Camera()
- 参考: new Camera()
kapi.Marker()
Marker
模块,通过 new kapi.Marker()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const marker = new kapi.Marker()
- 参考: new Marker()
kapi.Measure()
Measure
模块,通过 new kapi.Measure()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const measure = new kapi.Measure()
- 参考: new Measure()
kapi.Draw()
Draw
模块,通过 new kapi.Draw()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const draw = new kapi.Draw()
- 参考: new Draw()
kapi.Analyze()
Analyze
模块,通过 new kapi.Analyze()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const analyze = new kapi.Analyze()
- 参考: new Analyze()
kapi.Animation()
Animation
模块,通过 new kapi.Animation()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const animation = new kapi.Animation()
- 参考: new Animation()
kapi.Coord()
Coord
模块,通过 new kapi.Coord()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const coord = new kapi.Coord()
- 参考: new Coord()
kapi.Data()
Data
模块,通过 new kapi.Data()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const data = new kapi.Data()
- 参考: new Data()
kapi.Iot()
Iot
模块,通过 new kapi.Iot()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const iot = new kapi.Iot()
- 参考: new Iot()
kapi.Layer()
Layer
模块,通过 new kapi.Layer()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const layer = new kapi.Layer()
- 参考: new Layer()
kapi.Event()
Event
模块,通过 new kapi.Event()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const event = new kapi.Event()
- 参考: new Event()
kapi.Tool()
Tool
模块,通过 new kapi.Tool()
可实现实例化,以此调用该模块中的其他方法。
js
const kapi = await KAPI.build('Your Auth Token')
const tool = new kapi.Tool()
- 参考: new Tool()