PlaceMarker.Builder
class PlaceMarker.Builder
A builder of PlaceMarker.
Summary
Public functions |
|
|---|---|
PlaceMarker |
build()Constructs the |
PlaceMarker.Builder |
Sets the color that should be used for the marker on the map. |
PlaceMarker.Builder |
Sets the icon to display in the marker. |
PlaceMarker.Builder |
setLabel(label: CharSequence)Sets the text that should be displayed as the marker's content. |
Public functions
build
fun build(): PlaceMarker
Constructs the PlaceMarker defined by this builder.
| Throws | |
|---|---|
java.lang.IllegalStateException |
if the icon is of the type |
setColor
fun setColor(color: CarColor): PlaceMarker.Builder
Sets the color that should be used for the marker on the map.
This color is applied in the following cases:
- When the
PlaceMarkeris displayed on the map, the pin enclosing the icon or label will be painted using the given color. - When the
PlaceMarkeris displayed on the list, the color will be applied if the content is a label. A label rendered inside a map's pin cannot be colored and will always use the default color as chosen by the host.
Unless set with this method, the host will use a default color for the marker.
The host may ignore this color and use the default instead if the color does not pass the contrast requirements.
A color cannot be set if the marker's icon type is of TYPE_IMAGE.
| Throws | |
|---|---|
java.lang.NullPointerException |
if the |
setIcon
fun setIcon(icon: CarIcon, iconType: Int): PlaceMarker.Builder
Sets the icon to display in the marker.
Unless set with this method, the marker will not have an icon.
If a label is specified with setLabel, the icon will take precedence over it.
See CarIcon for more details related to providing icon and image resources that work with different car screen pixel densities.
| Parameters | |
|---|---|
icon: CarIcon |
the |
iconType: Int |
one of |
| Throws | |
|---|---|
java.lang.NullPointerException |
if the |
setLabel
fun setLabel(label: CharSequence): PlaceMarker.Builder
Sets the text that should be displayed as the marker's content.
Unless set with this method, the marker will not have a label.
If an icon is specified with setIcon, the icon will take precedence.
Spans are not supported in the input string and will be ignored.
| Parameters | |
|---|---|
label: CharSequence |
the text to display inside of the marker. The string must have a maximum size of 3 characters. Set to |
| Throws | |
|---|---|
java.lang.NullPointerException |
if the |
| See also | |
|---|---|
CarText |