DashImageRepresentation

public class DashImageRepresentation : MapPolyline.Representation

Represents a dash pattern for the map polyline consisting of images rendered with certain gaps from each other.

This dash pattern representation consists only of images rendered at certain points along the polyline. For rendering them without any distortions, polyline gets sliced into series of straight segments that are multiple of sum of dash and gap lengths. For this reason, the new polyline geometry might not align fully with original geometry.

The MapPolyline.DashImageRepresentation.dashImage is stretched according to MapPolyline.DashImageRepresentation.dashLength and MapPolyline.DashImageRepresentation.dashWidth, with image’s width matched to dashLength and image’s height matched to dashWidth. The image is oriented so that its bottom is on the left-hand side between vertices n and n+1.

The spacing between images is specified by MapPolyline.DashImageRepresentation.gapLength.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.


                    
                    
                    init(dashLength:dashWidth:image:)

Creates a uniform dash pattern in which the length of a gap is the same as the length of a dash. Dashes are rendered as image.

This allows for patterns like ' — — — —' or ' —— —— ——'.

For MapMeasureDependentRenderSize supplied for dashLength and dashWidth, only MapMeasure.Kind.zoomLevel is supported for MapMeasureDependentRenderSize.measureKind and only RenderSize.Unit.meters is supported for MapMeasureDependentRenderSize.sizeUnit.

Only map measure values in range [3-19] are supported.

The value of the keys in MapMeasureDependentRenderSize.sizes is truncated to integer values, hence only a single value can be provided per zoom level.

The values are interpolated linearly between zoom levels.

Throws

MapPolyline.Representation.InstantiationError In case of invalid input parameters.

Declaration

Swift

public init(dashLength: MapMeasureDependentRenderSize, dashWidth: MapMeasureDependentRenderSize, image: MapImage) throws

Parameters

`dashLength`	The map measure dependent length of a dash, to which image width is stretched.
`dashWidth`	The map measure dependent width of a dash, to which image height is stretched.
`image`	Image to be rendered in place of dash space. It is stretched to match `dashWidth` and `dashLength`.


                    
                    
                    init(dashLength:gapLength:dashWidth:image:)

Creates a simple dash pattern in which the lengths of a dash and gap can be different. Dashes are rendered as image.

This allows for patterns like ' — — — —' or ' ——— ——— ———'.

For MapMeasureDependentRenderSize supplied for dashLength, gapLength and dashWidth, only MapMeasure.Kind.zoomLevel is supported for MapMeasureDependentRenderSize.measureKind and only RenderSize.Unit.meters is supported for MapMeasureDependentRenderSize.sizeUnit.