com.tomtom.sdk.maps.visualization:routing/com.tomtom.sdk.map.display.visualization.routing.traffic/RouteTrafficIncidentStyle/MagnitudeOfDelayProperties

MagnitudeOfDelayProperties

class MagnitudeOfDelayProperties(@ColorInt val lineColor: Int, @ColorInt val lineOutlineColor: Int, @ColorInt val markerLabelTextColor: Int, @ColorInt val markerLabelTextOutlineColor: Int, val markerPinImageByCategory: Map<RouteTrafficIncidentStyle.TrafficIncidentCategoryKey, Image>, val markerIconImageByCategory: Map<RouteTrafficIncidentStyle.TrafficIncidentCategoryKey, Image>, val linePatternImage: Image? = null, val linePatternDisplay: RouteTrafficIncidentStyle.LinePatternDisplay = LinePatternDisplay(ZOOM_FULL_RANGE))

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. MagnitudeOfDelayProperties 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.

Constructors

MagnitudeOfDelayProperties

constructor(@ColorInt lineColor: Int, @ColorInt lineOutlineColor: Int, @ColorInt markerLabelTextColor: Int, @ColorInt markerLabelTextOutlineColor: Int, markerPinImageByCategory: Map<RouteTrafficIncidentStyle.TrafficIncidentCategoryKey, Image>, markerIconImageByCategory: Map<RouteTrafficIncidentStyle.TrafficIncidentCategoryKey, Image>, linePatternImage: Image? = null, linePatternDisplay: RouteTrafficIncidentStyle.LinePatternDisplay = LinePatternDisplay(ZOOM_FULL_RANGE))

Properties

lineColor

val lineColor: Int

The color of the traffic line.

lineOutlineColor

val lineOutlineColor: Int

The outline color of the traffic line.

linePatternDisplay

val linePatternDisplay: RouteTrafficIncidentStyle.LinePatternDisplay

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

linePatternImage

val linePatternImage: Image? = null

The pattern image of the traffic line.

markerIconImageByCategory

val markerIconImageByCategory: Map<RouteTrafficIncidentStyle.TrafficIncidentCategoryKey, Image>

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 TrafficIncidentCategoryKey.Any; the image associated with TrafficIncidentCategoryKey.Any is used for the categories that were not specified with their specific keys. This means that you can use the same image for all categories by providing only TrafficIncidentCategoryKey.Any. Since markers for jam incidents do not have icons (they show a label with the delay instead), the key TrafficIncidentCategoryKey.Jam is not allowed.

markerLabelTextColor

val markerLabelTextColor: Int

The color of the label text on the traffic marker. The alpha is ignored and set to fully opaque.

markerLabelTextOutlineColor

val markerLabelTextOutlineColor: Int

The outline color of the label text on the traffic marker. The alpha is ignored and set to fully opaque.

markerPinImageByCategory

val markerPinImageByCategory: Map<RouteTrafficIncidentStyle.TrafficIncidentCategoryKey, Image>

The traffic marker pin 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 TrafficIncidentCategoryKey.Any; the image associated with TrafficIncidentCategoryKey.Any is used for the categories that were not specified with their specific keys. This means that you can use the same image for all categories by providing only TrafficIncidentCategoryKey.Any.