BetterRouteStyle

public struct BetterRouteStyle

Represents the style used to display the better route.

Important

This is a Public Preview API. It may be changed or removed at any time.
  • Default values for a better route style.

    Important

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

    Declaration

    Swift

    public enum Defaults
  • Initializes BetterRouteStyle with values from Defaults

    Declaration

    Swift

    public init()
  • Initializes BetterRouteStyle with the given values.

    Throws

    StyleConfigurationError/invalidArgument if:

    • lineWidth is an empty list, has duplicates or has values not greater than 0.

    • outlineWidth is an empty list, has duplicates or has values not greater than 0.

    Declaration

    Swift

    public init(
        lineWidth: [WidthScene] = Defaults.lineWidth,
        outlineWidth: [WidthScene] = Defaults.outlineWidth,
        lineColor: UIColor = Defaults.lineColor,
        markerStyle: MarkerStyle = MarkerStyle(),
        isMarkerVisible: Bool = Defaults.isMarkerVisible
    ) throws

    Parameters

    lineWidth

    The width (in point units) per scene for a better route tube. By default, lineWidth is used. This parameter must be a non-empty list containing non-negative values for both the width and the scene. Items in this list must not contain duplicated values.

    outlineWidth

    The width (in point units) of the line’s outline per scene for better route tube. By default, outlineWidth is used. This parameter must be a non-empty list containing non-negative values for both the width and the scene. Items in this list must not contain duplicated values.

    lineColor

    The color of the better route tube. By default, lineColor is used. You can control the route line’s opacity by using the alpha component of the UIColor.

    markerStyle

    The better route marker style. By default, init(pinImage:textFontURI:textSize:textColor:textAnchoring:textOffset:) with default values is used.

    isMarkerVisible

    Determines if the better route marker is visible. By default, isMarkerVisible is used.

  • The default value of the better route marker visibility.

    Declaration

    Swift

    public let isMarkerVisible: Bool
  • The color of the better route tube. You can control the route line’s opacity by using an alpha component of the UIColor.

    Declaration

    Swift

    public let lineColor: UIColor
  • The width (in point units) of the line per scene for a better route tube. This parameter must be a non-empty list containing non-negative values for both the width and the scene. Items in this list must not contain duplicated values.

    Declaration

    Swift

    public let lineWidth: [WidthScene]
  • Represents the style used to display the better route bubble.

    Important

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

    Declaration

    Swift

    public struct MarkerStyle
  • The better route marker style.

    Declaration

    Swift

    public let markerStyle: MarkerStyle
  • The width (in point units) of the outline per scene for better route tube. This parameter must be a non-empty list containing non-negative values for both the width and the scene. Items in this list must not contain duplicated values.

    Declaration

    Swift

    public let outlineWidth: [WidthScene]