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

    Type Alias Marker

    A Marker

    type Marker = {
        audioAutoPlay?: boolean;
        backside?: boolean;
        clickableArea?: Embed;
        data?: MarkerData;
        embedAutoPlay?: boolean;
        embedMutesAudio?: boolean;
        htmlElement?: HTMLElement;
        i18n?: I18n<MarkerCultureData>;
        id: string;
        imageLayer?: number;
        images?: Models.Assets.Image[];
        noMarker?: boolean;
        onclick?: (m: Marker) => void;
        popupType?: "popup" | "popover" | "none" | "micrioLink";
        positionalAudio?: AudioLocation;
        radius?: number;
        rotation?: number;
        tags?: string[];
        type?:
            | "default"
            | "image"
            | "audio"
            | "video"
            | "media"
            | "link"
            | "waypoint"
            | "cluster";
        videoTour?: VideoTour;
        view?: View;
        visibleArc?: [number, number];
        x: number;
        y: number;
    }
    Index

    Properties

    audioAutoPlay? backside? clickableArea? data? embedAutoPlay? embedMutesAudio? htmlElement? i18n? id imageLayer? images? noMarker? onclick? popupType? positionalAudio? radius? rotation? tags? type? videoTour? view? visibleArc? x y

    Properties

    audioAutoPlay?: boolean

    Autoplay the audio asset when the marker is opened

    backside?: boolean

    Rotation is concave: it's on the back of a front-rounded shape

    clickableArea?: Embed

    If type is area, this HTML embed will be used for the marker

    data?: MarkerData

    Additional options

    embedAutoPlay?: boolean

    Autoplay video embed when the marker is opened

    embedMutesAudio?: boolean

    Having the embed iframe printed mutes audio

    htmlElement?: HTMLElement

    A custom HTML element instead of the default

    i18n?: I18n<MarkerCultureData>
    id: string

    The marker ID

    imageLayer?: number

    If an image has multiple layers, switch to this layer

    images?: Models.Assets.Image[]

    Images inside marker popup

    noMarker?: boolean

    Don't draw a marker element

    onclick?: (m: Marker) => void

    Optional function that overrides all behavior

    popupType?: "popup" | "popover" | "none" | "micrioLink"

    Popup type

    positionalAudio?: AudioLocation

    Positional audio asset

    radius?: number

    Omni-objects: radius from center

    rotation?: number

    Omni-objects: offset rotation in radians

    tags?: string[]

    Custom marker tags which will be also used as classnames on the marker elements

    type?:
        | "default"
        | "image"
        | "audio"
        | "video"
        | "media"
        | "link"
        | "waypoint"
        | "cluster"

    Content type, for displaying

    videoTour?: VideoTour

    Video tour which plays when the marker is opened

    view?: View

    The viewport to zoom to when the marker is opened

    visibleArc?: [number, number]

    Omni-objects: custom visibility between these radians

    x: number

    The relative marker X coordinate [0-1]

    y: number

    The relative marker Y coordinate [0-1]

    Settings

    Member Visibility

    On This Page

    Properties