Type Alias Marker

Marker: {
    audioAutoPlay?: boolean;
    backside?: boolean;
    data?: MarkerData;
    embedAutoPlay?: boolean;
    embedMutesAudio?: boolean;
    htmlElement?: HTMLElement;
    i18n?: {
        [key: string]: 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;
}

A Marker

Type declaration

  • OptionalaudioAutoPlay?: boolean

    Autoplay the audio asset when the marker is opened

  • Optionalbackside?: boolean

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

  • Optionaldata?: MarkerData

    Additional options

  • OptionalembedAutoPlay?: boolean

    Autoplay video embed when the marker is opened

  • OptionalembedMutesAudio?: boolean

    Having the embed iframe printed mutes audio

  • OptionalhtmlElement?: HTMLElement

    A custom HTML element instead of the default

  • Optionali18n?: {
        [key: string]: MarkerCultureData;
    }
  • id: string

    The marker ID

  • OptionalimageLayer?: number

    If an image has multiple layers, switch to this layer

  • Optionalimages?: Models.Assets.Image[]

    Images inside marker popup

  • OptionalnoMarker?: boolean

    Don't draw a marker element

  • Optionalonclick?: ((m: Marker) => void)

    Optional function that overrides all behavior

      • (m): void

      • Parameters

        Returns void

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

    Popup type

  • OptionalpositionalAudio?: AudioLocation

    Positional audio asset

  • Optionalradius?: number

    Omni-objects: radius from center

  • Optionalrotation?: number

    Omni-objects: offset rotation in radians

  • tags: string[]

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

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

    Content type, for displaying

  • OptionalvideoTour?: VideoTour

    Video tour which plays when the marker is opened

  • Optionalview?: View

    The viewport to zoom to when the marker is opened

  • OptionalvisibleArc?: [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