UserLocationViewStyle

public struct UserLocationViewStyle

A struct containing information about the default User Location annotation view style.

  • A struct containing information about the user location view style when the user is outside the current active level.

    See more

    Declaration

    Swift

    public struct OutOfActiveLevelStyle
  • The foreground image of the user location view. Default is nil

    Declaration

    Swift

    public let foregroundImage: UIImage?
  • The background image of the user location view. Default is nil

    Declaration

    Swift

    public let backgroundImage: UIImage?
  • The heading image of the user location view. Default is nil

    Declaration

    Swift

    public let headingImage: UIImage?
  • The tint color for the foreground image of the user location view. Default is nil

    Tint color will be applied to the image only if image.renderingMode == .alwaysTemplate. If you don’t use custom images, tint color will be applied to the default layer.

    Declaration

    Swift

    public let foregroundTintColor: UIColor?
  • The tint color for the background image of the user location view. Default is nil

    Tint color will be applied to the image only if image.renderingMode == .alwaysTemplate. If you don’t use custom images, tint color will be applied to the default layer.

    Declaration

    Swift

    public let backgroundTintColor: UIColor?
  • The tint color for the heading image of the user location view. Default is nil

    Tint color will be applied to the image only if image.renderingMode == .alwaysTemplate. If you don’t use custom images, tint color will be applied to the default layer.

    Declaration

    Swift

    public let headingTintColor: UIColor?
  • The style containing information about the user location view when the user is outside the current active level.

    Declaration

    Swift

    public let outOfActiveLevelStyle: OutOfActiveLevelStyle
  • Initializes and returns a newly allocated User Location annotation view style with the specified parameters.

    Declaration

    Swift

    public init(
        foregroundImage: UIImage? = nil,
        backgroundImage: UIImage? = nil,
        headingImage: UIImage? = nil,
        foregroundTintColor: UIColor? = nil,
        backgroundTintColor: UIColor? = nil,
        headingTintColor: UIColor? = nil,
        outOfActiveLevelStyle: OutOfActiveLevelStyle = .init()
    )

    Parameters

    foregroundImage

    The foreground image of the user location view. Default is nil

    backgroundImage

    The background image of the user location view. Default is nil

    headingImage

    The heading image of the user location view. Default is nil

    foregroundTintColor

    The tint color for the foreground image of the user location view. Default is nil

    backgroundTintColor

    The tint color for the background image of the user location view. Default is nil

    headingTintColor

    The tint color for the heading image of the user location view. Default is nil

    outOfActiveLevelStyle

    The style containing information about the user location view when the user is outside the current active level