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

    Interface MicrioCustomAttributes

    interface MicrioCustomAttributes {
        "data-camspeed"?: number;
        "data-control-zoom"?: boolean;
        "data-controls"?: boolean;
        "data-coverlimit"?: boolean;
        "data-dragging"?: boolean;
        "data-events"?: boolean;
        "data-focus"?: number[];
        "data-freemove"?: boolean;
        "data-fullscreen"?: boolean;
        "data-grid"?: string;
        "data-gtag"?: boolean;
        "data-inittype"?: string;
        "data-keeprendering"?: boolean;
        "data-keys"?: boolean;
        "data-limited"?: boolean;
        "data-logo"?: boolean;
        "data-logo-org"?: boolean;
        "data-minimap"?: boolean;
        "data-minimap-height"?: number;
        "data-minimap-hide"?: boolean;
        "data-minimap-width"?: number;
        "data-mutedvolume"?: number;
        "data-normalize-dpr"?: boolean;
        "data-path"?: string;
        "data-pinch-zoom"?: boolean;
        "data-router"?: string;
        "data-scroll-zoom"?: boolean;
        "data-show-info"?: boolean;
        "data-skipmeta"?: boolean;
        "data-social"?: boolean;
        "data-static"?: boolean;
        "data-toolbar"?: boolean;
        "data-two-finger-pan"?: boolean;
        "data-ui"?: boolean;
        "data-view"?: number[];
        "data-zooming"?: boolean;
        "data-zoomlimit"?: number;
        id?: string;
        lang?: string;
        lazyload?: boolean;
        muted?: boolean;
        volume?: number;
    }
    Index

    Properties

    "data-camspeed"?: number

    Set the speed factor for camera animations. Default: 1

    "data-control-zoom"?: boolean

    The user must press CTRL/CMD when zooming with the mousewheel. Default: false

    "data-controls"?: boolean

    No control buttons will be printed. Default: true

    "data-coverlimit"?: boolean

    The user cannot zoom out further than the full viewport. Default: undefined

    "data-dragging"?: boolean

    Use dragging and touch events for panning. Default: true

    "data-events"?: boolean

    No event handlers will be set up, and the image will be non-interactive. Default: true

    "data-focus"?: number[]

    Set focus point of the image, treated as the center in case of image overflows. Default: [0.5, 0.5]

    "data-freemove"?: boolean

    Can pan outside the image's limits. Default: false

    "data-fullscreen"?: boolean

    Show a fullscreen switching button on supported platforms. Default: true

    "data-grid"?: string

    Configuration for the grid which the viewer will use.

    "data-gtag"?: boolean

    Sending user input as GA Events to any available GTag instance (does nothing if none). Default: true

    "data-inittype"?: string

    Set this to 'cover' to start the image using the full viewport. Default: undefined

    "data-keeprendering"?: boolean

    Keep drawing frames, even if there is no movement. Default: false

    "data-keys"?: boolean

    Use your keyboard to navigate through the image. Default: false

    "data-limited"?: boolean

    Toggle limited rendering mode in WebAssembly.

    "data-logo"?: boolean

    The Micrio logo is displayed. Default: true

    "data-logo-org"?: boolean

    The optional Organisation logo (top right) will be hidden. Default: true

    "data-minimap"?: boolean

    An interactive minimap will be shown. Default: false

    "data-minimap-height"?: number

    The minimap height in pixels. Default: 160

    "data-minimap-hide"?: boolean

    The minimap will always be visible. Default: true

    "data-minimap-width"?: number

    The minimap width in pixels. Default: 200

    "data-mutedvolume"?: number

    Fade music to this volume while other audio plays (between 0 and 1). Default: 0

    "data-normalize-dpr"?: boolean

    When turned off, high DPI screens will have its zoom limited to visually 100% of pixel size. Default: true

    "data-path"?: string

    For custom hosted Micrio images, specify the root URL. Default: Based on image

    "data-pinch-zoom"?: boolean

    Use trackpad/touchscreen pinching for zooming. Default: true

    "data-router"?: string

    Read and write deeplinks to opened tours and markers. Default: null

    "data-scroll-zoom"?: boolean

    Use mousewheel/trackpad scrolling for zooming. Default: true

    "data-show-info"?: boolean

    Show an image info panel with the title and description. Default: false

    "data-skipmeta"?: boolean

    Do not load any metadata (markers, tours, etc). Default: false

    "data-social"?: boolean

    Show a social sharing link menu. Default: false

    "data-static"?: boolean

    Simulate an element. No logo, loader bar, and no event listeners. Default: false

    "data-toolbar"?: boolean

    No top menu bar will be printed. Default: true

    "data-two-finger-pan"?: boolean

    Requires the user to use two fingers to pan the image on touch devices. Default: false

    "data-ui"?: boolean

    No HTML UI elements will be printed. Default: true

    "data-view"?: number[]

    Set the initial viewport rectangle of the image. Default: [0,0,1,1]

    "data-zooming"?: boolean

    The user cannot zoom at all. Default: true

    "data-zoomlimit"?: number

    Set the percentage (1=100%) of how far a user can zoom in. Default: 1

    id?: string

    The image ID

    lang?: string

    The data language code to use. Default: 'en'

    lazyload?: boolean

    Only start loading the image when it's been scrolled into the user's view. Default: false

    muted?: boolean

    All audio will be disabled if this attribute is present.

    volume?: number

    The general sound volume for music/sfx (between 0 and 1). Default: 1