Type alias Marker

Marker: {
    id: string;
    x: number;
    y: number;
    view?: View;
    title?: string;
    label?: string;
    slug?: string;
    body?: string;
    markdown?: string;
    html?: string;
    bodySecondary?: string;
    markdownSecondary?: string;
    type?: "image" | "audio" | "video" | "media" | "link" | "waypoint";
    class?: string;
    audio?: Audio;
    audioAutoPlay?: boolean;
    noMarker?: boolean;
    htmlElement?: HTMLElement;
    embedImages?: Embed[];
    embedUrl?: string;
    embedDescription?: string;
    embedInPopover?: boolean;
    embedMutesAudio?: boolean;
    embedInEmbed?: boolean;
    embedInEmbedImmediate?: boolean;
    images?: Models.Assets.Image[];
    videoTour?: VideoTour;
    action?: number;
    actionKey?: string;
    actionValue?: string;
    data?: MarkerData;
}

A Marker

Type declaration

  • id: string

    The marker ID

  • x: number

    The relative marker X coordinate [0-1]

  • y: number

    The relative marker Y coordinate [0-1]

  • Optional view?: View

    The viewport to zoom to when the marker is opened

  • Optional title?: string

    The main marker title

  • Optional label?: string

    Alternative title to display as marker label

  • Optional slug?: string

    The marker url slug

  • Optional body?: string

    Marker main body HTML

  • Optional markdown?: string

    Marker main body raw text

  • Optional html?: string

    Marker markdown markdown rendered body (autogenerated)

  • Optional bodySecondary?: string

    Marker secondary body HTML

  • Optional markdownSecondary?: string

    Marker secondary body raw text

  • Optional type?: "image" | "audio" | "video" | "media" | "link" | "waypoint"

    Content type

  • Optional class?: string

    Marker classnames

  • Optional audio?: Audio

    Audio asset

  • Optional audioAutoPlay?: boolean

    Autoplay the audio asset when the marker is opened

  • Optional noMarker?: boolean

    Don't draw a marker element

  • Optional htmlElement?: HTMLElement

    A custom HTML element instead of the default

  • Optional embedImages?: Embed[]

    Embedded images into main image

  • Optional embedUrl?: string

    An optional iframe embed url

  • Optional embedDescription?: string

    Embed description

  • Optional embedInPopover?: boolean

    Open the iframe embed in a full-window popover overlay

  • Optional embedMutesAudio?: boolean

    Having the embed iframe printed mutes audio

  • Optional embedInEmbed?: boolean

    Put the iframe embed as the first image embed

  • Optional embedInEmbedImmediate?: boolean

    Put the iframe embed into the image embed on image load

  • Optional images?: Models.Assets.Image[]

    Images inside marker popup

  • Optional videoTour?: VideoTour

    Video tour which plays when the marker is opened

  • Optional action?: number

    [Spaces] Click action for spaces

  • Optional actionKey?: string

    [Spaces] Click action key

  • Optional actionValue?: string

    [Spaces] Value for action

  • Optional data?: MarkerData

    Additional options

Settings

Member Visibility

Theme

Generated using TypeDoc