Micrio Knowledge Base

Appearance

360° improvements in Micrio 5.4 Client 5.x ​

If you do have a Micrio implementation inside your own website which makes use of 360° image tours and storytelling, this article could be of help.

This guide only applies to upgrading existing custom JS implementations in your own website using Micrio 5.0-5.3 to version 5.4. If you don't know what that is, or if you are simply using Micrio out of the box without any customizations, this article is not for you.

The main change: Viewport model ​

The only base change in Micrio 5.4 (latest version: 5.4.2) is the internal viewport model. This has changed from [x0, y0, x1, y1] to [x0, y0, width, height].

Why this change? ​

This change was necessary to properly support storytelling and video tours inside 360-degree images. With the old model, some viewports were impossible to render correctly, especially when they would cross the panorama seam. The new model resolves these issues.

Backwards compatibility ​

The latest Micrio version (5.4.2 and up) is fully backwards compatible and is safe to implement in existing projects. By default, your existing images and any newly created ones will still use the old [x0, y0, x1, y1] viewport model.

How to upgrade to the new viewport model ​

Using the new viewport model is fully optional.

If you want to use the new model for your images, you can update them in the Micrio Dashboard. You have two options:

  1. Update a single image: In the dashboard, click on an image's context menu, or select an image in the spaces 360° editor and choose 'Use new view model'.

    Update single image to new viewport model

  2. Update a 360 Spaces project: If you have a 360 Spaces project, you can update all images within that project at once. Click the project's context menu, and choose 'Use new view model'.

This will convert all saved markers, tours, and other viewport-related data to the new model for the selected images.

Important considerations ​

IMPORTANT

If you choose to upgrade your images to the new viewport model, you must also upgrade your Micrio client library on your website to version 5.4.2 or newer.

Additionally, if you have any custom JavaScript code that manually creates or manipulates viewports (for example, using ie. Camera.setView()), you will need to update your code to use the new [x0, y0, width, height] model. Old code relying on the [x0, y0, x1, y1] format will not work correctly with images that have been migrated.