This API map lists the exported Five SDK types and methods used by each guide.
Find the relevant surface
| Capability | Public surface | Guide |
|---|---|---|
| Work lifecycle | Five, parseWork, appendTo, load, refresh, dispose | Load a scene |
| View modes | Mode, changeMode, currentMode, mode.change | Camera and modes |
| Viewpoints and pose | Pano, Pose, observers, moveToPano, updateCamera | Navigate |
| Save and restore | State, getCurrentState, setState | Saved views |
| Spatial interaction | gesture.tap, model.intersectRaycaster, project2d | Events and coordinates |
| Image export | getSize, getPixels | Capture an image |
| Asset feedback | works.ready, pano.texture.*, models.load, models.refined, model.error | Loading stages |
In version 6.9.2, five.on(...) returns an unsubscribe function. Keep it and call it at teardown. Use the event names and payloads documented for your SDK version.
Read the fixed-version package
Use declarations for argument and return types, then inspect the implementation and run the example for behavior. Package AI guides can contain naming mistakes; a copied event name is not a contract test.
Browser SDK and server APIs
Five SDK renders Work in the browser. OpenAPI retrieves Team data and performs server-side operations using Developer app credentials. Endpoint-level contracts remain in the API reference. The browser SDK does not replace authentication or authorize a Team resource.