Type Alias Settings

Settings: {
    _360?: {
        rotX?: number;
        rotY?: number;
        rotZ?: number;
        scale?: number;
        trueNorth?: number;
        video?: Video;
    };
    _markers?: MarkerSettings;
    _meta?: {
        [key: string]: any;
    };
    album?: AlbumInfo;
    alwaysShowMinimap?: boolean;
    audio?: boolean;
    camspeed?: number;
    clusterMarkerRadius?: number;
    clusterMarkers?: boolean;
    cmHeight?: number;
    cmWidth?: number;
    controlZoom?: boolean;
    crossfadeDuration?: number;
    css?: {
        href: string;
    };
    doTourJumps?: boolean;
    dragElasticity?: number;
    embedFadeDuration?: number;
    embedRestartWhenShown?: boolean;
    fadeBetween?: boolean;
    focus?: [number, number];
    forceDataRefresh?: boolean;
    freeMove?: boolean;
    fullscreen?: boolean;
    gallery?: GallerySettings;
    gridClickable?: boolean;
    gridTransitionDuration?: number;
    gridTransitionDurationOut?: number;
    hookDrag?: boolean;
    hookEvents?: boolean;
    hookKeys?: boolean;
    hookPinch?: boolean;
    hookScroll?: boolean;
    infoUrl?: string;
    initType?: string;
    js?: {
        href: string;
    };
    keepRendering?: boolean;
    lazyload?: number;
    limitToCoverScale?: boolean;
    markersScale?: boolean;
    micrioSplitLink?: string;
    minimap?: boolean;
    minimapHeight?: number;
    minimapWidth?: number;
    mutedVolume?: number;
    muteOnBlur?: boolean;
    noControls?: boolean;
    noExternals?: boolean;
    noFollow?: boolean;
    noGTag?: boolean;
    noLogo?: boolean;
    noOrgLogo?: boolean;
    noRetina?: boolean;
    noSmoothing?: boolean;
    noToolbar?: boolean;
    noUI?: boolean;
    noZoom?: boolean;
    omni?: OmniSettings;
    onlyPreferredLang?: boolean;
    pinchZoomOutLimit?: boolean;
    postProcessingFragmentShader?: string;
    resetView?: boolean;
    restrict?: View;
    routerMarkerTours?: boolean;
    secondaryInteractive?: boolean;
    showInfo?: boolean;
    skipBaseLevels?: number;
    skipMeta?: boolean;
    social?: boolean;
    start?: {
        id: string;
        type:
            | "marker"
            | "markerTour"
            | "tour"
            | "page";
    };
    startVolume?: number;
    static?: boolean;
    theme?: "dark" | "light" | "os";
    thumbSrc?: string;
    twoFingerPan?: boolean;
    ui?: Partial<UserInterfaceSettings>;
    view?: View;
    zoomLimit?: number;
    zoomLimitDPRFix?: boolean;
}

Micrio image settings, which is on load included as ImageInfo.settings.

Type declaration

Optional_360?: {
    rotX?: number;
    rotY?: number;
    rotZ?: number;
    scale?: number;
    trueNorth?: number;
    video?: Video;
}
Optional settings for 360 images/video
- OptionalrotX?: number
  2D embed X rotation in 360
- OptionalrotY?: number
  2D embed Y rotation in 360
- OptionalrotZ?: number
  2D embed Z rotation in 360
- Optionalscale?: number
  2D embed IFRAME scale
- OptionaltrueNorth?: number
  Y rotation true north correction
- Optionalvideo?: Video
  A 360 video object
Optional_markers?: MarkerSettings
Optional marker settings
Optional_meta?: {
[key: string]: any;
}
Freeform custom settings, this is the "Custom JSON" field in the image editor
- [key: string]: any
Optionalalbum?: AlbumInfo
OptionalalwaysShowMinimap?: boolean
Don't fade out the minimap (default: false)
Optionalaudio?: boolean
Enable the audio controller (default: true)
Optionalcamspeed?: number
The camera animation speed (default: 1)
OptionalclusterMarkerRadius?: number
The clustered marker radius
OptionalclusterMarkers?: boolean
Overlapping markers are clustered
OptionalcmHeight?: number
The physical height of the object in cm
OptionalcmWidth?: number
The physical width of the object in cm
OptionalcontrolZoom?: boolean
Force using the CTRL/CMD-keys to zoom in using scrolling (default: false)
OptionalcrossfadeDuration?: number
Optional image crossfade duration, in seconds
Optionalcss?: {
href: string;
}
Load a custom CSS file with this image
- href: string
  The asset href
