FlyToOptions
FlyToOptions =
AnimationOptions&CameraOptions&object
Defined in: ui/camera.ts:127
The Map.flyTo options object
Type Declaration
curve?
optionalcurve?:number
The zooming "curve" that will occur along the
flight path. A high value maximizes zooming for an exaggerated animation, while a low
value minimizes zooming for an effect closer to Map.easeTo. 1.42 is the average
value selected by participants in the user study discussed in
van Wijk (2003). A value of
Math.pow(6, 0.25) would be equivalent to the root mean squared average velocity. A
value of 1 would produce a circular motion.
Default Value
maxDuration?
optionalmaxDuration?:number
The animation's maximum duration, measured in milliseconds. If duration exceeds maximum duration, it resets to 0.
minZoom?
optionalminZoom?:number
The minimum zoom level that the flight arc may reach. The animation will
not zoom out beyond this level. If the natural flight arc stays within
this boundary, the arc is unchanged. This acts as a ceiling on zoom-out
even when options.curve is also specified.
padding?
optionalpadding?:number|PaddingOptions
The amount of padding in pixels to add to the given bounds.
screenSpeed?
optionalscreenSpeed?:number
The average speed of the animation measured in screenfulls
per second, assuming a linear timing curve. If options.speed is specified, this option is ignored.
speed?
optionalspeed?:number
The average speed of the animation defined in relation to
options.curve. A speed of 1.2 means that the map appears to move along the flight path
by 1.2 times options.curve screenfulls every second. A screenfull is the map's visible span.
It does not correspond to a fixed physical distance, but varies by zoom level.