TomTom SDK for iOS SafetyLocationStyle

SafetyLocationStyle

public struct SafetyLocationStyle

Defines the appearance and behavior of the safety location visualization on the route.

Important

Currently supported safety location types are:

SafetyLocation/SafetyLocationType/speedEnforcement
SafetyLocation/SafetyLocationType/averageSpeed
SafetyLocation/SafetyLocationType/mobileRiskZone
SafetyLocation/SafetyLocationType/trafficLight
SafetyLocation/SafetyLocationType/mobile
SafetyLocation/SafetyLocationType/fixedDangerZone

Important

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


                    
                    
                    init(speedCameraLineColor:speedCameraOutlineColor:dangerZoneLineColor:dangerZoneOutlineColor:lineWidth:outlineWidth:markerStyleByCategory:areMarkersVisible:)

Initializes SafetyLocationStyle 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(
    speedCameraLineColor: UIColor = Defaults.speedCameraLineColor,
    speedCameraOutlineColor: UIColor = Defaults.speedCameraOutlineColor,
    dangerZoneLineColor: UIColor = Defaults.dangerZoneLineColor,
    dangerZoneOutlineColor: UIColor = Defaults.dangerZoneOutlineColor,
    lineWidth: [WidthScene] = Defaults.lineWidth,
    outlineWidth: [OutlineWidthScene] = Defaults.outlineWidth,
    markerStyleByCategory: [SafetyLocation.SafetyLocationType: MarkerStyle] = Defaults
        .markerStyleByCategory,
    areMarkersVisible: Bool = Defaults.areMarkersVisible
) throws

Parameters

`speedCameraLineColor`	The color of the line for speed cameras representing zones. By default, `speedCameraLineColor` is used.
`speedCameraOutlineColor`	The outline color of the line for speed cameras representing zones. By default, `speedCameraOutlineColor` is used.
`dangerZoneLineColor`	The color of the line for danger zones. By default, `dangerZoneLineColor` is used.
`dangerZoneOutlineColor`	The outline color of the line for danger zones. By default, `dangerZoneOutlineColor` is used.
`lineWidth`	The width (in point units) of the line for safety location representing zones. By default, `lineWidth` is used. This parameter must be a non-empty list containing non-negative values for both the width and the zoom level where the width is used. Items in this list must not contain duplicated zoom level values.
`outlineWidth`	The width (in point units) of the line’s outline for safety location representing zones. By default, `outlineWidth` is used. This parameter must be a non-empty list containing non-negative values for both the width and the zoom level where the width is used. Items in this list must not contain duplicated zoom level values.
`markerStyleByCategory`	The safety location’s marker style by category. By default, `markerStyleByCategory` is used. If the marker style is missing for any of the supported safety locations, a default marker style will be used.
`areMarkersVisible`	Determines if the safety location markers are visible. By default, `areMarkersVisible` is used.

init()
Initializes SafetyLocationStyle with values from Defaults.
Declaration
Swift

public init()

speedCameraLineColor
The color of the line for speed cameras representing zones.
Declaration
Swift

public let speedCameraLineColor: UIColor
speedCameraOutlineColor
The outline color of the line for speed cameras representing zones.
Declaration
Swift

public let speedCameraOutlineColor: UIColor
dangerZoneLineColor
The color of the line for danger zones.
Declaration
Swift

public let dangerZoneLineColor: UIColor
dangerZoneOutlineColor
The outline color of the line for danger zones.
Declaration
Swift

public let dangerZoneOutlineColor: UIColor
lineWidth
The width (in point units) of the line for safety location representing zones.

This parameter must be a non-empty list containing non-negative values for both the width and the zoom level where the width is used. Items in this list must not contain duplicated zoom level values.
Declaration
Swift

public let lineWidth: [WidthScene]
outlineWidth
The width (in point units) of the line’s outline for safety location representing zones.

This parameter must be a non-empty list containing non-negative values for both the width and the zoom level where the width is used. Items in this list must not contain duplicated zoom level values.
Declaration
Swift

public let outlineWidth: [OutlineWidthScene]
markerStyleByCategory
The safety location’s marker style by category. If the marker style is missing for any of the supported safety locations, a default marker style will be used.
Declaration
Swift

public let markerStyleByCategory: [SafetyLocation.SafetyLocationType : MarkerStyle]
areMarkersVisible
Determines if the safety location markers are visible. Default is true.
Declaration
Swift

public let areMarkersVisible: Bool
TextStyle
Represents the style used to display safety locations markers.

Important
This stylization API is intended to be used for only the turn-by-turn navigation.

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

public struct TextStyle

Defaults
Provides default values for SafetyLocationStyle properties.

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

public enum Defaults

MarkerStyle
A container for the start, end, and background images of safety location markers.

Important
This stylization API is intended to be used for only the turn-by-turn navigation.

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

public struct MarkerStyle