Type alias MarkerTour

MarkerTour: Tour & {
    currentStep?: number;
    duration?: number;
    goto?: ((n) => void);
    image?: Models.Assets.Image;
    initialStep?: number;
    isSerialTour?: boolean;
    keepLastStep?: boolean;
    next?: (() => void);
    noControls?: boolean;
    prev?: (() => void);
    printChapters?: boolean;
    scrollable?: boolean;
    stepInfo?: MarkerTourStepInfo[];
    steps: string[];
}

A Micrio marker tour -- a sequence of markers, which the user can navigate through. This is created in the Micrio editor.

Type declaration

  • Optional currentStep?: number

    Current tour step getter

  • Optional duration?: number

    Internally calculated total duration, sum of all step durations

  • Optional goto?: ((n) => void)

    Go to step -- for running tours

      • (n): void

      • Parameters

        • n: number

        Returns void

  • Optional image?: Models.Assets.Image

    Optional tour image asset

  • Optional initialStep?: number

    Start on this tour step

  • Optional isSerialTour?: boolean

    Chapter-based multi-video serial tour

  • Optional keepLastStep?: boolean

    Don't reset view when tour ends

  • Optional next?: (() => void)

    Go to next step -- for running tours

      • (): void

      • Returns void

  • Optional noControls?: boolean

    No user controls

  • Optional prev?: (() => void)

    Go to prev step -- for running tours

      • (): void

      • Returns void

  • Optional printChapters?: boolean

    Print the chapters in the interface

  • Optional scrollable?: boolean

    This is a scrolling tour

  • Optional stepInfo?: MarkerTourStepInfo[]

    Internally generated propagated step data by Micrio

  • steps: string[]

    Tour steps

Settings

Member Visibility

Theme