OrnamentOptions

public struct OrnamentOptions : Equatable

Used to configure Ornament-specific capabilities of the map

All margin values are relative to the MapView‘s safe area. To allow the safe area (and thereby ornaments) to track the presence of navigation bars and tab bars, make MapView the root view of a view controller.

Scale Bar

scaleBar
The ornament options for the map’s scale bar.
Declaration
Swift

public var scaleBar: ScaleBarViewOptions

Compass

compass
The ornament options for the map’s compass view.
Declaration
Swift

public var compass: CompassViewOptions

Logo View

logo
The ornament options for the map’s logo view.

Per our terms of service, a Mapbox map is required to display both a Mapbox logo as well as an information icon that contains attribution information. See https://docs.mapbox.com/help/how-mapbox-works/attribution/ for details.
Declaration
Swift

public var logo: LogoViewOptions

Attribution Button

attributionButton
The ornament options for the map’s attribution button.
Declaration
Swift

public var attributionButton: AttributionButtonOptions


                    
                    
                    init(scaleBar:compass:logo:attributionButton:)

Initializes an OrnamentOptions.

Declaration

Swift

public init(
    scaleBar: ScaleBarViewOptions = .init(),
    compass: CompassViewOptions = .init(),
    logo: LogoViewOptions = .init(),
    attributionButton: AttributionButtonOptions = .init()
)

Parameters

`scaleBar`	The ornament options for the map’s scale bar.
`compass`	The ornament options for the map’s compass view.
`logo`	The ornament options for the map’s logo view.
`attributionButton`	The ornament options for the map’s attribution button.