RouteTrafficIncidentStyle

public struct RouteTrafficIncidentStyle

Style configuration for on-route traffic incidents. During instance construction, certain input values are checked against the range of values expected for that field (e.g., width values must be non-negative).

Default assets such as fonts and icons are bundled into the framework. You can provide custom icons in propertiesByMagnitudeOfDelay

Important

This is a Public Preview API. It may be changed or removed at any time.
  • The line widths of on-route traffic lines. This parameter must be a non-empty dictionary containing non-negative values for both the width and the zoom level where that width is used.

    Declaration

    Swift

    public let lineWidths: [Double : Double]
  • The outline line width of on-route traffic lines. This parameter must be a non-empty dictionary containing non-negative values for both the width and the zoom level where that width is used.

    Declaration

    Swift

    public let lineOutlineWidths: [Double : Double]
  • The on-route traffic line start cap.

    Declaration

    Swift

    public let lineStartCapType: LineCapType
  • The on-route traffic line end cap.

    Declaration

    Swift

    public let lineEndCapType: LineCapType
  • The on-route traffic line joint type.

    Declaration

    Swift

    public let lineJointType: LineJoinType
  • The URI of the font for the label text in the traffic marker.

    Declaration

    Swift

    public let markerLabelFontURI: String
  • The size of the label text in the traffic marker.

    Declaration

    Swift

    public let markerLabelTextSize: Double
  • The width of the outline of the label text in the traffic marker.

    Declaration

    Swift

    public let markerLabelTextOutlineWidth: Double
  • The offset that will be used to position the label in the traffic marker.

    Declaration

    Swift

    public let markerLabelTextOffset: MarkerLabelOptions.TextOffset
  • The anchoring that determines how the label is positioned on the traffic marker.

    Declaration

    Swift

    public let markerLabelTextAnchoring: TextAnchoring
  • Traffic incident marker visibility by category. That dictionary does not have to contain keys of all possible categories. If a category is missing in the dictionary, markers of that category will not be displayed.

    Declaration

    Swift

    public let markerVisibilityByCategory: [TrafficIncidentCategory : MarkerVisibility]
  • Style properties for traffic incidents by magnitude of delay. This dictionary may not contain keys for all possible magnitudes of delay. If a magnitude of delay is missing in the dictionary, style for MagnitudeOfDelayKey.any is used.

    Declaration

    Swift

    public let propertiesByMagnitudeOfDelay: [MagnitudeOfDelayKey : MagnitudeOfDelayProperties]
  • Whether traffic markers are visible. Default is true.

    Declaration

    Swift

    public let areMarkersVisible: Bool
  • Key for categories of on-route traffic incidents used in RouteTrafficIncidentStyle

    Important

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

    Declaration

    Swift

    public enum TrafficIncidentCategoryKey
  • Represents a line pattern display configuration for a specific zoom range.

    Important

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

    Declaration

    Swift

    public struct LinePatternDisplay
  • The traffic incident style properties that have specific values per magnitude of delay. Traffic incidents may have different magnitudes of delay associated with them: unknown, minor, moderate, major, or indefinite. PropertiesByMagnitudeOfDelay stores traffic incident style properties whose specific values depend on the magnitude of delay.

    Important

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

    Declaration

    Swift

    public struct MagnitudeOfDelayProperties
  • Describes marker visibility setup by zoom level and camera tilt.

    Important

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

    Declaration

    Swift

    public struct MarkerVisibility
  • A typealias for Defaults, ensuring backward compatibility.

    Declaration

    Swift

    public typealias Default = Defaults
  • Contains default styling properties for route traffic visualization.

    See more

    Declaration

    Swift

    public enum Defaults