Interface MapNavigatorRotateOptions

When falsy, the rotate operation will be immediate. When truthy, the rotate operation will be animated.

The default value is false.

Regardless of the value of 'animate', you have to wait for the returned Promise to resolve to ensure that the map has navigated to the target position. To alter the animation, you can assign an MapNavigatorAnimationOptions to this option.

Rotation will happen around this Point. Can be in a model, map or view reference. When omitted, defaults the map's view center.

The value to add the current camera pitch (3D only). Pitch is defined as the camera's "tilt" angle. A value of 0 points the camera towards the horizon (i.e. horizontally); -90 points straight down towards the ground and +90 points straight up. After the rotate operation finishes, the camera's pitch will equal its value from before the operation plus the value of deltaPitch. Defaults to 0.

The value to add to the current camera rotation (2D only). The rotation of the 2D camera is measured in degrees (positive is clockwise). A value of 0 means the map is not rotated ('up' in the map's reference is also 'up' on the screen). After the rotate operation finishes, the camera's rotation will equal its value before the operation. plus the value of deltaRotation. Defaults to 0.

The value to add to the current camera yaw (3D only). Yaw is defined as the orientation (or "heading") of the map's camera in the ground plane. A value of 0 points the camera towards the North pole; the angle increases in clockwise direction. After the rotate operation finishes, the camera yaw will equal its value before from before the operation, plus the value of deltaYaw. Defaults to 0.

The target pitch for the rotate operation (3D only). Pitch is defined as the camera's "tilt" angle. A value of 0 points the camera towards the horizon (i.e. horizontally); -90 points straight down towards the ground and +90 points straight up. After the rotate operation finishes, the camera pitch will equal this value. Defaults to the current pitch value of the map's camera.

The target angle of the camera rotation (2D only). The rotation of the 2D camera is measured in degrees (positive is clockwise). A value of 0 means the map is not rotated ('up' in the map's reference is also 'up' on the screen). After the rotate operation finishes, the map's rotation will equal this value.

The target yaw for the rotate operation (3D only). Yaw is defined as the orientation (or "heading") of the map's camera in the ground plane. A value of 0 points the camera towards the North pole; the angle increases in clockwise direction. After the rotate operation finishes, the camera yaw will equal this value. Defaults to the current yaw of the map's camera.