« For Developers: Embedding, JS, APIs
Micrio JS Events: Instance lifecycle
The Micrio client lifecycle JS events
The order of events to know when a Micrio element is initialized, has its required data to start, has drawn its first frame, or is being destroyed is as follows.
All events below fire on the Micrio HTML element, unless specified otherwise.
A new Micrio JS has been created. This is before any initialization or loading is done.
This fires for any loaded or pre-loaded image data JSON (resolution, base settings), including linked images that are preloaded for tours. The
event.detailis the individual image JSON, that can be manipulated at this point.
The main image data (resolution, low-level settings) has been downloaded and will be processed next. The
event.detailis the settings JSON, allowing for any preprocessing manipulation.
The image info has been loaded and the
Camerahas been initialized. Nothing else is initialized or loaded yet.
<canvas>HTML element has been placed in the Micrio HTML container.
Fires when image content data has been loaded, but not yet initialized. The
event.detailis the data JSON. This allows you to change any data (markers, tours, ...) before it gets processed by Micrio.
All required data, such as tours and markers, has been succesfully loaded and initialized.
Comes directly after
metadataand signifies that the image is fully ready to start being drawn. An alternative is the
micrio-readyevent which fires on the
windowinstead of the Micrio HTML element.
The image is fully loaded and the first frame has been succesfully drawn, but the image is still fading in. The event
loadfires for any Micrio image, even embedded inside another
showevent only fires on a main
The first fully opaque (100% opacity) has been drawn! From here on, the Micrio element will be opaque and can be for instance faded in.
These fire when texture downloading starts, or finishes. This event can be used to show or hide a custom loader element.
This event fires for any fatal Micrio errors that might arise. The
event.detailis the error detail object. When this event is fired, a fatal
Exceptionwill also be thrown.
The Micrio element is removed.