TomTom Maps for JavaScript
    Preparing search index...

    Type Alias RouteFlyoverOptions

    type RouteFlyoverOptions = {
        camera?: Partial<FlyoverCamera>;
        loop?: boolean;
        marker?: FlyoverMarkerConfig;
        onArrive?: () => void;
        onProgress?: (progress: FlyoverProgress) => void;
        route: Route;
    }
    Index
    camera? loop? marker? onArrive? onProgress? route
    camera?: Partial<FlyoverCamera>

    Overrides for the camera. Anything you leave out takes the default on FlyoverCamera.

    loop?: boolean

    Whether the flight wraps at the destination and flies on from the departure. Without the loop, it stops at the destination and calls onArrive, and a RouteFlyover.start from there flies the route again from its departure.

    true
    marker?: FlyoverMarkerConfig

    The marker riding the route at the followed position, by default an arrow.

    onArrive?: () => void

    Called when a flight that doesn't loop reaches the destination and stops there.

    onProgress?: (progress: FlyoverProgress) => void

    Called with the flight's progress, once per survey rather than once per frame.

    route: Route

    The route to fly. Replace it later with RouteFlyover.setRoute.

    Settings
    Member Visibility

    On This Page
    Properties