Type alias AnimationOptions

AnimationOptions: {
    animate?: boolean;
    duration?: number;
    easing?: ((_) => number);
    essential?: boolean;
    freezeElevation?: boolean;
    offset?: PointLike;
}

Options common to map movement methods that involve animation, such as Map#panBy and Map#easeTo, controlling the duration and easing function of the animation. All properties are optional.

Type declaration

  • Optional animate?: boolean

    If false, no animation will occur.

  • Optional duration?: number

    The animation's duration, measured in milliseconds.

  • Optional easing?: ((_) => number)

    A function taking a time in the range 0..1 and returning a number where 0 is the initial state and 1 is the final state.

      • (_): number

      • Parameters

        • _: number

        Returns number

  • Optional essential?: boolean

    If true, then the animation is considered essential and will not be affected by prefers-reduced-motion.

  • Optional freezeElevation?: boolean

    Default false. Needed in 3D maps to let the camera stay in a constant height based on sea-level. After the animation finished the zoom-level will be recalculated in respect of the distance from the camera to the center-coordinate-altitude.

  • Optional offset?: PointLike

    of the target center relative to real map container center at the end of animation.

Settings

Member Visibility

Theme