TomTom SDK for iOS MagnitudeOfDelayProperties

MagnitudeOfDelayProperties

public struct MagnitudeOfDelayProperties

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.

  • Initializes the traffic incident style properties that have specific values per magnitude of delay.

    Declaration

    Swift

    public init(
    lineColor: UIColor,
    lineOutlineColor: UIColor,
    markerLabelTextColor: UIColor,
    markerLabelTextOutlineColor: UIColor,
    markerPinImageByCategory: [TrafficIncidentCategoryKey: MapImage],
    markerIconImageByCategory: [TrafficIncidentCategoryKey: MapImage],
    linePatternImage: UIImage? = nil,
    linePatternDisplay: LinePatternDisplay? = nil
)

    Parameters

    lineColor

    The color of the traffic line.
    lineOutlineColor

    The outline color of the traffic line.
    markerLabelTextColor

    The color of the label text on the traffic marker.
    markerLabelTextOutlineColor

    The outline color of the label text on the traffic marker.
    markerPinImageByCategory

    The collection of marker pin base images by category. As a general rule, the dictionary must contain the keys of all possible categories. However, this rule is relaxed if you provide any; the image associated with any is used for the categories that were not specified with their specific keys. This means you can use the same image for all categories by providing only any.
    markerIconImageByCategory

    The traffic marker icon image by incident category. As a general rule, the dictionary must contain the keys of all possible categories. However, this rule is relaxed if you provide any; the image associated with any is used for the categories that were not specified with their specific keys. This means you can use the same image for all categories by providing only any. Since markers for jam incidents do not have icons (they show a label with the delay instead), the key jam is not allowed.
    linePatternImage

    The pattern texture of the traffic line. If linePatternDisplay is satisfied, this image is repeated along the traffic line, that is, this image has priority over the solid color from lineColor. However, lineOutlineColor may be seen through transparent portions of the image effectively like a background. If you pass nil, the pattern image is disabled, which causes the color from lineColor to be used.
    linePatternDisplay

    The criteria to display traffic lines with linePatternTexture (instead of lineColor).

  • The color of the traffic line.

    Declaration

    Swift

    public let lineColor: UIColor

  • The outline color of the traffic line.

    Declaration

    Swift

    public let lineOutlineColor: UIColor

  • Line pattern display configuration for a specific zoom range.

    Declaration

    Swift

    public let linePatternDisplay: LinePatternDisplay?

  • The pattern texture image for traffic line.

    Important

    The pattern texture has a higher priority than lineColor and lineOutlineColor.

    Declaration

    Swift

    public let linePatternImage: UIImage?

  • The collection of marker pin icon images by category

    Declaration

    Swift

    public let markerIconImageByCategory: [TrafficIncidentCategoryKey : MapImage]

  • The color of the label text on the traffic marker.

    Declaration

    Swift

    public let markerLabelTextColor: UIColor

  • The outline color of the label text on the traffic marker.

    Declaration

    Swift

    public let markerLabelTextOutlineColor: UIColor

  • The collection of marker pin base images by category

    Declaration

    Swift

    public let markerPinImageByCategory: [TrafficIncidentCategoryKey : MapImage]