OptionaldoTourJumps?: boolean
More natural camera zooming animation during transitions (default: true)
OptionaldragElasticity?: number
Kinetic dragging sensitivity (default: 1)
OptionalembedFadeDuration?: number
Embedded images/videos fade in/out duration, in seconds
OptionalembedRestartWhenShown?: boolean
When being re-shown, always restart
OptionalfadeBetween?: boolean
Do a crossfade when navigating between images (default: true)
Optionalfocus?: [number, number]
Load a cover-initing image focussed on this coordinate ([x, y])
OptionalforceDataRefresh?: boolean
Force refresh for published data JSON file
OptionalfreeMove?: boolean
Allow the user to pan and zoom out of image bounds
Optionalfullscreen?: boolean
Show a fullscreen button if supported
Optionalgallery?: GallerySettings
Albums
OptionalgridClickable?: boolean
Grid: can click individual grid images
OptionalgridTransitionDuration?: number
Grid: transition duration, in seconds
OptionalgridTransitionDurationOut?: number
Grid: transition duration going back, in seconds
OptionalhookDrag?: boolean
Allow panning through the image (default: true)
OptionalhookEvents?: boolean
Hook user events (default: true)
OptionalhookKeys?: boolean
Hook keyboard controls (default: false)
OptionalhookPinch?: boolean
Allow pinch to zoom on touch devices (default: true)
OptionalhookScroll?: boolean
Use the mousewheel or trackpad scrolling for zooming (default: true)
OptionalinfoUrl?: string
Use a custom uri for the info json file
OptionalinitType?: string
The starting viewport. Possible values cover and contain. Defaults to contain
Optionaljs?: {
href: string;
}
Load a custom JS file with this image
- href: string
  The asset href
OptionalkeepRendering?: boolean
Don't stop drawing frames when idle
Optionallazyload?: number
Initialize the image when the container is scrolled into view (default: false)
OptionallimitToCoverScale?: boolean
The user cannot zoom out more than a fully covered view
OptionalmarkersScale?: boolean
All markers are scaled with the image
OptionalmicrioSplitLink?: string
A static split-screen Micrio Image ID
Optionalminimap?: boolean
Show the minimap (default: true)
OptionalminimapHeight?: number
The minimap maximum height, in px (default: 160)
OptionalminimapWidth?: number
The minimap maximum width, in px (default: 200)
OptionalmutedVolume?: number
The audio volume when other media is playing [0-1] (default: 0)
OptionalmuteOnBlur?: boolean
Mute the audio when the current browser tab loses focus
OptionalnoControls?: boolean
Don't show any controls in the UI
OptionalnoExternals?: boolean
Don't load any custom JS or CSS scripts
OptionalnoFollow?: boolean
When this is a secondary image, don't follow the main image's navigation
OptionalnoGTag?: boolean
Don't load GTM module
OptionalnoLogo?: boolean
Don't show the Micrio logo on the top left
OptionalnoOrgLogo?: boolean
Don't show the organisation logo on the top right
OptionalnoRetina?: boolean
Turn off support for high DPI screens
OptionalnoSmoothing?: boolean
Don't smooth out pixels when zooming in > 100%
OptionalnoToolbar?: boolean
Don't show the menu bar with tours and custom pages
OptionalnoUI?: boolean
Don't load any UI elements
OptionalnoZoom?: boolean
Don't allow the user to zoom in or out
Optionalomni?: OmniSettings
FOR OMNI OBJECTS
OptionalonlyPreferredLang?: boolean
Don't auto-load first available non-preferred data language
OptionalpinchZoomOutLimit?: boolean
Don't allow less than minimum scale zooming when pinching
OptionalpostProcessingFragmentShader?: string
ADVANCED: A fragment shader for WebGL postprocessing This shader MUST have and use: uniform sampler2D u_image; // the render buffer texture varying vec2 v_texCoord; // the texture coordinate uniform float u_time; // elapsed time in seconds
OptionalresetView?: boolean
When navigating back to this image from another image, reset the initial view
Optionalrestrict?: View
Restrict navigation to this viewport ([x0,y0,x1,y1])
OptionalrouterMarkerTours?: boolean
With routing enabled, enable marker/tour deeplinks
OptionalsecondaryInteractive?: boolean
When this is a secondary image in split screen, allow independent navigating
OptionalshowInfo?: boolean
Show an info modal with the image title and description
OptionalskipBaseLevels?: number
Skip the deepest zoom levels
OptionalskipMeta?: boolean
Don't load this image's ImageData.ImageData (markers, tours, etc)
Optionalsocial?: boolean
Show a social sharing button
Optionalstart?: {
    id: string;
    type:
        | "marker"
        | "markerTour"
        | "tour"
        | "page";
}
When opening the image without a predefined deeplink, open this
- id: string
- type:
      | "marker"
      | "markerTour"
      | "tour"
      | "page"
