API Reference

This section is the reference documentation for the Kivicube Web iframe plugin, focused on the capabilities that are publicly exposed to the host page.

Coverage

The current reference mainly covers:

• the global entry points exposed by iframe-plugin.js
• opening and destroying scenes and collections
• iframe lifecycle events
• runtime methods on CollectionApi
• runtime methods on SceneApi

Recommended Reading Order

1. Plugin API
2. iframe Events
3. Collection API
4. Scene API

How This Relates to the Guide

• The Guide explains when to use each capability, how to integrate it, what to watch out for, and what it depends on.
• The API pages explain function signatures, parameters, return values, and event payloads.

If you are already reading the guide, you can jump directly to these reference pages:

• Property-related topics: Plugin API
• Event-related topics: iframe Events
• Collection Advanced API: Collection API
• Scene Advanced API: Scene API