Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapNavigatorRotateOptions

The options for a rotate operation.

Hierarchy

  • MapNavigatorRotateOptions

Overview

Properties

Optional animate

animate: MapNavigatorAnimationOptions | boolean

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.

Optional center

center: Point

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

Optional deltaPitch

deltaPitch: number

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.

Optional deltaRotation

deltaRotation: number

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.

Optional deltaYaw

deltaYaw: number

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.

Optional targetPitch

targetPitch: number

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.

Optional targetRotation

targetRotation: number

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.

Optional targetYaw

targetYaw: number

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.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method