OptionalstartVolume?: number
The starting audio volume [0-1] (default: 1)
Optionalstatic?: boolean
Render this image as a static image
Optionaltheme?: "dark" | "light" | "os"
Dark/light theme
OptionalthumbSrc?: string
Use a custom thumbnail image uri
OptionaltwoFingerPan?: boolean
Force two-finger panning on touch devices (default: false)
Optionalui?: Partial<UserInterfaceSettings>
UI customizations
Optionalview?: View
The starting viewport ([x0,y0,x1,y1])
OptionalzoomLimit?: number
The maximum zoom level in % of the original (default: 1)
OptionalzoomLimitDPRFix?: boolean
Adjust the maximum zoom of high DPI screens to that of regular displays

Type Alias Settings

Type declaration

Optional_360?: { rotX?: number; rotY?: number; rotZ?: number; scale?: number; trueNorth?: number; video?: Video; }

OptionalrotX?: number

OptionalrotY?: number

OptionalrotZ?: number

Optionalscale?: number

OptionaltrueNorth?: number

Optionalvideo?: Video

Optional_markers?: MarkerSettings

Optional_meta?: { [key: string]: any; }

[key: string]: any

Optionalalbum?: AlbumInfo

OptionalalwaysShowMinimap?: boolean

Optionalaudio?: boolean

Optionalcamspeed?: number

OptionalclusterMarkerRadius?: number

OptionalclusterMarkers?: boolean

OptionalcmHeight?: number

OptionalcmWidth?: number

OptionalcontrolZoom?: boolean

OptionalcrossfadeDuration?: number

Optionalcss?: { href: string; }

href: string

OptionaldoTourJumps?: boolean

OptionaldragElasticity?: number

OptionalembedFadeDuration?: number

OptionalembedRestartWhenShown?: boolean

OptionalfadeBetween?: boolean

Optionalfocus?: [number, number]

OptionalforceDataRefresh?: boolean

OptionalfreeMove?: boolean

Optionalfullscreen?: boolean

Optionalgallery?: GallerySettings

OptionalgridClickable?: boolean

OptionalgridTransitionDuration?: number

OptionalgridTransitionDurationOut?: number

OptionalhookDrag?: boolean

OptionalhookEvents?: boolean

OptionalhookKeys?: boolean

OptionalhookPinch?: boolean

OptionalhookScroll?: boolean

OptionalinfoUrl?: string

OptionalinitType?: string

Optionaljs?: { href: string; }

href: string

OptionalkeepRendering?: boolean

Optionallazyload?: number

OptionallimitToCoverScale?: boolean

OptionalmarkersScale?: boolean

OptionalmicrioSplitLink?: string

Optionalminimap?: boolean

OptionalminimapHeight?: number

OptionalminimapWidth?: number

OptionalmutedVolume?: number

OptionalmuteOnBlur?: boolean

OptionalnoControls?: boolean

OptionalnoExternals?: boolean

OptionalnoFollow?: boolean

OptionalnoGTag?: boolean

OptionalnoLogo?: boolean

OptionalnoOrgLogo?: boolean

OptionalnoRetina?: boolean

