Matterport embedding & URL parameters - reference

Matterport embedding & URL parameters – reference

Show navigation tips or help when the tour starts – &help=

Example: https://my.matterport.com/show/?m=zxqmmNn6XoM&help=2

null	Default	Show help for new users (those who have never opened a Matterport model before).
0		Do not show help at all.
1		Always show help when the Matterport model opens.
2		Always show help when the Matterport model opens. More concise help text than &help=1.

Show or hide the highlight reel upon launch = &hl=

Example: https://my.matterport.com/show/?m=Zh14WDtkjdC&hl=1

0	Default if highlight reel does not have a 360º View	Briefly show the highlight reel upon launch before hiding.
1	Default if highlight reel does have a 360º View	Keep the highlight reel visible upon launch.
2		Keeps the highlight reel collapsed. This option is only available if there is no 360º View in the highlight reel. If there is a 360º View then &hl=1 behavior will be used.

On mobile, when virtual tour is embedded in a webpage, when viewer presses ‘play’, does it open in webpage or new tab? &nt=

Example (works on mobile only): https://my.matterport.com/show/?m=Zh14WDtkjdC&nt=1

0	Default	Only for mobile. If a Matterport model is embedded on a webpage, then when user presses the play button 3D Showcase opens in the same browser tab.
1		Only for mobile. If a Matterport model is embedded on a webpage, then when user presses the play button, 3D Showcase opens in a new browser tab.

Automatically start the guided tour? &ts=

Example: https://my.matterport.com/show/?m=Zh14WDtkjdC&ts=5

Number of seconds after initial fly-in before the Guided Tour automatically starts. Help is not shown. Set to a negative number to not start the Guided Tour.

Make the iframe containing the virtual tour responsive

<div style="padding-bottom:56.25%; position:relative; display:block; width: 100%">
<iframe width="100%" height="100%" src="https://my.matterport.com/show/?m=f56Eok5ChdH" frameborder="0" allowfullscreen="" allow="xr-spatial-tracking" style="position:absolute; top:0; left: 0"></iframe>
</div>

Third responsive iFrame version if the first two don’t work (HTML & CSS)

<div class="floorplan-comparison-embed">
    <iframe 
        src="YOUR_MODULE_URL/index.html" 
        title="Floor Plan Comparison: Before and After"
        loading="lazy" 
        style="width: 100%; height: 100%; border: none;"
        allow="fullscreen">
    </iframe>
</div>

<style>
    /* This container ensures the module maintains its shape on all screens */
    .floorplan-comparison-embed {
        position: relative;
        width: 100%;
        max-width: 1000px; /* Optional: limits max width on desktop */
        margin: 2rem auto;
        /* The aspect ratio should match your floor plan images + extra for captions */
        aspect-ratio: 16 / 11; 
        box-shadow: 0 4px 20px rgba(0,0,0,0.1);
        border-radius: 8px;
        overflow: hidden;
    }

    /* Fallback for older browsers that don't support aspect-ratio */
    @supports not (aspect-ratio: 16/11) {
        .floorplan-comparison-embed {
            height: 0;
            padding-bottom: 68.75%; /* (11/16)*100 */
        }
        .floorplan-comparison-embed iframe {
            position: absolute;
            top: 0;
            left: 0;
        }
    }
</style>

Hide the ‘dollhouse’ view when the virtual tour starts. &dh=

Example: https://my.matterport.com/show/?m=Zh14WDtkjdC&dh=0

0		Hide Dollhouse View in introductory fly-in. Hide Dollhouse Button in the bottom left corner of the 3D Showcase UI. Hides Dollhouse and Floorplan view snapshots in the highlight reel.
1	Default	Show Dollhouse View

Hide or show the virtual reality option within the tour. &vr=

Example: https://my.matterport.com/show/?m=Zh14WDtkjdC&vr=0 https://my.matterport.com/show/?m=Zh14WDtkjdC&vr=0

0		Hide the VR button.
1	Default	Show the VR button.