Type alias Settings

Type declaration

• view: View

  The starting viewport ([x0,y0,x1,y1])

• Optional restrict?: View

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

• Optional focus?: number[]

  Load the image focussed on this coordinate ([x, y])

• Optional infoUrl?: string

  Use a custom uri for the info json file

• Optional static?: boolean

  Render this image as a static image

• Optional thumbSrc?: string

  Use a custom thumbnail image uri

• Optional initType?: string

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

• Optional limitToCoverScale?: boolean

  The user cannot zoom out more than a fully covered view

• Optional lazyload?: boolean

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

• Optional noExternals?: boolean

  Don't load any custom JS or CSS scripts

• Optional skipMeta?: boolean

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

• Optional onlyPreferredLang?: boolean

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

• Optional fadeBetween?: boolean

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

• Optional crossfadeDuration?: number

  Optional image crossfade duration, in seconds

• Optional keepRendering?: boolean

  Don't stop drawing frames when idle

• Optional noGTag?: boolean

  Don't load GTM module

• Optional camspeed?: number

  The camera animation speed (default: 1)

• Optional dragElasticity?: number

  Kinetic dragging sensitivity (default: 1)

• Optional zoomLimit?: number

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

• Optional noRetina?: boolean

  Turn off support for high DPI screens

• Optional zoomLimitDPRFix?: boolean

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

• Optional freeMove?: boolean

  Allow the user to pan and zoom out of image bounds

• Optional resetView?: boolean

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

• Optional hookEvents?: boolean

  Hook user events (default: true)

• Optional hookKeys?: boolean

  Hook keyboard controls (default: false)

• Optional noZoom?: boolean

  Don't allow the user to zoom in or out

• Optional hookScroll?: boolean

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

• Optional hookPinch?: boolean

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

• Optional hookDrag?: boolean

  Allow panning through the image (default: true)

• Optional twoFingerPan?: boolean

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

• Optional controlZoom?: boolean

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

• Optional pinchZoomOutLimit?: boolean

  Don't allow less than minimum scale zooming when pinching

• Optional noUI?: boolean

  Don't load any UI elements

• Optional noControls?: boolean

  Don't show any controls in the UI

• Optional fullscreen?: boolean

  Show a fullscreen button if supported

• Optional noLogo?: boolean

  Don't show the Micrio logo on the top left

• Optional noOrgLogo?: boolean

  Don't show the organisation logo on the top right

• Optional noToolbar?: boolean

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

• Optional showInfo?: boolean

  Show an info modal with the image title and description

• Optional social?: boolean

  Show a social sharing button

• Optional minimap?: boolean

  Show the minimap (default: true)

• Optional alwaysShowMinimap?: boolean

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

• Optional minimapWidth?: number

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

• Optional minimapHeight?: number

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

• Optional doTourJumps?: boolean

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

• Optional audio?: boolean

  Enable the audio controller (default: true)

• Optional startVolume?: number

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

• Optional musicVolume?: number

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

• Optional mutedVolume?: number

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

• Optional muteOnBlur?: boolean

  Mute the audio when the current browser tab loses focus

• Optional cmPerPx?: number

  The physical resolution of the object in cm per px

• Optional cmWidth?: number

  The physical width of the object in cm

• Optional cmHeight?: number

  The physical height of the object in cm

• Optional clusterMarkers?: boolean

  Overlapping markers are clustered

• Optional micrioSplitLink?: string

  A static split-screen Micrio Image ID

• Optional secondaryInteractive?: boolean

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

• Optional noFollow?: boolean

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

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

  Dark/light theme

• Optional js?: {
      href: string;
  }

  Load a custom JS file with this image

  • href: string

    The asset href

• Optional css?: {
      href: string;
  }

  Load a custom CSS file with this image

  • href: string

    The asset href

• Optional markersScale?: boolean

  All markers are scaled with the image

• Optional _markers?: MarkerSettings

  Optional marker settings

• Optional _360?: {
      closeTop?: boolean;
      video?: {
          video?: {
              width: number;
              height: number;
              fileUrl: string;
          };
          autoplay?: boolean;
          muted?: boolean;
          loop?: boolean;
          controls?: boolean;
      };
      orientation?: number;
  }

  Optional settings for 360 images/video

  • Optional closeTop?: boolean

    Vertically stretch the image to a full sphere if the image is not 2:1 ratio

  • Optional video?: {
        video?: {
            width: number;
            height: number;
            fileUrl: string;
        };
        autoplay?: boolean;
        muted?: boolean;
        loop?: boolean;
        controls?: boolean;
    }

    A 360 video object

    • Optional video?: {
          width: number;
          height: number;
          fileUrl: string;
      }

      Optional video asset object

      • width: number

      • height: number

      • fileUrl: string

        The video asset url

    • Optional autoplay?: boolean

      Try to autoplay the video

    • Optional muted?: boolean

      The video is muted

    • Optional loop?: boolean

      Loop the video

    • Optional controls?: boolean

      Show video player controls

  • Optional orientation?: number

    The Y-orientation in degrees of how the picture was taken

• Optional _meta?: {
      scripts?: string[];
      styles?: string[];
  }

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

  • Optional scripts?: string[]

    An array of JavaScript uris to load for this Micrio instance

  • Optional styles?: string[]

    An array of CSS uris to load for this Micrio instance

• Optional ui?: Partial<UserInterfaceSettings>

  UI customizations

• Optional gridClickable?: boolean

  Grid: can click individual grid images

• Optional gridTransitionDuration?: number

  Grid: transition duration, in seconds

• Optional gridTransitionDurationOut?: number

  Grid: transition duration going back, in seconds