API参考
本节是 Kivicube Web iframe 插件的参考文档,聚焦已经公开给宿主页面使用的能力。
适用范围
当前参考主要覆盖:
iframe-plugin.js暴露的全局入口- 场景/合辑的打开与销毁
- iframe 流程事件
- 合辑
CollectionApi的运行时方法 - 场景
SceneApi的运行时方法
建议阅读顺序
和指南的关系
指南:说明什么时候用、怎么接入、有哪些注意事项、需要配合什么等。API:说明函数签名、参数、返回值和事件载荷等。
如果你已经在读指南页,可以直接跳到下面这些参考页:
- 属性相关:插件 API
- 事件相关:iframe 事件
- 合辑高级API:Collection API
- 场景高级API:Scene API