PropertiesByMagnitudeOfDelay

data class PropertiesByMagnitudeOfDelay(@ColorInt val lineColor: Int, @ColorInt val lineOutlineColor: Int, @ColorInt val markerLabelTextColor: Int, @ColorInt val markerLabelTextOutlineColor: Int, val markerPinByCategory: Map<RouteTrafficIncidentStyle.CategoryKey, Image>, val markerIconByCategory: Map<RouteTrafficIncidentStyle.CategoryKey, 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. 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.

Parameters

lineColor

The color of the traffic line.

If linePatternImage is provided and linePatternDisplay is satisfied, lineColor has no effect.

lineOutlineColor

The outline color of the traffic line.

markerLabelTextColor

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

markerLabelTextOutlineColor

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

markerPinByCategory

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 CategoryKey.Any; the image associated with CategoryKey.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 CategoryKey.Any.

markerIconByCategory

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 CategoryKey.Any; the image associated with CategoryKey.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 CategoryKey.Any. Since markers for jam incidents do not have icons (they show a label with the delay instead), the key CategoryKey.Jam is not allowed on this property.

linePatternImage

The pattern image 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 null, the pattern image is disabled, which causes the color from lineColor to be used.

linePatternDisplay

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

Constructors

Link copied to clipboard
constructor(@ColorInt lineColor: Int, @ColorInt lineOutlineColor: Int, @ColorInt markerLabelTextColor: Int, @ColorInt markerLabelTextOutlineColor: Int, markerPinByCategory: Map<RouteTrafficIncidentStyle.CategoryKey, Image>, markerIconByCategory: Map<RouteTrafficIncidentStyle.CategoryKey, Image>, linePatternImage: Image? = null, linePatternDisplay: RouteTrafficIncidentStyle.LinePatternDisplay = LinePatternDisplay(ZOOM_FULL_RANGE))