Skip to content

Runtime settings for the Micrio viewer Client 5.x


This page is about the Micrio client version 5. Use the links below to navigate to alternative versions.

The Micrio viewer offers a lot of embedding customization options, allowing you to adjust the behavior.

HTML attributes

You can specify options as attributes using the <micr-io> element.

AttributeTypeDefault valueDescription

General settings

langstringenThe data language code to use
data-pathstringBased on imageFor custom hosted Micrio images, specify the root URL like this
data-inittypestring-Set this to cover to start the image using the full viewport
data-coverlimitboolean-The user cannot zoom out further than the full viewport, possibly not being able to view the entire image at once
lazyloadbooleanfalseSet this to true to only start loading the image when it's been scrolled into the user's view, in case it's lower in a webpage.
data-skipmetabooleanfalseDo not load any metadata (markers, tours, etc)
data-staticbooleanfalseSimulate an <img/> element. No logo, loaderbar, and no event listeners
data-routerstringnullRead and write deeplinks to opened tours and markers. Options are hash for hash-based routing, and static for using the real URL path (advanced use, for SSR)
data-gtagbooleantrueIf you are using Google Analytics in your site, by default Micrio will send user input as GA Events. Set this to false to prevent that. More info

Camera controls

data-camspeednumber1Set the speed factor for camera animations
data-freemovebooleanfalseCan pan outside the image's limits
data-zoomlimitnumber1Set this to the percentage (1=100%) of how far a user can zoom in to the image
data-viewArray<number>0,0,1,1Set the initial viewport rectangle of the image (x0, y0, x1, y1 with coordinates as fractions)
data-focusArray<number>0.5,0.5Set focus point of the image, which is treated as the center in case of image overflows (x, y with coordinates as fractions)
data-keeprenderingbooleanfalseKeep drawing frames, even if there is no movement. Use only when you need this.
data-normalize-dprbooleantrueWhen turned off, high DPI screens will have its zoom limited to visually 100% of pixel size, instead of corrected for the pixel density, resulting in being able to zoom in less (but the image will always be sharp)

User input

data-eventsbooleantrueIf set to false, no event handlers will be set up and the image will be non-interactive
data-keysbooleanfalseIf set to true, you can use your keyboard to navigate through the image
data-pinch-zoombooleantrueUse trackpad/touchscreen pinching for zooming
data-scroll-zoombooleantrueUse mousewheel/trackpad scrolling for zooming
data-control-zoombooleanfalseThe user must press CTRL/CMD when zooming with the mousewheel
data-two-finger-panbooleanfalseRequires the user to use two fingers to pan the image on touch devices
data-zoomingbooleantrueIf set to false the user cannot zoom at all
data-draggingbooleantrueUse dragging and touch events for panning

User interface

data-uibooleantrueWhen set to false, no HTML UI elements will be printed
data-controlsbooleantrueWhen set to false, no control buttons will be printed
data-fullscreenbooleantrueShow a fullscreen switching buttons on platforms that support it
data-socialbooleanfalseShow a social sharing link menu
data-logobooleantrueWhen set to false, the Micrio logo will be hidden
data-logo-orgbooleantrueWhen set to false, the optional Organisation logo (top right) will be hidden
data-toolbarbooleantrueWhen set to false, no top menu bar will be printed
data-show-infobooleanfalseShow an image info panel with the title and description
data-minimapbooleanfalseIf set to true, an interactive minimap will be shown
data-minimap-hidebooleantrueIf set to false, the minimap will always be visible
data-minimap-heightnumber160Set the minimap height in pixels
data-minimap-widthnumber200Set the minimap width in pixels


mutedbooleanIf this attribute is present, all audio will be disabled
volumenumber1The general sound volume for music/sfx (between 0 and 1)
data-mutedvolumenumber0If music was added to the image, fade it to this volume while other audio plays (between 0 and 1)