OptionalnoSmoothing?: boolean

OptionalnoToolbar?: boolean

OptionalnoUI?: boolean

OptionalnoZoom?: boolean

Optionalomni?: OmniSettings

OptionalonlyPreferredLang?: boolean

OptionalpinchZoomOutLimit?: boolean

OptionalpostProcessingFragmentShader?: string

OptionalresetView?: boolean

Optionalrestrict?: View

OptionalrouterMarkerTours?: boolean

OptionalsecondaryInteractive?: boolean

OptionalshowInfo?: boolean

OptionalskipBaseLevels?: number

OptionalskipMeta?: boolean

Optionalsocial?: boolean

Optionalstart?: { id: string; type: | "marker" | "markerTour" | "tour" | "page"; }

`Optional`_360?: {
rotX?: number;
rotY?: number;
rotZ?: number;
scale?: number;
trueNorth?: number;
video?: Video;
}

`Optional`rotX?: number

`Optional`rotY?: number

`Optional`rotZ?: number

`Optional`scale?: number

`Optional`trueNorth?: number

`Optional`video?: Video

`Optional`_markers?: MarkerSettings

`Optional`_meta?: {
[key: string]: any;
}

`Optional`album?: AlbumInfo

`Optional`alwaysShowMinimap?: boolean

`Optional`audio?: boolean

`Optional`camspeed?: number

`Optional`clusterMarkerRadius?: number

`Optional`clusterMarkers?: boolean

`Optional`cmHeight?: number

`Optional`cmWidth?: number

`Optional`controlZoom?: boolean

`Optional`crossfadeDuration?: number

`Optional`css?: {
href: string;
}

`Optional`doTourJumps?: boolean

`Optional`dragElasticity?: number

`Optional`embedFadeDuration?: number

`Optional`embedRestartWhenShown?: boolean

`Optional`fadeBetween?: boolean

`Optional`focus?: [number, number]

`Optional`forceDataRefresh?: boolean

`Optional`freeMove?: boolean

`Optional`fullscreen?: boolean

`Optional`gallery?: GallerySettings

`Optional`gridClickable?: boolean

`Optional`gridTransitionDuration?: number

`Optional`gridTransitionDurationOut?: number

`Optional`hookDrag?: boolean

`Optional`hookEvents?: boolean

`Optional`hookKeys?: boolean

`Optional`hookPinch?: boolean

`Optional`hookScroll?: boolean

`Optional`infoUrl?: string

`Optional`initType?: string

`Optional`js?: {
href: string;
}

`Optional`keepRendering?: boolean

`Optional`lazyload?: number

`Optional`limitToCoverScale?: boolean

`Optional`markersScale?: boolean

`Optional`micrioSplitLink?: string

`Optional`minimap?: boolean

`Optional`minimapHeight?: number

`Optional`minimapWidth?: number

`Optional`mutedVolume?: number

`Optional`muteOnBlur?: boolean

`Optional`noControls?: boolean

`Optional`noExternals?: boolean

`Optional`noFollow?: boolean

`Optional`noGTag?: boolean

`Optional`noLogo?: boolean

`Optional`noOrgLogo?: boolean

`Optional`noRetina?: boolean

`Optional`noSmoothing?: boolean

`Optional`noToolbar?: boolean

`Optional`noUI?: boolean

`Optional`noZoom?: boolean

`Optional`omni?: OmniSettings

`Optional`onlyPreferredLang?: boolean

`Optional`pinchZoomOutLimit?: boolean

`Optional`postProcessingFragmentShader?: string

`Optional`resetView?: boolean

`Optional`restrict?: View

`Optional`routerMarkerTours?: boolean

`Optional`secondaryInteractive?: boolean

`Optional`showInfo?: boolean

`Optional`skipBaseLevels?: number

`Optional`skipMeta?: boolean

`Optional`social?: boolean

`Optional`start?: {
id: string;
type:
| "marker"
| "markerTour"
| "tour"
| "page";
}

type:
| "marker"
| "markerTour"
| "tour"
| "page"

`Optional`startVolume?: number

`Optional`static?: boolean

`Optional`theme?: "dark" | "light" | "os"

`Optional`thumbSrc?: string