Micrio Client - v6.0.0
    Preparing search index...

    Type Alias Settings

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

    type 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;
        watermarkOpacity?: number;
        zoomLimit?: number;
        zoomLimitDPRFix?: boolean;
    }
    Index

    Properties

    _360? _markers? _meta? album? alwaysShowMinimap? audio? camspeed? clusterMarkerRadius? clusterMarkers? cmHeight? cmWidth? controlZoom? crossfadeDuration? css? doTourJumps? dragElasticity? embedFadeDuration? embedRestartWhenShown? fadeBetween? focus? forceDataRefresh? freeMove? fullscreen? gallery? gridClickable? gridTransitionDuration? gridTransitionDurationOut? hookDrag? hookEvents? hookKeys? hookPinch? hookScroll? infoUrl? initType? js? keepRendering? lazyload? limitToCoverScale? markersScale? micrioSplitLink? minimap? minimapHeight? minimapWidth? mutedVolume? muteOnBlur? noControls? noExternals? noFollow? noGTag? noLogo? noOrgLogo? noRetina? noSmoothing? noToolbar? noUI? noZoom? omni? onlyPreferredLang? pinchZoomOutLimit? postProcessingFragmentShader? resetView? restrict? routerMarkerTours? secondaryInteractive? showInfo? skipBaseLevels? skipMeta? social? start? startVolume? static? theme? thumbSrc? twoFingerPan? ui? view? watermarkOpacity? zoomLimit? zoomLimitDPRFix?

    Properties

    Optional_360

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

    Optional settings for 360 images/video

    Type Declaration

    • 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

      Use Spaces.SpaceImage.rotationY (radians). Normalized [0,1] image-X offset, 0.5 = identity. Still honoured for back-compat.

    • Optionalvideo?: Video

      A 360 video object

    Optional_markers

    _markers?: MarkerSettings

    Optional marker settings

    Optional_meta

    _meta?: { [key: string]: any }

    Freeform custom settings, this is the "Custom JSON" field in the image editor

    album?: AlbumInfo
    alwaysShowMinimap?: boolean

    Don't fade out the minimap (default: false)

    audio?: boolean

    Enable the audio controller (default: true)

    camspeed?: number

    The camera animation speed (default: 1)

    clusterMarkerRadius?: number

    The clustered marker radius

    clusterMarkers?: boolean

    Overlapping markers are clustered

    cmHeight?: number

    The physical height of the object in cm

    cmWidth?: number

    The physical width of the object in cm

    controlZoom?: boolean

    Force using the CTRL/CMD-keys to zoom in using scrolling (default: false)

    crossfadeDuration?: number

    Optional image crossfade duration, in seconds

    css?: { href: string }

    Load a custom CSS file with this image

    Type Declaration

    • href: string

      The asset href

    doTourJumps?: boolean

    More natural camera zooming animation during transitions (default: true)

    dragElasticity?: number

    Kinetic dragging sensitivity (default: 1)

    embedFadeDuration?: number

    Embedded images/videos fade in/out duration, in seconds

    embedRestartWhenShown?: boolean

    When being re-shown, always restart

    fadeBetween?: boolean

    Do a crossfade when navigating between images (default: true)

    focus?: [number, number]

    Load a cover-initing image focussed on this coordinate ([x, y])

    forceDataRefresh?: boolean

    Force refresh for published data JSON file

    freeMove?: boolean

    Allow the user to pan and zoom out of image bounds

    fullscreen?: boolean

    Show a fullscreen button if supported

    gallery?: GallerySettings

    Albums

    gridClickable?: boolean

    Grid: can click individual grid images

    gridTransitionDuration?: number

    Grid: transition duration, in seconds

    gridTransitionDurationOut?: number

    Grid: transition duration going back, in seconds

    hookDrag?: boolean

    Allow panning through the image (default: true)

    hookEvents?: boolean

    Hook user events (default: true)

    hookKeys?: boolean

    Hook keyboard controls (default: false)

    hookPinch?: boolean

    Allow pinch to zoom on touch devices (default: true)

    hookScroll?: boolean

    Use the mousewheel or trackpad scrolling for zooming (default: true)

    infoUrl?: string

    Use a custom uri for the info json file

    initType?: string

    The starting viewport. Possible values cover and contain. Defaults to contain

    js?: { href: string }

    Load a custom JS file with this image

    Type Declaration

    • href: string

      The asset href

    keepRendering?: boolean

    Don't stop drawing frames when idle

    lazyload?: number

    Initialize the image when the container is scrolled into view (default: false)

    limitToCoverScale?: boolean

    The user cannot zoom out more than a fully covered view

    markersScale?: boolean

    All markers are scaled with the image

    micrioSplitLink?: string

    A static split-screen Micrio Image ID

    minimap?: boolean

    Show the minimap (default: true)

    minimapHeight?: number

    The minimap maximum height, in px (default: 160)

    minimapWidth?: number

    The minimap maximum width, in px (default: 200)

    mutedVolume?: number

    The audio volume when other media is playing [0-1] (default: 0)

    muteOnBlur?: boolean

    Mute the audio when the current browser tab loses focus

    noControls?: boolean

    Don't show any controls in the UI

    noExternals?: boolean

    Don't load any custom JS or CSS scripts

    noFollow?: boolean

    When this is a secondary image, don't follow the main image's navigation

    noGTag?: boolean

    Don't load GTM module

    noLogo?: boolean

    Don't show the Micrio logo on the top left

    noOrgLogo?: boolean

    Don't show the organisation logo on the top right

    noRetina?: boolean

    Turn off support for high DPI screens

    noSmoothing?: boolean

    Don't smooth out pixels when zooming in > 100%

    noToolbar?: boolean

    Don't show the menu bar with tours and custom pages

    noUI?: boolean

    Don't load any UI elements

    noZoom?: boolean

    Don't allow the user to zoom in or out

    omni?: OmniSettings

    FOR OMNI OBJECTS

    onlyPreferredLang?: boolean

    Don't auto-load first available non-preferred data language

    pinchZoomOutLimit?: boolean

    Don't allow less than minimum scale zooming when pinching

    postProcessingFragmentShader?: 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

    resetView?: boolean

    When navigating back to this image from another image, reset the initial view

    restrict?: View

    Restrict navigation to this viewport ([x0,y0,x1,y1])

    routerMarkerTours?: boolean

    With routing enabled, enable marker/tour deeplinks

    secondaryInteractive?: boolean

    When this is a secondary image in split screen, allow independent navigating

    showInfo?: boolean

    Show an info modal with the image title and description

    skipBaseLevels?: number

    Skip the deepest zoom levels

    skipMeta?: boolean

    Don't load this image's ImageData.ImageData (markers, tours, etc)

    social?: boolean

    Show a social sharing button

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

    When opening the image without a predefined deeplink, open this

    startVolume?: number

    The starting audio volume [0-1] (default: 1)

    static?: boolean

    Render this image as a static image

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

    Dark/light theme

    thumbSrc?: string

    Use a custom thumbnail image uri

    twoFingerPan?: boolean

    Force two-finger panning on touch devices (default: false)

    ui?: Partial<UserInterfaceSettings>

    UI customizations

    view?: View

    The starting viewport

    watermarkOpacity?: number

    Watermark opacity, defaults to 0.075

    zoomLimit?: number

    The maximum zoom level in % of the original (default: 1)

    zoomLimitDPRFix?: boolean

    Adjust the maximum zoom of high DPI screens to that of regular displays

    Settings

    Member Visibility

    On This Page

    Properties
    _360_markers_metaalbumalwaysShowMinimapaudiocamspeedclusterMarkerRadiusclusterMarkerscmHeightcmWidthcontrolZoomcrossfadeDurationcssdoTourJumpsdragElasticityembedFadeDurationembedRestartWhenShownfadeBetweenfocusforceDataRefreshfreeMovefullscreengallerygridClickablegridTransitionDurationgridTransitionDurationOuthookDraghookEventshookKeyshookPinchhookScrollinfoUrlinitTypejskeepRenderinglazyloadlimitToCoverScalemarkersScalemicrioSplitLinkminimapminimapHeightminimapWidthmutedVolumemuteOnBlurnoControlsnoExternalsnoFollownoGTagnoLogonoOrgLogonoRetinanoSmoothingnoToolbarnoUInoZoomomnionlyPreferredLangpinchZoomOutLimitpostProcessingFragmentShaderresetViewrestrictrouterMarkerTourssecondaryInteractiveshowInfoskipBaseLevelsskipMetasocialstartstartVolumestaticthemethumbSrctwoFingerPanuiviewwatermarkOpacityzoomLimitzoomLimitDPRFix