Micrio 4.1

Welcome to the Micrio 4.1 API documentation pages!

This is the home of the auto-generated Micrio client JS API documentation.

If you are looking for HOWTOs, tutorials, or general Micrio help, please check out our searchable Knowledge Base at:

https://kb.micr.io/

If you want to dive into the Micrio possibilities for use in your own project, you are in the right place here!

Start your journey by checking out the Micrio section.

Or check out an example GitHub repository containing some Micrio implentation code excamples:

https://github.com/Q42/Micrio.CustomProject/

Below you can find the most recent changelogs.

Good luck!

The Micrio team

Changelog

Legend:

✅	A feature has been added
❌	A feature has been deprecated/removed
🧰	An update/upgrade under the hood
📢	Breaking change, upgrading an older version could break on this

• 💫 4.1 - 2023/05/18

  Added more UI customization possibilities

  Links

  • JavaScript library
  • TypeScript declarations include
  • API docs

  Changes

  • Added UserInterfaceSettings where you can specify your own icons
  • You can specify default image settings in JS
  • Extended MarkerSettings. You can now:
    • Place marker tour controls inside a marker popup
    • Enable minimizing marker popups
    • Turn on that when a marker is opened that is part of a tour, this tour will also start automatically at the marker's step
  • Added new feature player: Serial Tours
  • Bug and stability fixes

• 💕 4.0 - 2023/02/14

  A total rewrite from the ground up has been done.

  Nothing has been changed in the data model, but if you are using custom implementations and want to upgrade, check out the Micrio 4.0 documentation.

  For upgrading existing 3.x implementations, see this Micrio knowledge base guide.

  Links

  • JavaScript library
  • TypeScript declarations include
  • API docs
  • Feature examples

  General changes

  • 🧰 Micrio client codebase is now fully TypeScript (+AssemblyScript for Wasm)
  • 🧰 New WebAssembly rendering model, improving performance and image switching
  • 🧰 Switched API documentation pages from JSDoc to typedoc

  New features

  • ✅ Single <micr-io> tag gallery support
  • ✅ Support for petapixel resolution images
  • ✅ Support for angular photographed spatial objects

  API

  • ✅ Introduced a State Management API to replace the deprecated Micrio.Modules
  • ❌ The Micrio.Modules JS API has been deprecated. Please see the migration article above.
  • ❌ The new Micrio() constructor has been deprecated: <micr-io> is now the only way to initialize Micrio
  • 📢 Micrio.Camera.setCoo now requires 3 arguments (x:number,y:number,z:number) instead of int[3]
  • 📢 <micr-io> now is the main Micrio controller instance instead of <micr-io>.micrio, and has direct Micrio members, such as .camera

  HTML & CSS

  • 📢 Micrio interface HTML elements have been restructured and some class names have been changed
  • 📢 Micrio marker custom classNames: no more class- prefix is added in the output HTML
  • 📢 Micrio marker CSS variables changed prefix from --default-marker-* to --micrio-marker-*

  Events

  • 📢 Events markerTours-*, markerScrollTours-* and tours-* now named tour-*

• 💫 3.3 - 2021/03/31

  Mainly a stability and performance upgrade.

  Links

  • JavaScript library
  • TypeScript declarations include
  • API docs

  Changes

  • Included Google Tag Manager support for Micrio event tracking
  • You can now use the trackpad for panning and zooming
  • Support for custom JS & CSS uploaded in the Image Editor
  • Set up for use with Spaces
  • Many stability and performance fixes, especially for slower connections

• 📚 3.2 - 2021/02

  Fully documented the client using JSDoc -- See the documentation here!

  Links

  • JavaScript library
  • TypeScript declarations include
  • API docs

  General

  • 🧰 Now using Svelte for all interface rendering!
  • ✅ TypeScript importable definitions file micrio-3.2.min.d.ts

  DOM structure

  • 📢 Due to the change to Svelte, the DOM structure of Micrio HTML elements has been changed
  • 📢 Greatly simplified the DOM structure by removing the ShadowRoot

  Performance

  • Using WebWorkers to download tile textures over multiple threads
  • A lot of performance and stability fixes and updates, especially for iPad

• 🔎 3.1 - 2020/11

  Links

  • JavaScript library

  Changes

  • ✅ Added multi-image tours: marker tours over multiple images
  • ✅ Added side-by-side comparison mode (let us know if you're interested in this!)
  • Many stability and bug fixes

• 🚅 3.0 - 2020/08

  Links

  • JavaScript library

  Changes

  • 🧰 Rewrote the entire engine to use WebAssembly. Read the journey blogpost HERE!
  • Many stability and bug fixes

• 🎞 2.9 - 2020/05

  Links

  • JavaScript library

  Changes

  • ✅ Full 360° video support with enriched content (markers, audio, storytelling)

• 📜 Earlier versions

  The dark, pre-changelog days..

  • 2.8 - 2020/04 - JS lib
  • 2.7 - 2020/02 - JS lib
  • 2.6 - 2020/01 - JS lib
  • 2.5 - 2019/12 - JS lib
  • 2.4 - 2019/11 - JS lib
  • 2.2 - 2019/08 - JS lib
  • 2.0 - 2019/02 - JS lib
  • 1.9 - 2019/02 - JS lib
  • 1.8 - 2018/07 - JS lib
  • 1.7 - 2018/05 - JS lib
  • 1.6 - 2018/04 - JS lib
  • 1.5 - 2018/04 - JS lib
  • 1.4 - 2018/02 - JS lib
  • 1.2 - 2017/06 - JS lib
  • 0.9 - 2015/06