This is the documentation of version 1.0.0-rc.1. Go to the latest version, 1.0.0-rc.5.

Type Alias RouteFlyoverOptions

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

Index

Properties

camera? marker? onProgress? route

Properties

`Optional`camera

camera?: Partial<FlyoverCamera>

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

`Optional`marker

marker?: FlyoverMarkerConfig

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

`Optional`onProgress

onProgress?: (progress: FlyoverProgress) => void

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

route

route: Route

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