CameraOptions

public struct CameraOptions : Equatable

Camera options type.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Creates a new instance with some optional parameters.

    Declaration

    Swift

    public init(
    position: CLLocationCoordinate2D? = nil,
    zoom: Double? = nil,
    tilt: Double? = nil,
    rotation: Double? = nil,
    positionMarkerVerticalOffset: Double? = nil
)

    Parameters

    position

    Position of the camera in CLLocationCoordinate2D.
    zoom

    Displays the map from a closer position. Allowed zoom level range: [0, 22].
    tilt

    Camera tilt. A value of 0 indicates the camera is looking straight down. 90 means it is looking straight ahead towards the horizon.
    rotation

    Camera heading, measured starting at due north and continuing clockwise around the compass. Thus, north is 0 degrees, east is 90 degrees, south is 180 degrees, and so on. Allowed range: [0, 360].
    positionMarkerVerticalOffset

    Sets the camera position marker vertical offset from the centre of the screen. The offset controls the placement of the position marker in the space between the center of the safe area and its bottom. Offset of 0.0 means the position marker should remain in the center of the safe area. Offset of 1.0 means the position marker should be aligned with the bottom of the safe area. The value may be ignored when the camera’s scale is such that offsetting the map causes the world to rotate oddly. Valid range for the offset is [0.0, 1.0].

  • Creates a new instance with FitToCoordinatesOptions.

    Declaration

    Swift

    public init(fitToCoordinatesOptions: FitToCoordinatesOptions)

    Parameters

    fitToCoordinatesOptions

    FitToCoordinatesOptions instance.

Public

  • Camera options builder.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public enum Builder

  • Position of the camera in CLLocationCoordinate2D.

    Declaration

    Swift

    @EquatableWrapper
public var position: CLLocationCoordinate2D? { get set }

  • Displays the map from a closer position. Allowed zoom level range: [0, 22].

    Declaration

    Swift

    public var zoom: Double?

  • A value of 0 indicates the camera is looking straight down. 90 means it is looking straight ahead towards the horizon.

    Declaration

    Swift

    public var tilt: Double?

  • Camera heading, measured starting at due north and continuing clockwise around the compass. Allowed range: [0, 360].

    Declaration

    Swift

    public var rotation: Double?

  • Sets the camera position marker vertical offset from the centre of the screen.

    Declaration

    Swift

    public var positionMarkerVerticalOffset: Double?

  • Displays camera option values.

    Declaration

    Swift

    public var debugDescription: String { get }