Class MapPolyline.DashRepresentation

MapPolyline.DashRepresentation (API Reference)

java.lang.Object
- com.here.NativeBase
- - com.here.sdk.mapview.MapItemRepresentation
  - - com.here.sdk.mapview.MapPolyline.Representation
    - - com.here.sdk.mapview.MapPolyline.DashRepresentation

Enclosing class:

MapPolyline
```
public static final class MapPolyline.DashRepresentation
extends MapPolyline.Representation
```
Represents a dash pattern for map polyline where the dash can be rendered as a colored line and the gap can be either empty or colored.
The length of the dash and gap are set independently, allowing for patterns like ' — — — —' (dash length = gap length) or ' ——— ——— ———' (dash length != gap length).

Nested Class Summary
- Nested classes/interfaces inherited from class com.here.sdk.mapview.MapPolyline.Representation
  MapPolyline.Representation.InstantiationErrorCode, MapPolyline.Representation.InstantiationException

Constructor Summary

Constructors
Constructor	Description
`DashRepresentation(MapMeasureDependentRenderSize lineWidth, MapMeasureDependentRenderSize dashLength, MapMeasureDependentRenderSize gapLength, Color dashColor)`	Creates a representation for a dashed line.
`DashRepresentation(MapMeasureDependentRenderSize lineWidth, MapMeasureDependentRenderSize dashLength, MapMeasureDependentRenderSize gapLength, Color dashColor, Color gapColor)`	Creates a representation for a dashed line with both dash and the gap being colored.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Color`	`getDashColor()`	Gets the color of the dashes of the polyline.
`MapMeasureDependentRenderSize`	`getDashLength()`	Gets the map measure dependent polyline dash length.
`Color`	`getGapColor()`	Gets the color for the gaps of the polyline.
`MapMeasureDependentRenderSize`	`getGapLength()`	Gets the map measure dependent polyline gap length.
`MapMeasureDependentRenderSize`	`getLineWidth()`	Gets the map measure dependent polyline width.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DashRepresentation
```
public DashRepresentation(@NonNull
                          MapMeasureDependentRenderSize lineWidth,
                          @NonNull
                          MapMeasureDependentRenderSize dashLength,
                          @NonNull
                          MapMeasureDependentRenderSize gapLength,
                          @NonNull
                          Color dashColor)
                   throws MapPolyline.Representation.InstantiationException
```
    Creates a representation for a dashed line. Gaps are not displayed.
    At map measures smaller than the smallest map measure in the lineWidth, dashLength and gapLength, the value used for rendering is constant and equal to the value given for the smallest map measure in the respective MapMeasureDependentRenderSize object.
    At map measures bigger than the biggest map measure in the lineWidth, dashLength and gapLength, the value used for rendering is constant and equal to the value given for the biggest map measure in the respective MapMeasureDependentRenderSize object.
    At map measures between two nearest given map measures, the values are linearly interpolated between values given for these map measures.
    For MapMeasure.Kind only MapMeasure.Kind.ZOOM_LEVEL is supported.
    For RenderSize.Unit only RenderSize.Unit.PIXELS is supported.
    All sizes must not be 0 (MapMeasureDependentRenderSize.sizes with all values set to 0.0).
    
    Parameters:
    
    lineWidth -
    The width of the polyline depending on the map measure.
    
    dashLength -
    The dash length of the polyline depending on the map measure.
    
    gapLength -
    The gap length of the polyline depending on the map measure.
    
    dashColor -
    The dash color of the polyline.
    
    Throws:
    
    MapPolyline.Representation.InstantiationException -
    In case of invalid input parameters.
  - DashRepresentation
```
public DashRepresentation(@NonNull
                          MapMeasureDependentRenderSize lineWidth,
                          @NonNull
                          MapMeasureDependentRenderSize dashLength,
                          @NonNull
                          MapMeasureDependentRenderSize gapLength,
                          @NonNull
                          Color dashColor,
                          @NonNull
                          Color gapColor)
                   throws MapPolyline.Representation.InstantiationException
```
    Creates a representation for a dashed line with both dash and the gap being colored.
    At map measures smaller than the smallest map measure in the lineWidth, dashLength and gapLength, the value used for rendering is constant and equal to the value given for the smallest map measure in the respective MapMeasureDependentRenderSize object.
    At map measures bigger than the biggest map measure in the lineWidth, dashLength and gapLength, the value used for rendering is constant and equal to the value given for the biggest map measure in the respective MapMeasureDependentRenderSize object.
    At map measures between two nearest given map measures, the values are linearly interpolated between values given for these map measures.
    For MapMeasure.Kind only MapMeasure.Kind.ZOOM_LEVEL is supported.
    For RenderSize.Unit only RenderSize.Unit.PIXELS is supported.
    All sizes must not be 0 (MapMeasureDependentRenderSize.sizes with all values set to 0.0).
    
    Parameters:
    
    lineWidth -
    The width of the polyline depending on the map measure.
    
    dashLength -
    The dash length of the polyline depending on the map measure.
    
    gapLength -
    The gap length of the polyline depending on the map measure.
    
    dashColor -
    The color of the dashes.
    
    gapColor -
    The color of the gaps.
    
    Throws:
    
    MapPolyline.Representation.InstantiationException -
    In case of invalid input parameters.
- Method Detail
  - getLineWidth
```
@NonNull
public MapMeasureDependentRenderSize getLineWidth()
```
    Gets the map measure dependent polyline width.
    At map measures smaller than smallest map measure in the lineWidth line width is constant and equal to the width given for the smallest map measure in the lineWidth.
    At map measures bigger than biggest map measure in the lineWidth line width is constant and equal to the width given for the biggest map measure in the lineWidth.
    At map measures between two nearest given map measures, the values are linearly interpolated between values given for these map measures.
    
    Returns:
    
    The width of the polyline depending on the map measure.
  - getDashLength
```
@NonNull
public MapMeasureDependentRenderSize getDashLength()
```
    Gets the map measure dependent polyline dash length.
    At map measures smaller than smallest map measure in the dashLength line width is constant and equal to the width given for the smallest map measure in the dashLength.
    At map measures bigger than biggest map measure in the dashLength line width is constant and equal to the width given for the biggest map measure in the dashLength.
    At map measures between two nearest given map measures, the values are linearly interpolated between values given for these map measures.
    
    Returns:
    
    The dash length of the polyline depending on the map measure.
  - getGapLength
```
@NonNull
public MapMeasureDependentRenderSize getGapLength()
```
    Gets the map measure dependent polyline gap length.
    At map measures smaller than smallest map measure in the gapLength line width is constant and equal to the width given for the smallest map measure in the gapLength.
    At map measures bigger than biggest map measure in the gapLength line width is constant and equal to the width given for the biggest map measure in the gapLength.
    At map measures between two nearest given map measures, the values are linearly interpolated between values given for these map measures.
    
    Returns:
    
    The gap length of the polyline depending on the map measure.
  - getDashColor
```
@NonNull
public Color getDashColor()
```
    Gets the color of the dashes of the polyline.
    
    Returns:
    
    The color of the dashes of the polyline.
  - getGapColor
```
@Nullable
public Color getGapColor()
```
    Gets the color for the gaps of the polyline. Returns null if no color is used.
    
    Returns:
    
    The color for the gaps of the polyline. The default value is null and no color is used.

Class MapPolyline.DashRepresentation

Nested Class Summary

Nested classes/interfaces inherited from class com.here.sdk.mapview.MapPolyline.Representation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DashRepresentation

DashRepresentation

Method Detail

getLineWidth

getDashLength

getGapLength

getDashColor

getGapColor