OverviewViewportStateOptions

 
public struct OverviewViewportStateOptions : Equatable

Configuration options for OverviewViewportState.

  • The geometry that the OverviewViewportState should use when calculating its camera.

    Declaration

    Swift

    public var geometry: Geometry

  • The padding that OverviewViewportState should add to coordinates when calculating fitting camera.

    Note

    This is different from camera padding, see padding.

    Declaration

    Swift

    public var coordinatesPadding: UIEdgeInsets

  • The bearing that OverviewViewportState should use when calcualting its camera.

    Declaration

    Swift

    public var bearing: CLLocationDirection?

  • The pitch that OverviewViewportState should use when calculating its camera.

    Declaration

    Swift

    public var pitch: CGFloat?

  • Camera padding to set as camera options.

    Declaration

    Swift

    public var padding: UIEdgeInsets?

  • The maximum zoom level to allow.

    Declaration

    Swift

    public var maxZoom: Double?

  • The center of the given bounds relative to the map’s center, measured in points.

    Declaration

    Swift

    public var offset: CGPoint?

  • The length of the animation performed by OverviewViewportState when it starts updating the camera and any time options is set. See options for details.

    Declaration

    Swift

    public var animationDuration: TimeInterval

  • Memberwise initializer for OverviewViewportStateOptions.

    geometry is required, but all other parameters have default values.

    Declaration

    Swift

    public init(geometry: GeometryConvertible,
            coordinatesPadding: UIEdgeInsets = .zero,
            bearing: CLLocationDirection? = 0,
            pitch: CGFloat? = 0,
            padding: UIEdgeInsets? = nil,
            maxZoom: Double? = nil,
            offset: CGPoint? = nil,
            animationDuration: TimeInterval = 1)

    Parameters

    geometry

    The geometry for which an overview should be shown.
    coordinatesPadding

    The padding to add to coordinates when calculating fitting camera.
    bearing

    Camera bearing.
    pitch

    Camera pitch.
    padding

    Camera padding.
    maxZoom

    The maximum zoom level to allow.
    offset

    The center of the given bounds relative to the map’s center, measured in points.
    animationDuration

    Defaults to 1.